API Gateway

Autenticação

Para consumir os recursos definidos abaixo é necessário enviar em TODA requisição o token no cabeçalho com o parâmetro Authorization e o Content-Type com o valor padrão de: application/json

Exemplo:

Authorization: eyJhbGciOiJIUzI1NiJ9.MjM3NTVkZjQxMzgwYzcyODBhYzU3MTM4YjNhYWI2Yjc6NWZkNzFjNzNiMTg3ZjNiMWI2N2QzZmYyNjA2NDU2YWRhM2QxNjE4MmZhYTQxMjdkYmE5ODZhZjgyZjUxMzZjNmU5NzAyMDIyZjk3MjEwNzAwZTMwY2Q0YTU4NWY2ODFiMmI3N2UzNWIwZTk2MDQxMmZlMDI0ZGU2OWQyZWJkMTg1N2RiNzM3MDQyZWUxY2NmMTNjZWUyMGVkZDI0NWY4MjFkZmQ2MzBjNWE2ZTgwMzNiMjRiZjAwYjJlNTY5ZDc4Yjg4ZGVlNjlhNWJjNzM4NzRiYjJhZDJkZTExNDBiZDc1MjY1MmY1NWU2YjZjNzA4ZGNhNGM4ZjI3OWIzN2Y2NjA0ZjIyOTQxNjxJlZjc1MDE4YmFmNzA5MzlkNWQ3MzUxM2U5N2ZhZGZlNThiYzE1YWU4NGFmNjQ0OWI3MzQ1MTA3NTE3YzhiYWU3NjBlZDM2YWM3Y2YwNWYzN2Y3NmY5MDY5NTEyZmMxMWEwOTBkY2VjNTBkMmU0ZTUyNDNhNWIxZjQ3YjA2OWM0M2UzZDY3N2U4OWZhZTRhNjhiMDczYTAyNjc1ZjQ4NzliYTZmZWFiZTJkNmU5ZGYwOGZkNTQxZTE1ZTMxOGQzODY4ODg4YWVkNDc5MzczMTllNjhlMzJmNDUxNjYwNDM4OGUwNzNkNWU5OTA4MTQ1ZDNiOGQwN2U5MDBkMDU3OTFhYzE1MzNlYzVjOWEwMjBlMThjMjA5MWE0YjcxNWE1ZDc1MWUwNzJkMzYyOTZhNmM0NjQ2ODJhNDVkNWJjNTg1YmY1OGJkNmU5ODMzM2NiYTM4NmVhNzY.9fOPGJ0fxg8xCwctRI4PhgbOMMKY3AXR1mZnNiKlYhY===

Importante: Para obtenção do token de produção, é necessário entrar contato com à nossa equipe de atendimento: suporte@ar-online.com.br. O token acima é só um EXEMPLO.

Validação de Segurança (Validation)

O recurso de validation é uma forma de assegurar que o destinatário tenha seu AR protegido por uma senha previamente estabelecida. Quando habilitado e configurado na requisição, o destinatário precisará responder uma pergunta de segurança para acessar a notificação através do link público do AR-Portal.

Importante: Funcionalidade opcional e sujeita à habilitação prévia. Para utilizar, solicite a ativação ao nosso time de suporte (suporte@ar-online.com.br) antes de enviar requisições com validation.

Como funciona

validation.question: Pergunta de segurança que será exibida na página do AR-Portal
validation.reply: Resposta de segurança que será solicitada ao destinatário na página do AR-Portal

Exemplo de uso

{
  "nameTo": "João da Silva",
  "to": "joao@exemplo.com",
  "subject": "Documento Importante",
  "content": "<p>Você recebeu um documento importante.</p>",
  "validation": {
    "question": "Qual os 4 primeiros dígitos do seu CPF?",
    "reply": "1234"
  }
}

⚠️ Importante: A validação é aplicada a todos os canais de envio (Email, SMS, WhatsApp) quando habilitada e enviada na requisição.

Enviar AR-Online

