Отправка запроса на верификацию номера телефона
HLR (Home Location Register) - это централизованная база данных, которая содержит подробную информацию о каждом абоненте сети определенного оператора сотовой связи. API для верификации номеров позволяет отправлять сетевые запросы к HLR для проверки мобильного номера телефона. Это позволяет получить информацию о том, что мобильный номер телефона активен и зарегистрирован в сети мобильной связи в режиме реального времени.
Single Number Verifier request
Для отправки запроса на верификацию номера телефона используйте этот URL:
PUT (POST) https://api.notificore.ru/rest/hlr/create
Request parameters
Parameter | Required | Type | Description |
---|---|---|---|
msisdn | Yes | string | The phone number to which the Number Verifier request is sent. |
reference | Yes | string | Number Verifier request's external ID. A string of up to 32 characters containing /a-zA-Z0-9/. |
tariff | No | integer | Tariff number. The default is 0. An integer from 0 to 9. |
callback_url | No | string | Redefines the link where information on the Number Verifier request will be sent. |
Request example
[ { "msisdn": "85267202829", "reference": "sendHLR0407", "tariff": 9, "callback_url": "https://somelink.com/hlr" } ]
Response parameters
Parameter | Type | Description |
---|---|---|
id | integer | Request ID. |
price | float | Стоимость запроса на верификацию номера телефона |
currency | string | Валюта учетной записи, в которой указана стоимость запроса на верификацию номера телефона. |
Если запрос успешен, вы получите ответ:
{ "error": "0", "id": "12123", "price": "0.002", "currency": "RUB" }
Send a synchronous Number Verifier request
Этот метод позволяет создать запрос на верификацию номера телефона и мгновенно получить результат верификации.
Чтобы отправить запрос на верификацию номера телефона синхронно, выполните запрос по следующему URL:
Parameter | Required | Type | Description |
---|---|---|---|
msisdn | Yes | string | The phone number to which the Number Verifier request is sent. |
tariff | No | integer | Tariff number. The default is 0. An integer from 0 to 9. |
Request example
{ "msisdn": "85267202829", "tariff": 9 }
Response parameters
Parameter | Type | Description |
---|---|---|
id | integer | Internal Number Verifier request ID. |
country_name | string | Country name. |
brand | string | Operator (e.g. “MTS”). |
brand_name | string | Operator name (e.g. “Mobile telesystem”). |
reference | string | External Number Verifier request ID. |
msisdn | string | Phone number for which the Number Verifier request is performed. |
network | string | MCC and MNC numbers (for absent and active statuses). |
status | string | Request status. Possible values: sent, absent, active, unknown, failed. |
details | string | Number Verifier request details (full information is available when the status is active). |
imsi | string | International Mobile Subscriber Identifier (Individual Subscriber Number) associated with each GSM, UMTS or CDMA mobile communication user. |
ported | boolean | Indicator whether the phone is ported or not (1 – ported, 0 – not). |
roaming | boolean | Indicator whether the phone is roaming or not. (1 – roaming, 0 – not). |
createdDatetime | string | Date when the Number Verifier request was created. Display format – Y-m-d H:i:s. |
statusDatetime | string | Date and time when the Number verification status was received. (1 – roaming, 0 – not). |
price | float | Number Verifier request cost |
currency | string | The currency of the account, in which the Number Verifier request cost is specified. |
Если запрос успешен, вы получите ответ:
{ "error": 0, "errorDescription": "No errors", "id": "271811729", "reference": null, "msisdn": "792505142320", "network": null, "status": "active", "details": null, "createdDatetime": null, "statusDatetime": null }
Send bulk Number Verifier
Для отправки массового запроса на проверку номера выполните запрос по этому URL:
Request parameters
Parameter | Required | Type | Description |
---|---|---|---|
msisdn | Yes | string | Phone number for which the Number Verifier request is performed. |
reference | Yes | string | Number Verifier external request ID. A string of up to 32 characters containing /a-zA-Z0-9/. |
tariff | No | integer | Tariff number. The default is 0. An integer from 0 to 9. |
callback_url | No | string | Redefines the link where information on the Number Verifier request will be sent. |
Request example
[ { "msisdn": "85267202829", "reference": "extid13423now", "tariff": 9, "callback_url": "http://someurl.com/callback/?id=12345" }, { "msisdn": "85267202829", "reference": "extid13425", "tariff": 9, "callback_url": "http://someurl.com/callback/?id=12346" } ]
Response parameters
Parameter | Type | Description |
---|---|---|
reference | string | Number Verifier requests external ID. |
id | integer | Request ID. |
price | float | Number Verifier request cost |
currency | string | The currency of the account, in which the Number Verifier request cost is specified. |
Если запрос успешен, вы получите ответ:
{ "result": [ { "reference": "extid13423now", "id": "12345", "error": "0", "price": "0.002", "currency": "RUB" }, { "reference": "extid13425", "id": "12346", "error": "0", "price": "0.002", "currency": "RUB" } ], "error": "0", "totalprice": "0.004", "currency": "RUB" }