Os endpoints interativos criam mensagens no estilo de fluxo nativo ou template do WhatsApp. Alguns deles possuem limitações de licença no código através da verificação de limite de leitura (scan).
O suporte a mensagens interativas do WhatsApp pode variar de acordo com o tipo de conta, versão do aplicativo do destinatário, região e alterações feitas pelo próprio WhatsApp. Teste cada payload com seu próprio dispositivo antes de disponibilizá-lo aos clientes.
Mapa de endpoints
| Endpoint | Objetivo |
|---|
POST /send/buttons | Envia texto com um ou mais botões de resposta rápida ou CTA. |
POST /send/mediabutton | Envia botões com mídia de cabeçalho (imagem, vídeo ou documento). |
POST /send/template | Envia uma mensagem de botão no estilo template. |
POST /send/list | Envia uma mensagem de lista com seções e linhas. |
POST /send/locationbutton | Envia um botão nativo de solicitação de localização. |
POST /send/pixbutton | Envia um payload de botão de pagamento PIX. |
POST /send/reviewpay | Envia um payload de pagamento no estilo review-and-pay. |
POST /send/carousel | Envia um carrossel com cartões de texto e botões. |
POST /send/carouselmedia | Envia um carrossel onde os cartões incluem mídia. |
Tipos de botões
Os manipuladores de carrossel suportam tipos de botões como:
| Tipo | Comportamento |
|---|
url | Abre uma URL. |
webview | Abre uma URL com flags de interação webview. |
reply | Envia um payload de resposta rápida. |
copy | Copia um valor de código. |
call | Inicia uma chamada telefônica (CTA). |
Exemplo de carrossel
{
"phone": "15551234567",
"message": "Choose a product",
"carousel": [
{
"text": "Starter plan",
"buttons": [
{
"id": "starter",
"label": "Select",
"type": "reply"
},
{
"label": "Open",
"url": "https://example.com/starter",
"type": "url"
}
]
}
]
}
O /send/carouselmedia suporta mídia por cartão:
{
"phone": "15551234567",
"message": "Catalog",
"carousel": [
{
"text": "Product",
"media_url": "https://example.com/product.jpg",
"media_type": "image",
"caption": "Product photo",
"buttons": [
{
"id": "buy-1",
"label": "Buy",
"type": "reply"
}
]
}
]
}
O media_type deve ser image, video, audio ou document, mas o cabeçalho do cartão atualmente gera mídia de imagem, vídeo ou documento.
PIX e review pay
Os endpoints de PIX e review-and-pay Utilize-os para mensagens de WhatsApp no estilo de pagamento brasileiro. Mantenha os valores do payload consistentes com o seu provedor de pagamento e valide os valores no lado do servidor antes de chamar o WaGo.