> ## 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 Voz

> Dispare uma chamada de voz automatizada (AR-Voz) a partir de um script e variáveis fornecidos pelo suporte.

O canal Voz dispara uma **chamada telefônica automatizada** que executa um script de voz com as variáveis informadas. Para usá-lo, inclua o bloco `voz` na requisição de envio (`POST /gw/email`) — veja a [visão geral do envio](/enviando/visao-geral).

<Note>
  Sobre o AR-Voz, converse com o nosso time Comercial para saber mais sobre este recurso.
</Note>

## Campos do objeto `voz`

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

<ParamField path="voz.template" type="string" required>
  Modelo do script de voz. O script da mensagem é **fornecido pelo time de suporte**.
</ParamField>

<ParamField path="voz.payload" type="object" required>
  Valores das variáveis necessárias para a execução correta do script. As chaves dependem do script definido com o suporte.
</ParamField>

## 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>",
      "voz": {
        "number": "11999999888",
        "template": "template_voz_padrao",
        "payload": {
          "OPERADORA_VOZ": "A R SAÚDE",
          "NOME_VOZ": "João da Silva",
          "CONTATO_OPERADORA_VOZ": "zero oitocentos, um, dois, três, quatro, três, dois ",
          "CPF2_DIGITOS_FINAL_VOZ": "7 8",
          "CPF3_DIGITOS_INICIAL_VOZ": "123",
          "DESCRICAO_COMPENTECIA_VOZ": "Janeiro a Março de 2024",
          "RESULTADO_CONFIRMACAO_VOZ": "123"
        }
      }
    }'
  ```

  ```json Body theme={null}
  {
    "nameTo": "João da Silva",
    "subject": "Documento Importante",
    "content": "<p><strong>Você recebeu um documento importante.</strong></p>",
    "voz": {
      "number": "11999999888",
      "template": "template_voz_padrao",
      "payload": {
        "OPERADORA_VOZ": "A R SAÚDE",
        "NOME_VOZ": "João da Silva",
        "CONTATO_OPERADORA_VOZ": "zero oitocentos, um, dois, três, quatro, três, dois ",
        "CPF2_DIGITOS_FINAL_VOZ": "7 8",
        "CPF3_DIGITOS_INICIAL_VOZ": "123",
        "DESCRICAO_COMPENTECIA_VOZ": "Janeiro a Março de 2024",
        "RESULTADO_CONFIRMACAO_VOZ": "123"
      }
    }
  }
  ```
</CodeGroup>

A resposta traz o `idEmail` do envio:

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

## Exemplo de áudio

Ouça um exemplo de chamada gerada pelo AR-Voz: [áudio de exemplo](/audio/6b05d8dd-be1e-48ff-9e5b-8bb3e1f98e6d.wav).

## Acompanhando o status

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