Body Completo da Requisição: AR-Email, AR-SMS, AR-Whatsapp, AR-Voz e AR-Cartas - Envio Completo

Endpoint: https://api.ar-online.com.br/gw/email
Método: POST

Body da Requisição: AR-Email + AR-SMS + AR-Whatsapp + AR-Voz + AR-Cartas:

{
  "nameTo": "John",
  "to": "john@due.com",
  "subject": "Test Send",
  "content": "<p><strong> Hi!\/strong><\/p>",
  "attachments": [{
    "name": "test.png",
    "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAABCAQAAABN/Pf1AAAADUlEQVR42mNk+M+AAQATFwEB/YopsAAAAABJRU5ErkJggg=="
  }],
  "customID":"",
  "sms": {
    "number": "119999988888",
    "typeSend": "1",
    "customMessage": "Mensagem personalizada pelo cliente"
  },
  "whatsapp": {
    "number":"11999999888"
  },
  "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"
    }
  },
  "carta": {
    "name": "teste-carta-padrao",
    "modelo": "modelo-teste-padrao.docx",
    "variables": {
      "TEMPLATE_CARTAS": "modelo-teste-padrao.docx",
      "ASSUNTO_CARTA": "JOÃO DA SILVA -  Teste de envio AR-Cartas",
      "NOME_DESTINATARIO_CARTA": "João da Silva",
      "LOGRADOURO_CARTA": "RUA SEM SAIDA",
      "COMPLEMENTO_CARTA": "Casa",
      "NUMERO_CARTA": 99,
      "BAIRRO_CARTA": "CENTRO",
      "CIDADE_CARTA": "SÃO PAULO",
      "ESTADO_CARTA": "SP",
      "CEP_CARTA":"99999000",
      "TAB_DEBITO_01":"100,00",
      "TAB_DEBITO_02":"200,00",
      "TAB_DEBITO_03":"300,00",
      "TAB_DEBITO_04":"400,00",
      "TAB_REFERENCIA_01":"01/01/2024",
      "TAB_REFERENCIA_02":"02/02/2024", 
      "TAB_REFERENCIA_03":"03/03/2024",
      "TAB_REFERENCIA_04":"04/04/2024",
      "TAB_COMPETENCIA_01":"Janeiro",
      "TAB_COMPETENCIA_02":"Fevereiro",
      "TAB_COMPETENCIA_03":"Março",
      "TAB_COMPETENCIA_04":"Abril"
    }
  }
}

Body Completo da Requisição: AR-Email

{
  "nameTo": "John",
  "to": "john@due.com",
  "subject": "Test Send",
  "content": "<p><strong> Hi!\/strong><\/p>",
  "attachments": [{
    "name": "test.png",
    "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAABCAQAAABN/Pf1AAAADUlEQVR42mNk+M+AAQATFwEB/YopsAAAAABJRU5ErkJggg=="
  }],
  "customID":""
}

Body Completo da Requisição: AR-SMS

{
  "nameTo": "John",
  "subject": "Test Send",
  "content": "<p><strong> Hi!\/strong><\/p>",
  "attachments": [{
    "name": "test.png",
    "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAABCAQAAABN/Pf1AAAADUlEQVR42mNk+M+AAQATFwEB/YopsAAAAABJRU5ErkJggg=="
  }],
  "customID":"",
  "sms": {
    "number": "119999988888",
    "typeSend": "1",
    "customMessage": "Olá João, você recebeu um AR-Email. Acesse: {SHORT_LINK}"
  }
}

Body Completo da Requisição: AR-Whatsapp

{
  "nameTo": "John",
  "subject": "Test Send",
  "content": "<p><strong> Hi!\/strong><\/p>",
  "attachments": [{
    "name": "test.png",
    "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAABCAQAAABN/Pf1AAAADUlEQVR42mNk+M+AAQATFwEB/YopsAAAAABJRU5ErkJggg=="
  }],
  "customID":"",
  "whatsapp": {
    "number":"11999999888"
  }
}

Body Completo da Requisição: AR-Voz

