Jeśli chcesz wykorzystać SMSEagle do wysyłania/odbioru SMS z posiadanych aplikacji lub systemów, skorzystaj z dostępnego na urządzeniach SMSEagle interfejsu API.

W celu szybszego startu i ułatwienia korzystania z API  przygotowaliśmy przykłady kodów źródłowych, które można wykorzystać do własnych celów. W celu zapoznania się z bardziej szczegółową dokumentacją prosimy pobrać Podręcznik użytkownika.

Wyślij SMS: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/send_sms

Przykłady:
https://url-of-smseagle/index.php/http_api/send_sms?login=john&pass=doe&to=1234567&message=mymessage
lub
https://url-of-smseagle/index.php/http_api/send_sms?login=john&pass=doe&to=1234567&message=mymessage&date=201401152132
lub
https://url-of-smseagle/index.php/http_api/send_sms?login=john&pass=doe&to=1234567&message=mymessage&highpriority=1

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
to numer telefonu odbiorcy (lub numery rozdzielone przecinkami)
message wiadomość SMS
date (parametr opcjonalny)  data i czas w formacie YYYYmmDDHHMM (YYYY – rok, mm – miesiąc, DD – dzień, HH – godzina, MM – minuta). Jeśli parametr został podany, wiadomość SMS zostanie zapisana w kolejce do wysłania w podanym dniu i godzinie
highpriority (parametr opcjonalny)  0 = priorytet normalny, 1 = SMS będzie mieć wyższy priorytet w kolejce wiadomości wychodzących
unicode (parametr opcjonalny)  0 = bez kodowania unicode (wart. domyślna), 1 = SMS będzie zakodowany za pomocą unicode
flash (parametr opcjonalny)  0 = normalny SMS (wart. domyślna), 1 = SMS zostanie wysłany jako wiadomość flash
oid (parametr opcjonalny)  Ten atrybut określa unikatowy identyfikator zdefiniowany przez użytkownika przypisany do pary wiadomość-odbiorca. Oid jest typem varchar (36), który jednoznacznie identyfikuje wiadomość wysłaną do danego odbiorcy (konkretnego numer telefonu).
Wartość tego identyfikatora umożliwia aplikacjom klienckim dopasowanie wiadomości przychodzących do wiadomości wychodzących. Jeśli do wiadomości wychodzącej nie przypisano żadnego identyfikatora oid, ten atrybut będzie miał wartość null dla wiadomości przychodzącej. Wartość oid zostanie automatycznie przypisana do wiadomości przychodzącej tylko wtedy, gdy przychodzący numer telefonu pasuje dokładnie do numeru telefonu (w tym kodu kraju) z wiadomości wychodzącej.
modem_no (parametr opcjonalny)  numer modemu (tylko w urządzeniach wielomodemowych)
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML

Odpowiedź:
Odpowiedź: OK; ID=[ID wiadomości z folderu Outbox]
Przykład odpowiedzi: OK; ID=297
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach): Wrong parameters

Odpowiedź (XML):
Odpowiedź:
<xml>
<message_id>[ID wiadomości z folderu Outbox]</message_id>
<status>ok</status>
</xml>

Przykład odpowiedzi:
<xml>
<message_id>297</message_id>
<status>ok</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Uwaga: Adres url powinien być poddany operacji enkodowania (urlencode) jeśli w treści treści wiadomości SMS zostały użyte znaki narodowe.

Wyślij SMS: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”sms.send_sms”, „params”:{„login”:”john”,”pass”:”doe”,”to”:”481234567″,”message”:”My message”}}
lub
{„method”:”sms.send_sms”, „params”:{„login”:”john”,”pass”:”doe”,”to”:”481234567″,”message”:”My message”,”date”:”201401152132″}}
lub
{„method”:”sms.send_sms”, „params”:{„login”:”john”,”pass”:”doe”,”to”:”481234567″,”message”:”My message”,”highpriority”:”1″}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
to numer telefonu odbiorcy (lub numery rozdzielone przecinkami)
message wiadomość SMS
date (parametr opcjonalny)  data i czas w formacie YYYYmmDDHHMM (YYYY – rok, mm – miesiąc, DD – dzień, HH – godzina, MM – minuta). Jeśli parametr został podany, wiadomość SMS zostanie zapisana w kolejce do wysłania w podanym dniu i godzinie
highpriority (parametr opcjonalny)  0 = priorytet normalny, 1 = SMS będzie mieć wyższy priorytet w kolejce wiadomości wychodzących
unicode (parametr opcjonalny)  0 = bez kodowania unicode (wart. domyślna), 1 = SMS będzie zakodowany za pomocą unicode
flash (parametr opcjonalny)  0 = normalny SMS (wart. domyślna), 1 = SMS zostanie wysłany jako wiadomość flash
modem_no (parametr opcjonalny)  numer modemu (tylko w urządzeniach wielomodemowych)
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON
Odpowiedź:
Odpowiedź: {„result”: „OK; ID=[ID wiadomości z folderu Outbox]”}
Przykład odpowiedzi: {„result”: „OK; ID=297”}
Odpowiedź: {„result”: „Invalid login or password”}
Odpowiedź: {„result”: „Wrong parameters”}

Odpowiedź (extended):
Odpowiedź:{„result”:{„message_id”:”[ID ofmessage in outbox]”,”status”:”ok”}}
Przykład odpowiedzi:{„result”:{„message_id”:”748″,”status”:”ok”}}
Przykład odpowiedzi jeżeli parametr „to” zawiera wiele numerów telefonów:
{„result”:[{„message_id”:”3643″,”status”:”ok”},{„message_id”:”3644″,”status”:”ok”},{„message_id”:”3645″,”status”:”ok”},{„message_id”:”3646″,”status”:”ok”},{„message_id”:”3647″,”status”:”ok”}]}
Odpowiedź (przy błędnej autoryzacji):{„result”:{„error_text”:”Invalid login or password”,”status”:”error”}}
Odpowiedź (przy błędnych parametrach):{„result”:{„error_text”:”Wrong parameters”,”status”:”error”}}


Uwaga: Adres url powinien być poddany operacji enkodowania (urlencode) jeśli w treści treści wiadomości SMS zostały użyte znaki narodowe.

Wyślij SMS do grupy: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/send_togroup

Przykłady:
https://url-of-smseagle/index.php/http_api/send_togroup?login=john&pass=doe&groupname=admins&message=mymessage
lub
https://url-of-smseagle/index.php/http_api/send_togroup?login=john&pass=doe&groupname=admins&message=mymessage&date=201401152132
lub
https://url-of-smseagle/index.php/http_api/send_togroup?login=john&pass=doe&groupname=admins&message=mymessage&highpriority=1

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
groupname nazwa grupy zdefiniowana w Książce adresowej urządzenia. Grupa musi być zdefinowana jako Publiczna
message wiadomość SMS
date (parametr opcjonalny)  data i czas w formacie YYYYmmDDHHMM (YYYY – rok, mm – miesiąc, DD – dzień, HH – godzina, MM – minuta). Jeśli parametr został podany, wiadomość SMS zostanie zapisana w kolejce do wysłania w podanym dniu i godzinie
highpriority (parametr opcjonalny)  0 = priorytet normalny, 1 = SMS będzie mieć wyższy priorytet w kolejce wiadomości wychodzących
unicode (parametr opcjonalny)  0 = bez kodowania unicode (wart. domyślna), 1 = SMS będzie zakodowany za pomocą unicode
flash (parametr opcjonalny)  0 = normalny SMS (wart. domyślna), 1 = SMS zostanie wysłany jako wiadomość flash
modem_no (parametr opcjonalny)  numer modemu (tylko w urządzeniach wielomodemowych)
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML
Odpowiedź:
Odpowiedź: OK; ID=[ID wiadomości z folderu Outbox]
Przykład odpowiedzi: OK; ID=297
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach): Wrong parameters
Odpowiedź (XML):

