HTTPS API v2 / HLR - checking the availability of the number

Principle of operation

For using the remote operating number to check availability call the specified URL using the POST method.

phones/check

Available parameters

Parameter	Type	An example value or format	Description
username	String	login	Username used to dispatch the message
password	String	hasło	Password to the account
phone	String	500600700 or +42565478965	The number in the format 9-digit. For international numbers it is necessary to enter the plus prefix and country.
id	String	application number	The parameter used to read the result, if the response time exceeds 60 seconds.

The parameters in bold are obligatory. Others are optional.

Return generated after sending the sample query.

{
   "phone":"+48500600700",
   "status":"OK",
   "imsi":26006,
   "network":"Orange (PTK Centertel Sp. z o.o.)",
   "ported":false,
   "network_ported":null
}

Return generated after sending the sample query.{
   "status":"done",
   "process": 100,
   "items":[
   {
       "phone":"+48500600700",
       "status":"ERR",
       "imsi":26003,
       "network":"Orange (PTK Centertel Sp. z o.o.)",
       "ported":false,
       "network_ported":null,
       "description":"ABSENT_SUBSCRIBER_SM"
   },
   {
       "phone":"+48600700800",
       "status":"OK",
       "imsi":260011234567890,
       "network":"Plus (Polkomtel S.A.)",
       "ported":true,
       "network_ported":"Plus (Polkomtel S.A.)",
       "description":null
   }]
}

Explanation of individual parameters feedback

Parameter	Description
phone	Checked the phone number
status	Status queries HLR, if it is correct, the system will return "OK" if it is not possible to check the number or the number is not correct, the system will return "ERR". WARNING! The thariff are all queries HLR, both correct and incorrect.
imsi	A unique number assigned to each SIM card in a GSM or UMTS network. In some situations it may contain only the country code and network number (eg. "26003").
network	Alphanumeric name of the network where the number came from.
ported	Information on whether the number is transferred to "true" or not "false."
network_ported	Alphanumeric name the network to which the number is currently assigned.

 

If the response time exceeds 60 seconds, will be returned identifier that should be substituted into the query at a later time in order to read the status of the update. Feedback answer will have the form:

{
   "phone":"+48500600700",
   "id":"6970aa5525"
}

Recommended settings

Do not check multiple times in a row of the same number because every call to check affiliation to the network is charged. It is worth to save the results locally and use them for a specified period, eg a few days.

It is necessary to set a larger timeout for queries, as waiting for a system response may take from a few to even tens of seconds.