Przed rozpoczęciem korzystania z API należy najpierw aktywować dostęp do niego w Web-GUI.

1. Przejdź do Web-GUI > menu Użytkownicy
2. Utwórz nowego Użytkownika z poziomem dostępu “Użytkownik”, ustaw “Dostęp do API” na “Włączony” (opcjonalnie możesz ograniczyć dostęp tylko do wybranych metod API)
3. Wybierz metodę uwierzytelniania API. To może być:
   • token dostępowy (zalecane rozwiązanie)
     Przejdź do edycji użytkownika API > zaznacz “Włącz token” i wygeneruj nowy token. Token będzie używany do uwierzytelniania w metodach API.
     albo
   • login i hasło
     Użyj nazwy użytkownika i hasła API uwierzytelniania w metodach API.

Przykłady uwierzytelniania:

• z tokenem dostępowym
  https://url-of-smseagle/http_api/send_sms?access_token=0001gOjCOlMH8F2q&to=1234567&message=mymessage
• z loginem i hasłem
  https://url-of-smseagle/http_api/send_sms?login=john&pass=doe&to=1234567&message=mymessage

Sposób uwierzytelniania do API utworzony w tym punkcie będzie używany we wszystkich metodach API (patrz opisy poniżej).

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

Przykłady:
https://url-of-smseagle/index.php/http_api/send_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=1234567&message=mymessage
lub
https://url-of-smseagle/index.php/http_api/send_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=1234567&message=mymessage&date=201401152132
lub
https://url-of-smseagle/index.php/http_api/send_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=1234567&message=mymessage&highpriority=1

Odpowiedź:
Odpowiedź: OK; ID=[ID wiadomości z folderu Outbox]
Przykład odpowiedzi: OK; ID=297
Odpowiedź (przy błędnej autoryzacji za pomocą tokena): Invalid access token
Odpowiedź (przy błędnej autoryzacji za pomocą użytkownika/hasła): 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 za pomocą tokena):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Odpowiedź (przy błędnej autoryzacji za pomocą loginu/hasła):
<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.

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

Przykład treści POST:
{“method”:”sms.send_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”to”:”123456789″,”message”:”My message”}}
lub
{“method”:”sms.send_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”to”:”123456789″,”message”:”My message”,”date”:”201401152132″}}
lub
{“method”:”sms.send_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”to”:”123456789″,”message”:”My message”,”highpriority”:”1″}}

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

Przykłady:
https://url-of-smseagle/index.php/http_api/send_togroup?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&groupname=admins&message=mymessage
lub
https://url-of-smseagle/index.php/http_api/send_togroup?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&groupname=admins&message=mymessage&date=201401152132
lub
https://url-of-smseagle/index.php/http_api/send_togroup?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&groupname=admins&message=mymessage&highpriority=1

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.

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

Przykład treści POST:
{“method”:”sms.send_togroup”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”groupname”:”admins”,”message”:”mymessage”}}
lub
{“method”:”sms.send_togroup”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”groupname”:”admins”,”message”:”mymessage”,”date”:”201401152132″}}
lub
{“method”:”sms.send_togroup”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”groupname”:”admins”,”message”:”mymessage”,”highpriority”:”1″}}

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

Przykłady:
https://url-of-smseagle/index.php/http_api/send_tocontact?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contactname=johndoe&message=mymessage
lub
https://url-of-smseagle/index.php/http_api/send_tocontact?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contactname=johndoe&message=mymessage&date=201401152132
lub
https://url-of-smseagle/index.php/http_api/send_tocontact?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contactname=jonhdoe&message=mymessage&highpriority=1

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ź (jeśli kontakt nie istnieje w Książce adresowej):
<xml>
<error_text>Invalid contact name – [contact_name]</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.

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

Przykład treści POST:
{“method”:”sms.send_tocontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”contactname”:”johndoe”,”message”:”mymessage”}}
lub
{“method”:”sms.send_tocontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”contactname”:”johndoe”,”message”:”mymessage”,”date”:”201401152132″}}
lub
{“method”:”sms.send_tocontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”contactname”:”admins”,”message”:”mymessage”,”highpriority”:”1″}}

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?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=1234567&udh=0605040B8423F0&data=EA0601AE02056A0045C60C037777772E736D736561676C652E657500080103534D534561676C65000101

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

Przykład treści POST:
{“method”:”sms.send_binary_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”to”:”1234567″,”udh”:”0605040B8423F0″,”data”:”EA0601AE02056A0045C60C037777772E736D736561676C652E657500080103534D534561676C65000101″}}

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

Przykład:
https://url-of-smseagle/index.php/http_api/send_ussd?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=%2A101%23

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