Odpowiedź:
<xml>
<message_id>[ID wiadomości z folderu Outbox]</message_id>
<status>ok</status>
</xml>

Przykład odpowiedzi:
<xml>
<message_id>297</message_id>
<status>ok</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Uwaga: Adres url powinien być poddany operacji enkodowania (urlencode) jeśli w treści treści wiadomości SMS zostały użyte znaki narodowe.

Wyślij SMS do grupy: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”sms.send_togroup”, „params”:{„login”:”john”,”pass”:”doe”,”groupname”:”admins”,”message”:”mymessage”}}
lub
{„method”:”sms.send_togroup”, „params”:{„login”:”john”,”pass”:”doe”,”groupname”:”admins”,”message”:”mymessage”,”date”:”201401152132″}}
lub
{„method”:”sms.send_togroup”, „params”:{„login”:”john”,”pass”:”doe”,”groupname”:”admins”,”message”:”mymessage”,”highpriority”:”1″}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
groupname nazwa grupy zdefiniowana w Książce adresowej urządzenia. Grupa musi być zdefinowana jako Publiczna
message wiadomość SMS
date (parametr opcjonalny)  data i czas w formacie YYYYmmDDHHMM (YYYY – rok, mm – miesiąc, DD – dzień, HH – godzina, MM – minuta). Jeśli parametr został podany, wiadomość SMS zostanie zapisana w kolejce do wysłania w podanym dniu i godzinie
highpriority (parametr opcjonalny)  0 = priorytet normalny, 1 = SMS będzie mieć wyższy priorytet w kolejce wiadomości wychodzących
unicode (parametr opcjonalny)  0 = bez kodowania unicode (wart. domyślna), 1 = SMS będzie zakodowany za pomocą unicode
flash (parametr opcjonalny)  0 = normalny SMS (wart. domyślna), 1 = SMS zostanie wysłany jako wiadomość flash
modem_no (parametr opcjonalny)  numer modemu (tylko w urządzeniach wielomodemowych)
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON
Odpowiedź:
Odpowiedź: {„result”: „OK; ID=[ID wiadomości z folderu Outbox]”}
Przykład odpowiedzi: {„result”: „OK; ID=[297]”}
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}
Odpowiedź (przy błędnych parametrach): {„result”: „Wrong parameters”}
Odpowiedź (Extended):
Odpowiedź: {„result”:{„message_id”:”[ID wiadomości z folderu Outbox]”,”status”:”ok”}}
Przykład odpowiedzi: {„result”:{„message_id”:”748″,”status”:”ok”}}
Odpowiedź (przy błędnej autoryzacji): {„result”:{„error_text”:”Invalid login or password”,”status”:”error”}}
Odpowiedź (przy błędnych parametrach):{„result”:{„error_text”:”Wrong parameters”,”status”:”error”}}


Uwaga: Adres url powinien być poddany operacji enkodowania (urlencode) jeśli w treści treści wiadomości SMS zostały użyte znaki narodowe.

Wyślij SMS binarny: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/send_binary_sms

Przykład:
https://url-of-smseagle/index.php/http_api/send_binary_sms?login=john&pass=doe&to=1234567&udh=0605040B8423F0&data=EA0601AE02056A0045C60C037777772E736D736561676C652E657500080103534D534561676C65000101

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
to numer telefonu odbiorcy (lub numery rozdzielone przecinkami)
udh (parametr opcjonalny)  nagłówek UDH (w formacie HEX)
data wiadomość binarna (w formacie HEX)
class (parametr opcjonalny)  klasa wiadomości
modem_no (parametr opcjonalny)  numer modemu (tylko w urządzeniach wielomodemowych)
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML
Odpowiedź:
Odpowiedź: OK; ID=[ID wiadomości z folderu Outbox]
Przykład odpowiedzi: OK; ID=297
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach): Wrong or missing >>udh<< parameter
Odpowiedź (przy błędnych parametrach): Wrong or missing >>data<< parameter

Odpowiedź (XML):
Odpowiedź:
<xml>
<message_id>[ID wiadomości z folderu Outbox]</message_id>
<status>ok</status>
</xml>

Przykład odpowiedzi:
<xml>
<message_id>297</message_id>
<status>ok</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text> Wrong or missing >>udh<< parameter </error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text> Wrong or missing >>data<< parameter </error_text>
<status>error</status>
</xml>

Wyślij SMS binarny: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”sms.send_binary_sms”, „params”:{„login”:”john”,”pass”:”doe”,”to”:”1234567″,”udh”:”0605040B8423F0″,”data”:”EA0601AE02056A0045C60C037777772E736D736561676C652E657500080103534D534561676C65000101″}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
to numer telefonu odbiorcy (lub numery rozdzielone przecinkami)
udh (parametr opcjonalny)  nagłówek UDH (w formacie HEX)
data wiadomość binarna (w formacie HEX)
class (parametr opcjonalny)  klasa wiadomości
modem_no (parametr opcjonalny)  numer modemu (tylko w urządzeniach wielomodemowych)
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON
Odpowiedź:
Odpowiedź: {„result”: „OK; ID=[ID wiadomości z folderu Outbox]”}
Przykład odpowiedzi: {„result”: „OK; ID=297”}
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}
Odpowiedź (przy błędnych parametrach): {„result”: „Wrong or missing >>udh<< parameter”} Odpowiedź (przy błędnych parametrach): {„result”: „Wrong or missing >>data<< parameter”}
Odpowiedź (Extended):
Odpowiedź:
{„result”:{„message_id”:”[ID wiadomości z folderu Outbox]”,”status”:”ok”}}
 Przykład odpowiedzi: {„result”:{„message_id”:”748″,”status”:”ok”}}
 Odpowiedź (przy błędnej autoryzacji): {„result”:{„error_text”:”Invalid login or password”,”status”:”error”}}
 Odpowiedź (przy błędnych parametrach):{„result”:{„error_text”:”Wrong or missing>>udh<< parameter”,”status”:”error”}}
 Odpowiedź (przy błędnych parametrach):{„result”:{„error_text”:”Wrong or missing >>data<< parameter”,”status”:”error”}}

