Skip to main content
Todo envio na AR Online parte de uma única requisição para o endpoint POST /gw/email. O nome do endpoint é histórico: a requisição é um envelope que pode acionar de um a cinco canais — o e-mail (AR-Email) é apenas um deles, e cada bloco (sms, whatsapp, voz, carta) ativa o seu canal.
Os campos nameTo, subject e content são sempre obrigatórios. O to (destinatário do e-mail) é exigido apenas no envio somente e-mail.

​
Endpoint

  • Método e URL: POST https://api.ar-online.com.br/gw/email
  • Autenticação: envie o token JWT no header Authorization, sem o prefixo Bearer.
  • Content-Type: application/json.
O envio é assíncrono: a resposta HTTP 200 com { idEmail } significa “aceito para processamento”, não “entregue”. Use o idEmail para consultar o status de cada canal. O token de produção é solicitado ao suporte em suporte@ar-online.com.br.

​
Campos de nível superior

​
string
required
Nome do destinatário da mensagem.
​
string
E-mail do destinatário. Obrigatório apenas quando o envio é somente e-mail, ou seja, quando não há nenhum bloco de outro canal (sms, whatsapp etc.) na requisição.
​
string
required
Assunto da mensagem.
​
string
required
Conteúdo da mensagem em HTML.
​
string
Referência externa do envio, útil para correlacionar com seus próprios registros. Opcional.
​
array
Lista de anexos. Cada item é um objeto com name (nome do arquivo) e base64 (conteúdo do arquivo em base64). Opcional.
​
object
Protege o acesso ao link público do AR-Portal com uma pergunta e resposta de segurança. Contém validation.question (pergunta exibida) e validation.reply (resposta solicitada). Requer habilitação prévia da conta.
O recurso validation é opcional e sujeito à habilitação prévia. Sem a ativação, uma requisição com validation retorna erro 400. Solicite a ativação ao suporte (suporte@ar-online.com.br) antes de utilizá-lo.

​
Ativando outros canais

Incluir um bloco no corpo da requisição ativa o canal correspondente no mesmo envio:
  • sms — envia também por SMS. Veja Canal SMS.
  • whatsapp — envia também por WhatsApp. Veja Canal WhatsApp.
  • voz — dispara uma chamada de voz automatizada. Veja Canal Voz.
  • carta — envia uma carta física registrada. Veja Canal Carta.
Você pode combinar quantos canais quiser numa só requisição. Veja Multicanal.

​
Resposta

​
string
Identificador único do envio. Use-o para consultar o status de cada canal.

​
Próximos passos

E-mail

Campos do e-mail, anexos e validação de segurança.

SMS

Mensagem de texto (SMS) com link encurtado.

WhatsApp

Notificação por WhatsApp com template personalizado.

Voz

Chamada de voz automatizada.

Carta

Carta física registrada via Correios.

Multicanal

Combine vários canais em uma única requisição.