HLR functionality - Alaris Labs

The HLR functionality allows receiving current MCCMNCs for numbers through sending requests towards HLR providers. By your request, the Alaris technical support team installs the HLR proxy module for this purpose.

The list of supported HLR providers is available in our manual by the following link: Appendix 2. Supported HLR providers. Note that the Alaris Labs team is not related to any of the providers' contacts.

In case you need to integrate with a new provider, supply the following parameters to the Alaris technical support team:

1) API documentation;
2) An example of request to provider (curl);
3) An example of provider's response, in case of API - the fields from which MCCMNC can be taken;
4) Response code.
5) List of e.164 prefixes (for specific client products is necessary) for which dipping is needed.

To configure one of the already supported services from the list above, Alaris technical support team should be provided with the following information:

1) Credentials (if necessary);
2) TTL (time to live - defines for how many seconds requests will be stored in cache);
3) Timeout (in seconds; defines the period to wait a response from a provider);
4) List of e.164 prefixes (for specific client products is necessary) for which dipping is needed.

In some cases HLR providers need to whitelist your server IPs. Contact the Alaris technical support team to verify the list of IP addresses to be whitelisted.

Billing:

As soon as the HLR service is configured and enabled for the mentioned prefixes, the Alaris technical support team provides you with the parameters to create an HLR product so you can take an HLR rate into consideration while routing a message and calculating the margin.

For example:

Direction: Vendor
Product name: set to the provider’s service name (case-sensitive)
Product notes: set to the HLR provider name (case-sensitive)
Product and account can be any you need - a separate carrier can be created. No channel or SMS POI should be attached to it.

Then, it is required to add rates into the created product: either via Start\SMS\Rates\Rate editor (manual addition), or via Start\SMS\Rates\Rate import (from a file). As for invoices for HLR vendors, they are generated in accordance with the respective agreement.

To subtract HLR rates while calculating margin (MRG metric for routing), turn on the System setting Deduct HLR rate from margin (0 - no, 1 - yes) in Start\Administration\System settings\SMS routing.

Activating HLR for clients:

Enable the Dip HLR checkbox in client products (Start\Carriers\Products) and verify results with the help of Start\SMS\Routing\Simulation - it is recommended to use the Advanced mode and tick the Ignore HLR cache checkbox.

HLR: result not ported, MCCMNC <404020>, ported , cached <0>, source_name , source_type , HLR product id <>, response code <0>

Routing:

If you wish to build routing on the returned hlrResponseCode, it is possible to specify the Condition field of a routing rule as follows:
hlrResponseCode == 0
or
hlrResponseCode != 0
etc

The hlrResponseCode is obtained from different fields for different providers. For the supported HLR providers, the parameter is specified in hlrResponseCode column:

You can learn more about message metrics in our manual: Message metrics

Starting from 3.6 version, it's now possible to manage HLR rules by the System owners themselves via new functionality - the HLR configurator (MNP Server). Its interface allows configuring HLR services, users of System owner partners, and HLR traffic rules. The functionality is provided free of charge and can be installed by your request.

More detailed information about HLR functionality is presented in Appendix 7. Frequently asked questions > HLR module

If you haven't found an answer to your question in the article above, you can always contact the Alaris technical support team by creating a ticket on HelpDesk. Try to describe the current situation and desired behavior in as much detail as possible, if applicable - specify the corresponding HLR product ID and Simulation TASK ID if needed.

AKBSMS - Alaris Knowledge Base