Metot, engelleme (Suppressions) listesini almak için tasarlanmıştır. Belirli bir filtre kümesine göre arama için kullanılabilir. Tüm parametreler isteğe bağlıdır. Veriler, bağlantıdaki query parametrelerinde iletilir.
Engelleme (Suppression, engelleme kuralı) — belirli bir adrese e-posta gönderilmesini önleyen bir site işlevselliğidir. Örneğin, kullanıcı abonelikten çıktı / spam şikayetinde bulundu ya da e-posta adresi hiç çalışmıyor. Sistem, bu email'e artık e-posta gönderilmesinin mümkün olmadığı durumu belirler ve bir engelleme kuralı oluşturur.
HTTP isteği
- URL:
https://sender-solutions.com/api/suppressions/suppressions-list/ - HTTP metodu: GET
Maksimum parametre kümesiyle cURL kullanılarak istek örneği
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}}'
Alanların açıklaması
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
offset | int | Nihai listeden bulunan ve atlanması gereken kayıt sayısı. Verilerin parçalı (sayfalı) okunmasının uygulanması için gereklidir. Varsayılan olarak — 0. | |
limit | int | Bu isteğe yanıt olarak döndürülmesi gereken maksimum kayıt sayısı. Verilerin parçalı (sayfalı) okunmasının uygulanması için gereklidir. Varsayılan olarak — 100, maksimum — 2000. | |
Id | int | Engelleme kuralının tanımlayıcısı. Belirtilirse, filtre olarak kullanılır. | |
BaseId | int | Abone tabanının tanımlayıcısı. Belirtilirse, filtre olarak kullanılır. 0 değeri tüm tabanları ifade eder, yani kural herhangi bir belirli tabanla sınırlı değildir. 0 değeri belirtildiğinde filtreleme yine de yapılır. Sonucu BaseId alanına göre filtrelememek için bu alanı hiç iletmemek gerekir. | |
Email | string | E-posta adresi. Belirtilirse, filtre olarak kullanılır. | |
Type | string | Kuralın türü. Belirtilirse, filtre olarak kullanılır. Olası değerler: spam — spam şikayeti, unsubscribe — gönderimden abonelikten çıkma, hard_bounce — kalıcı teslimat hataları, soft_bounces — birçok kez tekrarlanan geçici teslimat hataları. |
JSON formatında başarılı yanıt örneği
{
"success": true,
"SuppressionsList": {
"TotalCount": 1,
"Offset": 0,
"Limit": 10,
"Suppressions": [
{
"Id": 2,
"BaseId": 0,
"Email": "username@example.com",
"Type": "unsubscribe",
"CreatedAt": 1770505912
}
]
}
}Bu yanıtta SuppressionsList.TotalCount alanı, isteğe göre bulunan toplam kayıt sayısını ifade eder. SuppressionsList.Offset ve SuppressionsList.Limit alanları, minimum ve maksimum değer sınırlamalarını dikkate alarak istekteki değerleri yineler. SuppressionsList.Suppressions alanı engelleme kuralları dizisini içerir. SuppressionsList.Suppressions.*.CreatedAt alanı, kuralın UnixTimestamp formatında oluşturulma zamanından sorumludur.