Request Format; Response Format - Grandstream Networks GRP26 Series Manual

Request format

The general CTI commands request format is:
http://Phone-IP-Address/cgi-bin/function?passcode=PASSWORD&param=value
"Function" is one of CTI functions as described in next chapter (api-get_line_status for example)
"Password" is the phone's admin/user level password
"Param=value" is the parameter for specific CTI function type

Response format

Positive answer with no returned value
{"response":"success", "body": "complete"}
Negative answer
{"response":"error", "body": "failed"}
Positive answer with returned values
{"response":"success", "body": [{"line": 1, "state": "idle", "acct": "", "remotename": "", "remotenumber": "", "active": 0}, {"line": 2, "state":
"idle", "acct": "", "remotename": "", "remotenumber": "", "active": 0}, {"line": 3, "state": "idle", "acct": "", "remotename": "",
"remotenumber": "", "active": 0}]}
TYPE OF CTI FUNCTIONS
Please refer to following table describing type of CTI functions supported:
Type
Line Status
Phone Status
Phone Operations
Account Status
Send Keys
System Operations
CTI COMMANDS AND EXAMPLES
Function
api-get_line_status
api-get_phone_status
api-phone_operation
api-get_accounts
api-send_key
api-sys_operation
Description
Retrieves line status of the phone
Retrieves phone status
Sends phone operations commands (hang
up, answer call, reject call...)
retrieve the account status: (registred, not
registered...)
Sends keys functions (speaker, volume up,
volume down, mute, hold, 0-9... )
Sends system operations commands (reset,
reboot...)