Método e URL
POST https://api.agilize.app/messenger/whatsapp/sendAutenticação
Envie a chave de API no cabeçalho da requisição.
Accept: application/json
x-api-key: SUA_CHAVE_APIParâmetros
| Nome | Origem | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
| x-api-key | header | Sim | string | Chave da API de integração gerada em seu painel gerencial. |
| content-type | header | Sim | string | application/json |
Corpo da requisição
- Obrigatório: Sim
- Content-Type: application/json
Campos do corpo
| Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição |
|---|---|---|---|---|
| destination | string | Sim | Exemplo: 553144446666 | Destino da mensagem a ser enviada, no formato DDI + DDD + TELEFONE. |
| phone | string | Sim | Id do WhatsApp de origem integrado a plataforma | |
| varHeader | string | Não | Variável usada no cabeçalho da mensagem do template (caso exista) | |
| varsBody | string | Não | ||
| varOrder | string | Não | ||
| template | string | Sim | Id do Template integrado a plataforma | |
| dt | string (date-time) | Não | Data/hora do envio (Setado automaticamente) | |
| extId | string | Não | Id externo fornecido pelo Meta após entrega da mensagem | |
| status | number | Não | Código de erro do envio quando houver falha síncrona ou atualização posterior via webhook do Meta | |
| persistOnRoom | boolean | Não | Padrão: false | Quando 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
| Status | Descrição | Conteúdo |
|---|---|---|
| 201 | created | application/json |
| 401 | not authenticated | |
| 500 | general 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.