Odczytaj SMS: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/read_sms

Przykłady:
Pokaż wszystkie wiadomości z inbox:
https://url-of-smseagle/index.php/http_api/read_sms?login=john&pass=doe&folder=inbox

Pokaż nieprzeczytanie wiadomości z inbox:
https://url-of-smseagle/index.php/http_api/read_sms?login=john&pass=doe&folder=inbox&unread=1

Pokaż wiadomości z folderu folder sentitems z id>=1234. Ogranicz ilość wiadomości do 5:
https://url-of-smseagle/index.php/http_api/read_sms?login=john&pass=doe&folder=sentitems&idfrom=1234&limit=5

Pokaż wiadomości z folderu inbox dla numeru +481234567
https://url-of-smseagle/index.php/http_api/read_sms?login=john&pass=doe&folder=inbox&from=+481234567

Pokaż wiadomości z folderu sentitems dla numeru odbiorcy 7654321 i datą/godziną pomiędzy 2014-12-24 08:10:00 a 2014-12-31 23:59:59:
https://url-of-smseagle/index.php/http_api/read_sms?login=john&pass=doe&folder=sentitems&to=7654321&datefrom=20141224081000&dateto=20141231235959

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
folder folder: inbox, outbox, sentitems
idfrom (parametr opcjonalny)  minimalne id-wiadomości
from (parametr opcjonalny)  numer telefonu nadawcy SMS (dla inbox)
to (parametr opcjonalny)  numer telefonu odbiorcy SMS (dla sentitems)
datefrom (parametr opcjonalny)  data i czas w formacie YYYYmmDDHHMMSS (YYYY – rok, mm – miesiąc, DD – dzień, HH – godzina, MM – minuta, SS – sekunda). Pokaż wiadomości wysłane lub odebrane od podanej daty/czasu
dateto (parametr opcjonalny)  data i czas w formacie YYYYmmDDHHMM (YYYY – rok, mm – miesiąc, DD – dzień, HH – godzina, MM – minuta, SS – sekunda). Pokaż wiadomości wysłane lub odebrane do podanej daty/czasu
limit (parametr opcjonalny)  ile wiadomości pokazać
unread (parametr opcjonalny)  1 = pokaż tylko nieprzeczytane wiadomości
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML

Odpowiedź:
Przykładowe odpowiedzi: folder inbox, folder sentitems
Odpowiedź (kiedy brak danych): No data to display
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach): Wrong parameters

Odpowiedź (XML):
Przykład odpowiedzi: folder inbox

Odpowiedź (kiedy brak danych):
<xml>
<error_text>No data to display</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Odczytaj SMS: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
Pokaż wszystkie wiadomości z inbox:
{„method”:”sms.read_sms”,”params”:{„login”:”john”,”pass”:”doe”,”folder”:”inbox”}}

Pokaż nieprzeczytanie wiadomości z inbox:
{„method”:”sms.read_sms”,”params”:{„login”:”john”,”pass”:”doe”,”folder”:”inbox”,”unread”:”1″}}

Pokaż wiadomości z folderu folder sentitems z id>=1234. Ogranicz ilość wiadomości do 5:
{„method”:”sms.read_sms”,”params”:{„login”:”john”,”pass”:”doe”,”folder”:”sentitems”,”idfrom”:”1234″,”limit”:”5″}}

Pokaż wiadomości z folderu inbox dla numeru +481234567
{„method”:”sms.read_sms”,”params”:{„login”:”john”,”pass”:”doe”,”folder”:”inbox”,”from”:”481234567″}}

Pokaż wiadomości z folderu sentitems dla numeru odbiorcy 7654321 i datą/godziną pomiędzy 2014-12-24 08:10:00 a 2014-12-31 23:59:59:
{„method”:”sms.read_sms”,”params”:{„login”:”john”,”pass”:”doe”,”folder”:”sentitems”,”to”:”7654321″,”datefrom”:”20141224081000″,”dateto”:”20141231235959″}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
folder folder: inbox, outbox, sentitems
idfrom (parametr opcjonalny)  minimalne id-wiadomości
from (parametr opcjonalny)   numer telefonu nadawcy SMS (dla inbox)
to (parametr opcjonalny)   numer telefonu odbiorcy SMS (dla sentitems)
datefrom (parametr opcjonalny)  data i czas w formacie YYYYmmDDHHMMSS (YYYY – rok, mm – miesiąc, DD – dzień, HH – godzina, MM – minuta, SS – sekunda). Pokaż wiadomości wysłane lub odebrane od podanej daty/czasu
dateto (parametr opcjonalny)  data i czas w formacie YYYYmmDDHHMM (YYYY – rok, mm – miesiąc, DD – dzień, HH – godzina, MM – minuta, SS – sekunda). Pokaż wiadomości wysłane lub odebrane do podanej daty/czasu
limit (parametr opcjonalny)  ile wiadomości pokazać
unread (parametr opcjonalny)   1 = pokaż tylko nieprzeczytane wiadomości
custom (parametr opcjonalny)  name of My Folder (custom folder defined in Web-GUI) to read from
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON
Odpowiedź:
Przykład odpowiedzi: folder inbox
Odpowiedź (kiedy brak danych): {„result”: „No data to display”}
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}
Odpowiedź (przy błędnych parametrach): {„result”: „Wrong parameters”}
Odpowiedź (Extended):
Przykład odpowiedzi: sentitems folder
Odpowiedź (kiedy brak danych): {„result”:{„error_text”:”No data to display”,”status”:”error”}}
Odpowiedź (przy błędnej autoryzacji): {„result”:{„error_text”:”Invalid login or password”,”status”:”error”}}
Odpowiedź (przy błędnych parametrach): {„result”:{„error_text”:”Wrong or missing >>udh<< parameter”,”status”:”error”}}

Usuń SMS: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/delete_sms

Przykłady:
Usuń wiadomość z id=1234 z folderu inbox:
http://url-of-smseagle/index.php/http_api/delete_sms?login=john&pass=doe&folder=inbox&idfrom=1234&idto=1234

Usuń wiadomości z id 1234 – 1250 z folderu inbox:
http://url-of-smseagle/index.php/http_api/delete_sms?login=john&pass=doe&folder=inbox&idfrom=1234&idto=1250

