Enviar Mensagem
Enviar carrossel de mídia com botões
/send/carouselConta 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 permite enviar um carrossel com imagens e botões interativos. Funciona de maneira igual ao endpoint /send/menu com type: carousel, porém usando outro formato de payload.
Campos Comuns
Este endpoint suporta todos os campos opcionais comuns documentados na tag "Enviar Mensagem", incluindo: delay, readchat, readmessages, replyid, mentions, forward, track_source, track_id, placeholders e envio para grupos.
Estrutura do Payload
{
"number": "5511999999999",
"text": "Texto principal",
"carousel": [
{
"text": "Texto do cartão",
"image": "URL da imagem",
"buttons": [
{
"id": "resposta1",
"text": "Texto do botão",
"type": "REPLY"
}
]
}
],
"delay": 1000,
"readchat": true
}Tipos de Botões
REPLY: Botão de resposta rápida- Quando clicado, envia o valor do id como resposta ao chat
- O id será o texto enviado como resposta
URL: Botão com link- Quando clicado, abre a URL especificada
- O id deve conter a URL completa (ex: https://exemplo.com)
COPY: Botão para copiar texto- Quando clicado, copia o texto para a área de transferência
- O id será o texto que será copiado
CALL: Botão para realizar chamada- Quando clicado, inicia uma chamada telefônica
- O id deve conter o número de telefone
Exemplo de Botões
{
"buttons": [
{
"id": "Sim, quero comprar!",
"text": "Confirmar Compra",
"type": "REPLY"
},
{
"id": "https://exemplo.com/produto",
"text": "Ver Produto",
"type": "URL"
},
{
"id": "CUPOM20",
"text": "Copiar Cupom",
"type": "COPY"
},
{
"id": "5511999999999",
"text": "Falar com Vendedor",
"type": "CALL"
}
]
}Exemplo Completo de Carrossel
{
"number": "5511999999999",
"text": "Nossos Produtos em Destaque",
"carousel": [
{
"text": "Smartphone XYZ\nO mais avançado smartphone da linha",
"image": "https://exemplo.com/produto1.jpg",
"buttons": [
{
"id": "SIM_COMPRAR_XYZ",
"text": "Comprar Agora",
"type": "REPLY"
},
{
"id": "https://exemplo.com/xyz",
"text": "Ver Detalhes",
"type": "URL"
}
]
},
{
"text": "Cupom de Desconto\nGanhe 20% OFF em qualquer produto",
"image": "https://exemplo.com/cupom.jpg",
"buttons": [
{
"id": "DESCONTO20",
"text": "Copiar Cupom",
"type": "COPY"
},
{
"id": "5511999999999",
"text": "Falar com Vendedor",
"type": "CALL"
}
]
}
],
"delay": 0,
"readchat": true
}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 |
| text* | string | Texto principal da mensagem Exemplo: Nossos Produtos em Destaque |
| carousel* | array<object> | Array de cartões do carrossel |
| delay | integer | Atraso em milissegundos antes do envio Exemplo: 1000 |
| readchat | boolean | Marca conversa como lida após envio Exemplo: true |
| readmessages | boolean | Marca últimas mensagens recebidas como lidas Exemplo: true |
| replyid | string | ID da mensagem para responder Exemplo: 3EB0538DA65A59F6D8A251 |
| mentions | string | Números para mencionar (separados por vírgula) Exemplo: 5511999999999,5511888888888 |
| forward | boolean | Marca a mensagem como encaminhada no WhatsApp Exemplo: false |
| async | boolean | Se true, envia a mensagem de forma assíncrona via fila interna Exemplo: false |
| track_source | string | Origem do rastreamento da mensagem Exemplo: chatwoot |
| track_id | string | ID para rastreamento da mensagem (aceita valores duplicados) Exemplo: msg_123456789 |
* obrigatório
Respostas
- 200Carrossel enviado com sucesso
- 400Requisição inválida
- 401Não autorizado
- 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.