You are on page 1of 41

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP

Opracowa:

Dnia: Wersja:

Tomasz Szmaciski biuro@serwersms.pl www.serwersms.pl 2012-01-16 3.9

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Spis treci Wprowadzenie............................................................................................................................ 3 Komunikaty oglne .................................................................................................................... 6 Wysyanie wiadomoci SMS o jednakowej treci...................................................................... 7 Wysyanie spersonalizowanych wiadomoci SMS (o rnej treci) ........................................ 13 Wysyanie wiadomoci MMS .................................................................................................. 16 Wysyanie wiadomoci VOICE (Pliki WAV) ........................................................................... 19 Wasne identyfikatory wiadomoci (usmsid) ........................................................................... 22 Obsuga wiadomoci Premium SMS ....................................................................................... 23 Sprawdzanie raportw dorcze wiadomoci .......................................................................... 25 Usuwanie zaplanowanych na okrelony termin wysyek ......................................................... 29 Sprawdzanie i pobieranie odpowiedzi oraz innych wiadomoci przychodzcych .................. 30 Sprawdzanie iloci dostpnych wiadomoci do wysania ........................................................ 35 Autoryzacja nazwy nadawcy.................................................................................................... 36 Historia zmian: ......................................................................................................................... 39

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Wprowadzenie
Serwer SMS umoliwia wysyanie wiadomoci przy pomocy Panelu Klienta oraz dostpnych tam funkcji jak rwnie przy pomocy tzw. zdalnej obsugi. Dziki drugiej z wymienionych metod moliwe jest wysyanie oraz sprawdzanie poprawnoci wysanych wiadomoci jak rwnie dostp do innych funkcji bez koniecznoci logowania si do Panelu Klienta. Komunikacja z Serwer SMS odbywa si poprzez wywoanie specjalnego adresu URL metod GET lub formularza metod POST z odpowiednimi parametrami. Adres moe by wywoywany zarwno jako poczenie szyfrowane SSL (na pocztku https:// jak rwnie standardowo, bez szyfrowania http://). Jako odpowied zwracany jest dokument w formacie XML informujcy o wyniku wywoanej operacji. Z racji specyfikacji standardu XML treci wywietlane jako odpowiedzi nie zawieraj polskich znakw tylko ich odpowiedniki (np. -> s) a znaki specjalne typu > kodowane do formatu UTF-8. Maksymalna wielko pojedynczego zgoszenia do wysyki to 100.000 SMS. Zalecane jest przesyanie mniejszych porcji danych np. 1000-500 SMS w jednym zgoszeniu. W przypadku zastosowania polskich znakw w treci wiadomoci maksymalna ilo numerw przesanych w jednym zgoszeniu wynosi 1.000. W przypadku gdy w pojedynczym zgoszeniu zostanie przesanych wicej numerw lub wiadomoci spersonalizowanych (numer oraz wiadomo) wygenerowany zostanie bd oglny a wiadomoci nie zostan wysane. Usuga zdalnej obsugi przez WebAPI umoliwia rwnie wysyanie informacji o raportach dorcze oraz odpowiedziach SMS wprost na wskazany adres URL Abonenta. Aby Serwer SMS wysa automatycznie informacje o raportach dorcze do Abonenta, naley w Panelu Klienta ustawi odpowiednie opcje w zakadce Zdalna obsuga (WebAPI). Wicej informacji na ten temat znajduje si w dalszej czci dokumentacji. Moliwe jest rwnie korzystanie z funkcjonalnoci WebAPI uywajc loginu i hasa uytkownikw konta gwnego. Konta uytkownikw naley wczeniej skonfigurowa w Panelu klienta i nada im odpowiednie uprawnienia jak np. moliwo korzystania z WebAPI, sprawdzania raportw dorcze oraz odpowiedzi SMS. Naley rwnie pamita o formacie podawanych numerw telefonw. Kady numer powinien by w formacie midzynarodowym np. w przypadku numerw polskich sieci komrkowych jest to +48509693444. Analogicznie jeli numer jest z sieci innego kraju naley poprzedzi go numerem kierunkowym. Ponadto naley zwrci uwag na dugo adresu przesyanego metod GET gdy w przypadku przesyania wikszej iloci danych moe nastpi przekroczenie dozwolonych 255 znakw. W takim przypadku prosimy o przesyanie danych metod POST. Wychodzc naprzeciw oczekiwaniom naszych obecnych oraz przyszych Klientw, udostpniamy moliwo sprawdzania i testowania usugi zdalnej obsugi przez WebAPI dla osb nie posiadajcych jeszcze kont w Serwer SMS. Aby skorzysta z konta testowego naley logowa si na nastpujce dane:

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Login: webapi Haso: webapitest

Zapytania ktre w przypadku normalnego konta wysyaj wiadomoci, w tym przypadku jedynie generuj zwrot w postaci dokumentu XML (identycznie jak w przypadku parametru test=1). Informacje zwrotne s identyczne jak w przypadku standardowego wysyania wiadomoci . Aby dokadnie sprawdzi raporty dorczenia oraz odczytywanie wiadomoci zwrotnych wysane zostay dwa SMSy oraz jedna odpowied SMS. W zwrocie otrzymano nastpujce dokumenty XML:

Wysany SMS 1:
<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="webapi"> <Wiadomosc>To jest wiadomosc testowa z serwersms.pl</Wiadomosc> <Odbiorcy> <Skolejkowane> <SMS id="5f5d1b1d97" numer="+48509693444" godzina_skolejkowania="200808-08 12:42:19"/> </Skolejkowane> </Odbiorcy> </SerwerSMS>

Wysany SMS 1:
<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="webapi"> <Wiadomosc>I jeszcze jedna wiadomosc testowa z serwersms.pl</Wiadomosc> <Odbiorcy> <Skolejkowane> <SMS id="1614f32c34" numer="+48783820099" godzina_skolejkowania="200808-08 12:43:23"/> </Skolejkowane> </Odbiorcy> </SerwerSMS>

Odpowied SMS:
<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="webapi"> <SMS numer="+48783820099" data="2008-08-08 12:44:17" tresc="Dziekuje za ta informacje. Pozdrawiam"/> </SerwerSMS>

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Na podstawie powyszych informacji mona z powodzeniem przetestowa oraz wdroy zdaln obsug do wasnego oprogramowania przez co sam proces integracji po skorzystaniu z oferty Serwer SMS bdzie krtszy i pewniejszy.

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Komunikaty oglne
W przypadku braku okrelenia akcji, zablokowanego konta klienta lub podaniu bdnych danych klienta Serwer SMS wygeneruje dokument w formacie XML z informacj na temat bdu ktry wystpi. Przykadowo w przypadku podania niewaciwego loginu lub hasa klient zobaczy nastpujcy komunikat:
<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS> <Blad>blad logowania: nieprawidlowy login lub haslo</Blad> </SerwerSMS>

Jeli nie zostanie okrelona adna akcja do wykonania, system wywietli komunikat:
<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <Blad>Nie okreslono akcji do wykonania</Blad> </SerwerSMS>

Objanienie poszczeglnych sekcji XML:


Znacznik XML <Blad></Blad>

Opis Widnieje tu przyczyna dlaczego wybrana operacja nie zakoczya si powodzeniem

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Wysyanie wiadomoci SMS o jednakowej treci


Wywoanie adresu Aby przy pomocy Zdalnej obsugi wysa wiadomo SMS naley przesa okrelone zgoszenie protokoem HTTP lub HTTPS metod POST lub GET. Przykadowo adres w przegldarce wyglda moe nastpujco: https://api1.serwersms.pl/zdalnie/index.php?login=uzytkownik&haslo=tajnehaslo&akcja=wyslij_s ms&numer=%2B48509693444&wiadomosc=Test%20Serwera%20SMS&flash=1

W przypadku zastosowania metody POST w formularzu, nazwy zmiennych i ich wartoci pozostaj bez zmian, zmienia si tylko i wycznie metoda przesania zapytania. Wywoanie powyszego adresu (w przypadku podania prawidowych danych do zalogowania) spowodowaoby wysanie wiadomoci SMS na numer 509693444 o treci Test Serwera SMS gdzie tre od od razu pojawi si na ekranie telefonu gdy wiadomo wysyana jest jako Flash SMS (parametr flash=1). UWAGA, aby wysa wiadomo SMS Full naley wypeni pole nadawca (nazwa lub numer). Jeli parametr nadawca zostanie pominity, lub jego warto bdzie pusta, zostanie wysany SMS typu Eco. Wypenienie parametru nadawca decyduje o tym czy wysany zostanie SMS Eco czy Full. Dostpne parametry: Parametr akcja Przykadowa warto lub format wyslij_sms Opis Aby wysa wiadomo SMS naley umieci tutaj warto wyslij_sms. Login klienta uywany do logowania si w Panelu Klienta Haso klienta uywane do logowania si w Panelu Klienta Numer lub numery telefonw oddzielane przecinkami. Tre wiadomoci SMS bez polskich znakw. Dostpne jest 160 znakw. Polskie znaki zamieniane s na ich odpowiedniki np. -> s itp. Parametr opcjonalny. Aby wysa wiadomo SMS jako Flash (od razu wywietlajc si na ekranie telefonu) parametr flash musi mie warto 1. Parametr opcjonalny, pozwalajcy

login haslo numer wiadomosc

login haslo %2B48509693444 tresc

flash

1, 0 lub brak parametru

test

1, 0 lub brak parametru

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

nadawca

wap_push

Numer w formacie +48509693444 (%2B48509693444) lub nazwa wasna (max 11 znakw, due i mae litery oraz liczby i znak spacji). Adres URL lub parametr pusty

pl

1 lub 0

glosowy

1 lub 0

vcard

1 lub 0

na sprawdzenie zapytania wysyajcego wiadomo SMS. W odpowiedzi generowany jest dokument XML identyczny jak w przypadku standardowego zapytania jednak wiadomo nie jest wysyana. Przydatne do testowania aplikacji. Parametr opcjonalny, umoliwia zmian pola nadawcy wiadomoci SMS na dowolny numer lub nazw. Jako numer naley poda numery podane w Panelu Klienta i pomylnie potwierdzone. Parametr opcjonalny. Naley poda peny adres wraz z uywanym protokoem np. http://. W przypadku podania adresu wiadomo zostanie wysana jako WAP Push. Okrelenie parametru nadawca jest obowizkowe w przypadku chci wysania wiadomoci WAP Push. Parametr opcjonalny, umoliwia wysanie wiadomoci Full SMS zawierajcej polskie znaki specjalne. Dziaa zarwno w standardowej wysyce jak i spersonalizowanej. W przypadku wysyania polskich znakw naley je odpowiednio zakodowa do formatu UTF. Tabela z przykadami dostpna poniej. Parametr opcjonalny, umoliwia wysanie wiadomoci SMS Gosowy na numery stacjonarne. W przypadku wiadomoci gosowej maksymalna dugo wiadomoci to 160 znakw. Parametr nadawca musi pozosta pusty. Spersonalizowane wiadomoci s obsugiwane. Parametr opcjonalny, umoliwiajcy wysanie wiadomoci SMS Full ktra zostanie dorczona jako wizytwka Vcard. W takim przypadku tre wiadomoci musi

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

mie cile okrelon struktur. speed 1 lub 0 Parametr opcjonalny, pozwalajcy na wysanie wiadomoci niezalenym kanaem o najwyszej jakoci (wie si to z dopat do SMS Full) data_wysylki Data w formacie Parametr opcjonalny pozwalajcy YYYY-MM-DD HH:ii na okrelenie terminu wysyki np: 2010-11-09 15:23 wiadomoci SMS. usmsid np. 6asTD3fif98gj Parametr opcjonalny pozwalajcy na zdefiniowanie wasnego identyfikatora wysyanej wiadomoci. Identyfikator moe mie maksymalnie 50 znakw alfanumerycznych (a-z, A-Z, 0-9) Parametry oznaczone pogrubieniem s obowizkowe. Pozostae s opcjonalne. W przypadku chci wysania wiadomoci jako wizytwka Vcard (parametr vcard=1), struktura wiadomoci musi mie cile okrelony format. Przykad formatu Vcard mona znale w oglnie dostpnej dokumentacji w internecie lub korzystajc z Panelu Klienta i formularza wysyki SMS. Kolejne tagi w wiadomoci Vcard powinny by rozdzielone znakiem nowej linii. Wiadomo Full SMS ktra zawiera polskie znaki specjalne powinna by przed wysaniem odpowiednio zakodowana. Wszystkie polskie znaki specjalne powinny by przeksztacone do formatu UTF. Naley rwnie pamita o odpowiednim zakodowaniu znakw & (%26) oraz # (%23) w przypadku wysyania metod GET. Przykadowo wiadomo o treci Przykadow wiadomoci w przypadku wysyki metod POST bdzie wyglda nastpujco:
Przyk&#322;adow&#261; wiadomo&#347;ci&#261;

Natomiast w przypadku wysyki metod GET musz by zakodowane dodatkowo znaki & oraz # wic wiadomo bdzie przesyana w postaci:
Przyk%26%23322;adow%26%23261; wiadomo%26%23347;ci%26%23261;

Aby wysa wiadomo z polskimi znakami musi by ustawiony parametr pl=1, abonent musi posiada uprawnienia do wysyania wiadomoci typu Full SMS oraz musi by wypenione pole nadawcy. Litera Kod &#261; &#263; &#243; Litera Kod &#260; &#262; &#211;

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

&#322; &#347; &#380; &#378; &#324; &#281;

w Internecie np.

&#321; &#346; &#379; &#377; &#323; &#280; na stronie:

Szczegy dot. Kodowania znakw mona znale http://www.kurshtml.boo.pl/generatory/unicode.html

Aby wysya wiadomoci typu Full (z wasnym polem nadawcy lub wiadomoci WAP Push), Abonent musi posiada odpowiednie uprawnienia. W przypadku nowych Klientw odpowiedni zapis znajduje si ju w umowie. W przypadku Abonentw ktrzy podpisali umowy przed 01.07.2008 niezbdne bdzie pobranie, wypenienie i przesanie do Firmy Artnet S.A Serwer SMS odpowiedniego aneksu do umowy ktry mona znale w Panelu Klienta w dziale Moje konto. Zwrot odpowiedzi W zalenoci od przesanych danych Serwer SMS wygeneruje w odpowiedzi dokument w formacie XML z informacj na temat wykonanych akcji. I tak w przypadku prawidowego wysania wiadomoci SMS klient otrzyma przykadowo nastpuj informacj:
<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <Wiadomosc>Test Serwer SMS</Wiadomosc> <Odbiorcy> <Skolejkowane> <SMS id="1c142d81c7" numer="+48509693444" godzina_skolejkowania="200807-10 12:42:45"/> </Skolejkowane> </Odbiorcy> </SerwerSMS>

W sekcji <Wiadomosc></Wiadomosc> widnieje tre wysyanej wiadomoci SMS. Sekcja <Odbiorcy></Odbiorcy> zawiera numery telefonw i ID wiadomoci przekazanych do wysania (oraz wiadomoci ktrych nie skolejkowano z okrelonego powodu). Sekcja <SMS></SMS> zawiera numer telefonu oraz ID wiadomoci. Unikalny znacznik wiadomoci SMS moe by wykorzystany pniej do sprawdzenia w sposb zdalny stanu wysyki konkretnej wiadomoci SMS. Numer telefonu jest automatycznie poprawiany i wywietlany w penym formacie wymaganym przez Serwer SMS czyli z numerem kierunkowym kraju (np. +48) na pocztku. W przypadku wywoania skryptu z dwoma lub wicej takimi samymi numerami, system wyle wiadomo tylko raz na ten numer. W przypadku podania np. zego numeru telefonu zostanie wygenerowana informacja o bdzie jak rwnie ID wiadomoci (aby mona byo pniej sprawdzi kiedy i dlaczego nie zostaa

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

wysana). I tak np. w przypadku podania dwch numerw prawidowych i dwch numerw bdnych system wygeneruje nastpujcy dokument XML:
<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <Wiadomosc>Test Serwera SMS</Wiadomosc> <Odbiorcy> <Skolejkowane> <SMS id="e1389bc4f6" numer="+48509693444" godzina_skolejkowania="200807-10 12:42:45"/> <SMS id="3ko9iuytdf" numer="+48509693123" godzina_skolejkowania="200807-10 12:42:45"/> </Skolejkowane> <Niewyslane> <SMS id="dedb71cd72" numer="6043440" przyczyna="bledny numer odbiorcy"/> <SMS id="765dk6109s" numer="+420777099123" przyczyna="niedozwolone wysyanie SMSow do sieci zagranicznych"/> </Niewyslane> </Odbiorcy> </SerwerSMS>

Objanienie poszczeglnych sekcji XML:


Znacznik XML <Wiadomosc></Wiadomosc> <Odbiorcy></Odbiorcy>

Opis Zawiera tre wysyanej wiadomoci Jest to cz gdzie wyszczeglnione s wszystkie wysane oraz niewysane wiadomoci SMS <Skolejkowane></Skolejkowane> Zawiera poprawnie skolejkowane wiadomoci SMS ktre zostan wysane w najbliszym czasie <SMS numer="NUM id=ID W sekcji prawidowo kolejkowanych wiadomoci godzina_skolejkowania=DAT/> SMS wpisy takie okrelaj numer telefonu (NUM), ID wiadomoci (ID) oraz godziny kolejkowania (DAT). <Niewyslane></Niewyslane> Zawiera informacje o bdach w prbie kolejkowania wiadomoci SMS <SMS numer="NUM" id="ID" W sekcji <Niewyslane> okrela numer telefonu przyczyna="POWOD"/> (NUM) na ktry nie udao si wysa wiadomoci SMS, ID tej wiadomoci oraz powd niewysania Oprcz tego moe zosta wygenerowany bd oglny gdzie nie ma rozgraniczenia na skolejkowane i bdne. Moe to nastpi np. w sytuacji gdy klient nie wpisze treci wiadomoci, nie poda numerw telefonw lub jego konto nie jest aktywne. W przypadku niewpisania treci wiadomoci zostanie wygenerowany nastpujcy komunikat:

<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <Blad>Wiadomosc jest pusta</Blad>

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

</SerwerSMS>

Oraz analogicznie w przypadku niepodania numerw telefonw:

<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <Blad>Nie podano numerow telefonow</Blad> </SerwerSMS>

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Wysyanie spersonalizowanych wiadomoci SMS (o rnej treci)


Wywoanie adresu Aby przy pomocy Zdalnej obsugi wysa spersonalizowan wiadomo SMS naley wywoa okrelony adres URL metod POST lub GET. W wiadomociach spersonalizowanych nie ma dostpnych parametrw takich jak numer czy wiadomosc. Zamiast tego jest dodatkowy parametr spersonalizowane ktry zawiera zbir numerw oraz przyporzdkowanych do nich indywidualnych treci wiadomoci. Warto parametru spersonalizowane skada si z oddzielonych od siebie dwukropkiem numeru oraz wiadomoci (np. 509693444:wiadomosc spersonalizowana). Kolejne czony, czyli numer+tre oddzielone s od siebie znakami ]|[. Limit pojedynczego wywoania takie go zapytania to 10.000 numerw i odpowiadajcym im treciom wiadomoci (zalecane s znacznie mniejsze porcje danych, po ok. 100-500 numerw w jednym zapytaniu). Przykadowo adres w przegldarce wyglda moe nastpujco: https://api1.serwersms.pl/zdalnie/index.php?login=uzytkownik&haslo=tajnehaslo&akcja=wyslij_s ms&spersonalizowane=+48509693444:wiadomosc1]|[+48509693333:wiadomosc2]|[

Wywoanie powyszego adresu (w przypadku podania prawidowych danych do zalogowania) spowodowaoby wysanie wiadomoci SMS o treci wiadomosc1 na numer 509693444 oraz drug wiadomo SMS o treci wiadomosc2 na numer 509693333. Dostpne parametry: Parametr akcja Przykadowa warto lub format wyslij_sms Opis Aby wysa wiadomo SMS naley umieci tutaj warto wyslij_sms. Login klienta uywany do logowania si w Panelu Klienta Haso klienta uywane do logowania si w Panelu Klienta Numery telefonw i przypisane do nich treci wiadomoci SMS powinny by oddzielone znakiem dwukropka : natomiast kolejne czony numer:wiadomosc powinny by oddzielone od siebie znakami ]|[. Parametr opcjonalny. Aby wysa wiadomo SMS jako Flash (od

login haslo spersonalizowane

login haslo %2B48509693444:tresc1]|[ %2B48509693333:tresc2]|[ itp.

flash

1, 0 lub brak parametru

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

test

1, 0 lub brak parametru

nadawca

pl

Numer w formacie +48509693444 (%2B48509693444) lub nazwa wasna (max 11 znakw, due i mae litery oraz liczby i znak spacji). 1 lub 0

glosowy

1 lub 0

data_wysylki

Data w formacie YYYY-MM-DD HH:ii np: 2010-11-09 15:23

razu wywietlajc si na ekranie telefonu) parametr flash musi mie warto 1. Parametr opcjonalny, pozwalajcy na sprawdzenie zapytania wysyajcego wiadomo SMS. W odpowiedzi generowany jest dokument XML identyczny jak w przypadku standardowego zapytania jednak wiadomo nie jest wysyana. Przydatne do testowania aplikacji. Parametr opcjonalny, umoliwia zmian pola nadawcy wiadomoci SMS na dowolny numer lub nazw. Jako numer naley poda numery podane w Panelu Klienta i pomylnie potwierdzone. Parametr opcjonalny, umoliwia wysanie wiadomoci Full SMS zawierajcej polskie znaki specjalne. Dziaa zarwno w standardowej wysyce jak i spersonalizowanej. W przypadku wysyania polskich znakw naley je odpowiednio zakodowa do formatu UTF. Tabela z przykadami dostpna poniej. Parametr opcjonalny, umoliwia wysanie wiadomoci SMS Gosowy na numery stacjonarne. W przypadku wiadomoci gosowej maksymalna dugo wiadomoci to 160 znakw. Parametr nadawca musi pozosta pusty. Wiadomo nie powinna zawiera polskich znakw (bd one jednak automatycznie odczytywane przez lektora). Spersonalizowane wiadomoci s obsugiwane. Parametr opcjonalny pozwalajcy na okrelenie terminu wysyki wiadomoci SMS.

Zwrot wygenerowany po przesaniu jest taki sam jak w przypadku zwykego wysania wiadomoci SMS. Ronica polega jedynie na wywietlanej wartoci w znacznikach

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

<Wiadomosc>Wiadomosc spersonalizowana</Wiadomosc>. Warto ta jest staa i niezalena od treci przesyanych wiadomoci SMS.

<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <Wiadomosc>Wiadomosc spersonalizowana</Wiadomosc> <Odbiorcy> <Skolejkowane> <SMS id="e1389bc4f6" numer="+48509693444" godzina_skolejkowania="200807-10 12:42:45"/> <SMS id="3ko9iuytdf" numer="+48509693123" godzina_skolejkowania="200807-10 12:42:45"/> </Skolejkowane> <Niewyslane> <SMS id="dedb71cd72" numer="6043440" przyczyna="bledny numer odbiorcy"/> <SMS id="765dk6109s" numer="+420777099123" przyczyna="niedozwolone wysyanie SMSow do sieci zagranicznych"/> </Niewyslane> </Odbiorcy> </SerwerSMS>

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Wysyanie wiadomoci MMS


Zasada dziaania Aby wysa wiadomo MMS, naley wczeniej wczyta plik multimedialny korzystajc z opcji wgrywania plikw. Dopiero po wgraniu niezbdnych plikw (np. obrazkw, dwiku lub video), moliwe jest wysanie wiadomoci MMS gdzie abonent okrela identyfikator pliku do wysyki. Wgrywanie pliku Zapisanie pliku na serwerze polega na przesaniu adresu URL pliku wraz z odpowiednimi parametrami. System sprawdzi, czy plik istnieje i czy spenia wymagania, i jeli weryfikacja przejdzie pomylnie, dan zostan zapisane na serwerze a abonent otrzyma dokument XML zawierajcy identyfikator pliku oraz inne informacje. Wysanie pliku odbywa si w nastpujcy sposb: https://api1.serwersms.pl/zdalnie/index.php?login=uzytkownik&haslo=tajnehaslo&akcja=pliki&url _mms=http%3A%2F%2Fwww.serwer.pl%2Fkat%2Fplik.jpg

W rezultacie zostanie wygenerowany dokument XML np. taki jak poniszy:


<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <Plik id="734857"> <Nazwa>plik.jpg</Nazwa> <Rozmiar>34325</Rozmiar> <Typ>MMS</Typ> <Data>2011-04-01 12:20:30</Data> </Plik> </SerwerSMS>

W przypadku wystpienia bdu, XML bdzie wyglda np. tak jak poniszy:

<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <Blad>komunikat bledu</Blad> </SerwerSMS>

Listowanie plikw Aby wylistowa wgrane na serwer pliki i pobra ich identyfikatory, ktre nastpnie bdzie mona uy w wysyce MMS, naley wywoa ponisze zapytanie: https://api1.serwersms.pl/zdalnie/index.php?login=uzytkownik&haslo=tajnehaslo&akcja=pliki&li
sta=mms

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

W rezultacie zostanie wygenerowany dokument XML np. taki jak poniszy:


<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <Plik id="734857"> <Nazwa>plik.jpg</Nazwa> <Rozmiar>34325</Rozmiar> <Typ>MMS</Typ> <Data>2011-04-01 12:20:30</Data> </Plik> <Plik id="734858"> <Nazwa>plik1.jpg</Nazwa> <Rozmiar>34545</Rozmiar> <Typ>MMS</Typ> <Data>2011-04-01 12:20:31</Data> </Plik> <Plik id="734859"> <Nazwa>plik2.jpg</Nazwa> <Rozmiar>5463423</Rozmiar> <Typ>MMS</Typ> <Data>2011-04-01 12:20:32</Data> </Plik> </SerwerSMS>

Wysyka MMS Aby przy pomocy Zdalnej obsugi wysa wiadomo MMS naley wywoa okrelony adres URL metod POST lub GET. Przykadowo adres w przegldarce wyglda moe nastpujco: https://api1.serwersms.pl/zdalnie/index.php?login=uzytkownik&haslo=tajnehaslo&akcja=wyslij_s ms&mms=1&plikmms=231243&wiadomosc=tytul%20MMSa&numer=%2B48500600700

Wywoanie powyszego adresu (w przypadku podania prawidowych danych do zalogowania) spowodowaoby wysanie wiadomoci SMS o treci tytul MMSa z zacznikiem o identyfikatorze 231243 na numer 500600700. Dostpne parametry: Parametr akcja Przykadowa warto lub format wyslij_sms Opis Aby wysa wiadomo SMS naley umieci tutaj warto wyslij_sms. Login klienta uywany do logowania si w Panelu Klienta

login

login

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

haslo wiadomosc

haso Tytu wiadomoci MMS

plikmms

Identyfikator pliku

mms

1 lub 0

data_wysylki

test

Data w formacie YYYY-MM-DD HH:ii np: 2010-11-09 15:23 1, 0 lub brak parametru

Haso klienta uywane do logowania si w Panelu Klienta Tre wiadomoci SMS bez polskich znakw. Dostpne jest 40 znakw. Polskie znaki zamieniane s na ich odpowiedniki np. -> s itp. Identyfikator pliku mona pobra poprzez wczeniejsze wgranie i wylistowanie dostpnych plikw dla usugi MMS. Mona jednoczenie wysa max 10 plikw gdzie ich identyfikatory oddzielone s przecinkami. Ustawienie parametru jako 1 umoliwi wysyk MMS. Jeli parametr bdzie ustawiony jako 0, wysany zostanie zwyky tekstowy SMS Eco. Parametr opcjonalny pozwalajcy na okrelenie terminu wysyki wiadomoci SMS. Parametr opcjonalny, pozwalajcy na sprawdzenie zapytania wysyajcego wiadomo SMS. W odpowiedzi generowany jest dokument XML identyczny jak w przypadku standardowego zapytania jednak wiadomo nie jest wysyana.

Zwrot wygenerowany po przesaniu jest taki sam jak w przypadku zwykego wysania wiadomoci SMS.

<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <Wiadomosc>Tytul MMSa</Wiadomosc> <Odbiorcy> <Skolejkowane> <SMS id="e1389bc4f6" numer="+48509693444" godzina_skolejkowania="201107-10 12:42:45"/> <SMS id="3ko9iuytdf" numer="+48509693123" godzina_skolejkowania="201107-10 12:42:45"/> </Skolejkowane> <Niewyslane> <SMS id="dedb71cd72" numer="6043440" przyczyna="bledny numer odbiorcy"/> <SMS id="765dk6109s" numer="+420777099123" przyczyna="niedozwolone wysyanie SMSow do sieci zagranicznych"/>

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

</Niewyslane> </Odbiorcy> </SerwerSMS>

Wysyanie wiadomoci VOICE (Pliki WAV)


Zasada dziaania Aby wysa wiadomo gosow uywajc pliku WAV, naley wczeniej wczyta plik multimedialny korzystajc z opcji wgrywania plikw. Dopiero po wgraniu niezbdnych plikw (plikw WAV o okrelonych parametrach) moliwe jest wysanie wiadomoci VOICE gdzie abonent okrela identyfikator pliku do wysyki. Wgrywanie pliku Zapisanie pliku na serwerze polega na przesaniu adresu URL pliku wraz z odpowiednimi parametrami. System sprawdzi, czy plik istnieje i czy spenia wymagania, i jeli weryfikacja przejdzie pomylnie, dan zostan zapisane na serwerze a abonent otrzyma dokument XML zawierajcy identyfikator pliku oraz inne informacje. Wysanie pliku odbywa si w nastpujcy sposb: https://api1.serwersms.pl/zdalnie/index.php?login=uzytkownik&haslo=tajnehaslo&akcja=pliki&url _voice=http%3A%2F%2Fwww.serwer.pl%2Fkat%2Fplik.wav

W rezultacie zostanie wygenerowany dokument XML np. taki jak poniszy:


<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <Plik id="734857"> <Nazwa>plik.WAV</Nazwa> <Rozmiar>34325</Rozmiar> <Typ>VOICE</Typ> <Data>2011-04-01 12:20:30</Data> </Plik> </SerwerSMS>

W przypadku wystpienia bdu, XML bdzie wyglda np. tak jak poniszy:

<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <Blad>komunikat bledu</Blad> </SerwerSMS>

Listowanie plikw

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Aby wylistowa wgrane na serwer pliki i pobra ich identyfikatory, ktre nastpnie bdzie mona uy w wysyce MMS, naley wywoa ponisze zapytanie: https://api1.serwersms.pl/zdalnie/index.php?login=uzytkownik&haslo=tajnehaslo&akcja=pliki&li
sta=voice

W rezultacie zostanie wygenerowany dokument XML np. taki jak poniszy:


<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <Plik id="734857"> <Nazwa>plik.wav</Nazwa> <Rozmiar>34325</Rozmiar> <Typ>VOICE</Typ> <Data>2011-04-01 12:20:30</Data> </Plik> <Plik id="734858"> <Nazwa>plik1.wav</Nazwa> <Rozmiar>34545</Rozmiar> <Typ>VOICE</Typ> <Data>2011-04-01 12:20:31</Data> </Plik> <Plik id="734859"> <Nazwa>plik2.wav</Nazwa> <Rozmiar>5463423</Rozmiar> <Typ>VOICE</Typ> <Data>2011-04-01 12:20:32</Data> </Plik> </SerwerSMS>

Wysyka Voice Aby przy pomocy Zdalnej obsugi wysa wiadomo Voice naley wywoa okrelony adres URL metod POST lub GET. Przykadowo adres w przegldarce wyglda moe nastpujco: https://api1.serwersms.pl/zdalnie/index.php?login=uzytkownik&haslo=tajnehaslo&akcja=wyslij_s ms&glosowy=1&plikwav=231243&numer=%2B48500600700

Wywoanie powyszego adresu (w przypadku podania prawidowych danych do zalogowania) spowodowaoby wysanie wiadomoci Voice w postaci pliku WAV o identyfikatorze 231243 na numer 500600700. Dostpne parametry: Parametr Przykadowa warto lub format Opis

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

akcja

wyslij_sms

login haslo glosowy plikmms

login haso 1 Identyfikator pliku

test

1, 0 lub brak parametru

Aby wysa wiadomo SMS naley umieci tutaj warto wyslij_sms. Login klienta uywany do logowania si w Panelu Klienta Haso klienta uywane do logowania si w Panelu Klienta Ustawienie parametru jako 1 umoliwi wysyk Voice. Identyfikator pliku mona pobra poprzez wczeniejsze wgranie i wylistowanie dostpnych plikw dla usugi Voice. Parametr opcjonalny, pozwalajcy na sprawdzenie zapytania wysyajcego wiadomo. W odpowiedzi generowany jest dokument XML identyczny jak w przypadku standardowego zapytania jednak wiadomo nie jest wysyana. Przydatne do testowania aplikacji.

Zwrot wygenerowany po przesaniu jest taki sam jak w przypadku zwykego wysania wiadomoci SMS.

<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <Wiadomosc>WAV</Wiadomosc> <Odbiorcy> <Skolejkowane> <SMS id="e1389bc4f6" numer="+48509693444" godzina_skolejkowania="201107-10 12:42:45"/> <SMS id="3ko9iuytdf" numer="+48509693123" godzina_skolejkowania="201107-10 12:42:45"/> </Skolejkowane> <Niewyslane> <SMS id="dedb71cd72" numer="6043440" przyczyna="bledny numer odbiorcy"/> <SMS id="765dk6109s" numer="+420777099123" przyczyna="niedozwolone wysyanie SMSow do sieci zagranicznych"/> </Niewyslane> </Odbiorcy> </SerwerSMS>

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Wasne identyfikatory wiadomoci (usmsid)


Przy wysykach wiadomoci, oprcz identyfikatorw zwracanych przez system Serwer SMS, Klient moe zdefiniowa wasne identyfikatory dla zgaszanych wiadomoci. Do tego celu suy zmienna usmsid i moe przyjmowa wartoci alfanumeryczne z zakresu a-z, A-Z oraz 0-9, oraz minimaln dugo 3 znaki i maksymaln 50 znakw. Wiadomoci z wasnymi identyfikatorami mona wysya zarwno jako pojedyncze wiadomoci jak rwnie grupowe czy te spersonalizowane. Dla pojedynczej wiadomoci naley po prostu doda w zapytaniu zmienn usmsid oraz jej warto nadan przez Klienta, np.: https://api1.serwersms.pl/zdalnie/index.php?login=uzytkownik&haslo=tajnehaslo&akcja=wyslij_s ms&numer=%2B48500600700&wiadomosc=testowa_wiadomosc&usmsid=123abc1

Dla wysyki masowej, naley okreli list identyfikatorw usmsid w kolejnoci takiej w jakiej przekazywane s kolejne numery. Kolejne identyfikatory usmsid powinny by oddzielone od siebie przecinkami np.: https://api1.serwersms.pl/zdalnie/index.php?login=uzytkownik&haslo=tajnehaslo&akcja=wyslij_s ms&numer=%2B48500600700,%2B48500600701,%2B48500600702 &wiadomosc=testowa_wiadomosc&usmsid=123abc1, 123abc2,123abc3

W powyszym przykadzie numery maj nastpujce identyfikatory usmsid: +48500600700 123abc1 +48500600701 123abc2 +48500600702 123abc3 Analogicznie wyglda sytuacja w przypadku wysyki wiadomoci spersonalizowanych. Kolejne identyfikatory usmsid powinny odpowiada zgaszanym wiadomociom wraz z numerami. Ilo przekazywanych grupowo numerw/wiadomoci spersonalizowanych oraz identyfikatorw usmsid musi si zgadza. Jeli iloci nie bd zgodne, adna z wiadomoci nie zostanie wysana a system zwrci bd oglny. Podobnie jest z wartociami identyfikatorw usmsid tj. jeli cho jeden identyfikator zawiera niedopuszczalne znaki, zwrcony zostanie bd oglny.

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Obsuga wiadomoci Premium SMS


Zasada dziaania Przy uyciu WebAPI mona obsugiwa rwnie ruch Premium SMS, tworzc np. wasne schematy konkursw, loterii czy czaty SMS (w przypadku gdy np. funkcjonalno Panelu Klienta nie jest zadowalajca dla Abonenta). Komunikacja Premium polega na odebraniu zapytania z now wiadomoci lub ew. wylistowanie dostpnych wiadomoci Premium oraz przesanie zapytania dot. wysyki odpowiedzi. URL przesyajcy informacj o nowej wiadomoci Premium W Panelu Klienta mona ustawi adres URL z odpowiednimi parametrami, na jaki wysyane maj by informacje dot. nowych wiadomoci Premium. Ustawienia te mona zaktualizowa w Panelu Klienta Premium SMS Prexy i numery Edycja wybranego hasa (lub stworzenie nowego) Tre odpowiedzi WebAPI. Przykadowy URL moe mie posta:
https://www.adres.pl/skrypt.php?z_numeru=#NUMEROD#&wiadomosc=#WIADOMOSC#&na_numer=#NUMER DO#&data=#DATA#&idsms=#IDSMS#&limit=#LIMIT#

Opis parametrw: Parametr #NUMEROD# #WIADOMOSC# #NUMERDO# #DATA# #IDSMS# #LIMIT# Przykadowa warto lub format 48500600700 test 71200 2011-09-26 12:23:56 1234 2 Opis Numer 9-cio cyfrowy z jakiego przysza wiadomo Premium Tre wiadomoci Numer Premium na jaki zostaa wysana wiadomo Data w formacie YYY-MM-DD HH:ii:ss Identyfikator numeryczny wiadomoci. Liczba przysugujcych odpowiedzi dla wybranej wiadomoci.

Poprawna odpowied na zapytanie powinna by zwrcona jako plain/text i zawiera jedynie OK. Listowanie wiadomoci Premium Jeli za jakiego powodu odbir wiadomoci si nie powiedzie, lub klient preferuje rcznie pobiera list dostpnych wiadomoci w ramach Premium API, istnieje moliwo przesania zapytania do systemu ktre zwrci list wiadomoci oczekujcych na odpowied. Przykadowe zapytanie znajduje si poniej.

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

https://api1.serwersms.pl/zdalnie/index.php?login=uzytkownik&haslo=tajnehaslo&akcja=premiu m_api&operacja=lista

W rezultacie zostanie wygenerowany dokument XML np. taki jak poniszy:


<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <SMS id="21544" na_numer="71160" z_numeru="48500600700" data="2011-09-14 14:44:55" limit="1">INT.test</SMS> <SMS id="21546" na_numer="71160" z_numeru="48600700800" data="2011-09-14 15:52:02" limit="2">PAS.premium</SMS> </SerwerSMS>

Wysyanie odpowiedzi Premium Aby wysa odpowied na okrelon wiadomo Premium naley uy jej identyfikatora. Zapytanie powinno wyglda tak: https://api1.serwersms.pl/zdalnie/index.php?login=uzytkownik&haslo=tajnehaslo&akcja=premiu m_api&operacja=wyslij_sms&idsms=21544&numer=48500600700&bramka=71160

W rezultacie zostanie wygenerowany dokument XML np. taki jak poniszy:


<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <SMS id="21544">OK</SMS> </SerwerSMS>

Lub w przypadku wystpienia bdu:


<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <Blad>komunikat bledu</Blad> </SerwerSMS>

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Sprawdzanie raportw dorcze wiadomoci


Serwer SMS oprcz wysyania wiadomoci w sposb zdalny umoliwia rwnie sprawdzenie stanu tych wiadomoci bez koniecznoci logowania si do Panelu Klienta. Kontrol poprawnoci wysania oraz stanu przesyek mona sprawdza na kilka dostpnych sposobw oraz czc je ze sob w dowolny sposb. Dodatkowo w Panelu Klienta mona ustawi opcj odpowiedzialn za przesyanie raportw dorcze bezporednio na adres URL wskazany przez Abonenta. W tej sytuacji nie ma koniecznoci aby wielokrotnie odpytywa nasz system o stan pojedynczej wiadomoci. Zamiast tego nasz system powiadomi Abonenta o tym, e wiadomo zostaa dorczona (lub z jakiego powodu nie zostaa dorczona). Wywoanie adresu Aby przy pomocy Zdalnej obsugi sprawdzi stan wiadomoci naley wywoa okrelony adres URL metod POST lub GET. Przykadowo adres w przegldarce wyglda moe nastpujco: https://api1.serwersms.pl/zdalnie/index.php?login=login&haslo=haslo&akcja=sprawdz_sms& data_od=2007-10-10%2012:15:00&data_do=2007-11-01%2012:15:00&numer=%2B48509693444 &stan=wyslane&smsid=5kf9g9ts23

Wywoanie powyszego adresu spowoduje wygenerowanie dokumentu XML z informacj na temat wiadomoci wysanej pomidzy dniem 2007-10-10 12:15:00 i 2007-11-01 12:15:00, na numer +48509693444, o ID 5kf9g9ts23 i dodatkowo stosujc filtr pokazujcy tylko wiadomoci wysane. Dostpne parametry: Parametr akcja Przykadowa warto lub format sprawdz_sms Opis Aby sprawdzi stan wiadomoci SMS naley umieci tutaj warto sprawdz_sms. Login klienta uywany do logowania si w Panelu Klienta Haso klienta uywane do logowania si w Panelu Klienta Numer lub numery telefonw oddzielane przecinkami w penym formacie tj. np. +48509693444 (w adresie URL znak + to kod %2B) Przedzia czasowy ktry ma zosta wywietlony. Jest to data i godzina kolejkowania wiadomoci do wysania lub data przeniesienia wiadomoci do niewysanych w

login haslo numer

Login Haslo %2B48509693444

data_od oraz data_do

Format: YYYY-MM-DD HH:II:SS (np. 2007-10-24 17:46:00)

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

smsid

np. Jdut76dn23 (litery oraz cyfry)

stan

wyslane, doreczone, niedoreczone, niewyslane, oczekiwanie, w trakcie wysylki, zaplanowane Parametry oznaczone pogrubieniem s obowizkowe. Pozostae s opcjonalne. Zwrot odpowiedzi Wynik wywoania powyszego adresu moe wyglda nastpujco:

przypadku wystpienia bdu Parametr ten okrela ID wiadomoci ktry zostaje nadany podczas wysyki zdalnej. Parametr ten precyzyjnie okrela jedn wiadomo. Mona jednoczenie zaczy wiksz ilo ID oddzielajc je przecinkami, wtedy zostan wywietlone informacje na temat wszystkich wybranych wiadomoci Parametr opcjonalny, filtruje wywietlane wiadomoci wg. stanu wysyki

<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <SMS id="d7e9cfb937" numer="+48509693444" tresc="Test Serwer SMS" stan="Doreczono" godzina_skolejkowania="2007-10-30 15:03:31" godzina_wyslania="2007-10-30 15:03:35" godzina_doreczenia="2007-10-30 15:03:39"/> <SMS id="06fcafceb1" numer="+48509693444" tresc="Test Serwera SMS" stan="W trakcie wysylki" godzina_skolejkowania="2007-10-31 13:04:20"/> <SMS id="5ughqbvc22" numer="+48000693444" tresc="Wiadomosc z blednym numerem" stan="Niewyslano" godzina_skolejkowania="2007-09-21 10:20:14" przyczyna="Nie ma takiego numeru lub bledna odpowiedz sieci"/> <SMS id="d9sf8jckj" numer="+48500693440" tresc="tresc informacji" stan="Niedoreczono" godzina_skolejkowania="2007-09-29 10:21:00" godzina_wyslania="2007-09-29 10:21:02" godzina_niedoreczenia="2007-09-30 12:00:20"/> </SerwerSMS>

W powyszym przykadzie Serwer SMS zwrci informacje o czterech wiadomociach z ktrych jedna zostaa wysana, jedna oczekuje na wysanie, jednej nie udao si wysa z powodu bdnego numeru odbiorcy a jedna zostaa wysana ale nie zostaa dorczona. Objanienie poszczeglnych sekcji XML:
Znacznik XML <SMS id="ID" numer="NUM"

Opis Zawiera wszystkie informacje na temat danej wiadomoci SMS oraz unikalny numer (ID) Zawiera numer odbiorcy w penym formacie z

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

tresc="TRESC" stan="STAN"

godzina_skolejkowania="GODZ"

godzina_wyslania="GODZ" godzina_doreczenia="GODZ"

przyczyna="POWOD"

godzina_niedoreczenia="GODZ"

numerem kierunkowym kraju na pocztku Zawiera poprawnie skolejkowane wiadomoci SMS ktre zostan wysane w najbliszym czasie Zawiera informacje na temat stanu wysyki wiadomoci. Pole to moe przyjmowa nastpujce wartoci: Doreczono, Niedoreczono, Niewyslano, Oczekiwanie, W trakcie wysylki, Zaplanowano Data oraz godzina przyjcia wiadomoci SMS do systemu (data wywoania). W przypadku gdy wysyka SMS zostaa zaplanowana na okrelony termin, widnieje tutaj godzina kiedy SMS zostanie wysany. Data oraz godzina wysania wiadomoci SMS do odbiorcy Data oraz godzina dorczenia wiadomoci do odbiorcy. Informacja ta wywietla si w przypadku gdy wiadomo posiada status oczekujcy bd zostaa dorczona. Jeli wiadomo nie zostanie dorczona, informacja ta nie pojawi si. Wystpuje tylko w przypadku nieudanego wysania i informuje z jakiego powodu wiadomo SMS nie zostaa wysana Data ostatniej zmiany statusu wiadomoci w przypadku gdy wiadomo nie zostaa dorczona do adresata. Wywietlona zostanie jedynie w sytuacji gdy wiadomo nie zostaa dorczona w okrelonym czasie do adresata.

Okrelanie adresu URL Abonenta na ktry maj by wysyane raporty dorcze. Odpowiednie opcje dostpne s w Panelu Klienta i wymagaj jednorazowej konfiguracji. Aby informacje na temat byy przesyane do Abonenta naley zaznaczy ustawienia jak na poniszym obrazku oraz poda swj wasny adres URL w ktrym znajd si takie parametry jak #STAN#, #DATA#, #PRZYCZYNA# oraz #RAPORT#.

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Rysunek 1. Opcje dodatkowe dotyczce przekazywania raportw dorcze na wskazany adres URL Abonenta

Przed wysaniem informacji do klienta, parametry te s podmieniane z danymi dotyczcymi okrelonej wiadomoci SMS. System sprawdza, czy w odpowiedzi strona klienta zwraca odpowied o treci OK. Jeli system nie wykryje takiej odpowiedzi, wysanie raportu zostanie ponowione po 5, 15, 60 minutach a nastpnie po 24 godzinach. Jeli wci strona klienta nie zwrci odpowiedzi o treci OK, Serwer SMS przestanie wysya informacj dotyczc raportu dorczenia. Informacje o raportach dorcze przesyane s metod GET. Przesyane parametry w adresie URL: Parametr Przykadowa warto lub format #STAN# Doreczono, Niedoreczono, Niewyslano, Oczekiwanie

Opis Warto ta okrela czy przekazana do wysyki wiadomo zostaa wysana, a jeli tak to czy zostaa dorczona. Data zmiany statusu wiadomoci, gdy zostaa dorczona, wrci raport niedorczenia lub gdy wiadomo zostaa przekazana do niewysanych. Cig alfanumeryczny jednoznacznie okrelajcy pojedyncz wiadomo W parametrze tym przekazywana jest bardziej szczegowa informacja na temat niedorczenia lub niewysania wiadomoci. Jest ona wypeniona jedynie w przypadku gdy wiadomo zostaa niedorczona lub niewysana.

#DATA#

Np: 2009-10-21 14:23:28

#SMSID#

Np. 8dfa7tvc44s

#PRZYCZYNA#

Tekstowy opis z przyczyn wystpienia bdu np. Bdny numer nadawcy

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Usuwanie zaplanowanych na okrelony termin wysyek


W przypadku skorzystania z wysyki w okrelonym terminie (parametr data_wysylki przy zgaszaniu wysyania wiadomoci) istnieje moliwo usunicia takich powiadomie odwoujc si do okrelonego SMSID/USMSID. Wywoanie adresu Aby przy pomocy zdalnej obsugi pobra odpowiedzi na wiadomoci naley wywoa okrelony adres URL metod POST lub GET. Przykadowo adres w przegldarce wyglda moe nastpujco: https://api1.serwersms.pl/zdalnie/index.php?login=login&haslo=haslo&akcja=usun_zaplanowane &smsid=89df6g875sf

Dostpne parametry: Parametr akcja Przykadowa warto lub format usun_zaplanowane Opis

Aby sprawdzi stan wiadomoci naley umieci tutaj warto sprawdz_odpowiedzi. login Login Login klienta uywany do logowania si w Panelu Klienta haslo Haslo Haso klienta uywane do logowania si w Panelu Klienta smsid 111065e43c Znaczniki SMSID wybranych wiadomoci Parametry oznaczone pogrubieniem s obowizkowe. Pozostae s opcjonalne. Zwrot odpowiedzi Wywoanie powyszego adresu moe wygenerowa np. tak odpowied:
<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <ZAPLANOWANE smsid="025701861e">OK</ZAPLANOWANE> <ZAPLANOWANE smsid="SD8F7G7DSF">OK</ZAPLANOWANE> </SerwerSMS>

Objanienie poszczeglnych sekcji XML:


Znacznik XML <ZAPLANOWANE smsid="SMSID">STAN</ZAPLANOWANE>

Opis Zawiera identyfikator wiadomoci SMSID oraz stan usuwania. Stan to w zalenoci od wyniku OK jeli wszystko przebiego poprawnie, ERR jeli

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

nie znaleziono wybranego znacznika SMSID.

Sprawdzanie i pobieranie odpowiedzi oraz innych wiadomoci przychodzcych


Kolejn funkcj dostpn dziki zdalnemu dostpowi jest moliwo pobierania odpowiedzi nadesanych od odbiorcw klienta, wiadomoci SMS nadesanych w ramach usugi numer dostpowy oraz numer dostpowy indywidualny. Wiadomoci nie s na chwil obecn w aden sposb rozrniane i listowane s najpierw odpowiedzi SMS, nastpnie wiadomoci z numeru dostpowego a na samym dole wiadomoci z numeru dostpowego indywidualnego. Wywoanie adresu (pobieranie wiadomoci SMS) Aby przy pomocy zdalnej obsugi pobra odpowiedzi na wiadomoci oraz inne wiadomoci przychodzce naley wywoa okrelony adres URL metod POST lub GET. Przykadowo adres w przegldarce wyglda moe nastpujco: https://api1.serwersms.pl/zdalnie/index.php?login=login&haslo=haslo&akcja=sprawdz_odpowied zi&data_od=2007-08-26%2013:53&data_do=2007-10-30%2022:05&numer=%2B48509693444, %2B48509693455&typ=1

Dostpne parametry: Parametr akcja Przykadowa warto lub format sprawdz_odpowiedzi Opis Aby sprawdzi stan wiadomoci SMS naley umieci tutaj warto sprawdz_odpowiedzi. Login klienta uywany do logowania si w Panelu Klienta Haso klienta uywane do logowania si w Panelu Klienta Numer lub numery telefonw oddzielane przecinkami w penym formacie tj. np. +48509693444 (w adresie URL znak + to kod %2B) Przedzia czasowy ktry ma zosta wywietlony. Jest to data i godzina wysania wiadomoci przez nadawc Typ wiadomoci jakie maj by wywietlone. Jeli parametr pozostanie pusty, zwrcone zostan wiadomoci przychodzce z wszystkich kategorii.

login haslo numer

Login Haslo %2B48509693444

data_od oraz data_do

Format: YYYY-MM-DD HH:II:SS (np. 2007-10-24 17:46:00) 1 odpowiedzi SMS 2 SMSy z numeru dostpowego 3 SMSy z numeru dostpowego

typ

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

ndi

Parametr opcjonalny pozwalajcy na odfiltrowanie tych wiadomoci przychodzcych ktre trafiy na okrelony numer NDI (jeli np. klient dysponuje kilkoma numerami na jednym koncie) Parametry oznaczone pogrubieniem s obowizkowe. Pozostae s opcjonalne. Zwrot odpowiedzi Wywoanie powyszego adresu moe wygenerowa np. tak odpowied:
<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <SMS numer="+48509693444" data="2007-09-26 10:59:36" tresc="Przyjade o 16. "/> <SMS numer="+48509693444" data="2007-09-26 11:20:00" tresc="Bede wczesniej"/> <SMS numer="+48509693444" data="2007-10-27 12:55:09" tresc="Dzieki za informacje"/> <MMS numer="+48500058777" data="2011-06-27 13:31:49" temat="jakis fajny temat :)"> <Zalacznik id="764" nazwa="text_0002.txt" contenttype="text/plain"> SmFrYXMgdGFtIGplc3pjemUgd2lhZGFvbW9zYw== </Zalacznik> </SerwerSMS>

indywidualnego 4 SMSy z Premium SMS 5 Odbir MMS Numer NDI w formacie +48500600700

Objanienie poszczeglnych sekcji XML:


Znacznik XML <SMS numer="NUM" tresc="TRESC"/>

data="DATA"

Opis Zawiera numer nadawcy wiadomoci SMS (NUM), dat (DATA) oraz tre wiadomoci SMS (TRESC)

Wywoanie adresu (pobieranie wiadomoci MMS) Do odbioru wiadomoci MMS niezbdne jest posiadanie dedykowanego numeru. Szczegy w ofercie na stronie www.serwersms.pl. Aby przy pomocy zdalnej obsugi pobra odebrane wiadomoci MMS naley wywoa okrelony adres URL metod POST lub GET. Przykadowo adres w przegldarce wyglda moe nastpujco: https://api1.serwersms.pl/zdalnie/index.php?login=login&haslo=haslo&akcja=pobierz_mms&data _od=2007-08-26%2013:53&data_do=2007-10-30%2022:05&numer=%2B48509693444

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Dostpne parametry: Parametr akcja Przykadowa warto lub format sprawdz_odpowiedzi Opis

Aby sprawdzi stan wiadomoci SMS naley umieci tutaj warto sprawdz_odpowiedzi. login Login Login klienta uywany do logowania si w Panelu Klienta haslo Haslo Haso klienta uywane do logowania si w Panelu Klienta numer %2B48509693444 Numer lub numery telefonw oddzielane przecinkami w penym formacie tj. np. +48509693444 (w adresie URL znak + to kod %2B) data_od oraz data_do Format: YYYY-MM-DD Przedzia czasowy ktry ma zosta HH:II:SS wywietlony. Jest to data i godzina (np. 2007-10-24 17:46:00) wysania wiadomoci przez nadawc Parametry oznaczone pogrubieniem s obowizkowe. Pozostae s opcjonalne. Zwrot odpowiedzi Wywoanie powyszego adresu moe wygenerowa np. tak odpowied:
<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <MMS numer="+48500600700" data="2010-03-22 13:59:40"> <Zalacznik id="1249" nazwa="obrazek.jpg" contenttype="image/jpeg"> /9j/4QD0RXhpZgAATU0AKgAAAAgACQEPAAIAAA () </Zalacznik> <Zalacznik id="1248" nazwa="01smil" contenttype="application/smil"> PHNtaWw+DQo8aGVhZD4NCjxsYXlvdXQ () </Zalacznik> </MMS> </SerwerSMS>

Objanienie poszczeglnych sekcji XML:


Znacznik XML <MMS numer="NUM" data="DATA"> <Zalacznik id="ID" nazwa="NAZWA" contenttype="CT"> DANE </Zalacznik> (...) </MMS>

Opis Zawiera numer nadawcy wiadomoci MMS (NUM), dat (DATA) oraz zaczniki zawarte w tagu Zalacznik. Mieci si tam identyfikator zacznika (ID), nazwa pliku (NAZWA), Contenttype (CT) oraz dane zakodowane w base64 (DANE)

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Okrelanie adresu URL Abonenta na ktry maj by wysyane wiadomoci przychodzce (odpowiedzi na SMS Eco). Odpowiednie opcje dostpne s w Panelu Klienta i wymagaj jedynie jednorazowej konfiguracji. Aby informacje na temat byy przesyane do Abonenta naley zaznaczy ustawienia jak na poniszym obrazku oraz poda swj wasny adres URL w ktrym znajd si takie parametry jak #WIADOMOSC#, #DATA# oraz #NUMER#.

Rysunek 2. Opcje dodatkowe dotyczce przekazywania odpowiedzi na SMS Eco na wskazany adres URL Abonenta

Przed wysaniem informacji do klienta, parametry te s podmieniane z danymi dotyczcymi okrelonej wiadomoci SMS. System wysya informacj jedynie jeden raz i nie sprawdza treci i poprawnoci odpowiedzi zwrotnej. Jeli z jakich wzgldw wiadomo nie zostanie prawidowo przesana, w kadej chwili mona pobra list nowych wiadomoci za porednictwem zapytania przez WebAPI. Serwer SMS przestanie wysya informacj dotyczc odpowiedzi na SMS Eco. Informacje o odpowiedziach na SMS Eco przesyane s metod GET. Przesyane parametry w adresie URL: Parametr Przykadowa warto lub format #WIADOMOSC# Tre wiadomoci

Opis Warto ta okrela tre wiadomoci przychodzcej zakodowanej w ten sposb aby byo moliwe przesanie jej w adresie URL metod GET Data i godzina wysania wiadomoci przez nadawc SMSa. Numer telefonu w formacie +48509693444 (przesyane jako %2B48509693444)

#DATA# #NUMER#

Np: 2009-10-21 14:23:28 Np. +48509693444

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Sprawdzanie iloci dostpnych wiadomoci do wysania


W przypadku kont z ograniczeniami dotyczcymi iloci wysyanych wiadomoci, klient moe sam sprawdzi ile wiadomoci pozostao jeszcze do wysania. W ten sposb mona kontrolowa stan dostpnego kredytu do wysania i w razie koniecznoci doadowa wczeniej konto. Wywoanie adresu Aby przy pomocy zdalnej obsugi pobra aktualn ilo dostpnych wiadomoci naley wywoa okrelony adres URL metod POST lub GET. Przykadowo adres w przegldarce wyglda moe nastpujco: https://api1.serwersms.pl/zdalnie/index.php?login=login&haslo=haslo&akcja=ilosc_sms

Dostpne parametry: Parametr akcja Przykadowa warto lub format ilosc_sms Opis

Aby sprawdzi ilo dostpnych wiadomoci naley umieci tutaj warto ilosc_sms. login Login Login klienta uywany do logowania si w Panelu Klienta haslo Haslo Haso klienta uywane do logowania si w Panelu Klienta Parametry oznaczone pogrubieniem s obowizkowe. Pozostae s opcjonalne. Zwrot odpowiedzi Wywoanie powyszego adresu moe wygenerowa np. tak odpowied:
<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <SMS typ="ECO">brak limitu</SMS> <SMS typ="FULL">2345</SMS> </SerwerSMS>

Objanienie poszczeglnych sekcji XML:


Znacznik XML <SMS typ="TYP">ILOSC</SMS>

Opis Parametr TYP okrela czy podana dalej ilo SMS dotyczy wiadomoci SMS Eco czy Full. ILOSC mwi klientowi ile wiadomoci danego typu mona jeszcze wysa. Jeli klient nie posiada adnych limitw, wtedy parametr ten przybiera warto brak limitu.

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Autoryzacja nazwy nadawcy


Wiadomoci typu Full SMS pozwalaj na uycie w nagwku SMSa wasnego tekstu lub numeru (zainstalowanego na platformie Serwer SMS). Ze wzgldu na zmiany prawne, uycie wasnej nazwy nadawcy jako tekst (np. nazwa firmy) wymaga dodatkowej autoryzacji. W kadym momencie mona wylistowa dodane do systemu nazwy nadawcy i sprawdzi ich status autoryzacji. Wywoanie adresu Aby przy pomocy zdalnej obsugi zgosi now nazw do autoryzacji naley wywoa okrelony adres URL metod POST lub GET. Przykadowo adres w przegldarce wyglda moe nastpujco: https://api1.serwersms.pl/zdalnie/index.php?login=login&haslo=haslo&akcja=nazwa_nadawcy &operacja=dodanie&nazwa= SerwerSMS

Dostpne parametry: Parametr akcja Przykadowa warto lub format nazwa_nadawcy Opis

Aby zgosi nowy numer do weryfikacji naley umieci tutaj warto nazwa_nadawcy. login Login Login klienta uywany do logowania si w Panelu Klienta haslo Haslo Haso klienta uywane do logowania si w Panelu Klienta operacja dodanie Warto taka powinna zosta uyta aby doda now nazw nadawcy do weryfikacji nazwa Konkurs, SerwerSMS itp. Alfanumeryczna nazwa nadawcy (max 11 znakw). Parametry oznaczone pogrubieniem s obowizkowe. Pozostae s opcjonalne. Zwrot odpowiedzi Wywoanie powyszego adresu moe wygenerowa np. tak odpowied:
<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <NADAWCA nazwa="SerwerSMS">Dopisano</NADAWCA> </SerwerSMS>

Objanienie poszczeglnych sekcji XML:


Znacznik XML <NADAWCA

Opis Parametr NAZWA okrela jaka nazwa jest

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

nazwa="NAZWA">INFO</NADAWCA>

przetwarzana natomiast parametr INFO okrela komunikat zwrotny. Jeli wystpi jaki bd, w parametrze INFO pojawi si odpowiedni komunikat.

Dostpne parametry: Parametr akcja Przykadowa warto lub format nazwa_nadawcy Opis

Aby zgosi nowy numer do weryfikacji naley umieci tutaj warto nazwa_nadawcy. login Login Login klienta uywany do logowania si w Panelu Klienta haslo Haslo Haso klienta uywane do logowania si w Panelu Klienta operacja weryfikacja Warto taka powinna zosta uyta aby zweryfikowa numer numer %2B48509693444 Numer telefonu w formacie midzynarodowym, z plusem zakodowanym jako %2B. kod 7sd6f56s6f Jednorazowy kod alfanumeryczny ktry zostanie odesany na weryfikowany numer telefonu Parametry oznaczone pogrubieniem s obowizkowe. Pozostae s opcjonalne. Listowanie nazw nadawcy oraz ich statusw Wywoanie adresu Aby przy pomocy zdalnej obsugi zweryfikowa przesany wczeniej nowy numer nadawcy naley wywoa okrelony adres URL metod POST lub GET. Przykadowo adres w przegldarce wyglda moe nastpujco: https://api1.serwersms.pl/zdalnie/index.php?login=login&haslo=haslo&akcja=nazwa_nadawcy&o peracja=lista

Dostpne parametry: Parametr akcja Przykadowa warto lub format nazwa_nadawcy Opis Aby zgosi nowy numer do weryfikacji naley umieci tutaj warto nazwa_nadawcy. Login klienta uywany do logowania si w Panelu Klienta

login

Login

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

haslo

Haso klienta uywane do logowania si w Panelu Klienta operacja Lista Warto taka powinna zosta uyta aby wywietli zapisane w systemie nazwy nadawcy predefiniowane 1 lub 0 Nieobowizkowy parametr umoliwiajcy wywietlenie predefiniowanych w systemie nazw nadawcy gotowych do uycia w wysyce SMS. Parametry oznaczone pogrubieniem s obowizkowe. Pozostae s opcjonalne. Zwrot odpowiedzi Wywoanie powyszego adresu moe wygenerowa np. tak odpowied:
<?xml version="1.0" encoding="UTF-8"?> <SerwerSMS login="login"> <NADAWCA nazwa="Testowa">Oczekuje na autoryzacje</NADAWCA> <NADAWCA nazwa="Serwer SMS">Autoryzowano</NADAWCA> <NADAWCA nazwa="+48783820099">Autoryzowano</NADAWCA> <NADAWCA nazwa="Era">Odrzucono: Uzywanie nazw wlasnych Operatorow GSM jest zabronione</NADAWCA> </SerwerSMS>

Haslo

Objanienie poszczeglnych sekcji XML:


Znacznik XML <NADAWCA nazwa="NAZWA">INFO</NADAWCA>

Opis Parametr NAZWA okrela jaka nazwa lub numer jest przetwarzany natomiast parametr INFO okrela komunikat zwrotny. Jeli wystpi jaki bd, w parametrze INFO pojawi si odpowiedni komunikat.

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Historia zmian
Wersja 3.9 2012-01-16 - dodano moliwo przekazywania wasnych identyfikatorw wiadomoci usmsid - moliwo wysyania kilku plikw w jednej wiadomoci MMS Wersja 3.8 2011-09-26 - obsuga wiadomoci Premium SMS (odbieranie wiadomoci, listowanie i wysyanie odpowiedzi) Wersja 3.7 2011-09-06 - udostpniona moliwo odbioru MMS - upload plikw WAV oraz moliwo wysyki SMS Voice z uyciem plikw WAV Wersja 3.6 2011-04-16 - udostpniona moliwo wysyki MMS Wersja 3.5 2010-12-31 - moliwo zdefiniowania wasnego identyfikatora wiadomoci USMSID a nastpnie odpytywanie systemu oraz odbieranie raportu wg przesanego identyfikatora. - wsparcie dla predefiniowanych nazw nadawcy (listowanie dostpnych oraz wysyka SMS) Wersja 3.4 2010-11-09 - moliwo zdefiniowania terminu wysyki SMS przy zgoszeniu przez API - wsparcie dla wielu numerw NDI Wersja 3.3 2010-07-26 - weryfikacja nazwy nadawcy (numer lub tekst) Wersja 3.2 2010-06-23 - udostpniona moliwo wysyania wizytwek Vcard w SMS Full - udostpniona moliwo wysyania Speed SMS w SMS Full Wersja 3.1 2010-02-04 - udostpniona moliwo weryfikacji numeru nadawcy (9-cio cyfrowy numer stacjonarny lub GSM) ktry moe zosta pniej uyty w wysyce SMS Full Wersja 3.0 2009-10-21 - udostpniona moliwo wysyania raportw dorczenia na wskazany adres URL - poprawiona integracja przesyania odpowiedzi SMS na wskazany adres URL - uaktualniona dokumentacja Wersja 2.6 2009-09-09 - uaktualnione informacje na temat przesyania zapyta metod POST oraz GET - uaktualnione informacje na temat tego jak wysa SMS Eco a jak SMS Full Wersja 2.5 2009-07-08 - dodano moliwo filtrowania wiadomoci przychodzcych (Odpowiedzi SMS, numer dostpowy, numer dostpowy indywidualny i Premium SMS)

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Wersja 2.4 2009-06-24 - dodano moliwo wysyania wiadomoci SMS Gosowych przez WebAPI - poprawiono obsug dat raportw dorcze, synchronizacja z operatorem - poprawiono opisy dotyczce sprawdzania statusw raportw wiadomoci Wersja 2.3 2009-05-21 - dodano moliwo korzystania z WebAPI przez uytkownikw konta gwnego (subkonta). - poprawiono wydajno WebAPI oraz kilka mniejszych bdw Wersja 2.2 2009-01-19 - dodano funkcjonalno pozwalajc sprawdzi ile wiadomoci SMS mona jeszcze wysa (np. w przypadku ogranicze pakietw jednorazowych oraz testowych). Wersja 2.1 2009-01-13 - dodana informacja w dokumentacji na temat maksymalnej wielkoci pojedynczego zgoszenia (10.000 SMS) w celu wysania SMS przez WebAPI. Wersja 2.0 2008-12-01 - na licie wiadomoci odebranych widoczne s rwnie wiadomoci odebrane w ramach usugi numer dostpowy oraz numer dostpowy indywidualny. Wersja 1.9 2008-11-03 - poprawiony bd zwizany z etykiet w przypadku sprawdzania statusu wiadomoci i niedorczenia wiadomoci. Wersja 1.8 2008-09-19 - dodano obsug polskich znakw specjalnych w Zdalnej obsudze przez WebAPI. Wersja 1.7 2008-08-22 - dodano funkcj spersonalizowany SMS w Zdalnej obsudze przez WebAPI. Wersja 1.6 2008-08-08 - dodano moliwo testowania Zdalnej obsugi WebAPI bez koniecznoci posiadania konta w Serwer SMS. Wersja 1.5 2008-07-15 - dodano obsug numeru nadawcy z Serwer SMS (obsuga odpowiedzi SMS) - dodano parametr godzina_skolejkowania w zwracanym dokumencie XML przy wysyaniu wiadomoci - poprawiono obsug identyfikatorw smsid Wersja 1.4 2008-07-02 - dodano opcj test - dodano moliwo wysyania wiadomoci z wasnym polem nadawcy - dodano moliwo wysyania wiadomoci typu WAP Push Wersja 1.3 2008-03-17 - dodana obsuga Flash SMS

Interfejs Zdalnej Obsugi przy pomocy protokou HTTP


www.serwersms.pl | email: biuro@serwersms.pl | BOK: +48 (032) 750 00 01 | FAX: +48 (032) 750 00 03 ________________________________________________________________________________________

Wersja 1.2 2008-02-21 - poprawiono kilka zauwaonych bdw w opisach - uaktualniono cz opisw zwracanych dokumentw XML Wersja 1.1 2007-01-07 - zmiana skadni zwracanego dokumentu XML. Poszczeglne sekcje atwiej teraz analizowa gdy s bardziej zwarte i przejrzyste - rozwizanych kilka problemw z kodowaniem dokumentw XML - uaktualniona i poprawiona dokumentacja zdalnej obsugi Wersja 1.0 - 2007-10-31 - Pierwsza odsona nowej wersji zdalnej obsugi

You might also like