Before you can start using API, first you need to enable API access.

1. Go to Web-GUI > menu Users
2. Create a new User with access level “User”
3. Click on “Access to API” next to the newly created user
4. Enable “APIv1” and  select all methods under “APIv1 Permission” (optionally you may limit access only to selected API methods)
5. Choose API authentication method. This can be either:
   • access token (recommended solution)
     Edit your API access > click “Generate new token” and generate a new access token. The token will be used to authenticate in API methods.
     or
   • login and password
     Edit your API access > click “Enable user/password authentication (APIv1 only)”. Use your API User credentials to authenticate in API methods.

Examples of authentication:

• with access token
  https://url-of-smseagle/http_api/send_sms?access_token=0001gOjCOlMH8F2q&to=1234567&message=mymessage
• with login and password
  https://url-of-smseagle/http_api/send_sms?login=john&pass=doe&to=1234567&message=mymessage

API credentials created here will be used to authenticate in all API methods (see descriptions below).

HTTP GET method: https://url-of-smseagle/http_api/send_sms

Examples:
https://url-of-smseagle/http_api/send_sms?access_token=0005gOjCOlMH8F2BP8&to=1234567&message=mymessage
or
https://url-of-smseagle/http_api/send_sms?access_token=0005gOjCOlMH8F2BP8&to=1234567&message=mymessage&date=201401152132
or
https://url-of-smseagle/http_api/send_sms?access_token=0005gOjCOlMH8F2BP8&to=1234567&message=mymessage&highpriority=1

Response:
Response: OK; ID=[ID of message in outbox]
Sample response: OK; ID=297
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters): Wrong parameters

Response (XML):
Response:
<xml>
<message_id>[ID of message in outbox]</message_id>
<status>ok</status>
</xml>

Sample response:
<xml>
<message_id>297</message_id>
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Important notice: You must encode URL before sending it to gateway if you use national characters in SMS message text.

HTTP POST method call: https://url-of-smseagle/jsonrpc/sms

Sample Body:
{“method”:”sms.send_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”to”:”481234567″,”message”:”My message”}}
or
{“method”:”sms.send_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”to”:”481234567″,”message”:”My message”,”date”:”201401152132″}}
or
{“method”:”sms.send_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”to”:”481234567″,”message”:”My message”,”highpriority”:”1″}}
Sample Body (MMS):
{“method”:”sms.send_sms”, “params”:{„access_token”:”0005gOjCOlMH8F2BP8”,”to”:”481234567″,”message”:”My message”,”message_type”:”mms”,
“attachments”: [{
“content_type”:”image/png”,
“content “:”/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAE(…)”,
}]}}

HTTP GET method: https://url-of-smseagle/http_api/send_togroup

Examples:
https://url-of-smseagle/http_api/send_togroup?access_token=0005gOjCOlMH8F2BP8&groupname=admins&message=mymessage
or
https://url-of-smseagle/http_api/send_togroup?access_token=0005gOjCOlMH8F2BP8&groupname=admins&message=mymessage&date=201401152132
or
https://url-of-smseagle/http_api/send_togroup?access_token=0005gOjCOlMH8F2BP8&groupname=admins&message=mymessage&highpriority=1

Response:
<xml>
<message_id>[ID of message in outbox]</message_id>
<status>ok</status>
</xml>

Sample response:
<xml>
<message_id>297</message_id>
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Important notice: You must encode URL before sending it to gateway if you use national characters in SMS message text.

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”sms.send_togroup”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”groupname”:”admins”,”message”:”mymessage”}}
or
{“method”:”sms.send_togroup”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”groupname”:”admins”,”message”:”mymessage”,”date”:”201401152132″}}
or
{“method”:”sms.send_togroup”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”groupname”:”admins”,”message”:”mymessage”,”highpriority”:”1″}}
Sample Body (MMS):
{“method”:”sms.send_sms”, “params”:{„access_token”:”0005gOjCOlMH8F2BP8”,”to”:”481234567″,”message”:”My message”,”message_type”:”mms”,
“attachments”: [{
“content_type”:”image/png”,
“content “:”/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAE(…)”,
}]}}

HTTP GET method: https://url-of-smseagle/http_api/send_tocontact

Examples:
https://url-of-smseagle/http_api/send_tocontact?access_token=0005gOjCOlMH8F2BP8&contactname=johndoe&message=mymessage
or
https://url-of-smseagle/http_api/send_tocontact?access_token=0005gOjCOlMH8F2BP8&contactname=johndoe&message=mymessage&date=201401152132
or
https://url-of-smseagle/http_api/send_tocontact?access_token=0005gOjCOlMH8F2BP8&contactname=johndoe&message=mymessage&highpriority=1

Response:
<xml>
<message_id>[ID of message in outbox]</message_id>
<status>ok</status>
</xml>

Sample response:
<xml>
<message_id>297</message_id>
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when contact doesn’t exist):
<xml>
<error_text>Invalid contact name – [contact_name]</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Important notice: You must encode URL before sending it to gateway if you use national characters in SMS message text.

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”sms.send_tocontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”contactname”:”johndoe”,”message”:”mymessage”}}
or
{“method”:”sms.send_tocontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”contactname”:”johndoe”,”message”:”mymessage”,”date”:”201401152132″}}
or
{“method”:”sms.send_tocontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”contactname”:”admins”,”message”:”mymessage”,”highpriority”:”1″}}
Sample Body (MMS):
{“method”:”sms.send_sms”, “params”:{„access_token”:”0005gOjCOlMH8F2BP8”,”to”:”481234567″,”message”:”My message”,”message_type”:”mms”,
“attachments”: [{
“content_type”:”image/png”,
“content “:”/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAE(…)”,
}]}}