{
  "nameTo": "John",
  "subject": "Test Send",
  "content": "<p><strong> Hi!\/strong><\/p>",
  "attachments": [{
    "name": "test.png",
    "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAABCAQAAABN/Pf1AAAADUlEQVR42mNk+M+AAQATFwEB/YopsAAAAABJRU5ErkJggg=="
  }],
  "customID":"",
  "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"
    }
  }
}

Body Completo da Requisição: AR-Cartas

{
  "nameTo": "John",
  "subject": "Test Send",
  "content": "<p><strong> Hi!\/strong><\/p>",
  "attachments": [{
    "name": "test.png",
    "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAABCAQAAABN/Pf1AAAADUlEQVR42mNk+M+AAQATFwEB/YopsAAAAABJRU5ErkJggg=="
  }],
  "customID":"",
  "carta": {
    "name": "teste-carta-padrao",
    "modelo": "modelo-teste-padrao.docx",
    "variables": {
      "TEMPLATE_CARTAS": "modelo-teste-padrao.docx",
      "ASSUNTO_CARTA": "JOÃO DA SILVA -  Teste de envio AR-Cartas",
      "NOME_DESTINATARIO_CARTA": "João da Silva",
      "LOGRADOURO_CARTA": "RUA SEM SAIDA",
      "COMPLEMENTO_CARTA": "Casa",
      "NUMERO_CARTA": 99,
      "BAIRRO_CARTA": "CENTRO",
      "CIDADE_CARTA": "SÃO PAULO",
      "ESTADO_CARTA": "SP",
      "CEP_CARTA":"99999000",
      "TAB_DEBITO_01":"100,00",
      "TAB_DEBITO_02":"200,00",
      "TAB_DEBITO_03":"300,00",
      "TAB_DEBITO_04":"400,00",
      "TAB_REFERENCIA_01":"01/01/2024",
      "TAB_REFERENCIA_02":"02/02/2024", 
      "TAB_REFERENCIA_03":"03/03/2024",
      "TAB_REFERENCIA_04":"04/04/2024",
      "TAB_COMPETENCIA_01":"Janeiro",
      "TAB_COMPETENCIA_02":"Fevereiro",
      "TAB_COMPETENCIA_03":"Março",
      "TAB_COMPETENCIA_04":"Abril"
    }
  }
}

Onde:

nameTo: Nome do destinatário da mensagem (obrigatório)
to: E-mail destinatário da mensagem (obrigatório apenas quando for envio somente de email, ou seja, quando não há o objeto sms ou whatsapp)
subject: Assunto da mensagem (obrigatório)
content: Conteúdo em HTML da mensagem (obrigatório)
attachments: Lista de objetos com name e base64 (opcional)
customID: Informação de referência externa, possibilitando a realização de pesquisa. (opcional)
validation: Objeto para proteger o acesso via link público com pergunta/resposta. (opcional e requer habilitação prévia)
validation.question: Pergunta de segurança exibida na página do AR-Portal. (opcional)
validation.reply: Resposta de segurança solicitada na página do AR-Portal. (opcional)

SMS

sms: Objeto com informações de envio de sms. Visa prover o recurso de envio de SMS através da API no envio do email.(opcional)
sms.number: Número do celular sem mascaras no formato XXXXX
sms.typeSend:
- 1 - Em caso de falha no envio do e-mail envia o SMS - contigencia - Esse é default (ou seja é opcional).
- 2 - Envia um SMS independete do status da mensagem - reforço
sms.customMessage: Possível mensagem personalizada pelo cliente (limitada a 140 caracteres)

🔗 Variável SHORT_LINK no SMS: É possível utilizar a variável {SHORT_LINK} na mensagem personalizada do SMS. Esta variável será automaticamente substituída pelo link encurtado para acesso ao AR-Email. Exemplo:

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

Resultado: A mensagem será enviada como: "Olá João, você recebeu um AR-Email. Acesse: https://short.link/abc123"