Usuń wszystkie wiadomości z folderu outbox:
http://url-of-smseagle/index.php/http_api/delete_sms?login=john&pass=doe&folder=outbox&idfrom=1&idto=999999999

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
folder folder: inbox, outbox, sentitems
idfrom minimalne id wiadomości
idto maksymalne id wiadomości
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML

Odpowiedź:
Odpowiedź: OK
Odpowiedź (gdy operacja usuwania nie powiodła się): Error
Odpowiedź (przy błędnej autoryzacji): Invalid login or password

Odpowiedź (XML):
Odpowiedź:
<xml>
<status>ok</status>
</xml>

Odpowiedź (gdy operacja usuwania nie powiodła się):
<xml>
<status>error</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Usuń SMS: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
Usuń wiadomość z id=1234 z folderu inbox inbox:
{„method”:”sms.delete_sms”, „params”:{„login”:”john”,”pass”:”doe”,”folder”:”inbox”,”idfrom”:”1234″”idto”:”1234″}}

Usuń wiadomości z id 1234 – 1250 z folderu inbox:
{„method”:”sms.delete_sms”, „params”:{„login”:”john”,”pass”:”doe”,”folder”:”inbox”,”idfrom”:”1234″,”idto”:”1250″}}

Usuń wszystkie wiadomości z folderu outbox:
{„method”:”sms.delete_sms”, „params”:{„login”:”john”,”pass”:”doe”,”folder”:”outbox”,”idfrom”:”1″,”idto”:”999999999″}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
folder folder: inbox, outbox, sentitems
idfrom minimalne id wiadomości
idto maksymalne id wiadomości
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON

Odpowiedź:
Odpowiedź: {„result”: „OK”}
Odpowiedź (gdy operacja usuwania nie powiodła się): {„result”: „Error”}
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}

Odpowiedź (Extended):
Odpowiedź:  {„result”:{„status”:”ok”}}
Odpowiedź (gdy operacja usuwania nie powiodła się): {„result”:{„status”:”error”}}
Odpowiedź (przy błędnej autoryzacji): {„result”: {„error_text”:”Invalid login or password”,”status”:”error”}}

Pobierz długość kolejki outbox: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/get_queue_length

Przykład:
https://url-of-smseagle/index.php/http_api/get_queue_length?login=john&pass=doe

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML

Odpowiedź:
Odpowiedź: [ilość wiadomości w kolejce do przetworzenia przez modem GSM/3G]
Przykład odpowiedzi: 7
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach): Wrong parameters

Odpowiedź (XML):
Odpowiedź:
<xml>
<queue_length>
[ilość wiadomości w kolejce do przetworzenia przez modem GSM/3G]
</queue_length >
<status>ok</status>
</xml>

Przykład odpowiedzi:
<xml>
<queue_length>7</queue_length >
<status>ok</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Pobierz długość kolejki outbox: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”sms.get_queue_length”, „params”:{„login”:”john”,”pass”:”doe”}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON

Odpowiedź:
Odpowiedź: {„result”: [ilość wiadomości w kolejce do przetworzenia przez modem GSM/3G]}
Przykład odpowiedzi: {„result”:7}
Odpowiedź: {„result”: „Invalid login or password”}
Odpowiedź: {„result”: „Wrong parameters”}

Odpowiedź (Extended):
Odpowiedź: {„result”:{„queue_length”:[ilość wiadomości w kolejce do przetworzenia przez modem GSM/3G],”status”:”ok”}}
Przykład odpowiedzi: {„result”: {„queue_length”:”419″,”status”:”ok”}}
Odpowiedź (przy błędnej autoryzacji): {„result”: {„error_text”:”Invalid login or password”,”status”:”error”}}
Odpowiedź (przy błędnych parametrach): {„result”: {„error_text”:”Wrong parameters”,”status”:”error”}}

Pobierz ilość wiadomości w folderze inbox: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/get_inbox_length

Przykład: 

https://url-of-smseagle/index.php/http_api/get_inbox_length?login=john&pass=doe

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML
Odpowiedź:
Odpowiedź: [ilość wiadomości w folderze inbox]
Przykład odpowiedzi: 3
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach): Wrong parameters
Odpowiedź (XML):

Odpowiedź:
<xml>
<queue_length>
[ilość wiadomości w folderze inbox]
</queue_length>
<status>ok</status>
</xml>

Przykład odpowiedzi:
<xml>
<inbox_length>3</inbox_length>
<status>ok</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Pobierz ilość wiadomości w inbox: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”sms.get_inbox_length”, „params”:{„login”:”john”,”pass”:”doe”}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON
Odpowiedź:
Odpowiedź: {„result”: „[ilość wiadomości w folderze inbox]”}
Przykład odpowiedzi: 3
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}
Odpowiedź (przy błędnych parametrach): {„result”: „Wrong parameters”}
Odpowiedź (Extended):
Odpowiedź: {„result”:{„inbox_length”:[ilość wiadomości w folderze inbox],”status”:”ok”}}
Przykład odpowiedzi: {„result”: {„inbox_length”:”3″,”status”:”ok”}}
Odpowiedź (przy błędnej autoryzacji): {„result”: {„error_text”:”Invalid login or password”,”status”:”error”}}
Odpowiedź (przy błędnych parametrach): {„result”: {„error_text”:”Wrong parameters”,”status”:”error”}}

Pobierz ilość wiadomości w folderze sentitems: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/get_inbox_length

Przykład:
https://url-of-smseagle/index.php/http_api/get_sentitems_length?login=john&pass=doe

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML
Odpowiedź:
Odpowiedź: [ilość wiadomości w folderze sentitems]
Przykład odpowiedzi: 21
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach): Wrong parameters

Odpowiedź (XML):
Odpowiedź:
<xml>
<sentitems_length>
[ilość wiadomości w folderze inbox]
</sentitems_length>
<status>ok</status>
</xml>

Przykład odpowiedzi:
<xml>
<sentitems_length>21</sentitems_length>
<status>ok</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Pobierz ilość wiadomości w folderze sentitems: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”sms.get_sentitems_length”, „params”:{„login”:”john”,”pass”:”doe”}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON
Odpowiedź:
Odpowiedź: {„result”: „[ilość wiadomości w folderze sentitems]”}
Przykład odpowiedzi: {„result”: „21”}
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}
Odpowiedź (przy błędnych parametrach): {„result”: „Wrong parameters”}
Odpowiedź (Extended):
Odpowiedź: {„result”:{„sentitems_length”:[ilość wiadomości w folderze sentitems],”status”:”ok”}}
Przykład odpowiedzi: {„result”: {„sentitems_length”:”21″,”status”:”ok”}}
Odpowiedź (przy błędnej autoryzacji): {„result”: {„error_text”:”Invalid login or password”,”status”:”error”}}
Odpowiedź (przy błędnych parametrach): {„result”: {„error_text”:”Wrong parameters”,”status”:”error”}}