HTTP GET method: https://url-of-smseagle/http_api/send_binary_sms

Example:
https://url-of-smseagle/http_api/send_binary_sms?access_token=0005gOjCOlMH8F2BP8&to=1234567&udh=0605040B8423F0&data=EA0601AE02056A0045C60C037777772E736D736561676C652E657500080103534D534561676C65000101

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”sms.send_binary_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”to”:”1234567″,”udh”:”0605040B8423F0″,”data”:”EA0601AE02056A0045C60C037777772E736D736561676C652E657500080103534D534561676C65000101″}}

HTTP GET method: https://url-of-smseagle/http_api/send_ussd

Example:
https://url-of-smseagle/http_api/send_ussd?access_token=0005gOjCOlMH8F2BP8&to=%2A101%23

Important notice: Response from 3G/4G network will show up in Inbox folder.

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”sms.send_ussd”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”to”:”*101#”}}

HTTP GET method: https://url-of-smseagle/http_api/read_sms

Examples:
Show all messages from inbox:
https://url-of-smseagle/http_api/read_sms?access_token=0005gOjCOlMH8F2BP8&folder=inbox

Show all unread messages from inbox:
https://url-of-smseagle/http_api/read_sms?access_token=0005gOjCOlMH8F2BP8&folder=inbox&unread=1

Show messages from sentitems folder with id=1234 to 1236:
https://url-of-smseagle/http_api/read_sms?access_token=0005gOjCOlMH8F2BP8&folder=sentitems&idfrom=1234&idto=1236

Show messages from inbox folder with sender phone number +481234567:
https://url-of-smseagle/http_api/read_sms?access_token=0005gOjCOlMH8F2BP8&folder=inbox&from=+481234567

Show messages from sentitems folder with receiver phone number 7654321 and datetime from 2014-12-24 08:10:00 to 2014-12-31 23:59:59:
https://url-of-smseagle/http_api/read_sms?access_token=0005gOjCOlMH8F2BP8&folder=sentitems&to=7654321&datefrom=20141224081000&dateto=20141231235959

Response:
Sample responses: inbox folder, sentitems folder
Response (when no data): No data to display
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters): Wrong parameters

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Samle body:
Show all messages from inbox:
{“method”:”sms.read_sms”,”params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”folder”:”inbox”}}

Show all unread messages from inbox:
{“method”:”sms.read_sms”,”params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”folder”:”inbox”,”unread”:”1″}}

Show messages from sentitems folder with id=1234 to 1236:
{“method”:”sms.read_sms”,”params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”folder”:”sentitems”,”idfrom”:”1234″,”idto”:”1236″}}

Show messages from inbox folder with sender phone number +481234567:
{“method”:”sms.read_sms”,”params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”folder”:”inbox”,”from”:”481234567″}}

Show messages from sentitems folder with receiver phone number 7654321 and datetime from 2014-12-24 08:10:00 to 2014-12-31 23:59:59:
{“method”:”sms.read_sms”,”params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”folder”:”sentitems”,”to”:”7654321″,”datefrom”:”20141224081000″,”dateto”:”20141231235959″}}

HTTP GET method: https://url-of-smseagle/http_api/delete_sms

Examples:
Delete message with id=1234 from inbox:
http://url-of-smseagle/index.php/http_api/delete_sms?access_token=0005gOjCOlMH8F2BP8&folder=inbox&idfrom=1234&idto=1234

Delete messages with id 1234 – 1250 from inbox:
http://url-of-smseagle/index.php/http_api/delete_sms?access_token=0005gOjCOlMH8F2BP8&folder=inbox&idfrom=1234&idto=1250

Delete all messages from outbox:
http://url-of-smseagle/index.php/http_api/delete_sms?access_token=0005gOjCOlMH8F2BP8&folder=outbox&idfrom=1&idto=999999999

Response:
Response: OK
Response (when delete operation was not successful): Error
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token

Response (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when delete operation was not successful):
<xml>
<status>error</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Sample body:
Delete message with id=1234 from inbox:
{“method”:”sms.delete_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”folder”:”inbox”,”idfrom”:”1234″”idto”:”1234″}}

Delete messages with id 1234 – 1250 from inbox:
{“method”:”sms.delete_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”folder”:”inbox”,”idfrom”:”1234″,”idto”:”1250″}}

Delete all messages from outbox:
{“method”:”sms.delete_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”folder”:”outbox”,”idfrom”:”1″,”idto”:”999999999″}}

Response:
Response: {“result”: “OK”}
Response (when delete operation was not successful): {“result”: “Error”}
Response (when wrong logindata): {“result”: “Invalid login or password”}
Response (when wrong access token): {“result”: “Invalid access token”}

Response (Extended):
Response: {“result”:{“status”:”ok”}}
Response (when delete operation was not successful): {“result”:{“status”:”error”}}
Response (when wrong logindata): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Response (when wrong access token): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}

HTTP GET method: https://url-of-smseagle/http_api/get_queue_length

Example:
https://url-of-smseagle/http_api/get_queue_length?access_token=0005gOjCOlMH8F2BP8

Response:
Response: [number of messages in database that wait to be processed by 3G/4G-modem]
Sample response: 7
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters): Wrong parameters

Response (XML):
Response:
<xml>
<queue_length>
[number of messages in database that wait to be processed by 3G/4G-modem]
</queue_length >
<status>ok</status>
</xml>

Sample response:
<xml>
<queue_length>7</queue_length >
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

HTTP POST method call: https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”sms.get_queue_length”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″}}

