Sign in

v1

latestSwagger 2.02026-07-132830204.5 KB
Telephony

HLR Lookup

Connect to the global mobile cellular network and retrieve the status of a mobile device

get/hlr-lookup

Query parameters

numberstring required

A phone number

country-codestring

ISO 2-letter country code, assume numbers are based in this country. <br> If not set numbers are assumed to be in international format (with or without the leading + sign)

Response

OK

number-validboolean required

True if this a valid phone number

international-calling-codestring required

The international calling code

mncstring required

The mobile MNC number (Mobile Network Code)

number-typestring required

The number type, possible values are: <br> <ul> <li>mobile</li> <li>fixed-line</li> <li>premium-rate</li> <li>toll-free</li> <li>voip</li> <li>unknown</li> </ul>

hlr-validboolean required

Was the HLR lookup successful. If true then this is a working and registered cell-phone or mobile device (SMS and phone calls will be delivered)

hlr-statusstring required

The HLR lookup status, possible values are: <br> <ul> <li>ok - the HLR lookup was successful and the device is connected</li> <li>absent - the number was once registered but the device has been switched off or out of network range for some time</li> <li>unknown - the number is not known by the mobile network</li> <li>invalid - the number is not a valid mobile MSISDN number</li> <li>fixed-line - the number is a registered fixed-line not mobile</li> <li>voip - the number has been detected as a VOIP line</li> <li>failed - the HLR lookup has failed, we could not determine the real status of this number</li> </ul>

ported-networkstring required

The ported to network/carrier name (only set if the number has been ported)

imsistring required

The mobile IMSI number (International Mobile Subscriber Identity)

mccstring required

The mobile MCC number (Mobile Country Code)

international-numberstring required

The number represented in full international format

local-numberstring required

The number represented in local dialing format

country-codestring required

The number location as an ISO 2-letter country code

is-portedboolean required

Has this number been ported to another network

msinstring required

The mobile MSIN number (Mobile Subscription Identification Number)

locationstring required

The number location. Could be a city, region or country depending on the type of number

origin-networkstring required

The origin network/carrier name

is-mobileboolean required

True if this is a mobile number (only true with 100% certainty, if the number type is unknown this value will be false)

is-roamingboolean required

Is this number currently roaming from its origin country

countrystring required

The phone number country

country-code3string required

The number location as an ISO 3-letter country code

currency-codestring required

ISO 4217 currency code associated with the country

roaming-country-codestring required

If the number is currently roaming, the ISO 2-letter country code of the roaming in country

mscstring required

The mobile MSC number (Mobile Switching Center)

current-networkstring required

The currently used network/carrier name

network-tagsstring required

Contains any additional details about the current network such as former network names and mobile technology utilized

Example response

{
  "country": "United States",
  "country-code": "US",
  "country-code3": "USA",
  "currency-code": "USD",
  "current-network": "Sinch Voice",
  "hlr-status": "voip",
  "hlr-valid": false,
  "imsi": "",
  "international-calling-code": "1",
  "international-number": "+12106100045",
  "is-mobile": false,
  "is-ported": true,
  "is-roaming": false,
  "local-number": "(210) 610-0045",
  "location": "San Antonio, TX",
  "mcc": "",
  "mnc": "",
  "msc": "LANDLINE",
  "msin": "",
  "network-tags": "NSR-10X-Port/1",
  "number-type": "voip",
  "number-valid": true,
  "origin-network": "BANDWIDTH.COM",
  "ported-network": "Sinch Voice",
  "roaming-country-code": ""
}