Objetivo

O Agent Connector API permite que plataformas externas realizem atendimentos de Live Chat no Zenvia NLU.

API Agent Connect

Esta API consiste no envio e recebimento de eventos, através de chamadas http. Diante disso, esteja atento às seguintes informações:

• O Zenvia NLU enviará eventos para o Live Chat através de chamadas POST ao webhook configurado na integração;
• O Live Chat enviará eventos para o Zenvia NLU por meio de chamadas POST ao endpoint https://agent.altubots.com/altu-connector/{slug}/{livechatId};
• A autenticação do envio e recebimento de eventos será feita via JWT. Esse processo será detalhado na conclusão do desenvolvimento;

Todo evento enviado e recebido deve ter no corpo um JSON com o seguinte formato:

{
 "action":"Tipo do evento",
 "conversationID":"Id único que identifica a conversa de live chat",
 "identifier":"Id único que identifica a usuário no ALTU",
 "parameters":{
 ...
 },
 "timestamp":"Horário do envio do evento em formato UNIX timestamp"
}

💡 Dica: Você também pode enviar dados do usuário para o agente. Para configurar, acesse esta documentação. 

Autenticação

A autenticação é feita via JWT. Além disso:

• Para cada request deve ser gerado um token novo onde a chave é usada para encriptar o token de acesso;
• O Token de acesso (access_token) e a Chave de acesso (access_key) são obtidos na integração cadastrada no Zenvia NLU.

{
 "alg": "RS256",
 "typ": "JWT"
}
.
{
 "access_token": "pDD8w6VeTjnk03MxGqwSsEneuaykfkVvfpfUnus2",
 "iat": 1653066200,
 "exp": 1653066260
}

• Assine o JWT com HS256 usando a chave de acesso (access_key);
• Para o campo iat, especifique a hora Unix atual, e para o campo exp, especifique a hora exatamente 60 segundos depois, que é quando o JWT irá expirar;
• É fundamental que o tempo de expiração seja de no máximo 60 segundos (exp).

Eventos

Todo evento deve possuir um atributo action que identifica o propósito do que está sendo enviado/solicitado.

Actions que Zenvia NLU envia para a plataforma Livechat