CardBoardFish
You are here: CardBoardFish > HTTPHLR > HTTPHLRParameters

HTTP HLR parameters

The required and optional parameters which you need to make an HTTP HLR request are listed here. For more information please consult the HTTP HLR specification.

Please note all parameters must be URL encoded. To learn more about URL encoding please read this article.

Required parameters
These are parameters which must be included in the HTTP HLR request.

Parameter Description Example value
USERNAME Account username (case sensitive) user01
PASSWORD Account password (case sensitive) pass1
MSISDN Mobile number to be looked up, in international format without '+' prefix 44789735533
QUERYTYPE The format of information requested 1

Please note that QUERYTYPE can be:

Basic QUERYTYPE=1 Basic HLR lookup data will be returned, including the status of the number, an error code, MCC and MNC.
Extended error codes QUERYTYPE=2 The HLR lookup data returned will include extended error code information.
Advanced QUERYTYPE=4 The results of both QUERYTYPE=1 and QUERYTYPE=2, as well as country name, operator name, and whether the number has been ported (including previous operator name).

Optional parameters

These parameters are not required but can be included to specify extra options.

Parameter Description Example value
RETURNTYPE The type of destination the system should send responses to, where h = HTTP return address and e = E-mail address. e
RETURNADDRESS The destination the system will send responses to as specified by RETURNTYPE. me@myaddress.com
THREADID If set up on you account, this specifies a dedicated thread to handle the HLR request. 10

Please note, if unspecified the return type uses the default set up on the customer account. To change this default option please consult the How Can I Change The Default RETURNTYPE? article.