TANDBERG D13639 manual Issuing a command, Example 2.12 xcommand Dial ?, Markup notation

Page 29

TANDBERG MPS API

User Guide

Example 2.12 xcommand Dial ?

*h xCommand Dial

Number(r): <S: 0, 30>

SubAddress: <S: 0, 10>

CallRate: <1xh221/2xh221/64/128/256...

Restrict: <On/Off>

NetProfile: <1..6>

OK

NOTE! Required parameters are identified by an “(r)” behind the parameter name.

2.4.2 Issuing a command

A command must start with a command-type root command, followed by a command name, followed by a set of parameters. Parameters values can either be specified by a mark-up notation or by placing the parameter values in the sequence specified by the help text – or a combination of these methods.

Markup notation

<command-type root command> <command> <parameter:value> <parameter:value>...

When using this notation, the sequence the parameters are entered is unessential:

Example 2.13

xcommand dial number:666 restrict:on callrate:128 subaddress:10

Abbreviations can be used for the parameter names as long as the parameter names are unique within the command:

Example 2.14

xcommand dial nu:666 r:on c:128 s:10

If there are multiple instances of a parameter, the item number is added after the tag separated with a dot:

<command-type root command> <command> <parameter.item:value>

<parameter.item:value>...

Example 2.15

xcommand groupentryadd name:TANDBERG localentryid.1:15 localentryid.2:57

27

Image 29
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 Tandberg XML Engine Addressing using XPathStructuring of Information FeedbackTandberg 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 FormputxmlExercise ExercisesTandberg 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 remotenumberXacli *s IP XMLConfiguration 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 s10Xcommand dial Xcommand dial 666 10 128 onXcommand dial 666 ron 10 Xgetxml status/ip XML Output xgetxmlXfeedback Special CommandsXfeedback ? Xfeedback register status/call/channels/audio/protocolXfeedback 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 Authentication UserName S 0 SIP Mode On/OffSIP Interface Authentication Password S 0 SIP Interface Transport Default TCP/UDPTandberg 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 Description Textual description of the cause code DialGroupEntry DialInNumberAdd DialInNumberRemoveParameters Conferencer DialLocalEntry DisconnectCall DisconnectGWCall FeedbackDeregister FeedbackRegister OK Result parameters Error Result parametersParameters Name S 0, 48 The entry’s name FloorToSite FloorToSiteEnd GroupEntryAddGroupEntryDelete 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 xstatusTandberg MPS API Examples Tandberg MPS API Mcuid Feedback Top level attributes Ethernet Top level attributesEnd User GuideNone MediaBoard 1..8 Top level attributesSystemUnit 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 TotalPackets AudioPacketLoss PacketsDroppedEnd