Integração de Chatbots de terceiros com a plataforma Hi Social

Introdução

Para clientes que já possuem integração de suas páginas com outra solução de bot, a Hi oferece uma API que pode ser utilizada para facilitar o trabalho de seus atendentes.

POST /api/forward_conversation_to_human.json POST /api/forward_conversation_to_human.xml

Fluxo

O fluxo de um atendimento com bot é muito simples. Conversas que são atendidas pelo bot sem necessitar de intervenção humana não passam pelo nosso fluxo de integração.

Assim que o bot encaminhar a conversa para um atendente, deve ser feita uma chamada para a nossa API avisando que essa conversa deve ser atendida por uma pessoa. Durante esse período, o bot não deve responder como mensagens recebidas. Porém, a cada nova mensagem recebida, o bot deve chamar nossa API para verificar o status da conversa. Caso o chamado já tenha sido finalizado pelo atendente, o bot pode voltar a responder e o fluxo se repetir.

Liberar Conversa para Atendente

Esse método pega o chamado referente a esse id de thread, que anteriormente estava oculto no sistema, e disponibiliza para um atendente. A partir desse momento, o chamado é de responsabilidade do atendimento até que seja finalizado.

Parâmetro obrigatório:             
search_id:             ID do Projeto onde está sendo feito o atendimento. Ver endpoint “pesquisa” em nossa API. 
thread_id:              ID do tópico             da conversa no Facebook.

Retorno em JSON:

{

"response": {

"status": "200 OK",

"code": 200

}

}

Retorno em XML:

<?xml version="1.0" encoding="UTF-8"?>
<seekr>
<response>
<status>200 OKstatus>
<code type="integer">200code>
response>
seekr>

Verificar Status da Conversa

GET /api/conversation_status.json GET /api/conversation_status.xml

Pega o status do chamado referente a esse ID de thread. Caso o status dele seja finalizado (“F”), o bot pode voltar a responder como mensagens desse usuário, e avisar o sistema novamente caso um atendente seja requisitado. Outros status possíveis são null, onde o chamado ainda não foi atribuido a nenhum atendente; aberto (“A”), onde o chamado já foi aberto e encaminhado; e respondido (“R”), onde o atendente já está se comunicando com o consumidor.

Parâmetro obrigatório:             
search_id:             ID do Projeto onde está sendo feito o atendimento. Ver endpoint “pesquisa” em nossa API. 
thread_id:              ID do tópico             da conversa no Facebook.

Retorno em JSON:

{

"response": {

"status": "200 OK",

"code": 200

}

"status": "F"

}

Retorno em XML:

<?xml version="1.0" encoding="UTF-8"?>
<seekr>
<response>
<status>200 OKstatus>
<code type="integer">200code>
response>
<status>Fstatus>
seekr>