HTTPS API v2 / NAT - sprawdzanie dostępności numeru

Zasada działania

Aby przy pomocy Zdalnej obsługi sprawdzić dostępność numeru należy wywołać określony adres URL metodą POST.

phones/nat

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|Array 500600700 lub +42565478965 Numer w formacie 9-cio cyfrowym. Dla tej usługi wspierane są wyłącznie Polskie numery GSM.
url String http://www.adres.com/index.php?id=#ID#&stan=#STAN# Opcjonalnie adres URL który zostanie wywołany po zakończeniu sprawdzania numeru. Adres może zawierać parametry: #ID# (identyfikator zlecenia), #STAN# (stan zlecenia: DELIVRD, UNDELIV, ERR, PENDING), #NUMER# (sprawdzany numer), #DATA# (data zakończenia sprawdzania)

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

Zwrot wygenerowany po przesłaniu przykładowego pojedynczego zapytania.

{
   "phone":"+48500600700",
   "id":"12345qwert"
}

Objaśnienie poszczególnych parametrów zwrotnych

Parametr Opis
phone Sprawdzany numer telefonu
id Identyfikator zlecenia. Można go użyć później do odpytania statusu zapytania lub w adresie URL wywyłowanym po zakończeniu sprawdzania numeru.

Sprawdzenie stanu zapytania

Aby przy pomocy Zdalnej obsługi sprawdzić stan wybranego zapytania (ID) należy wywołać określony adres URL metodą POST.

phones/nat

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.
id String numer zgłoszenia Identyfikator wcześniej zleconego zapytania

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

Zwrot wygenerowany po przesłaniu przykładowego zapytania:

{
   "phone":"+48500600700",
   "status":"DELIVRD",
   "date":"2017-10-26 10:40:26"
}

Objaśnienie poszczególnych parametrów zwrotnych

Parametr Opis
phone Zawiera informację na temat sprawdzanego numeru
status Status sprawdzanego numeru. Możliwe wartości: DELIVRD (numer jest dostępny), UNDELIV (numer nie jest dostępny), ERR (nieprawidłowy numer), PENDING (numer jest jeszcze sprawdzany). Statusy DELIVRD, UNDELIV, ERR są statusami końcowymi.
date Data zakończenia sprawdzania

Zalecane ustawienia

Nie należy sprawdzać wielokrotnie identyfikatorów które przyjęły status końcowy. Prosimy o sprawdzanie tych samych zapytań nie częściej niż 1x na 1minutę.