SMSEagle NXS-9700-3G, User Manual

Page: 167 / 229

167
| SMSEagle NXS-9700 | User’s Manual
name name for the created shift
enabled 0 = disabled, 1 = enabled
(mon-sun)_from shift start hour for each day of week
(mon-sun)_to shift end hour for each day of week
responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object
EXAMPLES:
{"method":"phonebook.shift_create",
"params":{“access_token”:”0005gOjCOlMH8F2x”,"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"}}
47. Phonebook shift read: HTTP GET method
HTTP GET METHOD:
https://url-of-smseagle/http_api/shift_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)