Przykład treści POST:
{“method”:”sms.send_ussd”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”to”:”*101#”}}

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?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=inbox

Pokaż nieprzeczytanie wiadomości z inbox:
https://url-of-smseagle/index.php/http_api/read_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=inbox&unread=1

Pokaż wiadomości z folderu folder sentitems z id od 1234 do 1236:
https://url-of-smseagle/index.php/http_api/read_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=sentitems&idfrom=1234&idto=1236

Pokaż wiadomości z folderu inbox dla numeru +481234567
https://url-of-smseagle/index.php/http_api/read_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&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?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=sentitems&to=7654321&datefrom=20141224081000&dateto=20141231235959

Odpowiedź:
Przykładowe odpowiedzi: folder inbox, folder sentitems
Odpowiedź (kiedy brak danych): No data to display
Odpowiedź (przy błędnej autoryzacji za pomocą tokena): Invalid access token
Odpowiedź (przy błędnej autoryzacji za pomocą użytkownika/hasła): Invalid login or password
Odpowiedź (przy błędnych parametrach): Wrong parameters

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”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”inbox”}}

Pokaż nieprzeczytanie wiadomości z inbox:
{“method”:”sms.read_sms”,”params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”inbox”,”unread”:”1″}}

Pokaż wiadomości z folderu folder sentitems z id od 1234 do 1236:
{“method”:”sms.read_sms”,”params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”sentitems”,”idfrom”:”1234″,”idto”:”1236″}}

Pokaż wiadomości z folderu inbox dla numeru +481234567
{“method”:”sms.read_sms”,”params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”inbox”,”from”:”123456789″}}

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”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”sentitems”,”to”:”7654321″,”datefrom”:”20141224081000″,”dateto”:”20141231235959″}}

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?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&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?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=inbox&idfrom=1234&idto=1250

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

Odpowiedź:
Odpowiedź: OK
Odpowiedź (gdy operacja usuwania nie powiodła się): Error
Odpowiedź (przy błędnej autoryzacji za pomocą tokena): Invalid access token
Odpowiedź (przy błędnej autoryzacji za pomocą użytkownika/hasła): 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>

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”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”inbox”,”idfrom”:”1234″”idto”:”1234″}}

Usuń wiadomości z id 1234 – 1250 z folderu inbox:
{“method”:”sms.delete_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”inbox”,”idfrom”:”1234″,”idto”:”1250″}}

Usuń wszystkie wiadomości z folderu outbox:
{“method”:”sms.delete_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”outbox”,”idfrom”:”1″,”idto”:”999999999″}}

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”}}

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?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq

Odpowiedź:
Odpowiedź: [ilość wiadomości w kolejce do przetworzenia przez modem GSM/3G]
Przykład odpowiedzi: 7
Odpowiedź (przy błędnej autoryzacji za pomocą tokena): Invalid access token
Odpowiedź (przy błędnej autoryzacji za pomocą użytkownika/hasła): 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>

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

Przykład treści POST:
{“method”:”sms.get_queue_length”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”}}

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”: “Invalid access token”}
Odpowiedź: {“result”: “Wrong parameters”}

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

https://url-of-smseagle/index.php/http_api/get_inbox_length?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq

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>

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

Przykład treści POST:
{“method”:”sms.get_inbox_length”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”}}

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?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq

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

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

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>

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

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

Odpowiedź: OK
Odpowiedź (przy błędnych danych logowania): Invalid login or password
Odpowiedź (jeśli modem nie wspiera połączeń głosowych): This modem doesn’t support voice calls
Odpowiedź (przy niepoprawnych parametrach):
Wrong or missing >>to<< parameter
Wrong or missing >>duration<< parameter
Odpowiedź (przy niepoprawnym parametrze modem_no): Modem not recognized

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

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

Odpowiedź (przy niepoprawnych parametrach):
<xml>
<error_text>Wrong or missing >>duration<< parameter</error_text>
<status>error</status>
</xml>

Odpowiedź (jeśli modem nie wspiera połączeń głosowych):
<xml>
<error_text>This modem doesn’t support voice calls</error_text>
<status>error</status>
</xml>

Odpowiedź (przy niepoprawnym parametrze modem_no):
<xml>
<error_text> Modem not recognized </error_text>
<status>error</status>
</xml>

Uwaga: Ta metoda jest dostępna wyłącznie w urządzeniach z modemem 3G

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

Odpowiedź: {“result”: “OK”}
Odpowiedź (przy błędnych danych logowania): {“result”: “Invalid login or password”}
Odpowiedź (jeśli modem nie wspiera połączeń głosowych): {“result”: “This modem doesn’t support voice calls”}
Odpowiedź (przy niepoprawnych parametrach):
{“result”: “Wrong or missing >>to<< parameter”}
{“result”: “Wrong or missing >>duration<< parameter”}
Odpowiedź (przy niepoprawnym parametrze modem_no): {“result”: ” Modem not recognized”}

