CardBoardFish
You are here: CardBoardFish > HTTPHLR > HowDoIProcessTheResultsFromHTTPCallback

How do I process results from HTTP callback?

Once you have submitted your HTTP HLR request (click here for details) with the RETURNTYPE set to an HTTP address (or if this is set up as default), you will receive an HTTP GET request back from the HLR server with the following parameters:

Parameter Name Description
QueryID Query ID The unique ID of the HLR query, received when the request was submitted
MSISDN MSISDN The MSISDN queried
Status Status The status of the query, either Success (subscriber available), Unavailable (subscriber has a temporary error) or Invalid (subscriber has a permanent error)
NetworkCode Network Code The network code the MSISDN belongs to. A 5 or 6 digit combined MCC and MNC.
ErrorCode Errror Code A hexadecimal code referring to the GSM error code.
ErrorDescription Error Description A string describing each error code.

Dependent on the configuration of your HLR service, then the following eight extra parameters will also be returned:

Parameter Name Description
CountryName Country Name The name of the country the MSISDN originates from.
CountryCode Country Code The ISO code of the originating country.
Organisation Organisation The organisation which the MSISDN originates from.
NetworkName Network Name The network which the MSISDN originates from.
NetworkType Network Type The type of mobile network the MSISDN originates from.
Ported Ported Whether the MSISDN is ported.
PortedFrom Ported From If the number is ported, the organisation the MSISDN has been ported to.
PortedFrom2 Ported From (2) If the number is ported, the network the MSISDN has been ported to.

Some destinations return the address of the MSC that is currently serving the subscriber. This can be used to determine the country that the handset is currently roaming in and possibly an approximate location if you were aware of where each MSC is located. This optional parameter is described below:

Parameter Name Description
Location MSC Address Some destinations return the address of the MSC currently serving the handset. If this is present, the 3 letter ISO code of the country that the handset is currently located in shall also be provided, separated with a space.

You should respond to the HTTP GET request with a HTTP server status of 200 and the string "OK" without surrounding speech marks:

Example HTTP GET response
OK

If the HTTP GET request fails for any reason it will be retried once immediately. If this fails then it will retry every 10 minutes over a period of 6 hours.