HTTP HLR Server Response

When you make an HTTP HLR Lookup request, the server will send a response back to you showing whether your request was successful or not for each number submitted.

A successful response will look like:

OK [uniqueID1] [UniqueIDn]

If all the parameters are correct and there is enough credit to perform the HLR request, the response “OK” followed by a space and a unique ID will be returned. If multiple mobile numbers were submitted, multiple unique IDs will be returned, each separated by a space. The order of the unique IDs corresponds to the order in which the mobile numbers were submitted. For example: OK 70801920 70801921.

Successful response with unprocessable mobile numbers:

It is possible that the syntax check, authentication check and credit check succeed but it is not possible to process one or more of the submitted mobile numbers. If this occurs, a negative error code will be returned in place of the corresponding unique ID.

Possible error codes are:

Example: OK 808010234 -15 808010235

An unsuccessful response will look like:

ERR [ErrorType] [ErrorDescription]

Where [ErrorType] is either FAIL, in which case there was an error with the request which needs attention before being retried, or RETRY in which case there was a temporary error and you should retry your request in one or two minutes.

If you receive a FAIL error type, you can use [ErrorDescription] to help identify and correct the problem. For a list of all [ErrorDescription] values and possible solutions, please see the I'm Receiving An Error, What Does This Mean? article.

An example unsuccessful response might look like: ERR FAIL Invalid USERNAME or PASSWORD.