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. Up to 100 numbers can be provided, each separated by a comma. 44789735533 or 44701020202,447010102303

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. h
RETURNADDRESS The destination address that the system will send responses to as specified by RETURNTYPE. me@myaddress.com or http://www.clienturl.com/hlrcallback.php

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.