{"id":3504,"date":"2026-01-13T09:21:23","date_gmt":"2026-01-13T06:21:23","guid":{"rendered":"https:\/\/docs.unibell.tech\/?page_id=3504"},"modified":"2026-02-17T14:03:43","modified_gmt":"2026-02-17T11:03:43","slug":"hlr-api","status":"publish","type":"page","link":"https:\/\/docs.unibell.tech\/?page_id=3504","title":{"rendered":"HLR API"},"content":{"rendered":"\n

Sending an asynchronous HLR request<\/h2>\n\n\n\n

For information about the authentication and authorization procedures that associate API calls with the required applications in your account, see Authorization<\/a>.<\/p>\n\n\n\n

Request:<\/strong><\/p>\n\n\n\n

Parameters can be passed in the request headers:<\/p>\n\n\n\n

POST\/GET https:\/\/api.unibell.ru\/v2\/hlr?X-Authorization=AccessKey d8ac9959r12b43545XXXXX&destAddr=7XXXXXXXXXX<\/code><\/pre>\n\n\n\n
Or in the request body:<\/p>\n\n\n\n
{\n    \"destAddr\": \"7XXXXXXXXXX\"\n}<\/code><\/pre>\n\n\n\n
Example requests using CURL:<\/strong><\/p>\n\n\n\n
curl --location --request POST 'https:\/\/api.unibell.ru\/v2\/hlr?X-Authorization=AccessKey%20d8ac9959r12b43545XXXXX&destAddr=7XXXXXXXXXX'<\/code><\/pre>\n\n\n\n
curl --location 'https:\/\/api.unibell.ru\/v2\/hlr' \\\n--header 'X-Authorization: AccessKey d8ac9959r12b43545XXXXX' \\\n--header 'Content-Type: application\/json' \\\n--data '{\n    \"destAddr\": \"7XXXXXXXXXX\"\n}'<\/code><\/pre>\n\n\n\n
Parameter<\/strong><\/th>Type<\/strong><\/th>Description<\/strong><\/th><\/tr><\/thead>
destAddr<\/td>string<\/td>Phone number to which the HLR request was sent, in e.164 format, for example, for the Russian Federation: 7XXXXXXXXXX<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Response upon successful request execution:<\/strong><\/p>\n\n\n\n
{\n    \"status\": \"Created\",\n    \"requestId\": \"11273\"\n}<\/code><\/pre>\n\n\n\n
Response in case destAddr<\/code> is missing:<\/strong><\/p>\n\n\n\n
{\n    \"status\": \"Rejected\",\n    \"error\": \"Missing destAddr param\"\n}<\/code><\/pre>\n\n\n\n
Parameter<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
status<\/strong><\/td>string<\/td>Request status:
Created – The message has been created in the system but not yet sent
Rejected – The message was not accepted for sending, see error for details
prohibitedForServiceError – The key does not belong to the HLR service
invalidAccessKeyError – Authorization key error<\/sub>
accountFinanciallyBlocked \u2014 The customer is blocked by the balance\/Blocking by IP address<\/sub><\/td><\/tr>
requestId<\/strong><\/td>string<\/td>Unique request identifier<\/td><\/tr>
error<\/strong><\/td>string<\/td>Error description:
Missing destAddr param – destAddr is missing in the request<\/sub><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Sending a synchronous HLR request<\/h2>\n\n\n\n
A synchronous request \u2014 the system returns a response immediately within the same request.<\/p>\n\n\n\n
Request:<\/strong><\/p>\n\n\n\n
Parameters can be passed in the request headers:<\/p>\n\n\n\n
POST\/GET https:\/\/api.unibell.ru\/v3\/hlr?X-Authorization=AccessKey d8ac9959r12b43545XXXXX&destAddr=7XXXXXXXXXX<\/code><\/pre>\n\n\n\n
Or in the request body:<\/p>\n\n\n\n
{\n    \"destAddr\": \"7XXXXXXXXXX\"\n}<\/code><\/pre>\n\n\n\n
Example requests using CURL:<\/strong><\/p>\n\n\n\n
curl --location --request POST 'https:\/\/api.unibell.ru\/v3\/hlr?X-Authorization=AccessKey%20d8ac9959r12b43545XXXXX&destAddr=7XXXXXXXXXX'<\/code><\/pre>\n\n\n\n
curl --location 'https:\/\/api.unibell.ru\/v3\/hlr' \\\n--header 'X-Authorization: AccessKey d8ac9959r12b43545XXXXX' \\\n--header 'Content-Type: application\/json' \\\n--data '{\n    \"destAddr\": \"7XXXXXXXXXX\"\n}'<\/code><\/pre>\n\n\n\n
Response upon successful request execution:<\/strong><\/p>\n\n\n\n
{\n    \"id\": 9654,\n    \"destAddr\": \"7XXXXXXXXXX\",\n    \"requestId\": \"11273\",\n    \"status\": \"Delivered\",\n    \"networkErrCode\": 0,\n    \"mcc\": 250,\n    \"mnc\": 2,\n    \"originalMcc\": 250,\n    \"originalMnc\": 20,\n    \"ported\": 1\n}<\/code><\/pre>\n\n\n\n
Parameter<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
id<\/td>integer<\/td>Unique HLR identifier<\/td><\/tr>
destAddr<\/td>string<\/td>Phone number to which the HLR request was sent, in e.164 format, for example, for the Russian Federation: 7XXXXXXXXXX<\/td><\/tr>
requestId<\/td>string<\/td>Unique request identifier<\/td><\/tr>
status<\/td>string<\/td>HLR request status:
Delivered – Phone is active
Expired – Waiting time for network response expired
Deleted – Request canceled before receiving result
Undeliverable – Phone is inactive
Accepted – Request sent, but network result not yet received
Unknown – Unknown error
Rejected – Request rejected by the network, check impossible<\/sub>
prohibitedForServiceError – The key does not belong to the HLR service
invalidAccessKeyError – Authorization key error<\/sub>
accountFinanciallyBlocked \u2014 The customer is blocked by the balance\/Blocking by IP address<\/sub><\/td><\/tr>
networkErrCode<\/td>string<\/td>SS7 errors, see below<\/a><\/td><\/tr>
mcc<\/td>integer<\/td>Mobile Country Code<\/td><\/tr>
mnc<\/td>integer<\/td>Mobile Network Code \u2013 mobile operator code<\/td><\/tr>
originalMcc<\/td>integer<\/td>MCC of the original operator
Country code of the mobile network where the subscriber was initially registered<\/sup><\/td><\/tr>
originalMnc<\/td>integer<\/td>MNC of the original operator
Mobile operator code within the country where the subscriber was initially registered<\/sup><\/td><\/tr>
ported<\/td>integer<\/td>Indicates whether the number has been ported:
1 – if the number was ported
0 – if not ported<\/sub><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Retrieving status<\/h2>\n\n\n\n
Request:<\/strong><\/p>\n\n\n\n
Parameters can be passed in the request headers:<\/p>\n\n\n\n
GET https:\/\/api.unibell.ru\/v2\/hlr_status?X-Authorization=AccessKey d8ac9959r12b43545XXXXX&requestId=11273<\/code><\/pre>\n\n\n\n
As well as in the request body:<\/p>\n\n\n\n
{\n    \"requestId\": \"11273\"\n}<\/code><\/pre>\n\n\n\n
Example requests using CURL:<\/strong><\/p>\n\n\n\n
curl --location 'https:\/\/api.unibell.ru\/v2\/hlr_status?X-Authorization=AccessKey%20d8ac9959r12b43545XXXXX&requestId=11273'<\/code><\/pre>\n\n\n\n
curl --location --request GET 'https:\/\/api.unibell.ru\/v2\/hlr_status' \\\n--header 'X-Authorization: AccessKey d8ac9959r12b43545XXXXX' \\\n--header 'Content-Type: application\/json' \\\n--data '{\n    \"requestId\": \"11273\"\n}'<\/code><\/pre>\n\n\n\n
Response body upon successful request execution:<\/strong><\/p>\n\n\n\n
{\n    \"id\": 9654,\n    \"destAddr\": \"7XXXXXXXXXX\",\n    \"requestId\": \"11273\",\n    \"status\": \"Rejected\",\n    \"networkErrCode\": 34,\n    \"mcc\": 0,\n    \"mnc\": 0,\n    \"ported\": 0\n}<\/code><\/pre>\n\n\n\n
Response in case the requestId<\/code> parameter is missing:<\/strong><\/p>\n\n\n\n
{\n    \"status\": \"Rejected\",\n    \"error\": \"Missing requestId param\"\n}<\/code><\/pre>\n\n\n\n
Parameter<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
id<\/td>integer<\/td>Unique HLR identifier<\/td><\/tr>
destAddr<\/td>string<\/td>Phone number to which the HLR request was sent, in e.164 format, for example, for the Russian Federation: 7XXXXXXXXXX<\/td><\/tr>
requestId<\/td>string<\/td>Unique request identifier<\/td><\/tr>
status<\/td>string<\/td>HLR request status:
Created – Request created in the system but not yet sent
Enroute – Request is being processed, awaiting network verification
Delivered – Phone is active
Expired – Waiting time for network response expired
Deleted – Request canceled before receiving result
Undeliverable – Phone is inactive
Accepted – Request sent, but network result not yet received
Unknown – Unknown error
Rejected – Request rejected by the network, check impossible
notFound – Record for the requested requestId does not exist\/not found<\/sub><\/td><\/tr>
networkErrCode<\/td>string<\/td>SS7 errors, see below<\/a><\/td><\/tr>
mcc<\/td>integer<\/td>Mobile Country Code \u2013 \u043a\u043e\u0434 \u0441\u0442\u0440\u0430\u043d\u044b<\/td><\/tr>
mnc<\/td>integer<\/td>Mobile Network Code \u2013 mobile operator code<\/td><\/tr>
ported<\/td>integer<\/td>Indicates whether the number has been ported:
1 – if the number was ported
0 – if not ported<\/sub><\/td><\/tr>
error<\/td>string<\/td>Error description:
Missing requestId param – requestId is missing in the request<\/sub><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Retrieving request statuses via Webhook<\/h2>\n\n\n\n
Request source:<\/strong><\/p>\n\n\n\n
Webhooks will be sent from the IP addresses 185.175.44.211 and 46.148.235.62, which must be added to the ACL on the client\u2019s web server to ensure proper interaction.<\/p>\n\n\n\n
Interaction format:<\/strong><\/p>\n\n\n\n
Callbacks are performed over the HTTP protocol.<\/p>\n\n\n\n
Data is transmitted in JSON format.<\/p>\n\n\n\n
Webhook setup is performed by submitting a request to technical support.<\/p>\n\n\n\n
Sending a request:<\/strong><\/p>\n\n\n\n
The request is sent in JSON format, which has the following structure:<\/p>\n\n\n\n
{\n  \"ported\": 0,\n  \"mnc\": 0,\n  \"requestId\": \"35714061\",\n  \"destAddr\": \"7XXXXXXXXXX\",\n  \"id\": 639073386,\n  \"networkErrCode\": 0,\n  \"mcc\": 0,\n  \"status\": \"Delivered\"\n}<\/code><\/pre>\n\n\n\n
Parameter<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
ported<\/td>integer<\/td>Indicates whether the number has been ported:
1 – if the number was ported
0 – if not ported<\/sub><\/td><\/tr>
mnc<\/td>integer<\/td>Mobile Network Code \u2013 mobile operator code<\/td><\/tr>
requestId<\/td>string<\/td>Unique request identifier<\/td><\/tr>
destAddr<\/td>string<\/td>Phone number to which the HLR was sent, in e.164 format, for example, for the Russian Federation: 7XXXXXXXXXX<\/td><\/tr>
id<\/td>integer<\/td>Unique HLR identifier<\/td><\/tr>
networkErrCode<\/td>string<\/td>SS7 errors, see below<\/a><\/td><\/tr>
mcc<\/td>integer<\/td>Mobile Country Code<\/td><\/tr>
status<\/td>string<\/td>HLR request status:
Created – Request created in the system but not yet sent
Enroute – Request is being processed, awaiting network verification
Delivered – Phone is active
Expired – Waiting time for network response expired
Deleted – Request canceled before receiving result
Undeliverable – Phone is inactive
Accepted – Request sent, but network result not yet received
Unknown – Unknown error
Rejected – Request rejected by the network, check impossible<\/sub><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/p>\n\n\n\n
Error codes in status<\/h2>\n\n\n\n
Possible error codes in the HLR status (networkErrCode<\/code>).<\/p>\n\n\n\n
All unspecified codes are considered vendor-dependent and are not handled separately.<\/p>\n\n\n\n
Code<\/th>Description Key<\/th>Description<\/th><\/tr><\/thead>
1<\/td>unknownSubscriber<\/td>Unknown subscriber
The subscriber is not registered in the network<\/sub><\/td><\/tr>
5<\/td>unidentifiedSubscriber<\/td>Unidentified subscriber
Subscriber is registered, but information about them is missing or unavailable<\/sub><\/td><\/tr>
9<\/td>illegalSubscriber<\/td>Illegal subscriber
Access denied due to rule violation<\/sub><\/td><\/tr>
11<\/td>teleserviceNotProvisioned<\/td>Telecommunication service not provisioned
Subscriber is not subscribed to the requested service<\/sub><\/td><\/tr>
13<\/td>callBarred<\/td>Call barred
Calls are prohibited for this subscriber (e.g., due to blocking or tariff restrictions)<\/sub><\/td><\/tr>
21<\/td>facilityNotSupported<\/td>Facility not supported
Requested service is unavailable for the subscriber or network<\/sub><\/td><\/tr>
27<\/td>adsentSubscriber<\/td>Address absent
Message not delivered due to missing sender information<\/sub><\/td><\/tr>
31<\/td>subscriberBusyForMT-SMS<\/td>Subscriber busy for MT-HLR
Subscriber cannot receive HLR due to device being busy<\/sub><\/td><\/tr>
32<\/td>sm-DeliverFailure<\/td>HLR delivery failure
General error related to HLR transmission<\/sub><\/td><\/tr>
33<\/td>messageWaitingListFull<\/td>Message waiting list full
Subscriber device memory has no space for new messages<\/sub><\/td><\/tr>
34<\/td>systemFailure<\/td>System failure
General network-side error<\/sub><\/td><\/tr>
35<\/td>dataMissing<\/td>Data missing
Insufficient information to complete the operation<\/sub><\/td><\/tr>
36<\/td>unexpectedDataValue<\/td>Unexpected data value
Incorrect or unexpected data provided<\/sub><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
Sending an asynchronous HLR request For information about the authentication and authorization procedures that associate API calls with the required applications in your account, see Authorization. Request: Parameters can be passed in the request headers: Or in the request body: Example requests using CURL: Parameter Type Description destAddr string Phone number to which the HLR …  HLR API<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"tpl\/http-content.php","meta":{"footnotes":""},"class_list":["post-3504","page","type-page","status-publish","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=\/wp\/v2\/pages\/3504","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=3504"}],"version-history":[{"count":5,"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=\/wp\/v2\/pages\/3504\/revisions"}],"predecessor-version":[{"id":3599,"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=\/wp\/v2\/pages\/3504\/revisions\/3599"}],"wp:attachment":[{"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=3504"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}