Specifications
Table Of Contents
- About This Guide
- Contents
- Room Integration
- Setting Up a Room for Video Conferencing
- Integrating Video
- Connecting Polycom Cameras
- Polycom EagleEye HD Camera as the Main Camera up to 30 ft Away
- Polycom EagleEye HD Camera as the Second Camera up to 30 ft Away
- Polycom EagleEye HD Camera as the Main or Second Camera up to 100 ft Away
- Polycom EagleEye 1080 or Sony EVI-HD1 PTZ as the Main or Second Camera
- PowerCam as the Main Camera up to 10 ft Away
- PowerCam as the Second Camera
- PowerCam Plus as the Main Camera up to 10 ft Away
- PowerCam Plus as the Second Camera up to 10 ft Away
- Connecting Sony and ELMO Cameras
- Connecting Vaddio and Canon Cameras
- Connecting Polycom Cameras
- Integrating Audio and Content
- Cables
- Network Cables
- Video and Camera Cables
- S-Video Cable
- BNC to S-Video Cable
- BNC to S-Video Adapter
- DVI to VGA Monitor Cable
- HDMI Monitor Cable
- BNC Monitor Adapter Cable
- Polycom HDX Component Monitor Cable
- HDX Component Video Cable
- DVI-D Monitor Cable
- Component A/V Monitor Cable
- HDCI Analog Camera Cable
- HDCI Digital Camera Cable
- HDCI Camera Break-Out Cable
- VCR/DVD Composite Cable
- Composite Video Cable
- PowerCam Plus Primary Cable
- HDCI PowerCam Cable
- HDCI PowerCam Plus Adapter Cable
- HDCI VISCA Adapter Cable
- HDCI Polycom EagleEye 1080 Camera Cable
- HDCI Polycom EagleEye View Camera Cable
- HDCI Sony VISCA Adapter Cable
- HDCI EagleEye 1080 or Sony Adapter Cable
- PowerCam Primary Camera Cable
- PowerCam Break-Out Cable
- PowerCam Plus/VISCA Control Cable
- Audio Cables
- Serial Cables
- Straight-Through Serial Cable
- Using the API
- System Commands
- About the API Commands
- !
- abk (deprecated)
- addrbook
- addressdisplayedingab
- advnetstats
- alertusertone
- alertvideotone
- all register
- all unregister
- allowabkchanges
- allowcamerapresetssetup
- allowdialing
- allowmixedcalls
- allowusersetup
- amxdd
- answer
- areacode
- audiometer
- audiotransmitlevel
- autoanswer
- autoshowcontent
- backlightcompensation
- basicmode
- bri1enable, bri2enable, bri3enable, bri4enable
- briallenable
- button
- calendardomain
- calendarmeetings
- calendarpassword
- calendarplaytone
- calendarregisterwithserver
- calendarremindertime
- calendarresource
- calendarserver
- calendarshowpvtmeetings
- calendarstatus
- calendaruser
- calldetail
- calldetailreport
- callencryption (deprecated)
- callinfo
- callstate
- callstats
- camera
- cameradirection
- camerainput
- chaircontrol
- cmdecho
- colorbar
- configchange (deprecated)
- configdisplay
- configparam
- configpresentation
- confirmdiradd
- confirmdirdel
- contentauto
- contentsplash
- country
- cts
- daylightsavings
- dcd
- dcdfilter
- defaultgateway
- dhcp
- dial
- dialchannels
- dialingdisplay
- diffservaudio, diffservfecc, diffservvideo
- directory
- display (deprecated)
- displayglobaladdresses
- displaygraphics
- displayipext
- displayipisdninfo (deprecated)
- displayparams
- dns
- dsr
- dsranswer
- dtr
- dualmonitor
- dynamicbandwidth
- e164ext
- echo
- echocanceller
- enablefirewalltraversal
- enablekeyboardnoisereduction
- enablelivemusicmode
- enablepvec
- enablersvp
- enablesnmp
- encryption
- exit
- exportdirectory
- farcontrolnearcamera
- farnametimedisplay
- flash
- gabk (deprecated)
- gabpassword
- gabserverip
- gaddrbook
- gatekeeperip
- gatewayareacode
- gatewaycountrycode
- gatewayext
- gatewaynumber
- gatewaynumbertype
- gatewayprefix
- gatewaysetup
- gatewaysuffix
- gdsdirectory
- gendial
- gendialtonepots (deprecated)
- generatetone
- get screen
- getcallstate
- getconfiguredipaddress
- gmscity
- gmscontactemail
- gmscontactfax
- gmscontactnumber
- gmscontactperson
- gmscountry
- gmsstate
- gmstechsupport
- gmsurl
- h239enable
- h323name
- h331audiomode
- h331dualstream
- h331framerate
- h331videoformat
- h331videoprotocol
- hangup
- history
- homecallquality
- homemultipoint (deprecated)
- homerecentcalls
- homesystem
- homesystemname
- hostname
- importdirectory
- ipaddress
- ipdialspeed
- ipisdninfo
- ipprecaudio, ipprecfecc, ipprecvideo
- ipstat
- isdnareacode
- isdncountrycode
- isdndialingprefix
- isdndialspeed
- isdnnum
- isdnswitch
- keypadaudioconf
- language
- lanport
- ldapauthenticationtype
- ldapbasedn
- ldapbinddn
- ldapdirectory
- ldapntlmdomain
- ldappassword
- ldapserveraddress
- ldapserverport
- ldapsslenabled
- ldapusername
- linestate
- listen
- localdatetime
- marqueedisplaytext
- maxgabinternationalcallspeed
- maxgabinternetcallspeed
- maxgabisdncallspeed
- maxtimeincall
- mcupassword
- meetingpassword
- monitor1 (deprecated)
- monitor1screensaveroutput
- monitor2 (deprecated)
- monitor2screensaveroutput
- mpautoanswer
- mpmode
- mtumode
- mtusize
- mute
- muteautoanswer
- natconfig
- nath323compatible
- nearloop
- netstats
- nonotify
- notify
- ntpmode
- ntpserver
- numberofmonitors (deprecated)
- numdigitsdid
- numdigitsext
- ocsdirectory
- oobcomplete
- pause
- phone
- pip
- popupinfo
- preset
- pricallbycall
- prichannel
- pricsu
- pridialchannels
- priintlprefix
- prilinebuildout
- prilinesignal
- primarycallchoice (deprecated)
- prinumberingplan
- prioutsideline
- priswitch
- reboot
- recentcalls
- registerall (deprecated)
- registerthissystem
- remotecontrol
- remotemonenable
- requireacctnumtodial
- resetsystem
- roomphonenumber
- rs232 baud, rs232port1 baud
- rs232 mode, rs232port1 mode
- rs366dialing
- rt
- rts
- screen
- screencontrol
- secondarycallchoice (deprecated)
- serialnum
- session
- setaccountnumber
- setpassword
- showpopup
- sleep
- sleeptext
- sleeptime
- snmpadmin
- snmpcommunity
- snmpconsoleip
- snmplocation
- snmpsystemdescription
- snmptrapversion
- soundeffectsvolume
- spidnum
- st
- subnetmask
- sysinfo
- systemname
- tcpports
- techsupport
- teleareacode
- telenumber
- telnetechoeol
- timediffgmt
- typeofservice
- udpports
- unregisterall (deprecated)
- usefixedports
- usegatekeeper
- usepathnavigator
- useroompassword
- v35broadcastmode
- v35dialingprotocol
- v35num
- v35portsused
- v35prefix
- v35profile
- v35suffix
- validateacctnum
- vcbutton
- vcraudioout
- vcrrecordsource
- version
- vgaqualitypreference
- videocallorder
- voicecallorder
- volume
- vortex
- waitfor
- wake
- wanipaddress
- webmonitoring
- webport
- whoami
- Room Design and Layout
- Status Messages
- Polycom HDX 9000 Series Specifications
- Index

