Enviar Mensagem
Enviar menu interativo (botões, carrosel, lista ou enquete)
/send/menuConta no limite de envio da conexão. Ao passar do limite, a resposta é 429.
Autenticação: envie a chave da conexão no header token ou em Authorization: Bearer.
Este endpoint oferece uma interface unificada para envio de quatro tipos principais de mensagens interativas:
- Botões: Para ações rápidas e diretas
- Carrosel de Botões: Para uma lista horizontal de botões com imagens
- Listas: Para menus organizados em seções
- Enquetes: Para coleta de opiniões e votações
Suporte a campos de rastreamento: Este endpoint também suporta track_source e track_id documentados na tag "Enviar Mensagem".
Estrutura Base do Payload
Todas as requisições seguem esta estrutura base:
{
"number": "5511999999999",
"type": "button|list|poll|carousel",
"text": "Texto principal da mensagem",
"choices": ["opções baseadas no tipo escolhido"],
"footerText": "Texto do rodapé (opcional para botões e listas)",
"listButton": "Texto do botão (para listas)",
"selectableCount": "Número de opções selecionáveis (apenas para enquetes)"
}Tipos de Mensagens Interativas
1. Botões (type: "button")
Cria botões interativos com diferentes funcionalidades de ação.
Campos Específicos
footerText: Texto opcional exibido abaixo da mensagem principalchoices: Array de opções que serão convertidas em botões
Formatos de Botões
Cada botão pode ser configurado usando | (pipe) ou \n (quebra de linha) como separadores:
- Botão de Resposta:
"texto|id"ou"texto\nid"ou"texto"(ID será igual ao texto)- Botão de Cópia:
"texto|copy:código"ou"texto\ncopy:código"- Botão de Chamada:
"texto|call:+5511999999999"ou"texto\ncall:+5511999999999"- Botão de URL:
"texto|https://exemplo.com"ou"texto|url:https://exemplo.com"
Botões com Imagem
Para adicionar uma imagem aos botões, use o campo imageButton no payload:
Exemplo com Imagem
{
"number": "5511999999999",
"type": "button",
"text": "Escolha um produto:",
"imageButton": "https://exemplo.com/produto1.jpg",
"choices": [
"Produto A|prod_a",
"Mais Info|https://exemplo.com/produto-a",
"Produto B|prod_b",
"Ligar|call:+5511999999999"
],
"footerText": "Produtos em destaque"
}> Suporte: O campo imageButton aceita URLs ou imagens em base64.
Exemplo Completo
{
"number": "5511999999999",
"type": "button",
"text": "Como podemos ajudar?",
"choices": [
"Suporte Técnico|suporte",
"Fazer Pedido|pedido",
"Nosso Site|https://exemplo.com",
"Falar Conosco|call:+5511999999999"
],
"footerText": "Escolha uma das opções abaixo"
}Limitações e Compatibilidade
> Importante: Ao combinar botões de resposta com outros tipos (call, url, copy) na mesma mensagem, será exibido o aviso: "Não é possível exibir esta mensagem no WhatsApp Web. Abra o WhatsApp no seu celular para visualizá-la."
2. Listas (type: "list")
Cria menus organizados em seções com itens selecionáveis.
Campos Específicos
listButton: Texto do botão que abre a listafooterText: Texto opcional do rodapéchoices: Array com seções e itens da lista
Formato das Choices
"[Título da Seção]": Inicia uma nova seção"texto|id|descrição": Item da lista com:- texto: Label do item
- id: Identificador único, opcional
- descrição: Texto descritivo adicional e opcional
Exemplo Completo
{
"number": "5511999999999",
"type": "list",
"text": "Catálogo de Produtos",
"choices": [
"[Eletrônicos]",
"Smartphones|phones|Últimos lançamentos",
"Notebooks|notes|Modelos 2024",
"[Acessórios]",
"Fones|fones|Bluetooth e com fio",
"Capas|cases|Proteção para seu device"
],
"listButton": "Ver Catálogo",
"footerText": "Preços sujeitos a alteração"
}3. Enquetes (type: "poll")
Cria enquetes interativas para votação.
Campos Específicos
selectableCount: Número de opções que podem ser selecionadas (padrão: 1)choices: Array simples com as opções de voto
Exemplo Completo
{
"number": "5511999999999",
"type": "poll",
"text": "Qual horário prefere para atendimento?",
"choices": [
"Manhã (8h-12h)",
"Tarde (13h-17h)",
"Noite (18h-22h)"
],
"selectableCount": 1
}4. Carousel (type: "carousel")
Cria um carrossel de cartões com imagens e botões interativos.
Campos Específicos
choices: Array com elementos do carrossel na seguinte ordem:[Texto do cartão]: Texto do cartão entre colchetes{URL ou base64 da imagem}: Imagem entre chaves- Botões do cartão (um por linha):
"texto|copy:código"para botão de copiar"texto|https://url"para botão de link"texto|call:+número"para botão de ligação
Exemplo Completo
{
"number": "5511999999999",
"type": "carousel",
"text": "Conheça nossos produtos",
"choices": [
"[Smartphone XYZ\nO mais avançado smartphone da linha]",
"{https://exemplo.com/produto1.jpg}",
"Copiar Código|copy:PROD123",
"Ver no Site|https://exemplo.com/xyz",
"Fale Conosco|call:+5511999999999",
"[Notebook ABC\nO notebook ideal para profissionais]",
"{https://exemplo.com/produto2.jpg}",
"Copiar Código|copy:NOTE456",
"Comprar Online|https://exemplo.com/abc",
"Suporte|call:+5511988888888"
]
}> Nota: Criamos outro endpoint para carrossel: /send/carousel, funciona da mesma forma, mas com outro formato de payload. Veja o que é mais fácil para você.
Termos de uso
Os recursos de botões interativos e listas podem ser descontinuados a qualquer momento sem aviso prévio. Não nos responsabilizamos por quaisquer alterações ou indisponibilidade destes recursos.
Alternativas e Compatibilidade
Considerando a natureza dinâmica destes recursos, nosso endpoint foi projetado para facilitar a migração entre diferentes tipos de mensagens (botões, listas e enquetes).
Recomendamos criar seus fluxos de forma flexível, preparados para alternar entre os diferentes tipos.
Em caso de descontinuidade de algum recurso, você poderá facilmente migrar para outro tipo de mensagem apenas alterando o campo "type" no payload, mantendo a mesma estrutura de choices.
Corpo da requisição (JSON)
| Campo | Tipo | Descrição |
|---|---|---|
| number* | string | ID do chat para o qual a mensagem será enviada. Pode ser um número de telefone em formato internacional, um ID de grupo ( Exemplo: 5511999999999 |
| type* | string | Tipo do menu (button, list, poll, carousel) Exemplo: list |
| text* | string | Texto principal (aceita placeholders) Exemplo: Escolha uma opção: |
| footerText | string | Texto do rodapé (opcional) Exemplo: Menu de serviços |
| listButton | string | Texto do botão principal Exemplo: Ver opções |
| selectableCount | integer | Número máximo de opções selecionáveis (para enquetes) Exemplo: 1 |
| choices* | array<string> | Lista de opções. Use [Título] para seções em listas Exemplo: [Eletrônicos],Smartphones|phones|Últimos lançamentos,Notebooks|notes|Modelos 2024,[Acessórios],Fones|fones|Bluetooth e com fio,Capas|cases|Proteção para seu device |
| imageButton | string | URL da imagem para botões (recomendado para type: button) Exemplo: https://exemplo.com/imagem-botao.jpg |
| replyid | string | ID da mensagem para responder Exemplo: 3EB0538DA65A59F6D8A251 |
| mentions | string | Números para mencionar (separados por vírgula) Exemplo: 5511999999999,5511888888888 |
| readchat | boolean | Marca conversa como lida após envio Exemplo: true |
| readmessages | boolean | Marca últimas mensagens recebidas como lidas Exemplo: true |
| delay | integer | Atraso em milissegundos antes do envio, durante o atraso apacerá 'Digitando...' Exemplo: 1000 |
| track_source | string | Origem do rastreamento da mensagem Exemplo: chatwoot |
| track_id | string | ID para rastreamento da mensagem (aceita valores duplicados) Exemplo: msg_123456789 |
| async | boolean | Se true, envia a mensagem de forma assíncrona via fila interna Exemplo: false |
* obrigatório
Respostas
- 200Menu enviado com sucesso
- 400Requisição inválida
- 401Não autorizado
- 429Limite de requisições excedido
- 500Erro interno do servidor
Experimente
Atenção: a chamada é real. Ela roda na sua conexão e pode enviar mensagem de verdade. A chave fica só nesta tela e some ao sair dela; nunca é guardada.