Status consolidado (Full)

O endpoint Full retorna, em uma única chamada, os dados de perícia de todos os canais de um envio (e-mail, SMS, WhatsApp, voz e carta): o histórico completo de status, o último status de cada canal e os detalhes técnicos de cada entrega.

Endpoint: GET /gw/full/{idEmail}
Parâmetro de caminho: idEmail — identificador único obtido no envio.

Use este endpoint quando precisar de informações completas para perícia ou auditoria. Para acompanhar apenas o estágio atual de um canal, prefira a consulta por canal, que é mais leve.

Estrutura da resposta

A resposta combina três visões dos status com os blocos detalhados de cada canal:

number

Código interno do e-mail na plataforma.

object

Histórico completo de status de cada canal. Cada canal (email, sms, whatsapp, voz, carta) é um array de eventos com label (rótulo do status) e dateTime (data/hora em BRT).

object

Último status de cada canal, no mesmo formato { label, dateTime }.

array

Dados detalhados do canal e-mail, incluindo carimbos digitais, trilhas de leitura e links de download dos anexos.

array

Dados detalhados do canal SMS, incluindo carimbos digitais.

array

Dados detalhados do canal WhatsApp.

array

Dados detalhados do canal voz.

array

Dados detalhados do canal carta.

Dados de perícia

Além dos status, o bloco de cada canal traz informações críticas para comprovação pericial:

Carimbos digitais assinados — carimbo e hashAssinado em cada evento de envio, entrega e leitura.
Trilhas de leitura — IP de quem leu (ipLeitura), userAgent e referer do acesso.
Timestamps em UTC — além das datas em BRT, campos como dataLeituraUTC registram o momento exato em UTC.
Rastreamento geográfico — emailRastreio e emailRastreioProvider com IP, país e cidade.
Links seguros de anexos — downloadLink com o nome original do arquivo codificado em base64.

Exemplo de 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"
    }
  ]
}

Todas as datas em formato dd/mm/aaaa hh:mm:ss estão no fuso BRT (Brasília). Os campos com sufixo UTC (ex.: dataLeituraUTC) trazem o mesmo instante em UTC.

Para os significados possíveis de cada status, consulte a tabela em Consultar status por canal.

Início

Enviando notificações

Acompanhando envios

Notas técnicas

Webhooks

Templates

Referência da API

Endpoints

Status consolidado (Full)

Estrutura da resposta

Dados de perícia

Exemplo de resposta

​Estrutura da resposta

​Dados de perícia

​Exemplo de resposta

Estrutura da resposta

Dados de perícia

Exemplo de resposta