whatsapp: Objeto com informações de envio de whatsapp. Visa prover o recurso de envio de Whatsapp pela API.
whatsapp.number: Número de telefone de Whatsapp do destinatário.

Voz

voz.number: Número do destinatário de Voz
voz.template: Modelo do script de voz (*script da mensagem - fornecido pelo time suporte)
voz.payload: Valores que devem ser passados para execução correta do script

Carta

carta.name: Nome da carta enviada - (uso interno)
carta.template: Modelo da carta
carta.variables: Valores que devem ser passados para o processamento da carta (preenchimento da carta física)

⚠️ Importante - Variáveis do AR-Cartas: As variáveis do AR-Cartas são definidas de acordo com o modelo pré-configurado. Para utilização deste canal, é obrigatório passar pelo processo de SETUP para criação do modelo personalizado. Entre em contato com nossa equipe de suporte para configuração.

Resposta
```
{
  "idEmail": "8c4813f5-8430-4ad4-ab72-19d7eed39731"
}
```
Este é o id do Email que será usado para consultar os status

Exemplo da voz

Download do arquivo

Exemplo Carta

Exemplo Carta

Em amarelo os valores passados dentro da propriedade variables (carta.variables)

*Obs: Sobre o AR-Voz e AR-Cartas converser com o nosso time Comercial para saber mais destes recursos.

Enviar AR-WhatsApp - Template personalizado

É possível enviar AR-WhatsApp utilizando um template personalizado. Para isso, é necessário possuir um número próprio implantado conosco e solicitar ao nosso time de suporte a criação do template.

Após o cadastro, nossa equipe informará quais variáveis devem ser enviadas no corpo da requisição.

Exemplo:

Endpoint: https://api.ar-online.com.br/gw/email
Método: POST
Parâmetros da Requisição:

{
  "nameTo": "John",
  "subject": "Test Send",
  "content": "<p><strong> Hi!\/strong><\/p>",
  "whatsapp": {
    "number": "11999999888",
    "variables": {
      "template": "template_hsm_1", 
      "nomeCliente": "João da Silva",
      "operadora": "AR-SAUDE",
      "mesalidades": "JAN, FEV, MAR/2024",
      "contato": "0800 123 123"
    }
  }
}

Resposta

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

Este é o id do Email que será usado para consultar os status

Exemplo WhatsApp com template customizado:

Consulta do status completo (Full) - Dados de Perícia

Endpoint: https://api.ar-online.com.br/gw/full/{idEmail}
Método: GET
Parâmetros da Requisição:
- idEmail - ID único obtido no envio do AR-Email

⚠️ Importante: Este endpoint retorna todos os dados de perícia de todos os canais (Email, SMS, WhatsApp, Voz e Cartas) em uma única requisição. É ideal para casos que necessitam de informações completas para perícia ou auditoria.

Resposta:

