Pular para o conteúdo principal
POST
/
v1
/
messages
/
send
Enviar mensagem
curl --request POST \
  --url https://pilotstatus.com.br/v1/messages/send \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "templateId": "boas_vindas",
  "destinationNumber": "5511988887777",
  "variables": {
    "nome": "Ana"
  }
}
'
{
  "id": "msg_01HZX...",
  "correlationId": "corr_01HZX...",
  "status": "QUEUED",
  "createdAt": "2026-06-20T10:00:00.000Z",
  "origin": "Suporte",
  "sourceNumber": "5511999999999"
}

Autorizações

​
x-api-key
string
header
obrigatório

Sua chave de API ps_

Corpo

application/json
​
templateId
string

Id ou nome do template (exclusivo com text).

Exemplo:

"boas_vindas"

​
text
string

Texto livre (exclusivo com templateId).

Exemplo:

"Olá! Sua entrega chegou."

​
destinationNumber
string

Destino (exatamente um destino). Aceita telefone E.164 OU um BSUID — o userId durável do contato (ex.: BR.13491208655302741918), retornado por GET /api/v1/conversations. Use o BSUID para responder a contatos que usam username do WhatsApp (sem telefone). Templates de autenticação one-tap/zero-tap/copy-code exigem telefone.

Exemplo:

"5511988887777"

​
groupId
string

JID de grupo. NOT_SUPPORTED_FOR_META.

Exemplo:

"123456789-987654321@g.us"

​
newsletterId
string

JID de canal/newsletter. NOT_SUPPORTED_FOR_META.

Exemplo:

"120363000000000000@newsletter"

​
variables
string

Variáveis do template (padrão {}).

Exemplo:

"{ \"nome\": \"Ana\" }"

​
media
string

URL pública http(s) OU data URI base64 (ex.: data:audio/ogg;base64,AAAA…). Base64 funciona na Meta Cloud API e na Evolution v2; na Evolution GO use uma URL pública http(s) (GO não aceita base64). Usado no modo template ou no modo mídia direta (media + mediaType, sem templateId e sem text).

Exemplo:

"https://cdn.acme.com/img.png"

​
mediaType
string

Tipo da mídia. No modo mídia direta (sem templateId/text) envie media + mediaType: caption opcional para image/video/document (não para audio); botões/header/footer/variáveis não permitidos. "audio" é entregue como nota de voz (PTT) na Meta Cloud API, Evolution v2 e Evolution GO; na Evolution v2 e GO um indicador de presença "gravando áudio" é mostrado ao destinatário antes da nota de voz (a Meta não tem API de presença de saída).

Exemplo:

"image"

​
buttons
string

Botões (QUICK_REPLY/URL/PHONE_NUMBER/COPY_CODE).

​
header
string

Header para texto livre (com botões).

​
footer
string

Rodapé para texto livre (com botões).

​
deliverAt
string

Agendar a entrega para um instante futuro.

Exemplo:

"2026-06-21T09:00:00Z"

​
deliverUntil
string

Janela máxima de entrega.

Exemplo:

"2026-06-21T18:00:00Z"

​
labels
string

Labels a aplicar à conversa de destino.

Exemplo:

"[\"pedido\", \"vip\"]"

Resposta

Enviar template