HTTPS XML API / Obsługa czarnej listy

System umożliwia zdalne listowanie, dodawanie oraz usuwanie numerów z czarnej listy.

Listowanie numerów z czarnej listy

Wywołanie adresu

Aby przy pomocy zdalnej obsługi wylistować numery zapisane na czarnej liście, 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=czarna_lista&operacja=lista

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
akcja	String	czarna_lista	Wartość odpowiadająca zarządzaniu czarną listą
login	String	Login	Login konta
haslo	String	Haslo	Hasło konta
operacja	String	lista	Wartość taka pozwoli wylistować numery z czarnej listy
numer	String	np. +48500600700	Wartość opcjonalna, pozwalająca zawęzić przeszukiwany obszar do konkretnego numeru

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

Zwrot odpowiedzi

Wywołanie powyższego adresu może wygenerować np. taką odpowiedź:

<?xml version="1.0" encoding="UTF-8"?>
<SerwerSMS login="demo">
 <CZARNALISTA>
  <NUMER>+48500600700</NUMER>
  <NUMER>+48600700800</NUMER>
 </CZARNALISTA>
</SerwerSMS>

Objaśnienie poszczególnych sekcji XML

Znacznik XML	Opis
<CZARNALISTA><NUMER>NUM</NUMER></CZARNALISTA>	Tag CZARNALISTA zawiera listę numerów z których każdy znajduj się w osobnym tagu NUMER

Dopisywanie numeru do czarnej listy

Wywołanie adresu

Aby przy pomocy zdalnej obsługi dopisać numer do czarnej listy, 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=czarna_lista&operacja=dodaj&numer=500600700

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
akcja	String	czarna_lista	Wartość odpowiadająca zarządzaniu czarną listą
login	String	Login	Login konta
haslo	String	Haslo	Hasło do konta
operacja	String	dodaj	Wartość taka pozwoli dopisać numer do czarnej listy
numer	String	np. +48500600700	Numer do dopisania do czarnej listy, najlepiej z międzynarodowym prefiksem poprzedzonym znakiem „+”.

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

Zwrot odpowiedzi

Wywołanie powyższego adresu może wygenerować np. taką odpowiedź:

<?xml version="1.0" encoding="UTF-8"?>
<SerwerSMS login="demo">
 <NUMER>OK</NUMER>
</SerwerSMS> 

Objaśnienie poszczególnych sekcji XML

Znacznik XML	Opis
<NUMER>STAN</NUMER>	Tag NUMER zawiera informację STAN na temat status wykonywanej operacji. W przypadku powodzenia, zwrócone zostanie „OK”. W przypadku wystąpienia błędu, zostanie zwrócony kod numeryczny lub opis alfanumeryczny (w zależności od ustawień API).

Usuwanie numeru z czarnej listy

Wywołanie adresu

Aby przy pomocy zdalnej obsługi usunąć numer z czarnej listy, 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=czarna_lista&operacja=usun&numer=500600700

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
akcja	String	czarna_lista	Wartość odpowiadająca zarządzaniu czarną listą
login	String	Login	Login konta
haslo	String	Haslo	Hasło do konta
operacja	String	usun	Wartość taka pozwoli usunąć numer z czarnej listy
numer	String	np. +48500600700	Numer do dopisania do czarnej listy, najlepiej z międzynarodowym prefiksem poprzedzonym znakiem „+”.

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

Zwrot odpowiedzi

Wywołanie powyższego adresu może wygenerować np. taką odpowiedź:

<?xml version="1.0" encoding="UTF-8"?>
<SerwerSMS login="demo">
 <NUMER>OK</NUMER>
</SerwerSMS> 

Objaśnienie poszczególnych sekcji XML

Znacznik XML	Opis
<NUMER>STAN</NUMER>	Tag NUMER zawiera informację STAN na temat status wykonywanej operacji. W przypadku powodzenia, zwrócone zostanie „OK”. W przypadku wystąpienia błędu, zostanie zwrócony kod numeryczny lub opis alfanumeryczny (w zależności od ustawień API).