Response:
Response: {“result”: [number of messages in database that wait to be processed by 3G/4G-modem]}
Sample response: {“result”:7}
Response: {“result”: “Invalid login or password”}
Response (when wrong access token): {“result”: “Invalid access token”}
Response: {“result”: “Wrong parameters”}

HTTP GET method: https://url-of-smseagle/http_api/get_inbox_length

https://url-of-smseagle/http_api/get_inbox_length?access_token=0005gOjCOlMH8F2BP8

Response:
<xml>
<queue_length>
[number of messages in database Inbox folder]
</queue_length>
<status>ok</status>
</xml>

Sample response:
<xml>
<inbox_length>3</inbox_length>
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”sms.get_inbox_length”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″}}

HTTP GET method: https://url-of-smseagle/http_api/get_sentitems_length

Example:
https://url-of-smseagle/http_api/get_sentitems_length?access_token=0005gOjCOlMH8F2BP8

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

HTTP GET method: https://url-of-smseagle/http_api/get_sendingerror_length

https://url-of-smseagle/http_api/get_sendingerror_length?access_token=0005gOjCOlMH8F2BP8

Response:
<xml>
<queue_length>
[number of messages in database Sending error folder]
</queue_length>
<status>ok</status>
</xml>

Sample response:
<xml>
<inbox_length>3</inbox_length>
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”sms.get_sendingerror_length”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″}}

HTTP GET method: https://url-of-smseagle/http_api/get_gsmsignal

Response:
<xml>
<signal_strength>
[3G/4G signal strength in percent (values between 0-100)]
</signal_strength>
<status>ok</status>
</xml>

Sample response:
<xml>
<signal_strength>74</signal_strength>
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

HTTP GET method: https://url-of-smseagle/http_api/call_with_termination

Response (when wrong access token): Invalid access token

Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):
<xml>
<error_text>Wrong or missing >>duration<< parameter</error_text>
<status>error</status>
</xml>

Response (when modem doesn’t support voice calls):
<xml>
<error_text>This modem doesn’t support voice calls</error_text>
<status>error</status>
</xml>

Response (when modem_no is wrong):
<xml>
<error_text> Modem not recognized </error_text>
<status>error</status>
</xml>

Important notice: this method is available only for devices with voice modem

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

HTTP GET method:
https://url-of-smseagle/http_api/get_modem_state

Example:
https://url-of-smseagle/http_api/get_modem_state?access_token=0005gOjCOlMH8F2BP8&modem_no=1

Response:
Response: enabled / disabled
Sample response: enabled
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when modem doesn’t exist): Wrong modem number

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

Sample response:
<xml>
<modem_status>enabled</modem_status>
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when modem doesn’t exist):
<xml>
<error_text> Wrong modem number</error_text>
<status>error</status>
</xml>

HTTP POST method:
https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”sms.get_modem_state”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″}}

Response:
{“result”: enabled / disabled }
Sample response: {“result”:”enabled”}
Response (when wrong logindata): {“result”: “Invalid login or password”}
Response (when wrong access token): {“result”:”Invalid access token”}
Response (when modem doesn’t exist): {“result”: “Wrong modem number”}

Response (Extended):
Response: {“result”:{“modem_status”: enabled / disabled,”status”:”ok”}}

Sample response: {“result”: {“modem_status”:”Wrong modem number”,”status”:”ok”}}
Response (when wrong logindata): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Response (when wrong access token): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Response (when modem doesn’t exist): {“result”: {“error_text”:”Wrong modem number”,”status”:”error”}}

HTTP GET method:
https://url-of-smseagle/http_api/set_modem_state

Example:
https://url-of-smseagle/http_api/set_modem_state?access_token=0005gOjCOlMH8F2BP8&modem_no=1&status=enabled

Response:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when modem doesn’t exist): Wrong modem number
Response (when wrong modem state): Wrong modem state

Response (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when modem doesn’t exist):
<xml>
<error_text> Wrong modem number</error_text>
<status>error</status>
</xml>

Response (when wrong modem state):
<xml>
<error_text>Wrong modem state</error_text>
<status>error</status>
</xml>

HTTP POST method:
https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”sms.set_modem_state”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″, “status”:”enabled”}}

Response:
{“result”: enabled / disabled }

Sample response: {“result”:”enabled”}
Response (when wrong logindata): {“result”: “Invalid login or password”}
Response (when wrong access token): {“result”:”Invalid access token”}
Response (when modem doesn’t exist): {“result”: “Wrong modem number”}
Response (when wrong modem state): {“result”: “Wrong modem state”}

Response (Extended):
Response: {“result”:{“modem_status”: enabled / disabled,”status”:”ok”}}

Sample response: {“result”: {“modem_status”:”Wrong modem number”,”status”:”ok”}}
Response (when wrong logindata): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Response (when wrong access token): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Response (when modem doesn’t exist): {“result”: {“error_text”:”Wrong modem number”,”status”:”error”}}
Response (when wrong modem state): {“result”: {“error_text”:”Wrong modem state”,”status”:”error”}}

HTTP GET method: https://url-of-smseagle/http_api/group_create

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

HTTP GET method: https://url-of-smseagle/http_api/group_read

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

HTTP GET method: https://url-of-smseagle/http_api/group_update

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

HTTP GET method: https://url-of-smseagle/http_api/group_delete

Example:
https://url-of-smseagle/http_api/group_delete?access_token=0005gOjCOlMH8F2BP8&group_id=2&groupname=myusers

Response (XML):
Response:
<xml>
<status>ok</status>
</xml>Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):
<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>

