Canal SMS

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.

Campos do objeto `sms`

string

required

Número do celular do destinatário, sem máscaras (apenas dígitos), no formato DDDNÚMERO.

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.

string

Mensagem personalizada do cliente, limitada a 140 caracteres. Opcional.

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.

"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

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

{
  "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}"
  }
}

A resposta traz o idEmail do envio:

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

Acompanhando o status

Consulte o status do SMS 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 `sms`

Variável `{SHORT_LINK}`

Exemplo completo

Acompanhando o status

​Campos do objeto sms

​Variável {SHORT_LINK}

​Exemplo completo

​Acompanhando o status

Campos do objeto `sms`

Variável `{SHORT_LINK}`

Exemplo completo

Acompanhando o status