GRANDSTREAM GSC3505 1 Way Public Address SIP Intercom Speaker User Guide

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&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 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:

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

{“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

phone_operation.passcode=admin&cmd=endcall](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

sys_operation?passcode=admin&request=REBOOT](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

“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

ctrl_music_play.passcode=admin&state=1&type=1&url=/var/user/music/music1.ogg&loop=1](http://192.168.5.135 -cgi-bin-api- ctrl_music_play.passcode=admin&state=1&type=1&url=/var/user/music/music1.ogg&loop=1)
Single Playback| http://192.168.5.135/cgi-bin/api- ctrl_music_play.passcode=admin&state=1&type=1&url=/var/user/music/music1.ogg&loop=0
Stop Playback| http://192.168.5.135/cgi-bin/api- ctrl_music_play.passcode=admin&state=0&type=1&url=/var/user/music/music1.ogg&loop=0

Supported Models

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
---|---

References

• documentation.grandstream.com/?hkb-redirect&nonce=4825de7fdc&check=1qiil&redirect=helpdesk.grandstream.com&otype=ht_kb_article&oid=70975&source=widget
• Log In · Yuque

Read User Manual Online (PDF format)

Read User Manual Online (PDF format)  >>

Download This Manual (PDF format)

Download this manual  >>