Page 1 API Guide for ViewStation EX, ViewStation FX, and VS4000 March 2004 Edition Release 6.0 1725-10656-006...
Page 2: Trademark Information
As between the parties, Polycom, Inc. retains title to, and ownership of, all proprietary rights with respect to the software contained within its products. The software is protected by United States copyright laws and international treaty provision.
Page 3: Table Of Contents
...32 callpreference ...33 callstate ...34 camera ...35 camera1ptz ...38 camera4ptz ...39 cameradirection ...40 camerainput ...41 chaircontrol ...42 colorbar ...44 country ...45 dataconferencetype ...46 daylightsavings ...47 defaultgateway ...48 dhcp ...49 dial ...50 dialchannels ...52 diffserv ...53 © Polycom, Inc. Contents...
Page 4 API Guide for ViewStation EX, ViewStation FX, and VS4000 dir ...54 display ...55 displaybolt ...57 displayglobaladdresses ...58 displaygraphics ...59 displayipext ...60 displayipisdninfo ...61 displayparams ...62 dns ...64 dynamicbandwidth ...65 e164ext ...66 echocanceller ...67 enablesnapshots ...68 enablesnmp ...69 exit ...70 farcontrolnearcamera ...71 farloop ...72...
Page 5 ...147 popup ...148 preferredalias ...149 preset ...150 primarycallchoice ...151 primarycamera ...152 queuecommands ...153 reboot ...154 registerall ...155 registerthissystem ...156 repeat ...157 requireacctnumtodial ...158 roomphonenumber ...159 rs232 ...160 run ...161 screen ...162 secondarycallchoice ...163 sendonlypreferredalias ...164 serialnum ...165 setaccountnumber ...166 www.polycom.com/videodocumentation...
Page 6 API Guide for ViewStation EX, ViewStation FX, and VS4000 showaddrsingab ...167 showpopup ...168 sleep ...169 slides ...170 snapshot ...171 snapshotcamera ...172 snapshottimeout ...173 snmpadmin ...174 snmpcommunity ...175 snmpconsoleip ...176 snmplocation ...177 soundeffectsvolume ...178 speeddial list ...179 speeddial lock or speeddial unlock ...180 stdout ...181...
Page 7 ...255 spidnum ...256 V.35/RS-449/RS-530 Commands ... 259 cts ...260 dcd ...261 dcdfilter ...262 dsr ...263 dsranswer ...264 dtr ...265 h331audiomode ...266 h331framerate ...267 h331videoformat ...268 h331videoprotocol ...269 rs331dialing ...270 rt ...271 rts ...272 st ...273 v35broadcastmode ...274 v35debug ...275 www.polycom.com/videodocumentation...
Page 8 API Guide for ViewStation EX, ViewStation FX, and VS4000 v35dialingprotocol ...276 v35num ...277 v35portsused ...278 v35prefix ...279 v35profile ...280 v35suffix ...282 Appendix: Status Display ... 283 B Channel Status Message Example ...284 viii www.polycom.com/videodocumentation...
Page 9: Introduction
This API is a set of commands implemented within the shell. The commands are available for advanced users who want to customize some of the control features of the ViewStation EX, ViewStation FX, and VS4000 systems. This API can be used via a Telnet session or via the RS-232 interface.
Page 10: What's New In Release 6.0
API Guide for ViewStation EX, ViewStation FX, and VS4000 What’s New in Release 6.0? New and enhanced API commands in 6.0 provide greater control over system behaviors. For example, the system now provides registration data to the control device when call states, camera states, and certain other states change.
Page 11: Enhanced Commands
Either switches the phone channel to the next channel to add another telephone call to a video call, or clears any dialstring from the text box on the Telephone screen of the user interface Registers or unregisters the shell session to receive popup notifications.
Page 12 API Guide for ViewStation EX, ViewStation FX, and VS4000 listen screen New “off” parameter adds the ability to unregister the listen <phone|video|sleep> command. New “swap” parameter adds ability to toggle the content of PIP and main display between near-site and far-site view.
Page 13: System Commands
System Commands This section describes each system shell command and its parameters. © Polycom, Inc.
Page 14 API Guide for ViewStation EX, ViewStation FX, and VS4000 Description This command allows you to execute a previously used command starting with a specific number or letter(s) from the history list. For more information about the history list, refer to Syntax !<“...
Page 15 ->!gat gatewaynumber set 123456789 gatewaynumber 123456789 restart system for changes to take effect. restart now? <y,n> ->history gatewaynumber set 123456789 hangup video history gatewaynumber set 123456789 hangup video hangup video history gatewaynumber set 123456789 history © Polycom, Inc. System Commands...
Page 16: Abk
API Guide for ViewStation EX, ViewStation FX, and VS4000 Description This command displays local Address Book entries. For information about Global Address Book entries, see Syntax abk batch|all|letter|range> abk batch <{0..59}> abk batch search <“s1”> <“n1”> abk batch define <“n1”> <“n2”>...
Page 17 4 entries. abk batch define 10 5 returns the 10th entry and the following 4 entries. © Polycom, Inc. Definition Returns entries beginning with the alphanumeric “character” specified. Requires an alphanumeric character.
Page 18: Adminpassword
API Guide for ViewStation EX, ViewStation FX, and VS4000 adminpassword Description This command is used to change the administrator password. Note This command cannot be accessed through the RS-232 port. Syntax adminpassword <set|get> ["password"] Parameter “password” Examples adminpassword set MyFXpsswd adminpassword set "EX 2004"...
Page 19: Advnetstats
Video FEC errors tapl Transmit audio packet loss (H.323 calls only) © Polycom, Inc. Definition Calls in a multipoint call, where 0 is call #1, 1 is call #2, and 2 is call #3. Select a number from this range to specify a remote site call for which you want to obtain advanced network statistics.
Page 20 API Guide for ViewStation EX, ViewStation FX, and VS4000 tlsdp Transmit LSD protocol (H.320 calls only) rapl Receive audio packet loss (H.323 calls only) rlsdp Receive LSD protocol (H.320 calls only) Transmit audio jitter (h.323 calls only) tlsdr Transmit LSD rate (H.320 calls only) Receive audio jitter (H.323 calls only)
Page 21: All Register
To unregister user feedback, use the all unregister command. Syntax all register Parameter all register © Polycom, Inc. Definition Registers changes to any of the following types of parameters: • Current near end or far end source • State of privacy •...
Page 22: All Unregister
API Guide for ViewStation EX, ViewStation FX, and VS4000 all unregister Description This command simultaneously unregisters all registered user feedback, so that you will not be informed in the API interface of changes that have been made to any of the parameter types listed in the following table.
Page 23: Allowabkchanges
User Interface Screen Location System Info > Admin Setup > General Setup (page 2-Next): Allow Address Book Changes © Polycom, Inc. Definition Enables the Address Book Changes option. Disables the Address Book Changes option. Returns the current setting (yes or no).
Page 24: Allowcamerapresetssetup
API Guide for ViewStation EX, ViewStation FX, and VS4000 allowcamerapresetssetup Description This command gets or sets whether camera presets can be changed. Syntax allowcamerapresetssetup <yes|no|get> Parameter Example allowcamerapresetssetup no User Interface Screen Location System Info > Admin Setup > General Setup > Allow Modifications to...
Page 25: Allowdialing
Example allowdialing get User Interface Screen Location System Info > Admin Setup > General Setup: Allow Dialing © Polycom, Inc. Definition Allows users to place calls. Disables dialing. Your system can only receive calls. Returns the current setting (yes or no).
Page 26: Allowmixedcalls
API Guide for ViewStation EX, ViewStation FX, and VS4000 allowmixedcalls Description This command sets or gets the ability to place and receive mixed protocol multipoint calls (IP and ISDN). It allows the administrator to disable this ability for security reasons.
Page 27: Allowremotemon
For security reasons, it can only be set from the user interface. Syntax allowremotemon <get> Parameter Example allowremotemon get User Interface Screen Location System Info > User Setup: Allow Remote Monitoring © Polycom, Inc. Definition Returns the current setting (yes or no). System Commands...
Page 28: Allowusersetup
API Guide for ViewStation EX, ViewStation FX, and VS4000 allowusersetup Description This command enables or disables the User Setup icon on the System Information screen of the user interface, thus allowing or preventing access to the User Setup screen. This option is useful to prevent users from changing the User Setup functions.
Page 29: Answer
This command answers incoming video or POTS calls. Syntax answer <phone|video> Parameter phone video Example answer phone © Polycom, Inc. Definition Answers incoming POTS calls. Answers incoming video calls when the Auto Answer Point to Point or Auto Answer Multipoint option is set to System Commands...
Page 30: Audioquality
API Guide for ViewStation EX, ViewStation FX, and VS4000 audioquality Description This command sets or gets the call speed threshold that determines which audio protocol is used. At the selected speed or lower, the system uses the G.728 audio protocol. Above the selected speed, the system uses the G.722 audio protocol.
Page 31: Audioqualityg7221
{64..512} Example audioqualityg7221 set 256 User Interface Screen Location System Info > Admin Setup > Phone/Audio: Audio Quality © Polycom, Inc. {64..512}> Definition Sets the call speed threshold value. Requires a parameter from the {64..512} range. Returns the current threshold value of the call.
Page 32: Audiotransmitlevel
API Guide for ViewStation EX, ViewStation FX, and VS4000 audiotransmitlevel Description This command sets or gets the audio volume transmitted to the far site. It is used when a control system needs to increase the audio gain level of DTMF tones being sent to a gateway.
Page 33: Autoanswer
Example autoanswer donotdisturb User Interface Screen Location System Info > Admin Setup > General Setup: Auto Answer Point to Point © Polycom, Inc. Definition Allows any incoming call to be connected automatically. This is the factory default autoanswer setting. Prompts the user to answer incoming calls with a message, “You have a video call.
Page 34: Autodiscovernat
API Guide for ViewStation EX, ViewStation FX, and VS4000 autodiscovernat Description This command sets or gets the Auto Discover NAT option. Syntax autodiscovernat <yes|no|get> Parameter Example autodiscovernat yes User Interface Screen Location System Info > Admin Setup > LAN/H.323 > LAN/Intranet > Firewall/LAN...
Page 35: Autoh323Dialing
User Interface Screen Location System Info > Admin Setup > LAN/H.323 > H.323 > Setup: Auto H.323 Dialing © Polycom, Inc. Definition Enables the option. When this option is enabled, the ISDN and H.323 fields are not visible on the Video Phone screen.
Page 36: Autoshowcontent
API Guide for ViewStation EX, ViewStation FX, and VS4000 autoshowcontent Description This command sets or gets the ability to show content automatically when a user connects a PC to the Visual Concert FX. (To set the ability to preview content on the near Visual Concert FX monitor, see on page 218.)
Page 37: Backlightcompensation
Example backlightcompensation no User Interface Screen Location System Info > Admin Setup > Video/Camera > Cameras: Backlight Compensation © Polycom, Inc. Definition Enables Backlight Compensation. The camera automatically adjusts for a bright background. Disables the option. Returns the current setting (yes or no).
Page 38: Button
Description This command and its parameters let you send the same command as buttons on the Polycom remote control to the user interface. The button commands are not checked prior to being sent to the user interface. Note The button commands are available only for backward compatibility, and are not recommended.
Page 39 This valid command combines the following commands: button near button left button callhangup © Polycom, Inc. Takes you to the previous menu screen. Sends the Mute key to the user interface, causing a toggle of mute state. Sends the Near key to the user interface.
Page 40: Callencryption
API Guide for ViewStation EX, ViewStation FX, and VS4000 callencryption Description This command sets or gets the encryption mode. Use encryption when the far site is capable of encryption. Syntax callencryption <required|disabled|get> Parameter required disabled Example callencryption required User Interface Screen Location System Info >...
Page 41: Callpreference
User Interface Screen Location System Info > Admin Setup > Video Network > Call Preference: ISDN Video Calls (H.320), LAN/Internet Calls (H.323), or both options. © Polycom, Inc. Definition Selects H.320 (ISDN) as the supported call type. Selects H.323 (IP) as the supported call type.
Page 42: Callstate
API Guide for ViewStation EX, ViewStation FX, and VS4000 callstate Description This command registers the shell session to receive notifications about call state activities. (For information on the state of current calls, use command getcallstate Syntax callstate <register|unregister|get> Parameter register...
Page 43: Camera
<near|far> Parameter {1..4} {1..5} source © Polycom, Inc. Definition Registers to receive feedback when the user changes the camera source. Unregisters to receive feedback when the user changes the camera source. Specifies that the command selects or controls the near camera.
Page 44 API Guide for ViewStation EX, ViewStation FX, and VS4000 camera <near|far> Parameter move <direction> Changes the near or far camera’s direction or zoom. near <setposition| getposition> stop tracking Example 1 camera far 2 This command causes the remote terminal to begin sending its camera 2.
Page 45 System Commands Example 2 camera far move left This command causes the far camera to start panning to the left. Example 3 camera near move zoom+ This command causes the near camera to zoom in. © Polycom, Inc.
Page 46: Camera1Ptz
API Guide for ViewStation EX, ViewStation FX, and VS4000 camera1ptz Description This command sets camera source 1 to pan-tilt-zoom mode. Note This command is specific to the VS4000 system. Note See the command camera source to S-video or composite mode.
Page 47: Camera4Ptz
Parameter Example camera4ptz get User Interface Screen Location System Info > Admin Setup > Video/Camera > Cameras > VS4000 Camera Setup © Polycom, Inc. camerainput on page 41 to set your VS4000 Definition Enables pan-tilt-zoom mode. Disables pan-tilt-zoom mode. Returns the current setting (yes or no).
Page 48: Cameradirection
API Guide for ViewStation EX, ViewStation FX, and VS4000 cameradirection Description This command selects whether the camera moves in the same direction (normal) as the arrows on the remote control or in opposite (reversed) direction. Syntax cameradirection <normal|reversed|get> Parameter normal...
Page 49: Camerainput
4 off User Interface Screen Location System Info > Admin Setup > Video/Cameras > Cameras > VS4000 Camera Setup: Primary Camera © Polycom, Inc. camera1ptz on page 38 and Definition Selects the camera source. Disables the selected camera source.
Page 50: Chaircontrol
API Guide for ViewStation EX, ViewStation FX, and VS4000 chaircontrol Description This command and subcommands are used for various chair control functions while the system is in a multipoint call. Syntax chaircontrol <rel_chair|req_chair|req_floor|req_term_name| req_vas|view|view_broadcaster|list|set_password|set_broadcaster| set_term_name|hangup_term|end_conf> <register|unregister> Subcommands chaircontrol req_term_name <“term_no”>...
Page 51 User Interface Screen Location While in a multipoint call, press the Near button on the remote control twice to bring up Chair Control screen. © Polycom, Inc. Definition Sets the chaircontrol password. This password is the Meeting Password (System Info > Admin Setup >...
Page 52: Colorbar
API Guide for ViewStation EX, ViewStation FX, and VS4000 colorbar Description This command turns the diagnostic color bars on or off. Syntax colorbar <on|off> Parameter Example colorbar on User Interface Screen Location System Info > Diagnostics > Color Bar: View Color Bars Definition Turns on the color bars.
Page 53: Country
"united states" User Interface Screen Location System Info > Admin Setup > General Setup: Country © Polycom, Inc. Definition Sets the country. A country name parameter is required. Note: Use quotation marks around a compound name or strings containing spaces (Example: “united states”...
Page 54: Dataconferencetype
API Guide for ViewStation EX, ViewStation FX, and VS4000 dataconferencetype Description This command sets the data conference type. If a setting is changed, the system has to be restarted for changes to take effect. You are prompted to restart the system.
Page 55: Daylightsavings
User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Global Management > Setup: Daylight Savings Time © Polycom, Inc. Definition Enables daylight savings time. Disables daylight savings time. Returns the status of this option (yes or no).
Page 56: Defaultgateway
API Guide for ViewStation EX, ViewStation FX, and VS4000 defaultgateway Description This command sets or gets the default gateway. This setting can only be changed if DHCP is turned off. The system has to be restarted for the change to take effect. You are prompted to restart the system.
Page 57: Dhcp
User Interface Screen Location System Info > Admin Setup > LAN/H.323 > LAN/Intranet > LAN & Intranet: DHCP © Polycom, Inc. Definition Disables DHCP . Enables DHCP client. The system is set to obtain an IP address from a server on your network.
Page 58: Dial
API Guide for ViewStation EX, ViewStation FX, and VS4000 dial Description This command lets you dial video or audio calls either manually or from the Address Book. Syntax dial <addressbook|auto|manual|phone> dial addressbook <"address book entry name"> dial auto <“speed”> <“dialstring”>...
Page 59 User Interface Screen Location These icons on the main screen: Speed Dial > {1..6} or Address Book > Speed Dial > {1..6} Video Call or Telephone © Polycom, Inc. Description Valid data rate for the network. Valid ISDN or IP Address Book number.
Page 60: Dialchannels
API Guide for ViewStation EX, ViewStation FX, and VS4000 dialchannels Description This command lets you define how each ISDN channel will be dialed. Normally, channels are dialed in parallel. Syntax dialchannels <parallel|oneatatime|get> Parameter parallel oneatatime Example dialchannels parallel User Interface Screen Location System Info >...
Page 61: Diffserv
0 User Interface Screen Location System Info > Admin Setup > LAN/H.323 > QOS: Type of Service (ToS) Field > DiffServ © Polycom, Inc. Definition Sets the priority level. A priority level from the range {0..63} is required.
Page 62: Dir
API Guide for ViewStation EX, ViewStation FX, and VS4000 Description This command lists flash files. No wild cards are allowed. Syntax dir ["string"] Parameter “string” Note Use quotation marks around a compound name or strings containing spaces (Example: “united states” or “111 222 333”).
Page 63: Display
Brand: Software Version: Model: Network Interface: MP Enabled: Encryption Enabled: Yes H.264 Enabled: © Polycom, Inc. Definition Displays the following information about the current call: • call ID • status • speed • the number to which this system is connected Returns information about the current system.
Page 64 API Guide for ViewStation EX, ViewStation FX, and VS4000 H.323 Enabled: IP Address: GMT: Time In Last Call: Total Time In Calls: 87:17:17 Total Calls: Country Code: Area Code: PRI Number: 192.168.1.104 Wed Mar 31 00:22:09 2004 0:43:50 5555555 www.polycom.com/videodocumentation...
Page 65: Displaybolt
The lightning bolt is displayed when 5% of the packets are lost. displaybolt -50 The lightning bolt is displayed when 50 packets are lost. © Polycom, Inc. Definition Decimal value between -10000 and 100. A positive integer represents the percentage of lost packets. A negative integer represents the number of lost packets.
Page 66: Displayglobaladdresses
API Guide for ViewStation EX, ViewStation FX, and VS4000 displayglobaladdresses Description This command sets or gets the display of global addresses in the system’s Address Book. Syntax displayglobaladdresses <yes|no|get> Parameter Example displayglobaladdresses yes User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Global Address > Server:...
Page 67: Displaygraphics
User Interface Screen Location System Info > Admin Setup > Video/Cameras > Monitors > TV Monitors: Display Icons in a Call © Polycom, Inc. Definition Enables the display of graphic icons. Disables the display of graphic icons. Returns the current setting (yes or no).
Page 68: Displayipext
API Guide for ViewStation EX, ViewStation FX, and VS4000 displayipext Description This command sets or gets the display of the IP extension field extension is needed when placing a call through a gateway. When this option is selected, the Extension field is visible in the Video Call screen.
Page 69: Displayipisdninfo
User Interface Screen Location System Info > Admin Setup > General Setup: Display My IP and ISDN Information © Polycom, Inc. Definition Enables the display of IP and ISDN information. Disables the display of IP and ISDN information.
Page 70: Displayparams
API Guide for ViewStation EX, ViewStation FX, and VS4000 displayparams Description This command outputs the list of all the system settings. Syntax displayparams Example displayparams returns information similar to this: systemname Jw hostname Jw ipaddress 192.168.1.104 wanipaddress 192.168.1.111 version 6.0 FX - 31Mar2004 14:12...
Page 71 7 numdigitsext 4 gatewaycountrycode <empty> gatewayareacode <empty> gatewaynumber <empty> gatekeeperip <empty> h323name Jw e164ext 59715 gatewayext 59715 usepathnavigator required © Polycom, Inc.
Page 72: Dns
API Guide for ViewStation EX, ViewStation FX, and VS4000 Description This command is used to set the IP address of up to four DNS servers. After a change is made, the system prompts you for a restart. Note This option can only be set when DHCP is off.
Page 73: Dynamicbandwidth
Parameter Example dynamicbandwidth yes User Interface Screen Location System Info > Admin Setup > LAN/H.323 > QOS: Dynamic Bandwidth © Polycom, Inc. Definition Enables the dynamic bandwidth option. Disables the dynamic bandwidth option. Returns the current setting (on or off).
Page 74: E164Ext
API Guide for ViewStation EX, ViewStation FX, and VS4000 e164ext Description This command is used to set or get an H.323 (IP) extension (also known as E.164). H.323 extensions are needed for inbound calls going through a gateway. The extension number is associated with a specific LAN device. If you change the E.164 extension, you must restart the system.
Page 75: Echocanceller
This option is enabled by default. Note Polycom strongly recommends that you do not turn off echo cancellation except when using an external microphone system with its own built-in echo cancellation.
Page 76: Enablesnapshots
API Guide for ViewStation EX, ViewStation FX, and VS4000 enablesnapshots Description This command sets or gets the ability to take or send snapshots. This option is enabled by default. Syntax enablesnmp <yes|no|get> Parameter Example enablesnmp yes User Interface Screen Location System Info >...
Page 77: Enablesnmp
Parameter Example enablesnmp yes User Interface Screen Location System Info > Admin Setup > LAN/H.323 > SNMP: Enable SNMP © Polycom, Inc. Definition Enables the SNMP option. Disables the SNMP option. Returns the current setting (on or off). System Commands...
Page 78: Exit
API Guide for ViewStation EX, ViewStation FX, and VS4000 exit Description This command ends an API command session. Syntax exit Example exit www.polycom.com/videodocumentation...
Page 79: Farcontrolnearcamera
System Info > Admin Setup > Video/Camera > Cameras: Far Control of Near Camera System Info > User Setup: Far Control of Near Camera © Polycom, Inc. Definition Enables far control of the near camera. Disables far control of the near camera.
Page 80: Farloop
API Guide for ViewStation EX, ViewStation FX, and VS4000 farloop Description This command turns the far-site loop on or off, when in a call. Syntax farloop <on|off> Parameter Example farloop on User Interface Screen Location System Info > Diagnostics > Far End Loop Definition Turns the far-site loop on.
Page 81: Farnametimedisplay
120 User Interface Screen Location System Info > User Setup: Far Site Name Display © Polycom, Inc. Definition Sets the length of time the far-site name will be displayed. when followed by the parameter “time” .
Page 82: Gabk
API Guide for ViewStation EX, ViewStation FX, and VS4000 gabk Description This command displays Global Address Book entries. For information about local Address Book entries, see Syntax gabk batch|all|letter|range> gabk batch <{0..59}> gabk batch search <“s1”> <“n1”> gabk batch define <“n1”> <“n2”>...
Page 83 4 entries. gabk batch define 10 5 returns the 10th entry and the following 4 entries. © Polycom, Inc. Definition Returns entries beginning with the alphanumeric “character or characters” specified. Requires an alphanumeric character or two alphanumeric characters together.
Page 84: Gabpassword
API Guide for ViewStation EX, ViewStation FX, and VS4000 gabpassword Description This command sets the Global Address Book (GAB) password. Syntax gabpassword <set|get> ["password"] Parameter “password” Note Use quotation marks around a compound name or strings containing spaces (Example: “united states” or “111 222 333”).
Page 85: Gabserverip
This command sets the IP address of the Global Address Book (GAB) server. Syntax gabserverip <set|get> [“ipaddress”] Parameter “ipaddress” Example gabserverip set gab.polycom.com User Interface Screen Location System Info > User Setup > LAN/H.323 > Global Address > Server: Server IP Address © Polycom, Inc. Definition Sets the GDS server’s IP address when followed by the...
Page 86: Gatekeeperip
API Guide for ViewStation EX, ViewStation FX, and VS4000 gatekeeperip Description This command sets the IP address of the gatekeeper. When this option is changed, you are prompted to restart the system. Syntax gatekeeperip <set|get> [“ipaddress”] Parameter “ipaddress” Example gatekeeperip set 192.168.1.1 User Interface Screen Location System Info >...
Page 87: Gatewayareacode
Erases the current setting. User Interface Screen Location System Info > User Setup > LAN/H.323 > H.323 > Gateway: Gateway Number > Area Code © Polycom, Inc. Definition Sets the area code when followed by the “areacode” parameter. To erase the current setting, omit “areacode” .
Page 88: Gatewaycountrycode
API Guide for ViewStation EX, ViewStation FX, and VS4000 gatewaycountrycode Description This command sets the gateway country code. Syntax gatewaycountrycode <set|get> [“number”] Parameter “number” Note Use quotation marks around a compound name or strings containing spaces (Example: “united states” or “111 222 333”).
Page 89: Gatewayext
59715 User Interface Screen Location System Info > User Setup > LAN/H.323 > H.323 > Gateway: Gateway Number > Extension © Polycom, Inc. Definition Sets the gateway extension number when followed by the “extension” parameter. To erase the current setting, omit “extension” .
Page 90: Gatewaynumber
API Guide for ViewStation EX, ViewStation FX, and VS4000 gatewaynumber Description This command sets the gateway number. Syntax gatewaynumber <set|get> ["number"] Parameter “number” Example gatewaynumber set 5555454 User Interface Screen Location System Info > User Setup > LAN/H.323 > H.323 > Gateway: Gateway Number >...
Page 91: Gatewaynumbertype
User Interface Screen Location System Info > User Setup > LAN/H.323 > H.323 > Gateway: Gateway Number Type © Polycom, Inc. Definition Indicates that the gateway number is a direct inward dialed number - it has no extension.
Page 92: Gatewayprefix
API Guide for ViewStation EX, ViewStation FX, and VS4000 gatewayprefix Description This command sets the gateway prefixes for the corresponding speeds. Some gateways require a number to be prepended (prefix) to the gateway number. The prefix identifies which gateway is used to dial a call at a particular data rate.
Page 93: Gatewaysetup
Description This command lists all the available speeds and values at once. Syntax gatewaysetup Example gatewaysetup returns 2x56 2x64 etc... © Polycom, Inc. #222 #333 #444 #555 System Commands...
Page 94: Gatewaysuffix
API Guide for ViewStation EX, ViewStation FX, and VS4000 gatewaysuffix Description This command sets the gateway suffix. Some gateways require a number to be appended (suffix) to the gateway number. The suffix identifies which gateway is used to dial a call at a particular data rate.
Page 95: Gendialtone
The function and syntax of gendial and gendialtone are identical. Syntax gendialtone [“buttons”] Parameter “buttons” Example gendialtone 2 generates the DTMF tone corresponding to a telephone’s 2 button over a video call. © Polycom, Inc. on page 88. Definition Valid buttons are: {0..9} System Commands...
Page 96: Gendialtonepots
API Guide for ViewStation EX, ViewStation FX, and VS4000 gendialtonepots Description This command generates DTMF dialing tones to a POTS line. Note To generate DTMF calls over video, use the command page 87. Syntax gendialtonepots [“buttons”] Parameter “buttons” Example gendialtonepots 2 generates the DTMF tone corresponding to a telephone’s 2 button to a POTS...
Page 97: Generatetone
Syntax generatetone <on|off> Parameter Example generatetone on User Interface Screen Location System Info > Diagnostics > Audio > Generate Tone © Polycom, Inc. Definition Turns on the test tone. Turns off the test tone. System Commands...
Page 98: Getcallstate
API Guide for ViewStation EX, ViewStation FX, and VS4000 getcallstate Description This command gets the state of current calls. (To register the shell session to receive notifications about call state activities, see Syntax getcallstate Example getcallstate returns something like cs: call[0] speed[512] dialstr[216.54.149.109] state[connected] while still in the call.
Page 99: Get Screen
Description This command returns the name of the current screen. It is intended to let the control panel programmer know which screen the user interface is currently displaying. Syntax get screen Example get screen might return CGenToneScreen © Polycom, Inc.
Page 100: Gmscity
API Guide for ViewStation EX, ViewStation FX, and VS4000 gmscity Description This command sets or gets the Global Management System city information. Syntax gmscity <set|get> ["city"] Parameter “city” Example gmscity set "San Antonio" User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Global Management> Info 1: City...
Page 101: Gmscontactemail
JohnGMSguy@whatever.com User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Global Management > Info 1: Contact Email © Polycom, Inc. Definition Sets the Global Management System email contact information when followed by the “email” parameter.
Page 102: Gmscontactfax
API Guide for ViewStation EX, ViewStation FX, and VS4000 gmscontactfax Description This command sets or gets the Global Management System fax contact information. Syntax gmscontactfax <set|get> [“fax”] Parameter “fax” Example gmscontactfax ”512 555 5555” User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Global Management > Info 1:...
Page 103: Gmscontactnumber
”512 555 1212” User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Global Management > Info 1: Contact Number © Polycom, Inc. Definition Sets the Global Management System contact number when followed by the “number” parameter.
Page 104: Gmscontactperson
API Guide for ViewStation EX, ViewStation FX, and VS4000 gmscontactperson Description This command sets or gets the Global Management System contact person information. Syntax gmscontactperson <set|get> [“person”] Parameter “person” Example gmscontactperson set "John Doe" User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Global Management > Info 1:...
Page 105: Gmscountry
Example gmscountry set "United States" User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Global Management > Info 1: Country © Polycom, Inc. Definition Sets the Global Management System country information when followed by the “countryname” parameter.
Page 106: Gmsstate
API Guide for ViewStation EX, ViewStation FX, and VS4000 gmsstate Description This command sets or gets the Global Management System state information. Syntax gmsstate <set|get> [“state”] Parameter “state” Example gmsstate set Texas User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Global Management > Info 1:...
Page 107: Gmstechsupport
"512 555 1212" User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Global Management > Info 1: Tech Support © Polycom, Inc. Definition Sets the technical support information when followed by the “number” parameter. To erase the current setting, omit “number” .
Page 108: Gmsurl
API Guide for ViewStation EX, ViewStation FX, and VS4000 gmsurl Description This command sets or gets the URL of the Global Management System server that manages your system. When you are registered with the Global Management System, this information is automatically configured. In some instances, you may add Global Management System URLs manually.
Page 109: Graphicsmonitor
User Interface Screen Location System Info > Admin Setup > Video/Camera > Monitors > Graphics Monitor © Polycom, Inc. Definition Selects the TV monitor as the graphics monitor. The graphics and video are displayed on the TV monitor.
Page 110: Graphicsmonitorfxvga
API Guide for ViewStation EX, ViewStation FX, and VS4000 graphicsmonitorfxvga Description This command sets or gets whether the ViewStation’s VGA monitor is used as a graphics monitor. Syntax graphicsmonitorfxvga <on|off|get> Parameter Example graphicsmonitorfxvga on User Interface Screen Location System Info > Admin Setup > Video/Camera > Monitors > Graphics Monitor:...
Page 111: Graphicsmonitortv
User Interface Screen Location System Info > Admin Setup > Video/Camera > Monitors > Graphics Monitor: TV Monitor © Polycom, Inc. Definition Enables a connected TV monitor as a graphics monitor. Note: The command graphicsmonitortv on is similar to...
Page 112: Graphicsmonitorvisualconcert
API Guide for ViewStation EX, ViewStation FX, and VS4000 graphicsmonitorvisualconcert Description This command sets or gets whether Visual Concert FX is used as a graphics monitor. Enable this option if Visual Concert FX is connected to your system and the graphics monitor is directly connected to Visual Concert FX. This allows your system to display your computer desktop on your system’s VGA...
Page 113: H323Name
"Pacific Room" User Interface Screen Location System Info > Admin Setup > LAN/H.323 > H.323 > Setup: H.323 name when calling this system © Polycom, Inc. Definition Sets the H.323 name when followed by the “H.323name” parameter. To erase the current setting, omit the parameter.
Page 114: Hangup
API Guide for ViewStation EX, ViewStation FX, and VS4000 hangup Description This command hangs up a telephone or video call. Syntax hangup <phone|video> [{1..3}] Parameter phone video {1..3} Example 1 hangup phone Example 2 hangup video 2 Definition Hangs up the current audio call.
Page 115: Help
-Display all the local address book entries. abk batch <{0..60}> -Display local address book entries in batches of 10, or the whole address book at once. © Polycom, Inc. Definition Returns detailed help for all commands. Describes the various types of help described in this section.
Page 116 API Guide for ViewStation EX, ViewStation FX, and VS4000 abk letter <{a..z}> - Display local address book entries beginning with the letter specified. abk range <{a}> <{b}> -Display local address book entries numbered a through b. Example 2 help returns (in part)
Page 117: Hires
4 hires No User Interface Screen Location System Info > Admin Setup > Video Cameras > Cameras: High Resolution Cameras © Polycom, Inc. Definition Selectable high-resolution cameras. Enables high-resolution mode for the selected camera. Disables high-resolution mode for the selected camera.
Page 118: History
API Guide for ViewStation EX, ViewStation FX, and VS4000 history Description This command lists the last commands used in the current session. If more than 64 commands have been issued, only the last 64 are displayed. Syntax history Example history returns information similar to this: 1ipaddress set 192.168.1.105...
Page 119: Hostname
User Interface Screen Location System Info > Admin Setup > LAN/H.323 > LAN/Intranet > LAN & Intranet: Host Name © Polycom, Inc. Definition Sets the system’s LAN host name when followed by the “hostname” parameter. If “hostname” is omitted, the system automatically sets it to Admin.
Page 120: Ipaddress
API Guide for ViewStation EX, ViewStation FX, and VS4000 ipaddress Description This command sets or gets the LAN IP address of the system. Use this command when you need to allocate a static IP address to your system. After a change is made, the system prompts you for a restart.
Page 121: Ipdialspeed
1152, 1176, 1216, 1232, 1280, 1288, 24x56, 21x64, 1400, 1408, 1456, 1472, 1512, 1536, 1568, 1600, 1624, 1664, 1680, 1728, 1736, 32x56, 28x64, 1848, 1856, 1904, and 1920 Kbps. Note: The ViewStation EX system supports speeds up to 768 Kbps. Enables the specified speed. Disables the specified speed.
Page 122: Ipprecedence
API Guide for ViewStation EX, ViewStation FX, and VS4000 ipprecedence Description This command lets you set or get the IP Precedence option and specify a priority level for the Type of Service (Quality of Service and Firewalls). The value can be between 0 and 5 for video, audio, or fecc data.
Page 123: Ipstat
User Interface Screen Location System Info > Admin Setup > LAN/H.323 > LAN/Intranet > LAN & Intranet: all fields on page System Info > Admin Setup > LAN/H.323 > LAN/Intranet > Advanced LAN Settings: LAN Port and PC Port © Polycom, Inc.
Page 124: Ispopupup
API Guide for ViewStation EX, ViewStation FX, and VS4000 ispopupup Description This command informs you if a popup screen or keyboard is currently displayed or not. Syntax ispopupup Example ispopupup returns ispopupup no www.polycom.com/videodocumentation...
Page 125: Isuserinputup
System Commands isuserinputup Description This command gets the current state of user input screens, that is, popup screens that require user input before the popup is removed. Syntax isuserinputup Example isuserinputup returns isuserinputup yes © Polycom, Inc.
Page 126: Keypadaudioconf
API Guide for ViewStation EX, ViewStation FX, and VS4000 keypadaudioconf Description This command sets or gets the keypad audio confirmation. When this option is enabled, an audio response is echoed when a numeric key is depressed on the remote control.
Page 127: Language
Example language set german User Interface Screen Location System Info > Admin Setup > General Setup: Language © Polycom, Inc. Definition Sets the command. It requires a “language” parameter. Returns the current language on the system. Must be one of the following: •...
Page 128: Lanport
API Guide for ViewStation EX, ViewStation FX, and VS4000 lanport Description This command sets or gets the system’s LAN speed and duplex mode settings. Syntax lanport <auto|”rate”> |get] Parameter auto “rate” Example lanport auto User Interface Screen Location System Info > Admin Setup > LAN/H.323 > LAN/Intranet > Advanced LAN...
Page 129: Lanstat
5 0 lanstat: rx_polycasts 1 0 lanstat: rx_polycasts_filtered 0 0 lanstat: rx_resource_error 0 0 © Polycom, Inc. Definition Returns the accumulating total of LAN statistics for the current minute. Returns the last 0 to 60 minutes of LAN statistics.
Page 130 API Guide for ViewStation EX, ViewStation FX, and VS4000 lanstat: rx_collisions 0 0 lanstat: rx_oversize_frame 0 0 lanstat: rx_runt_errors 0 0 lanstat: rx_crc_errs 0 0 lanstat: rx_align_errs 0 0 lanstat: rx_overruns 0 0 lanstat: rx_no_buffer 0 0 lanstat: rx_multiframe 0 0...
Page 131: Listen
Notification of event: the system is waking up. Example 2 listen sleep off unregisters the sleep command. © Polycom, Inc. Definition Instructs the session to listen for incoming phone calls. When this event occurs, the message “listen audio ringing” is received.
Page 132: Maxgabinternationalcallspeed
Syntax maxgabinternationalcallspeed <set|get> <"valid speed"> Parameter “valid speed” Note The ViewStation EX system supports speeds up to 768 Kbps. Example maxgabinternationalcallspeed set 512 User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Global Address > Preferences: Maximum Line Speed for Global Address: International ISDN Calls...
Page 133: Maxgabinternetcallspeed
Syntax maxgabinternetcallspeed <set|get> <"valid speed"> Parameter “valid speed” Note The ViewStation EX system supports speeds up to 768 Kbps. Example maxgabinternetcallspeed set 384 User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Global Address > Preferences: Maximum Line Speed for Global Address: LAN/Internet Calls (H.323) ©...
Page 134: Maxgabisdncallspeed
Syntax maxgabisdncallspeed <set|get> <"valid speed"> Parameter “valid speed” Note The ViewStation EX system supports speeds up to 768 Kbps. Example maxgabisdncallspeed set 384 User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Global Address > Preferences: Maximum Line Speed for Global Address: ISDN Video Calls (H.320)
Page 135: Maxtimeincall
Example maxtimeincall set 180 User Interface Screen Location System Info > Admin Setup > General Setup: Maximum Time in a Call © Polycom, Inc. Definition Sets the maximum time for calls when followed by a parameter from {0..99999}. To erase the current setting, omit the parameter: the call will stay up indefinitely.
Page 136: Mcupassword
This command sends the MCU password when the MCU prompts system for an MCU password. The Meeting Password can be configured as the multipoint MCU conference password. Note This command is not available on the ViewStation EX unless you purchase the multipoint option. Syntax mcupassword ["password"] Parameter “...
Page 137: Meetingpassword
EXpasswd User Interface Screen Location System Info > User Setup: Meeting Password System Info > Admin Setup > Security: Meeting Password © Polycom, Inc. Definition Sets the meeting password if followed by the “password” parameter. To erase the current setting, omit the “password”...
Page 138: Mpautoanswer
This command sets or gets the Auto Answer Multipoint mode which determines how the system handles an incoming call in a multipoint video conference. Note This command is not available on the ViewStation EX unless you purchase the multipoint option. Syntax mpautoanswer <yes|no|donotdisturb|get>...
Page 139: Mpmode
The multipoint mode can be set to auto, discussion, presentation, or fullscreen. By default, it is set to auto. Note This command is not available on the ViewStation EX unless you purchase the multipoint option. Syntax mpmode <auto|discussion|presentation|fullscreen|get>...
Page 140: Mute
API Guide for ViewStation EX, ViewStation FX, and VS4000 mute Description This command sets or gets the near or far site mute mode. It can also set the system to register or unregister mode. In register mode, the system sends notification to the shell session when the far or near site is muted or unmuted.
Page 141: Muteautoanswercalls
Example muteautoanswercalls yes User Interface Screen Location System Info > User Setup: Mute Auto Answer Calls © Polycom, Inc. Definition Enables Mute Auto Answer Calls mode. The microphone will be muted when the system receives a call while in Auto Answer mode.
Page 142: Nearloop
API Guide for ViewStation EX, ViewStation FX, and VS4000 nearloop Description This command turns the Near End Loop on or off. When it is on, you can test the encoder/decoder on your system. This can help you diagnose a problem with an ISDN (H.320) video call.
Page 143: Netmeetingip
Example netmeeting set 192.168.100.7 User Interface Screen Location System Info > Admin Setup > Data Conference: NetMeeting © Polycom, Inc. Definition Sets the NetMeeting IP address when followed by the “ipaddress” parameter. To erase the current setting, omit the parameter.
Page 144: Netstats
API Guide for ViewStation EX, ViewStation FX, and VS4000 netstats Description This command is used to get network statistics for endpoints in a multipoint call. Syntax netstats [{0..2}] Parameter {0..2} Examples netstats netstats 2 return information similar to this: call:1 txrate:128k rxrate:128k pktloss:0 %pktloss:0.00% tvp:H.263+FIT rvp:H.263+FIT tvf:CIF rvp:CIF tap:G.728...
Page 145: Ntpmode
Example ntpmode auto User Interface Screen Location System > Admin Setup > LAN/H.323 > LAN & Intranet > NTP Setup © Polycom, Inc. Definition Automatically selects an NTP server from the Internet. Turns off the use of an NTP server.
Page 146: Ntpserver
API Guide for ViewStation EX, ViewStation FX, and VS4000 ntpserver Description This command sets or gets an Network Time Protocol (NTP) server, using the IP address or the DNS name of the server. This allows you to use an internal time server and thus synchronize the system’s time with the time on your...
Page 147: Numberofmonitors
Number of Monitors © Polycom, Inc. Definition Sets the number of monitors allowed. Maximum number is 4 for ViewStation FX and VS4000 systems, and 2 for ViewStation EX systems. Returns the current setting (1, 2, 3, or 4). System Commands...
Page 148: Numdigitsdid
API Guide for ViewStation EX, ViewStation FX, and VS4000 numdigitsdid Description This command sets or gets the number of digits in the DID gateway number (E.164 dialing). The number of digits in the DID is that portion of the full DID that the gateway will be given from the ISDN service provider as the Called Party Line Identifier.
Page 149: Numdigitsext
System Info > Admin Setup > LAN/H.323 > H.323 > Gateway: Number of digits in extension Note This option becomes visible when Direct Inward Dial (DID) has been selected on the same screen. © Polycom, Inc. Definition Sets the number of digits in the gateway number. Returns the current setting. System Commands...
Page 150: Outboundcallroute
API Guide for ViewStation EX, ViewStation FX, and VS4000 outboundcallroute Description This command sets or gets the default outbound calling route. Syntax outboundcallroute <gateway|isdn|get> Parameter gateway isdn Example outboundcallroute gateway User Interface Screen Location System Info > Admin Setup > LAN/H.323 > H.323 > Gatekeeper: Outbound...
Page 151: Pause
Pauses are useful when commands are retrieved from a script file. Syntax pause <{0..65535}> Parameter {0..65535} Example pause 3 Note In this example, the command pauses 3 seconds before executing the next command. © Polycom, Inc. Definition Number of seconds to pause. System Commands...
Page 152: Pcport
API Guide for ViewStation EX, ViewStation FX, and VS4000 pcport Description This command sets or gets the PC port speed of the system. Syntax pcport <auto|”rate”|get> Parameter auto “rate” Example pcport 100fdx User Interface Screen Location System Info > Admin Setup > LAN/H.323 > LAN/Intranet > Advanced LAN...
Page 153: Phone
Description This command either switches the phone channel to the next channel to add another telephone call to a video call, or clears any dialstring from the text box on the Telephone screen of the user interface. Syntax phone <flash|clear>...
Page 154: Ping
API Guide for ViewStation EX, ViewStation FX, and VS4000 ping Description This command pings the IP address of a device to check if it can be reached. This command is similar to the command Syntax ping <ipaddress> [“count”] Parameter “ipaddress”...
Page 155: Pip
Example pip auto User Interface Screen Location System Info > User Setup: PIP © Polycom, Inc. Definition Enables PIP mode. The system shows a PIP window which remains in the lower right corner of the TV screen until the video call is completed.
Page 156: Popup
API Guide for ViewStation EX, ViewStation FX, and VS4000 popup Description This command registers or unregisters the shell session to receive popup notifications. Syntax popup <register|unregister> Parameter register unregister Example popup register returns ispopupup no popup registered Definition Registers the system to display to the API control device the text of all popups displayed on the user interface.
Page 157: Preferredalias
System Info > Admin Setup > LAN/H.323 > Global Address > Preferences: Preferred Alias (E.164). Select this field to access the Preferred Alias screen. © Polycom, Inc. Definition Sends the ISDN number as the preferred alias. Sends the Full DID number as the preferred alias.
Page 158: Preset
API Guide for ViewStation EX, ViewStation FX, and VS4000 preset Description This command sets camera presets or goes to the presets for the near or far camera source. It can also register or unregister the shell session to give notification when someone sets or goes to presets. You can set and store up to ten preset camera positions.
Page 159: Primarycallchoice
User Interface Screen Location System Info > Admin Setup > Video Network > Call Preferences: Primary Call Type Choice © Polycom, Inc. secondarycallchoice Definition Selects ISDN as the Primary Call Type Choice. Selects IP as the Primary Call Type Choice.
Page 160: Primarycamera
Syntax primarycamera <{1..4}>|get Parameter {1..4} Note Option 4 (camera 4) is not available for the ViewStation EX. Example primarycamera 1 User Interface Screen Location System Info > Admin Setup > Video/Cameras > Cameras: Primary Camera Definition Selects the camera to use as the primary video source.
Page 161: Queuecommands
System Commands queuecommands Note The queuecommands command is no longer relevant as the system can now process all commands when they are issued, regardless of the system state. © Polycom, Inc.
Page 162: Reboot
API Guide for ViewStation EX, ViewStation FX, and VS4000 reboot Description This command restarts the system. The system settings (such as system name and remote access settings) are cleared unless you include the y parameter. Syntax reboot [y] Parameter Example...
Page 163: Registerall
The function and syntax of registerall and register all are identical. Syntax registerall Parameter registerall © Polycom, Inc. Definition Registers changes to any of the following types of parameters: • Current near end or far end source • State of privacy •...
Page 164: Registerthissystem
API Guide for ViewStation EX, ViewStation FX, and VS4000 registerthissystem Description This command sets or gets the system’s IP address to be registered and displayed in the Global Address Book (GAB) when the system is powered on. If you do not enable this option, the system has access to the GAB, but the IP address does not appear in the Global Address Book of other systems.
Page 165: Repeat
Consequently, the command: repeat 4 will repeat command the fourth command, which in the preceding history list is ipdialspeed set 128 on . © Polycom, Inc. 110. Definition Repeats the specified command in the history list. Values larger than the number of commands in the history list are not valid.
Page 166: Requireacctnumtodial
API Guide for ViewStation EX, ViewStation FX, and VS4000 requireacctnumtodial Description This command sets or gets the Require Account Number to Dial option. It is used to log calls to a specific account so that they can be tracked and billed to the appropriate departments.
Page 167: Roomphonenumber
“number” parameter. To erase the current setting, omit the parameter. Returns the current setting. Telephone number for a telephone (not the system) in the room. Note: Enclose the number in quotation marks if it includes spaces. Example: 512 555 1212...
Page 168: Rs232
API Guide for ViewStation EX, ViewStation FX, and VS4000 rs232 Description This command configures and monitors the RS-232 port. For more detailed information about the RS-232 interface, see “V.35/RS-449/RS-530 Commands” on page 259 of this manual. Syntax rs232<mode|flowcontrol|baud> rs232 mode <passthru|control|get>...
Page 169: Run
API commands contained in it. Each command needs to be placed on a single line with a <CR><LF> as a terminator. Syntax run <“scriptfilename”> Parameter scriptfilename Example run startcall.bat © Polycom, Inc. Definition Name of the script file containing the API commands to be executed. System Commands...
Page 170: Screen
API Guide for ViewStation EX, ViewStation FX, and VS4000 screen Description This command causes a specified screen to be displayed on the system. Syntax screen <addressbook|farvideo|main|nearvideo|sysinfo|speeddial| disableui|enableui|chaircontrol|sleep|wake|phone> Parameter addressbook speeddial farvideo main nearvideo sysinfo disableui enableui chaircontrol sleep wake phone...
Page 171: Secondarycallchoice
User Interface Screen Location System Info > Admin Setup > VIdeo Network > Call Preferences: Secondary Call Type Choice © Polycom, Inc. Definition Selects ISDN as the Secondary Call Type Choice. Selects IP as the Secondary Call Type Choice.
Page 172: Sendonlypreferredalias
API Guide for ViewStation EX, ViewStation FX, and VS4000 sendonlypreferredalias Description This command enables the option Send Only Preferred Alias. It allows you to select which E.164 alias to send to the gatekeeper. Any change forces a system restart. Syntax sendonlypreferredalias <yes|no|get>...
Page 173: Serialnum
System Commands serialnum Description This command displays the serial number of the system. Syntax serialnum Example serialnum returns something like this: 00EA79 User Interface Screen Location System Info > Admin Setup > Software/Hardware > Software: System Serial Number © Polycom, Inc.
Page 174: Setaccountnumber
API Guide for ViewStation EX, ViewStation FX, and VS4000 setaccountnumber Description This command sets the account number that is required for dialing out. The account number is saved in the Global Management System database and is generally assigned by the Global Management System administrator. See...
Page 175: Showaddrsingab
User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Global Address > Preferences: Show Addresses in Address Book © Polycom, Inc. Definition Returns only H.320 (ISDN) video numbers in the GAB. Returns only H.323 (IP) numbers in the GAB.
Page 176: Showpopup
API Guide for ViewStation EX, ViewStation FX, and VS4000 showpopup Description This command displays a popup message box in the user interface for 15 seconds. Syntax showpopup <“text”> Parameter “text” Example showpopup Definition Message to display immediately to users. Enclose the text in quotation marks.
Page 177: Sleep
System Commands sleep Description This command puts the system in sleep mode. To resume normal operation, use the wake command. Syntax sleep Example sleep © Polycom, Inc.
Page 178: Slides
API Guide for ViewStation EX, ViewStation FX, and VS4000 slides Description This command and its subcommands let you select and control a slide presentation. To use the slides subcommands, you must first load the slide presentation via the web browser. For information about loading a slide presentation using the web browser, refer to the Getting Started Guide for ViewStation EX, FX, and VS4000.
Page 179: Snapshot
Syntax snapshot <{0..4}|register|unregister> Parameter register unregister Example snapshot 1 © Polycom, Inc. snapshottimeout on page 173). Definition Generates a snapshot from the far-site camera. Generates a snapshot from near camera 1. Generates a snapshot from near camera 2 (document camera).
Page 180: Snapshotcamera
API Guide for ViewStation EX, ViewStation FX, and VS4000 snapshotcamera Description This command sets or gets the default camera from which you want to send snapshots. Syntax snapshotcamera <{1..4}|get> Parameter {1..4} Example snapshotcamera 1 User Interface Screen Location System Info > Admin Setup > Video/Cameras > Cameras: Snapshot Camera Definition Sets camera 1, 2, 3, or 4 to be used for a snapshot.
Page 181: Snapshottimeout
User Interface Screen Location System Info > Admin Setup > Video/Cameras > Monitors > TV Monitors: Snapshot Timeout © Polycom, Inc. Definition Enables the option: the display times out after four minutes and the system returns to live video.
Page 182: Snmpadmin
API Guide for ViewStation EX, ViewStation FX, and VS4000 snmpadmin Description This command sets or gets the SNMP administrator name. Syntax snmpadmin <set|get> ["admin name"] Parameter “admin name” Example snmpadmin set User Interface Screen Location System Info > Admin Setup > LAN/H.323 > SNMP: Administrator Contact...
Page 183: Snmpcommunity
Example snmpcommunity set Public User Interface Screen Location System Info > Admin Setup > LAN/H.323 > SNMP: Community Name © Polycom, Inc. Definition Sets the SNMP community name when followed by the “community name” parameter. To erase the current setting, omit the parameter.
Page 184: Snmpconsoleip
API Guide for ViewStation EX, ViewStation FX, and VS4000 snmpconsoleip Description This command sets or gets the SNMP console IP address. Syntax snmpconsoleip <set|get> ["ipaddress"] Parameter “ipaddress” Example snmpconsoleip set 192.168.1.111 User Interface Screen Location System Info > Admin Setup > LAN/H.323 > SNMP: SNMP Console IP Address...
Page 185: Snmplocation
Example snmplocation set User Interface Screen Location System Info > Admin Setup > LAN/H.323 > SNMP: Location Name © Polycom, Inc. Definition Sets the SNMP location name when followed by the “location name” parameter. To erase the current setting, omit the parameter.
Page 186: Soundeffectsvolume
API Guide for ViewStation EX, ViewStation FX, and VS4000 soundeffectsvolume Description This command allows you to adjust and test the volume of the sounds made by the system when you select an object on the screen with the remote control.
Page 187: Speeddial List
System Commands speeddial list Description This command lists the contents of the current Speed Dial entries. Syntax speeddial list Example speeddial list User Interface Screen Location Speed Dial or Address Book > Speed Dial © Polycom, Inc.
Page 188: Speeddial Lock Or Speeddial Unlock
API Guide for ViewStation EX, ViewStation FX, and VS4000 speeddial lock or speeddial unlock Description This command locks a specified Speed Dial entry so it cannot be overwritten by a new call. Syntax speeddial lock {1..6} speeddial unlock {1..6} Example...
Page 189: Stdout
This command redirects the standard output to the port from which you are issuing the stdout command. Syntax stdout <on|off> Parameter Example stdout on stdout off © Polycom, Inc. Definition Turns on the standard output. Turns off the standard output. System Commands...
Page 190: Stream
API Guide for ViewStation EX, ViewStation FX, and VS4000 stream Description This command starts or stops streaming from your system. Syntax stream <start|stop> Parameter start stop Example stream start User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Streaming: Allow Streaming Call Type >...
Page 191: Streamannounce
<yes|no|get> Parameter Example streamannounce yes User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Streaming: Enable Streaming Announcement © Polycom, Inc. Definition Enables streaming announcement. Disables streaming announcement. Returns the current setting (yes or no). System Commands...
Page 192: Streamaudioport
API Guide for ViewStation EX, ViewStation FX, and VS4000 streamaudioport Description This command sets or gets the stream audio port. By default, the audio port is a fixed port. This may be changed if a user needs to go through the firewall.
Page 193: Streamenable
This command enables or disables streaming on the system. Syntax streamenable <yes|no|get> Parameter Example streamenable yes User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Streaming: Allow Streaming © Polycom, Inc. Definition Enables streaming. Disables streaming. Returns the current setting (yes or no). System Commands...
Page 194: Streammulticastip
This command sets or gets the multicast IP address. A default address is entered for you based on your system’s serial number. This ensures that you do not have the same multicast address as another Polycom system. You can change this default address using this command.
Page 195: Streamrestoredefaults
This command restores the stream Speed, IP Multicast Address, Number of Router Hops, Audio Port, and Video Port defaults and prints out the values. Syntax streamrestoredefaults Example streamrestoredefaults returns information similar to this: streamspeed 192 streammulticastip 231.0.231.01 streamrouterhops 1 streamaudioport 16384 streamvideoport 16386 streamannounce yes streamenable no © Polycom, Inc.
Page 196: Streamrouterhops
API Guide for ViewStation EX, ViewStation FX, and VS4000 streamrouterhops Description This command sets or gets the number of routers you want the streaming video to pass through. This allows you to control who can see your streaming video. Syntax streamrouterhops <set|get>...
Page 197: Streamspeed
<192|256|384|512|get> Parameter 192|256|384| Example streamspeed 256 User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Streaming: Speed © Polycom, Inc. Definition Sets the streaming speed at the designated number of Kbps. Returns the current setting. System Commands...
Page 198: Streamvideoport
API Guide for ViewStation EX, ViewStation FX, and VS4000 streamvideoport Description This command sets or gets the stream video port. By default, the video port is a fixed port. This command lets you can change stream video port to go through a firewall.
Page 199: Subnetmask
255.255.255.0 User Interface Screen Location System Info > Admin Setup > LAN/H.323 > LAN/Intranet > LAN & Intranet: Subnet Mask © Polycom, Inc. Definition Sets the subnet mask of the system when followed by the “ipaddress” parameter. To erase the current setting, omit the “ipaddress”...
Page 200: Sysinfo
API Guide for ViewStation EX, ViewStation FX, and VS4000 sysinfo Description This command registers or unregisters the shell session to receive ISDN, IP , and gatekeeper status notifications. Syntax sysinfo <register|unregister> Parameter register unregister Example sysinfo register Definition Registers the shell session to receive ISDN, IP , and gatekeeper status notifications.
Page 201: Systembehindnat
User Interface Screen Location System Info > Admin Setup > LAN/H.323 > LAN/Intranet > Firewall/LAN Connection: System is Behind a NAT © Polycom, Inc. Definition Sets the system to be behind a NAT and use the NAT Outside (WAN) Address.
Page 202: Systemhastelephone
API Guide for ViewStation EX, ViewStation FX, and VS4000 systemhastelephone Description This command sets or gets whether or not the system has a POTS line connected. Syntax systemhastelephone <yes|no|get> Parameter Example systemhastelephone get User Interface Screen Location System Info > Admin Setup > Phone/Audio Definition Sets this option to yes.
Page 203: Systemname
"Pacific Room" User Interface Screen Location System Info > Admin Setup > General Setup: System Name © Polycom, Inc. Definition Sets the system name when followed by the “system name” parameter. The name can be up to 34 characters long.
Page 204: T120Nameip
API Guide for ViewStation EX, ViewStation FX, and VS4000 t120nameip Description This command sets or gets the t120 data conference name or IP address. You are prompted for a restart if this setting is changed. Note Data conferencing is only available during IP (H.320) calls and must be supported by far-site systems.
Page 205: Tcpports
User Interface Screen Location System Info > Admin Setup > LAN/H.323 > LAN/Intranet > Firewall/LAN Connection: Use Fixed Ports > TCP Ports © Polycom, Inc. Definition Sets the TCP ports when followed by a value from the range of available TCP ports {1024..49150}.
Page 206: Techsupport
API Guide for ViewStation EX, ViewStation FX, and VS4000 techsupport Description This command sends your phone number to Global Management System technical support if your system is managed by the Global Management System. Syntax techsupport <"phone number"> Parameter “phone number” Phone number at which the user of this system will be...
Page 207: Teleareacode
Description This command sets or gets the system’s telephone area code. Syntax teleareacode <set|get> ["telephone area code"] Parameter “telephone area code” Example teleareacode set 703 User Interface Screen Location System Info > Admin Setup > Phone/Audio: Area Code © Polycom, Inc.
Page 208: Telecountrycode
API Guide for ViewStation EX, ViewStation FX, and VS4000 telecountrycode Description This command sets or gets the system’s telephone country code. This code is associated with the country where the system is used. The system is generally able to automatically determine the country code based on the country you selected during initial system setup.
Page 209: Telenumber
Description This command sets or gets the system’s telephone number. Syntax telenumber <set|get> ["telephone number"] Parameter “telephone number” Example telenumber set 5551212 User Interface Screen Location System Info > Admin Setup > Phone/Audio: Number © Polycom, Inc. Definition Sets the telephone number when followed by the “telephone number”...
Page 210: Testlan Arp
API Guide for ViewStation EX, ViewStation FX, and VS4000 testlan arp Description This command prints the ARP (Address Resolution Protocol) table contents. Syntax testlan arp Example testlan arp www.polycom.com/videodocumentation...
Page 211: Testlan Dcuinfo
36 = 1 for 37 = 1 for 44 = 1 for 49 = 2048 for 52 = 1 IP counts: ip_xchg_count=590, list_input_count=590 Total TX: offered=316, processed=316 Badrequestor=0, Badpointer=0, Badindex=0, total=4096 © Polycom, Inc. System Commands DCUs DCUs DCUs DCUs DCUs DCU:...
Page 212: Testlan Dns
API Guide for ViewStation EX, ViewStation FX, and VS4000 testlan dns Description This command returns a domain name for an IP address or an IP address for a domain name. Syntax testlan dns <“name or ipaddress”> Parameter “name or ipaddress“...
Page 213: Testlan Echo
© Polycom, Inc. Definition Generates UDP packets to this destination IP address (remote UDP echo server) and prints an echo message with specific information when followed by one of the parameters in this table.
Page 214 API Guide for ViewStation EX, ViewStation FX, and VS4000 Example 2 testlan echo 207.46.197.101 This output shows a failure condition: testlan: echo cf2ec565 100 10 10 100 7 1024 testlan: waiting 100000us for next message testlan: sent=10, received=0, lost=10, delayed=0, corrupt=0...
Page 215: Testlan Ping
Syntax testlan ping <“ipaddress”> [“count”] Parameter “ipaddress” “count” Example testlan ping 192.168.1.200 5 © Polycom, Inc. ping described on page 146. Definition IP address of the device. Optional parameter defining the number of times the device is to be pinged.
Page 216: Textinput
API Guide for ViewStation EX, ViewStation FX, and VS4000 textinput Description This command inserts text into a user interface edit box that you have already selected using the remote control. Syntax textinput <"text to input"> Parameter “text to input” Example textinput This command would insert the text "Pacific Room VS4000"...
Page 217: Timediffgmt
Example timediffgmt -6:00 User Interface Screen Location System Info > Admin Setup > LAN/H.323 > Global Management> Setup: Time Difference from GMT © Polycom, Inc. Definition Range of time differences. +00:00 is GMT time. Returns the current setting. System Commands...
Page 218: Typeofservice
API Guide for ViewStation EX, ViewStation FX, and VS4000 typeofservice Description This command selects the type of service for Quality of Service. Syntax typeofservice <ipprecedence|diffserv|get> Parameter ipprecedence diffserv Example typeofservice diffserv User Interface Screen Location System Info > Admin Setup > LAN/H.323 > QOS: Type of Service (ToS) Field Definition Selects IP precedence service.
Page 219: Udpports
3230 User Interface Screen Location System Info > Admin Setup > LAN/H.323 > LAN/Intranet > Firewall/LAN Connection: Use Fixed Ports > UDP Ports © Polycom, Inc. Definition Sets the UDP ports when followed by a value from the range {1024..49150}.
Page 220: Unregisterall
API Guide for ViewStation EX, ViewStation FX, and VS4000 unregisterall Description This command simultaneously unregisters all user feedback, that is all changes that have been made to any of the parameter types listed in the following table. This allows you to be informed via the API interface of all user actions and is particularly useful when two different control systems are being used simultaneously, such as the web and API commands.
Page 221: Usefixedports
User Interface Screen Location System Info > Admin Setup > LAN/H.323 > LAN/Intranet > Firewall/LAN Connection: Use Fixed Ports © Polycom, Inc. Definition Enables the use of Used Fixed Ports. Disables the use of Used Fixed Ports. Returns the current setting (yes or no).
Page 222: Usegatekeeper
API Guide for ViewStation EX, ViewStation FX, and VS4000 usegatekeeper Description This command sets or gets the gatekeeper mode (off, specify, or auto). After a change, the user is prompted for system restart. Note A gatekeeper is not required to make IP-to-IP LAN calls. In these situations, select the off option.
Page 223: Usepathnavigator
Note This option is only accessible if PathNavigator is used. Note This command is not available on the ViewStation EX unless you purchase the multipoint option. Syntax usepathnavigator <always|never|required|get> Parameter...
Page 224: Validateacctnum
API Guide for ViewStation EX, ViewStation FX, and VS4000 validateacctnum Description This command sets or gets the validation for the Global Management System account number that is used when dialing out. When the call connects, the system verifies that the account exists with the Global Management System server.
Page 225: Vcbutton
Example vcbutton play © Polycom, Inc. Definition Starts sending the video stream from the Visual Concert Stops sending the video stream from the Visual Concert Returns the current mode/setting (play or stop). Registers the shell session to receive notifications about Visual Concert FX events.
Page 226: Vcfxvgacontentpreview
API Guide for ViewStation EX, ViewStation FX, and VS4000 vcfxvgacontentpreview Description This command sets or gets the ability to preview content on the near Visual Concert FX monitor. (To set the ability to show content on a PC connected to...
Page 227: Vcraudioout
Example vcraudioout yes User Interface Screen Location System Info > Admin Setup > Video/Cameras > VCR: VCR Audio Out Always On © Polycom, Inc. Definition Enables the option. Disables the option. Returns the current setting (yes or no). System Commands...
Page 228: Vcrrecordsource
API Guide for ViewStation EX, ViewStation FX, and VS4000 vcrrecordsource Description This command sets or gets the VCR record source. Syntax vcrrecordsource <auto|near|far|get> Parameter auto near Example vcrrecordsource auto User Interface Screen Location System Info > Admin Setup > Video/Cameras > VCR: VCR Record Source...
Page 229: Vcstream
Example vcstream state returns vcstream state no video © Polycom, Inc. Definition Returns the current status of the Visual Concert content stream. Registers the Visual Concert stream so that changes to the stream will be displayed to the API control device, and reports the current status of the stream.
Page 230: Version
API Guide for ViewStation EX, ViewStation FX, and VS4000 version Description This command displays the current system’s version information. Syntax version Example version returns version Release 6.0 FX - 31Mar2004 14:12 User Interface Screen Location System Info: Software Version www.polycom.com/videodocumentation...
Page 231: Vgahorizpos
Position Note This screen is only visible if a Visual Concert FX unit is connected to your system. © Polycom, Inc. Definition Sets the calibration frame to the left. Sets the calibration frame to the right. Returns the current setting (left or right)
Page 232: Vgaoffmode
API Guide for ViewStation EX, ViewStation FX, and VS4000 vgaoffmode Description This command sets or gets the system’s VGA off mode. Syntax vgaoffmode <black|nosignal|get> Parameter black nosignal Example vgaoffmode nosignal User Interface Screen Location System Info > Admin Setup > Video/Cameras > Monitors > Graphics Monitor >...
Page 233: Vgaphase
System Info > Admin Setup > Video/Cameras > VGA Input: Phase Note This screen is only visible if a Visual Concert FX unit is connected to your system. © Polycom, Inc. Definition Increases the phase by 1. Decreases the phase by 1.
Page 234: Vgaresolution
API Guide for ViewStation EX, ViewStation FX, and VS4000 vgaresolution Description This command sets or gets the system’s VGA output resolution. Select the maximum resolution that your monitor or projector can support. Consult the user manual provided with the VGA monitor or projector for performance.
Page 235: Vgavertpos
System Info > Admin Setup > Video/Cameras > VGA Input: Vertical Position Note This screen is only visible if a Visual Concert FX unit is connected to your system. © Polycom, Inc. Definition Moves the calibration frame up by 1. Moves the calibration frame down by 1.
Page 236: Volume
API Guide for ViewStation EX, ViewStation FX, and VS4000 volume Description This command sets or gets the audio volume on the system (not including sound effects). It also lets you register and unregister for notification of changes to the volume level.
Page 237: Waitfor
Example waitfor callcomplete © Polycom, Inc. Definition Causes the API shell to wait until a call being placed either connects or fails. Causes the system to return the message “system is ready” when the system is ready to make a call.
Page 238: Wake
API Guide for ViewStation EX, ViewStation FX, and VS4000 wake Description This command wakes the system from sleep mode. To put the system in sleep mode, use the command sleep. Syntax wake Example wake www.polycom.com/videodocumentation...
Page 239: Wanipaddress
192.168.1.122 User Interface Screen Location System Info > Admin Setup > LAN/H.323 > LAN/Intranet > Firewall/ LAN Connection: NAT Outside (WAN) Address © Polycom, Inc. Definition Sets the WAN IP address when followed by the “ipaddress” parameter. To erase the current setting, omit the parameter.
Page 240: Whoami
API Guide for ViewStation EX, ViewStation FX, and VS4000 whoami Description This command displays banner information. Syntax whoami Example whoami might return something like this: Hi, my name is: Serial Number: Brand: Software Version: Model: Network Interface: MP Enabled: Encryption Enabled: Yes H.264 Enabled:...
Page 241: Widescreenvideo
512 Kbps and above. Note This option only works between ViewStation EX, ViewStation FX, or VS4000 systems with software version 4.0 and higher. If one of the systems has a software version older than 4.0, the proprietary letter box format is supported.
Page 242: Winsresolution
API Guide for ViewStation EX, ViewStation FX, and VS4000 winsresolution Description This command sets or gets WINS resolution. After a change is made, the system prompts you for a restart. Syntax winsresolution <yes|no|get> Parameter Example winsresolution no User Interface Screen Location System Info >...
Page 243: Winsserver
192.168.1.57 User Interface Screen Location System Info > Admin Setup > LAN/H.323 > LAN/Intranet > LAN & Intranet: WINS Server © Polycom, Inc. Definition Sets the WINS server IP address. To erase the current setting, omit the parameter.
Page 244 API Guide for ViewStation EX, ViewStation FX, and VS4000 www.polycom.com/videodocumentation...
Page 245: Isdn Commands
ISDN Commands The commands in the following section pertain to ISDN Quad BRI and PRI network interfaces. © Polycom, Inc.
Page 246: Isdnareacode
API Guide for ViewStation EX, ViewStation FX, and VS4000 isdnareacode Description This command sets or gets the ISDN area code or STD code associated with the area where the system is used. Syntax isdnareacode <set|get> ["area code"] Parameter “area code”...
Page 247: Isdncountrycode
Sets the ISDN country code when followed by the “country code” parameter. To erase the current setting, omit “country code” . Returns the country code information. Numeric value. This code is the same as the telephone country code. ISDN Commands...
Page 248: Isdndialingprefix
API Guide for ViewStation EX, ViewStation FX, and VS4000 isdndialingprefix Description This command sets or gets the ISDN dialing prefix used to access an outside line if the system is behind a PBX. Syntax isdndialingprefix <set|get> ["isdn prefix"] Parameter “isdn prefix”...
Page 249: Isdndialspeed
System Info > Admin Setup > Video Network > IMUX > Dialing Speeds Note This screen is only accessible if you have a Quad BRI, PRI, or V.35 network interface connected to your system. © Polycom, Inc. Definition Sets the command. The parameters “valid speed” and on or off are required.
Page 250: Isdnnum
API Guide for ViewStation EX, ViewStation FX, and VS4000 isdnnum Description This command sets or gets the ISDN video number or numbers assigned to the system. Syntax isdnnum <set|get> <“bchannel”> [“number”] Parameter “bchannel” “number” Example isdnnum set 1b1 5125551212 User Interface Screen Location System Info >...
Page 251: Priareacode
System Info > User Setup > Video Network > IMUX > Numbers Note This screen is only accessible if you have a PRI network interface connected to your system. © Polycom, Inc. Definition Sets the PRI area code when followed by the “area code” parameter.
Page 252: Pricallbycall
API Guide for ViewStation EX, ViewStation FX, and VS4000 pricallbycall Description This command sets or gets the PRI area code. Call-by-call is a number from 1 to 31, which is optionally sent to an upstream telephone company switch, if required. For example, specify a value of 6 for a T1 PRI network interface module that is directly connected to an ATT 5ESS switch, which is provisioned with Accunet.
Page 253: Prichannel
User Interface Screen Location System Info > Admin Setup > Video Network > IMUX > PRI Network > PRI Status © Polycom, Inc. Definition Sets the PRI channels to be active when followed by a parameter from <all|{1..23|1..30}>}> and from <on|off>.
Page 254: Important Pri Channel Information
API Guide for ViewStation EX, ViewStation FX, and VS4000 Note This screen is only accessible if you have a PRI network interface connected to your system. Important PRI Channel Information Outgoing Call. For an outgoing call, the ViewStation FX or VS4000 system uses the first active and available channel starting with the lowest number from the channel range (1-23 for a PRI T1 and 1-30 for a PRI E1).
Page 255: Pricsu
Setup: CSU Note This screen is only accessible if you have a PRI network interface connected to your system. © Polycom, Inc. Definition Sets the internal CSU mode. This is the default. Sets the external CSU mode. When selected, you must specify the PRI line buildout.
Page 256: Pridialchannels
API Guide for ViewStation EX, ViewStation FX, and VS4000 pridialchannels Description This command sets or gets the number of PRI channels to dial in parallel. By default, ISDN channels are dialed three at a time. On PRI systems, you can choose the number of channels to dial in parallel.
Page 257: Priintlprefix
PRI Setup > Advanced PRI Setup: International Dialing Prefix Note This screen is only accessible if you have a PRI network interface connected to your system. © Polycom, Inc. Definition Sets the PRI international dialing prefix when followed by the parameter “prefix” .
Page 258: Prilinebuildout
API Guide for ViewStation EX, ViewStation FX, and VS4000 prilinebuildout Description This command sets or gets the PRI line buildout for a T1 interface. If you are using an internal CSU, enter the output attenuation in dB. If you are using an external CSU, enter the output attenuation in feet.
Page 259: Prilinesignal
System Info > Admin Setup > Video Network > IMUX > PRI Network > PRI Setup: Line Signaling Note This screen is only accessible if you have a PRI network interface connected to your system. © Polycom, Inc. Definition Sets the PRI line signal. It requires one of the following parameters: • esf/b8zs •...
Page 260: Prinumber
API Guide for ViewStation EX, ViewStation FX, and VS4000 prinumber Description This command sets or gets the PRI video number. Syntax prinumber <set|get> ["pri number"] Parameter “pri number” Example prinumber set 5551212 User Interface Screen Location System Info > Admin Setup > Video Network > IMUX > Numbers...
Page 261: Prinumberingplan
PRI Setup > Advanced PRI Setup Note This screen is only accessible if you have a PRI network interface connected to your system. © Polycom, Inc. Definition With this parameter, the numbering plan is identified to the upstream switch as ISDN, and the number type, which is either national or international, is determined from the dialed phone number.
Page 262: Prioutsideline
API Guide for ViewStation EX, ViewStation FX, and VS4000 prioutsideline Description This command sets or gets the PRI number that is dialed for outside line access. This number is needed if your system is on a PBX. Syntax prioutsideline <set|get> ["outside_line"] Parameter “outside_line”...
Page 263: Priswitch
Description This command sets or gets the PRI switch. If more than one switch protocol is supported, you must find out from your telephone service provider which protocol to select. NET5/CTR4 is the default. It is the standard ETSI protocol derived from ITU Q.931.
Page 264: Spidnum
API Guide for ViewStation EX, ViewStation FX, and VS4000 spidnum Description This command sets or gets the ISDN SPID number or numbers assigned to the system. SPIDs generally apply only in the U.S. and Canada. If you are behind an internal phone system (PBX), SPID numbers may not be required.
Page 265 User Interface Screen Location System Info > Admin Setup > Video Network > IMUX > SPIDS Note This screen is only accessible if you have a Quad BRI network interface connected to your system. © Polycom, Inc. ISDN Commands...
Page 266 API Guide for ViewStation EX, ViewStation FX, and VS4000 www.polycom.com/videodocumentation...
Page 267: V.35/Rs-449/Rs
V.35/RS-449/RS-530 Commands The following commands are specific to the V.35/RS-449/RS-530 network interface. The user interface screens are only accessible if you have a V.35/RS-449/RS-530 network interface connected to your system. © Polycom, Inc.
Page 268: Cts
API Guide for ViewStation EX, ViewStation FX, and VS4000 Description This command lets you configure the cts serial interface control signal (clear to send). The default setting for this signal is “normal” . Syntax cts <normal|inverted|get> Parameter normal inverted Example...
Page 269: Dcd
User Interface Screen Location System Info > Admin Setup > Video Network > Advanced V.35: DCD © Polycom, Inc. Definition Sets the signal to normal (high voltage is logic 1). Sets the signal to inverted (low voltage is logic 1).
Page 270: Dcdfilter
API Guide for ViewStation EX, ViewStation FX, and VS4000 dcdfilter Description This command lets you configure the filter of the dcd serial interface control signal (data carrier detect). When this filter is enabled, dcd drops for 60 seconds before changing the call state. The default setting for this signal is “off”...
Page 271: Dsr
User Interface Screen Location System Info > Admin Setup > Video Network > Advanced V.35: DSR © Polycom, Inc. Definition Sets the signal to normal (high voltage is logic 1). Sets the signal to inverted (low voltage is logic 1).
Page 272: Dsranswer
API Guide for ViewStation EX, ViewStation FX, and VS4000 dsranswer Description This command sets or gets the dsr serial interface control signal to indicate an incoming call. Syntax dsranswer <on|off|get> Parameter Example dsranswer on User Interface Screen Location System Info > Admin Setup > Video Network > Advanced V.35: DSR >...
Page 273: Dtr
User Interface Screen Location System Info > Admin Setup > Video Network > Advanced V.35: DTR © Polycom, Inc. Definition Sets the signal to normal (high voltage is logic 1). Sets the signal to inverted (low voltage is logic 1).
Page 274: H331Audiomode
API Guide for ViewStation EX, ViewStation FX, and VS4000 h331audiomode Description This command sets or gets the H.331 audio protocol for transmitting audio in broadcast mode. Broadcast configuration parameters should be set to accommodate the lowest common denominator of the systems which are receiving the broadcast.
Page 275: H331Framerate
30 User Interface Screen Location System Info > Admin Setup > Video Network > Video Network > Broadcast Mode Setup: Frame Rate © Polycom, Inc. Definition Sets the frame rate at 30 fps. Sets the frame rate at 15 fps.
Page 276: H331Videoformat
API Guide for ViewStation EX, ViewStation FX, and VS4000 h331videoformat Description This command sets or gets the H.331 video format for the broadcast transmission. Broadcast configuration parameters should be set to accommodate the lowest common denominator of the systems which are receiving the broadcast.
Page 277: H331Videoprotocol
User Interface Screen Location System Info > Admin Setup > Video Network > Video Network > Broadcast Mode Setup: Video Protocol © Polycom, Inc. Definition Video protocol based on an enhanced video algorithm. Only far-site systems that support H.263 can receive H.263.
Page 278: Rs331Dialing
API Guide for ViewStation EX, ViewStation FX, and VS4000 rs331dialing Description This command sets or gets RS-366 dialing. Enable this option if you want to call from the system through the DCE connection to the far-site video conferencing system. Disable this option if you are using your DCE to dial the call or if you have a dedicated connection to the far site.
Page 279 User Interface Screen Location System Info > Admin Setup > Video Network > Advanced V.35: RT © Polycom, Inc. Definition Sets the signal to normal (rising edge receives data). Sets the signal to inverted (falling edge receives data).
Page 280: Rts
API Guide for ViewStation EX, ViewStation FX, and VS4000 Description This command sets or gets the rts serial interface control signal (request to send) to normal or inverted. The default setting is “normal” . Syntax rts <normal|inverted|get> Parameter normal inverted...
Page 281 User Interface Screen Location System Info > Admin Setup > Video Network > Advanced V.35: ST © Polycom, Inc. Definition Sets the signal to normal (falling edge sends data). Sets the signal to inverted (rising edge sends data).
Page 282: V35Broadcastmode
API Guide for ViewStation EX, ViewStation FX, and VS4000 v35broadcastmode Description This command sets or gets H.331 broadcast mode for transmissions via satellite. Syntax v35broadcastmode <on|off|get> Parameter Example v35broadcastmode on User Interface Screen Location System Info > Admin Setup > Video Network > Video Network:...
Page 283: V35Debug
This command enables or disables debug tracing for a V.35/RS-449/RS-530 device (0 through 3). Syntax v35debug <0..3> <on|off> Parameter {0..3} Example v35debug 1 on © Polycom, Inc. Definition Range of V.35/RS-449/RS-530 devices. Enables V.35/RS-449/RS-530 debug tracing. Disables V.35/RS-449/RS-530 debug tracing. V.35/RS-449/RS-530 Commands...
Page 284: V35Dialingprotocol
API Guide for ViewStation EX, ViewStation FX, and VS4000 v35dialingprotocol Description This command selects the dialing protocol. Selecting a dialing protocol is not needed if you are using your DCE to dial the call or if you have a dedicated connection to the far site.
Page 285: V35Num
“v35 number” Example v35num set 1b1 5125551212 User Interface Screen Location System Info > Admin Setup > Video Network > Numbers © Polycom, Inc. isdnnum (see page 242). Definition Sets the ISDN video number for a B channel line when followed by a “v35 number”...
Page 286: V35Portsused
API Guide for ViewStation EX, ViewStation FX, and VS4000 v35portsused Description This command selects the number of ports to use on the V.35/RS-449/RS-530 network interface module. Syntax v35portsused <1|1+2|get> Parameter Example v35portsused 1+2 User Interface Screen Location System Info > Admin Setup > Video Network > Video Network: V.35 Ports Used...
Page 287: V35Prefix
" speed “valid speed” “value” Note The ViewStation EX system supports speeds up to 768 Kbps. Example v35prefix set 112 ”#005” This command associates the dialing prefix 005 to the speed 112. User Interface Screen Location System Info > Admin Setup > Video Network > Video Network >...
Page 288: V35Profile
API Guide for ViewStation EX, ViewStation FX, and VS4000 v35profile Description This command sets or gets a profile associated with dialing through a DCE. It can also display all the settings (speed, prefix or suffix) of the current profile. Syntax v35profile <“available profile”|get|view>...
Page 289 The second column lists the suffixes associated with each speed. 2x56 2x64 7x64 User Interface Screen Location System Info > Admin Setup > Video Network > Video Network > Advanced Dialing © Polycom, Inc. #3#0 #4#0 #3#0 #3#2 #4#0 #4#2 #3#3...
Page 290: V35Suffix
<"valid speed"> Parameter “valid speed” “value” Note The ViewStation EX system supports speeds up to 768 Kbps. Example v35suffix set 128 ”#4#2” This command associates the dialing suffix #4#2 to the speed 128. User Interface Screen Location System Info > Admin Setup > Video Network > Video Network >...
Page 291: Appendix: Status Display
RS-232 port; if a later session on a Telnet port issues a dial or listen command, then call status is also directed to that Telnet port. © Polycom, Inc.
Page 292: B Channel Status Message Example
API Guide for ViewStation EX, ViewStation FX, and VS4000 B Channel Status Message Example The following output example is for B channel status messages, where: RINGING CONNECTED BONDING COMPLETE Example: ->dial man 384 5551212 ISDN Dialing manual Dialing 5551212 384 none ISDN...
Page 294 API Guide for ViewStation EX, ViewStation FX, and VS4000 cs: call[0] chan[4] dialstr[8005551212] state[RINGING] cs: call[0] chan[5] dialstr[8005551212] state[RINGING] cs: call[0] chan[4] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[5] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[7] dialstr[8005551212] state[RINGING] cs: call[0] chan[7] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[1] dialstr[8005551212] state[BONDING]...
Page 295: Safety And Legal Notices
2) remove any product. Warranty Polycom, Inc. warrants its products to be free of defects in materials and factory workmanship for a period of twelve (12) months from date of purchase. This warranty does not apply to damage to products resulting from accident, misuse, service or modification by anyone other than a Polycom, Inc.
Page 296: Limitation Of Remedies And Damages
This equipment may not be used on a coin service or party line. If you experience trouble with your ViewStation EX/FX/VS4000, disconnect it from the telephone line to determine if the registered equipment is malfunctioning. For repair or warranty information, please contact Polycom Inc. at 1-888-248-4143 or 4750 Willow Road, Pleasanton, CA 94588-2708, USA.
Page 297: Eea Regulatory Notices
CE Mark This ViewStation EX/FX/VS4000 has been marked with the CE mark. This mark indicates compliance with EEC Directives 1999/5/EC. A full copy of the Declaration of Conformity can be obtained from Polycom Ltd., 270 Bath Road, Slough UK SL1 4DX.
Page 298 Par la présente, Polycom Ltd. déclare que ce ViewStation EX/FX/VS4000 est conforme aux conditions essentielles et à toute autre modalité pertinente de la Directive 1999/5/CE. Dichiarazione di conformità: Con la presente Polycom Ltd. dichiara che il ViewStation EX/FX/VS4000 soddisfa i requisiti essenziali e le altre disposizioni pertinenti della direttiva 1999/5/CE. Verklaring van overeenstemming: Hierbij verklaart Polycom Ltd.
Page 299 The system is intended to be powered only by the supplied power supply unit. Special Safety Instructions Follow existing safety instructions and observe all safeguards as directed. Installation Instructions Installation must be performed in accordance with all relevant national wiring rules. © Polycom, Inc.
Page 300 API Guide for ViewStation EX, ViewStation FX, and VS4000 www.polycom.com/videodocumentation...

This manual is also suitable for:

Viewstation fx Vs4000

Polycom ViewStation EX Api Manual

Introduction

System Commands

ISDN Commands

V.35/Rs-449/Rs

Commands

Appendix: Status Display

Quick Links

Need help?

Questions and answers

Related Manuals for Polycom ViewStation EX

Summary of Contents for Polycom ViewStation EX