Pular para o conteúdo principal
POST
/
send-carousel
Enviar carrossel
curl --request POST \
  --url https://zapi.hubmessage.io/channels/{channel_id}/token/{channel_token}/send-carousel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "5511999999999",
  "message": "Confira nossos produtos:",
  "carousel": [
    {
      "text": "Produto A",
      "image": "https://exemplo.com/produto-a.png",
      "buttons": [
        {
          "id": "1",
          "type": "URL",
          "label": "Ver detalhes",
          "url": "https://www.hubmessage.io"
        },
        {
          "id": "2",
          "type": "REPLY",
          "label": "Tenho interesse"
        }
      ]
    },
    {
      "text": "Produto B",
      "image": "https://exemplo.com/produto-b.png",
      "buttons": [
        {
          "id": "3",
          "type": "URL",
          "label": "Ver detalhes",
          "url": "https://www.hubmessage.io"
        },
        {
          "id": "4",
          "type": "REPLY",
          "label": "Tenho interesse"
        }
      ]
    }
  ]
}
'
{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

Conceituação

Método para envio de mensagens com carrossel de cards. Cada card pode conter imagem, texto e botões de ação (CALL, URL ou REPLY).
A estrutura de resposta é idêntica à da Z-API. Seu código existente que processa esses retornos continuará funcionando sem alterações.

Autorizações

Authorization
string
header
obrigatório

Secret Key gerada no painel de Segurança do Hub Message

Corpo

application/json
phone
string
obrigatório

Telefone do destinatário (DDI + DDD + número)

Exemplo:

"5511999999999"

message
string
obrigatório

Texto da mensagem

Lista de cards do carrossel

delayMessage
integer

Delay em segundos antes do envio (1-15)

Intervalo obrigatório: 1 <= x <= 15

Resposta

Mensagem enviada com sucesso

zaapId
string

Identificador interno

messageId
string

ID da mensagem no WhatsApp

id
string

Mesmo valor do messageId (compatibilidade)