TANDBERG D13639 manual Configuration documents rw

Page 12

TANDBERG MPS API

User Guide

<RemoteIPAddress item="1" />

<LocalIPAddress item="1">10.47.8.41:2326</LocalIPAddress> <Encryption item="1" status="On">

<Type item="1">AES-128</Type> </Encryption>

<RSVP item="1">Off</RSVP> <RSVPRate item="1">0</RSVPRate>

<DynamicRate item="1">64</DynamicRate> <TotalPackets item="1">367</TotalPackets> <PacketLoss item="1">0</PacketLoss> <Jitter item="1">0</Jitter>

</Audio>

.

.

.

</Call>

---

<Call item="2" status="Synced" type="Vtlph" protocol="H320" direction="Outgoing">

<CallRate item="1">384</CallRate> <Bonding item="1">On</Bonding> <RemoteNumber item="1">8796</RemoteNumber> <RemoteNumber item="2" /> <RemoteSubAddress item="1" />

<Mute item="1">Off</Mute> <Microphone item="1">Off</Microphone> <LogTag item="1">25</LogTag> <Channels item="1" type="Incoming">

<Rate item="1">384</Rate> <Restrict item="1">Off</Restrict> <Encryption item="1" status="Off" /> <Audio item="1" status="Active">

<Protocol item="1">G722</Protocol> <Rate item="1">56</Rate>

</Audio>

.

.

.

</Call>

---

<Call item="6" status="Disconnected" type="NA" protocol="NA" direction="NA">

<Cause item="1">255</Cause> </Call>

In the above example we see that the Bonding element, RemoteNumber[2] and SubAddress is not present for H323 calls. On the other hand, for H323 calls, the Audio channel element holds information regarding packet loss etc., which is not present for H320 calls. If the call is disconnected, the Call element only contains the disconnect cause value.

1.4.3 Configuration documents (rw)

The structure of the Configuration documents is independent of system state, i.e. the structure will be constant in time. In addition to holding the values for the various

configurations, each configuration value-element includes an attribute, valueSpaceRef, referencing the value domain for the configuration.

10

Image 12
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 Addressing using XPath Tandberg XML EngineStructuring of Information FeedbackTandberg MPS API XML Documents DocumentsStatus Documents r Configuration documents rw Command documents w Command Dial item=1 Number item=1999/Number /Dial Example Introduction to Tandberg XML API Service Txas Bare-bone Https accessGetxml FormputxmlExercises ExerciseTandberg MPS API XML-based Advanced Command Line Interface Accessing Xacli Root commandsAddressing Exposure options Supported exposure optionsXstatus call Misc Status-type root commands Xstatus / xhistory FormatXstatus ? Xstatus call 1 remotenumberXML Xacli *s IPConfiguration-type root commands xconfiguration/xdirectory Configuration helpXconfiguration ? Xdirectory ?Configuration read Configuration set writeXconfiguration // ? Xconfiguration ?? Xconfiguration ip/assignment static Command-type root commands xcommand Command helpXcommand ? Xcommand ??Issuing a command Example 2.12 xcommand Dial ?Xcommand dial number666 restricton callrate128 subaddress10 Xcommand dial nu666 ron c128 s10Xcommand dial 666 10 128 on Xcommand dial 666 ron 10Xcommand dial XML Output xgetxml Xgetxml status/ipSpecial Commands XfeedbackXfeedback ? 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 Mode On/Off SIP Interface Authentication UserName S 0SIP Interface Authentication Password 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 DialGroupEntry DialInNumberAdd DialInNumberRemove Parameters ConferencerDescription Textual description of the cause code DialLocalEntry DisconnectCall DisconnectGWCall OK Result parameters Error Result parameters FeedbackDeregister FeedbackRegisterFloorToSite FloorToSiteEnd GroupEntryAdd Parameters Name S 0, 48 The entry’s nameGroupEntryDelete LayoutLock LayoutUnLock Windowr CallIDr 1..176 Call Error Result parameters LocalEntryAdd LocalEntryDeleteNetworkId NetworkModule OK Result parameters 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 attributesUser Guide EndNone 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 Audio TotalPacketsPacketLoss PacketsDroppedEnd