castomAPI
Odbierz klucz
POST /v1/verify/hlr bezpłatny Bez klucza Weryfikacja

Wykonanie zapytania sygnalizacyjnego SS7 w czasie rzeczywistym do HLR…

Wykonanie zapytania sygnalizacyjnego SS7 w czasie rzeczywistym do HLR (Home Location Register) w celu weryfikacji bieżącego statusu abonenta mobilnego, historii przenoszenia numeru MNP, kodów sieci MCC/MNC oraz stanu roamingu

POST

Żądanie

  • x-api-key: <your-api-key>
  • Content-Type: application/json

Odpowiedź

{
  "hlrAudit": {
    "e164Formatted": "PL61 1090 1014 0000 0712 1981 2874",
    "queryTimestamp": "2026-09-08T10:00:00Z",
    "rawInput": "PL61109010140000071219812874",
    "reason": "checksum ok"
  },
  "isReachable": true,
  "networkDetails": {
    "countryCode": "PL",
    "countryName": "Poland",
    "imsiPrefix": "<imsi prefix>",
    "isRoaming": true,
    "mcc": "<mcc>",
    "mccMncCode": "ABC-123",
    "mnc": "<mnc>",
    "roamingCountryCode": "PL"
  },
  "portingDetails": {
    "currentActiveCarrier": "Orange Polska",
    "isPorted": true,
    "originalDonorCarrier": "Orange Polska"
  },
  "status": "success",
  "subscriberStatus": "ACTIVE",
  "tokensDeducted": 2
}
Odpowiedź poniżej to makieta zbudowana ze schematu endpointu — żadne żądanie nie opuszcza tej strony. Zmień treść, naciśnij Wyślij, zobacz kształt odpowiedzi. Uruchom naprawdę w panelu →

Co robi

Wykonanie zapytania sygnalizacyjnego SS7 w czasie rzeczywistym do HLR (Home Location Register) w celu weryfikacji bieżącego statusu abonenta mobilnego, historii przenoszenia numeru MNP, kodów sieci MCC/MNC oraz stanu roamingu

Żądanie

Treść

PoleTypWymaganeOpis
phonestringtakMobile phone number (MSISDN) string in E.164 format (e.g., "+48 601 234 567" or "48601234567")

Przykładowe żądanie

{
  "phone": "+48600700800"
}

Odpowiedź

PoleTypOpis
hlrAuditobject
  ↳ e164Formattedstring
  ↳ queryTimestampstring
  ↳ rawInputstring
  ↳ reasonstring
isReachableboolean
networkDetailsobject
  ↳ countryCodestring
  ↳ countryNamestring
  ↳ imsiPrefixstring
  ↳ isRoamingboolean
  ↳ mccstring
  ↳ mccMncCodestring
  ↳ mncstring
  ↳ roamingCountryCodestring
portingDetailsobject
  ↳ currentActiveCarrierstring
  ↳ isPortedboolean
  ↳ originalDonorCarrierstring
statusstring
subscriberStatusenumOne of: ACTIVE, ABSENT_SUBSCRIBER, DISCONNECTED, UNKNOWN.
tokensDeductedinteger

Przykładowa odpowiedź

{
  "hlrAudit": {
    "e164Formatted": "PL61 1090 1014 0000 0712 1981 2874",
    "queryTimestamp": "2026-09-08T10:00:00Z",
    "rawInput": "PL61109010140000071219812874",
    "reason": "checksum ok"
  },
  "isReachable": true,
  "networkDetails": {
    "countryCode": "PL",
    "countryName": "Poland",
    "imsiPrefix": "<imsi prefix>",
    "isRoaming": true,
    "mcc": "<mcc>",
    "mccMncCode": "ABC-123",
    "mnc": "<mnc>",
    "roamingCountryCode": "PL"
  },
  "portingDetails": {
    "currentActiveCarrier": "Orange Polska",
    "isPorted": true,
    "originalDonorCarrier": "Orange Polska"
  },
  "status": "success",
  "subscriberStatus": "ACTIVE",
  "tokensDeducted": 2
}

Błędy

Każdy błąd ma tę samą kopertę: status HTTP, kod maszynowy i jedno zdanie.

400Treść albo parametr nie przeszły walidacji. Tablica details wskazuje pole.
401Brak klucza, klucz cofnięty albo zły nagłówek. Wyślij x-api-key.
402Portfel nie pokrywa tego wywołania. Doładuj albo poczekaj na miesięczny przydział.
404Zasób nie istnieje albo nie jest Twój. Obie sytuacje odpowiadają identycznie i nic nie kosztują.
429Przekroczony limit na minutę dla Twojego planu. Odczekaj i ponów.
5xxUsługa nadrzędna odmówiła albo przekroczyła czas. Wywołanie nie jest rozliczane.

Kod

curl -X POST 'https://app.castomapi.com/v1/verify/hlr' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"phone": "+48600700800"}'
const res = await fetch('https://app.castomapi.com/v1/verify/hlr', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"phone": "+48600700800"})
});
const data = await res.json();
console.log(data);
import { request } from 'node:https';

// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/verify/hlr', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"phone": "+48600700800"})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/verify/hlr',
    headers={'x-api-key': '<your-api-key>'},
    json={"phone": "+48600700800"},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/verify/hlr');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['phone' => '+48600700800']),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Koszt i limity

Ta operacja nie wymaga klucza API i nic nie kosztuje: wywołana bez klucza odpowiada 200 i pobiera zero tokenów, do 10 żądań na minutę z jednego adresu IP.

Limity żądań na minutę

Bez klucza10
Free60
Pro300
Enterprise1200

Dokumentacja → Cennik

Pytania

Ile kosztuje Wykonanie zapytania sygnalizacyjnego SS7 w czasie rzeczywistym do HLR…?

Ta operacja nie wymaga klucza API i nic nie kosztuje: wywołana bez klucza odpowiada 200 i pobiera zero tokenów, do 10 żądań na minutę z jednego adresu IP.

Jak się uwierzytelnić?

Wyślij klucz w nagłówku x-api-key. Jeden klucz obejmuje każdy rozliczany endpoint; niczego nie trzeba włączać osobno.

Czy mogę wysłać nagłówek Authorization: Bearer zamiast klucza?

Nie dla rozliczanego endpointu — te przyjmują wyłącznie nagłówek x-api-key. Tokeny Bearer należą do strony konta: panel i API konta przyjmują sesję JWT, a castomapi-auth wydaje je standardowym uzgodnieniem OAuth2, z grantami authorization code, client credentials i refresh. Opisuje to strona usługi auth.

Jakie są limity?

10 żądań na minutę z jednego IP zupełnie bez klucza, 60 na minutę w planie Free, 300 w Pro, 1200 w Enterprise. Powyżej poziomu bez klucza limit jest na konto, łącznie dla wszystkich endpointów.

OpenAPI: https://app.castomapi.com/docs/json