Kontrola blacklistu

Ověří, zda jsou zadaná čísla v blacklistu. Vrací mapu číslo → true/false.

API URL

Adresa URL používaná k odeslání požadavků HTTP:

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

Poznámka

Nedostane-li se požadavek k cíli, zopakujte ho na záložním serveru backup1.bulkgate.com.

Podporované HTTP metody

POST - application/json

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

Poznámka

API má nastavenou kvótu na 20 požadavků za minutu.

Tabulka s parametry

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
application_id	Aplikační identifikátor	Ano	-
application_token	Aplikační ověřovací token	Ano	-
numbers	Čísla ke kontrole — pole, nebo řetězec oddělený čárkami	Ano	-
wallet	Peněženka, ve které se čísla zkontrolují	Ne	Výchozí peněženka
route	Routa, pro kterou se blokace vyhodnotí — `promotional`, `transactional`, nebo `all`	Ne	`promotional`

Příklad požadavku

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

Odpověď

V případě úspěchu:

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

Kde:

klíč je zadané telefonní číslo
hodnota je true, pokud je číslo v blacklistu, jinak false

Neplatná čísla nevrací chybu — jsou v odpovědi s hodnotou false.

V případě chyby:

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

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

Kde:

type a error (popis chyby) najdete v tabulce typů chyb
code je HTTP kód chyby
detail je doplňující informace o chybě

Typy chyb Blacklist API

Vedle obecných typů vrací Blacklist API vlastní:

TYP	KDY NASTANE
`invalid_wallet`	Zadaná peněženka neexistuje nebo k ní nemáte přístup.
`minute_quota_exceeded`	Vyčerpaná kvóta 20 požadavků za minutu.

Byla tato stránka užitečná?

Zeptat se AI Zkopírováno