User Manual

88 | SMSEagle NXS-9700-3G | User’s Manual
https://url-of-smseagle/index.php/jsonrpc/sms
Parameter
Description
login
your user to login to SMSEagle
pass
your password to login to SMSEagle
groupname
name for the created group
public
(optional parameter) 0 = private group, 1 = public group
responsetype
(optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object
EXAMPLES:
{"method":"phonebook.group_create",
"params":{"login":"john","pass":"doe","groupname":"myusers","public":"1"}}
RESPONSE:
Response: {"result": "OK; ID=[ID of created group]"}
Sample response: {"result": "OK; ID=5"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong parameters): {"result": "Wrong or missing >>groupname<<
parameter"}
RESPONSE (EXTENDED):
Response:
{"result": {"group_id":"[ID of created group]","status":"ok"}}
Sample response: {"result": {"group_id":"748","status":"ok"}}
Response (when wrong logindata):
{"result": {"error_text":"Invalid login or password","status":"error"}}
Response (when wrong parameters):
{"result": {"error_text":"Wrong parameters","status":"error"}}
25. Phonebook group read: HTTP GET method
HTTP GET METHOD:
https://url-of-smseagle/index.php/http_api/group_read
Parameter
Description
login
your user to login to SMSEagle
pass
your password to login to SMSEagle
public
(optional parameter) 0 = private group (default value), 1 = public group
uid
(optional parameter) id of user who created the group