Response (when group_id is wrong):
<xml>
<error_text>Group with the given id does not exists</error_text>
<status>error</status>
</xml>

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.group_delete”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”group_id”:”2″,”groupname”:”myusers”}}

HTTP GET method: https://url-of-smseagle/http_api/group_addcontact

Example:
https://url-of-smseagle/http_api/group_addcontact?access_token=0005gOjCOlMH8F2BP8&group_id=2&contact_id=1

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.group_addcontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”group_id”:”2″,”contact_id”:”1″}}

HTTP GET method: https://url-of-smseagle/http_api/group_removecontact

Example:
https://url-of-smseagle/http_api/group_removecontact?access_token=0005gOjCOlMH8F2BP8&group_id=2&contact_id=1

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.group_removecontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”group_id”:”2″,”contact_id”:”1″}}

HTTP GET method:
https://url-of-smseagle/http_api/group_members_read

Example:
https://url-of-smseagle/http_api/group_members_read?access_token=0005gOjCOlMH8F2BP8&group_id=11

Response:
Sample response: link
Response (when wrong or missing group_id parameter): Wrong or missing >>group_id<< parameter
Response (when wrong user_id parameter): Wrong >>user_id<< parameter
Response (when wrong public parameter): Wrong >>public<< parameter
Response (when result set is empty): No data to display

Response (XML):

Response:
<xml>
<contacts>
<contact>
<ID>17</ID>
<Name>mycontact1</Name>
<Number>23456</Number>
<id_user>1</id_user>
<is_public>true</is_public>
</contact>
<contact>
<ID>24</ID>
<Name>mycontact3</Name>
<Number>12345</Number>
<id_user>3</id_user>
<is_public>false</is_public>
</contact>
</contacts>
</xml>

Response (when wrong or missing group_id parameter):
<xml>
<error_text>Wrong or missing >>group_id<< parameter</error_text>
<status>error</status>
</xml>

Response (when wrong user_id parameter):
<xml>
<error_text>Wrong >>user_id<< parameter</error_text>
<status>error</status>
</xml>

Response (when wrong public parameter):
<xml>
<error_text> Wrong >>public<< parameter </error_text>
<status>error</status>
</xml>

HTTP POST method:
https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.group_members_read”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”group_id”:”11″}}

Response:
Sample response:
{
“result”: [
{“ID”:”1706″,”Name”:”mycontact1″,”Number”:”23456″,
“id_user”:”1″,”is_public”:”true”},
{“ID”:”1693″,”Name”:”mycontact3″,”Number”:”12345″,
“id_user”:”3″,”is_public”:”false”}]
}

Response (when wrong or missing group_id parameter): {“result”: “Wrong or missing >>group_id<< parameter”}
Response (when wrong user_id parameter): {“result”: “Wrong >>user_id<< parameter”}
Response (when wrong public parameter): {“result”: “Wrong >>public<< parameter”}

Response (Extended):
Sample response:
{
“result”: {
“contacts”: [
{“ID”:”1706″,”Name”:”mycontact1″,”Number”:”23456″,
“id_user”:”1″,”is_public”:”true”},
{“ID”:”1693″,”Name”: “mycontact3″,”Number”:”12345″,
“id_user”:”3″,”is_public”:”false”}],
“status”: “ok”}
}

Response (when wrong logindata): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Response (when wrong access token): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Response (when wrong or missing group_id parameter): {“result”: {“error_text”:”Wrong or missing >>group_id<< parameter”,”status”:”error”}}
Response (when wrong user_id parameter): {“result”: “Wrong >>user_id<< parameter”}
Response (when wrong public parameter): {“result”: “Wrong >>public<< parameter”}

HTTP GET method: https://url-of-smseagle/http_api/contact_create

Example:
https://url-of-smseagle/http_api/contact_create?access_token=0005gOjCOlMH8F2BP8&contactname=johndoe&number=12345678&public=1

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.contact_create”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”contactname”:”johndoe”,”number”:”12345678″,”public”:”1″}}

HTTP GET method: https://url-of-smseagle/http_api/contact_read

Example:
https://url-of-smseagle/http_api/contact_read?access_token=0005gOjCOlMH8F2BP8&public=1&uid=12

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.contact_read”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”public”:”1″,”uid”:”12″}}

HTTP GET method: https://url-of-smseagle/http_api/contact_update

Example:
https://url-of-smseagle/http_api/contact_update?access_token=0005gOjCOlMH8F2BP8&contact_id=4&contactname=johnlord&number=123456789&public=1

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.contact_update”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”contact_id”:”4″,”contactname”:”johnlord”,”number”:”123456789″,”public”:”1″}}

HTTP GET method: https://url-of-smseagle/http_api/contact_delete

Example:
https://url-of-smseagle/http_api/contact_delete?access_token=0005gOjCOlMH8F2BP8&contact_id=4&contactname=johnlord

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.contact_delete”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”contact_id”:”4″,”contactname”:”johnlord”}}

HTTP GET method: https://url-of-smseagle/http_api/shift_create

Example:
https://url-of-smseagle/http_api/shift_create?access_token=0005gOjCOlMH8F2BP8&name=myshift&mon_from=08:00&mon_to=16:00&wed_from=09:00&wed_to=20:00&enabled=1

Response:
Response: OK; ID=[ID of created shift]
Sample response: OK; ID=5
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters): Wrong or missing >>name<< parameter

Response (XML):
Response:
<xml>
<shift_id>[ID of created shift]</shift_id>
<status>ok</status>
</xml>

Sample response:
<xml>
<shift_id>5</shift_id>
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):
<xml>
<error_text>Wrong or missing >>name<< parameter</error_text>
<status>error</status>
</xml>

