API Status | TANDBERG D13639 manual

TANDBERG MPS API

User Guide

5 API - Status

This section gives an overview of the Status Information available in the Status XML documents (status.xml / history.xml) and the Status root commands (xstatus / xhistory) of the XACLI interface.

All examples are presented using the standard XACLI format.

63

Image 65

TANDBERG D13639 manual API Status

Contents

User Guide Tandberg MPS API Table of Contents Disclaimer Tandberg API Example Introduction to XML Example Tandberg MPS API Introduction to XML Path Language XPath Status/Call@status=Synced/CallRate Tandberg XML Engine Addressing using XPathStructuring of Information Feedback Tandberg MPS API Status Documents r XML DocumentsDocuments Configuration documents rw Command documents w Command Dial item=1 Number item=1999/Number /Dial Example Bare-bone Https access Introduction to Tandberg XML API Service TxasGetxml Formputxml Exercise Exercises Tandberg MPS API XML-based Advanced Command Line Interface Addressing Accessing XacliRoot commands Xstatus call Exposure optionsSupported exposure options Misc Format Status-type root commands Xstatus / xhistoryXstatus ? Xstatus call 1 remotenumber Xacli *s IP XML Configuration help Configuration-type root commands xconfiguration/xdirectoryXconfiguration ? Xdirectory ? Xconfiguration // ? Xconfiguration ?? Configuration readConfiguration set write Xconfiguration ip/assignment static Command help Command-type root commands xcommandXcommand ? Xcommand ?? Example 2.12 xcommand Dial ? Issuing a commandXcommand dial number666 restricton callrate128 subaddress10 Xcommand dial nu666 ron c128 s10 Xcommand dial Xcommand dial 666 10 128 onXcommand dial 666 ron 10 Xgetxml status/ip XML Output xgetxml Xfeedback Special CommandsXfeedback ? Xfeedback register status/call/channels/audio/protocol Xfeedback register status/call@status=Disconnected Xcom dial Xfeedback register status/call Xcom dial Xfeedback register status/call@status=Synced Xcom dial Xcom disc Xpreferences ? Xpreferences Xpreferences detaillevel Xstat call 1 channels 1 audio Xstat call 1 channels 1 audio BaudRate item=12400/BaudRate API Configurations Configuration.xml xconfiguration Tandberg MPS API Tandberg MPS API Http Mode On/Off H323Gatekeeper 1..2 Authentication Password S 0 Tandberg MPS API MCU LoS Polarity Positive/Negative LoS Retry SerialInterfaceCard Session RTP SIP Interface Authentication UserName S 0 SIP Mode On/OffSIP Interface Authentication Password S 0 SIP Interface Transport Default TCP/UDP Tandberg MPS API Directory.xml xdirectory API Commands Command.xml xcommand CallMuteOutgoing CallTransfer CallTransferToDirEntry Parameters Conferencer OK Result parameters CallMuteVideo ConferenceDisconnect ConferenceModify ConferenceRedefine ConferenceStart ConferenceStop ConferenceShowDuration ConferenceTerminate DefaultValuesSet Dial Description Textual description of the cause code DialGroupEntry DialInNumberAdd DialInNumberRemoveParameters Conferencer DialLocalEntry DisconnectCall DisconnectGWCall FeedbackDeregister FeedbackRegister OK Result parameters Error Result parameters Parameters Name S 0, 48 The entry’s name FloorToSite FloorToSiteEnd GroupEntryAdd GroupEntryDelete 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 Examples Status.xml xstatus Tandberg MPS API Examples Tandberg MPS API Mcuid Feedback Top level attributes Ethernet Top level attributes End User GuideNone MediaBoard 1..8 Top level attributes SystemUnit Top level attributes None Summary Top level attributes Status on/off Summary SerialInterfaceCard ISDNInterfaceCard Tandberg MPS API Tandberg MPS API NTP SIP SystemLoad SystemClock SystemActivity Options Option Option 64 / *s/end Conference Top level attributes History.xml xhistory Event.xml xevent TotalPackets AudioPacketLoss PacketsDropped End