Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Este artículo describe cómo utilizar la API de notificación para enviar notificaciones desde aplicaciones externas a los usuarios del agente virtual. Las notificaciones son útiles para notificar a los usuarios sobre una interrupción, un anuncio de la empresa o que se completó una solicitud o un servicio, entre otras opciones.

...

NombreValorEjemplo de punto de conexión
URL predeterminada{{ENDPOINT}}/api/v1/bulk/notificationhttps://luma2.serviceaide.com/gateway/api/v1/bulk/notification

...

La sección del cuerpo/la solicitud de la API incluye lo siguiente:

NombreDescripción
Destinatarios

Proporcione los detalles de los destinatarios que recibirán las notificaciones.  Esto incluye: 

  • Contact Channel Authentication (CCA): autenticación del canal de contacto, que incluye el ID del canal y el ID del alcance del canal.
  • Users (Usuarios): lista de usuarios que se notificarán.
  • Groups (Grupos): información de los grupos.
  • ChannelID (ID del canal) (opcional, use el canal predeterminado): información del canal donde se debe notificar al usuario.
  • BotExternalId ID del bot externo (opcional, use el bot predeterminado): ID del agente virtual que se notificará.
Response Type (Tipo de respuesta)Especifique el formato en el que desea recibir la respuesta. Actualmente, solo se admite el formato JSON. 
MensajeEspecifique el mensaje que desea que Luma envíe a los usuarios. Por ejemplo, “Ya reinicié el servidor. Si tiene un problema, cree un ticket de Soporte”.


Use los elementos anteriores, incluida la URL, los parámetros y los encabezados, para crear la solicitud de notificación a los usuarios. En este ejemplo, usaremos una solicitud JSON, como se especifica a continuación. 

...

  • La marca de tiempo es la fecha y hora del mensaje que se muestra en formato UNIX o epoch.
  • El estado es el resultado de su solicitud. Para obtener más información, consulte Status CodesCódigos de estado.
  • “Error” muestra si se ha producido algún error al mostrar el mensaje.

...