{
  "codEmail": 12345,
  "statusFull": {
    "email": [
      {
        "label": "Enviado",
        "dateTime": "14/05/2025 17:04:44"
      },
      {
        "label": "Entregue",
        "dateTime": "14/05/2025 17:04:45"
      },
      {
        "label": "Lido (acessou o link)",
        "dateTime": "14/05/2025 17:05:55"
      }
    ],
    "sms": [
      {
        "label": "Enviado",
        "dateTime": "14/05/2025 17:04:50"
      },
      {
        "label": "Entregue",
        "dateTime": "14/05/2025 17:04:52"
      }
    ],
    "whatsapp": [
      {
        "label": "Enviado",
        "dateTime": "14/05/2025 17:04:48"
      },
      {
        "label": "Entregue",
        "dateTime": "14/05/2025 17:04:49"
      }
    ],
    "voz": [
      {
        "label": "Enviado",
        "dateTime": "14/05/2025 17:05:00"
      },
      {
        "label": "Sucesso no atendimento",
        "dateTime": "14/05/2025 17:06:15"
      }
    ],
    "carta": [
      {
        "label": "Preparado o envio",
        "dateTime": "14/05/2025 17:10:00"
      },
      {
        "label": "Enviada",
        "dateTime": "15/05/2025 08:30:00"
      }
    ]
  },
  "lastStatus": {
    "email": {
      "label": "Lido (acessou o link)",
      "dateTime": "14/05/2025 17:05:55"
    },
    "sms": {
      "label": "Entregue",
      "dateTime": "14/05/2025 17:04:52"
    },
    "whatsapp": {
      "label": "Entregue",
      "dateTime": "14/05/2025 17:04:49"
    },
    "voz": {
      "label": "Sucesso no atendimento",
      "dateTime": "14/05/2025 17:06:15"
    },
    "carta": {
      "label": "Enviada",
      "dateTime": "15/05/2025 08:30:00"
    }
  },
  "email": [
    {
      "subject": "Documento Importante",
      "content": "<p>Você recebeu um documento importante.</p>",
      "idEmail": "f6cb58f2-3e9b-4899-b703-3facd52e17ee",
      "remetente": "noreply@empresa.com",
      "destinatario": "joao@exemplo.com",
      "dataEnviada": "14/05/2025",
      "horaEnviada": "17:04:44",
      "dataEntrega": "14/05/2025",
      "horaEntrega": "17:04:45",
      "dataLeitura": "14/05/2025",
      "horaLeitura": "17:05:55",
      "idImage": "abc123",
      "dataLeituraUTC": "2025-05-14T20:05:55.000Z",
      "detalhesEnvioEntrega": {
        "ocorridoEm": "14/05/2025 17:04:45",
        "carimbo": "carimbo_digital_assinado",
        "hashAssinado": "hash_assinatura_digital"
      },
      "detalhesLeitura": {
        "ocorridoEm": "14/05/2025 17:05:55",
        "ipLeitura": "192.168.1.100",
        "trilhaLeitura": {
          "userAgent": "Mozilla/5.0...",
          "referer": "https://google.com"
        },
        "carimbo": "carimbo_leitura_assinado"
      },
      "attachments": [
        {
          "downloadLink": "https://portal.ar-online.com.br/attachments/ZG9jdW1lbnRvLnBkZg==/uuid-documento",
          "originalFilename": "documento.pdf"
        }
      ],
      "emailResultSendStatus": "delivered",
      "emailRastreio": {
        "ip": "192.168.1.100",
        "country": "Brasil",
        "city": "São Paulo"
      },
      "emailRastreioProvider": {
        "ip": "10.0.0.1",
        "country": "Brasil",
        "city": "São Paulo"
      },
      "email_error": null,
      "dateClickEmailTrack": {},
      "dataClickProviderTrackEmail": {}
    }
  ],
  "sms": [
    {
      "detalhesEnvioEntregaSMS": {
        "hashAssinado": "hash_sms_assinado",
        "ocorridoEm": "14/05/2025 17:04:52",
        "carimbo": "carimbo_sms_assinado"
      },
      "detalhesLeituraSMS": {
        "hashAssinado": "hash_leitura_sms",
        "ocorridoEm": "14/05/2025 17:05:00",
        "carimbo": "carimbo_leitura_sms"
      },
      "numberSMS": "11999998888",
      "messageSMS": "Você recebeu um AR-Email. Acesse: https://short.link/abc123",
      "statusSMSDescription": "Entregue",
      "sms_error": null,
      "SMSRastreioProvider": {
        "ip": "10.0.0.2",
        "country": "Brasil",
        "city": "São Paulo"
      }
    }
  ],
  "whatsapp": [
    {
      "dataProviderWhatsApp": {
        "messageId": "whatsapp_msg_123",
        "status": "delivered",
        "timestamp": "14/05/2025 17:04:49"
      },
      "numberWhatsapp": "11999999888",
      "hasErrorWhatsapp": false,
      "statusWhatsapp": "Entregue"
    }
  ],
  "voz": [
    {
      "status": "Sucesso no atendimento",
      "number": "11999999888",
      "linkAtendimento": "https://portal.ar-online.com.br/emails/info/public/voz/f6cb58f2-3e9b-4899-b703-3facd52e17ee"
    }
  ],
  "carta": [
    {
      "status": "Enviada",
      "sro": "YA000000000BR",
      "linkRastreio": "https://rastreamento.correios.com.br/app/index.php?objetos=YA000000000BR"
    }
  ]
}