HTTP POST method: https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.shift_create”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”name”:”myshift”,”mon_from”:”08:00″,”mon_to”:”16:00″,”wed_from”:”09:00″,”wed_to”:”20:00″,”enabled”:”1″}}

Response:
Response: {“result”: “OK; ID=[ID of created shift]”}
Sample response: {“result”: “OK; ID=5”}
Response (when wrong logindata): {“result”: “Invalid login or password”}
Response (when wrong access token): {“result”:”Invalid access token”}
Response (when wrong parameters): {“result”: “Wrong or missing >>name<< parameter”}

Response (Extended):
Response: {“result”: {“shift_id”:”[ID of created shift]”,”status”:”ok”}}
Sample response: {“result”: {“shift_id”:”748″,”status”:”ok”}}
Response (when wrong logindata): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Response (when wrong access token): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Response (when wrong parameters): {“result”: {“error_text”:” Wrong or missing >>name<< parameter “,”status”:”error”}}

HTTP GET method:
https://url-of-smseagle/http_api/shift_read

Example:
https://url-of-smseagle/http_api/shift_read?access_token=0005gOjCOlMH8F2BP8&name=myshift

Response:
Sample response: link
Response (when no data): No data to display
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong >>shift_id<< parameter

Response (XML):
Sample response:
<xml>
<shifts>
<shift>
<id_shift>62</id_shift>
<name>myshift</name>
<mon_from>08:00</mon_from>
<mon_to>16:00</mon_to>
<tue_from/>
<tue_to/>
<wed_from>09:00</wed_from>
<wed_to>20:00</wed_to>
<thu_from/>
<thu_to/>
<fri_from/>
<fri_to/>
<sat_from/>
<sat_to/>
<sun_from/>
<sun_to/>
<enabled>true</enabled>
</shift>
</shifts>
<status>ok</status>
</xml>

Response (when no data):
<xml>
<error_text>No data to display</error_text>
<status>error</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):
<xml>
<error_text> Wrong >>id<< parameter</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):
<xml>
<error_text> Wrong >>enabled<< parameter</error_text>
<status>error</status>
</xml>

HTTP POST method:
https://url-of-smseagle/jsonrpc/sms

Examples:
{“method”:”phonebook.shift_read”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”name”:”myshift”}}

Response:
Sample response:

{
“result”: [
{
“id_shift”: “62”,
“name”: “myshift”,
“mon_from”: “08:00”,
“mon_to”: “16:00”,
“tue_from”: null,
“tue_to”: null,
“wed_from”: “09:00”,
“wed_to”: “20:00”,
“thu_from”: null,
“thu_to”: null,
“fri_from”: null,
“fri_to”: null,
“sat_from”: null,
“sat_to”: null,
“sun_from”: null,
“sun_to”: null,
“enabled”: “true”
}
]
}
Response (when no data): {“result”: “No data to display”}
Response (when wrong logindata): {“result”: “Invalid login or password”}
Response (when wrong access token): {“result”:”Invalid access token”}
Response (when wrong parameters):
{“result”: “Wrong >> enabled<< parameter”}
{“result”: “Wrong >>shift_id<< parameter”}

Response (EXTENDED):
Sample response:
{
“result”: {
“shifts”: [
{
“id_shift”: “62”,
“name”: “myshift”,
“mon_from”: “08:00”,
“mon_to”: “16:00”,
“tue_from”: null,
“tue_to”: null,
“wed_from”: “09:00”,
“wed_to”: “20:00”,
“thu_from”: null,
“thu_to”: null,
“fri_from”: null,
“fri_to”: null,
“sat_from”: null,
“sat_to”: null,
“sun_from”: null,
“sun_to”: null,
“enabled”: “false”
}
],
“status”: “ok”
}
}

Response (when no data):

{“result”: {“error_text”:” No data to display”,”status”:”error”}}

Response (when wrong logindata):

{“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}

Response (when wrong access token): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}

Response (when wrong parameters):

{“result”: {“error_text”:” Wrong >> enabled<< parameter “,”status”:”error”}}

{“result”: {“error_text”:” Wrong >> shift_id<< parameter “,”status”:”error”}}

HTTP GET method:
https://url-of-smseagle/http_api/shift_update

Example:
https://url-of-smseagle/http_api/shift_update?access_token=0005gOjCOlMH8F2BP8&shift_id=24&name=updatedshift&enabled=1

Response:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>name<< parameter
Wrong or missing >>shift_id<< parameter
Response (when shift_id is wrong): Shift with the given id does not exists

Response (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):
<xml>
<error_text>Wrong or missing >>name<< parameter</error_text>
<status>error</status>
</xml>

<xml>
<error_text>Wrong or missing >>shift_id<< parameter</error_text>
<status>error</status>
</xml>

Response (when shift_id is wrong):
<xml>
<error_text>Shift with given id does not exists</error_text>
<status>error</status>
</xml>

HTTP POST method:
https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.shift_update”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”shift_id”:”24″,”name”:”updatedshift”,”enabled”:”1″}}

Response:
Response: {“result”: “OK”}
Response (when wrong logindata): {“result”: “Invalid login or password”}
Response (when wrong access token): {“result”:”Invalid access token”}
Response (when wrong parameters):
{“result”: “Wrong or missing >>name<< parameter”}
{“result”: “Wrong or missing >>shift_id<< parameter”}
Response (when shift_id is wrong): {“result”: “Shift with the given id does not exists”}

Response (Extended):
Response: {“result”:{“status”:”ok”}}

