Receber emails: Contatos e público

Ver status de entrega

Entrega de um email enviado, por destinatário. Só leitura.

POSThttps://g.sendcorex.com/v1command: get_delivery_status
i

status: delivered, sending, retrying, rate_limited, bounced, spam, not_sent, filtered ou suppressed.

Argumentos

  • idstringobrigatório

    O message_uid do email enviado.

  • cursornumberopcional

    O cursor da página anterior.

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "get_delivery_status",
        args: {
          id: "Vj0xQUJDMTIz"
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Resposta

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "get_delivery_status",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "total": 2,
        "audience_total": null,
        "recipients": [
          {
            "email": "ana@empresa.com",
            "status": "delivered",
            "reason": null,
            "at": "2026-11-21T09:40:00Z"
          },
          {
            "email": "joao@empresa.com",
            "status": "bounced",
            "reason": "550 mailbox not found",
            "at": "2026-11-21T09:40:02Z"
          }
        ],
        "cursor": null
      }
    }
  ]
}

Campos da resposta

  • total

    Destinatários com status até agora.

  • audience_total

    Envio com melhor horário: quantas pessoas recebem ao longo do dia. null num envio normal.

  • recipients[]

    email, status, reason e at. 50 por página.

  • cursor

    Próxima página, ou null.

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 401TOKEN_EXPIRED

    O access token expirou. Chame Refresh Token e repita a requisição.

  • 401INVALID_TOKEN

    O token está malformado, é desconhecido ou foi revogado.

  • 429RATE_LIMITED

    Mais de 15 requisições/s ou 15 em andamento para o mesmo IP + caixa de correio. Espere o número de segundos indicado em Retry-After.

  • CMDINVALID_ARGS

    Um argumento obrigatório está ausente ou é inválido.

  • CMDNOT_FOUND

    A mensagem, conversa ou pasta não existe para este token.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.