El método está destinado a la obtención de la lista de bloqueos (Suppressions). Se puede usar para buscar según un conjunto determinado de filtros. Todos los parámetros son opcionales. Los datos se transmiten en los parámetros query del enlace.
Un bloqueo (Suppression, regla de bloqueo) — es una funcionalidad del sitio que impide el envío de correos a una determinada dirección. Por ejemplo, el usuario se dio de baja / se quejó de spam o su dirección de email no funciona en absoluto. El sistema detecta la situación en la que el envío de correos a este email ya no es posible, y crea una regla de bloqueo.
Solicitud HTTP
- URL:
https://sender-solutions.com/api/suppressions/suppressions-list/ - Método HTTP: GET
Ejemplo de solicitud con el conjunto máximo de parámetros usando cURL
curl --location 'https://sender-solutions.com/api/suppressions/suppressions-list/?offset=0&limit=10&Id=25&BaseId=0&Email=username%40example.com&Type=unsubscribe' \
--header 'Authorization: {{api-token}}'
Descripción de los campos
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
offset | int | Cantidad de registros encontrados de la lista resultante que es necesario omitir. Se necesita para la implementación de la lectura por porciones (por páginas) de los datos. Por defecto — 0. | |
limit | int | Cantidad máxima de registros que es necesario devolver en la respuesta a esta solicitud. Se necesita para la implementación de la lectura por porciones (por páginas) de los datos. Por defecto — 100, máximo — 2000. | |
Id | int | Identificador de la regla de bloqueo. Si se indica, se usa como filtro. | |
BaseId | int | Identificador de la base de suscriptores. Si se indica, se usa como filtro. El valor 0 significa todas las bases, es decir, la regla no está limitada a ninguna base concreta. Al indicar el valor 0, el filtrado se realiza de todos modos. Para no filtrar el resultado por el campo BaseId, es necesario no transmitir este campo en absoluto. | |
Email | string | Dirección de email. Si se indica, se usa como filtro. | |
Type | string | Tipo de regla. Si se indica, se usa como filtro. Valores posibles: spam — queja de spam, unsubscribe — baja del envío, hard_bounce — errores de entrega permanentes, soft_bounces — errores de entrega temporales que se repitieron múltiples veces. |
Ejemplo de respuesta exitosa en formato JSON
{
"success": true,
"SuppressionsList": {
"TotalCount": 1,
"Offset": 0,
"Limit": 10,
"Suppressions": [
{
"Id": 2,
"BaseId": 0,
"Email": "username@example.com",
"Type": "unsubscribe",
"CreatedAt": 1770505912
}
]
}
}En esta respuesta, el campo SuppressionsList.TotalCount significa la cantidad total de registros encontrados según la solicitud. Los campos SuppressionsList.Offset y SuppressionsList.Limit duplican los valores de la solicitud teniendo en cuenta las restricciones de los valores mínimos y máximos. El campo SuppressionsList.Suppressions contiene un array de reglas de bloqueo. El campo SuppressionsList.Suppressions.*.CreatedAt corresponde a la hora de creación de la regla en formato UnixTimestamp.