HTTPS XML API / HLR - sprawdzanie dostępności numeru

 

Informujemy, że obecnie nie działa opcja sprawdzania statusu aktywności numeru dla poniższych sieci:

26002 - T-mobile (PL)

Wynik zwracany w usłudze HLR będzie zawierał jedynie informacje na temat przynależności numeru do sieci oraz czy numer był przenoszony.

 

Zasada działania

Aby przy pomocy Zdalnej obsługi sprawdzić dostępność numeru należy wywołać określony adres URL metodą POST lub GET. Przykładowo adres w przeglądarce wyglądać może następująco:

https://api1.serwersms.pl/zdalnie/index.php?login=demo&haslo=demo&akcja=hlr&numer=%2B48500600700

Wywołanie powyższego adresu (w przypadku podania prawidłowych danych do zalogowania) spowoduje sprawdzenie numeru w bazie i zwrot informacji czy numer jest dostępny czy też nie.

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
akcja	String	hlr	Aby sprawdzić numer należy umieścić tutaj wartość „hlr”.
login	String	login	Login konta używany do wysyłki
haslo	String	hasło	Hasło do konta
numer	String	500600700 lub +42565478965	Numer w formacie 9-cio cyfrowym. Dla numerów zagranicznych niezbędne jest podanie plusa i prefiksu kraju.

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot wygenerowany po przesłaniu przykładowego zapytania.

<?xml version="1.0" encoding="UTF-8"?>
<SerwerSMS login="demo">
 <NUMER numer="+48500600700">
  <status>OK</status>
  <imsi>260031994508897</imsi>
  <siec_macierzysta>Orange (PTK Centertel Sp. z o.o.)</siec_macierzysta>
  <przenoszony>0</przenoszony>
  <siec_obecna>Orange (PTK Centertel Sp. z o.o.)</siec_obecna>
  <opis></opis>
 </NUMER>
</SerwerSMS>

Objaśnienie poszczególnych sekcji XML

Znacznik XML	Opis
<NUMER></NUMER>	Zawiera informację na temat sprawdzanego numeru
<Numer="NUM" />	Sprawdzany numer telefonu
<status>X</status>	Status zapytania HLR, jeśli jest poprawny, system zwróci „OK”, jeśli nie ma możliwości aby sprawdzić numer lub numer nie jest poprawny, system zwróci „ERR”. UWAGA! Taryfikowane są wszystkie zapytania HLR, zarówno poprawne jak i niepoprawne.
<imsi>X</imsi>	Unikatowy numer przypisany do każdej karty SIM w sieci GSM lub UMTS. W niektórych sytuacjach może zawierać jedynie numer kraju i numer sieci (np. „26003”).
<siec_macierzysta>X</siec_macierzysta>	Nazwa alfanumeryczna sieci z której numer pochodzi.
<przenoszony>X</przenoszony>	Informacja o tym czy numer jest przenoszony „1” czy też nie „0”.
<siec_obecna>X</siec_obecna>	Nazwa alfanumeryczna sieci do której numer jest obecnie przypisany.
<opis>X</opis>	Kod ew. błędu podczas sprawdzania numeru

Kody błędów

Kod	Opis
UNKNOWN_SUBSCRIBER	Numer nie istnieje lub nie jest przypisany do żadnego abonenta
CALL_BARRED	Abonent ustawił usługę "Nie przeszkadzać" (DND)
ABSENT_SUBSCRIBER_SM	Abonent tymczasowo niedostępny - znajduje się poza zasięgiem sieci lub jego aparat jest wyłączony
TELE_SERVICE_NOT_PROVISIONED	Usługa telefoniczna została zawieszona przez operatora
HLR_REJECT	Zapytanie zostało odrzucone przez operatora
HLR_ABORT	HLR (lub inna jednostka) przerwało zapytanie. Brak odpowiedzi
HLR_LOCAL_CANCEL	Brak odpowiedzi na zapytanie HLR
TIMEOUT	Brak odpowiedzi w określonym czasie
IMSI_LOOKUP_BLOCKED	Usługa zablokowana dla wybranego numeru
SYSTEM_FAILURE	Awaria systemu HLR po stronie operatora

Zalecane ustawienia

Nie należy sprawdzać wielokrotnie pod rząd tego samego numeru gdyż każde wywołanie sprawdzające przynależność do sieci jest taryfikowane. Warto więc zapisywać wyniki lokalnie i posługiwać się nimi przez określony czas np. kilka dni. 

Należy ustawić większy timeout dla zapytań, gdyż oczekiwanie na odpowiedź systemu może trwać od kilku do nawet kilkudziesięciu sekund.