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>

62. User ID read: JSONRPC method

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

username username to be queried

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

BODY:
{"method":"phonebook.userid_read",
"params":{"access_token"="0005gOjCOlMH8F2BPo8mWqcGzycVHRLq","username":"myu
ser"}}

148 | SMSEagle NXS-9700 | User’s Manual

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

63. Group members read: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/group_members_read

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) text = format response as text (default), xml = format
response as XML object

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

RESPONSE:
Sample response: link

149 | SMSEagle NXS-9700 | User’s Manual