Odpowiedź (extended):
Odpowiedź: {“result”:{“status”:”ok”}}
Odpowiedź (przy błędnych danych logowania):
{“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Odpowiedź (przy niepoprawnych parametrach):
{“result”: {“error_text”:”Wrong or missing >>to<< parameter”,”status”:”error”}}
{“result”: {“error_text”:”Wrong or missing >>duration<< parameter”,”status”:”error”}}
Odpowiedź (jeśli modem nie wspiera połączeń głosowych): {“result”: {“error_text”:”This modem doesn’t support voice calls”,”status”:”error”}}
Odpowiedź (przy niepoprawnym parametrze modem_no): {“result”: {“error_text”:”Modem not recognized”,”status”:”error”}}

Uwaga: Ta metoda jest dostępna wyłącznie w urządzeniach z modemem 3G

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

Odpowiedź: enabled/disabled
Przykładowa odpowiedź: enabled
Odpowiedź (przy błędnych danych logowania): Invalid login or password
Odpowiedź (przy niepoprawnym parametrze modem_no):Wrong modem number

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

Przykładowa odpowiedź:
<xml>
<modem_status>enabled</modem_status>
<status>ok</status>
</xml>

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

Odpowiedź (przy niepoprawnym parametrze modem_no):
<xml>
<error_text> Wrong modem number</error_text>
<status>error</status>
</xml>

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

Odpowiedź:
{“result”: enabled / disabled }
Przykładowa odpowiedź: {“result”:”enabled”}
Odpowiedź (przy błędnych danych logowania): {“result”: “Invalid login or password”}
Odpowiedź (przy niepoprawnym parametrze modem_no): {“result”: “Wrong modem number”}

Odpowiedź (extended):
Odpowiedź: {“result”:{“modem_status”: enabled / disabled,”status”:”ok”}}

Przykładowa odpowiedź: {“result”: {“modem_status”:”Wrong modem number”,”status”:”ok”}}
Odpowiedź (przy błędnych danych logowania): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Odpowiedź (przy niepoprawnym parametrze modem_no): {“result”: {“error_text”:”Wrong modem number”,”status”:”error”}}

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

Odpowiedź:
Odpowiedź: OK
Odpowiedź (przy błędnych danych logowania): Invalid login or password
Odpowiedź (przy niepoprawnym parametrze modem_no): Wrong modem number
Odpowiedź (przy niepoprawnym parametrze status): Wrong modem state

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

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

Odpowiedź (przy niepoprawnym parametrze modem_no):
<xml>
<error_text> Wrong modem number</error_text>
<status>error</status>
</xml>

Odpowiedź (przy niepoprawnym parametrze status):
<xml>
<error_text>Wrong modem state</error_text>
<status>error</status>
</xml>

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

Odpowiedź:
{“result”: enabled / disabled }

Przykładowa odpowiedź: {“result”:”enabled”}
Odpowiedź (przy błędnych danych logowania): {“result”: “Invalid login or password”}
Odpowiedź (przy niepoprawnym parametrze modem_no): {“result”: “Wrong modem number”}
Odpowiedź (przy niepoprawnym parametrze status): {“result”: “Wrong modem state”}

Odpowiedź (extended):
Odpowiedź: {“result”:{“modem_status”: enabled / disabled,”status”:”ok”}}

Przykładowa odpowiedź: {“result”: {“modem_status”:”Wrong modem number”,”status”:”ok”}}
Odpowiedź (przy błędnych danych logowania): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Odpowiedź (przy niepoprawnym parametrze modem_no): {“result”: {“error_text”:”Wrong modem number”,”status”:”error”}}
Odpowiedź (przy niepoprawnym parametrze status): {“result”: {“error_text”:”Wrong modem state”,”status”:”error”}}

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

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

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

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

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

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

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

Przykład:
https://url-of-smseagle/index.php/http_api/group_delete?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&group_id=2&groupname=myusers

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>

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

Przykład treści POST:
{“method”:”phonebook.group_delete”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”group_id”:”2″,”groupname”:”myusers”}}

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

Przykład:
https://url-of-smseagle/index.php/http_api/group_addcontact?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&group_id=2&contact_id=1

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

Przykład treści POST:
{“method”:”phonebook.group_addcontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”group_id”:”2″,”contact_id”:”1″}}

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

Przykład:
https://url-of-smseagle/index.php/http_api/group_removecontact?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&group_id=2&contact_id=1

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

Przykład treści POST:
{“method”:”phonebook.group_removecontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”group_id”:”2″,”contact_id”:”1″}}

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

Przykład:
https://url-of-smseagle/index.php/http_api/contact_create?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contactname=johndoe&number=12345678&public=1

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

Przykład treści POST:
{“method”:”phonebook.contact_create”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”contactname”:”johndoe”,”number”:”12345678″,”public”:”1″}}

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

Przykład:
https://url-of-smseagle/index.php/http_api/contact_read?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&public=1&uid=12

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

Przykład treści POST:
{“method”:”phonebook.contact_read”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”public”:”1″,”uid”:”12″}}

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

Przykład:
https://url-of-smseagle/index.php/http_api/contact_update?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contact_id=4&contactname=johnlord&number=123456789&public=1

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

Przykład treści POST:
{“method”:”phonebook.contact_update”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”contact_id”:”4″,”contactname”:”johnlord”,”number”:”123456789″,”public”:”1″}}

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

Przykład:
https://url-of-smseagle/index.php/http_api/contact_delete?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contact_id=4&contactname=johnlord

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

Przykład treści POST:
{“method”:”phonebook.contact_delete”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”contact_id”:”4″,”contactname”:”johnlord”}}