La méthode est destinée à l'obtention de la liste des blocages (Suppressions). On peut l'utiliser pour rechercher selon un ensemble défini de filtres. Tous les paramètres sont optionnels. Les données sont transmises dans les paramètres query du lien.
Un blocage (Suppression, règle de blocage) — c'est une fonctionnalité du site qui empêche l'envoi d'e-mails à une adresse donnée. Par exemple, l'utilisateur s'est désabonné / s'est plaint de spam ou son adresse email ne fonctionne pas du tout. Le système détecte la situation où l'envoi d'e-mails vers cet email n'est plus possible, et crée une règle de blocage.
Requête HTTP
- URL :
https://sender-solutions.com/api/suppressions/suppressions-list/ - Méthode HTTP : GET
Exemple de requête avec l'ensemble maximal de paramètres à l'aide de 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}}'
Description des champs
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
offset | int | Nombre d'enregistrements trouvés dans la liste résultante qu'il faut ignorer. Nécessaire pour la mise en œuvre de la lecture par portions (par pages) des données. Par défaut — 0. | |
limit | int | Nombre maximal d'enregistrements qu'il faut renvoyer dans la réponse à cette requête. Nécessaire pour la mise en œuvre de la lecture par portions (par pages) des données. Par défaut — 100, maximum — 2000. | |
Id | int | Identifiant de la règle de blocage. S'il est indiqué, il est utilisé comme filtre. | |
BaseId | int | Identifiant de la base d'abonnés. S'il est indiqué, il est utilisé comme filtre. La valeur 0 signifie toutes les bases, c'est-à-dire que la règle n'est limitée à aucune base concrète. En indiquant la valeur 0, le filtrage est tout de même effectué. Pour ne pas filtrer le résultat selon le champ BaseId, il faut ne pas transmettre du tout ce champ. | |
Email | string | Adresse email. Si elle est indiquée, elle est utilisée comme filtre. | |
Type | string | Type de règle. S'il est indiqué, il est utilisé comme filtre. Valeurs possibles : spam — plainte pour spam, unsubscribe — désabonnement de l'envoi, hard_bounce — erreurs de livraison permanentes, soft_bounces — erreurs de livraison temporaires qui se sont répétées à plusieurs reprises. |
Exemple de réponse réussie au format JSON
{
"success": true,
"SuppressionsList": {
"TotalCount": 1,
"Offset": 0,
"Limit": 10,
"Suppressions": [
{
"Id": 2,
"BaseId": 0,
"Email": "username@example.com",
"Type": "unsubscribe",
"CreatedAt": 1770505912
}
]
}
}Dans cette réponse, le champ SuppressionsList.TotalCount indique le nombre total d'enregistrements trouvés selon la requête. Les champs SuppressionsList.Offset et SuppressionsList.Limit reprennent les valeurs de la requête en tenant compte des restrictions sur les valeurs minimales et maximales. Le champ SuppressionsList.Suppressions contient un tableau de règles de blocage. Le champ SuppressionsList.Suppressions.*.CreatedAt correspond à l'heure de création de la règle au format UnixTimestamp.