Надіслати запит Number Verifier
HLR (Home Location Register) — це централізована база даних, що містить детальну інформацію про кожного абонента мережі певного GSM-оператора.
Number Verifier API дає змогу надсилати мережеві запити до HLR для перевірки номера мобільного телефону. Так ви в режимі реального часу дізнаєтеся, що номер активний і зареєстрований у мобільній мережі.
Одиночний запит Number Verifier
Щоб надіслати запит Number Verifier, зверніться за цією URL-адресою:
| PUT ( POST ) https://api.bsg.world/rest/hlr/create |
Параметри запиту:
| Параметр | Обовʼязковий | Тип | Опис |
|---|---|---|---|
| msisdn | Так | string | Номер телефону, на який надсилається запит Number Verifier. |
| reference | Так | string | Зовнішній ID запиту Number Verifier. Рядок до 32 символів, що містить /a-zA-Z0-9/. |
| tariff | Ні | integer | Номер тарифу. За замовчуванням 0. Ціле число від 0 до 9. |
| callback_url | Ні | string | Перевизначає посилання, на яке буде надіслано інформацію про запит Number Verifier. |
Приклад запиту:
[{
"msisdn":"85267202829",
"reference":"sendHLR0407",
"tariff":9
"callback_url":"https://somelink.com/hlr"
}]
Параметри відповіді:
| Параметр | Тип | Опис |
|---|---|---|
| id | integer | ID запиту. |
| price | float | Вартість запиту Number Verifier |
| currency | string | Валюта рахунку, в якій зазначено вартість Number Verifier. |
Якщо запит успішний, ви отримаєте відповідь:
{
"error": "0",
"id": "12123",
"price": "0.002",
"currency": "EUR"
}
Надіслати синхронний запит Number Verifier
Метод дає змогу створити запит Number Verifier, щоб перевірити номер і одразу отримати результат перевірки. Щоб надіслати запит Number Verifier синхронно, зверніться за цією URL-адресою:
| PUT ( POST ) https://api.bsg.world/rest/hlr/check |
Параметри запиту:
| Параметр | Обовʼязковий | Тип | Опис |
|---|---|---|---|
| msisdn | Так | string | Номер телефону, на який надсилається запит Number Verifier. |
| tariff | Ні | integer | Номер тарифу. За замовчуванням 0. Ціле число від 0 до 9. |
Приклад запиту:
{
"msisdn":"85267202829",
"tariff":9
}
Параметри відповіді:
| Параметр | Тип | Опис |
|---|---|---|
| id | integer | Внутрішній ID запиту Number Verifier. |
| country_name | string | Назва країни. |
| brand | string | Оператор (напр. “Vodafone”). |
| brand_name | string | Назва оператора (напр. “PrJSC VF Ukraine”). |
| reference | string | Зовнішній ID запиту Number Verifier. |
| msisdn | string | Номер телефону, для якого виконується запит Number Verifier. |
| network | string | Номери MCC та MNC (для статусів absent і active). |
| status | string | Статус запиту. Можливі значення: sent, absent, active, unknown, failed. |
| details | string | Деталі запиту Number Verifier (повна інформація доступна, коли статус active). |
| imsi | string | Міжнародний ідентифікатор мобільного абонента (індивідуальний номер абонента), повʼязаний із кожним користувачем мобільного звʼязку GSM, UMTS або CDMA. |
| ported | boolean | Ознака, чи портовано номер (1 — портовано, 0 — ні). |
| roaming | boolean | Ознака, чи перебуває номер у роумінгу. (1 — у роумінгу, 0 — ні). |
| createdDatetime | string | Дата створення запиту Number Verifier. Формат відображення — Y-m-d H:i:s |
| statusDatetime | string | Дата й час отримання статусу перевірки номера. (1 — у роумінгу, 0 — ні). |
| price | float | Вартість запиту Number Verifier |
| currency | string | Валюта рахунку, в якій зазначено вартість запиту Number Verifier. |
Якщо запит успішний, ви отримаєте відповідь:
{
"error":0,
"errorDescription":"No errors",
"id":"271811729",
"reference":null,
"msisdn":"380505142320",
"network":null,
"status":"active",
"details":null,
"createdDatetime":null,
"statusDatetime":null
}
Надіслати масовий Number Verifier
Щоб надіслати масовий Number Verifier, зверніться за цією URL-адресою:
| PUT ( POST ) https://api.bsg.world/rest/hlr/create |
Параметри запиту:
Передається масив даних такої структури:
| Параметр | Обовʼязковий | Тип | Опис |
|---|---|---|---|
| msisdn | Так | string | Номер телефону, для якого виконується запит Number Verifier. |
| reference | Так | string | Зовнішній ID запиту Number Verifier. Рядок до 32 символів, що містить /a-zA-Z0-9/. |
| tariff | Ні | integer | Номер тарифу. За замовчуванням 0. Ціле число від 0 до 9. |
| callback_url | Ні | string | Перевизначає посилання, на яке буде надіслано інформацію про запит Number Verifier. |
Приклад запиту:
[
{
"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"}
}
]
Параметри відповіді:
| Параметр | Тип | Опис |
|---|---|---|
| reference | string | Зовнішній ID запиту Number Verifier. |
| id | integer | ID запиту. |
| price | float | Вартість запиту Number Verifier |
| currency | string | Валюта рахунку, в якій зазначено вартість запиту Number Verifier. |
Якщо запит успішний, ви отримаєте відповідь:
{
"result": [
{
"reference": "extid13423now",
"id": "12345",
"error": "0",
"price": "0.002",
"currency": "EUR"
},
{
"reference": "extid13425",
"id": "12346",
"error": "0",
"price": "0.002",
"currency": "EUR"
}
],
"error": "0",
"totalprice": "0.004",
"currency": "EUR"
}