Nombre del servicio
GET https://api.envialosimple.email/api/v1/mail/:identifier
Método de autenticación
Authorization: Bearer
Para más detalle sobre cómo generar clave API ver: Cómo enviar mails desde la API
Descripción
Devuelve el detalle del email.
Parámetros
Nombre | Tipo | Descripción |
identifier | String | ID del email. Requerido. |
Respuesta
Campo | Descripción |
id | ID de email. |
created_date | Fecha de creación. Zona horaria UTC+00:00. |
from | Remitente del email. |
to | Destinatario del email. |
subject | Asunto del email. |
status |
Estado del email. Valores posibles: processed ➔ Procesado sent ➔ Entregado rejected ➔ Rechazado failed ➔ Falla de envío excluded ➔ Excluido |
events |
Detalle de los eventos por los que pasa el email. 🛈 Tener en cuenta que esta información se guarda por un período determinado que depende del plan que hayas contratado. |
events.mail_id | ID de email. |
events.type |
Evento. Valores posibles: queued ➔ Encolado processed ➔ Procesado rejected_hard ➔ Rebote duro rejected_soft ➔ Rebote blando failed ➔ Falla de envío sent ➔ Entregado read ➔ Abierto click ➔ Cliqueado excluded ➔ Excluido complaint ➔ Queja |
events.date | Fecha del evento. Zona horaria UTC+00:00. |
events.email | Destinatario. |
events.id | ID de evento. |
type |
Formato del email. Valores posibles: text ➔ Texto plano html ➔ HTML |
channel |
Canal de envío. Valores posibles: http ➔ API smtp ➔ SMTP preview ➔ Vista previa |
extra_data.preview.path | Path de la imagen del email |
Ejemplo de respuesta
{
"id": "661d0e4cf0f90d40880a4452",
"created_date": "2024-04-15T11:23:56+00:00",
"from": "empresa@ejemplo.com",
"to": "destinatario@ejemplo.com",
"subject": "Recibimos la documentación!",
"status": "sent",
"events": [
{
"mail_id": "661d0e4cf0f90d40880a4452",
"type": "queued",
"date": "2024-04-15T11:23:56+00:00",
"email": "destinatario@ejemplo.com",
"id": "661d0e4cf0f90d40880a2233"
},
{
"mail_id": "661d0e4cf0f90d40880a4452",
"type": "processed",
"date": "2024-04-15T11:23:57+00:00",
"email": "destinatario@ejemplo.com",
"id": "661d0e4d02095e3a080f6213"
},
{
"mail_id": "661d0e4cf0f90d40880a4452",
"type": "sent",
"date": "2024-04-15T11:24:06+00:00",
"email": "destinatario@ejemplo.com",
"id": "661d0e56fba1f161a901b9a2"
},
{
"mail_id": "661d0e4cf0f90d40880a4452",
"type": "click",
"date": "2024-04-15T11:25:01+00:00",
"email": "destinatario@ejemplo.com",
"id": "661d0e8dd73bef1dea0fea03"
}
],
"type": "html",
"channel": "http",
"extra_data": {
"preview": {
"path":"https://api.envialosimple.email/files/Mail/6452a270807877b0d107e2a5/preview/661d0e4cf0d50d40880a5893_661d0e51b1c7f.png"
}
}
}
Comentarios
0 comentarios
El artículo está cerrado para comentarios.