Pobierz siłę sygnału GSM/3G: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/get_gsmsignal

Przykład:
https://url-of-smseagle/index.php/http_api/get_gsmsignal?login=john&pass=doe&modem_no=1

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
modem_no (parametr opcjonalny)  numer modemu do odpytania (domyślnie = 1). Parametr używany tylko w urządzeniach wielomodemowych
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML
Odpowiedź:
Odpowiedź: Siła sygnału GSM/3G w procentach (wartości 0-100). Jeśli modem GSM/3G jest odłączony od sieci GSM/3G metoda zwraca wartość -1
Przykład odpowiedzi: 74
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach): Wrong parameters
Odpowiedź (XML):

Odpowiedź:
<xml>
<signal_strength>
[Siła sygnału GSM/3G w procentach (wartości 0-100)]
</signal_strength>
<status>ok</status>
</xml>

Przykład odpowiedzi:
<xml>
<signal_strength>74</signal_strength>
<status>ok</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Pobierz siłę sygnału GSM/3G: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”signal.get_gsmsignal”, „params”:{„login”:”john”,”pass”:”doe”}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
modem_no (parametr opcjonalny)  numer modemu do odpytania (domyślnie = 1). Parametr używany tylko w urządzeniach wielomodemowych
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON

Odpowiedź:
Odpowiedź: {„result”: GSM signal strength in percent: values between 0-100. Jeśli modem GSM/3G jest odłączony od sieci GSM/3G metoda zwraca wartość -1 }
Przykład odpowiedzi: {„result”:7}
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}
Odpowiedź (przy błędnych parametrach): {„result”: „Wrong parameters”}

Odpowiedź (Extended):
Odpowiedź: {„result”:{„signal_strength”:[ilość wiadomości w folderze sentitems],”status”:”ok”}}
Przykład odpowiedzi: {„result”: {„signal_strength”:”7″,”status”:”ok”}}
Odpowiedź (przy błędnej autoryzacji): {„result”: {„error_text”:”Invalid login or password”,”status”:”error”}}

Książka adresowa utwórz grupę: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/group_create

Przykład:
https://url-of-smseagle/index.php/http_api/group_create?login=john&pass=doe&groupname=myusers&public=1

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
groupname nazwa tworzonej grupy
public (parametr opcjonalny)  0 = grupa prywatna, 1 = grupa publiczna
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML

Odpowiedź:
Odpowiedź: OK; ID=[ID utworzonej grupy]
Przykład odpowiedzi: OK; ID=5
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach): Wrong or missing >>groupname<< parameter

Odpowiedź (XML):
Odpowiedź:
<xml>

    <group_id>[ID utworzonej grupy]</group_id>
<status>ok</status>
</xml>

Przykład odpowiedzi:
<xml>
<group_id>5</group_id>
<status>ok</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong or missing >>groupname<< parameter</error_text>
<status>error</status>
</xml>

Książka adresowa utwórz grupę: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”phonebook.group_create”, „params”:{„login”:”john”,”pass”:”doe”,”groupname”:”myusers”,”public”:”1″}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
groupname nazwa tworzonej grupy
public (parametr opcjonalny)  0 = grupa prywatna, 1 = grupa publiczna
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON

Odpowiedź:
Odpowiedź: {„result”: „OK; ID=[ID utworzonej grupy]”}
Przykład odpowiedzi: {„result”: „OK; ID=5”}
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}
Odpowiedź (przy błędnych parametrach): {„result”: „Wrong or missing >>groupname<< parameter”}

Odpowiedź (Extended):
Odpowiedź: {„result”: {„group_id”:”[ID utworzonej grupy]”,”status”:”ok”}}
Przykład odpowiedzi: {„result”: {„group_id”:”748″,”status”:”ok”}}
Odpowiedź (przy błędnej autoryzacji): {„result”: {„error_text”:”Invalid login or password”,”status”:”error”}}
Odpowiedź (przy błędnych parametrach): {„result”: {„error_text”:”Wrong parameters”,”status”:”error”}}

Książka adresowa odczyt grup: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/group_read

Przykład:
https://url-of-smseagle/index.php/http_api/group_read?login=john&pass=doe&public=1&uid=12

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
public (parametr opcjonalny)  0 = grupa prywatna (domyślnie), 1 = grupa publiczna
uid (parametr opcjonalny)  id użytkownika, który jest właścicielem grupy
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML
Odpowiedź:
Przykład odpowiedzi: link
Odpowiedź (kiedy brak danych): No data to display
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach):
Wrong or missing >>uid<< parameter
Wrong or missing >>public<< parameter
Odpowiedź (XML):
Przykład odpowiedzi:

<xml>
<groups>
<item>
<Name>private</Name>
<ID>2</ID>
<id_user>2</id_user>
<is_public>true</is_public>
</item>
<item>
<Name>Everyone</Name>
<ID>3</ID>
<id_user>1</id_user>
<is_public>true</is_public>
</item>
<item>
<Name>work</Name>
<ID>4</ID>
<id_user>1</id_user>
<is_public>true</is_public>
</item></groups>
<status>ok</status>
</xml>

Odpowiedź (kiedy brak danych):
<xml>
<error_text>No data to display</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong or missing >>uid<< parameter</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong or missing >>public<< parameter</error_text>
<status>error</status>
</xml>

Książka adresowa odczyt grup: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”phonebook.group_read”, „params”:{„login”:”john”,”pass”:”doe”,”public”:”1″,”uid”:”12″}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
public (parametr opcjonalny)  0 = grupa prywatna (domyślnie), 1 = grupa publiczna
uid (parametr opcjonalny)  id użytkownika, który jest właścicielem grupy
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON

Odpowiedź:
Przykład odpowiedzi: link

Odpowiedź (kiedy brak danych): {„result”: „No data to display”}
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}
Odpowiedź (przy błędnych parametrach):
{„result”: „Wrong or missing >>uid<< parameter”}
{„result”: „Wrong or missing >>public<< parameter”}

Odpowiedź (Extended):
Przykład odpowiedzi: link
Odpowiedź (przy błędnych parametrach):
{„result”: {„error_text”:”Wrong or missing >>uid<< parameter”,”status”:”error”}}
{„result”: {„error_text”:”Wrong or missing >>public<< parameter”,”status”:”error”}}

Książka adresowa aktualizuj grupę: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/group_update

