Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12
12 - 78
Using the SoundStructure API
This section presents some examples of using the SoundStructure API com-
mands. In this section, commands sent by the control system are in blue,
acknowledgements received by the control system are preceded by the word
‘val’ and are coded in green, and comments to explain the example are pref-
aced by the ‘#’ character.
Not all acknowledgements are shown in these examples. Only the acknowl-
edgements that are important for understanding how the systems works are
shown. These examples assume the names of the SoundStructure VoIP Inter-
face’s input and output channel are “VoIP In” and “VoIP Out” respectively.
Dialing a Call
This example shows how to make a phone call.
# Take the phone offhook.
set phone_connect “VoIP Out” 1
val phone_connect “VoIP Out” 1
# Dial the digits
set phone_dial “VoIP Out” “2029”
val phone_dial “VoIP Out” “2029”
# If the remote party answers at extension 2029 then the call
# is connected.
voip_reboot Reboots the SoundStructure VoIP Interface.
voip_resume Resumes a call that was on hold.
voip_send Causes a call to be placed with the digits dialed.
voip_split Splits all calls in a conference into individual calls.
voip_status Indicates the status LED state on the
SoundStructure VoIP Interface.
voip_transfer Used to transfer a call.
voip_uc_sw_ver Gets the SoundStructure VoIP Interface’s UC
Software version.