Manuals / Polycom / Home Audio / Speaker System

Polycom VIEWSTATION EX manual ViewStation EX, ViewStation FX, and VS4000 API Guide, Polycom, Inc

Models: VIEWSTATION EX

1 224

Page 9

ViewStation EX, ViewStation FX,

and VS4000 API Guide

This document describes the CGI-based ViewStation EX, ViewStation FX, and VS4000 API (Application Programming Interface).

This API is a set of commands implemented within the shell. The commands are available for advanced users who want to automate 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.

It is presumed that users are familiar with Web programming, specifically the CGI POST command and its use from the application programming language of their choice.

Page 9

Image 9

Polycom VIEWSTATION EX manual ViewStation EX, ViewStation FX, and VS4000 API Guide, Polycom, Inc

Contents

FX, and VS4000 API Guide ViewStation EX, ViewStationVS4000 User’s Guide April 2003 Edition Release 1725-10656-004Patent Information Trademark InformationContents callstate gatewayprefix nearloop streammulticastip isdnareacode ViewStation EX, ViewStation FX and VS4000 API GuidePolycom, Inc. button near command What’s New in Release 5.0?Command CommandUsing Telnet Accessing the API InterfaceUsing the RS-232Interface Connecting the Serial CableViewStation EX and ViewStation FX Starting a Communications SessionRS-232User Interface Screen RS-232Interface InformationBaud Rate RS-232ModesPage Near-SideMode Flow ControlFar-SideMode Resulting OperationFunction Pin NumberPin Number RS-232Serial Cable Pinout and Connections VS4000Function Polycom, Inc.Status Display Using the “listen” or “dial” CommandB Channel Status Message Example ExamplePolycom, Inc. Page Example Syntax SummaryExample ExampleExample About the “get” SubcommandResponse Example<“str”|1..64> System CommandsDescription ExampleSubcommands abk <batch|all|letter|range>abk batch <0..59> adminpassword <set|get> password adminpasswordabk all abk letter <a..z> abk range <a..b> ExamplesUser Interface Screen Location advnetstatsadvnetstats advnetstatsExamples Sample Outputallowabkchanges <yes|no|get> allowabkchangesEnables the Allow Address Book Changes option Disables the Allow Address Book Changes optionallowmixedcalls allowdialingallowdialing <yes|no|get> allowmixedcalls <yes|no|get>allowusersetup <yes|no|get> allowusersetupallowremotemon allowremotemon <get>audioquality answeranswer <phone|video> audioquality <set|get>audioqualityg7221 <set|get> audioqualityg7221audioqualityg7221 get Exampleautoanswer <yes|no|donotdisturb|get> autoanswerExample User Interface Screen Locationautoh323dialing autodiscovernatautodiscovernat <yes|no|get> autoh323dialing <yes|no|get>backlightcompensation <yes|no|get> backlightcompensationDisplays the current setting yes or no ExampleDescription buttonvolume+ presetvolume deletecallpreference <h320|h323|both|get> callpreferenceExample Examplecallstate <register|unregister|get> callstateOutput to Example Descriptioncamera <near|far|register|unregister> cameracamera <near|far> stop Subcommandsnear move continuous near tracking to_presetsnear move discrete near <setposition|getposition> <x> <y> <z>far tracking to_presets far subcommandsregister unregister subcommand Camera sourcecamera1ptz <yes|no|get> camera1ptzExample Examplecameradirection camera4ptzcamera4ptz <yes|no|get> cameradirection <normal|reversed|get>camerainput <1|2|3|4> <off|s-video|composite|get> camerainputExample User Interface Screen LocationSubcommands chaircontrolExample Exampleset_password <“ string> Requests voice activated switchingExample req_term_name <term_no>country colorbarcolorbar <on|off> country <set|get> <algeria..zimbabwe>dataconferencetype <off|netmeeting|t120| get> dataconferencetypeExamples User Interface Screen Locationdefaultgateway <set|get> defaultgatewaydefaultgateway get daylightsavingsdhcp <off|client|server|get> dhcpExample User Interface Screen Locationdial <addressbook|auto|manual|phone> dialdial phone <dialstring> User Interface Screen Locationdialchannels <parallel|oneatatime|get> dialchannelsExamples Descriptiondiffserv <set|get><0..63> diffservdiffserv set <0..63> diffserv get dir stringdisplay whoami display calldisplay call Output SampleOuput displayboltdisplaybolt dd Descriptiondisplaygraphics displayglobaladdressesdisplayglobaladdresses <yes|no|get> displaygraphics <yes|no|get>displayipisdninfo displayipextdisplayipext <yes|no|get> Enables the display of the IP extensiondisplayparams displayparamsOutput partial Displays the current setting yes or nodns get <1..4> dns <set|get> <1..4>xxx.xxx.xxx.xxxdynamicbandwidth <yes|no|get> dynamicbandwidthEnables the option Descriptione164ext <set|get> e.164name e164exte164ext get Disables the optionechocanceller <yes|no|get> echocancellerResponse User Interface Screen Locationenablesnmp enablesnapshotsenablesnmp <yes|no|get> enablesnmp <yes|no|get>farcontrolnearcamera exitexit farcontrolnearcamera <yes|no|get>farnametimedisplay farloopfarloop <on|off> farnametimedisplay <set|get>gabpassword <set|get> password gabpasswordgabk batch gabk batch <0..59>gabserverip <set|get> gabserveripgabserverip set xxx.xxx.xxx.xxx gabserverip set gabserverip getgatekeeperip <set|get> gatekeeperipgatekeeperip get User Interface Screen Locationgatewayareacode <set|get> areacode gatewayareacodeSets the area code when followed by the areacode Displays the current setting for this optiongatewaycountrycode <set|get> number gatewaycountrycodeDescription Examplegatewayext <set|get> gateway extension gatewayextgatewayext set gateway extension gatewayext set gatewayext getgatewaynumber <set|get> number gatewaynumberDescription Examplegatewaynumbertype <did|number+extension|get> gatewaynumbertypeDisplays the current setting did or Descriptiongatewayprefix <set|get><valid speed> value gatewayprefixDescription set <“valid speed”>gatewaysetup gatewaysetupOutput Examplegatewaysuffix <set|get><valid speed> value gatewaysuffixDescription set <“valid speed”>generatetone gendialgendial 0..9|#| generatetone <on|off>gmscity get screenget screen Output Examplegmscontactemail <set|get> email gmscontactemailExample User Interface Screen Locationgmscontactfax <set|get> fax gmscontactfaxDescription Examplegmscontactnumber <set|get> number gmscontactnumberDescription Examplegmscontactperson <set|get> person gmscontactpersonDescription Examplegmscountry get gmscountryDescription Examplegmsstate get gmsstateDescription Examplegmstechsupport <set|get> tech support digits gmstechsupportgmstechsupport get Descriptiongmsurl get <1..10> gmsurlDescription Examplegraphicsmonitor <tv|fxvga|visualconcert|get> graphicsmonitorcommand graphicsmonitor fxvga is similar to command graphicsmonitor visualconcert isgraphicsmonitortv graphicsmonitorfxvgagraphicsmonitorfxvga <on|off|get> graphicsmonitortv <on|off|get>graphicsmonitorvisualconcert <on|off|get> graphicsmonitorvisualconcertDisables the TV monitor as the graphics monitor Displays the current setting on or offh323name <set|get> H.323name h323nameh323name get Descriptionhelp hanguphangup <phone|video> hangup phone hangup video 1..3 hangup videoExample Output to Example 1 partialhelp verboseOutput to Example 2 partial hireshires <2|3> <yes|no|get> Descriptionhistory historyOutput to Example User Interface Screen Locationhostname <set|get> hostname hostnamehostname set hostname hostname set hostname get Descriptionipaddress <set|get> ipaddressipaddress set xxx.xxx.xxx.xxx ipaddress set ipaddress getipdialspeed <set|get><valid speed><on|off> ipdialspeedExample User Interface Screen Locationipprecedence <set|get> <0..5> ipprecedenceipprecedence set <0..5> ipprecedence get Displays the current settingipstat ipstatDescription Output to Examplelanguage keypadaudioconfkeypadaudioconf <yes|no|get> language getSets the command. It requires a parameter from lanportDisplays the current setting Examplelanstat lanstat <min|misc|reset|sec|tmin|total>lanstat min lanstat tmin lanstat tmin 0..60 lanstat totalOutput to Example ExampleOutput to Example lanstat minlisten <phone|video|sleep> listenDescription Examplemaxgabinternationalcallspeed get maxgabinternationalcallspeedDescription Examplemaxgabinternetcallspeed <set|get> <valid speed> maxgabinternetcallspeedmaxgabinternetcallspeed get Descriptionmaxgabisdncallspeed <set|get> <valid speed> maxgabisdncallspeedmaxgabisdncallspeed get Descriptionmaxtimeincall <set|get> maxtimeincallDescription Examplemcupassword password mcupasswordmcupassword Descriptionmeetingpassword <set|get> password meetingpasswordpassword Descriptionmpautoanswer <yes|no|donotdisturb|get> mpautoanswerDescription ExampleDisplays the current setting for this option mpmodeUser Interface Screen Location Descriptionmute <near|far|register|unregister> mutemute near <on|off|toggle|get> mute far get mute register mute unregisternearloop muteautoanswercallsmuteautoanswercalls <yes|no|get> nearloop <on|off>netmeetingip <set|get> netmeetingipnetmeetingip get Disables the Near End Loopnetstats netstatsnetstats Descriptionnumdigitsdid <0..24|get> numdigitsdidnumdigitsdid <0..24> numdigitsdid get User Interface Screen Locationnumdigitsext <0..24|get> numdigitsextnumdigitsext <0..24> numdigitsext get Displays the current settingoutboundcallroute numberofmonitorsnumberofmonitors <1..4|get> numberofmonitors <1..4> numberofmonitors getpcport pausepause <0..65535> Exampleping <ip_addr> count pingDisplays the current setting Examplepreferredalias switchnumber|didextnumber|extension|get>pip <on|off|auto|get> preferredalias<isdnnumber|fulldidnumber|preset <near|far|register|unregister> presetpreset unregister switchnumberprimarycallchoice <isdn|ip|manual|get> primarycallchoiceExample Descriptionprimarycamera <1|2|3|4|get> primarycameraDisplays the current setting isdn, ip, or manual Displays the current setting 1, 2, 3, orqueuecommands <yes|no|get> queuecommandsregisterthissystem registerthissystem <yes|no|get>repeat <1..64> repeatEnables this option register this system Disables this optionrequireacctnumtodial <yes|no|get> requireacctnumtodialEnables the option Disables the optionroomphonenumber <set|get> room phone number roomphonenumberDescription Examplers232<mode|flowcontrol|baud|> rs232Subcommands Descriptionrun <scriptfilename> screenUser Interface Screen Location Descriptionsecondarycallchoice <isdn|ip|none|get> secondarycallchoicedisableui enableuiserialnum sendonlypreferredaliassendonlypreferredalias <yes|no|get> serialnumshowaddrsingab setaccountnumbersetaccountnumber <account number> showaddrsingab <h320|h323|both|get>showpopup <text to display> showpopupDisplays the current setting h320, h323, or both Exampleslides sleepsleep slides select <pres>snapshot <0|1|2|3|4|register|unregister> snapshotpassword Examplesnapshotcamera <1|2|3|4|get> snapshotcameraDisplays the current setting 1, 2, 3, or Examplesnapshottimeout <yes|no|get> snapshottimeoutDescription Examplesnmpadmin <set|get> admin name snmpadminsnmpadmin set admin_name snmpadmin set snmpadmin getsnmpcommunity <set|get> community name snmpcommunityDescription Examplesnmplocation snmpconsoleipsnmpconsoleip <set|get> snmpconsoleip getsoundeffectsvolume <set|get|test> <0..10> soundeffectsvolumeExample User Interface Screen Locationstream stdoutstdout <on|off> stream <start|stop>streamannounce <yes|no|get> streamannounceEnables streaming announcement Disables streaming announcementstreamaudioport <set|get> stream audio port streamaudioportstreamaudioport get setting, omit the parameterstreamenable <yes|no|get> streamenablestreammulticastip streammulticastip <set|get> ip addressstreamrestoredefaults streamrestoredefaultsDisplays the current setting Examplestreamrouterhops <set|get> number router hops streamrouterhopsstreamrouterhops get Descriptionstreamvideoport streamspeedstreamspeed <192|256|384|512|get> streamvideoport <set|get> video portsubnetmask <set|get> subnetmasksubnetmask get Displays the current settingsystembehindnat <yes|no|get> systembehindnatDescription Examplesystemname <set|get> system name systemnamesystemname set system name systemname get Descriptiont120nameip <set|get> name or ip t120nameipDescription Exampletechsupport tcpportstcpports <set|get> tcpports getteleareacode <set|get> telephone area code teleareacodeteleareacode get Exampletelecountrycode <set|get> telephone country code telecountrycodetelecountrycode get Exampletelenumber <set|get> telephone number telenumbertelenumber set telephone number telenumber set telenumber gettestlan dcuinfo testlan arptestlan arp testlan dcuinfotestlan echo testlan dnstestlan dns <name or ip> testlan echo <ip_addr>Output to Example ExampleExample Output to Exampletestlan ping <ip_addr>count testlan pingtestlan ping <ip_addr> Descriptiontimediffgmt textinputtextinput <text to input> timediffgmt <-12:00..+00:00..+12:00|get>typeofservice <ipprecedence|diffserv|get> typeofserviceudpports udpports <set|get>usefixedports <yes|no|get> usefixedportsEnables the use of Used Fixed Ports Disables the use of Used Fixed Portsusegatekeeper <off|specify|auto|get> usegatekeeperDescription Exampleusepathnavigator <always|never|required| get> usepathnavigatorDescription ExamplePolycom, Inc. User Interface Screen Locationvcbutton validateacctnumvalidateacctnum <yes|no|get> vcbutton <play|stop|get|register|unregister>vcraudioout <yes|no|get> vcraudiooutExample Descriptionversion vcrrecordsourcevcrrecordsource <auto|near|far|get> versionvgahorizpos vgaoffmode <black|nosignal|get>vgaoffmode vgahorizpos <left|right|get>vgaphase <increase|decrease|get> vgaphaseDisplays the current setting black or nosignal Increases the phasevgaresolution <800x600|1024x768| 1280x1024|get> vgaresolutionvgavertpos vgavertpos <up|down|get>volume <set|up|down|get|register| unregister> volumevolume set <0..24> Displays the current setting up or downwaitfor <callcomplete|systemready| receivingcall> waitforUser Interface Screen Location Descriptionwanipaddress wakewake wanipaddress <set|get>widescreenvideo whoamiwhoami widescreenvideo <yes|no|get>winsresolution <yes|no|get> winsresolutionEnables WINS resolution Disables WINS resolutionwinsserver <set|get> winsserverwinsserver get Descriptionisdnareacode ISDN BRI Commandsisdnareacode <set|get> area code Sets the ISDN area code when followed by the areaisdncountrycode <set|get> country code isdncountrycodeDescription Exampleisdndialingprefix <set|get> isdn prefix isdndialingprefixDescription Exampleisdndialspeed <set|get> <valid speed> <on|off> isdndialspeedEnables the specified speed valid speed Disables the specified speed valid speedDescription isdnnumExample User Interface Screen LocationDescription spidnumExample User Interface Screen Locationpriareacode ISDN PRI Commandspriareacode <set|get> area code Displays the current settingpricallbycall <set|get> pricallbycallDescription Exampleprichannel <set|get> <all|1..<23|30>> <on|off> prichannelDescription ExampleExample Important PRI Channel InformationExample User Interface Screen Locationpricsu <internal|external|get> pricsuSets the internal CSU mode. This is the default command on pagepridialchannels <set|get> <1..12|15> pridialchannelsDescription Examplepriintlprefix <set|get> prefix priintlprefixDescription Exampleprilinebuildout set <0|-7.5|-15|-22.5> prilinebuildoutprilinebuildout get Displays the current settingprilinesignal <set|get><esf/b8zs|crc4/hdb3| hdb3> prilinesignalDescription Exampleprinumber <set|get> pri number prinumberprinumber set pri number prinumber set prinumber getprinumberingplan <isdn|unknown|get> prinumberingplanDescription Exampleprioutsideline <set|get> outside_line prioutsidelineDescription Examplepriswitch get priswitchDescription Examplects <normal|inverted|get> V.35/RS-449/RS-530/RS-366Commandsdcd <normal|inverted|get> Sets the signal to normal high voltage is logicdcdfilter <on|off|get> dcdfilterSets the signal to inverted low voltage is logic Displays the current setting normal or inverteddsr <normal|inverted|get> dsranswerdsranswer <on|off|get> Sets the signal to normal high voltage is logicExample dtr <normal|inverted|on|get>User Interface Screen Location DescriptionDescription h331audiomodeg728 g711uh331framerate <30|15|10|7.5|get> h331framerateDisplays the current setting for this option User Interface Screen Locationh331videoformat h331videoprotocolh331videoprotocol <h263|h261|get> h331videoformat <fcif|get>rs366dialing on off get rs366dialingExample User Interface Screen Locationrts <normal|inverted|get> rt <normal|inverted|get>Sets the signal to normal high voltage is logic Sets the signal to inverted low voltage is logicSets the signal to normal falling edge sends data st <normal|inverted|get>Example User Interface Screen Locationv35debug v35broadcastmodev35broadcastmode <on|off|get> v35debug <0..3> <on|off>v35num v35dialingprotocolv35dialingprotocol <rs366|get> v35num <set|get> <1b1|1b2> v35 numberv35portsused <1|1+2|get> v35portsusedExample User Interface Screen Locationv35prefix <set|get> <valid speed> value v35prefixExample User Interface Screen LocationExample v35profileUser Interface Screen Location DescriptionExample ExampleOutput to Example User Interface Screen Locationv35suffix <set|get> <valid speed> value v35suffixDescription set <valid speed>Example User Interface Screen Locationv35suffix set 128 ”#4#2” Important Safeguards License RestrictionsSafety and Legal Notices Limitation of Remedies and Damages WarrantyUSA and Canadian Regulatory Notices FCC NoticeSafety and Legal Notices Part 68 FCC Rules CE Mark EEA Regulatory NoticesDeclaration of Conformity KonformitetserklæringVerklaring van overeenstemming Dichiarazione di conformitàDeclaração de Conformidade Declaración de conformidadSpecial Safety Instructions Installation InstructionsUnderwriters Laboratories Statement