Canal E-mail

O AR-Email é o canal de e-mail da AR Online, com comprovação de entrega e leitura. O endpoint de envio se chama POST /gw/email; o campo to (destinatário do e-mail) é exigido apenas no envio somente e-mail. Veja a visão geral do envio.

Campos

string

required

Nome do destinatário.

string

E-mail do destinatário. Obrigatório apenas quando o envio é somente e-mail.

string

required

Assunto da mensagem.

string

required

Conteúdo da mensagem em HTML.

array

Lista de anexos. Cada item tem name (nome do arquivo) e base64 (conteúdo em base64). Opcional.

object

Protege o acesso ao link público do AR-Portal com pergunta e resposta de segurança.

string

Pergunta de segurança exibida na página do AR-Portal.

string

Resposta de segurança solicitada ao destinatário.

O recurso validation é opcional e exige habilitação prévia da conta. Sem a ativação, uma requisição que contenha validation retorna erro 400. Solicite a ativação ao suporte (suporte@ar-online.com.br). Quando habilitada, a validação é aplicada a todos os canais de envio (Email, SMS e WhatsApp).

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",
    "to": "joao@exemplo.com",
    "subject": "Documento Importante",
    "content": "<p><strong>Você recebeu um documento importante.</strong></p>",
    "attachments": [
      {
        "name": "documento.pdf",
        "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAABCAQAAABN/Pf1AAAADUlEQVR42mNk+M+AAQATFwEB/YopsAAAAABJRU5ErkJggg=="
      }
    ]
  }'

{
  "nameTo": "João da Silva",
  "to": "joao@exemplo.com",
  "subject": "Documento Importante",
  "content": "<p><strong>Você recebeu um documento importante.</strong></p>",
  "attachments": [
    {
      "name": "documento.pdf",
      "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAABCAQAAABN/Pf1AAAADUlEQVR42mNk+M+AAQATFwEB/YopsAAAAABJRU5ErkJggg=="
    }
  ]
}

A resposta traz o idEmail do envio:

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

Acompanhando o status

Use o idEmail para acompanhar a entrega e a leitura. Veja Consultar status.

Início

Enviando notificações

Acompanhando envios

Notas técnicas

Webhooks

Templates

Referência da API

Endpoints

Campos

Exemplo completo

Acompanhando o status

​Campos

​Exemplo completo

​Acompanhando o status

Campos

Exemplo completo

Acompanhando o status