Grandstream Networks, Inc.
GSC3505/3510/3506/3516 Series
CTI Guide
GSC35XX : CTI Guide
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 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 | Function | Description | Method |
| Phone Status | api-get_phone_status | Retrieves phone status | GET |
| Make Call | api-make_call | Make a general call | GET |
| Phone Operations | api-phone_operation | Sends phone operations commands (hang up, answer call, reject call…) | GET |
| System Operations | api-sys_operation | Sends system operations commands (reset, reboot…) | GET |
| Get Local Music List | api-get_music | get the local music list stored in device | GET |
| Music play control | api-ctrl_music_play | control the local music play or stop | GET |
CTI functions supported
CTI COMMANDS AND EXAMPLES
Following commands have been run in a web browser on computer in same phone’s network. In the examples below, a GSC3516 device is used with IP address 192.168.5.135 and admin level password set to default (passcode=admin).
Phone Status Function
General Format
The general format of CTI command to retrieve phone status is:
http://Phone-IP-Address-cgi-bin-api-get_phone_status.passcode=PASSWORD
Introduction to URL parameters
passcode : PASSWORD
Example
| Request | http://192.168.5.135-cgi-bin-api-get_phone_status.passcode=admin |
| Response | Phone available {“response”:”success”, , “misc”: “1”} “body”: “available” Phone busy {“response”:”success”, “misc”: “1”} “body”: “busy”, |
Make Call
General Format
The general format of CTI command to initiate call is:
http://Phone-IP-Address-cgi-bin-api-make_call.passcode=PASSWORD&phonenumber=NUMBER
Introduction to URL parameters
passcode : PASSWORD
phone number : phone number
Example
| Request | http://192.168.5.135-cgi-bin-api-make_call.passcode=admin&phonenumber=35463 |
| Response | { “response”: “success”, “body”: true } |
Phone Operations Functions
General format
The general format of CTI command to send phone operations is:
http://Phone-IP-Address-cgi-bin-api-phone_operation.passcode=PASSWORD&cmd=CMD
Introduction to URL parameters
passcode : PASSWORD
cmd : phone operations functions
Examples
| Operation | Function | Examples |
| endcall | End established call | http://192.168.5.135-cgi-bin-api-phone_operation.passcode=admin&cmd=endcall |
| acceptcall | Accept incoming call | http://192.168.5.135-cgi-bin-api-phone_operation.passcode=admin&cmd=acceptcall |
| rejectcall | Reject incoming call | http://192.168.5.135-cgi-bin-api-phone_operation.passcode=admin&cmd=rejectcall |
| mute | Mute or unmute during calls | http://192.168.5.135-cgi-bin-api-phone_operation.passcode=admin&cmd=mute the first trigger is mute,then the second trigger is unmute. |
System Operations Functions
General Format
The general CTI command to send system operations is:
http://Phone-IP-Address-cgi-bin-api-sys_operation.passcode=PASSWORD&request=CMD
Introduction to URL parameters
passcode : PASSWORD
request : system operations functions
Examples
| Operation | Function | Example |
| REBOOT | Reboot the device | http://192.168.5.135/cgi-bin/api-sys_operation?passcode=admin&request=REBOOT |
| RESET | Reset the device to Defualt Settings | http://192.168.5.135-cgi-bin-api-sys_operation.passcode=admin&request=RESET |
Get Local Music List
General Format
The general CTI command to get local music list is:
http://Phone-IP-Address-cgi-bin-api-get_music.passcode=PASSWORD
Introduction to URL parameters
passcode : PASSWORD
Example
| Request | http://192.168.5.135-cgi-bin-api-get_music.passcode=admin |
| Response | {“response”:”success”, “body”:[{“fileName”: “music1.ogg”, “path”: “/var/user/music/music1.ogg”}, {“fileName”: “music2.ogg”, “path”:“/var/user/music/music2.ogg”} ]} |
Music play control
General Format
The general CTI command to play or stop music play is:
http://Phone-IP-Address-cgi-bin-api-ctrl_music_play.passcode=PASSWORD&state=STATE&type=TYPE&url=URL&loop=LOOP
Introduction to URL parameters
passcode : PASSWORD
state : stop or play music. (0 – stop; 1 – play)
type : 1, Default value
url : Music playback path,You can obtain music paths through the “api-get_music” interface
loop : Single or looping playback. (0 – single; 1 – loop)
Example
Supported Models
| Model name | CTI Support | Firmware requirements |
| GSC3505 | YES | 1.0.3.8 or higher |
| GSC3510 | YES | 1.0.3.8 or higher |
| GSC3506 | YES | 1.0.3.8 or higher |
| GSC3516 | YES | 1.0.3.8 or higher |
Supported GSC Models
Need Support?
Can’t find the answer you’re looking for? Don’t worry we’re here to help!
CONTACT SUPPORT
Documents / Resources
 |
GRANDSTREAM GSC3505 1 Way Public Address SIP Intercom Speaker [pdf] User Guide GSC3505 1 Way Public Address SIP Intercom Speaker, GSC3505, 1 Way Public Address SIP Intercom Speaker, Public Address SIP Intercom Speaker, Address SIP Intercom Speaker, SIP Intercom Speaker, Intercom Speaker |