Authorization: Bearer {BearerToken}.
Ao contrário dos endpoints de Enviar Mensagens, os endpoints interativos de Baileys, Zapo e UazAPI usam
ticketId em vez de number: eles enviam dentro de uma conversa que já existe. Obtenha o ticketId pelo webhook do canal (ticket.id) ou pela listagem de atendimentos (listTickets). Cada rota exige que a API usada esteja ligada a um canal do tipo indicado na tabela abaixo.Baileys
Canais conectados via Baileys (QR Code) suportam seis tipos de mensagem interativa.Resposta Rápida (Botões)
Envia até 3 botões de resposta rápida abaixo de uma mensagem de texto.Seleção Única (Lista)
Envia um menu em formato de lista, agrupado em seções, acionado por um botão “Ver opções”.Botão de PIX
Envia uma mensagem com os dados da chave PIX (beneficiário, tipo e chave) e um botão Copiar chave PIX, que copia a chave para o contato colar no app do banco (copia e cola).CTA: Copiar Código
Envia um botão que copia um código (cupom, rastreio, token) para a área de transferência do contato.CTA: Abrir URL
CTA: Ligar
Zapo
Canais conectados via Zapo suportam os mesmos seis tipos do Baileys acima (quickReply, singleSelect, pixButton, ctaCopy, ctaUrl e ctaCall), com campos idênticos, apenas trocando o segmento da URL de baileys para zapo:
Enquete (Zapo)
Além dos seis tipos compartilhados, o Zapo oferece um sétimo tipo: enquetes nativas do WhatsApp. O UazAPI também tem enquete, com campos próprios (veja a seção UazAPI abaixo).UazAPI
Canais conectados via UazAPI têm seu próprio conjunto de sete tipos interativos, com nomes de campo próprios (text/choices em vez de body/buttons).
Botão
Lista
Enquete
Carrossel
Envia uma série de cartões navegáveis horizontalmente, cada um com imagem, texto e botões próprios.Botão de PIX
Botão de Localização
Solicita que o próprio contato compartilhe a localização dele pelo WhatsApp.Solicitar Pagamento
Envia uma cobrança formatada com valor, descrição e dados de PIX para pagamento.WABA (Oficial)
Canais WABA têm apenas dois tipos interativos suportados pela Cloud API da Meta (botões de resposta rápida e listas) e, diferente dos provedores acima, endereçam o destinatário pornumber (podendo também fixar em um ticketId específico).
Estas duas rotas exigem canal do tipo WhatsApp Business API (
waba). Canais Dialog360 e Gupshup respondem 400 ERR_CHANNEL_WABA_REQUIRED.Botões (SendButtonWABA)
Lista (SendListWABA)
Respostas
Em caso de sucesso, a resposta trazsuccess: true e os dados do envio em data. Nos canais Baileys, data é a própria mensagem registrada no WhatsApp: key (com remoteJid, fromMe e id, o ID da mensagem), message (o conteúdo interativo enviado), messageTimestamp e status (PENDING logo após o envio).
{ "success": false, "error": "..." }:
A seleção feita pelo contato (botão tocado, item da lista escolhido, resposta da enquete) chega de volta como uma mensagem recebida no webhook do canal: consulte Webhooks.