Onde:

codEmail: Código interno do email
statusFull: Histórico completo de status de todos os canais
lastStatus: Último status de cada canal
email: Dados detalhados do canal Email (incluindo carimbos digitais, trilhas de leitura, links de download dos anexos)
sms: Dados detalhados do canal SMS (incluindo carimbos digitais)
whatsapp: Dados detalhados do canal WhatsApp
voz: Dados detalhados do canal Voz
carta: Dados detalhados do canal Carta

🔒 Dados de Perícia: Este endpoint inclui informações críticas para perícia como:

Carimbos digitais assinados (hashAssinado, carimbo)
Trilhas de leitura com IP e User-Agent
Timestamps precisos em UTC
Dados de rastreamento geográfico
Histórico completo de status de todos os canais
Links de download seguros para anexos (downloadLink com nome original em base64)

Todas as datas estão no formato BRT (Brasília)

Consulta do status do AR-Email

Endpoint: https://api.ar-online.com.br/gw/email/{idEmail}
Método: GET
Parâmetros da Requisição:
- idEmail - ID único obtido no envio do AR-Email
Resposta:
```
{
  "dateSend": "21/10/2025 10:29:54",
  "dateDelivery": "21/10/2025 10:29:58",
  "dateReading": "21/10/2025 10:30:06",
  "dateAcceptance": "21/10/2025 10:38:48",
  "error": false,
  "description": "Confirmou o recebimento",
  "failureReason": null,
  "customID": null,
  "idEmail": "f6cb58f2-3e9b-4899-b703-3facd52e17ee"
}
```
Onde:
- dateSend: Data do Envio da Mensagem
- dateDelivery: Data da Entrega da Mensagem
- dateReading: Data da Leitura da Mensagem
- dateAcceptance: Data da Confirmação de Recebimento da Mensagem
- error: Indica se houve ou não erro
- description: Descrição do Status - Enviado, Entregue, Lido, Confirmou o recebimento, Falha no Envio/Entrega
- failureReason: Detalhamento do erro
- customID: ID utilizado no envio da Mensagem
- idEmail: ID do AR-Email
Todas as datas estão no formato BRT (Brasília)

Consulta do status do AR-SMS

Endpoint: https://api.ar-online.com.br/gw/sms/{idEmail}
Método: GET
Parâmetros da Requisição:
- idEmail - ID único obtido no envio do AR-Email
Resposta:
```
{
  "dateSend": "21/02/2025 21:01:54",
  "dateReading": "21/02/2025 21:02:00",
  "description": "Entregue",
  "dateAnswered": null,
  "answered": []
}
```
Onde:
- dateSend: Data do Envio da Mensagem
- dateReading: Data da Leitura da Mensagem
- description: Descrição do Status - Processado (enfileirado na fila para envio), Enviado, Entregue, Lido, Falha
- answered: Lista de respostas da Mensagem
- dateAnswered: Data da Resposta da Mensagem
Todas as datas estão no formato BRT (Brasília)

Consulta do status do AR-Whatsapp

