Метод предназначен для получения списка Блокировок (Suppressions). Можно использовать для поиска по определённому набору фильтров. Все параметры необязательные. Данные передаются в query параметрах в ссылке
Блокировка, Suppression, Правило блокировки — это функционал сайта, который предотвращает отправку писем на определённый адрес. Например, пользователь отписался / пожаловался на спам, либо его email адрес вообще не работает. Система видит ситуацию, когда нельзя больше отправлять письма на этот email и создаёт Правило блокировки.
HTTP запрос
- URL:
https://sender-solutions.com/api/suppressions/suppressions-list/ - HTTP Метод: GET
Пример запроса с максимальным набором параметров с использованием 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}}'
Описание полей
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
offset | int | Количество найденных записей из итогового списка, которых необходимо пропустить. Необходимо для возможности порционного (постраничного) чтения данных. По умолчанию 0 | |
limit | int | Максимальное количество записей, которых необходимо отобразить в ответ на этот запрос. Необходимо для возможности порционного (постраничного) чтения данных. По умолчанию 100, максимум 2000 | |
Id | int | Идентификатор правила блокировки. Если указан, работает как фильтр | |
BaseId | int | Идентификатор Базы подписчиков. Если указан, работает как фильтр. Значение 0 отвечает за все базы, то есть когда правило не ограничивается какой-либо из баз. При указании значения 0 фильтрация всё равно происходит. Чтобы не фильтровать результат по полю BaseId, необходимо вообще не передавать это поле | |
Email | string | Email адрес. Если указан, работает как фильтр | |
Type | string | Тип правила. Если указан, работает как фильтр. Возможные значения: spam для жалоб на спам, unsubscribe для отписки от рассылки, hard_bounce для значения постоянных ошибок отправки, soft_bounces для временных ошибок отправки, которые многократно повторялись. |
Пример успешного ответа в JSON
{
"success": true,
"SuppressionsList": {
"TotalCount": 1,
"Offset": 0,
"Limit": 10,
"Suppressions": [
{
"Id": 2,
"BaseId": 0,
"Email": "username@example.com",
"Type": "unsubscribe",
"CreatedAt": 1770505912
}
]
}
}В этом ответе поле SuppressionsList.TotalCount означает общее количество записей, найденых по запросу. Поля SuppressionsList.Offset и SuppressionsList.Limit дублируют значения из запроса, с учётом ограничений по минимальным и максимальным значениям. Поле SuppressionsList.Suppressions содержит массив правил блокировки. Поле SuppressionsList.Suppressions.*.CreatedAt отвечает за время создания правила в формате UnixTimestamp.