Il metodo è destinato all'ottenimento dell'elenco dei blocchi (Suppressions). Si può usare per la ricerca secondo un determinato insieme di filtri. Tutti i parametri sono opzionali. I dati vengono trasmessi nei parametri query del link.
Un blocco (Suppression, regola di blocco) — è una funzionalità del sito che impedisce l'invio di email a un determinato indirizzo. Ad esempio, l'utente si è disiscritto / si è lamentato di spam oppure il suo indirizzo email non funziona affatto. Il sistema rileva la situazione in cui l'invio di email a questo email non è più possibile, e crea una regola di blocco.
Richiesta HTTP
- URL:
https://sender-solutions.com/api/suppressions/suppressions-list/ - Metodo HTTP: GET
Esempio di richiesta con il set massimo di parametri usando 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}}'
Descrizione dei campi
| Campo | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
offset | int | Numero di record trovati dall'elenco risultante che è necessario saltare. Serve per la realizzazione della lettura a porzioni (per pagine) dei dati. Per impostazione predefinita — 0. | |
limit | int | Numero massimo di record che è necessario restituire nella risposta a questa richiesta. Serve per la realizzazione della lettura a porzioni (per pagine) dei dati. Per impostazione predefinita — 100, massimo — 2000. | |
Id | int | Identificatore della regola di blocco. Se indicato, viene usato come filtro. | |
BaseId | int | Identificatore della base di iscritti. Se indicato, viene usato come filtro. Il valore 0 significa tutte le basi, ovvero la regola non è limitata ad alcuna base concreta. Indicando il valore 0, il filtraggio viene comunque eseguito. Per non filtrare il risultato in base al campo BaseId, è necessario non trasmettere affatto questo campo. | |
Email | string | Indirizzo email. Se indicato, viene usato come filtro. | |
Type | string | Tipo di regola. Se indicato, viene usato come filtro. Valori possibili: spam — lamentela di spam, unsubscribe — disiscrizione dall'invio, hard_bounce — errori di consegna permanenti, soft_bounces — errori di consegna temporanei ripetuti più volte. |
Esempio di risposta riuscita in formato JSON
{
"success": true,
"SuppressionsList": {
"TotalCount": 1,
"Offset": 0,
"Limit": 10,
"Suppressions": [
{
"Id": 2,
"BaseId": 0,
"Email": "username@example.com",
"Type": "unsubscribe",
"CreatedAt": 1770505912
}
]
}
}In questa risposta il campo SuppressionsList.TotalCount indica il numero totale di record trovati secondo la richiesta. I campi SuppressionsList.Offset e SuppressionsList.Limit duplicano i valori della richiesta tenendo conto delle restrizioni sui valori minimi e massimi. Il campo SuppressionsList.Suppressions contiene un array di regole di blocco. Il campo SuppressionsList.Suppressions.*.CreatedAt corrisponde all'ora di creazione della regola in formato UnixTimestamp.