Przykład:
https://url-of-smseagle/index.php/http_api/group_update?login=john&pass=doe&group_id=2&groupname=myusers&public=1

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
group_id id grupy
groupname nazwa grupy
public (parametr opcjonalny)  0 = grupa prywatna, 1 = grupa publiczna
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML

Odpowiedź:
Odpowiedź: OK
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach):
Wrong or missing >>groupname<< parameter
Wrong or missing >>group_id<< parameter
Odpowiedź (przy błędnym group_id): Group with the given id does not exists

Odpowiedź (XML):
Odpowiedź:
<xml>
<status>ok</status>
</xml>
Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>
Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong or missing >>groupname<< parameter</error_text>
<status>error</status>
</xml>
<xml>
<error_text>Wrong or missing >>group_id<< parameter</error_text>
<status>error</status>
</xml>
Odpowiedź (przy błędnym group_id):
<xml>
<error_text>Group with the given id does not exists</error_text>
<status>error</status>
</xml>

Książka adresowa aktualizuj grupę: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”phonebook.group_update”, „params”:{„login”:”john”,”pass”:”doe”,”group_id”:”2″,”groupname”:”myusers”,”public”:”1″}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
group_id id grupy
groupname nazwa grupy
public (parametr opcjonalny)  0 = grupa prywatna, 1 = grupa publiczna
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON

Odpowiedź:
Odpowiedź: OK
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach):
Wrong or missing >>groupname<< parameter
Wrong or missing >>group_id<< parameter
Odpowiedź (przy błędnym group_id): Group with the given id does not exists

Odpowiedź (Extended):
Odpowiedź:  {„result”:{„status”:”ok”}}
Odpowiedź (przy błędnej autoryzacji): {„result”: {„error_text”:”Invalid login or password”,”status”:”error”}}
Odpowiedź (przy błędnych parametrach): {„result”: {„error_text”:”Wrong or missing >>groupname<< parameter”,”status”:”error”}}{„result”: {„error_text”:”Wrong or missing >>group_id<< parameter”,”status”:”error”}}
Odpowiedź (przy błędnym group_id): {„result”: {„error_text”:”Group with the given id does not exists”,”status”:”error”}}

Książka adresowa usuń grupę: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/group_delete

Przykład:
https://url-of-smseagle/index.php/http_api/group_delete?login=john&pass=doe&group_id=2&groupname=myusers

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
group_id id grupy
groupname nazwa grupy
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML
Odpowiedź:
Odpowiedź: OK
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach):
Wrong or missing >>groupname<< parameter
Wrong or missing >>group_id<< parameter
Odpowiedź (przy błędnym group_id): Group with the given id and name does not exist

 

Odpowiedź (XML):
Odpowiedź:
<xml>
<status>ok</status>
</xml>Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong or missing >>groupname<< parameter</error_text>
<status>error</status>
</xml><xml>
<error_text>Wrong or missing >>group_id<< parameter</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnym group_id):
<xml>
<error_text>Group with the given id does not exists</error_text>
<status>error</status>
</xml>

Książka adresowa usuń grupę: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”phonebook.group_delete”, „params”:{„login”:”john”,”pass”:”doe”,”group_id”:”2″,”groupname”:”myusers”}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
group_id id grupy
groupname nazwa grupy
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON

Odpowiedź:
Odpowiedź: {„result”: „OK”}
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}
Odpowiedź (przy błędnych parametrach):
{„result”: „Wrong or missing >>groupname<< parameter”}
{„result”: „Wrong or missing >>group_id<< parameter”}

Odpowiedź (przy błędnym group_id): {„result”: „Group with the given id and name does not exist”}
Odpowiedź (Extended):
Odpowiedź:  {„result”:{„status”:”ok”}}Odpowiedź (przy błędnej autoryzacji):
{„result”: {„error_text”:”Invalid login or password”,”status”:”error”}}Odpowiedź (przy błędnych parametrach):
{„result”: {„error_text”:”Wrong or missing >>groupname<< parameter”,”status”:”error”}}{„result”: {„error_text”:”Wrong or missing >>group_id<< parameter”,”status”:”error”}}Odpowiedź (przy błędnym group_id):
{„result”: {„error_text”:”Group with the given id does not exists”,”status”:”error”}}

Książka adresowa dodaj kontakt do grupy: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/group_addcontact

Przykład:
https://url-of-smseagle/index.php/http_api/group_addcontact?login=john&pass=doe&group_id=2&contact_id=1

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
group_id id grupy (lub wiele id rozdzielonych przecinkiem)
contact_id id kontaktu. Kontakt zostanie dodany do grupy
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML
Odpowiedź:
Odpowiedź: OK
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach):
Wrong or missing >>group_id<< parameter
Wrong or missing >>contact_id<< parameter
Odpowiedź (jeśli id jest błędne):
Group with the given id does not exists
Contact with the given id does not exists

Odpowiedź (XML):
Odpowiedź:
<xml>
<status>ok</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong or missing >>group_id<< parameter</error_text>
<status>error</status>
</xml><xml>
<error_text>Wrong or missing >>contact_id<< parameter</error_text>
<status>error</status>
</xml>

Odpowiedź (jeśli id jest błędne):
<xml>
<error_text>Group with the given id does not exists</error_text>
<status>error</status>
</xml><xml>
<error_text>Contact with the given id does not exists</error_text>
<status>error</status>
</xml>

Książka adresowa dodaj kontakt do grupy: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”phonebook.group_addcontact”, „params”:{„login”:”john”,”pass”:”doe”,”group_id”:”2″,”contact_id”:”1″}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
group_id id grupy (lub wiele id rozdzielonych przecinkiem)
contact_id id kontaktu. Kontakt zostanie dodany do grupy
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON
Odpowiedź:
Odpowiedź: {„result”: „OK”}
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}
Odpowiedź (przy błędnych parametrach):
{„result”: „Wrong or missing >>group_id<< parameter”}
{„result”: „Wrong or missing >>contact_id<< parameter”}
Odpowiedź (jeśli id jest błędne):
{„result”: „Group with the given id does not exists”}
{„result”: „Contact with the given id does not exists”}
Odpowiedź (Extended):
Odpowiedź:  {„result”:{„status”:”ok”}}Odpowiedź (przy błędnej autoryzacji):
{„result”: {„error_text”:”Invalid login or password”,”status”:”error”}}Odpowiedź (przy błędnych parametrach):
{„result”: {„error_text”:”Wrong or missing >>group_id<< parameter”,”status”:”error”}}{„result”: {„error_text”:”Wrong or missing >>contact_id<< parameter”,”status”:”error”}}Odpowiedź (jeśli id jest błędne):
{„result”: {„error_text”:”Group with the given id does not exists”,”status”:”error”}}{„result”: {„error_text”:”Contact with the given id does not exists”,”status”:”error”}}

