API WebChat Mensagem de Lista
Envia uma mensagem com uma Lista de opções para o visitante do WebChat, no chat do site. O visitante abre a lista, toca numa opção, e a resposta volta como mensagem dele.
API: WebChat
Endpoint
https://{BACKEND_URL}/api/messages/channels/sendList
Método
POST
Autenticação
Bearer {seutokenaqui}
Payload
{
"number": "session_1745772400000_abc123",
"header": "Cardápio",
"body": "Escolha o seu pedido:",
"footer": "Entrega em 40 minutos",
"buttonText": "Ver opções",
"sections": [
{
"title": "Pizzas",
"rows": [
{
"id": "pz-mussarela",
"title": "Mussarela",
"description": "Molho, mussarela e orégano"
},
{
"id": "pz-calabresa",
"title": "Calabresa"
}
]
}
]
}
“number”: o sessionId do visitante, o identificador da sessão dele no widget. É gerado pelo widget e pode ser obtido via webhook, pela mensagem-marcador do ticket ou pela página de visitantes ao vivo. Sem o
number, informe o ticketId.
O visitante precisa já ter aberto o chat do site: a chamada não começa conversa, e um
number que a empresa não conhece é recusado.
“ticketId”: ID do Ticket, no lugar do
number.
É o número entre parênteses no cabeçalho da conversa. Em João da Silva (52) | #25678, o ticketId é o 52.
O 25678 é o protocolo, e não serve nesta chamada.
“header”: título que aparece acima do texto, até 60 caracteres. Opcional.
“body”: o texto da mensagem, até 1024 caracteres. Não pode ficar vazio. Obrigatório.
“footer”: linha menor abaixo do texto, até 60 caracteres. Opcional.
“buttonText”: o texto do botão que abre a lista, até 20 caracteres. Obrigatório.
No chat do site, o botão aparece com ☰ na frente — em ☰ Ver opções, o visitante toca e a lista abre.
“sections”: até 10 seções, com até 10 itens somando todas. Obrigatório.
“title” da seção: até 24 caracteres. Obrigatório quando há mais de uma seção.
“rows”: os itens da seção. Cada item tem
id (o que volta para a sua integração, até 200 caracteres, sem repetir), title (até 24) e description opcional (até 72).
Campo acima do limite ou faltando é recusado, e a resposta diz qual campo corrigir.
Quando o visitante escolhe um item, o título dele entra no atendimento como mensagem do cliente e chega no webhook da conexão com o
id do item em postback. Com um fluxo rodando no atendimento, a escolha é a resposta do bloco que está esperando.
“assinaturaIa”: opcional — acrescente ao corpo quando quem envia é a sua IA. Mande o nome da IA, com até 100 caracteres, ou
true, que assina como Assistente IA. A mensagem fica marcada como enviada pela IA e aparece na conversa com o nome dela. Sem o campo, ou com false, o envio fica como sempre.
Utilize o código em requisições HTTPS com ferramentas como cURL ou bibliotecas de integração.
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://{BACKEND_URL}/api/messages/channels/sendList',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"number": "session_1745772400000_abc123",
"header": "Cardápio",
"body": "Escolha o seu pedido:",
"footer": "Entrega em 40 minutos",
"buttonText": "Ver opções",
"sections": [
{
"title": "Pizzas",
"rows": [
{
"id": "pz-mussarela",
"title": "Mussarela",
"description": "Molho, mussarela e orégano"
},
{
"id": "pz-calabresa",
"title": "Calabresa"
}
]
}
]
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'Authorization: Bearer {seutokenaqui}' //Token cadastrado na conexão
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;