Canal WhatsApp

O canal WhatsApp envia uma notificação por WhatsApp ao destinatário, usando um template personalizado com variáveis definidas na implantação do seu número. Para usá-lo, inclua o bloco whatsapp na requisição de envio (POST /gw/email) — veja a visão geral do envio.

Para enviar AR-WhatsApp com template personalizado, é necessário possuir um número próprio implantado conosco e solicitar ao nosso time de suporte a criação do template. Após o cadastro, nossa equipe informará quais variáveis devem ser enviadas no corpo da requisição.

Campos do objeto `whatsapp`

string

required

Número de WhatsApp do destinatário, sem máscaras (apenas dígitos).

object

Variáveis que preenchem o template personalizado. Inclui o identificador do template (template) e as demais variáveis definidas para o seu número.

O identificador do template e o conjunto de variáveis são definidos junto ao suporte na implantação do número. Após o cadastro, nossa equipe informa exatamente quais variáveis devem ser enviadas no corpo da requisição. O exemplo abaixo segue o formato whatsapp.variables com o template e suas variáveis.

Exemplo completo

curl -X POST "https://api.ar-online.com.br/gw/email" \
  -H "Authorization: SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "nameTo": "João da Silva",
    "subject": "Documento Importante",
    "content": "<p><strong>Você recebeu um documento importante.</strong></p>",
    "whatsapp": {
      "number": "11999999888",
      "variables": {
        "template": "template_hsm_1",
        "nomeCliente": "João da Silva",
        "operadora": "AR-SAUDE",
        "mesalidades": "JAN, FEV, MAR/2024",
        "contato": "0800 123 123"
      }
    }
  }'

{
  "nameTo": "João da Silva",
  "subject": "Documento Importante",
  "content": "<p><strong>Você recebeu um documento importante.</strong></p>",
  "whatsapp": {
    "number": "11999999888",
    "variables": {
      "template": "template_hsm_1",
      "nomeCliente": "João da Silva",
      "operadora": "AR-SAUDE",
      "mesalidades": "JAN, FEV, MAR/2024",
      "contato": "0800 123 123"
    }
  }
}

A resposta traz o idEmail do envio:

{
  "idEmail": "8c4813f5-8430-4ad4-ab72-19d7eed39731"
}

Exemplo de mensagem entregue com template personalizado:

Exemplo de AR-WhatsApp com template personalizado

Acompanhando o status

Consulte o status do WhatsApp com o idEmail do envio. Veja Consultar status.

Início

Enviando notificações

Acompanhando envios

Notas técnicas

Webhooks

Templates

Referência da API

Endpoints

Campos do objeto `whatsapp`

Exemplo completo

Acompanhando o status

​Campos do objeto whatsapp

​Exemplo completo

​Acompanhando o status

Campos do objeto `whatsapp`

Exemplo completo

Acompanhando o status