TANDBERG D13639 Manuel d'utilisateur

TANDBERG MPS API User Guide TANDBERG D13639 Rev 07 March 2008

TANDBERG MPS API User Guide 8 configuration hierarchies it wants to monitor by using XPath. The user/control application can therefore limit the amou

TANDBERG MPS API User Guide 9 1.4 The XML Documents 1.4.1 Documents The XML Data in the TANDBERG systems are divided into three main types of docu

TANDBERG MPS API User Guide 10 <RemoteIPAddress item="1" /> <LocalIPAddress item="1">10.47.8.41:2326<

TANDBERG MPS API User Guide 11 Example 10 From the XML structure below we see that the BaudRate element of SerialPort[1] is configure

TANDBERG MPS API User Guide 12 <CallRate item="1" required="False" valueSpaceRef="/ValueSpace/Bandwidth"/>

TANDBERG MPS API User Guide 13 Example 14 Below is an example of the Dial command, not being accepted by the system: <Command> &

TANDBERG MPS API User Guide 14 1.5 Introduction to TANDBERG XML API Service (TXAS) TXAS is a service provided by TANDBERG units for transmitting an

TANDBERG MPS API User Guide 15 1.6 Exercises The exercises in this section are based on using a TANDBERG 6000 MXP codec and Microsoft Internet Expl

TANDBERG MPS API User Guide 16 <SerialPort> <BaudRate>2400</BaudRate> </SerialPort> <Conference> <H263

TANDBERG MPS API User Guide 17 2 The XML-based Advanced Command Line Interface The XML-based Advanced Command Line Interface, XACLI, is a very flexi

TANDBERG MPS API User Guide ii Table of Contents User Guide...

TANDBERG MPS API User Guide 18 2.1 XACLI 2.1.1 Accessing XACLI XACLI can be accessed through Telnet via the LAN interface or through RS-232 by conne

TANDBERG MPS API User Guide 19 2.1.4 Exposure options By adding an exposure option after the address (XPath or SimplePath) expression, the system can

