Nos detalhes técnicos abaixo, você encontrará as diferentes respostas que reportaremos ao webhook que você indicar, quando você executar os diferentes endpoints de consulta disponíveis no API Live.
⇒ Lembre-se de que o webhook é essencial, pois será o espaço que permitirá que você receba as respostas ou os eventos, que serão os de atenção, transferência, mensagem do cliente e encerramento da conversa.
1. Evento de atenção: esse evento será enviado quando qualquer agente receber a conversa que foi colocada na fila, seja devido a um evento de fila causado por você ou a um evento de transferência causado por outro agente. O evento tem o seguinte formato:
{ "name": "attended", "roomId": "d5211892-e170-4d4a-b2dd-de705b595674", "timestamp": 1706293970842633079, "botId": 1000, "eventTime": 1706293970, "data": { "agent": { "name": "Tomas", "nickname": "Tomas NICKK", "groupId": 2179 } } } |
2. Evento de transferência: será enviado quando um evento de transferência for executado, o que significa que a conversa terá um destino diferente daquele para o qual foi enfileirada. Por exemplo, a conversa foi passada para o grupo de Atendimento ao Cliente e depois foi encaminhada para o grupo de Vendas para fechar o negócio com o cliente em questão. O evento tem o seguinte formato:
|
Dados-chave
- O campo do grupo de origem refere-se à identificação do grupo do qual a conversa está sendo transferida.
- O campo de destino refere-se ao ID do grupo que a conversa busca alcançar. Ou seja, o destino.
3. Evento de mensagem para cliente: esse evento relatará todas as mensagens gravadas no lado do agente/ao vivo e direcionadas ao cliente/usuário. O evento tem o seguinte formato:
{ "name": "messageToClient", "roomId": "7f185acb-214f-4d59-8612-357796a146b7", "timestamp": 1706293179331454146, "botId": 1000, "eventTime": 1706293179, "data": { "action": "text", "value": "Posso ajudá-lo com mais alguma coisa?1", "source": "trigger", "hash": "b9e8f46b56efbace7a64cdab3_71146a36682af3c0915577", "agent": {} } } |
Dados-chave
- O campo de origem pode ser o agente ou o trigger.
- O campo Action (Ação) pode ser um texto, uma imagem ou um arquivo. O campo Value (Valor) pode ser o texto que o agente digitou ou o diretório do arquivo/imagem.
4. Evento de encerramento de conversa: será publicado sempre que a conversa for encerrada. No campo motivo, dentro de sua estrutura, você verá informações adicionais sobre o motivo do encerramento. Por exemplo, fechamento do agente, fechamento devido ao acionador de inatividade, fechamento devido à fila de espera etc. O evento tem o seguinte formato:
{ "name": "close", "roomId": "21f4e58c-c1c3-452c-b7d3-b0c93aca0986", "timestamp": 1706293127429583428, "botId": 1000, "eventTime": 1706293127, "data": { "hash": "b9e8f46b56efbace7a64cdab3_7114636682af3c0915577", "reason": "queue clean process", "agent": {} } } { "name": "close", "roomId": "27101a99-d4f2-4c0c-98ad-8fe65366362d", "timestamp": 1706289577835959833, "botId": 1000, "eventTime": 1706289577, "data": { "hash": "b9e8f46b56efbace764cdab3_7114636682f3c0915577", "reason": "agent", "agent": {} } } |