System Commands
Polycom, Inc. 4–3
controlled by a provisioning service and cannot be changed”. For
more information about provisioned settings, refer to your
provisioning service administrator.
Deprecated commands are included for backward compatibility only and are
not recommended for use with this version. Suitable replacements are noted
for each deprecated command.
Command Response Syntax
When you send a command, the system returns responses using the following
syntax, where <CR> indicates a carriage return and <LF> indicates a line feed.
When Not Registered To Receive Notifications
When your system is not registered to receive any notifications and you send
an API command, an API echo and API acknowledgement are returned.
For example:
• camera near 2 <CR>API command
returns
camera near 2<LF><CR>API echo
camera near 2<CR><LF>API acknowledgement
When your system is not registered for notifications, always use the API
acknowledgement (<CR><LF>), which indicates that the command was sent,
accepted, and processed. Never use the API echo (<LF><CR>), which only
indicates that you sent an API command but does not indicate whether the API
command you sent was actually processed. For example, you receive an API
echo even if you send an invalid API command. In this case, the API echo
responds by echoing the invalid API command that you attempted to send.
When Registered To Receive Notifications
Registering for notifications adds extra line responses in the form of API
registration responses. When your system is already registered to receive
notifications and you send an API command that affects a notification, an API
echo, API acknowledgement, and API registration response are returned. You
API support is not available for:
• Telnet ports 23 and 24 when Security Mode is enabled.
• Software versions for the Joint Interoperability Test Command
(JITC)certification
The end of line (EOL) character for the echo is different for serial and LAN
responses. The feedback examples below and elsewhere in the Integrator’s
Reference Manual are based on the serial response.