A Agents API tem como objetivo abrir a plataforma da Aivo para uma comunidade de integradores, facilitando o desenvolvimento de conexões entre os usuários que interagem em nossos diversos canais e os Agentes em qualquer plataforma. Dessa forma, as comunicações entre sistemas são padronizadas.
Para alcançar esse propósito, propomos um fluxo de integração orientado a eventos, no qual o cliente (parceiro) deverá configurar um Webhook de notificação para receber os diferentes eventos conversacionais gerados pelo Aivo (como transferências, mensagens e encerramentos). Será responsabilidade do cliente gerenciar e processar esses eventos.
Além disso, a Aivo disponibilizará a Agents API, que permitirá ao cliente interagir diretamente com o usuário por meio dos eventos mencionados.
▶️ Aivo para Webhook (Event Hook):
O propósito deste Webhook é enviar eventos conversacionais gerados dentro do Aivo. Ele é baseado em um protocolo REST e será enviado usando o método POST em formato JSON. Os três eventos que serão tratados são os seguintes:
- Evento de Fila (Queue Event): acionado quando o AgentBot inicia uma transferência (derivação) para um agente humano.
- Evento de Mensagem (Message Event): acionado quando o usuário escreve uma nova mensagem em uma conversa atendida por um agente humano.
- Evento de Encerramento (Close Event): acionado quando o usuário sai do canal ou quando a conversa fica inativa por mais de 24 horas.
Acesse aqui para consultar a API Reference de Webhooks.
▶️ Requests Webhook para Aivo:
O propósito deste endpoint é receber novas mensagens destinadas ao usuário final.
Gateway: https://agents-api.agentbot.net/{{chanelId}}/{{action}}
Este endpoint utiliza o método POST para receber as informações, e o payload deve estar em formato JSON. Os eventos que serão tratados no adaptador são os seguintes:
- Attended: notifica o usuário de que sua solicitação foi atendida por um Agente.
- Message: envia uma mensagem do Agente para o Usuário.
- endConversation: notifica o Usuário de que a conversa foi encerrada e a fecha a partir do AgentBot.