Request format
The general CTI commands request format is:
http://Phone-IP-Address/cgi-bin/function?passcode=PASSWORD¶m=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
TYPE OF CTI FUNCTIONS
Please refer to following table describing type of CTI functions supported:
CTI COMMANDS AND EXAMPLES
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 Function Description
Line Status api-get_line_status Retrieves line status of the phone
Phone Status api-get_phone_status Retrieves phone status
Phone Operations api-phone_operation
Sends phone operations commands (hang
up, answer call, reject call…)
Account Status api-get_accounts
retrieve the account status: (registred, not
registered...)
Send Keys api-send_key
Sends keys functions (speaker, volume up,
volume down, mute, hold, 0-9… )
System Operations api-sys_operation
Sends system operations commands (reset,
reboot…)