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