Black List download
API URL
URL used to send HTTP requests:
https://portal.bulkgate.com/api/1.0/black-list/load
POST /api/1.0/black-list/load HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache
Api is limited by daily quota 20 requests.
Parameters table
PARAMETER NAME | VALUE | MANDATORY | DEFAULT VALUE |
---|---|---|---|
application_id | Application ID | Yes | - |
application_token | Application token | Yes | - |
campaign_id | Selects only records for a specific campaign. | Yes | - |
wallet | Selects only records for a specific wallet. | No | - |
from | Selects entries from a specific date. It accepts the following formats: unix timestamp, or ISO 8601. | Yes | - |
to | Selects entries to a specific date. It accepts the following formats unix timestamp, or ISO 8601. | No | Now |
Example of full request:
POST /api/1.0/black-list/load HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache
{
"application_id": "APPLICATION_ID",
"application_token": "APPLICATION_TOKEN",
"campaign_id": "id-bulkgate-000001",
"wallet": "wallet_id",
"from": "2018-05-14T18:30:00-01:00",
"to": "2018-05-15T18:30:00-01:00"
}
Response to this command may be:
In case of success:
{
"data": [
{
"id": 198668,
"wallet": "wallet_id",
"number": "420777777777",
"date": "2018-11-21T15:30:31+01:00",
"unix_date": 1542810631,
"campaign_id": "id-bulkgate-000001",
"source": "web",
"source_id": "",
"reason": "I don't want to receive business messages."
},
{
"id": 198667,
"wallet": "wallet_id",
"number": "420777777778",
"date": "2018-11-21T15:30:35+01:00",
"unix_date": 1542810635,
"campaign_id": "",
"source": "import",
"source_id": "import.csv",
"reason": ""
}
]
}
In case of error:
{
"error": "The daily quota (20 requests) has been exceeded.",
"code": 400
}
{
"type": "invalid_wallet",
"code": 400,
"error": "Invalid wallet",
"detail": null
}
{
"type": "invalid_input_parameters",
"code": 400,
"error": "Invalid input parameters",
"detail": null
}
{
"type": "maximal_date_range_is_30_days",
"code": 400,
"error": "Maximal date range is 30 days",
"detail": null
}