TANDBERG D13639 manual Xcom disc, Xfeedback register status/call@status=Synced Xcom dial

Page 34

TANDBERG MPS API

User Guide

*s/end

xcom disc

*r Result (status=OK): / *r/end

OK

NO CARRIER

*s Call 1 (status=Disconnected, type=NA, protocol=NA, direction=NA): *s/end

When conditional XPath expressions are used, the system will provide feedback on all elements within the address the first time the condition is true.

Example 2.23

User wants to monitor call changes only when the call is in Synced state. By registering the below expression, the system will not provide feedback on the call before it reaches the Synced state. When it first enters the Synced state it will provide status for the complete call. After this, the system will only give feedback on elements changing values (provided that the call is still in Synced state).

xfeedback register status/call[@status="Synced"]

OK

xcom dial 10.47.15.127

*r Result (status=OK): CallRef: 1 LogTag: 5

*r/end

OK

CONNECT

*s Call 1 (status=Synced, type=Vtlph, protocol=H323, direction=Outgoing):

CallRate: 768

RemoteNumber: "10.47.15.127"

Mute: Off

Microphone: Off

Duration: 0

Channels 1 (type=Incoming): Rate: 768

Restrict: Off

Encryption (status=Off): / Audio (status=Active):

Protocol: G722

Rate: 64

Video 1 (status=Active): Protocol: H263 Resolution: CIF Rate: 704

Video 2 (status=Inactive): /

Data (status=Inactive): /

Channels 2 (type=Outgoing):

32

Image 34
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 Documents XML DocumentsStatus Documents r 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 Root commands Accessing XacliAddressing Supported exposure options Exposure optionsXstatus call Misc Xstatus ? Status-type root commands Xstatus / xhistoryFormat Xstatus call 1 remotenumberXML Xacli *s IPXconfiguration ? Configuration-type root commands xconfiguration/xdirectoryConfiguration help Xdirectory ?Configuration set write Configuration readXconfiguration // ? Xconfiguration ?? 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 666 ron 10 Xcommand dial 666 10 128 onXcommand dial 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 Parameters Conferencer DialGroupEntry DialInNumberAdd DialInNumberRemoveDescription 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 LocalEntryAdd LocalEntryDelete Windowr CallIDr 1..176 Call Error Result parametersNetworkId 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 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