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"
}