SMSEagle NXS-9700-3G, User Manual

Page: 190 / 229

190
| SMSEagle NXS-9700 | User’s Manual
HTTP POST METHOD:
https://url-of-smseagle/jsonrpc/sms
Parameter Description
access_token authentication access token (see details in point API Authentication)
login your user to login to SMSEagle (see details in point API Authentication)
pass your password to login to SMSEagle
group_id ID of group to be queried
user_id (optional parameter) show only contacts created by user with given ID
public (optional parameter) 0 = private, 1 = public
responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object
BODY:
{"method":"phonebook.group_members_read",
"params":{“access_token”:”0005gOjCOlMH8F2x”,"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):