FX, and VS4000 API Guide
ViewStation EX, ViewStation
VS4000 User’s Guide
April 2003 Edition Release 1725-10656-004
Patent Information
Trademark Information
Contents
callstate
gatewayprefix
nearloop
streammulticastip
isdnareacode
ViewStation EX, ViewStation FX
and VS4000 API Guide
Polycom, Inc.
button near command
What’s New in Release 5.0?
Command
Command
Using Telnet
Accessing the API Interface
Using the RS-232Interface
Connecting the Serial Cable
ViewStation EX and ViewStation FX
Starting a Communications Session
RS-232User Interface Screen
RS-232Interface Information
Baud Rate
RS-232Modes
Page
Near-SideMode
Flow Control
Far-SideMode
Resulting Operation
Function
Pin Number
Pin Number
RS-232Serial Cable Pinout and Connections VS4000
Function
Polycom, Inc.
Status Display
Using the “listen” or “dial” Command
B Channel Status Message Example
Example
Polycom, Inc.
Page
Example
Syntax Summary
Example
Example
Example
About the “get” Subcommand
Response
Example
<“str”|1..64>
System Commands
Description
Example
Subcommands
abk <batch|all|letter|range>
abk batch <0..59>
adminpassword <set|get> password
adminpassword
abk all abk letter <a..z> abk range <a..b>
Examples
User Interface Screen Location
advnetstats
advnetstats
advnetstats
Examples
Sample Output
allowabkchanges <yes|no|get>
allowabkchanges
Enables the Allow Address Book Changes option
Disables the Allow Address Book Changes option
allowmixedcalls
allowdialing
allowdialing yes no get
allowmixedcalls <yes|no|get>
allowusersetup <yes|no|get>
allowusersetup
allowremotemon
allowremotemon <get>
audioquality
answer
answer <phone|video>
audioquality <set|get>
audioqualityg7221 <set|get>
audioqualityg7221
audioqualityg7221 get
Example
autoanswer <yes|no|donotdisturb|get>
autoanswer
Example
User Interface Screen Location
autoh323dialing
autodiscovernat
autodiscovernat yes no get
autoh323dialing <yes|no|get>
backlightcompensation <yes|no|get>
backlightcompensation
Displays the current setting yes or no
Example
Description
button
volume+
preset
volume
delete
callpreference h320 h323 both get
callpreference
Example
Example
callstate <register|unregister|get>
callstate
Output to Example
Description
camera <near|far|register|unregister>
camera
camera <near|far> stop
Subcommands
near move continuous
near tracking to_presets
near move discrete
near <setposition|getposition> <x> <y> <z>
far tracking to_presets
far subcommands
register unregister subcommand
Camera source
camera1ptz <yes|no|get>
camera1ptz
Example
Example
cameradirection
camera4ptz
camera4ptz <yes|no|get>
cameradirection <normal|reversed|get>
camerainput <1|2|3|4> <off|s-video|composite|get>
camerainput
Example
User Interface Screen Location
Subcommands
chaircontrol
Example
Example
set_password <“ string>
Requests voice activated switching
Example
req_term_name <term_no>
country
colorbar
colorbar on off
country <set|get> <algeria..zimbabwe>
dataconferencetype <off|netmeeting|t120| get>
dataconferencetype
Examples
User Interface Screen Location
defaultgateway <set|get>
defaultgateway
defaultgateway get
daylightsavings
dhcp <off|client|server|get>
dhcp
Example
User Interface Screen Location
dial <addressbook|auto|manual|phone>
dial
dial phone <dialstring>
User Interface Screen Location
dialchannels <parallel|oneatatime|get>
dialchannels
Examples
Description
diffserv <set|get><0..63>
diffserv
diffserv set <0..63> diffserv get
dir string
display whoami
display call
display call
Output Sample
Ouput
displaybolt
displaybolt dd
Description
displaygraphics
displayglobaladdresses
displayglobaladdresses <yes|no|get>
displaygraphics <yes|no|get>
displayipisdninfo
displayipext
displayipext <yes|no|get>
Enables the display of the IP extension
displayparams
displayparams
Output partial
Displays the current setting yes or no
dns get <1..4>
dns <set|get> <1..4>xxx.xxx.xxx.xxx
dynamicbandwidth <yes|no|get>
dynamicbandwidth
Enables the option
Description
e164ext <set|get> e.164name
e164ext
e164ext get
Disables the option
echocanceller <yes|no|get>
echocanceller
Response
User Interface Screen Location
enablesnmp
enablesnapshots
enablesnmp <yes|no|get>
enablesnmp <yes|no|get>
farcontrolnearcamera
exit
exit
farcontrolnearcamera <yes|no|get>
farnametimedisplay
farloop
farloop <on|off>
farnametimedisplay <set|get>
gabpassword <set|get> password
gabpassword
gabk batch
gabk batch <0..59>
gabserverip <set|get>
gabserverip
gabserverip set xxx.xxx.xxx.xxx gabserverip set
gabserverip get
gatekeeperip <set|get>
gatekeeperip
gatekeeperip get
User Interface Screen Location
gatewayareacode <set|get> areacode
gatewayareacode
Sets the area code when followed by the areacode
Displays the current setting for this option
gatewaycountrycode <set|get> number
gatewaycountrycode
Description
Example
gatewayext <set|get> gateway extension
gatewayext
gatewayext set gateway extension gatewayext set
gatewayext get
gatewaynumber <set|get> number
gatewaynumber
Description
Example
gatewaynumbertype <did|number+extension|get>
gatewaynumbertype
Displays the current setting did or
Description
gatewayprefix <set|get><valid speed> value
gatewayprefix
Description
set <“valid speed”>
gatewaysetup
gatewaysetup
Output
Example
gatewaysuffix <set|get><valid speed> value
gatewaysuffix
Description
set <“valid speed”>
generatetone
gendial
gendial 0..9|#|
generatetone <on|off>
gmscity
get screen
get screen
Output Example
gmscontactemail <set|get> email
gmscontactemail
Example
User Interface Screen Location
gmscontactfax set get fax
gmscontactfax
Description
Example
gmscontactnumber <set|get> number
gmscontactnumber
Description
Example
gmscontactperson <set|get> person
gmscontactperson
Description
Example
gmscountry get
gmscountry
Description
Example
gmsstate get
gmsstate
Description
Example
gmstechsupport <set|get> tech support digits
gmstechsupport
gmstechsupport get
Description
gmsurl get <1..10>
gmsurl
Description
Example
graphicsmonitor <tv|fxvga|visualconcert|get>
graphicsmonitor
command graphicsmonitor fxvga is similar to
command graphicsmonitor visualconcert is
graphicsmonitortv
graphicsmonitorfxvga
graphicsmonitorfxvga <on|off|get>
graphicsmonitortv on off get
graphicsmonitorvisualconcert <on|off|get>
graphicsmonitorvisualconcert
Disables the TV monitor as the graphics monitor
Displays the current setting on or off
h323name <set|get> H.323name
h323name
h323name get
Description
help
hangup
hangup <phone|video>
hangup phone hangup video 1..3 hangup video
Example
Output to Example 1 partial
help
verbose
Output to Example 2 partial
hires
hires <2|3> <yes|no|get>
Description
history
history
Output to Example
User Interface Screen Location
hostname <set|get> hostname
hostname
hostname set hostname hostname set hostname get
Description
ipaddress <set|get>
ipaddress
ipaddress set xxx.xxx.xxx.xxx ipaddress set
ipaddress get
ipdialspeed <set|get><valid speed><on|off>
ipdialspeed
Example
User Interface Screen Location
ipprecedence <set|get> <0..5>
ipprecedence
ipprecedence set <0..5> ipprecedence get
Displays the current setting
ipstat
ipstat
Description
Output to Example
language
keypadaudioconf
keypadaudioconf <yes|no|get>
language get
Sets the command. It requires a parameter from
lanport
Displays the current setting
Example
lanstat
lanstat <min|misc|reset|sec|tmin|total>
lanstat min
lanstat tmin lanstat tmin 0..60 lanstat total
Output to Example
Example
Output to Example
lanstat min
listen <phone|video|sleep>
listen
Description
Example
maxgabinternationalcallspeed get
maxgabinternationalcallspeed
Description
Example
maxgabinternetcallspeed <set|get> <valid speed>
maxgabinternetcallspeed
maxgabinternetcallspeed get
Description
maxgabisdncallspeed <set|get> <valid speed>
maxgabisdncallspeed
maxgabisdncallspeed get
Description
maxtimeincall <set|get>
maxtimeincall
Description
Example
mcupassword password
mcupassword
mcupassword
Description
meetingpassword <set|get> password
meetingpassword
password
Description
mpautoanswer <yes|no|donotdisturb|get>
mpautoanswer
Description
Example
Displays the current setting for this option
mpmode
User Interface Screen Location
Description
mute <near|far|register|unregister>
mute
mute near <on|off|toggle|get> mute far get
mute register mute unregister
nearloop
muteautoanswercalls
muteautoanswercalls <yes|no|get>
nearloop <on|off>
netmeetingip <set|get>
netmeetingip
netmeetingip get
Disables the Near End Loop
netstats
netstats
netstats
Description
numdigitsdid <0..24|get>
numdigitsdid
numdigitsdid <0..24> numdigitsdid get
User Interface Screen Location
numdigitsext <0..24|get>
numdigitsext
numdigitsext <0..24> numdigitsext get
Displays the current setting
outboundcallroute
numberofmonitors
numberofmonitors <1..4|get>
numberofmonitors <1..4> numberofmonitors get
pcport
pause
pause <0..65535>
Example
ping <ip_addr> count
ping
Displays the current setting
Example
preferredalias
switchnumber|didextnumber|extension|get>
pip <on|off|auto|get>
preferredalias<isdnnumber|fulldidnumber|
preset <near|far|register|unregister>
preset
preset unregister
switchnumber
primarycallchoice <isdn|ip|manual|get>
primarycallchoice
Example
Description
primarycamera <1|2|3|4|get>
primarycamera
Displays the current setting isdn, ip, or manual
Displays the current setting 1, 2, 3, or
queuecommands <yes|no|get>
queuecommands
registerthissystem
registerthissystem <yes|no|get>
repeat <1..64>
repeat
Enables this option register this system
Disables this option
requireacctnumtodial <yes|no|get>
requireacctnumtodial
Enables the option
Disables the option
roomphonenumber <set|get> room phone number
roomphonenumber
Description
Example
rs232 mode flowcontrol baud
rs232
Subcommands
Description
run <scriptfilename>
screen
User Interface Screen Location
Description
secondarycallchoice <isdn|ip|none|get>
secondarycallchoice
disableui
enableui
serialnum
sendonlypreferredalias
sendonlypreferredalias <yes|no|get>
serialnum
showaddrsingab
setaccountnumber
setaccountnumber <account number>
showaddrsingab <h320|h323|both|get>
showpopup <text to display>
showpopup
Displays the current setting h320, h323, or both
Example
slides
sleep
sleep
slides select <pres>
snapshot <0|1|2|3|4|register|unregister>
snapshot
password
Example
snapshotcamera <1|2|3|4|get>
snapshotcamera
Displays the current setting 1, 2, 3, or
Example
snapshottimeout <yes|no|get>
snapshottimeout
Description
Example
snmpadmin <set|get> admin name
snmpadmin
snmpadmin set admin_name snmpadmin set
snmpadmin get
snmpcommunity <set|get> community name
snmpcommunity
Description
Example
snmplocation
snmpconsoleip
snmpconsoleip <set|get>
snmpconsoleip get
soundeffectsvolume <set|get|test> <0..10>
soundeffectsvolume
Example
User Interface Screen Location
stream
stdout
stdout <on|off>
stream <start|stop>
streamannounce <yes|no|get>
streamannounce
Enables streaming announcement
Disables streaming announcement
streamaudioport <set|get> stream audio port
streamaudioport
streamaudioport get
setting, omit the parameter
streamenable <yes|no|get>
streamenable
streammulticastip
streammulticastip <set|get> ip address
streamrestoredefaults
streamrestoredefaults
Displays the current setting
Example
streamrouterhops <set|get> number router hops
streamrouterhops
streamrouterhops get
Description
streamvideoport
streamspeed
streamspeed <192|256|384|512|get>
streamvideoport <set|get> video port
subnetmask <set|get>
subnetmask
subnetmask get
Displays the current setting
systembehindnat <yes|no|get>
systembehindnat
Description
Example
systemname <set|get> system name
systemname
systemname set system name systemname get
Description
t120nameip <set|get> name or ip
t120nameip
Description
Example
techsupport
tcpports
tcpports <set|get>
tcpports get
teleareacode <set|get> telephone area code
teleareacode
teleareacode get
Example
telecountrycode <set|get> telephone country code
telecountrycode
telecountrycode get
Example
telenumber <set|get> telephone number
telenumber
telenumber set telephone number telenumber set
telenumber get
testlan dcuinfo
testlan arp
testlan arp
testlan dcuinfo
testlan echo
testlan dns
testlan dns <name or ip>
testlan echo <ip_addr>
Output to Example
Example
Example
Output to Example
testlan ping <ip_addr>count
testlan ping
testlan ping <ip_addr>
Description
timediffgmt
textinput
textinput <text to input>
timediffgmt <-12:00..+00:00..+12:00|get>
typeofservice <ipprecedence|diffserv|get>
typeofservice
udpports
udpports <set|get>
usefixedports <yes|no|get>
usefixedports
Enables the use of Used Fixed Ports
Disables the use of Used Fixed Ports
usegatekeeper <off|specify|auto|get>
usegatekeeper
Description
Example
usepathnavigator <always|never|required| get>
usepathnavigator
Description
Example
Polycom, Inc.
User Interface Screen Location
vcbutton
validateacctnum
validateacctnum <yes|no|get>
vcbutton <play|stop|get|register|unregister>
vcraudioout <yes|no|get>
vcraudioout
Example
Description
version
vcrrecordsource
vcrrecordsource auto near far get
version
vgahorizpos
vgaoffmode <black|nosignal|get>
vgaoffmode
vgahorizpos <left|right|get>
vgaphase <increase|decrease|get>
vgaphase
Displays the current setting black or nosignal
Increases the phase
vgaresolution <800x600|1024x768| 1280x1024|get>
vgaresolution
vgavertpos
vgavertpos <up|down|get>
volume <set|up|down|get|register| unregister>
volume
volume set
Displays the current setting up or down
waitfor <callcomplete|systemready| receivingcall>
waitfor
User Interface Screen Location
Description
wanipaddress
wake
wake
wanipaddress <set|get>
widescreenvideo
whoami
whoami
widescreenvideo <yes|no|get>
winsresolution <yes|no|get>
winsresolution
Enables WINS resolution
Disables WINS resolution
winsserver <set|get>
winsserver
winsserver get
Description
isdnareacode
ISDN BRI Commands
isdnareacode <set|get> area code
Sets the ISDN area code when followed by the area
isdncountrycode <set|get> country code
isdncountrycode
Description
Example
isdndialingprefix <set|get> isdn prefix
isdndialingprefix
Description
Example
isdndialspeed <set|get> <valid speed> <on|off>
isdndialspeed
Enables the specified speed valid speed
Disables the specified speed valid speed
Description
isdnnum
Example
User Interface Screen Location
Description
spidnum
Example
User Interface Screen Location
priareacode
ISDN PRI Commands
priareacode <set|get> area code
Displays the current setting
pricallbycall <set|get>
pricallbycall
Description
Example
prichannel <set|get> <all|1..<23|30>> <on|off>
prichannel
Description
Example
Example
Important PRI Channel Information
Example
User Interface Screen Location
pricsu <internal|external|get>
pricsu
Sets the internal CSU mode. This is the default
command on page
pridialchannels <set|get> <1..12|15>
pridialchannels
Description
Example
priintlprefix <set|get> prefix
priintlprefix
Description
Example
prilinebuildout set <0|-7.5|-15|-22.5>
prilinebuildout
prilinebuildout get
Displays the current setting
prilinesignal <set|get><esf/b8zs|crc4/hdb3| hdb3>
prilinesignal
Description
Example
prinumber <set|get> pri number
prinumber
prinumber set pri number prinumber set
prinumber get
prinumberingplan <isdn|unknown|get>
prinumberingplan
Description
Example
prioutsideline <set|get> outside_line
prioutsideline
Description
Example
priswitch get
priswitch
Description
Example
cts <normal|inverted|get>
V.35/RS-449/RS-530/RS-366Commands
dcd <normal|inverted|get>
Sets the signal to normal high voltage is logic
dcdfilter <on|off|get>
dcdfilter
Sets the signal to inverted low voltage is logic
Displays the current setting normal or inverted
dsr <normal|inverted|get>
dsranswer
dsranswer <on|off|get>
Sets the signal to normal high voltage is logic
Example
dtr <normal|inverted|on|get>
User Interface Screen Location
Description
Description
h331audiomode
g728
g711u
h331framerate <30|15|10|7.5|get>
h331framerate
Displays the current setting for this option
User Interface Screen Location
h331videoformat
h331videoprotocol
h331videoprotocol <h263|h261|get>
h331videoformat <fcif|get>
rs366dialing on off get
rs366dialing
Example
User Interface Screen Location
rts normal inverted get
rt <normal|inverted|get>
Sets the signal to normal high voltage is logic
Sets the signal to inverted low voltage is logic
Sets the signal to normal falling edge sends data
st <normal|inverted|get>
Example
User Interface Screen Location
v35debug
v35broadcastmode
v35broadcastmode <on|off|get>
v35debug <0..3> <on|off>
v35num
v35dialingprotocol
v35dialingprotocol <rs366|get>
v35num <set|get> <1b1|1b2> v35 number
v35portsused <1|1+2|get>
v35portsused
Example
User Interface Screen Location
v35prefix <set|get> <valid speed> value
v35prefix
Example
User Interface Screen Location
Example
v35profile
User Interface Screen Location
Description
Example
Example
Output to Example
User Interface Screen Location
v35suffix <set|get> <valid speed> value
v35suffix
Description
set valid speed
Example
User Interface Screen Location
v35suffix set 128 ”#4#2”
Important Safeguards
License Restrictions
Safety and Legal Notices
Limitation of Remedies and Damages
Warranty
USA and Canadian Regulatory Notices
FCC Notice
Safety and Legal Notices Part 68 FCC Rules
CE Mark
EEA Regulatory Notices
Declaration of Conformity
Konformitetserklæring
Verklaring van overeenstemming
Dichiarazione di conformità
Declaração de Conformidade
Declaración de conformidad
Special Safety Instructions
Installation Instructions
Underwriters Laboratories Statement