TANDBERG D13639 manual Examples

Page 68

TANDBERG MPS API

User Guide

	Conference	Top level attributes:
	[1..40]	• status: NotStarted/Started/Active

Summary:

•Includes references to the calls being connected to the conference

•DuoVideo status

•Includes information about the pictures generated by the MultiSite

•Cascading status

•MCU Site list

•On Air information

Examples:

*s Conference 1 (status=NotStarted): / *s/end

*s Conference 1 (status=Started): MCUID: 85

Properties:

Name: "Marius sin"

CallRate: 384

Restrict: Off

Password: ""

PasswordOnOutgoingCalls: Off

Dynamic: On

ID: ""

Encryption: Off

EncryptionType: Auto

WelcomeMessage: On

DuoVideo: On

AudioG728: On

CascadingPreference: Auto

BillingCode: ""

CPAutoSwitch: 0

PictureMode: VS

VideoFormat: Auto

CustomFormats: On

AGC: On

AllowIncomingCalls: On

Duration: 0

MaxAudioSites: 0

MaxVideoSites: 0

EntryExitTones: On

LegacyLevel: 0

TelephoneFilter: On

FloorToFull: On

WebCallListTimeout: On

BandwidthThreshold: 128

NetworkId: 1

ConferenceSelfview: On

PhoneIndication: On

SpeakerIndication: On

VideoText: On

VideoTextTimeout: 2

ChairControl: On

LectureMode: Off

Protect: Off

VideoCodingMode: Transcoding

SecondaryRate: On

66

Image 68

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 Status Documents r XML DocumentsDocuments 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 Addressing Accessing XacliRoot commands Xstatus call Exposure optionsSupported exposure options Misc Status-type root commands Xstatus / xhistory FormatXstatus ? Xstatus call 1 remotenumberXML Xacli *s IPConfiguration-type root commands xconfiguration/xdirectory Configuration helpXconfiguration ? Xdirectory ?Xconfiguration // ? Xconfiguration ?? Configuration readConfiguration set write 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 Xcommand dial 666 10 128 onXcommand dial 666 ron 10 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 Description Textual description of the cause code DialGroupEntry DialInNumberAdd DialInNumberRemoveParameters Conferencer DialLocalEntry DisconnectCall DisconnectGWCall OK Result parameters Error Result parameters FeedbackDeregister FeedbackRegisterFloorToSite FloorToSiteEnd GroupEntryAdd Parameters Name S 0, 48 The entry’s nameGroupEntryDelete 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 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