SMSEagle NXS-9700-3G, User Manual

Page: 159 / 229

159
| SMSEagle NXS-9700 | User’s Manual
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
contact_id id of existing contact
contactname name for the contact
number phone number for the contact
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.contact_update",
"params":{“access_token”:”0005gOjCOlMH8F2x”,"contact_id":"4","contactname":
"johnlord","number":"123456789","public":"1"}}
RESPONSE:
Response: {"result": "OK"}
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 >>contactname<< parameter"}
{"result": "Wrong or missing >>contact_id<< parameter"}
{"result": "Wrong or missing >>number<< parameter"}
Response (when contact_id is wrong): {"result": "Contact with the given id does not
exists"}
RESPONSE (EXTENDED):
Response: {"result":{"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 >>contactname<<
parameter","status":"error"}}
{"result": {"error_text":"Wrong or missing >>contact_id<<
parameter","status":"error"}}
{"result": {"error_text":"Wrong or missing >>number<<
parameter","status":"error"}}