TANDBERG D13639 manual XML-based Advanced Command Line Interface

Page 19

TANDBERG MPS API

User Guide

2 The XML-based Advanced Command Line Interface

The XML-based Advanced Command Line Interface, XACLI, is a very flexible interface both optimized for machine-machine interaction and man-machine interaction. It is based on the powerful TANDBERG XML engine and offers many of the same features as the TANDBERG XML interface.

The main distinction between XACLI and the TANDBERG XML interface is the input format. As XACLI is a command line interface all inputs from the user/control application have to be put on one line, in opposite to the XML interface where a complete XML document can be posted to the system in one operation.

A basic understanding of the information structuring in the TANDBERG XML engine is important in order to get the most out of the XACLI interface. It is therefore recommended to read the documentation of the TANDBERG XML API prior to reading this section.

17

Image 19

Contents User Guide Tandberg MPS APITable of Contents Disclaimer Tandberg APIExample Introduction to XMLExample Tandberg MPS API Introduction to XML Path Language XPath Status/Call@status=Synced/CallRate Feedback Addressing using XPathTandberg XML Engine Structuring of InformationTandberg MPS API Documents XML DocumentsStatus Documents r Configuration documents rw Command documents w Command Dial item=1 Number item=1999/Number /Dial Example Formputxml Introduction to Tandberg XML API Service TxasBare-bone Https access GetxmlExercise ExercisesTandberg MPS API XML-based Advanced Command Line Interface Root commands Accessing XacliAddressing Supported exposure options Exposure optionsXstatus call Misc Xstatus call 1 remotenumber Status-type root commands Xstatus / xhistoryFormat Xstatus ?Xacli *s IP XMLXdirectory ? Configuration-type root commands xconfiguration/xdirectoryConfiguration help Xconfiguration ?Configuration set write Configuration readXconfiguration // ? Xconfiguration ?? Xconfiguration ip/assignment static Xcommand ?? Command-type root commands xcommandCommand help Xcommand ?Xcommand dial nu666 ron c128 s10 Issuing a commandExample 2.12 xcommand Dial ? Xcommand dial number666 restricton callrate128 subaddress10Xcommand dial 666 ron 10 Xcommand dial 666 10 128 onXcommand dial Xgetxml status/ip XML Output xgetxmlXfeedback register status/call/channels/audio/protocol Special CommandsXfeedback Xfeedback ?Xfeedback register status/call@status=Disconnected Xcom dial Xfeedback register status/call Xcom dialXfeedback register status/call@status=Synced Xcom dial Xcom discXpreferences ? XpreferencesXpreferences detaillevel Xstat call 1 channels 1 audio Xstat call 1 channels 1 audioBaudRate item=12400/BaudRate API Configurations Configuration.xml xconfiguration Tandberg MPS API Tandberg MPS API Http Mode On/Off H323Gatekeeper 1..2 Authentication Password S 0Tandberg MPS API MCU LoS Polarity Positive/Negative LoS RetrySerialInterfaceCard Session RTPSIP Interface Transport Default TCP/UDP SIP Mode On/OffSIP Interface Authentication UserName S 0 SIP Interface Authentication Password S 0Tandberg MPS API Directory.xml xdirectory API Commands Command.xml xcommand CallMuteOutgoing CallTransfer CallTransferToDirEntry Parameters Conferencer OK Result parameters CallMuteVideo ConferenceDisconnect ConferenceModifyConferenceRedefine ConferenceStart ConferenceStop ConferenceShowDuration ConferenceTerminate DefaultValuesSet Dial Parameters Conferencer DialGroupEntry DialInNumberAdd DialInNumberRemoveDescription Textual description of the cause code DialLocalEntry DisconnectCall DisconnectGWCall FeedbackDeregister FeedbackRegister OK Result parameters Error Result parametersParameters Name S 0, 48 The entry’s name FloorToSite FloorToSiteEnd GroupEntryAddGroupEntryDelete LayoutLock LayoutUnLock LocalEntryAdd LocalEntryDelete Windowr CallIDr 1..176 Call Error Result parametersNetworkId NetworkModule OK Result parameters Command used to add option key ProtectNumberRemove VideoTextSet API Status Examples Status.xml xstatusTandberg MPS API Examples Tandberg MPS API Mcuid Feedback Top level attributes Ethernet Top level attributesMediaBoard 1..8 Top level attributes User GuideEnd NoneSystemUnit Top level attributes None Summary Top level attributes Status on/off Summary SerialInterfaceCard ISDNInterfaceCardTandberg MPS API Tandberg MPS API NTP SIP SystemLoad SystemClock SystemActivity Options Option Option 64 / *s/end Conference Top level attributes History.xml xhistoryEvent.xml xevent PacketsDropped AudioTotalPackets PacketLossEnd