Kontrola černé listiny · BulkGate Helpdesk

API URL

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

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

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

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	Pole čísel pro kontrolu zdali jsou v blacklistu	Ano	-
wallet	Peněženka v které zkontrolovat čísla	Ne	Výchozí peněženka
route	Je zakázané číslo součástí `transactional` nebo `promotional` routy	Ne	`promotional`

Příklad úplného požadavku

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

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",     
  "numbers": ["420123456789", "420987654321"],
  "wallet": "WALLET",
  "route": "promotional"
}

Odpověď na tento příkaz může být:

V případě úspěchu:

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

V případě chyby:

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