Response (when wrong logindata): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Response (when wrong access token): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Response (when wrong parameters):
{“result”: {“error_text”:”Wrong or missing >>name<< parameter”,”status”:”error”}}
{“result”: {“error_text”:”Wrong or missing >>shift_id<< parameter”,”status”:”error”}}

Response (when shift_id is wrong): {“result”: {“error_text”:”Shift with the given id does not exists”,”status”:”error”}}

HTTP GET method:
https://url-of-smseagle/http_api/shift_delete

Example:
https://url-of-smseagle/http_api/shift_delete?access_token=0005gOjCOlMH8F2BP8&shift_id=24

Response:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>shift_id<< parameter
Response (when shift_id is wrong): Shift with the given id does not exist

Response (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

<xml>
<error_text>Wrong or missing >>shift_id<< parameter</error_text>
<status>error</status>
</xml>

Response (when shift_id is wrong):
<xml>
<error_text>Shift with the given id does not exists</error_text>
<status>error</status>
</xml>

HTTP POST method:
https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.shift_delete”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”shift_id”:”24″}}

Response:
Response: {“result”: “OK”}
Response (when wrong logindata): {“result”: “Invalid login or password”}
Response (when wrong access token): {“result”:”Invalid access token”}
Response (when wrong parameters):
{“result”: “Wrong or missing >>shift_id<< parameter”}
Response (when shift_id is wrong): {“result”: “Shift with the given id does not exist”}

Response (Extended):
Response: {“result”:{“status”:”ok”}}

Response (when wrong logindata): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Response (when wrong access token): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Response (when wrong parameters): {“result”: {“error_text”:”Wrong or missing >>shift_id<< parameter”,”status”:”error”}}
Response (when shift_id is wrong): {“result”: {“error_text”:”Shift with the given id does not exists”,”status”:”error”}}

HTTP GET method:
https://url-of-smseagle/http_api/shift_addcontact

Example:
https://url-of-smseagle/http_api/shift_addcontact?access_token=0005gOjCOlMH8F2BP8&shift_id=2&contact_id=1

Response:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>shift_id<< parameter
Wrong or missing >>contact_id<< parameter
Response (when id is wrong):
Shift with the given id does not exists
Contact with the given id does not exists

Response (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):
<xml>
<error_text>Wrong or missing >>shift_id<< parameter</error_text>
<status>error</status>
</xml>

<xml>
<error_text>Wrong or missing >>contact_id<< parameter</error_text>
<status>error</status>
</xml>

Response (when id is wrong):
<xml>
<error_text>Shift 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>

HTTP POST method:
https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.shift_addcontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”shift_id”:”24″,”contact_id”:”1″}}

Response:
Response: {“result”: “OK”}
Response (when wrong logindata): {“result”: “Invalid login or password”}
Response (when wrong access token): {“result”:”Invalid access token”}
Response (when wrong parameters):
{“result”: “Wrong or missing >>shift_id<< parameter”}
{“result”: “Wrong or missing >>contact_id<< parameter”}
Response (when id is wrong):
{“result”: “Shift with the given id does not exists”}
{“result”: “Contact with the given id does not exists”}

Response (Extended):
Response: {“result”:{“status”:”ok”}}

Response (when wrong logindata): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Response (when wrong access token): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Response (when wrong parameters):
{“result”: {“error_text”:”Wrong or missing >>shift_id<< parameter”,”status”:”error”}}
{“result”: {“error_text”:”Wrong or missing >>contact_id<< parameter”,”status”:”error”}}

Response (when id is wrong):
{“result”: {“error_text”:”Shift with the given id does not exists”,”status”:”error”}}
{“result”: {“error_text”:”Contact with the given id does not exists”,”status”:”error”}}

HTTP GET method:
https://url-of-smseagle/http_api/shift_removecontact

Example:
https://url-of-smseagle/http_api/shift_removecontact?access_token=0005gOjCOlMH8F2BP8&shift_id=24&contact_id=1

Response:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>shift_id<< parameter
Wrong or missing >>contact_id<< parameter
Response (when id is wrong):
Shift with the given id does not exists
Contact with the given id does not exists

Response (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):
<xml>
<error_text>Wrong or missing >>shift_id<< parameter</error_text>
<status>error</status>
</xml>

<xml>
<error_text>Wrong or missing >>contact_id<< parameter</error_text>
<status>error</status>
</xml>

Response (when id is wrong):
<xml>
<error_text>Shift 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>

HTTP POST method:
https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.shift_removecontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”shift_id”:”24″,”contact_id”:”1″}}

Response:
Response: {“result”: “OK”}
Response (when wrong logindata): {“result”: “Invalid login or password”}
Response (when wrong access token): {“result”:”Invalid access token”}
Response (when wrong parameters):
{“result”: “Wrong or missing >>shift_id<< parameter”}
{“result”: “Wrong or missing >>contact_id<< parameter”}
Response (when id is wrong):
{“result”: “Shift with the given id does not exists”}
{“result”: “Contact with the given id does not exists”}

Response (Extended):
Response: {“result”:{“status”:”ok”}}

Response (when wrong logindata): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Response (when wrong access token): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Response (when wrong parameters):
{“result”: {“error_text”:”Wrong or missing >>shift_id<< parameter”,”status”:”error”}}
{“result”: {“error_text”:”Wrong or missing >>contact_id<< parameter”,”status”:”error”}}

Response (when id is wrong):
{“result”: {“error_text”:”Shift with the given id does not exists”,”status”:”error”}}
{“result”: {“error_text”:”Contact with the given id does not exists”,”status”:”error”}}

HTTP GET method:
https://url-of-smseagle/http_api/userid_read

Example:
https://url-of-smseagle/http_api/userid_read?access_token=0005gOjCOlMH8F2BP8&username=myuser

