TANDBERG D13639 manual API Configurations

Page 38

TANDBERG MPS API

User Guide

3 API - Configurations

This section gives an overview of the Configuration Information available in the Configuration XML documents (configuration.xml / directory.xml) and the Configuration root commands (xconfiguration / xdirectory) of the XACLI interface.

All examples are presented using the standard XACLI format.

36

Image 38

Contents Tandberg MPS API User GuideTable of Contents Tandberg API DisclaimerIntroduction to XML ExampleExample Tandberg MPS API Introduction to XML Path Language XPath Status/Call@status=Synced/CallRate Structuring of Information Addressing using XPathTandberg XML Engine FeedbackTandberg MPS API Status Documents r XML DocumentsDocuments Configuration documents rw Command documents w Command Dial item=1 Number item=1999/Number /Dial Example Getxml Introduction to Tandberg XML API Service TxasBare-bone Https access FormputxmlExercises ExerciseTandberg MPS API XML-based Advanced Command Line Interface Addressing Accessing XacliRoot commands Xstatus call Exposure optionsSupported exposure options Misc Xstatus ? Status-type root commands Xstatus / xhistoryFormat Xstatus call 1 remotenumberXML Xacli *s IPXconfiguration ? Configuration-type root commands xconfiguration/xdirectoryConfiguration help Xdirectory ?Xconfiguration // ? Xconfiguration ?? Configuration readConfiguration set write Xconfiguration ip/assignment static Xcommand ? Command-type root commands xcommandCommand help Xcommand ??Xcommand dial number666 restricton callrate128 subaddress10 Issuing a commandExample 2.12 xcommand Dial ? Xcommand dial nu666 ron c128 s10Xcommand dial Xcommand dial 666 10 128 onXcommand dial 666 ron 10 XML Output xgetxml Xgetxml status/ipXfeedback ? Special CommandsXfeedback Xfeedback register status/call/channels/audio/protocolXfeedback register status/call Xcom dial Xfeedback register status/call@status=Disconnected Xcom dialXcom disc Xfeedback register status/call@status=Synced Xcom dialXpreferences Xpreferences ?Xstat call 1 channels 1 audio Xpreferences detaillevel Xstat call 1 channels 1 audioBaudRate item=12400/BaudRate API Configurations Configuration.xml xconfiguration Tandberg MPS API Tandberg MPS API H323Gatekeeper 1..2 Authentication Password S 0 Http Mode On/OffTandberg MPS API LoS Polarity Positive/Negative LoS Retry MCURTP SerialInterfaceCard SessionSIP Interface Authentication Password S 0 SIP Mode On/OffSIP Interface Authentication UserName S 0 SIP Interface Transport Default TCP/UDPTandberg MPS API Directory.xml xdirectory API Commands Command.xml xcommand CallMuteOutgoing CallTransfer CallTransferToDirEntry CallMuteVideo ConferenceDisconnect ConferenceModify Parameters Conferencer OK Result parametersConferenceRedefine ConferenceStart ConferenceStop ConferenceShowDuration ConferenceTerminate DefaultValuesSet Dial Description Textual description of the cause code DialGroupEntry DialInNumberAdd DialInNumberRemoveParameters Conferencer DialLocalEntry DisconnectCall DisconnectGWCall OK Result parameters Error Result parameters FeedbackDeregister FeedbackRegisterFloorToSite FloorToSiteEnd GroupEntryAdd Parameters Name S 0, 48 The entry’s nameGroupEntryDelete LayoutLock LayoutUnLock NetworkId NetworkModule OK Result parameters Windowr CallIDr 1..176 Call Error Result parametersLocalEntryAdd LocalEntryDelete Command used to add option key ProtectNumberRemove VideoTextSet API Status Status.xml xstatus ExamplesTandberg MPS API Examples Tandberg MPS API Mcuid Ethernet Top level attributes Feedback Top level attributesNone User GuideEnd MediaBoard 1..8 Top level attributesSystemUnit Top level attributes None Summary SerialInterfaceCard ISDNInterfaceCard Top level attributes Status on/off SummaryTandberg MPS API Tandberg MPS API NTP SIP SystemLoad SystemClock SystemActivity Options Option Option 64 / *s/end History.xml xhistory Conference Top level attributesEvent.xml xevent PacketLoss AudioTotalPackets PacketsDroppedEnd