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:

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://connector.ms.altubots.com/<slug>/api/<id_integracao>

Headers

NameTypeDescription

Content-Type:*

string

application/json

Request Body

NameTypeDescription

Authorization*

string

token gerado no ALTU

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

Body:

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

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.

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

Para que o POST no callback seja realizado, é obrigatório informar tanto a URL quanto o Token.

Last updated