Como podemos ajudar?

03. Bot API
1 min
Criado por MT em 07/03/2023 13:00
Atualizado por Ligia Sarmento em 23/06/2025 10:26

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:

assets_-MBjaNm5lB1Yqgih1JCA_-MRyU_ysnFPOzG4NZhUV_-MRyVlwDISy6xfRlz57__image.webp

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 e que irá receber a resposta do assistente após uma requisição com input.

POST https://connector.ms.altubots.com/<slug>/api/<id_integracao>

Headers

NameTypeDescription
Content- Typestringapplication/json

Request Body


Name

TypeDescription
Authorizationstringtoken gerado no Zenvia NLU

Responses

200

{
   "code": 200,
   "message": "Message sent."
}

 400

{
   "code": 400,
   "message": "Bad request: body"
}

401

{
   "code": 401,
   "message": "Unauthorized."
}

404

{
   "code": 404,
   "message": "Client not found."
}

500

{
   "code": 500,
   "message": "Unexpected Error."
}

Body

{
   "input": {
     "text": "Olá"
 },
 "identifier": "{identificador_do_contato}",
 "context": {
    "var1": "value1",
    "var2": "value2"
 }
}

⚠️Atenção: 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

Content-Type: application/json
Authorization: <token autogerado pelo ALTU>

⚠️Atenção: para que o POST no callback seja realizado, é obrigatório informar tanto a URL quanto o Token.

assets_-MBjaNm5lB1Yqgih1JCA_-MRyU_ysnFPOzG4NZhUV_-MRy_BhrAV3ctzaH1Zfd_image.webp

Este artigo resolveu sua dúvida?
Últimos artigos visitados