Specifikace

API URL

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

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

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	Seznam struktur čísel ke kontrole, viz Numbers	Ne	-

Numbers

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
phone_number	telefonní číslo	Ano	-
country	Country kód telefonního čísla	Ne	-

Příklad úplného požadavku:

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

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

V případě úspěchu

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