Blacklist prüfen

Prüft, ob sich die angegebenen Nummern auf der Blacklist befinden. Gibt eine Zuordnung Nummer → true/false zurück.

API-URL

URL, an die HTTP-Anfragen gesendet werden:

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

Hinweis

Wenn die Anfrage ihr Ziel nicht erreicht, wiederholen Sie sie auf dem Backup-Server backup1.bulkgate.com.

Unterstützte HTTP-Methoden

POST - application/json

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

Hinweis

Für die API gilt ein Kontingent von 20 Anfragen pro Minute.

Parametertabelle

PARAMETERNAME	WERT	PFLICHT	STANDARDWERT
application_id	Anwendungs-ID	Ja	-
application_token	Authentifizierungstoken der Anwendung	Ja	-
numbers	Zu prüfende Nummern — ein Array oder eine durch Kommas getrennte Zeichenkette	Ja	-
wallet	Wallet, für die die Nummern geprüft werden	Nein	Standard-Wallet
route	Die Route, für die die Sperre ausgewertet wird — `promotional`, `transactional` oder `all`	Nein	`promotional`

Beispielanfrage

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" }

Antwort

Bei Erfolg:

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

Dabei gilt:

der Schlüssel ist die von Ihnen gesendete Telefonnummer
der Wert ist true, wenn die Nummer auf der Blacklist steht, andernfalls false

Ungültige Nummern lösen keinen Fehler aus — sie erscheinen in der Antwort mit dem Wert false.

Bei einem Fehler:

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

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

Dabei gilt:

type und error (Beschreibung des Fehlers) finden Sie in der Tabelle der Fehlertypen
code ist der HTTP-Fehlercode
detail enthält zusätzliche Informationen zum Fehler

Fehlertypen der Blacklist API

Zusätzlich zu den allgemeinen Typen gibt die Blacklist API eigene Typen zurück:

TYP	WANN ER AUFTRITT
`invalid_wallet`	Die angegebene Wallet existiert nicht oder Sie haben keinen Zugriff darauf.
`minute_quota_exceeded`	Das Kontingent von 20 Anfragen pro Minute ist ausgeschöpft.

War diese Seite hilfreich?

KI fragen Kopiert