WhatsApp · Referência da API

Nesta área

Send WhatsApp messages directly, without creating an inbox conversation. Meta bills these to your own WABA account.

List connected WhatsApp numbers

get/v1/public/whatsapp/numbers

Returns the organization's WhatsApp numbers with their channel (CLOUD_API = official Meta, EVOLUTION = unofficial) and connection status. Use the id of a connected number as instanceId when sending through the Send API — required in practice for multi-number organizations, since otherwise the oldest connected number of the channel is used.

Parâmetros

Sem parâmetros.

Respostas

200

Exemplos

bash

curl -X GET "https://api.cognizy.ai/api/v1/public/whatsapp/numbers" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Send a WhatsApp message

post/v1/public/whatsapp/messages

Pede aprovaçãoAceita Idempotency-Key

Sends a WhatsApp message directly (text, media or approved template) without creating an inbox conversation. Returns 202 with the queued message id; the final status is tracked on the message and pushed via webhooks. Pass an Idempotency-Key header to safely retry without duplicating the send. Use instanceId to choose which of your numbers sends (required in practice for multi-number organizations), or channel to pick a channel and let the oldest connected number of that channel be used. On the official CLOUD_API channel, free-form text/media require an open 24h session window with the recipient — outside it, use an approved template. The unofficial EVOLUTION channel has no window and no templates, but is subject to a per-number anti-ban rate cap.

Responde 202 com o pedido: a ação só acontece depois que alguém aprova em Para revisar ou na aba Aprovações de IA.

Parâmetros

idempotency-keystringobrigatório· cabeçalho

Campo	Onde	Tipo	Descrição
`idempotency-key`obrigatório	cabeçalho	string

Corpo (JSON)obrigatório

tostringobrigatório: Recipient in E.164 (digits)
instanceIdstringopcional: Send from this specific WhatsApp number (WhatsAppInstance id). Required in practice for multi-number organizations; omit it and the oldest-created connected number of the selected channel is used. Takes precedence over channel.
channelstringopcional: Which WhatsApp channel to send through when no instanceId is given. CLOUD_API is the official Meta channel (supports templates, subject to the 24h session window). EVOLUTION is the unofficial channel (free-form text/media only, no templates, subject to the instance's daily anti-ban cap). Defaults to CLOUD_API.CLOUD_APIEVOLUTION
typestringobrigatório: TEXTMEDIATEMPLATE
textstringopcional: Body for type=TEXT
mediaobjectopcional
media.urlstringobrigatório
media.typestringobrigatório: imagevideodocumentaudio
media.captionstringopcional
templateobjectopcional
template.namestringobrigatório: Approved Meta template name
template.languagestringopcional
template.variablesstring[]opcional: Positional body variables, in order

Campo	Tipo	Descrição
`to`obrigatório	string	Recipient in E.164 (digits)
`instanceId`opcional	string	Send from this specific WhatsApp number (WhatsAppInstance id). Required in practice for multi-number organizations; omit it and the oldest-created connected number of the selected channel is used. Takes precedence over `channel`.
`channel`opcional	string	Which WhatsApp channel to send through when no instanceId is given. CLOUD_API is the official Meta channel (supports templates, subject to the 24h session window). EVOLUTION is the unofficial channel (free-form text/media only, no templates, subject to the instance's daily anti-ban cap). Defaults to CLOUD_API.`CLOUD_APIEVOLUTION`
`type`obrigatório	string	`TEXTMEDIATEMPLATE`
`text`opcional	string	Body for type=TEXT
`media`opcional	object
`media.url`obrigatório	string
`media.type`obrigatório	string	`imagevideodocumentaudio`
`media.caption`opcional	string
`template`opcional	object
`template.name`obrigatório	string	Approved Meta template name
`template.language`opcional	string
`template.variables`opcional	string[]	Positional body variables, in order

Respostas

202Message accepted and queued

Exemplos

bash

curl -X POST "https://api.cognizy.ai/api/v1/public/whatsapp/messages" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "to": "5511999999999",
  "instanceId": "clx7k2p9a0001qwerty",
  "channel": "CLOUD_API",
  "type": "TEXT",
  "text": "Olá! Seu pedido saiu.",
  "media": {
    "url": "https://example.com/file.pdf",
    "type": "image",
    "caption": "texto"
  },
  "template": {
    "name": "order_update",
    "language": "pt_BR",
    "variables": [
      "Maria",
      "#1234"
    ]
  }
}'

Get the status of a sent message

get/v1/public/whatsapp/messages/{id}

Parâmetros

idstringobrigatório· caminho: OutboundMessage id returned by POST

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	string	OutboundMessage id returned by POST

Respostas

200

Exemplos

bash

curl -X GET "https://api.cognizy.ai/api/v1/public/whatsapp/messages/<id>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Toda a referência