Response:
Response: User ID
Sample response: 24
Response (when username parameter is missing): Missing >>username<< parameter
Response (when user doesn’t exist): Wrong >>username<< parameter

Response (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when username parameter is missing):
<xml>
<error_text>Missing >>username<< parameter</error_text>
<status>error</status>
</xml>

Response (when user doesn’t exist):
<xml>
<error_text>Wrong >>username<< parameter</error_text>
<status>error</status>
</xml>

HTTP POST method:
https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.userid_read”, “params”:{“access_token”:”0005gOjCOlMH8F2BP8″,”username”:”myuser”}}

Response:
{“result”: [user ID] }
Sample response: {“result”:”24″}
Response (when username parameter is missing): {“result”: “Missing >>username<< parameter”}
Response (when user doesn’t exist): {“result”: “Wrong >>username<< parameter”}

Response (Extended):
Response:
{“result”:{“uid”: [user ID],”status”:”ok”}}

Sample response: {“result”: {“uid”:”24″,”status”:”ok”}}
Response (when wrong logindata): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Response (when wrong access token): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Response (when username parameter is missing): {“result”: {“error_text”:”Missing >>username<< parameter”,”status”:”error”}}
Response (when user doesn’t exist): {“result”: {“error_text”:”Wrong >>username<< parameter”,”status”:”error”}}

HTTP GET method:
https://url-of-smseagle/http_api/group_members_read

Example:
https://url-of-smseagle/http_api/group_members_read? access_token=0005gOjCOlMH8F2x&group_id=11

Response:

Response (when wrong or missing group_id parameter): Wrong or missing >>group_id<< parameter
Response (when wrong user_id parameter): Wrong >>user_id<< parameter
Response (when wrong public parameter): Wrong >>public<< parameter
Response (when result set is empty): No data to display

RESPONSE (XML):
Response:
<xml>
<contacts>
<contact>
<ID>17</ID>
<Name>mycontact1</Name>
<Number>23456</Number>
<id_user>1</id_user>
<is_public>true</is_public>
</contact>
<contact>
<ID>24</ID>
<Name>mycontact3</Name>
<Number>12345</Number>
<id_user>3</id_user>
<is_public>false</is_public>
</contact>
</contacts>
</xml>
Response (when wrong or missing group_id parameter):
<xml>
<error_text>Wrong or missing >>group_id<< parameter</error_text>
<status>error</status>
</xml>
Response (when wrong user_id parameter):
<xml>
<error_text>Wrong >>user_id<< parameter</error_text>
<status>error</status>
</xml>
Response (when wrong public parameter):
<xml>
<error_text> Wrong >>public<< parameter </error_text>
<status>error</status>
</xml>

HTTP POST method:
https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.group_members_read”, “params”:{“access_token”:”0005gOjCOlMH8F2x”,”group_id”:”11″}}

Response:
Response: {“result”: “OK”}
Response (when wrong logindata): {“result”: “Invalid login or password”}
Response (when wrong access token): {“result”:”Invalid access token”}
Response (when wrong or missing group_id parameter):
{“result”: “Wrong or missing >>group_id<< parameter”}
Response (when wrong user_id parameter): {“result”: “Wrong >>user_id<< parameter”}
Response (when wrong public parameter): {“result”: “Wrong >>public<< parameter”}

Response (Extended):
Response: {“result”:{“status”:”ok”}}

Response (when wrong logindata): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Response (when wrong access token): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Response (when wrong or missing group_id parameter): {“result”: {“error_text”:”Wrong or missing >>group_id<< parameter”,”status”:”error”}}
Response (when wrong user_id parameter): {“result”: “Wrong >>user_id<< parameter”}
Response (when wrong public parameter): {“result”: “Wrong >>public<< parameter”}

Important Notice: This feature is available only devices with 3G modems.

HTTP GET method:
https://url-of-smseagle/http_api/call_forward_read

Example:
https://url-of-smseagle/http_api/call_forward_read? access_token=0005gOjCOlMH8F2x&modem_no=1

Response:

Sample response: 0 (call forwarding disabled)
Sample response: 1;+48123456789 (call forwarding enabled to number +48123456789)
Response (when modem returns wrong response): error
Response (when wrong modem_no parameter): Wrong parameters

RESPONSE (XML):
Response:
xml>
<call_forward_status>1;+48123456789 </call_forward_status>
<status>ok</status>
</xml>
Response (when wrong modem_no parameter):
<xml>
<error_text>Wrong parameters </error_text>
<status>error</status>
</xml>

Important Notice: This feature is available only devices with 3G modems.

HTTP POST method:
https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phone.call_forward_read”, “params”:{“access_token”:”0005gOjCOlMH8F2x”,”modem_no”:”1″}}

Response:
Response: {“result”: “OK”}
Response (when wrong logindata): {“result”: “Invalid login or password”}
Response (when wrong access token): {“result”:”Invalid access token”}
Response {“result”:”0″} (call forwarding disabled)
Response {“result”:”1;+48123456789″} (call forwarding enabled to number +48123456789)
Response (when modem/cellular network returns wrong response): {“result”: “error”}
Response (when wrong modem_no parameter): {“result”: “Wrong parameters”}

Response (Extended):
Response: {“result”:{“status”:”ok”}}

Response (when wrong logindata): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Response (when wrong access token): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Response {“result”:{“call_forward_status”:”0″,”status”:”ok”}}
Response {“result”:{“call_forward_status”:”1;+48123456789″,”status”:”ok”}}
Response (when wrong parameters):
{“result”:{“error_text”:”Wrong parameters”,”status”:”error”}}

