curl --request POST \
--url https://api.wppfy.com/send/carousel \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"number": "5511999999999",
"text": "Nossos produtos",
"carousel": [
{
"text": "Smartphone XYZ",
"image": "https://exemplo.com/produto.jpg",
"buttons": [
{
"id": "comprar_xyz",
"text": "Comprar agora",
"type": "REPLY"
}
]
}
]
}
'import requests
url = "https://api.wppfy.com/send/carousel"
payload = {
"number": "5511999999999",
"text": "Nossos produtos",
"carousel": [
{
"text": "Smartphone XYZ",
"image": "https://exemplo.com/produto.jpg",
"buttons": [
{
"id": "comprar_xyz",
"text": "Comprar agora",
"type": "REPLY"
}
]
}
]
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
number: '5511999999999',
text: 'Nossos produtos',
carousel: [
{
text: 'Smartphone XYZ',
image: 'https://exemplo.com/produto.jpg',
buttons: [{id: 'comprar_xyz', text: 'Comprar agora', type: 'REPLY'}]
}
]
})
};
fetch('https://api.wppfy.com/send/carousel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wppfy.com/send/carousel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'number' => '5511999999999',
'text' => 'Nossos produtos',
'carousel' => [
[
'text' => 'Smartphone XYZ',
'image' => 'https://exemplo.com/produto.jpg',
'buttons' => [
[
'id' => 'comprar_xyz',
'text' => 'Comprar agora',
'type' => 'REPLY'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wppfy.com/send/carousel"
payload := strings.NewReader("{\n \"number\": \"5511999999999\",\n \"text\": \"Nossos produtos\",\n \"carousel\": [\n {\n \"text\": \"Smartphone XYZ\",\n \"image\": \"https://exemplo.com/produto.jpg\",\n \"buttons\": [\n {\n \"id\": \"comprar_xyz\",\n \"text\": \"Comprar agora\",\n \"type\": \"REPLY\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wppfy.com/send/carousel")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"number\": \"5511999999999\",\n \"text\": \"Nossos produtos\",\n \"carousel\": [\n {\n \"text\": \"Smartphone XYZ\",\n \"image\": \"https://exemplo.com/produto.jpg\",\n \"buttons\": [\n {\n \"id\": \"comprar_xyz\",\n \"text\": \"Comprar agora\",\n \"type\": \"REPLY\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/send/carousel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"number\": \"5511999999999\",\n \"text\": \"Nossos produtos\",\n \"carousel\": [\n {\n \"text\": \"Smartphone XYZ\",\n \"image\": \"https://exemplo.com/produto.jpg\",\n \"buttons\": [\n {\n \"id\": \"comprar_xyz\",\n \"text\": \"Comprar agora\",\n \"type\": \"REPLY\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"messageid": "<string>",
"chatid": "<string>",
"sender": "<string>",
"senderName": "<string>",
"isGroup": false,
"fromMe": false,
"messageType": "<string>",
"source": "<string>",
"messageTimestamp": 0,
"status": "<string>",
"text": "",
"quoted": "",
"edited": "",
"reaction": "",
"vote": "",
"convertOptions": "",
"buttonOrListid": "",
"owner": "",
"error": "",
"content": {},
"wasSentByApi": true,
"pinned": true,
"sendFunction": "<string>",
"sendPayload": {},
"fileURL": "<string>",
"callPeer": {
"jid": "<string>",
"name": "<string>",
"imagePreviewUrl": "<string>"
},
"send_folder_id": "<string>",
"track_source": "<string>",
"track_id": "<string>",
"ai_metadata": {
"agent_id": "<string>",
"turn": "<string>",
"flow_id": "<string>",
"request": {
"messages": "<array>",
"tools": "<array>",
"options": {
"model": "<string>",
"temperature": 123,
"maxTokens": 123,
"topP": 123,
"frequencyPenalty": 123,
"presencePenalty": 123
}
},
"response": {
"choices": "<array>",
"toolResults": "<array>",
"error": "<string>"
},
"outcome": {
"status": "sent",
"texts": 123,
"audio": true,
"menus": 123,
"files": 123,
"handoff": "<string>",
"lead": [
"<string>"
],
"detail": "<string>"
}
},
"sender_pn": "<string>",
"sender_lid": "<string>",
"sender_image_preview_url": "<string>",
"response": {
"status": "success",
"message": "Carousel sent successfully"
}
}{
"error": "Missing required fields or invalid card format"
}{
"error": "Invalid token"
}{
"error": "Failed to send carousel"
}Enviar carrossel de mídia com botões
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"
}
]
}
]
}
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"
}
]
}
]
}
curl --request POST \
--url https://api.wppfy.com/send/carousel \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"number": "5511999999999",
"text": "Nossos produtos",
"carousel": [
{
"text": "Smartphone XYZ",
"image": "https://exemplo.com/produto.jpg",
"buttons": [
{
"id": "comprar_xyz",
"text": "Comprar agora",
"type": "REPLY"
}
]
}
]
}
'import requests
url = "https://api.wppfy.com/send/carousel"
payload = {
"number": "5511999999999",
"text": "Nossos produtos",
"carousel": [
{
"text": "Smartphone XYZ",
"image": "https://exemplo.com/produto.jpg",
"buttons": [
{
"id": "comprar_xyz",
"text": "Comprar agora",
"type": "REPLY"
}
]
}
]
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
number: '5511999999999',
text: 'Nossos produtos',
carousel: [
{
text: 'Smartphone XYZ',
image: 'https://exemplo.com/produto.jpg',
buttons: [{id: 'comprar_xyz', text: 'Comprar agora', type: 'REPLY'}]
}
]
})
};
fetch('https://api.wppfy.com/send/carousel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wppfy.com/send/carousel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'number' => '5511999999999',
'text' => 'Nossos produtos',
'carousel' => [
[
'text' => 'Smartphone XYZ',
'image' => 'https://exemplo.com/produto.jpg',
'buttons' => [
[
'id' => 'comprar_xyz',
'text' => 'Comprar agora',
'type' => 'REPLY'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wppfy.com/send/carousel"
payload := strings.NewReader("{\n \"number\": \"5511999999999\",\n \"text\": \"Nossos produtos\",\n \"carousel\": [\n {\n \"text\": \"Smartphone XYZ\",\n \"image\": \"https://exemplo.com/produto.jpg\",\n \"buttons\": [\n {\n \"id\": \"comprar_xyz\",\n \"text\": \"Comprar agora\",\n \"type\": \"REPLY\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wppfy.com/send/carousel")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"number\": \"5511999999999\",\n \"text\": \"Nossos produtos\",\n \"carousel\": [\n {\n \"text\": \"Smartphone XYZ\",\n \"image\": \"https://exemplo.com/produto.jpg\",\n \"buttons\": [\n {\n \"id\": \"comprar_xyz\",\n \"text\": \"Comprar agora\",\n \"type\": \"REPLY\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/send/carousel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"number\": \"5511999999999\",\n \"text\": \"Nossos produtos\",\n \"carousel\": [\n {\n \"text\": \"Smartphone XYZ\",\n \"image\": \"https://exemplo.com/produto.jpg\",\n \"buttons\": [\n {\n \"id\": \"comprar_xyz\",\n \"text\": \"Comprar agora\",\n \"type\": \"REPLY\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"messageid": "<string>",
"chatid": "<string>",
"sender": "<string>",
"senderName": "<string>",
"isGroup": false,
"fromMe": false,
"messageType": "<string>",
"source": "<string>",
"messageTimestamp": 0,
"status": "<string>",
"text": "",
"quoted": "",
"edited": "",
"reaction": "",
"vote": "",
"convertOptions": "",
"buttonOrListid": "",
"owner": "",
"error": "",
"content": {},
"wasSentByApi": true,
"pinned": true,
"sendFunction": "<string>",
"sendPayload": {},
"fileURL": "<string>",
"callPeer": {
"jid": "<string>",
"name": "<string>",
"imagePreviewUrl": "<string>"
},
"send_folder_id": "<string>",
"track_source": "<string>",
"track_id": "<string>",
"ai_metadata": {
"agent_id": "<string>",
"turn": "<string>",
"flow_id": "<string>",
"request": {
"messages": "<array>",
"tools": "<array>",
"options": {
"model": "<string>",
"temperature": 123,
"maxTokens": 123,
"topP": 123,
"frequencyPenalty": 123,
"presencePenalty": 123
}
},
"response": {
"choices": "<array>",
"toolResults": "<array>",
"error": "<string>"
},
"outcome": {
"status": "sent",
"texts": 123,
"audio": true,
"menus": 123,
"files": 123,
"handoff": "<string>",
"lead": [
"<string>"
],
"detail": "<string>"
}
},
"sender_pn": "<string>",
"sender_lid": "<string>",
"sender_image_preview_url": "<string>",
"response": {
"status": "success",
"message": "Carousel sent successfully"
}
}{
"error": "Missing required fields or invalid card format"
}{
"error": "Invalid token"
}{
"error": "Failed to send carousel"
}Autorizações
Corpo
ID do chat para o qual a mensagem será enviada. Pode ser um número de telefone em formato internacional, um ID de grupo (@g.us), um ID de usuário (com @s.whatsapp.net ou @lid).
"5511999999999"
Array de cartões do carrossel
Show child attributes
Show child attributes
Texto principal da mensagem
"Nossos Produtos em Destaque"
Atraso em milissegundos antes do envio
1000
Marca conversa como lida após envio
true
Marca últimas mensagens recebidas como lidas
true
ID da mensagem para responder
"3EB0538DA65A59F6D8A251"
Números para mencionar (separados por vírgula)
"5511999999999,5511888888888"
Marca a mensagem como encaminhada no WhatsApp
false
Se true, envia a mensagem de forma assíncrona via fila interna
false
Origem do rastreamento da mensagem
"chatwoot"
ID para rastreamento da mensagem (aceita valores duplicados)
"msg_123456789"
Resposta
Carrossel enviado com sucesso
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
ID do remetente da mensagem
Nome exibido do remetente
Indica se é uma mensagem de grupo
Indica se a mensagem foi enviada pelo usuário
Tipo de conteúdo da mensagem
Plataforma de origem da mensagem
Timestamp original da mensagem em milissegundos
Status do ciclo de vida da mensagem.
Exemplos comuns: Queued, Canceled, Failed, Sent, Delivered, Read.
Em mensagem de grupo, segue o participante mais adiantado: Delivered quando pelo menos um recebeu, Read quando pelo menos um leu e Played quando pelo menos um ouviu.
Texto original da mensagem
ID da mensagem citada/respondida
Histórico de edições da mensagem
ID da mensagem reagida
Dados de votação de enquete e listas
Conversão de opções da mensagem, lista, enquete e botões
ID do botão ou item de lista selecionado
Dono da mensagem
Mensagem de erro caso o envio tenha falhado
Conteúdo bruto da mensagem (JSON serializado ou texto)
Indica se a mensagem foi enviada via API
Mensagem fixada na conversa (fixar e desafixar chegam também em messages_update, tipos Pinned e Unpinned)
Função usada para enviar a mensagem (quando enviada via API)
Payload usado no envio quando disponível. Dados de mídia em base64 são omitidos.
URL ou referência de arquivo da mensagem
Contato conhecido associado a uma ligação, quando disponível em messageType: call.
Show child attributes
Show child attributes
Pasta associada ao envio (quando aplicável)
Origem de rastreamento
ID de rastreamento (pode repetir)
Registro de uma rodada da IA. O completo (pedido ao modelo, resposta e outcome) fica uma vez, na última mensagem do contato que a rodada respondeu, também quando nada saiu (erro, resposta descartada). Cada mensagem enviada pela IA leva só agent_id e turn (o id dessa mensagem do contato).
Show child attributes
Show child attributes
JID PN resolvido do remetente (quando disponível)
LID original do remetente (quando disponível)
URL temporária de preview do remetente, quando conhecida. A hidratação desta versão preenche mensagens recebidas em grupos; o campo pode ser omitido. Não provoca consulta de foto ao WhatsApp na listagem.
Show child attributes
Show child attributes
