Metoda este destinată obținerii listei de blocări (Suppressions). Poate fi folosită pentru căutarea după un anumit set de filtre. Toți parametrii sunt opționali. Datele se transmit în parametrii query din link.
Blocarea (Suppression, regulă de blocare) — este o funcționalitate a site-ului care împiedică trimiterea e-mailurilor către o anumită adresă. De exemplu, utilizatorul s-a dezabonat / s-a plâns de spam sau adresa lui de e-mail pur și simplu nu funcționează. Sistemul determină situația în care trimiterea e-mailurilor către acest email nu mai este posibilă și creează o regulă de blocare.
Cerere HTTP
- URL:
https://sender-solutions.com/api/suppressions/suppressions-list/ - Metodă HTTP: GET
Exemplu de cerere cu setul maxim de parametri cu folosirea 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}}'
Descrierea câmpurilor
| Câmp | Tip | Obligatoriu | Descriere |
|---|---|---|---|
offset | int | Numărul de înregistrări găsite din lista finală care trebuie sărite. Necesar pentru implementarea citirii pe porțiuni (pe pagini) a datelor. Implicit — 0. | |
limit | int | Numărul maxim de înregistrări care trebuie returnate în răspunsul la această cerere. Necesar pentru implementarea citirii pe porțiuni (pe pagini) a datelor. Implicit — 100, maxim — 2000. | |
Id | int | Identificatorul regulii de blocare. Dacă este indicat, se folosește ca filtru. | |
BaseId | int | Identificatorul bazei de abonați. Dacă este indicat, se folosește ca filtru. Valoarea 0 înseamnă toate bazele, adică regula nu este limitată de nicio bază concretă. La indicarea valorii 0, filtrarea se efectuează oricum. Pentru a nu filtra rezultatul după câmpul BaseId, este necesar să nu transmiteți deloc acest câmp. | |
Email | string | Adresa de e-mail. Dacă este indicată, se folosește ca filtru. | |
Type | string | Tipul regulii. Dacă este indicat, se folosește ca filtru. Valori posibile: spam — plângere de spam, unsubscribe — dezabonare de la campanie, hard_bounce — erori permanente de livrare, soft_bounces — erori temporare de livrare care s-au repetat de multe ori. |
Exemplu de răspuns reușit în formatul JSON
{
"success": true,
"SuppressionsList": {
"TotalCount": 1,
"Offset": 0,
"Limit": 10,
"Suppressions": [
{
"Id": 2,
"BaseId": 0,
"Email": "username@example.com",
"Type": "unsubscribe",
"CreatedAt": 1770505912
}
]
}
}În acest răspuns, câmpul SuppressionsList.TotalCount înseamnă numărul total de înregistrări găsite după cerere. Câmpurile SuppressionsList.Offset și SuppressionsList.Limit dublează valorile din cerere ținând cont de limitările valorilor minime și maxime. Câmpul SuppressionsList.Suppressions conține array-ul de reguli de blocare. Câmpul SuppressionsList.Suppressions.*.CreatedAt răspunde de ora creării regulii în formatul UnixTimestamp.