This endpoint allows sending a carousel with images and interactive buttons.
It works the same way as the /send/menu endpoint with type: carousel, but using a different payload format.
This endpoint supports all common optional fields documented in the “Send Message” tag, including:
delay, readchat, readmessages, replyid, mentions, forward, track_source, track_id, placeholders, and sending to groups.
{
"number": "5511999999999",
"text": "Main text",
"carousel": [
{
"text": "Card text",
"image": "Image URL",
"buttons": [
{
"id": "reply1",
"text": "Button text",
"type": "REPLY"
}
]
}
],
"delay": 1000,
"readchat": true
}
REPLY: Quick reply button
URL: Button with link
COPY: Button to copy text
CALL: Button to make a call
{
"buttons": [
{
"id": "Yes, I want to buy!",
"text": "Confirm Purchase",
"type": "REPLY"
},
{
"id": "[https://example.com/product](https://example.com/product)",
"text": "View Product",
"type": "URL"
},
{
"id": "COUPON20",
"text": "Copy Coupon",
"type": "COPY"
},
{
"id": "5511999999999",
"text": "Speak to Seller",
"type": "CALL"
}
]
}
{
"number": "5511999999999",
"text": "Our Featured Products",
"carousel": [
{
"text": "Smartphone XYZ\nThe most advanced smartphone in the line",
"image": "[https://example.com/product1.jpg](https://example.com/product1.jpg)",
"buttons": [
{
"id": "YES_BUY_XYZ",
"text": "Buy Now",
"type": "REPLY"
},
{
"id": "[https://example.com/xyz](https://example.com/xyz)",
"text": "View Details",
"type": "URL"
}
]
},
{
"text": "Discount Coupon\nGet 20% OFF on any product",
"image": "[https://example.com/coupon.jpg](https://example.com/coupon.jpg)",
"buttons": [
{
"id": "DISCOUNT20",
"text": "Copy Coupon",
"type": "COPY"
},
{
"id": "5511999999999",
"text": "Speak to Seller",
"type": "CALL"
}
]
}
],
"delay": 0,
"readchat": true
}
Recipient number (international format)
"5511999999999"
Main message text
"Our Featured Products"
Array of carousel cards
Message tracking source
"chatwoot"
ID for message tracking (accepts duplicate values)
"msg_123456789"
Carousel sent successfully
Representa uma mensagem trocada no sistema
ID único interno da mensagem (formato r + 7 caracteres hex aleatórios)
ID original da mensagem no provedor
ID da conversa relacionada
Indica se a mensagem foi enviada pelo usuário
Indica se é uma mensagem de grupo
Tipo de conteúdo da mensagem
text, image, video, document, audio, location, button, list, reaction Timestamp original da mensagem em milissegundos
Histórico de edições da mensagem
ID da mensagem citada/respondida
ID da mensagem reagida
ID do remetente da mensagem
Nome exibido do remetente
Plataforma de origem da mensagem
ios, web, android Status do ciclo de vida da mensagem
pending, sent, delivered, read, failed, deleted Texto original da mensagem
Dados de votação de enquete e listas
ID do botão ou item de lista selecionado
Conversão de opções de da mensagem, lista, enquete e botões
URL para download de arquivos de mídia
Conteúdo completo da mensagem em formato JSON
Dono da mensagem
Origem do rastreamento da mensagem
ID para rastreamento da mensagem (aceita valores duplicados)
Data de criação no sistema (formato SQLite YYYY-MM-DD HH:MM:SS.FFF)
Data da última atualização (formato SQLite YYYY-MM-DD HH:MM:SS.FFF)
Metadados do processamento por IA