HLR

Example of a request to check the validity of a specified number. You can also get detailed information about the number, including identifying the mobile operator and whether the number is in roaming. The subscriber does not receive any notifications, as the request is directed to the telecom operator's equipment.

URI: /api/json.php

All requests to API are sent in JSON format using the POST method.

Header parameters

Requests must contain header Content-Type: application/json, otherwise, the request will be considered invalid even if it has valid JSON.

Request parameters

authstringrequired Your API key, which can be obtained in your personal cabinet

datalist[object]required List of objects with request parameters typestringrequired Request type idnumberrequired Unique message identifier in the client system phonenumberrequired Phone number of the recipient of the message

Request example

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "hlr",
            "id": 100500,
            "phone": 380971234567
        }
    ]
}

Response parameters

successinteger Result of request execution

errorstring Error text, returned if success=false

datalist[object] List of objects with the results of request execution successboolean Request execution result returned in the data packet dataobject Request execution result phonenumber Phone number to be checked statusstring Current message status (see Message statuses reference) imsinumber International Mobile Subscriber Identity - number that uniquely identifies every user of a cellular network mccmncnumber MCC is a mobile country code. In combination with MNC is a unique identifier of cellular operator of networks portedboolean Flag of the ported number networkobject Object containing mobile network data originobject Object containing data about the origin mobile network namestring Name of mobile network operator prefixnumber Mobile network operator code countryobject Object containing data about the country of the mobile network operator namestring Country name prefixnumber MCC country code portedobject Object containing data about the ported mobile network namestring Name of mobile network operator prefixnumber Mobile network operator code countryobject Object containing data about the country of the mobile network operator namestring Country name prefixnumber MCC country code

Response examples

Successful

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": true,
    "data": [
        {
            "success": true,
            "data": {
                "phone": 380971234567,
                "status": "DELIVERED",
                "imsi": 255010000000000,
                "mccmnc": 25501,
                "ported": true,
                "network": {
                    "origin": {
                        "name": "Kyivstar",
                        "prefix": 97,
                        "country": {
                            "name": "Ukraine",
                            "prefix": 380,
                        }
                    },
                    "ported": {
                        "name": "Vodafone Ukraine (fka MTS)",
                        "prefix": 66,
                        "country": {
                            "name": "Ukraine",
                            "prefix": 380,
                        }
                    }
                }
            }
        }
    ]
}

Access denied

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": false,
    "error": "Access denied"
}