Książka adresowa usuń kontakt z grupy: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/group_removecontact

Przykład:
https://url-of-smseagle/index.php/http_api/group_removecontact?login=john&pass=doe&group_id=2&contact_id=1

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
group_id id grupy (lub wiele id rozdzielonych przecinkiem)
contact_id id kontaktu. Kontakt zostanie usunięty z grupy
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML
Odpowiedź:
Odpowiedź: OK
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach):
Wrong or missing >>group_id<< parameter
Wrong or missing >>contact_id<< parameter
Odpowiedź (jeśli id jest błędne):
Group with the given id does not exists
Contact with the given id does not exists

Odpowiedź (XML):
Odpowiedź:
<xml>
<status>ok</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong or missing >>group_id<< parameter</error_text>
<status>error</status>
</xml><xml>
<error_text>Wrong or missing >>contact_id<< parameter</error_text>
<status>error</status>
</xml>

Odpowiedź (jeśli id jest błędne):
<xml>
<error_text>Group with the given id does not exists</error_text>
<status>error</status>
</xml><xml>
<error_text>Contact with the given id does not exists</error_text>
<status>error</status>
</xml>

Książka adresowa usuń kontakt z grupy: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”phonebook.group_removecontact”, „params”:{„login”:”john”,”pass”:”doe”,”group_id”:”2″,”contact_id”:”1″}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
group_id id grupy (lub wiele id rozdzielonych przecinkiem)
contact_id id kontaktu. Kontakt zostanie usunięty z grupy
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON
Odpowiedź:
Odpowiedź: {„result”: „OK”}
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}
Odpowiedź (przy błędnych parametrach):
{„result”: „Wrong or missing >>group_id<< parameter”}
{„result”: „Wrong or missing >>contact_id<< parameter”}
Odpowiedź (jeśli id jest błędne):
{„result”: „Group with the given id does not exists”}
{„result”: „Contact with the given id does not exists”}
Odpowiedź (Extended):
Odpowiedź:  {„result”:{„status”:”ok”}}Odpowiedź (przy błędnej autoryzacji):
{„result”: {„error_text”:”Invalid login or password”,”status”:”error”}}Odpowiedź (przy błędnych parametrach):
{„result”: {„error_text”:”Wrong or missing >>group_id<< parameter”,”status”:”error”}}{„result”: {„error_text”:”Wrong or missing >>contact_id<< parameter”,”status”:”error”}}Odpowiedź (jeśli id jest błędne):
{„result”: {„error_text”:”Group with the given id does not exists”,”status”:”error”}}{„result”: {„error_text”:”Contact with the given id does not exists”,”status”:”error”}}

Książka adresowa utwórz kontakt: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/contact_create

Przykład:
https://url-of-smseagle/index.php/http_api/contact_create?login=john&pass=doe&contactname=johndoe&number=12345678&public=1

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
contactname nazwa tworzonego kontaktu
number numer telefonu tworzonego kontaktu
public (parametr opcjonalny)  0 = kontakt prywatny, 1 = kontakt publiczny (wartość domyślna)
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML
Odpowiedź:
Odpowiedź: OK; ID=[ID of created contact]
Przykład odpowiedzi: OK; ID=2
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach):
Wrong or missing >>contactname<< parameter
Wrong or missing >>number<< parameter

Odpowiedź (XML):
Odpowiedź:
<xml>
<contact_id>[ID of created contact]</contact_id>
<status>ok</status>
</xml>

Przykład odpowiedzi:
<xml>
<contact_id>2</contact_id>
<status>ok</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong or missing >>contactname<< parameter</error_text>
<status>error</status>
</xml><xml>
<error_text>Wrong or missing >>number<< parameter</error_text>
<status>error</status>
</xml>

Książka adresowa utwórz kontakt: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”phonebook.contact_create”, „params”:{„login”:”john”,”pass”:”doe”,”contactname”:”johndoe”,”number”:”12345678″,”public”:”1″}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
contactname nazwa tworzonego kontaktu
number numer telefonu tworzonego kontaktu
public (parametr opcjonalny)  0 = kontakt prywatny, 1 = kontakt publiczny (wartość domyślna)
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON
Odpowiedź:
Odpowiedź: {„result”: „OK; ID=[ID of created contact]”}
Przykład odpowiedzi: {„result”: „OK; ID=2”}
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}
Odpowiedź (przy błędnych parametrach):
{„result”: „Wrong or missing >>contactname<< parameter”}
{„result”: „Wrong or missing >>number<< parameter”}
Odpowiedź (Extended):
Odpowiedź:
{„result”: {„contact_id”:”[ID of created contact]”,”status”:”ok”}}Przykład odpowiedzi: {„result”: {„contact_id”:”2″,”status”:”ok”}}Odpowiedź (przy błędnej autoryzacji):
{„result”: {„error_text”:”Invalid login or password”,”status”:”error”}}Odpowiedź (przy błędnych parametrach):
{„result”: {„error_text”:”Wrong or missing >>contactname<< parameter”},”status”:”error”}}{„result”: {„error_text”:”Wrong or missing >>number<< parameter”,”status”:”error”}}

Książka adresowa czytaj kontakty: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/contact_read

Przykład:
https://url-of-smseagle/index.php/http_api/contact_read?login=john&pass=doe&public=1&uid=12

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
public (parametr opcjonalny)  0 = kontakty prywatne (wartosć domyślna), 1 = kontakty publiczne
uid (parametr opcjonalny)  id właściciela kontaktu
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML
Odpowiedź:
Przykład odpowiedzi: link
Odpowiedź (kiedy brak danych): No data to display
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach):
Wrong or missing >>uid<< parameter
Wrong or missing >>public<< parameter

Odpowiedź (XML):
Przykład odpowiedzi: link

Odpowiedź (kiedy brak danych):
<xml>
<error_text>No data to display</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong or missing >>uid<< parameter</error_text>
<status>error</status>
</xml>
<xml>
<error_text>Wrong or missing >>public<< parameter</error_text>
<status>error</status>
</xml>

Książka adresowa czytaj kontakty: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”phonebook.contact_read”, „params”:{„login”:”john”,”pass”:”doe”,”public”:”1″,”uid”:”12″}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
public (parametr opcjonalny)  0 = kontakty prywatne (wartosć domyślna), 1 = kontakty publiczne
uid (parametr opcjonalny)  id właściciela kontaktu
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON
Odpowiedź:
Przykład odpowiedzi: link
Odpowiedź (kiedy brak danych): {„result”: „No data to display”}
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}
Odpowiedź (przy błędnych parametrach):
{„result”: „Wrong or missing >>uid<< parameter”}
{„result”: „Wrong or missing >>public<< parameter”}
Odpowiedź (Extended):
Przykład odpowiedzi: link
Odpowiedź (kiedy brak danych):
{„result”: {„error_text”:” No data to display”,”status”:”error”}}
Odpowiedź (przy błędnej autoryzacji):
{„result”: {„error_text”:”Invalid login or password”,”status”:”error”}}
Odpowiedź (przy błędnych parametrach):
{„result”: {„error_text”:”Wrong or missing >>uid<< parameter”,”status”:”error”}}{„result”: {„error_text”:”Wrong or missing >>public<< parameter”,”status”:”error”}}

