La Agents API tiene como objetivo abrir la plataforma de Aivo a una comunidad de integradores, facilitando el desarrollo de conexiones entre los usuarios que interactúan en nuestros distintos canales y los Agentes en cualquier plataforma. Logrando de esta manera estandarizar las comunicaciones entre sistemas.
Para alcanzar este propósito, proponemos un flujo de integración basado en eventos, en el cual el cliente (partner) deberá configurar un Webhook de notificación para recibir los distintos eventos conversacionales generados desde Aivo (como transferencias, mensajes y cierres). Será responsabilidad del cliente gestionar y procesar estos eventos.
Adicionalmente, Aivo pondrá a disposición la Agents API, que permitirá al cliente interactuar directamente con el usuario a través de los eventos mencionados.
▶️ Aivo a Webhook (Event Hook):
El propósito de este Webhook es enviar eventos conversacionales generados dentro de Aivo. Está basado en un protocolo REST y se enviará usando el método POST en formato JSON. Los tres eventos que se manejarán son los siguientes:
- Evento de Cola (Queue Event): este evento se activa cuando AgentBot inicia una transferencia (derivación) a un agente humano.
- Evento de Mensaje (Message Event): este evento se activa cuando el usuario escribe un nuevo mensaje en una conversación atendida por un agente humano.
- Evento de Cierre (Close Event): este evento se activa cuando el usuario abandona el canal o cuando la conversación ha estado inactiva por más de 24 horas.
Accesa aquí para consultar el API Reference de Webhooks.
▶️ Requests Webhook a Aivo:
El propósito de este endpoint es recibir nuevos mensajes destinados al usuario final.
Gateway: https://agents-api.agentbot.net/{{chanelId}}/{{action}}
Este endpoint utiliza el método POST para recibir la información, y el payload debe estar en formato JSON. Los eventos que se manejarán en el adaptador son los siguientes:
- Attended: este evento tiene como fin notificar al usuario que su consulta ha sido atendida por un Agente.
- Message: el propósito de este evento es enviar un mensaje del Agente al Usuario.
- endConversation: el propósito de este evento es notificar al Usuario que la conversación ha finalizado y cerrarla desde AgentBot.