DOCS

POST/messenger/whatsapp/send

Envia um template de WhatsApp para o destino informado. Use `persistOnRoom` para tambem registrar o envio no historico da conversa quando aplicavel.

Método e URL

POST https://api.agilize.app/messenger/whatsapp/send

Autenticação

Envie a chave de API no cabeçalho da requisição.

Accept: application/json
x-api-key: SUA_CHAVE_API

Parâmetros

NomeOrigemObrigatórioTipoDescrição
x-api-keyheaderSimstringChave da API de integração gerada em seu painel gerencial.
content-typeheaderSimstringapplication/json

Corpo da requisição

  • Obrigatório: Sim
  • Content-Type: application/json

Campos do corpo

CampoTipoObrigatórioValores / ExemploDescrição
destinationstringSimExemplo: 553144446666Destino da mensagem a ser enviada, no formato DDI + DDD + TELEFONE.
phonestringSimId do WhatsApp de origem integrado a plataforma
varHeaderstringNãoVariável usada no cabeçalho da mensagem do template (caso exista)
varsBodystringNão
varOrderstringNão
templatestringSimId do Template integrado a plataforma
dtstring (date-time)NãoData/hora do envio (Setado automaticamente)
extIdstringNãoId externo fornecido pelo Meta após entrega da mensagem
statusnumberNãoCódigo de erro do envio quando houver falha síncrona ou atualização posterior via webhook do Meta
persistOnRoombooleanNãoPadrão: falseQuando true, o envio tambem e persistido no historico de uma room WhatsApp. A plataforma tenta localizar a room pelo numero de destino e cria uma nova room outbound quando necessario.

Exemplo básico:

{
  "destination": "553144446666",
  "phone": "valor",
  "template": "valor"
}

Respostas

StatusDescriçãoConteúdo
201createdapplication/json
401not authenticated
500general error

Exemplos básicos

Escolha uma linguagem para abrir o exemplo de requisição.

Testar requisição

Preencha os parâmetros, informe a chave no cabeçalho x-api-key e envie a requisição diretamente pelo navegador.

Carregando teste interativo do endpoint...