TANDBERG MPS API User Guide 20 Audio (status=Active): Video 1 (status=Active): Video 2 (status=Inactive): / Data (status=

TANDBERG MPS API User Guide 21 2.2 The Status-type root commands – xstatus / xhistory The information accessible through these commands is the exac

TANDBERG MPS API User Guide 22 o XACLI is using indent spaces to present the data structure o XACLI hides instance number (item number in XML) of a

TANDBERG MPS API User Guide 23 2.3 The Configuration-type root commands - xconfiguration/xdirectory The information accessible through these comman

TANDBERG MPS API User Guide 24 <configuration-type root command> <address expr> ?/help Example 2.7 User wants to configure IP: xconfi

TANDBERG MPS API User Guide 25 Example 2.9 User wants to set IP assignment: xconfiguration ip assignment: static or xconfiguration ip/

TANDBERG MPS API User Guide 26 2.4 The Command-type root commands - xcommand To get an overview of the supported commands within a command-type roo

TANDBERG MPS API User Guide 27 Example 2.12 xcommand Dial ? *h xCommand Dial Number(r): <S: 0, 30> SubAd

TANDBERG MPS API User Guide 1 1 The TANDBERG API This document is a guide to the API interface of the TANDBERG MPS products. All rights reserved. Th

TANDBERG MPS API User Guide 28 Sequence notation <command-type root command> <command> <value> <value>... When using this

TANDBERG MPS API User Guide 29 2.5 XML Output - xgetxml As an alternative to the standard XACLI output format, XML format is supported through the

TANDBERG MPS API User Guide 30 2.6 Special Commands In addition to the root commands described above, XACLI support a set of root commands that onl

TANDBERG MPS API User Guide 31 Example 2.21 Exposure options are also supported together with feedback. User only wants to monitor call s

TANDBERG MPS API User Guide 32 *s/end xcom disc *r Result (status=OK): / *r/end OK NO CARRIER *s Call 1 (status=Disconnected, type=NA, protocol=N

TANDBERG MPS API User Guide 33 Rate: 768 Restrict: Off Encryption (status=Off): / Audio (status=Active): Protoco

TANDBERG MPS API User Guide 34 xpreferences detaillevel <1..2> Most information elements accessible by the status-type root commands are define

TANDBERG MPS API User Guide 35 <BaudRate item="1">2400</BaudRate> </SerialPort> </Configuration> xpreference

TANDBERG MPS API User Guide 36 3 API - Configurations This section gives an overview of the Configuration Information available in the Configuration

TANDBERG MPS API User Guide 37 3.1 configuration.xml – xconfiguration AllowIncomingTlphCall AllowIncomingTlphCall: <On/Off> Conference Confe

TANDBERG MPS API User Guide 2 1.1 Introduction to XML XML is a markup language for documents containing structured information. All information el

TANDBERG MPS API User Guide 38 ConferenceTemplate [1..10] EntryExitTones: <On/Off> ConferenceTemplate [1..10] WelcomeMessage: <On/Off>

TANDBERG MPS API User Guide 39 <Off/Normal/High> ConferenceTemplate [1..10] OptimalVideoQuality: <On/Off> ConferenceTemplate [1..10] Enc

TANDBERG MPS API User Guide 40 H323Gatekeeper [1..2] Authentication Password: <S: 0, 50> HTTP HTTP Mode: <On/Off> HTTPS HTTPS Mode: <

TANDBERG MPS API User Guide 41 ISDNInterfaceCard [1..6] ISDN PRI Interface [1..8] MaxChannels: <1..30> ISDNInterfaceCard [1..6] ISDN PRI Interf

TANDBERG MPS API User Guide 42 LoS Polarity: <Positive/Negative> LoS Retry: <0..65535> MCU MCU AdditiveRegEnable: <On/Off> MCU H

TANDBERG MPS API User Guide 43 QoS [1..2] Precedence Telephony Signalling: <0/1/2/3/4/5/6/7/Auto/Off> QoS [1..2] Precedence VideoTelephony Aud

TANDBERG MPS API User Guide 44 SingleNumberDialIn SingleNumberDialIn Active: <On/Off> SingleNumberDialIn Numbers ISDN: <S: 0, 60> Sing

TANDBERG MPS API User Guide 45 DefaultIpConference: <0..15> TerminalSyncLossTimer: <5..90> GatekeeperAdhocString: <S: 0, 10> Tra

TANDBERG MPS API User Guide 46 3.2 directory.xml – xdirectory LocalEntry LocalEntry [1..250] Name: <S: 0, 48> LocalEntry [1.. 250] Number: &

TANDBERG MPS API User Guide 47 4 API - Commands This section gives an overview of the supported system Commands. All examples are presented using th

TANDBERG MPS API User Guide 3 Example 1.3 If we now look at the call element for an active call we see that call element contains a large sub-struct

TANDBERG MPS API User Guide 48 4.1 command.xml – xcommand Boot Command used to reboot the system. Parameters: None OK Result parameters: None ERRO

TANDBERG MPS API User Guide 49 • Cause: <1…> Cause code specifying why the command was not accepted by the system • Description

TANDBERG MPS API User Guide 50 CallMuteVideo Command used to mute incoming video from a specific call. Parameters: • Call(r): <1..128>

TANDBERG MPS API User Guide 51 • EntryExitTones: <On/Off> • LegacyLevel: <0..15> • TelephoneFilter: <On/Off&

TANDBERG MPS API User Guide 52 • AudioG728: <On/Off> • CascadingPreference: <Auto/Master/Slave> • BillingCode: <

TANDBERG MPS API User Guide 53 • Description Textual description of the cause code. Example: xcommand conferencestart conference:1 *r Result

TANDBERG MPS API User Guide 54 *r/end OK DefaultValuesSet Command used to reset configurations to default values. Parameters: • Level: <

TANDBERG MPS API User Guide 55 OK DialGroupEntry Command used to dial an entry from the Group Directory. Dialing from the Group Directory makes it p

TANDBERG MPS API User Guide 56 • Cause: <1…> Cause code specifying why the call was not accepted by the system • Description Tex

TANDBERG MPS API User Guide 57 accepted by the system • Description Textual description of the cause code. Example: xcommand disconnectgwcall

TANDBERG MPS API User Guide 4 <StopBits item="1">1</StopBits> <Mode item="1">Auto</Mode> <

TANDBERG MPS API User Guide 58 *r/end OK FloorToSite Command used to assign floor to a specific site in a conference. Parameters: • Confer

TANDBERG MPS API User Guide 59 • GroupEntryId: <1..16> Reference to the Group Directory position the entry is stored. ERROR Result param

TANDBERG MPS API User Guide 60 • Window(r): <1..16> • CallID(r): <1..176> Call. ERROR Result parameters: • Caus

TANDBERG MPS API User Guide 61 *r Result (status=OK): *r/end OK OptionKeyAdd Command used to add option key. Parameters: • Key(r): <S:

TANDBERG MPS API User Guide 62 ProtectNumberRemove Command used to remove a protect number. Parameters: • Conference(r): <1..15> Confer

TANDBERG MPS API User Guide 63 5 API - Status This section gives an overview of the Status Information available in the Status XML documents (status

TANDBERG MPS API User Guide 64 5.1 status.xml – xstatus Call [1..160] Top level attributes: • conferenceRef: 1..9 • direction: Incomi

TANDBERG MPS API User Guide 65 LocalIPAddress: "10.47.9.150:2344" Encryption (status=Off): / RSVP: Off R

TANDBERG MPS API User Guide 66 Conference [1..40] Top level attributes: • status: NotStarted/Started/Active Summary: • Includes refe

TANDBERG MPS API User Guide 67 FarTlphEchoSupression: Normal NetErrorHandling: None IPLRRobustMode: Auto FURBlockSites: Au

TANDBERG MPS API User Guide 5 1.2 Introduction to XML Path Language (XPath) XPath is a comprehensive language to address data in XML documents. It

TANDBERG MPS API User Guide 68 Picture: NA CallRef: None Window 6: Picture: NA CallRef: None

TANDBERG MPS API User Guide 69 PhoneIndication: On SpeakerIndication: On VideoText: On VideoTextTimeout: 5 ChairCon

TANDBERG MPS API User Guide 70 *s/end H323Gatekeeper [1..2] Top level attributes: • status:Required/Discovering/Discovered/Authenticating/ Authen

TANDBERG MPS API User Guide 71 Example *s MediaBoard 1: TemperatureCelcius: 30 TemperatureFahrenheit: 86 Description: ""

TANDBERG MPS API User Guide 72 SerialNumber: "44a00003" MainBoard: "113637 MCP 820 System Controller" BootSoft

TANDBERG MPS API User Guide 73 Channels 22 (type=BChannel, status=Idle): / Channels 23 (type=BChannel, status=Idle): / Channels 2

TANDBERG MPS API User Guide 74 CauseLocation: 2 ChannelCause: 17 ConnectionTime: 0 Channels 26 (type=BChannel, statu

TANDBERG MPS API User Guide 75 State: RedAlarm *s/end ExternalManager *s ExternalManager: Address: "10.47.1.10" Protocol

TANDBERG MPS API User Guide 76 URI: "" Registration 21 (status=Inactive): URI: "" Registration 22

TANDBERG MPS API User Guide 77 Options *s Options: Option 1: Key: "****" Description: "40 video telephony ports + 1

TANDBERG MPS API User Guide 6 Example 1.8 XPath also supports addressing by putting constraints on element attributes. Let’s go back

TANDBERG MPS API User Guide 78 Option 52: / Option 53: / Option 54: / Option 55: / Option 56: / Option 57: / Option

TANDBERG MPS API User Guide 79 5.2 history.xml – xhistory Call [1..96] Top level attributes: • type: Tlph/Vtlph • protocol: H320/H

TANDBERG MPS API User Guide 80 5.3 Event.xml – xevent AuthenticationFailure *e AuthenticationFailure: Service: / RemoteIPAddress: /

TANDBERG MPS API User Guide 81 Incoming: Audio: TotalPackets: / PacketLoss: / PacketsDropped: / MaxJit

TANDBERG MPS API User Guide 82 *e/end H320Statistics *e H320Statistics: CallRef: / LogTag: / ConferenceRef: / ConferenceLogTag:

TANDBERG MPS API User Guide 7 1.3 The TANDBERG XML Engine The TANDBERG XML engine is optimized for advanced machine-machine interaction between a T