API de cancelaciones de suscripción
Cuando un destinatario cancela la suscripción de un correo electrónico, su dirección se añadirá a la lista de cancelaciones de suscripción. No se enviarán más correos a la dirección de correo dada de baja. Se puede consultar, eliminar y añadir direcciones en la 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.
POST/v1/unsubscribes
Consultar
URL
https://email.api.engagelab.cc/v1/unsubscribes
https://email.api.engagelab.cc/v1/unsubscribes
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
GET
GET
Este bloque de código se muestra en una ventana flotante
Encabezado
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
Descripción de parámetros de consulta
| Parámetro | Tipo | Obligatorio o no | Descripción |
|---|---|---|---|
| start_date | string | * | Fecha de inicio (formato: yyyy-MM-dd) |
| end_date | string | * | Fecha de fin (formato: yyyy-MM-dd) |
| string | * | Dirección de correo electrónico, p. ej., 22@gmail.com |
|
| api_user | string | no | API_USER especificado; valor predeterminado: all |
| offset | int | no | Posición inicial [0-], valor predeterminado: 0 |
| limit | int | no | Cantidad [0-100], valor predeterminado: 100 |
Notas:
- El intervalo de tiempo no puede ser superior a 3 meses.
- Al buscar con una dirección de correo específica, se ignora el intervalo de tiempo.
Ejemplo de solicitud:
curl -X GET -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
'https://email.api.engagelab.cc/v1/unsubscribes?offset=0&limit=30'
curl -X GET -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
'https://email.api.engagelab.cc/v1/unsubscribes?offset=0&limit=30'
Este bloque de código se muestra en una ventana flotante
Descripción de valores devueltos
| Parámetro | Descripción |
|---|---|
| Dirección de correo electrónico | |
| api_user | API_USER |
| type | Tipo de cancelación de suscripción (0, 1, 2, 3) |
| unsubscribe_time | Marca de tiempo de cuándo se produjo la cancelación de suscripción |
| expire_time | Fecha y hora de caducidad de la intercepción de cancelación de suscripción |
| Tipo | Descripción |
|---|---|
| 0 | No quiero recibir este tipo de correos |
| 1 | No me suscribí a esto |
| 2 | Este correo es spam |
| 3 | Este correo es fraudulento; quiero reportarlo |
Ejemplo de valores devueltos:
{
"result": [
{
"email": "524244185@qq.com",
"unsubscribe_time": "2021-01-12T17:03:23+08:00",
"expire_time": "2023-01-12T17:03:23+08:00",
"api_user": "delong_test",
"type": 0
}
],
"count": 1,
"total": 1
}
{
"result": [
{
"email": "524244185@qq.com",
"unsubscribe_time": "2021-01-12T17:03:23+08:00",
"expire_time": "2023-01-12T17:03:23+08:00",
"api_user": "delong_test",
"type": 0
}
],
"count": 1,
"total": 1
}
Este bloque de código se muestra en una ventana flotante
Añadir
URL
https://email.api.engagelab.cc/v1/unsubscribes
https://email.api.engagelab.cc/v1/unsubscribes
Este bloque de código se muestra en una ventana flotante
Content-Type:
Content-Type: application/json;charset=utf-8
Content-Type: application/json;charset=utf-8
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
POST
POST
Este bloque de código se muestra en una ventana flotante
Encabezado
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
Descripción de parámetros del cuerpo
| Parámetro | Tipo | Obligatorio o no | Descripción |
|---|---|---|---|
| string | sí | Dirección de correo electrónico que se va a añadir | |
| expire_time | string | sí | Fecha y hora de caducidad de la intercepción de cancelación de suscripción (formato: yyyy-MM-dd) |
Ejemplo de solicitud:
curl -X POST -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"email": "xjmfc23@126.com","expire_time":"2023-12-31"}'
'https://email.api.engagelab.cc/v1/unsubscribes'
curl -X POST -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"email": "xjmfc23@126.com","expire_time":"2023-12-31"}'
'https://email.api.engagelab.cc/v1/unsubscribes'
Este bloque de código se muestra en una ventana flotante
Descripción de valores devueltos
| Parámetro | Descripción |
|---|---|
| Dirección de correo electrónico | |
| api_user | API_USER |
| unsubscribe_time | Hora de cancelación de suscripción |
| expire_time | Fecha y hora de caducidad |
Ejemplo de valores devueltos:
{
"result": {
"email": "abc@qq.com",
"api_user": "api_user",
"unsubscribe_time": "2014-11-19 10:57:24",
"expire_time": "2014-11-19 10:57:24"
}
}
{
"result": {
"email": "abc@qq.com",
"api_user": "api_user",
"unsubscribe_time": "2014-11-19 10:57:24",
"expire_time": "2014-11-19 10:57:24"
}
}
Este bloque de código se muestra en una ventana flotante
Eliminar
URL
https://email.api.engagelab.cc/v1/unsubscribes
https://email.api.engagelab.cc/v1/unsubscribes
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
DELETE
DELETE
Este bloque de código se muestra en una ventana flotante
Encabezado de la solicitud
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
Descripción de parámetros del cuerpo
| Parámetro | Tipo | Obligatorio o no | Descripción |
|---|---|---|---|
| string | * | Direcciones de correo que se van a eliminar | |
| start_date | string | * | Fecha de inicio (formato: yyyy-MM-dd) |
| end_date | string | * | Fecha de fin (formato: yyyy-MM-dd) |
Ejemplo de solicitud
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"start_date": "2023-04-06","end_date":"2023-07-06", "email": "example1@example.com"}'
'https://email.api.engagelab.cc/v1/unsubscribes'
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"start_date": "2023-04-06","end_date":"2023-07-06", "email": "example1@example.com"}'
'https://email.api.engagelab.cc/v1/unsubscribes'
Este bloque de código se muestra en una ventana flotante
Descripción de valores devueltos
| Parámetro | Descripción |
|---|---|
| count | Cantidad de direcciones eliminadas |
Ejemplo de valores devueltos:
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Este bloque de código se muestra en una ventana flotante
Response-error
HTTP Status: 401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
Este bloque de código se muestra en una ventana flotante
