TANDBERG D13639 manual ConferenceStart

Page 54

ConferenceStart

TANDBERG MPS API

User Guide

•AudioG728: <On/Off>

•CascadingPreference: <Auto/Master/Slave>

•BillingCode: <S: 0, 16>

•CPAutoSwitch: <0..60>

•NetworkId: <1..32>

•ConferenceSelfview: <On/Off>

•Protect: <On/Off>

•TemplateReference: <1..10>

•HDEnabled: <On/Off>

OK Result parameters:

None

ERROR Result parameters:

•Cause: <1…> Cause code specifying why the command was not accepted by the system

•Description Textual description of the cause code.

Example:

xcommand conferenceredifine conference:1 duovideo:on restrict:on

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

OK

Command used to start a new conference.

Parameters:

•Conference(r): <1..35>

•Name: <S: 0, 30>

•CallRate:

<1xh221/2xh221/64/128/192/256/320/384/H0/512/768/1152/1472/15

36/1920/Tlph>

•Restrict: <On/Off>

•Password: <S: 0, 8>

•PasswordOnOutgoingCalls: <On/Off>

•Encryption: <On/Off>

•EncryptionType: <DES/AES-128/Auto>

•SecondaryRate: <On/Off>

•WelcomeMessage: <On/Off>

•DuoVideo: <On/Off>

•AudioG728: <On/Off>

•CascadingPreference: <Auto/Master/Slave>

•BillingCode: <S: 0, 16>

•CPAutoSwitch: <0..60>

•NetworkId: <1..32>

•ConferenceSelfview: <On/Off>

•Protect: <On/Off>

•TemplateReference: <1..10>

•HDEnabled: <On/Off>onference(r): <1..12>

OK Result parameters:

None

ERROR Result parameters:

•Cause: <1…> Cause code specifying why the command was not accepted by the system

52

Image 54

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 XML Documents 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 Accessing Xacli Root commandsAddressing Exposure options Supported 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 read Configuration set writeXconfiguration // ? 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 10 128 on Xcommand dial 666 ron 10Xcommand 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 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 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