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

> Envie uma mensagem de texto (SMS) ao destinatário, com link encurtado automático.

O canal SMS envia uma mensagem de texto (SMS) ao celular do destinatário. Para usá-lo, inclua o bloco `sms` na requisição de envio (`POST /gw/email`) — veja a [visão geral do envio](/enviando/visao-geral).

## Campos do objeto `sms`

<ParamField path="sms.number" type="string" required>
  Número do celular do destinatário, sem máscaras (apenas dígitos), no formato `DDDNÚMERO`.
</ParamField>

<ParamField path="sms.typeSend" type="string">
  Controla o disparo do SMS. Opcional.

  * **`1`** (padrão) — envia o SMS apenas se o e-mail não for enviado/entregue.
  * **`2`** — envia o SMS sempre, independentemente do status do e-mail.
</ParamField>

<ParamField path="sms.customMessage" type="string">
  Mensagem personalizada do cliente, limitada a **140 caracteres**. Opcional.
</ParamField>

## Variável `{SHORT_LINK}`

Na mensagem personalizada você pode usar a variável `{SHORT_LINK}`, que é substituída automaticamente pelo link encurtado de acesso ao AR-Email.

```json theme={null}
"sms": {
  "number": "119999988888",
  "typeSend": "1",
  "customMessage": "Olá João, você recebeu um AR-Email. Acesse: {SHORT_LINK}"
}
```

Resultado entregue ao destinatário:

> Olá João, você recebeu um AR-Email. Acesse: [https://short.link/abc123](https://short.link/abc123)

## 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>",
      "sms": {
        "number": "119999988888",
        "typeSend": "2",
        "customMessage": "Olá João, você recebeu um AR-Email. Acesse: {SHORT_LINK}"
      }
    }'
  ```

  ```json Body theme={null}
  {
    "nameTo": "João da Silva",
    "subject": "Documento Importante",
    "content": "<p><strong>Você recebeu um documento importante.</strong></p>",
    "sms": {
      "number": "119999988888",
      "typeSend": "2",
      "customMessage": "Olá João, você recebeu um AR-Email. Acesse: {SHORT_LINK}"
    }
  }
  ```
</CodeGroup>

A resposta traz o `idEmail` do envio:

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

## Acompanhando o status

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