HLRLookUPSpecification User Manual Version 1.0.2

HLR Lookup Request:

This API provides HTTP/HTTPS solution for HLR lookup.Request:

http://<ipaddress>:<port>/HLR/query?username=xxxx&password=xxxx&reference=xxxxx&msisdn=xxxxxxxxxxxx

https://<ipaddress>:<port>/HLR/query?username=xxxx&password=xxxx&reference=xxxxx&msisdn=xxxxxxxxxxxx

Sr. No Parameter Description1. username Name of the user2. password Password for the specified user3. reference Reference value

4. msisdnDestination for lookup. It should be prefixed withcountry code.

Response:

In case of successful lookup, number lookup information will be given in response body in JSON format.In case of success:

{"results":{

"to":"XXXXXXXXXXXX","msgid":"XXXXXXXXXXXXXX","ported":"XXXXX","mccmnc":"XXXXX","imsi":"XXXXXXXXXX","country":"XXXXXXXX","operator":"XXXXXXXX","errcode":"XXXXXXXX","errdesc":"XXXXX"}

}

In case of number lookup failure:{"results":{

"to":"XXXXXXXXXXXX","msgid":"XXXXXXXXXXXXXX","ported":"XXXXX","mccmnc":"XXXXX","imsi":"XXXXXXXXXX","country":"XXXXXXXX","operator":"XXXXXXXX","errcode":"XXXXXXXX","errdesc":"XXXXX"}

}In case of lookup failure ‘errdesc’ node will contain the ERROR_CODE giving reason for failure. ERROR_CODE values could be one of the following:

i. ERR 2401 : One of the parameter is missingii. ERR 2402 : Authentication failed for given user credentials iii. ERR 2403 : Provided destination is invalid iv. ERR 2409 : Some error occurred

Response nodes description:

Sr.No. Node Name Description1. to MSISDN for number lookup2. msgid Unique 36 character value for request mapping

purpose3. ported Indicate whether number is ported or not4. imsi International Mobile Subscriber Identity, used to

uniquely identify the user of a mobile network.5. mccmnc Mobile Country Code and Mobile Network Code6. country Ported country name if number is ported else

original country name7. operator Ported operator name in case of number is ported

else original operator name8. errcode 000 → DELIVRD

001 → UNDELIV Temporarily002 → UNDELIV Permanent003 → REJECTD Temporarily004 → REJECTD Permanent

9. errdesc Refer table 1.1 for error description

Table 1.1:

Error Description Error code PermanentAbsent Subscriber 001 falseCall Barred 001 falseData Missing 001 falseSMS Facility Not Supported 001 falseHLR Abort 001 falseNo Response 001 falseReject Request 001 falseNo Error 000 falseMSISDN Not Found 001 falseInvalid MSISDN 001 falseRequest Method Not Allowed 001 falseRequest Throttled 001 falseInvalid URL 001 falseSystem Failure 001 falseSMS Tele Service Not Provisioned 002 trueTime Out 001 falseUnexpected Data Value 001 falseUnknown Subscriber 002 trueService Failure 003 falseCUG Reject 001 falseSMS Facility Not Supported 001 falseSystem Failure 001 falseData Missing 001 falseUnexpected Data Value 001 falseService Unreachable 003 falseAuthentication Error 001 falseNot allowed to use this profile 001 falseNot allowed to use this service 001 falseUnknown user 001 falseInvalid parameter 001 falseUnidentified Subscriber 001 falseRoaming not allowed 001 falseIllegal Subscriber 002 trueSubscriber Busy For Mt SMS 001 falseSM Delivery Failure 001 falseMessage Waiting List Full 001 falseSystem Failure 001 falseUnexpected Data Value 001 falseUnknown Error 001 falseNo Response 001 false Service not Supported 001 falseDuplicated Invoke Id 001 falseSubsystem Congestion 001 false Subsystem Failure 001 falseNetwork Congestion 001 falseIMSI blacklisted 002 trueDND blacklisted 002 true

Message canceled 002 trueValidity Expired 002 trueTime window violation 001 falseMessage delivered to operator 001 falseMessage sent, waiting for delivery report

001 false

Message rejected by operator 001 falseMessage delivered to handset 001 falseNetwork is forbidden 001 falseMessage submitted to operator 001 falseNumber prefix missing 003 falseMessage sent not delivered 001 falseDestination on DND list 001 falseRejected by Destination 001 falseMessage expired 001 falseNetwork not reachable 001 falseDestination not registered 001 falseRoute not available 003 falseRejected flooding 001 falseSystem error 001 falseUnknown Reason 001 falseRejected duplicate message ID 001 falseRejected message too long 001 falseMessage accepted, pending for delivery

001 false

Message accepted, pending for approval

001 false

Rejected Not Sent 001 falseExpired DLR Unknown 001 falseMO message forwarded and delivered

001 false

Message not sent 003 falseERR 2401 003 falseERR 2402 003 falseERR 2403 003 falseERR 2409 003 falseERR 1025 003 falseInternal Error 001 falseTemporary Failure Or Unsupported Network Operator

003 false