HTTPS API v2 / LOOKUP sprawdzanie przynależności numeru do sieci

Zasada działania

Aby przy pomocy Zdalnej obsługi sprawdzić przynależność numeru do sieci należy wywołać określony adres URL metodą POST.

phones/lookup

Dostępne parametry

Parametr Typ Przykładowa wartość lub format Opis
username String login Login konta używany do wysyłki.
password String hasło Hasło do konta.
phone String 500600700 lub +42565478965 Numer w formacie 9-cio cyfrowym. Dla numerów zagranicznych niezbędne jest podanie plusa i prefiksu kraju.
id String numer zgłoszenia Parametr służący do odczytu wyniku, jeśli czas oczekiwania na odpowiedź przekroczy 60 sekund.

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

Zwrot wygenerowany po przesłaniu przykładowego zapytania.

{
   "phone":"+48500600700",
   "status":"OK",
   "imsi":26006,
   "network":"Orange (PTK Centertel Sp. z o.o.)",
   "ported":false,
   "network_ported":null
}

Objaśnienie poszczególnych parametrów zwrotnych

Parametr Opis
phone Sprawdzany numer telefonu
status Status zapytania LOOKUP, 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 LOOKUP, zarówno poprawne jak i niepoprawne.
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”).
network Nazwa alfanumeryczna sieci z której numer pochodzi.
ported Informacja o tym czy numer jest przenoszony „true” czy też nie „false”.
network_ported Nazwa alfanumeryczna sieci do której numer jest obecnie przypisany.

Jeśli czas oczekiwania na odpowiedź przekroczy 60 sekund, zwrócony zostanie identyfikator, który należy podstawić do zapytania w późniejszym czasie w celu odczytu statusu po jego aktualizacji. Odpowiedź zwrotna będzie miała wówczas postać:

{
   "phone":"+48500600700",
   "id":"6970aa5525"
}

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.