HTTPS XML API / 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 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=nat&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	nat	Aby sprawdzić numer należy umieścić tutaj wartość „nat”.
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 tej usługi wspierane są wyłącznie Polskie numery GSM.
dlr_url	String	http://adres.pl/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 zapytania.

<?xml version="1.0" encoding="UTF-8"?>
<SerwerSMS login="demo">
 <NUMER numer="+48500600700" id="12345qwert"></NUMER>
</SerwerSMS>

Objaśnienie poszczególnych sekcji XML

Znacznik XML	Opis
<NUMER></NUMER>	Zawiera informację na temat sprawdzanego numeru
<numer="NUM" />	Sprawdzany numer telefonu
<id="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 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=nat&id=12345qwert

Wywołanie powyższego adresu (w przypadku podania prawidłowych danych do zalogowania) spowoduje zwrot informacji dot. podanego identyfikatora.

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
akcja	String	nat	Aby sprawdzić numer należy umieścić tutaj wartość „nat”.
login	String	login	Login konta używany do wysyłki
haslo	String	hasło	Hasło do konta
id	String	12345qwert	Identyfikator wcześniej zleconego zapytania

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>DELIVRD</status>
  <data>2015-12-25 12:00:00</data>
 </NUMER>
</SerwerSMS>

Objaśnienie poszczególnych sekcji XML

Znacznik XML	Opis
<NUMER numer="NUM"></NUMER>	Zawiera informację na temat sprawdzanego numeru
<status>STAT</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.
<data>DAT</data>	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ę.