Метод призначений для отримання списку блокувань (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.