Książka adresowa aktualizuj kontakt: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/contact_update

Przykład:
https://url-of-smseagle/index.php/http_api/contact_update?login=john&pass=doe&contact_id=4&contactname=johnlord&number=123456789&public=1

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
contact_id id kontaktu
contactname nazwa kontaktu
number numer telefonu kontaktu
public (parametr opcjonalny)  0 = grupa prywatna, 1 = grupa publiczna
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML
Odpowiedź:
Odpowiedź: OK
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach):
Wrong or missing >>contactname<< parameter
Wrong or missing >>contact_id<< parameter
Wrong or missing >>number<< parameter
Odpowiedź (przy błędnym contact_id): Contact with the given id does not exists

Odpowiedź (XML):
Odpowiedź:
<xml>
<status>ok</status>
</xml>

Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong or missing >>contactname<< parameter</error_text>
<status>error</status>
</xml>
<xml>
<error_text>Wrong or missing >>contact_id<< parameter</error_text>
<status>error</status>
</xml>
<xml>
<error_text>Wrong or missing >>number<< parameter</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnym contact_id):
<xml>
<error_text>Contact with the given id does not exists</error_text>
<status>error</status>
</xml>

Książka adresowa aktualizuj kontakt: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”phonebook.contact_update”, „params”:{„login”:”john”,”pass”:”doe”,”contact_id”:”4″,”contactname”:”johnlord”,”number”:”123456789″,”public”:”1″}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
contact_id id kontaktu
contactname nazwa kontaktu
number numer telefonu kontaktu
public (parametr opcjonalny)  0 = grupa prywatna, 1 = grupa publiczna
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON
Odpowiedź:
Odpowiedź: {„result”: „OK”}
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}
Odpowiedź (przy błędnych parametrach):
{„result”: „Wrong or missing >>contactname<< parameter”}
{„result”: „Wrong or missing >>contact_id<< parameter”}
{„result”: „Wrong or missing >>number<< parameter”}
Odpowiedź (przy błędnym contact_id): {„result”: „Contact with the given id does not exists”}
Odpowiedź (Extended):
Odpowiedź:  {„result”:{„status”:”ok”}}
Odpowiedź (przy błędnej autoryzacji):
{„result”: {„error_text”:”Invalid login or password”,”status”:”error”}}
Odpowiedź (przy błędnych parametrach):
{„result”: {„error_text”:”Wrong or missing >>contactname<< parameter”,”status”:”error”}}
{„result”: {„error_text”:”Wrong or missing >>contact_id<< parameter”,”status”:”error”}}
{„result”: {„error_text”:”Wrong or missing >>number<< parameter”,”status”:”error”}}
Odpowiedź (przy błędnym contact_id):
{„result”: {„error_text”:”Contact with the given id does not exists”,”status”:”error”}}

Książka adresowa usuń kontakt: HTTP GET

HTTP GET: https://url-of-smseagle/index.php/http_api/contact_delete

Przykład:
https://url-of-smseagle/index.php/http_api/contact_delete?login=john&pass=doe&contact_id=4&contactname=johnlord

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
contact_id id kontaktu
contactname nazwa kontaktu
responsetype (parametr opcjonalny)  text = API zwraca w formacie tekstowym (domyślnie), xml = API zwraca odpowiedź w formacie XML
Odpowiedź:
Odpowiedź: OK
Odpowiedź (przy błędnej autoryzacji): Invalid login or password
Odpowiedź (przy błędnych parametrach):
Wrong or missing >>contactname<< parameter
Wrong or missing >>contact_id<< parameter
Odpowiedź (przy błędnym group_id): Contact with the given id and name does not exists
Odpowiedź (XML):
Odpowiedź:
<xml>
<status>ok</status>
</xml>
Odpowiedź (przy błędnej autoryzacji):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>
Odpowiedź (przy błędnych parametrach):
<xml>
<error_text>Wrong or missing >>contactname<< parameter</error_text>
<status>error</status>
</xml>
<xml>
<error_text>Wrong or missing >>contact_id<< parameter</error_text>
<status>error</status>
</xml>
Odpowiedź (przy błędnym contact_id):
<xml>
<error_text>Contact with the given id and name does not exists </error_text>
<status>error</status>
</xml>

Książka adresowa usuń kontakt: JSON-RPC

HTTP POST: https://url-of-smseagle/index.php/jsonrpc/sms

Przykład treści POST:
{„method”:”phonebook.contact_delete”, „params”:{„login”:”john”,”pass”:”doe”,”contact_id”:”4″,”contactname”:”johnlord”}}

Parametr Opis
login użytkownik do zalogowania się do SMSEagle
pass hasło do zalogowania się do SMSEagle
contact_id id kontaktu
contactname nazwa kontaktu
responsetype (parametr opcjonalny)  simple = odpowiedź API jako prosty obiekt z jednym polem result (domyślnie), extended = odpowiedź API jako pełen obiekt JSON
Odpowiedź:
Odpowiedź: {„result”: „OK”}
Odpowiedź (przy błędnej autoryzacji): {„result”: „Invalid login or password”}
Odpowiedź (przy błędnych parametrach):
{„result”: „Wrong or missing >>contactname<< parameter”}
{„result”: „Wrong or missing >>contact_id<< parameter”}
Odpowiedź (przy błędnym group_id): {„result”: „Contact with the given id and name does not exists”}
Odpowiedź (Extended):
Odpowiedź:  {„result”:{„status”:”ok”}}
Odpowiedź (przy błędnej autoryzacji):
{„result”: {„error_text”:”Invalid login or password”,”status”:”error”}}
Odpowiedź (przy błędnych parametrach):
{„result”: {„error_text”:”Wrong or missing >>contactname<< parameter”,”status”:”error”}}
{„result”: {„error_text”:”Wrong or missing >>contact_id<< parameter”,”status”:”error”}}
Odpowiedź (przy błędnym contact_id):
{„result”: {„error_text”:”Contact with the given id and name does not exists”,”status”:”error”}}

Masz pytanie lub pomysł?

Jeśli masz pytania techniczne dotyczące wykorzystania API skontaktuj się z naszym Wsparciem Technicznym.