Nombre del servicio
GET https://api.envialosimple.email/api/v1/domains
Método de autenticación
Authorization: Bearer <clave API>
Para más detalle sobre cómo generar clave API ver: Cómo enviar mails desde la API
Descripción
Devuelve los datos generales del dominio.
Parametros
| Nombre | Tipo | Descripción |
| page | Integer | Número de página. Por defecto: 1. |
| limit | Integer | Cantidad de registros por página. Por defecto: 10. Máximo: 100. |
| sort | string | Ordenar por. Valores posibles: name/created_date. Por defecto: created_date. |
| direction | string | Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc. |
| filters | string | Expresión para filtrar los registros. Ver detalle de la Generación de expresiones (*). |
Respuesta
| Campo | Descripción |
| id | ID de dominio. |
| name | Nombre del dominio. |
| created_date | Fecha de creación. Zona horaria UTC+00:00. |
| deleted_date | Fecha de eliminación. Zona horaria UTC+00:00. |
| counters.mail_processed | Emails procesados. |
| health |
Reputación. Valores posibles: unknown > No disponible blocked > Mala warning > Regular good > Excelente |
| status |
Estado. Valores posibles: verified > Verificado not_verified > No verificado paused > Pausado deleted > Eliminado |
Errores
| Error | Descripción |
| malformed_filter | La expresión para filtrar los registros ingresada es incorrecta. Ver detalle de la Generación de expresiones (*). |
| 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. |
Ejemplo de respuesta
{
"page": 1,
"limit": 10,
"payload": [
{
"id": "8952a87b807877b0d199e2a8",
"name": "tudominio.com",
"created_date": "2024-03-15T18:08:59+00:00",
"deleted_date": null,
"counters": {
"mail_processed": 132
},
"health": "good",
"status": "verified"
}
],
"total": 1
}
Comentarios
0 comentarios
El artículo está cerrado para comentarios.