Vérifier la blacklist

Vérifie si les numéros indiqués figurent sur la blacklist. Renvoie un tableau associatif numéro → true/false.

URL de l'API

URL à laquelle envoyer les requêtes HTTP :

https://portal.bulkgate.com/api/1.0/black-list/is-black-listed

Note

Si la requête n'atteint pas sa destination, renvoyez-la sur le serveur de secours backup1.bulkgate.com.

Méthodes HTTP prises en charge

POST - application/json

POST /api/1.0/black-list/is-black-listed HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Note

L'API est soumise à un quota de 20 requêtes par minute.

Tableau des paramètres

NOM DU PARAMÈTRE	VALEUR	OBLIGATOIRE	VALEUR PAR DÉFAUT
application_id	Application ID	Oui	-
application_token	Token d'authentification de l'application	Oui	-
numbers	Numéros à vérifier — un tableau, ou une chaîne séparée par des virgules	Oui	-
wallet	Portefeuille sur lequel vérifier les numéros	Non	Portefeuille par défaut
route	La route pour laquelle le blocage est évalué — `promotional`, `transactional` ou `all`	Non	`promotional`

Exemple de requête

POST /api/1.0/black-list/is-black-listed HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "numbers": ["420123456789", "420987654321"], "wallet": "bg1905014138000023" }

Réponse

En cas de succès :

{ "data": { "420123456789": true, "420987654321": false } }

Où :

la clé est le numéro de téléphone que vous avez envoyé
la valeur est true si le numéro figure sur la blacklist, sinon false

Les numéros invalides ne renvoient pas d'erreur — ils figurent dans la réponse avec la valeur false.

En cas d'erreur :

{ "type": "invalid_wallet", "code": 400, "error": "Invalid wallet", "detail": null }

{ "type": "minute_quota_exceeded", "code": 400, "error": "Minute quota exceeded", "detail": null }

Où :

type et error (description de l'erreur) figurent dans le tableau des types d'erreurs
code est le code d'erreur HTTP
detail contient des informations complémentaires sur l'erreur

Types d'erreurs de l'API Blacklist

En plus des types généraux, l'API Blacklist renvoie ses propres types :

TYPE	QUAND CELA SE PRODUIT
`invalid_wallet`	Le portefeuille indiqué n'existe pas ou vous n'y avez pas accès.
`minute_quota_exceeded`	Le quota de 20 requêtes par minute est épuisé.

Cette page vous a-t-elle été utile ?

Demander à l'IA Copié