Enviar Mensagens

Enviar Carrossel

Envia um carrossel de cartões com imagem e botões de ação. Cada item do array `carousel` representa um cartão com `text`, `image` e `buttons: [{type,text,id}]`.

POSThttps://api.zapzapapi.com/api/v1/{instanceId}/send/carousel

Autenticação por cabeçalhos x-api-key e x-api-secret.

Parâmetros

NomeTipoOndeObrigatórioDescrição
numbertextcorpoSimNúmero (com DDI)
texttextareacorpoSimTexto principal da mensagem
carouseljsoncorpoSimCartões (JSON array)
delaynumbercorpoNãoDelay (ms)
digitandoselectcorpoNãoExibe "digitando..." automatico proporcional ao tamanho da mensagem antes de enviar. Ligado por padrao (humaniza e reduz risco de bloqueio). Envie false para desligar e responder mais rapido. A resposta continua sincrona.

Exemplo de requisição

curl

curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/send/carousel" \
  -H "x-api-key: SUA_API_KEY" \
  -H "x-api-secret: SEU_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"number":"5511999999999","text":"Confira nossas opções:","carousel":[{"text":"Produto 1","image":"https://exemplo.com/img.jpg","buttons":[{"type":"REPLY","text":"Quero!","id":"quero"}]}]}'

Node.js

const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/send/carousel", {
  method: "POST",
  headers: {
    "x-api-key": "SUA_API_KEY",
    "x-api-secret": "SEU_API_SECRET",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "number": "5511999999999",
    "text": "Confira nossas opções:",
    "carousel": [
      {
        "text": "Produto 1",
        "image": "https://exemplo.com/img.jpg",
        "buttons": [
          {
            "type": "REPLY",
            "text": "Quero!",
            "id": "quero"
          }
        ]
      }
    ]
  }),
});
console.log(await res.json());

Python

import requests

res = requests.post(
    "https://api.zapzapapi.com/api/v1/{instanceId}/send/carousel",
    headers={"x-api-key": "SUA_API_KEY", "x-api-secret": "SEU_API_SECRET"},
    json={"number":"5511999999999","text":"Confira nossas opções:","carousel":[{"text":"Produto 1","image":"https://exemplo.com/img.jpg","buttons":[{"type":"REPLY","text":"Quero!","id":"quero"}]}]},
)
print(res.json())

Exemplo de resposta

JSON

{
  "messageId": "ABCDEF123456",
  "status": "sent"
}

Os valores são ilustrativos; os campos seguem o formato real da resposta.

Ver referência completa

Pegue suas chaves de API

Crie sua conta, conecte um número em minutos e comece a usar a API. R$15 por número ativo/mês, com crédito de boas-vindas ao criar a conta, sujeito à campanha vigente.