Manuals / Polycom / Home Audio / Speaker System

Polycom VIEWSTATION EX callstate <register|unregister|get>, Output to Example, Description

Models: VIEWSTATION EX

1 224

Download 224 pages 61.71 Kb

Page 39

Image 39

ViewStation EX, ViewStation FX, and VS4000 API Guide

callstate

callstate <registerunregisterget>

Description

This command registers the Telnet or RS-232 session to receive notifications about call state activities.

unregister Disables the register mode.

get	Displays the selected call state mode (register or
	unregister).

Example

callstate register

Output to Example

callstate registered

Acknowledgment that the session is now registered to list call state activities.

Sample Output

cs: call[0] chan[0] dialstr[192.168.1.103] state [RINGING]

cs: call[0] chan[0] dialstr[192.168.1.103] state

[CONNECTED]

cs: call[0] chan[0] dialstr[192.168.1.103] state [COMPLETE]

active: call[0] speed[128]

cleared: call[0] line[0] bchan[0] cause[16]

dialstring[192.168.1.103]

ended: call[0]

Page 39

Image 39

Polycom VIEWSTATION EX manual callstate <register|unregister|get>, Output to Example, Description, Sample Output

Contents

April 2003 Edition Release 1725-10656-004 ViewStation EX, ViewStationFX, and VS4000 API Guide VS4000 User’s GuidePatent Information Trademark InformationContents callstate gatewayprefix nearloop streammulticastip isdnareacode ViewStation EX, ViewStation FX and VS4000 API GuidePolycom, Inc. Command What’s New in Release 5.0?button near command CommandConnecting the Serial Cable Accessing the API InterfaceUsing Telnet Using the RS-232InterfaceViewStation EX and ViewStation FX Starting a Communications SessionRS-232Modes RS-232Interface InformationRS-232User Interface Screen Baud RatePage Resulting Operation Flow ControlNear-SideMode Far-SideModeFunction Pin NumberPolycom, Inc. RS-232Serial Cable Pinout and Connections VS4000Pin Number FunctionExample Using the “listen” or “dial” CommandStatus Display B Channel Status Message ExamplePolycom, Inc. Page Example Syntax SummaryExample ExampleExample About the “get” SubcommandExample ResponseExample System Commands<“str”|1..64> DescriptionSubcommands abk <batch|all|letter|range>abk batch <0..59> Examples adminpasswordadminpassword <set|get> password abk all abk letter <a..z> abk range <a..b>advnetstats advnetstatsUser Interface Screen Location advnetstatsExamples Sample OutputDisables the Allow Address Book Changes option allowabkchangesallowabkchanges <yes|no|get> Enables the Allow Address Book Changes optionallowmixedcalls <yes|no|get> allowdialingallowmixedcalls allowdialing <yes|no|get>allowremotemon <get> allowusersetupallowusersetup <yes|no|get> allowremotemonaudioquality <set|get> answeraudioquality answer <phone|video>Example audioqualityg7221audioqualityg7221 <set|get> audioqualityg7221 getUser Interface Screen Location autoanswerautoanswer <yes|no|donotdisturb|get> Exampleautoh323dialing <yes|no|get> autodiscovernatautoh323dialing autodiscovernat <yes|no|get>Example backlightcompensationbacklightcompensation <yes|no|get> Displays the current setting yes or noDescription buttondelete presetvolume+ volumeExample callpreferencecallpreference <h320|h323|both|get> ExampleDescription callstatecallstate <register|unregister|get> Output to ExampleSubcommands cameracamera <near|far|register|unregister> camera <near|far> stopnear <setposition|getposition> <x> <y> <z> near tracking to_presetsnear move continuous near move discreteCamera source far subcommandsfar tracking to_presets register unregister subcommandExample camera1ptzcamera1ptz <yes|no|get> Examplecameradirection <normal|reversed|get> camera4ptzcameradirection camera4ptz <yes|no|get>User Interface Screen Location camerainputcamerainput <1|2|3|4> <off|s-video|composite|get> ExampleExample chaircontrolSubcommands Examplereq_term_name <term_no> Requests voice activated switchingset_password <“ string> Examplecountry <set|get> <algeria..zimbabwe> colorbarcountry colorbar <on|off>User Interface Screen Location dataconferencetypedataconferencetype <off|netmeeting|t120| get> Examplesdaylightsavings defaultgatewaydefaultgateway <set|get> defaultgateway getUser Interface Screen Location dhcpdhcp <off|client|server|get> ExampleUser Interface Screen Location dialdial <addressbook|auto|manual|phone> dial phone <dialstring>Description dialchannelsdialchannels <parallel|oneatatime|get> Examplesdir string diffservdiffserv <set|get><0..63> diffserv set <0..63> diffserv getOutput Sample display calldisplay whoami display callDescription displayboltOuput displaybolt dddisplaygraphics <yes|no|get> displayglobaladdressesdisplaygraphics displayglobaladdresses <yes|no|get>Enables the display of the IP extension displayipextdisplayipisdninfo displayipext <yes|no|get>Displays the current setting yes or no displayparamsdisplayparams Output partialdns get <1..4> dns <set|get> <1..4>xxx.xxx.xxx.xxxDescription dynamicbandwidthdynamicbandwidth <yes|no|get> Enables the optionDisables the option e164exte164ext <set|get> e.164name e164ext getUser Interface Screen Location echocancellerechocanceller <yes|no|get> Responseenablesnmp <yes|no|get> enablesnapshotsenablesnmp enablesnmp <yes|no|get>farcontrolnearcamera <yes|no|get> exitfarcontrolnearcamera exitfarnametimedisplay <set|get> farloopfarnametimedisplay farloop <on|off>gabk batch <0..59> gabpasswordgabpassword <set|get> password gabk batchgabserverip get gabserveripgabserverip <set|get> gabserverip set xxx.xxx.xxx.xxx gabserverip setUser Interface Screen Location gatekeeperipgatekeeperip <set|get> gatekeeperip getDisplays the current setting for this option gatewayareacodegatewayareacode <set|get> areacode Sets the area code when followed by the areacodeExample gatewaycountrycodegatewaycountrycode <set|get> number Descriptiongatewayext get gatewayextgatewayext <set|get> gateway extension gatewayext set gateway extension gatewayext setExample gatewaynumbergatewaynumber <set|get> number DescriptionDescription gatewaynumbertypegatewaynumbertype <did|number+extension|get> Displays the current setting did orset <“valid speed”> gatewayprefixgatewayprefix <set|get><valid speed> value DescriptionExample gatewaysetupgatewaysetup Outputset <“valid speed”> gatewaysuffixgatewaysuffix <set|get><valid speed> value Descriptiongeneratetone <on|off> gendialgeneratetone gendial 0..9|#|Output Example get screengmscity get screenUser Interface Screen Location gmscontactemailgmscontactemail <set|get> email ExampleExample gmscontactfaxgmscontactfax <set|get> fax DescriptionExample gmscontactnumbergmscontactnumber <set|get> number DescriptionExample gmscontactpersongmscontactperson <set|get> person DescriptionExample gmscountrygmscountry get DescriptionExample gmsstategmsstate get DescriptionDescription gmstechsupportgmstechsupport <set|get> tech support digits gmstechsupport getExample gmsurlgmsurl get <1..10> Descriptioncommand graphicsmonitor visualconcert is graphicsmonitorgraphicsmonitor <tv|fxvga|visualconcert|get> command graphicsmonitor fxvga is similar tographicsmonitortv <on|off|get> graphicsmonitorfxvgagraphicsmonitortv graphicsmonitorfxvga <on|off|get>Displays the current setting on or off graphicsmonitorvisualconcertgraphicsmonitorvisualconcert <on|off|get> Disables the TV monitor as the graphics monitorDescription h323nameh323name <set|get> H.323name h323name gethangup phone hangup video 1..3 hangup video hanguphelp hangup <phone|video>verbose Output to Example 1 partialExample helpDescription hiresOutput to Example 2 partial hires <2|3> <yes|no|get>User Interface Screen Location historyhistory Output to ExampleDescription hostnamehostname <set|get> hostname hostname set hostname hostname set hostname getipaddress get ipaddressipaddress <set|get> ipaddress set xxx.xxx.xxx.xxx ipaddress setUser Interface Screen Location ipdialspeedipdialspeed <set|get><valid speed><on|off> ExampleDisplays the current setting ipprecedenceipprecedence <set|get> <0..5> ipprecedence set <0..5> ipprecedence getOutput to Example ipstatipstat Descriptionlanguage get keypadaudioconflanguage keypadaudioconf <yes|no|get>Example lanportSets the command. It requires a parameter from Displays the current settinglanstat tmin lanstat tmin 0..60 lanstat total lanstat <min|misc|reset|sec|tmin|total>lanstat lanstat minlanstat min ExampleOutput to Example Output to ExampleExample listenlisten <phone|video|sleep> DescriptionExample maxgabinternationalcallspeedmaxgabinternationalcallspeed get DescriptionDescription maxgabinternetcallspeedmaxgabinternetcallspeed <set|get> <valid speed> maxgabinternetcallspeed getDescription maxgabisdncallspeedmaxgabisdncallspeed <set|get> <valid speed> maxgabisdncallspeed getExample maxtimeincallmaxtimeincall <set|get> DescriptionDescription mcupasswordmcupassword password mcupasswordDescription meetingpasswordmeetingpassword <set|get> password passwordExample mpautoanswermpautoanswer <yes|no|donotdisturb|get> DescriptionDescription mpmodeDisplays the current setting for this option User Interface Screen Locationmute register mute unregister mutemute <near|far|register|unregister> mute near <on|off|toggle|get> mute far getnearloop <on|off> muteautoanswercallsnearloop muteautoanswercalls <yes|no|get>Disables the Near End Loop netmeetingipnetmeetingip <set|get> netmeetingip getDescription netstatsnetstats netstatsUser Interface Screen Location numdigitsdidnumdigitsdid <0..24|get> numdigitsdid <0..24> numdigitsdid getDisplays the current setting numdigitsextnumdigitsext <0..24|get> numdigitsext <0..24> numdigitsext getnumberofmonitors <1..4> numberofmonitors get numberofmonitorsoutboundcallroute numberofmonitors <1..4|get>Example pausepcport pause <0..65535>Example pingping <ip_addr> count Displays the current settingpreferredalias<isdnnumber|fulldidnumber| switchnumber|didextnumber|extension|get>preferredalias pip <on|off|auto|get>switchnumber presetpreset <near|far|register|unregister> preset unregisterDescription primarycallchoiceprimarycallchoice <isdn|ip|manual|get> ExampleDisplays the current setting 1, 2, 3, or primarycameraprimarycamera <1|2|3|4|get> Displays the current setting isdn, ip, or manualregisterthissystem <yes|no|get> queuecommandsqueuecommands <yes|no|get> registerthissystemDisables this option repeatrepeat <1..64> Enables this option register this systemDisables the option requireacctnumtodialrequireacctnumtodial <yes|no|get> Enables the optionExample roomphonenumberroomphonenumber <set|get> room phone number DescriptionDescription rs232rs232<mode|flowcontrol|baud|> SubcommandsDescription screenrun <scriptfilename> User Interface Screen Locationenableui secondarycallchoicesecondarycallchoice <isdn|ip|none|get> disableuiserialnum sendonlypreferredaliasserialnum sendonlypreferredalias <yes|no|get>showaddrsingab <h320|h323|both|get> setaccountnumbershowaddrsingab setaccountnumber <account number>Example showpopupshowpopup <text to display> Displays the current setting h320, h323, or bothslides select <pres> sleepslides sleepExample snapshotsnapshot <0|1|2|3|4|register|unregister> passwordExample snapshotcamerasnapshotcamera <1|2|3|4|get> Displays the current setting 1, 2, 3, orExample snapshottimeoutsnapshottimeout <yes|no|get> Descriptionsnmpadmin get snmpadminsnmpadmin <set|get> admin name snmpadmin set admin_name snmpadmin setExample snmpcommunitysnmpcommunity <set|get> community name Descriptionsnmpconsoleip get snmpconsoleipsnmplocation snmpconsoleip <set|get>User Interface Screen Location soundeffectsvolumesoundeffectsvolume <set|get|test> <0..10> Examplestream <start|stop> stdoutstream stdout <on|off>Disables streaming announcement streamannouncestreamannounce <yes|no|get> Enables streaming announcementsetting, omit the parameter streamaudioportstreamaudioport <set|get> stream audio port streamaudioport getstreammulticastip <set|get> ip address streamenablestreamenable <yes|no|get> streammulticastipExample streamrestoredefaultsstreamrestoredefaults Displays the current settingDescription streamrouterhopsstreamrouterhops <set|get> number router hops streamrouterhops getstreamvideoport <set|get> video port streamspeedstreamvideoport streamspeed <192|256|384|512|get>Displays the current setting subnetmasksubnetmask <set|get> subnetmask getExample systembehindnatsystembehindnat <yes|no|get> DescriptionDescription systemnamesystemname <set|get> system name systemname set system name systemname getExample t120nameipt120nameip <set|get> name or ip Descriptiontcpports get tcpportstechsupport tcpports <set|get>Example teleareacodeteleareacode <set|get> telephone area code teleareacode getExample telecountrycodetelecountrycode <set|get> telephone country code telecountrycode gettelenumber get telenumbertelenumber <set|get> telephone number telenumber set telephone number telenumber settestlan dcuinfo testlan arptestlan dcuinfo testlan arptestlan echo <ip_addr> testlan dnstestlan echo testlan dns <name or ip>Output to Example ExampleOutput to Example ExampleDescription testlan pingtestlan ping <ip_addr>count testlan ping <ip_addr>timediffgmt <-12:00..+00:00..+12:00|get> textinputtimediffgmt textinput <text to input>udpports <set|get> typeofservicetypeofservice <ipprecedence|diffserv|get> udpportsDisables the use of Used Fixed Ports usefixedportsusefixedports <yes|no|get> Enables the use of Used Fixed PortsExample usegatekeeperusegatekeeper <off|specify|auto|get> DescriptionExample usepathnavigatorusepathnavigator <always|never|required| get> DescriptionPolycom, Inc. User Interface Screen Locationvcbutton <play|stop|get|register|unregister> validateacctnumvcbutton validateacctnum <yes|no|get>Description vcraudiooutvcraudioout <yes|no|get> Exampleversion vcrrecordsourceversion vcrrecordsource <auto|near|far|get>vgahorizpos <left|right|get> vgaoffmode <black|nosignal|get>vgahorizpos vgaoffmodeIncreases the phase vgaphasevgaphase <increase|decrease|get> Displays the current setting black or nosignalvgavertpos <up|down|get> vgaresolutionvgaresolution <800x600|1024x768| 1280x1024|get> vgavertposDisplays the current setting up or down volumevolume <set|up|down|get|register| unregister> volume set <0..24>Description waitforwaitfor <callcomplete|systemready| receivingcall> User Interface Screen Locationwanipaddress <set|get> wakewanipaddress wakewidescreenvideo <yes|no|get> whoamiwidescreenvideo whoamiDisables WINS resolution winsresolutionwinsresolution <yes|no|get> Enables WINS resolutionDescription winsserverwinsserver <set|get> winsserver getSets the ISDN area code when followed by the area ISDN BRI Commandsisdnareacode isdnareacode <set|get> area codeExample isdncountrycodeisdncountrycode <set|get> country code DescriptionExample isdndialingprefixisdndialingprefix <set|get> isdn prefix DescriptionDisables the specified speed valid speed isdndialspeedisdndialspeed <set|get> <valid speed> <on|off> Enables the specified speed valid speedUser Interface Screen Location isdnnumDescription ExampleUser Interface Screen Location spidnumDescription ExampleDisplays the current setting ISDN PRI Commandspriareacode priareacode <set|get> area codeExample pricallbycallpricallbycall <set|get> DescriptionExample prichannelprichannel <set|get> <all|1..<23|30>> <on|off> DescriptionUser Interface Screen Location Important PRI Channel InformationExample Examplecommand on page pricsupricsu <internal|external|get> Sets the internal CSU mode. This is the defaultExample pridialchannelspridialchannels <set|get> <1..12|15> DescriptionExample priintlprefixpriintlprefix <set|get> prefix DescriptionDisplays the current setting prilinebuildoutprilinebuildout set <0|-7.5|-15|-22.5> prilinebuildout getExample prilinesignalprilinesignal <set|get><esf/b8zs|crc4/hdb3| hdb3> Descriptionprinumber get prinumberprinumber <set|get> pri number prinumber set pri number prinumber setExample prinumberingplanprinumberingplan <isdn|unknown|get> DescriptionExample prioutsidelineprioutsideline <set|get> outside_line DescriptionExample priswitchpriswitch get DescriptionSets the signal to normal high voltage is logic V.35/RS-449/RS-530/RS-366Commandscts <normal|inverted|get> dcd <normal|inverted|get>Displays the current setting normal or inverted dcdfilterdcdfilter <on|off|get> Sets the signal to inverted low voltage is logicSets the signal to normal high voltage is logic dsranswerdsr <normal|inverted|get> dsranswer <on|off|get>Description dtr <normal|inverted|on|get>Example User Interface Screen Locationg711u h331audiomodeDescription g728User Interface Screen Location h331framerateh331framerate <30|15|10|7.5|get> Displays the current setting for this optionh331videoformat <fcif|get> h331videoprotocolh331videoformat h331videoprotocol <h263|h261|get>User Interface Screen Location rs366dialingrs366dialing on off get ExampleSets the signal to inverted low voltage is logic rt <normal|inverted|get>rts <normal|inverted|get> Sets the signal to normal high voltage is logicUser Interface Screen Location st <normal|inverted|get>Sets the signal to normal falling edge sends data Examplev35debug <0..3> <on|off> v35broadcastmodev35debug v35broadcastmode <on|off|get>v35num <set|get> <1b1|1b2> v35 number v35dialingprotocolv35num v35dialingprotocol <rs366|get>User Interface Screen Location v35portsusedv35portsused <1|1+2|get> ExampleUser Interface Screen Location v35prefixv35prefix <set|get> <valid speed> value ExampleDescription v35profileExample User Interface Screen LocationUser Interface Screen Location ExampleExample Output to Exampleset <valid speed> v35suffixv35suffix <set|get> <valid speed> value DescriptionExample User Interface Screen Locationv35suffix set 128 ”#4#2” Important Safeguards License RestrictionsSafety and Legal Notices FCC Notice WarrantyLimitation of Remedies and Damages USA and Canadian Regulatory NoticesSafety and Legal Notices Part 68 FCC Rules Konformitetserklæring EEA Regulatory NoticesCE Mark Declaration of ConformityDeclaración de conformidad Dichiarazione di conformitàVerklaring van overeenstemming Declaração de ConformidadeSpecial Safety Instructions Installation InstructionsUnderwriters Laboratories Statement

callstate

callstate <registerunregisterget>

Displays the selected call state mode (register or

unregister).

Output to Example