HLR Results
Retrieving HLR results automatically to a Specified URL
The API has the ability to post HLR results to a URL of your choice.
![sm_api_icon](https://developers.sendmode.com/wp-content/uploads/2017/09/sm_api_icon.jpg)
![Parameters](https://developers.sendmode.com/wp-content/uploads/2017/09/sm_api_parameters.jpg)
Parameters
Parameter | Description |
---|---|
mobilenumber | Mobile number which was HLR’d |
status | This is the status of the HLR. This will be returned in numeric format. |
mncid | This is the Mobile Network Code of the mobile number (e.g. 27202) |
customerid | Relevant customer ID sent in on the submission. |
![HLR Result Status](https://developers.sendmode.com/wp-content/uploads/2017/09/sm_api_parameters.jpg)
HLR Result Status
Status | Description |
---|---|
0 | Live |
1 | Temporary Error |
2 | Permanent Error |
3 | Dispatched |
![How to register your HLR results page.](https://developers.sendmode.com/wp-content/uploads/2017/09/sm_api_info.jpg)
How to register your HLR results page.
- Go to the Settings option in the menu.
- Go to the API Settings tab with the settings page.
- Enter your HLR results pages URL in the Post HLR Results to URL textbox.
- Save your settings.
![Requirements for your HLR results page.](https://developers.sendmode.com/wp-content/uploads/2017/09/sm_api_info.jpg)
Requirements for your HLR results page.
- You will require a server (PC) with a public IP or Domain.
- You will need to host a web page in a language of your choice which is accessible from the internet.
- You need to output the phrase "True" into the HTML of the web page.
![Example posted HLR Result](https://developers.sendmode.com/wp-content/uploads/2017/09/sm_api_response.jpg)
Example posted HLR Result
An example of the format the posted HLR result to your URL will take.
www.DOMAIN.com/HLR_PAGE.aspx?mobilenumber=353870000000&status=0&mncid=27201&customerid=12345