Black List check

API URL

URL used to send HTTP requests:

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 is limited by minute quota 20 requests.

Parameters table

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
application_id	Application ID	Yes	-
application_token	Application token	Yes	-
numbers	Array of numbers to check their inclusion in blacklist	Yes	-
wallet	Wallet on which to check numbers	No	Default wallet
route	Is blacklisted number related to transactional or promotional route	No	promotional

Example of full request:

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

Response to this command may be:

In case of success:

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

In case of error:

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