v4

latestOpenAPI 3.0.3raw.githubusercontent.com2026-07-2172104104.0 KB
messages

Envia mensagem WhatsApp (template, texto, interativa, localização ou reação)

Aceita exatamente um tipo de payload por request: templateName, body, interactive, location ou reaction. Retorna 202 Accepted com o ID interno; o status real chega via webhook.

post/v1/messages

Request body

receiverstring required

Número E.164 do destinatário.

senderstring nullable

Número remetente (opcional; usa default da org).

type'template' | 'text' | 'interactive' | 'location' | 'reaction' nullable

Tipo explícito. Quando omitido, infere de outros campos.

templateNamestring nullable
templateVariablesstring[] nullable

Lista posicional de variáveis (aceita alias variables).

smartLinkParamstring nullable
smartLinkUrlstring nullable
bodystring nullable

Texto livre (apenas em janela 24h aberta).

replyTostring nullable

internalId da mensagem original sendo respondida.

scheduled_atstring date-time nullable
mode'LIVE' nullable
media_urlstring nullable

DEPRECATED — use variables posicionalmente (header na primeira posição).

Example request

{
  "receiver": "+5511999998888"
}

Response

Mensagem aceita pra envio

idstring nullable
status'PENDING' | 'SCHEDULED' | 'PROCESSING' | 'SENT' | 'DELIVERED' | 'READ' | 'FAILED' | 'CANCELED' required
mode'LIVE' required
senderstring required
receiverstring required
bodystring nullable
costnumber float nullable

Example response

{
  "status": "SENT"
}