Specification
API URL
URL used to send HTTP requests:
https://portal.bulkgate.com/api/1.0/integration/check-phone-numbers
POST /api/1.0/integration/check-phone-numbers HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache
Table with parameters
PARAMETER NAME | VALUE | MANDATORY | DEFAULT VALUE |
---|---|---|---|
application_id | Application ID | Yes | - |
application_token | Application authentication token | Yes | - |
numbers | List of phone number structures to be checked, see Numbers | No | - |
Numbers
PARAMETER NAME | VALUE | MANDATORY | DEFAULT VALUE |
---|---|---|---|
phone_number | Phone number | Yes | - |
country | Phone number's country code | No | - |
Example of a complete request:
POST /api/1.0/integration/check-phone-numbers HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache
{
"application_id": "####",
"application_token": "######################################",
"numbers": [
{
"phone_number": "420777777777",
"country": "cz"
},
{
"phone_number": "7777",
"country": "cz"
}
]
}
The response to this command can be:
In case of success
{
"data": {
"420777777777": {
"phone_number": "420777777777",
"valid": true,
"country": "cz",
"call_prefix": 420,
"network_code": "23003",
"network_name": "Vodafone"
},
"7777": {
"phone_number": "7777",
"valid": false,
"country": null,
"call_prefix": null,
"network_code": null,
"network_name": "unknown"
}
}
}