Como Configurar e Utilizar o Canal Custom (API) no Ligo Bots

O canal Custom foi desenvolvido para clientes que desejam centralizar diversos canais de comunicação dentro de sua própria infraestrutura. Com ele, o Ligo Bots pode orquestrar a interação do bot e encaminhar mensagens para uma URL personalizada via API.

Configuração

1. Ative o canal Custom
   • No painel do Ligo Bots, acesse as configurações do seu chatbot e ative o canal Custom.
   • Cadastre a URL que receberá as mensagens do bot (por exemplo, uma URL do NGROK).
2. Salve e gere a chave de API
   • Após cadastrar a URL, clique em “Salvar”.
   • Em seguida, clique em “Gerar chave” para criar a chave de API.
   • Clique em “Ver key” e depois em “Ver” para visualizar a chave gerada.
   • Atenção: Guarde a chave em local seguro, pois ela só poderá ser visualizada uma única vez.
3. Integração
   • Sempre que uma mensagem for enviada ao Ligo Bots, uma nova sessão será criada e os dados serão enviados para a URL cadastrada.

Custom Channel API

• Serviço: ‎`wapp.boteria.com.br`

Endpoints principais

Cabeçalho da requisição:

• Authorization: Bearer ‎`[sua-chave-de-api]`

Parâmetros comuns

• ‎`clientId`: string – Identificação do cliente/sessão (ex: número de telefone)
• ‎`parameters`: string (JSON) – Parâmetros para nova sessão (ex: ‎`{ “name”: “John” }`)
• ‎`text`: texto da mensagem
• ‎`media`: objeto de mídia

Exemplos de Payload

Mensagem de texto

{  "parameters": "{'name':'John Doe'}",  "clientId": "5511989898989",  "text": {    "body": "Hello World!"  }}

Mensagem de mídia

{  "parameters": "{'name':'John Doe'}",  "clientId": "5511989898989",  "media": {    "file": {      "content": "BASE_64"    }  }}

Status

{  "clientId": "5511989898989",  "status": "read",  "messageId": "d1a8db26-c820-4109-827e-9f6749660e31"}

Mensagem com botões de sugestão

{  "to": "551198989999",  "id": "6964beac-2e7e-4b18-b0c1-883df1772d2f",  "type": "text",  "text": {    "type": "Text",    "body": "Olá bom dia"  },  "suggestionList": [ "Exemplo de texto" ]}

Mensagem de menu

{  "to": "551198989999",  "id": "6964beac-2e7e-4b18-b0c1-883df1772d2f",  "type": "text",  "text": {    "type": "Text",    "body": "Olá bom dia",    "menuItems": [      { "option": 1, "description": "Opc 1" },      { "option": 2, "description": "Opc 2" }    ]  },  "suggestionList": [    { "option": 1, "description": "Opc 1" },    { "option": 2, "description": "Opc 2" }  ]}

Mensagem de imagem

{  "to": "551198989999",  "id": "ac692d2b-d62f-4b65-8d0d-7df40abd09c1",  "type": "media",  "media": {    "type": "Image",    "file": {      "name": "Titulo do bot",      "content": "URL da Imagem",      "title": "Titulo da Imagem",      "altText": "Texto Alternativo da Imagem"    }  }}

Mensagem de carrossel

{  "to": "551198989999",  "id": "cdcb3c0b-ef15-407d-aed5-c2c757d9b4a9",  "type": "carousel",  "cards": [    {      "title": "Título do Card 01",      "imageUrl": "URL da imagem do card 01",      "altText": "Descrição Imagem do card 01",      "buttons": [        {          "name": "botão 1",          "label": "Botão 01 card 01",          "destination": {            "type": "url",            "value": "URL de destino"          }        }      ]    }  ]}

Ação de clique em botão do carrossel

{  "clientId": "551198989999",  "action": {    "type": "CAROUSEL",    "clickedCardTitle": "Título do Card Selecionado",    "clickedButtonLabel": "Botão 02 card 02",    "destination": {      "value": "666b226f4a10780b14d3c292",      "type": "item"    }  }}