Endpoint: https://api.ar-online.com.br/gw/whatsapp/{idEmail}
Método: GET
Parâmetros da Requisição:
- idEmail - ID único obtido no envio do AR-Email
Resposta:
```
 {
   "description": "Lido (acessou o link)",
   "dateSent": "14/05/2025 17:04:44",
   "dateDelivery": "14/05/2025 17:04:45",
   "dateResponse": "21/05/2025 10:26:19",
   "dateAccessLink": "14/05/2025 17:05:55",
   "error": false,
   "failureReason": null,
   "customID": null,
   "idEmail": "f6cb58f2-3e9b-4899-b703-3facd52e17ee"
 }
```
Onde:
- description: Descrição do Status - Processado (enfileirado na fila para envio), Enviado, Entregue, Visualizado (WhatsApp), Respondido, Lido (acessou o link), Número inválido, Falha no envio/entrega
- dateSent: Data do Envio da Mensagem
- dateDelivery: Data da Entrega da Mensagem
- dateReading: Data da Leitura da Mensagem
- dateResponse: Data de Resposta da Mensagem
- dateAccessLink: Data de Acesso ao Link da Mensagem Enviada
- error: Indica se houve ou não erro
- failureReason: Detalhamento do erro
- customID: ID utilizado no envio da Mensagem
- idEmail: ID do AR-Email
  Todas as datas estão no formato BRT (Brasília)

Consulta do status do AR-Voz

Endpoint: https://api.ar-online.com.br/gw/voz/{idEmail}
Método: GET
Parâmetros da Requisição:
- idEmail - ID único obtido no envio do AR-Email
Resposta:
```
{
  "dateSent": "05/12/2024 14:19:57",
  "dateSuccessCall": "05/12/2024 14:21:10",
  "description": "Sucesso no atendimento",
  "linkCall": "https://portal.ar-online.com.br/emails/info/public/voz/%7BidEmail%7D"
}
```
Onde:
- dateSent: Data do Envio da Mensagem
- dateSuccessCall: Data de Sucesso - Confirmação da Mensangem
- description: Enviado, Falha no atendimento, Falha no envio/entrega, Atendimento Confirmado
- linkCall: Link para download da gravação da chamada
Todas as datas estão no formato BRT (Brasília)

Consulta do status do AR-Cartas

Endpoint: https://api.ar-online.com.br/gw/carta/{idEmail}
Método: GET
Parâmetros da Requisição:
- idEmail - ID único obtido no envio do AR-Email
Resposta:
```
{
  "description": "Entregue",
  "error": false,
  "dateProcessing": "19/02/2025 10:45:50",
  "datePreparation": "19/02/2025 20:45:50",
  "dateDelivery": "10/03/2025 14:19:18",
  "sro": "YA000000000BR",
  "linkArCartaComprovante": "https://ar-carta-dev.s3.us-east-1.amazonaws.com/XYZ",
  "linkRastreio": "https://rastreamento.correios.com.br/app/index.php?objetos=YA000000000BR"
}
```
Onde:
- dateProcessing: Data de início de processamento da carta
- datePreparation: Data da preparação da carta - envio + processamento da printer
- dateDelivery: Data de entrega da carta (Correios)
- description: Processando o envio, Preparado o envio, Pendente de envio, Enviada, Entregue, Falha ao tentar enviar/entrega
- sro: Código de rastreio dos correios
- linkArCartaComprovante: Link com validade de uma hora para download do comprovante dos correios
- linkRastreio: Link para a página dos correios
Todas as datas estão no formato BRT (Brasília)

Comprovante do Envio

Endpoint: https://api.ar-online.com.br/gw/sending-proof/{idEmail}
Método: GET
Parâmetros da Requisição:
- idEmail - ID único obtido no envio do AR-Email
Respostas:
- Email com status:

  {
    "content": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/KQovQ3JlYXRvciAo/v8pCi9Qcm9kdWNlciAo/v8AUQB0ACAANQAuADUALgAxKQovQ3JlYXRpb25EYXRlIChEOjIwMjAwNTIyMTk0MDU5KQo+PgplbmRvYmoKMiAwI",
  }

Onde:

content: Comprovante PDF em base64

Email sem Status

{
  "message": "O comprovante para e-mail consultado ainda não possui o status de entrega",
}

Laudo Pericial

Endpoint: https://api.ar-online.com.br/gw/email/laudo/{idEmail}
Método: GET
Parâmetros da Requisição:
- idEmail - ID único (UUID) obtido no envio do AR-Email
Respostas:
- Sucesso (200)
  Retorna o arquivo PDF do Laudo Pericial diretamente no corpo da resposta.
  Headers da Resposta:
