Blocks

Si se detecta un registro malicioso y no se desea enviar correos electrónicos a determinadas direcciones o buzones, se puede añadir el dominio o una dirección de correo electrónico específica a la lista de bloqueos. Las direcciones de correo electrónico incluidas en esta lista serán bloqueadas por el sistema. Se pueden consultar, añadir y eliminar entradas de esta lista.

Dirección de la solicitud

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/blocks

Consulta

URL

https://email.api.engagelab.cc/v1/blocks

              
              https://email.api.engagelab.cc/v1/blocks

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, con formato `yyyy-MM-dd`
end_date	string	*	Fecha de fin, con formato `yyyy-MM-dd`
email_or_domain	string	*	Correos electrónicos o dominios (p. ej., `11@gmail.com`, `hotmail.com`)
api_user	string	no	API_USER de bloqueo; valor predeterminado: `all`
offset	int	no	Inicio [0-100], valor predeterminado: 100
limit	int	no	Cantidad [0-100], valor predeterminado: 100

Notas:

El intervalo de tiempo no puede ser superior a 3 meses.

Ejemplo de solicitud:

curl -X GET -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/blocks?offset=0&limit=1'

              
              curl -X GET -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/blocks?offset=0&limit=1'

Este bloque de código se muestra en una ventana flotante

Descripción de los valores devueltos

Parámetro	Descripción
api_user	API_USER de bloqueo
email_or_domain	Correo electrónico o dominio bloqueado
create_time	Fecha de creación
expire_time	Fecha de caducidad

Ejemplo de valores devueltos

{ "result": [ { "block_id": 122, "api_user": "all", "email_or_domain": "11@gmail.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" },{ "block_id": 123, "api_user": "all", "email_or_domain": "hotmail.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" },{ "block_id": 124, "api_user": "all", "email_or_domain": "22@yahoo.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" } ], "count": 3, "total": 10 }

              
              {
  "result": [
    {
      "block_id": 122,
      "api_user": "all",
      "email_or_domain": "11@gmail.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    },{
      "block_id": 123,
      "api_user": "all",
      "email_or_domain": "hotmail.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    },{
      "block_id": 124,
      "api_user": "all",
      "email_or_domain": "22@yahoo.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    }
  ],
  "count": 3,
  "total": 10
}

Este bloque de código se muestra en una ventana flotante

Añadir

URL

https://email.api.engagelab.cc/v1/blocks

              
              https://email.api.engagelab.cc/v1/blocks

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
api_user	string	no	API_USER de bloqueo; valor predeterminado: `all`
email_or_domain	array	sí	Correos electrónicos o dominios (p. ej., `["11@gmail.com","hotmail.com","22@yahoo.com"]`)
expire_time	string	sí	Fecha de caducidad, con formato `yyyy-MM-dd`

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": ["11@gmail.com","hotmail.com","22@yahoo.com"],"expire_time":"2023-12-31"}' 'https://email.api.engagelab.cc/v1/blocks'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"api_user": "123456abc","email_or_domain": ["11@gmail.com","hotmail.com","22@yahoo.com"],"expire_time":"2023-12-31"}'
     'https://email.api.engagelab.cc/v1/blocks'

Este bloque de código se muestra en una ventana flotante

Descripción de los valores devueltos

Parámetro	Descripción
api_user	API_USER de bloqueo
email_or_domain	Correo electrónico o dominio
create_time	Fecha de creación
expire_time	Fecha de caducidad

Ejemplo de valores devueltos

{ "result": [ { "api_user": "all", "email_or_domain": "11@gmail.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" },{ "api_user": "all", "email_or_domain": "hotmail.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" },{ "api_user": "all", "email_or_domain": "22@yahoo.com", "create_time": "2021-03-01 17:24:34", "expire_time": "2021-10-01 00:00:00" } ] }

              
              {
   "result": [
    {
      "api_user": "all",
      "email_or_domain": "11@gmail.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    },{
      "api_user": "all",
      "email_or_domain": "hotmail.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    },{
      "api_user": "all",
      "email_or_domain": "22@yahoo.com",
      "create_time": "2021-03-01 17:24:34",
      "expire_time": "2021-10-01 00:00:00"
    }
  ]
}

Este bloque de código se muestra en una ventana flotante

Eliminar bloqueos

URL

https://email.api.engagelab.cc/v1/blocks

              
              https://email.api.engagelab.cc/v1/blocks

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

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
api_user	string	no	API_USER de bloqueo
email_or_domain	array	sí	Dominios de recepción o direcciones de correo electrónico bloqueados

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":["xjmfc@example.com","gmail.com"]}' 'https://email.api.engagelab.cc/v1/blocks'

              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"api_user":"123456abc","email_or_domain":["xjmfc@example.com","gmail.com"]}'
     'https://email.api.engagelab.cc/v1/blocks'

Este bloque de código se muestra en una ventana flotante

Descripción de los valores devueltos

Parámetro	Descripción
count	Número de elementos eliminados correctamente

Ejemplo de valores devueltos

{ "count": 1 }

              
              {
    "count": 1
}

Este bloque de código se muestra en una ventana flotante

API de bloqueos

Dirección de la solicitud

Consulta

Añadir

Eliminar bloqueos