User Manual

134 | SMSEagle NXS-9700-3G | User’s Manual
<error_text>Wrong >>username<< parameter</error_text>
<status>error</status>
</xml>
62. User ID read: JSONRPC method
HTTP POST METHOD:
https://url-of-smseagle/index.php/jsonrpc/sms
Parameter
Description
login
your user to login to SMSEagle
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":{"login":"john","pass":"doe","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 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"}}