> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ar-online.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Canal WhatsApp

> Envie uma notificação por WhatsApp com template personalizado, ativando o bloco whatsapp na requisição.

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](/enviando/visao-geral).

<Warning>
  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.
</Warning>

## Campos do objeto `whatsapp`

<ParamField path="whatsapp.number" type="string" required>
  Número de WhatsApp do destinatário, sem máscaras (apenas dígitos).
</ParamField>

<ParamField path="whatsapp.variables" type="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.
</ParamField>

<Note>
  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.
</Note>

## Exemplo completo

<CodeGroup>
  ```bash cURL theme={null}
  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"
        }
      }
    }'
  ```

  ```json Body theme={null}
  {
    "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"
      }
    }
  }
  ```
</CodeGroup>

A resposta traz o `idEmail` do envio:

```json theme={null}
{
  "idEmail": "8c4813f5-8430-4ad4-ab72-19d7eed39731"
}
```

Exemplo de mensagem entregue com template personalizado:

<img src="https://mintcdn.com/aronline/xG8qjUhq0nMODZpv/images/exemplo-whatsapp-customizado.png?fit=max&auto=format&n=xG8qjUhq0nMODZpv&q=85&s=e303c67fc44dcb5e306d5c111ab45470" alt="Exemplo de AR-WhatsApp com template personalizado" width="512" height="540" data-path="images/exemplo-whatsapp-customizado.png" />

## Acompanhando o status

Consulte o status do WhatsApp com o `idEmail` do envio. Veja [Consultar status](/acompanhando/consultar-status).