Nombre del servicio
GET https://api.envialosimple.email/api/v1/mail
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 una lista de todos los emails enviados.
Parámetros
| Nombre | Tipo | Descripción |
| domainId | String | ID de dominio. Requerido. |
| limit | Integer | Cantidad de registros por página. Por defecto: 10. Máximo: 100. |
| page | Integer | Número de página. Por defecto: 1. |
| sort | String |
Ordenar por. Valores posibles: created_date ➔ Fecha de creación from ➔ Remitente to ➔ Destinatario subject ➔ Asunto Por defecto: Fecha de creación. |
| direction | String |
Tipo de ordenamiento. Valores posibles: asc ➔ Ascendente. desc ➔ Descendente. Por defecto: Ascendente. |
| filters | String |
Expresión para filtrar los registros. Ver detalle de la Generación de expresiones (*). Ejemplos: {"status": "excluded"} ➔ Filtra por estado excluido {"created_date":{"$gt":{"$ts":1711971302}}} ➔ Filtra por fecha de creación mayor a {"to":{"$regex":"prueba"}} ➔ Filtra por destinatario que contenga “prueba” |
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 |
| 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 |
Errores
| Error | Descripción |
| domain_required | El dominio es requerido. |
| domain_not_allowed | No existe el dominio informado. |
| invalid_direction | El tipo de ordenamiento es incorrecto. Verifique los posibles valores. |
| invalid_page | El número de página ingresado es incorrecto. Debe ser un número entero positivo. |
| invalid_limit |
La cantidad de registros por página es incorrecta. Debe ser un número entero positivo. |
| malformed_filter | La expresión para filtrar los registros ingresada es incorrecta. Ver detalle de la Generación de expresiones (*). |
Ejemplo de respuesta
{
"page": 1,
"limit": 20,
"payload": [
{
"id": "661d0e4cf0f90d40880a5589",
"created_date": "2024-04-15T11:23:56+00:00",
"from": "\"Empresa\" <empresa@prueba.com.ar>",
"to": "envio@ejemplo.com ",
"subject": "Recibimos la documentación!",
"status": "sent",
"type": "html",
"channel": "http"
},
{
"id": "661d0f6b6a351e9936375e02",
"created_date": "2024-04-15T11:28:43+00:00",
"from": "\"Empresa\" <empresa@prueba.com.ar>",
"to": "envio@ejemplo.com",
"subject": "Confirmación de pedido",
"status": "sent",
"type": "text",
"channel": "http"
}
],
"total": 2
}
Comentarios
0 comentarios
El artículo está cerrado para comentarios.