Important Notice: This feature is available only devices with 3G modems.

HTTP GET method:
https://url-of-smseagle/http_api/call_forward_set

Example:
https://url-of-smseagle/http_api/call_forward_set? access_token=0005gOjCOlMH8F2x&modem_no=1&modem_no=2&status=1&number=1234567

Response:

Sample response: OK
Response (when modem returns wrong response): error
Response (when wrong modem_no parameter): Wrong parameters

RESPONSE (XML):
Response:
<xml>
<status>ok</status>
</xml>
Response (when wrong modem_no parameter):
<xml>
<error_text>Wrong parameters </error_text>
<status>error</status>
</xml>

Important Notice: This feature is available only devices with 3G modems.

HTTP POST method:
https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phone.call_forward_set”, “params”:{“access_token”:”0005gOjCOlMH8F2x”,”modem_no”:”1″, “status”:”1″, “number”:”123456789″}}

Response:
Response: {“result”: “OK”}
Response (when wrong logindata): {“result”: “Invalid login or password”}
Response (when wrong access token): {“result”:”Invalid access token”}
Response (when modem/cellular network returns wrong response): {“result”: “error”}
Response (when wrong modem_no parameter): {“result”: “Wrong parameters”}

Response (Extended):
Response: {“result”:{“status”:”ok”}}

Response (when wrong logindata): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Response (when wrong access token): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Response (when wrong parameters):
{“result”:{“error_text”:”Wrong parameters”,”status”:”error”}}

HTTP GET method:
https://url-of-smseagle/http_api/set_contact_vacation_mode

Example:
https://url-of-smseagle/http_api/set_contact_vacation_mode?access_token=0005gOjCOlMH8F2x&contact_id=4&contactname=johnlord& status=enabled

Response:

Sample response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong status): Wrong parameters

RESPONSE (XML):
Response:
<xml>
<status>
ok
</status>
</xml>
Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>
Response (when wrong access token):
<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>
Response (when wrong status):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

HTTP POST method:
https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.set_contact_vacation_mode”, “params”:{“access_token”:”0005gOjCOlMH8F2x”,”contact_id”:”4″, “contactname”:”johnlord”,”status”:”enabled”}}

Response:
Response: {“result”: “OK”}
Response (when wrong logindata): {“result”: “Invalid login or password”}
Response (when wrong access token): {“result”:”Invalid access token”}
Response (when wrong status): {“result”: “Wrong parameters”}

Response (Extended):
Response: {“result”:{“status”:”ok”}}

Response (when wrong logindata): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Response (when wrong access token): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Response (when wrong status):
{“result”:{“error_text”:”Wrong parameters”,”status”:”error”}}

HTTP GET method:
https://url-of-smseagle/http_api/get_contact_vacation_mode

Example:
https://url-of-smseagle/http_api/get_contact_vacation_mode?access_token=0005gOjCOlMH8F2x&contact_id=4&contactname=johnlord

Response:

Response: enabled / disabled
Sample response: enabled
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token

RESPONSE (XML):

Response:
<xml>
<vacation_mode>
enabled / disabled
</vacation_mode>
<status>
ok
</status>
</xml>

Sample response:
<xml>
<vacation_mode>
enabled
</vacation_mode>
<status>
ok
</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

HTTP POST method:
https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”phonebook.get_contact_vacation_mode”,
“params”:{“access_token”:”0005gOjCOlMH8F2x”,”contact_id”:”4″,
“contactname”:”johnlord”}}

Response:
Response: {“result”: enabled / disabled }
Sample response: {“result”:”enabled”}
Response (when wrong logindata): {“result”: “Invalid login or password”}
Response (when wrong access token): {“result”: “Invalid access token”}

Response (Extended):
Response:
{“result”:{“vacation_mode”: enabled / disabled,”status”:”ok”}}

Response (when wrong logindata):
{“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}

Response (when wrong access token):
{“result”: {“error_text”:”Invalid access token”,”status”:”error”}}

Important Notice: This feature is available only for multimodem devices.

HTTP GET method:
https://url-of-smseagle/http_api/set_outbox_modem_no

Example:
https://url-of-smseagle/http_api/set_outbox_modem_no? access_token=0005gOjCOlMH8F2x&current_modem_no=1&new_modem_no=2

responsetype(optional parameter) text = format response as text (default), xml = format response as XML object

Response:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when modem doesn’t exist): Wrong modem number
Response (when wrong modem state): Wrong modem state

Response (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Response (when modem doesn’t exist):
<xml>
<error_text> Wrong modem number</error_text>
<status>error</status>
</xml>

Response (when wrong modem state):
<xml>
<error_text>Wrong modem state</error_text>
<status>error</status>
</xml>

Important Notice: This feature is available only for multimodem devices.

HTTP POST method:
https://url-of-smseagle/jsonrpc/sms

Sample body:
{“method”:”sms.set_outbox_modem_no”, “params”:{“access_token”:”0005gOjCOlMH8F2x”, “current_modem_no”:”1”, “new_modem_no”:”2”}}

Response:
{“result”:”OK”}

Sample response: {“result”:”OK”} Response (when wrong login data): {“result”: “Invalid login or password”} Response (when wrong access token): {“result”: “Invalid access token”}
Response (when wrong status): {“result”: “Wrong parameters”}

Response (Extended):
{“result”:{“set_outbox_modem_no”:”OK”,”status”:”ok”}}
Response (when wrong logindata):
{“result”: {“error_text”:”Invalid login or password”,”status”:”error”}} Response (when wrong access token):
{“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Response (when wrong status): {“result”: {“error_text”:”Wrong parameters”,”status”:”error”}}