Sin intercepciones
EngageLab interceptará las direcciones de correo electrónico en estado de complaint, block, bounce y unsubscribe.
Si el cliente no desea interceptar una dirección o un dominio receptor, puede añadirlo a la lista no_interceptions.
Se puede consultar, agregar y eliminar esta lista.
Dirección de invocación
| Centro de datos | URL |
|---|---|
| Singapur | https://email.api.engagelab.cc |
| Turquía | https://emailapi-tr.engagelab.com |
Al utilizar la API REST, se debe asegurar de que el centro de datos seleccionado corresponda a la URL base adecuada.
Consultar
URL
https://email.api.engagelab.cc/v1/no_interceptions
Método de solicitud HTTP
GET
Encabezado
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | string | Sí | Basic base64(api_user:api_key) |
Descripción de parámetros de consulta
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| start_date | string | Sí | Fecha de inicio, con formato yyyy-MM-dd |
| end_date | string | Sí | Fecha de fin, con formato yyyy-MM-dd |
| email_or_domain | string | Sí | Correos o dominios (p. ej., 11@gmail.com, hotmail.com) |
| api_user | string | No | API_USER sin intercepción; valor predeterminado: all |
| offset | int | No | Cantidad, [0-100], valor predeterminado: 100 |
| limit | int | No | Cantidad, [0-100], valor predeterminado: 100 |
Ejemplo de solicitud:
curl -X GET -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
'https://email.api.engagelab.cc/v1/no_interceptions'
Descripción de valores devueltos
| Parámetro | Descripción |
|---|---|
| api_user | API_USER sin intercepción |
| email_or_domain | Dominio receptor o dirección de correo sin intercepción |
| create_time | Hora de creación |
Ejemplo de valores devueltos
{
"result": [
{
"api_user": "all",
"email_or_domain": "wbw@hotmail.com",
"create_time": "2021-07-15 15:32:03"
}
],
"count": 1,
"total": 1
}
Agregar
URL
https://email.api.engagelab.cc/v1/no_interceptions
Método de solicitud HTTP
POST
Encabezado
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | string | Sí | Basic base64(api_user:api_key) |
Descripción de parámetros del cuerpo
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| api_user | string | No | API_USER sin intercepción; valor predeterminado: all |
| email_or_domain | array | Sí | Dominio receptor o dirección de correo sin intercepción |
Ejemplo de solicitud:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"api_user": "123456abc", "email_or_domain": ["qq.com","22@gmail.com"]}' \
'https://email.api.engagelab.cc/v1/no_interceptions'
Descripción de valores devueltos
| Parámetro | Descripción |
|---|---|
| api_user | API_USER sin intercepción |
| email_or_domain | Dominio receptor o dirección de correo sin intercepción |
| create_time | Hora de creación |
Ejemplo de valores devueltos
{
"result": [
{
"api_user": "all",
"email_or_domain": "qq.com",
"create_time": "2021-07-19 11:30:00"
},
{
"api_user": "all",
"email_or_domain": "22@gmail.com",
"create_time": "2021-07-19 11:30:00"
}
]
}
Eliminar
URL
https://email.api.engagelab.cc/v1/no_interceptions
Método de solicitud HTTP
DELETE
Encabezado
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | string | Sí | Basic base64(api_user:api_key) |
Descripción de parámetros del cuerpo
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| api_user | string | No | API_USER sin intercepción |
| email_or_domain | array | Sí | Dominios receptores o direcciones de correo sin intercepción |
Ejemplo de solicitud:
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
'https://email.api.engagelab.cc/v1/no_interceptions'
Descripción de valores devueltos
| Parámetro | Descripción |
|---|---|
| count | Número de eliminaciones realizadas correctamente |
Ejemplo de valores devueltos
{
"count": 1
}
Eliminar sin intercepciones
URL
https://email.api.engagelab.cc/v1/no_interceptions
Método de solicitud HTTP
DELETE
Encabezado
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | string | Sí | Basic base64(api_user:api_key) |
Descripción de parámetros del cuerpo
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| api_user | string | No | API_USER sin intercepción |
| email_or_domain | array | Sí | Dominio receptor o dirección de correo sin intercepción |
Ejemplo de solicitud:
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"api_user": "123456abc", "email_or_domain": ["qq.com","22@gmail.com"]}' \
'https://email.api.engagelab.cc/v1/no_interceptions'
Descripción de valores devueltos
| Parámetro | Descripción |
|---|---|
| count | Número de eliminaciones realizadas correctamente |
Ejemplo de valores devueltos
{
"count": 1
}
