Metoda przeznaczona jest do pobierania listy blokad (Suppressions). Można jej używać do wyszukiwania według określonego zestawu filtrów. Wszystkie parametry są opcjonalne. Dane przekazywane są w parametrach query w linku.
Blokada (Suppression, reguła blokady) — to funkcjonalność witryny, która zapobiega wysyłaniu wiadomości na określony adres. Na przykład użytkownik zrezygnował z subskrypcji / złożył skargę na spam albo jego adres email w ogóle nie działa. System rozpoznaje sytuację, gdy wysyłanie wiadomości na ten email nie jest już możliwe, i tworzy regułę blokady.
Żądanie HTTP
- URL:
https://sender-solutions.com/api/suppressions/suppressions-list/ - Metoda HTTP: GET
Przykład żądania z maksymalnym zestawem parametrów z użyciem 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}}'
Opis pól
| Pole | Typ | Obowiązkowe | Opis |
|---|---|---|---|
offset | int | Liczba znalezionych rekordów z wynikowej listy, które należy pominąć. Potrzebne do realizacji porcjowego (stronicowanego) odczytu danych. Domyślnie — 0. | |
limit | int | Maksymalna liczba rekordów, które należy zwrócić w odpowiedzi na to żądanie. Potrzebne do realizacji porcjowego (stronicowanego) odczytu danych. Domyślnie — 100, maksymalnie — 2000. | |
Id | int | Identyfikator reguły blokady. Jeśli podany, używany jest jako filtr. | |
BaseId | int | Identyfikator bazy subskrybentów. Jeśli podany, używany jest jako filtr. Wartość 0 oznacza wszystkie bazy, czyli reguła nie jest ograniczona żadną konkretną bazą. Przy wskazaniu wartości 0 filtrowanie i tak jest wykonywane. Aby nie filtrować wyniku według pola BaseId, należy w ogóle nie przekazywać tego pola. | |
Email | string | Adres email. Jeśli podany, używany jest jako filtr. | |
Type | string | Typ reguły. Jeśli podany, używany jest jako filtr. Możliwe wartości: spam — skarga na spam, unsubscribe — rezygnacja z wysyłki, hard_bounce — trwałe błędy dostarczenia, soft_bounces — tymczasowe błędy dostarczenia, które wielokrotnie się powtarzały. |
Przykład pomyślnej odpowiedzi w formacie JSON
{
"success": true,
"SuppressionsList": {
"TotalCount": 1,
"Offset": 0,
"Limit": 10,
"Suppressions": [
{
"Id": 2,
"BaseId": 0,
"Email": "username@example.com",
"Type": "unsubscribe",
"CreatedAt": 1770505912
}
]
}
}W tej odpowiedzi pole SuppressionsList.TotalCount oznacza całkowitą liczbę rekordów znalezionych według żądania. Pola SuppressionsList.Offset i SuppressionsList.Limit powielają wartości z żądania z uwzględnieniem ograniczeń wartości minimalnych i maksymalnych. Pole SuppressionsList.Suppressions zawiera tablicę reguł blokady. Pole SuppressionsList.Suppressions.*.CreatedAt odpowiada za czas utworzenia reguły w formacie UnixTimestamp.