eComms

Buscar en la documentación

Busca en todas las páginas de la documentación y salta a un resultado.

Consultar un envío

GEThttps://api.e-comms.dev/v1/email/:messageId
Ver como Markdown

El resultado de un envío ya admitido. No cuesta cuota: una organización sobre su límite igual puede leer lo que ya envió.

Importante

Toda llamada necesita un bearer token de una clave de API activa. Ver Autenticación. Crea o administra claves desde el panel de claves de API.

Parámetros de ruta

messageIdstringObligatorio

El id que devolvió POST /v1/email en su propio results[].messageId.

Parámetros de consulta

Ninguno.

Encabezados

AuthorizationstringObligatorio

Bearer ek_live_<clave>.

Atributos de la solicitud

Ninguno.

Atributos de la respuesta

idstringObligatorio

El mismo id que el parámetro de ruta.

addressstringObligatorio

La dirección de este destinatario.

statusstringObligatorio

claimed, sent, suppressed, failed o unknown — ver Notas.

deliveryStatusstring | nullObligatorio

null hasta la primera entrega de webhook. Después, deferred, delivered, rejected, bounced o complained — ver Notas.

failureReasonstring | nullObligatorio

null salvo que status sea failed, donde trae el motivo del proveedor.

createdAtstringObligatorio

Cuándo se admitió el envío. Nunca null.

sentAtstring | nullObligatorio

null hasta que el intento de envío mismo tuvo éxito o falló.

deliveredAtstring | nullObligatorio

null hasta que deliveryStatus llega a delivered.

Notas

  • status es del intento de envío, no de la entrega. claimed es el único valor antes de llamar al proveedor; sent y failed describen si esa llamada tuvo éxito; unknown es lo que deja una interrupción entre la reclamación y la respuesta del proveedor, después de que un reintento acotado ya tuvo su oportunidad — nunca una entrega fallida en sí.
  • deliveryStatus es una escalera que nunca retrocede, la misma que documenta la referencia de webhooks: deferred, delivered, rejected, bounced y complained, en el orden en que puede llegar una queja tardía por encima de una entrega ya registrada.
  • No cuesta cuota: una organización sobre su límite igual puede leer lo que ya envió.
  • Leer pide su propio permiso. Esta ruta exige messages:read; enviar exige messages:send. Una clave emitida solo con messages:send puede enviar, pero recibe 403 al consultar un envío, así que crea la clave con los dos permisos si va a hacer ambas cosas.

Errores

EstadoCódigoCausa
403forbiddenLa clave no tiene el permiso messages:read. Una clave emitida solo con messages:send recibe este 403 al leer.
404not_foundEl mensaje no existe, o existe para otra organización — la respuesta nunca revela cuál de las dos.