```
Content-Type: application/pdf
Content-Disposition: inline; filename="laudo.pdf"
```
  O conteúdo retornado é um arquivo binário (PDF), não sendo codificado em base64.

Onde:

Content-Type: Indica que o retorno é um arquivo PDF.
Content-Disposition: Define se o arquivo será exibido no navegador (inline) ou baixado.

Registro não encontrado (404)

{
  "statusCode": 404,
  "message": "Registro não encontrado"
}

Finalizar Régua de Notificação

Endpoint: GET /regua-notificacao/finalizar/{emailId}
Método: GET
Parâmetros da Requisição:
- idEmail - ID único obtido no envio do AR-Email
Respostas:

  { 
    "message": "Regua de notificação finalizada com sucesso" 
  }

Possíveis Mensagens de Erro

{
  "statusCode": 401,
  "message": "Unauthorized"
}

{
  "statusCode": 404,
  "message": "Email sem status!"
}

{
  "statusCode": 404,
  "message": "O comprovante para e- mail consultado ainda não possui o status de entrega"
}

{
  "statusCode": 401,
  "message": "Você tentou enviar um email para ${emailTo}, porém ele está em uma blacklist"
}

{
  "statusCode": 400,
  "message": "O e-mail do destinatário informado é inválido, Verifique o endereço de e-mail inserido."
}

{
  "statusCode": 400,
  "message": "Você está tentando enviar um email, você não possui créditos suficientes"
}

{
  "statusCode": 400,
  "message": "O número do destinatário informado é inválido, Verifique o número inserido."
}

{
  "statusCode": 500,
  "message": "Não foi possível enviar o email." 
}

{
  "statusCode": 400,
  "message": "Erro ao obter informações do plano."
}

{  
  "statusCode": 404,  
  "message": "Carta não encontrado",  
  "error": "Not Found"
  }

{  
  "statusCode": 400,  
  "message": "Validation failed (uuid is expected)",  
  "error": "Bad Request"
  }

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

API Gateway

Autenticação​

Validação de Segurança (Validation)​

Como funciona​

Exemplo de uso​

Enviar AR-Online​

Body Completo da Requisição: AR-Email, AR-SMS, AR-Whatsapp, *AR-Voz e *AR-Cartas - Envio Completo​

Body Completo da Requisição: AR-Email​

Body Completo da Requisição: AR-SMS​

Body Completo da Requisição: AR-Whatsapp​

Body Completo da Requisição: AR-Voz​

Body Completo da Requisição: AR-Cartas​

SMS​

Whatsapp​

Voz​

Carta​

Enviar AR-WhatsApp - Template personalizado​

Consulta do status completo (Full) - Dados de Perícia​

Consulta do status do AR-Email​

Consulta do status do AR-SMS​

Consulta do status do AR-Whatsapp​

Consulta do status do AR-Voz​

Consulta do status do AR-Cartas​

Comprovante do Envio​

Laudo Pericial​

Finalizar Régua de Notificação​

Possíveis Mensagens de Erro​

Autenticação

Validação de Segurança (Validation)

Como funciona

Exemplo de uso

Enviar AR-Online

Body Completo da Requisição: AR-Email, AR-SMS, AR-Whatsapp, AR-Voz e AR-Cartas - Envio Completo

Body Completo da Requisição: AR-Email

Body Completo da Requisição: AR-SMS

Body Completo da Requisição: AR-Whatsapp

Body Completo da Requisição: AR-Voz

Body Completo da Requisição: AR-Cartas

SMS

Whatsapp

Voz

Carta

Enviar AR-WhatsApp - Template personalizado

Consulta do status completo (Full) - Dados de Perícia

Consulta do status do AR-Email

Consulta do status do AR-SMS

Consulta do status do AR-Whatsapp

Consulta do status do AR-Voz

Consulta do status do AR-Cartas

Comprovante do Envio

Laudo Pericial

Finalizar Régua de Notificação

Possíveis Mensagens de Erro