Alertas

Os Alertas são uteis em vários contextos para fornecer informações rápidas sobre o processamento de uma tarefa, você pode emitir alertas customizados por dois métodos do SDK:

• Alerta
• Mensagem

Orquestrador BotCity

Você pode visualizar a funcionalidade de Alertas diretamente na plataforma do Orquestrador BotCity.

Veja mais em:

• Alertas

Emitir Alerta

O método de Alerta entra no contexto de notificação de usuários que tem acesso ao workspace do Orquestrador BotCity.

Para criar um Alerta com o SDK, você precisa das seguintes informações:

• ID da tarefa: Referência da tarefa que emitirá o alerta.
• Titulo: O titulo customizável.
• Mensagem: Uma mensagem detalhada sobre o alerta.
• Tipo de alerta: Tipo definido com a classe AlertType, pode ser:
  • INFO: Alerta de informação.
  • WARN: Alerta de aviso.
  • ERROR: Alerta de erro.

Dica

Você pode configurar no Orquestrador quais usuários devem receber o Alerta também no e-mail.

Veja um exemplo de alerta:

PythonJavaJavascriptTypescriptC#

maestro.alert(
    task_id=<TASK_ID>,
    title="Alerta de informação",
    message="Este é um alerta de informação",
    alert_type=AlertType.INFO
)

maestro.alert(
    <TASK_ID>, 
    "Alerta de informação", 
    "Este é um alerta de informação",
    AlertType.INFO
);

const alert = await maestro.alert(
    <TASK_ID>, 
    "Alerta de informação", 
    "Este é um alerta de informação", 
    "INFO"
)

const alert: Alert = await maestro.alert(
    <TASK_ID>, 
    "Alerta de informação", 
    "Este é um alerta de informação", 
    "INFO"
)

using Dev.BotCity.MaestroSdk.Model.Alert;

await maestro.CreateAlertAsync(
    <TASK_ID>,
    "Alerta de informação",
    "Este é um alerta de informação",
    AlertTypeEnum.INFO
);

Emitir Mensagem

O método de Mensagem pode ser usado para notificar qualquer pessoa, sem a necessidade de ter acesso ao workspace do Orquestrador BotCity.

As mensagens são enviadas diretamente para e-mails, abrindo a possibilidade de notificar usuários externos de maneira simples.

Para criar uma Mensagem, você precisa das seguintes informações:

• E-mails: Lista de e-mails para envio da mensagem.
• Usuarios: Lista de nomes de usuários com acesso ao Orquestrador BotCity.
• Assunto: Texto customizavel como assunto de e-mail.
• Corpo: Corpo do e-mail
• Tipo de mensagem: Tipo definido com a classe MessageType, pode ser:
  • TEXT: Corpo de mensagem de texto simples.
  • HTML: Corpo da mensagem formatado em HTML.

Atenção!

O método para envio de mensagem tem um limite de 50 destinatários por chamada.

Aqui está um exemplo de envio de mensagem através do Maestro SDK:

PythonJavaJavascriptTypescriptC#

# Lista de e-mails, se não for utilizada, passe uma lista vazia.
emails = ["seu_email@seu_email.com"]
# Lista de usuários, se não for utilizada, passe uma lista vazia.
usuarios = ["usuario_Orquestrador1", "usuario_Orquestrador2"]

# Assunto e corpo do e-mail
assunto = "Assunto da mensagem
corpo_email = "Este é o conteúdo da mensagem."

maestro.message(
    email=emails, 
    users=usuarios, 
    subject=assunto, 
    body=corpo_email, 
    msg_type=MessageType.TEXT,
    )

List<String> emails = new ArrayList<String>();
emails.add("seu_email@seu_email.com");

List<String> users = new ArrayList<String>();
usuarios.add("usuario_Orquestrador1");
usuarios.add("usuario_Orquestrador2");

String assunto = "Mensagem de teste";
String corpo_email = "Este é o conteúdo da mensagem.";

maestro.message(emails, usuarios, assunto, corpo_email, MessageType.TEXT);

const emails = ["seu_email@seu_email.com"]
// List of usernames, if not using, pass an empty list
const usuarios = ["usuario_Orquestrador1", "usuario_Orquestrador2"]

const assunto = "Mensagem de teste"
const corpo_email = "Este é o conteúdo da mensagem."

await maestro.message(emails, usuarios, assunto, corpo_email, "TEXT")

const emails: array = ["seu_email@seu_email.com"]
// List of usernames, if not using, pass an empty list
const usuarios: array = ["usuario_Orquestrador1", "usuario_Orquestrador2"]

const assunto: string = "Mensagem de teste"
const corpo_email: string = "Este é o conteúdo da mensagem."

await maestro.message(emails, usuarios, assunto, corpo_email, "TEXT")

// List of emails, if not using, pass an empty list
List<string> emails = ["your_email@your_provider.com"];
// List of usernames, if not using, pass an empty list
List<string> users = ["maestro_user1", "maestro_user2"];

string subject = "Mensagem de teste";
string body = "Este é o conteúdo da mensagem.";

await maestro.SendMessageAsync(emails, users, subject, body, MessageTypeEnum.TEXT);