Die Methode ist zum Abrufen der Sperrliste (Suppressions) vorgesehen. Sie kann für die Suche nach einem bestimmten Satz von Filtern verwendet werden. Alle Parameter sind optional. Die Daten werden in Query-Parametern im Link übergeben.
Eine Sperre (Suppression, Sperrregel) — das ist eine Funktion der Website, die den Versand von E-Mails an eine bestimmte Adresse verhindert. Zum Beispiel hat sich der Nutzer abgemeldet / über Spam beschwert oder seine E-Mail-Adresse funktioniert überhaupt nicht. Das System erkennt die Situation, in der der Versand von E-Mails an diese E-Mail nicht mehr möglich ist, und erstellt eine Sperrregel.
HTTP-Anfrage
- URL:
https://sender-solutions.com/api/suppressions/suppressions-list/ - HTTP-Methode: GET
Beispiel einer Anfrage mit maximalem Satz von Parametern unter Verwendung von 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}}'
Beschreibung der Felder
| Feld | Typ | Obligatorisch | Beschreibung |
|---|---|---|---|
offset | int | Anzahl der gefundenen Einträge aus der Ergebnisliste, die übersprungen werden sollen. Notwendig für die Umsetzung des portionsweisen (seitenweisen) Lesens der Daten. Standardmäßig — 0. | |
limit | int | Maximale Anzahl der Einträge, die in der Antwort auf diese Anfrage zurückgegeben werden sollen. Notwendig für die Umsetzung des portionsweisen (seitenweisen) Lesens der Daten. Standardmäßig — 100, maximal — 2000. | |
Id | int | Kennung der Sperrregel. Wenn angegeben, wird als Filter verwendet. | |
BaseId | int | Kennung der Abonnentenbasis. Wenn angegeben, wird als Filter verwendet. Der Wert 0 bedeutet alle Basen, das heißt, die Regel ist nicht auf eine bestimmte Basis beschränkt. Bei Angabe des Werts 0 wird die Filterung dennoch durchgeführt. Um das Ergebnis nicht nach dem Feld BaseId zu filtern, darf dieses Feld gar nicht übergeben werden. | |
Email | string | E-Mail-Adresse. Wenn angegeben, wird als Filter verwendet. | |
Type | string | Typ der Regel. Wenn angegeben, wird als Filter verwendet. Mögliche Werte: spam — Spam-Beschwerde, unsubscribe — Abmeldung von der Aussendung, hard_bounce — dauerhafte Zustellfehler, soft_bounces — temporäre Zustellfehler, die sich mehrfach wiederholt haben. |
Beispiel einer erfolgreichen Antwort im JSON-Format
{
"success": true,
"SuppressionsList": {
"TotalCount": 1,
"Offset": 0,
"Limit": 10,
"Suppressions": [
{
"Id": 2,
"BaseId": 0,
"Email": "username@example.com",
"Type": "unsubscribe",
"CreatedAt": 1770505912
}
]
}
}In dieser Antwort bedeutet das Feld SuppressionsList.TotalCount die Gesamtzahl der nach der Anfrage gefundenen Einträge. Die Felder SuppressionsList.Offset und SuppressionsList.Limit duplizieren die Werte aus der Anfrage unter Berücksichtigung der Beschränkungen für Minimal- und Maximalwerte. Das Feld SuppressionsList.Suppressions enthält ein Array von Sperrregeln. Das Feld SuppressionsList.Suppressions.*.CreatedAt ist für die Erstellungszeit der Regel im Format UnixTimestamp verantwortlich.