HLR (JSON API)

Приклад запиту для перевірки дійсності вказаного номера. Також можна отримати детальну інформацію про номер, включаючи визначення оператора мобільного зв'язку та перебування номера в роумінгу. Абонент не отримує жодних повідомлень, оскільки запит направляється на обладнання оператора зв'язку.

URI: https://alphasms.ua/api/json.php

Усі запити до API надсилаються у форматі JSON за допомогою методу POST.

Параметри заголовків

У запитах обов'язково має бути заголовок Content-Type: application/json, інакше запит буде вважатися некоректним навіть при валідному JSON у ньому.

Параметри запиту

authstringобов'язковий Ваш API-ключ, який можна отримати в особистому кабінеті

datalist[object]обов'язковий Список об'єктів з параметрами запиту typestringобов'язковий Тип запиту idnumberобов'язковий Унікальний ідентифікатор повідомлення в системі клієнта phonenumberобов'язковий Номер телефону одержувача повідомлення

Приклад запиту

Sync

JSON

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "hlr",
            "id": 100500,
            "phone": 380971234567
        }
    ]
}

cURL

curl -X POST 'https://alphasms.ua/api/json.php' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "hlr",
      "id": 100500,
      "phone": 380971234567
    }
  ]
}'

PHP

<?php

$payload = json_encode([
    'auth' => 'bb56a4369eb19***cfec6d1776bd25',
    'data' => [
        [
            'type' => 'hlr',
            'id' => 100500,
            'phone' => 380971234567,
        ],
    ],
], JSON_UNESCAPED_UNICODE);

$ch = curl_init('https://alphasms.ua/api/json.php');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => $payload,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Python

import requests

payload = {
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "hlr",
            "id": 100500,
            "phone": 380971234567,
        },
    ],
}

response = requests.post(
    "https://alphasms.ua/api/json.php",
    json=payload,
    timeout=30,
)

print(response.json())

Node.js

const payload = {
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "hlr",
      "id": 100500,
      "phone": 380971234567
    }
  ]
};

const response = await fetch("https://alphasms.ua/api/json.php", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});

console.log(await response.json());

Async

JSON

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "hlr",
            "id": 100500,
            "phone": 380971234567
        }
    ]
}

cURL

curl -X POST 'https://api-async.alphasms.ua/v1/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "hlr",
      "id": 100500,
      "phone": 380971234567
    }
  ]
}'

PHP

<?php

$payload = json_encode([
    'auth' => 'bb56a4369eb19***cfec6d1776bd25',
    'data' => [
        [
            'type' => 'hlr',
            'id' => 100500,
            'phone' => 380971234567,
        ],
    ],
], JSON_UNESCAPED_UNICODE);

$ch = curl_init('https://api-async.alphasms.ua/v1/json');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => $payload,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Python

import requests

payload = {
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "hlr",
            "id": 100500,
            "phone": 380971234567,
        },
    ],
}

response = requests.post(
    "https://api-async.alphasms.ua/v1/json",
    json=payload,
    timeout=30,
)

print(response.json())

Node.js

const payload = {
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "hlr",
      "id": 100500,
      "phone": 380971234567
    }
  ]
};

const response = await fetch("https://api-async.alphasms.ua/v1/json", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});

console.log(await response.json());

Параметри відповіді

successinteger Результат виконання запиту

errorstring Текст помилки, що повертається, якщо success=false

datalist[object] Список об'єктів з результатами виконання запиту successboolean Результат виконання запиту повернутий у пакеті даних dataobject Результат виконання запиту phonenumber Номер телефону для перевірки statusstring Поточний статус повідомлення (див. Довідник статусів повідомлень) imsinumber International Mobile Subscriber Identity - номер, який однозначно ідентифікує кожного користувача стільникової мережі mccmncnumber MCC - мобільний код країни. У поєднанні з MNC є унікальним ідентифікатором оператора стільникового зв'язку portedboolean Ознака портованого номера networkobject Об'єкт, що містить дані мобільної мережі originobject Об'єкт, що містить дані про початкову мобільну мережу namestring Назва оператора мобільного зв'язку prefixnumber Код оператора мобільного зв'язку countryobject Об'єкт, що містить дані про країну оператора мобільного зв'язку namestring Назва країни prefixnumber Код країни MCC portedobject Об'єкт, що містить дані про портовану мобільну мережу namestring Назва оператора мобільного зв'язку prefixnumber Код оператора мобільного зв'язку countryobject Об'єкт, що містить дані про країну оператора мобільного зв'язку namestring Назва країни prefixnumber Код країни MCC

Приклади відповіді

Успішний

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": true,
    "data": [
        {
            "success": true,
            "data": {
                "phone": 380971234567,
                "status": "DELIVERED",
                "imsi": 255010000000000,
                "mccmnc": 25501,
                "ported": true,
                "network": {
                    "origin": {
                        "name": "Kyivstar",
                        "prefix": 97,
                        "country": {
                            "name": "Ukraine",
                            "prefix": 380,
                        }
                    },
                    "ported": {
                        "name": "Vodafone Ukraine (fka MTS)",
                        "prefix": 66,
                        "country": {
                            "name": "Ukraine",
                            "prefix": 380,
                        }
                    }
                }
            }
        }
    ]
}

Доступ заборонено

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": false,
    "error": "Access denied"
}