ViewStation® EX, ViewStation FX, and VS4000 API Guide VS4000 User's Guide April 2003 Edition Release 5.0 1725-10656-004 Trademark Information Polycom®, the Polycom logo design, and ViewStation® are registered trademarks of Polycom Inc. ARENATM, Global Management SystemTM, PathNavigatorTM, Polycom OneDialTM, and Visual ConcertTM are trademarks of Polycom, Inc. in the United States and various other countries. Internet ExplorerTM, NetMeeting®, Windows®, and Windows NT® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Intel®, Pentium®, and Celeron® are registered trademarks and TeamStationTM is a trademark of Intel Corporation. Adobe® Acrobat® is a registered trademark of Adobe Systems Incorporated. ADTRAN® is a registered trademark of ADTRAN, Inc. QuickTimeTM is a trademark of Apple Computer, Inc. Netscape® Navigator® is a registered trademark of Netscape Communications Corporation. IP/TV® is a registered trademark of Cisco Systems, Inc. All other trademarks are the property of their respective owners. Every effort has been made to ensure that the information in this manual is accurate. Polycom, Inc. is not responsible for printing or clerical errors. Information in this document is subject to change without notice. Patent Information The accompanying product is protected by one or more U.S. and foreign patents and patents pending held by Polycom, Inc. © 2003 Polycom, Inc. All rights reserved. Polycom Inc. 4750 Willow Road Pleasanton, CA 94588-2708 USA No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Polycom, Inc. Under the law, reproducing includes translating into another language or format. 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. Therefore, you must treat the software like any other copyrighted material (e.g. a book or sound recording). Every effort has been made to ensure that the information in this manual is accurate. Polycom, Inc. is not Contents Contents........................................................................................................... i What's New in Release 5.0? ............................................................................ 2 Accessing the API Interface ............................................................................. 3 Using Telnet ........................................................................................ 3 Using the RS-232 Interface................................................................. 3 Connecting the Serial Cable .................................................. 3 Starting a Communications Session ...................................... 4 RS-232 Interface Information ........................................................................... 5 RS-232 User Interface Screen ............................................................ 5 Baud Rate ........................................................................................... 5 RS-232 Modes .................................................................................... 5 Flow Control ........................................................................................ 7 RS-232 Serial Cable Pinout and Connections (ViewStation EX and FX)8 RS-232 Serial Cable Pinout and Connections (VS4000) .................... 9 Status Display .................................................................................................. 10 Using the "listen" or "dial" Command .................................................. 10 B Channel Status Message Example.................................................. 10 Syntax Summary.............................................................................................. 13 About the "get" Subcommand .......................................................................... 14 System Commands.......................................................................................... 15 ! ........................................................................................................... 15 abk ...................................................................................................... 16 adminpassword ................................................................................... 17 advnetstats.......................................................................................... 18 allowabkchanges................................................................................. 20 allowdialing.......................................................................................... 21 allowmixedcalls ................................................................................... 21 allowremotemon.................................................................................. 22 allowusersetup .................................................................................... 22 answer................................................................................................. 23 audioquality ......................................................................................... 23 audioqualityg7221 ............................................................................... 24 autoanswer.......................................................................................... 25 autodiscovernat................................................................................... 26 autoh323dialing................................................................................... 26 backlightcompensation........................................................................ 27 button .................................................................................................. 28 callpreference...................................................................................... 30 © Polycom, Inc. 2003 i ViewStation EX, ViewStation FX, and VS4000 API Guide callstate ............................................................................................... 31 camera ................................................................................................ 32 camera1ptz.......................................................................................... 35 camera4ptz.......................................................................................... 36 cameradirection................................................................................... 36 camerainput......................................................................................... 37 chaircontrol.......................................................................................... 38 colorbar ............................................................................................... 40 country................................................................................................. 40 dataconferencetype............................................................................. 41 daylightsavings.................................................................................... 42 defaultgateway .................................................................................... 42 dhcp..................................................................................................... 43 dial....................................................................................................... 44 dialchannels ........................................................................................ 45 diffserv................................................................................................. 46 dir ........................................................................................................ 46 display call........................................................................................... 47 display whoami.................................................................................... 47 displaybolt ........................................................................................... 48 displayglobaladdresses ....................................................................... 49 displaygraphics.................................................................................... 49 displayipext.......................................................................................... 50 displayipisdninfo .................................................................................. 50 displayparams ..................................................................................... 51 dns....................................................................................................... 52 dynamicbandwidth............................................................................... 53 e164ext................................................................................................ 54 echocanceller ...................................................................................... 55 enablesnapshots ................................................................................. 56 enablesnmp......................................................................................... 56 exit....................................................................................................... 57 farcontrolnearcamera .......................................................................... 57 farloop ................................................................................................. 58 farnametimedisplay ............................................................................. 58 gabk batch........................................................................................... 59 gabpassword ....................................................................................... 59 gabserverip.......................................................................................... 60 gatekeeperip........................................................................................ 61 gatewayareacode ................................................................................ 62 gatewaycountrycode ........................................................................... 63 gatewayext .......................................................................................... 64 gatewaynumber................................................................................... 65 gatewaynumbertype ............................................................................ 66 ii www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide gatewayprefix ...................................................................................... 67 gatewaysetup ...................................................................................... 68 gatewaysuffix ...................................................................................... 69 gendial................................................................................................. 70 generatetone ....................................................................................... 70 get screen ........................................................................................... 71 gmscity ................................................................................................ 71 gmscontactemail ................................................................................. 72 gmscontactfax ..................................................................................... 73 gmscontactnumber.............................................................................. 74 gmscontactperson............................................................................... 75 gmscountry.......................................................................................... 76 gmsstate.............................................................................................. 77 gmstechsupport................................................................................... 78 gmsurl ................................................................................................. 79 graphicsmonitor................................................................................... 80 graphicsmonitorfxvga .......................................................................... 81 graphicsmonitortv................................................................................ 81 graphicsmonitorvisualconcert.............................................................. 82 h323name ........................................................................................... 83 hangup ............................................... ...