Metoda je určena k získání seznamu blokování (Suppressions). Lze ji použít k vyhledávání podle určité sady filtrů. Všechny parametry jsou volitelné. Data se předávají v query parametrech v odkazu.
Blokování (Suppression, pravidlo blokování) — je funkcionalita webu, která zabraňuje zasílání e-mailů na určitou adresu. Například uživatel se odhlásil / si stěžoval na spam nebo jeho e-mailová adresa vůbec nefunguje. Systém rozpozná situaci, kdy zasílání e-mailů na tento e-mail již není možné, a vytvoří pravidlo blokování.
HTTP požadavek
- URL:
https://sender-solutions.com/api/suppressions/suppressions-list/ - HTTP metoda: GET
Příklad požadavku s maximální sadou parametrů s použitím 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}}'
Popis polí
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
offset | int | Počet nalezených záznamů z výsledného seznamu, které je třeba přeskočit. Je potřeba pro realizaci dávkového (stránkovaného) čtení dat. Výchozí — 0. | |
limit | int | Maximální počet záznamů, které je třeba vrátit v odpovědi na tento požadavek. Je potřeba pro realizaci dávkového (stránkovaného) čtení dat. Výchozí — 100, maximum — 2000. | |
Id | int | Identifikátor pravidla blokování. Pokud je uveden, používá se jako filtr. | |
BaseId | int | Identifikátor databáze odběratelů. Pokud je uveden, používá se jako filtr. Hodnota 0 znamená všechny databáze, tedy pravidlo není omezeno na žádnou konkrétní databázi. Při uvedení hodnoty 0 se filtrování přesto provádí. Chcete-li výsledek nefiltrovat podle pole BaseId, je nutné toto pole vůbec nepředávat. | |
Email | string | E-mailová adresa. Pokud je uvedena, používá se jako filtr. | |
Type | string | Typ pravidla. Pokud je uveden, používá se jako filtr. Možné hodnoty: spam — stížnost na spam, unsubscribe — odhlášení z rozesílky, hard_bounce — trvalé chyby doručení, soft_bounces — dočasné chyby doručení, které se opakovaně vyskytly. |
Příklad úspěšné odpovědi ve formátu JSON
{
"success": true,
"SuppressionsList": {
"TotalCount": 1,
"Offset": 0,
"Limit": 10,
"Suppressions": [
{
"Id": 2,
"BaseId": 0,
"Email": "username@example.com",
"Type": "unsubscribe",
"CreatedAt": 1770505912
}
]
}
}V této odpovědi pole SuppressionsList.TotalCount znamená celkový počet záznamů nalezených podle požadavku. Pole SuppressionsList.Offset a SuppressionsList.Limit duplikují hodnoty z požadavku s ohledem na omezení minimálních a maximálních hodnot. Pole SuppressionsList.Suppressions obsahuje pole pravidel blokování. Pole SuppressionsList.Suppressions.*.CreatedAt odpovídá za čas vytvoření pravidla ve formátu UnixTimestamp.