CONNECT
Bot API
O bot API é um serviço que permite iniciar atendimentos com integração por meio de uma API.
Configurações
Adicione uma nova API com as seguintes informações:
- Nome: nome que deseja para a API
- Assistente: selecione o assistente >adicionar o link da página de assistentes da doc<
- Squad: selecione o nome da squad se estiver disponível na lista, caso contrário mantenha como “geral”
Após criar, acesse sua área de edição para configurar algumas opções:
V1
Processo síncrono
O processo síncrono é utilizado para a V1, na qual um
input é passado e a requisição fica pausada até que o motor de inteligência artificial responda para o usuário.post
https://www.altubots.com/api/
<slug>/<id_assistente>
Body:
1
{
2
"input": {
3
"text": "Olá"
4
},
5
"identifier": "{identificador_do_contato}",
6
"context": {
7
"var1": "value1",
8
"var2": "value2"
9
},
10
"returnContext": true
11
}
Copied!
O parâmetro
returnContext é opcional e por padrão o valor é false. Se passado (e com valor true) irá retornar as variáveis de contexto do atendimento.Header:
1
Content-Type: application/json
2
Authorization: <token autogerado pelo ALTU>
Copied!
V2
Processo assíncrono:
O processo assíncrono é utilizado na V2, nesta temos a possibilidade de configurar um callback, que é o endpoint informado na tela de configuração da API que irá receber a resposta do assistente após uma requisição com input.
post
https://www.altubots.com/api/
v2/<slug>/<id_assistente>
Body:
1
{
2
"input": {
3
"text": "Olá"
4
},
5
"identifier": "{identificador_do_contato}",
6
"context": {
7
"var1": "value1",
8
"var2": "value2"
9
}
10
}
Copied!
Para obter o contexto é necessário marcar a opção "Incluir contexto do atendimento na resposta", disponível na tela de configuração da API.
Header:
1
Content-Type: application/json
2
Authorization: <token autogerado pelo ALTU>
Copied!
Para que o POST no callback seja realizado, é obrigatório informar tanto a
URL quanto o Token.
Last modified 4mo ago
Copy link