Alertas¶
Las Alertas son útiles en varios contextos para proporcionar información rápida sobre el procesamiento de una tarea. Puedes emitir alertas personalizadas a través de dos métodos del SDK:
- Alerta
- Mensaje
Orquestador BotCity
Puedes visualizar la funcionalidad de Alertas directamente en la plataforma del Orquestador BotCity.
Consulta más en:
Emitir Alerta¶
El método de Alerta se aplica en el contexto de notificación de usuarios que tienen acceso al workspace del Orquestador BotCity.
Para crear una Alerta con el SDK, necesitas la siguiente información:
- ID de la tarea: Referencia de la tarea que emitirá la alerta.
- Título: El título personalizable.
- Mensaje: Un mensaje detallado sobre la alerta.
- Tipo de alerta: Tipo definido con la clase
AlertType, puede ser:INFO: Alerta de información.WARN: Alerta de aviso.ERROR: Alerta de error.
Consejo
Puedes configurar en el Orquestador qué usuarios deben recibir la Alerta también por correo electrónico.
Aquí un ejemplo de alerta:
Emitir Mensaje¶
El método de Mensaje puede utilizarse para notificar a cualquier persona, sin necesidad de tener acceso al workspace del Orquestador BotCity.
Los mensajes se envían directamente a correos electrónicos, abriendo la posibilidad de notificar a usuarios externos de forma sencilla.
Para crear un Mensaje, necesitas la siguiente información:
- Correos electrónicos: Lista de correos electrónicos para el envío del mensaje.
- Usuarios: Lista de nombres de usuarios con acceso al Orquestador BotCity.
- Asunto: Texto personalizable como asunto del correo electrónico.
- Cuerpo: Cuerpo del correo electrónico.
- Tipo de mensaje: Tipo definido con la clase
MessageType, puede ser:TEXT: Cuerpo de mensaje de texto simple.HTML: Cuerpo del mensaje formateado en HTML.
¡Atención!
El método para el envío de mensajes tiene un límite de 50 destinatarios por llamada.
Aquí un ejemplo de envío de mensaje a través del Maestro SDK:
# Lista de correos electrónicos, si no se utiliza, pasa una lista vacía.
emails = ["tu_email@tu_email.com"]
# Lista de usuarios, si no se utiliza, pasa una lista vacía.
usuarios = ["usuario_Orquestrador1", "usuario_Orquestrador2"]
# Asunto y cuerpo del correo electrónico
asunto = "Asunto del mensaje"
cuerpo_email = "Este es el contenido del mensaje."
maestro.message(
email=emails,
users=usuarios,
subject=asunto,
body=cuerpo_email,
msg_type=MessageType.TEXT,
)
List<String> emails = new ArrayList<String>();
emails.add("tu_email@tu_email.com");
List<String> usuarios = new ArrayList<String>();
usuarios.add("usuario_Orquestrador1");
usuarios.add("usuario_Orquestrador2");
String asunto = "Mensaje de prueba";
String cuerpo_email = "Este es el contenido del mensaje.";
maestro.message(emails, usuarios, asunto, cuerpo_email, MessageType.TEXT);
// Lista de correos electrónicos, si no se utiliza, pasa una lista vacía
const emails = ["tu_email@tu_email.com"]
// Lista de usuarios, si no se utiliza, pasa una lista vacía
const usuarios = ["usuario_Orquestrador1", "usuario_Orquestrador2"]
const asunto = "Mensaje de prueba"
const cuerpo_email = "Este es el contenido del mensaje."
await maestro.message(emails, usuarios, asunto, cuerpo_email, "TEXT")
// Lista de correos electrónicos, si no se utiliza, pasa una lista vacía
const emails: array = ["tu_email@tu_email.com"]
// Lista de usuarios, si no se utiliza, pasa una lista vacía
const usuarios: array = ["usuario_Orquestrador1", "usuario_Orquestrador2"]
const asunto: string = "Mensaje de prueba"
const cuerpo_email: string = "Este es el contenido del mensaje."
await maestro.message(emails, usuarios, asunto, cuerpo_email, "TEXT")
// Lista de correos electrónicos, si no se utiliza, pasa una lista vacía
List<string> emails = ["tu_email@tu_proveedor.com"];
// Lista de usuarios, si no se utiliza, pasa una lista vacía
List<string> users = ["maestro_user1", "maestro_user2"];
string subject = "Mensaje de prueba";
string body = "Este es el contenido del mensaje.";
await maestro.SendMessageAsync(emails, users, subject, body, MessageTypeEnum.TEXT);