TANDBERG D13639 manual Xstat call 1 channels 1 audio

Page 36

TANDBERG MPS API

User Guide

xpreferences detaillevel <1..2>

Most information elements accessible by the status-type root commands are defined to be level1 information. However there are some information elements which are defined to be level2 information. When reading status information, only the information elements with a detail level equal to or less than the detaillevel defined for the interface will be listed.

Example 2.24

xstat call 1 channels 1 audio

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

Channels 1 (type=Incoming):

Audio (status=Active): Protocol: G722 Rate: 64

*s/end

OK

xpreferences detaillevel 2

OK

xstat call 1 channels 1 audio

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

Channels 1 (type=Incoming):

Audio (status=Active): Protocol: G722 Rate: 64 RemoteIPAddress: "" LocalIPAddress: "10.47.8.28:2326" Encryption (status=On):

Type: AES-128 RSVP: Off

RSVPRate: 0 DynamicRate: 64 TotalPackets: 1618

PacketLoss: 0

Jitter: 0

*s/end

OK

xpreferences xmlconfigfeedback <on/off>

If xmlconfigfeedback is set to on, feedback on configurations will be returned in XML-format instead of the standard XACLI configuration format.

Example 2.25

XACLI-format:

*c xConfiguration SerialPort 1 BaudRate: 2400

XML-format: <Configuration>

<SerialPort item="1">

34

Image 36
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