Page 2 - Table of Contents
TANDBERG MPS API User Guide ii Table of Contents User Guide................................................................................................................................. 1 1 The TANDBERG API .............................................................................................
Page 3 - The TANDBERG API
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. This document contains information that is proprietary to TANDBERG. No part of this publication may be reproduced, stored in a retrieval system, or transm...
Page 4 - Introduction to XML
TANDBERG MPS API User Guide 2 1.1 Introduction to XML XML is a markup language for documents containing structured information. All information elements in an XML document are marked by a tag and a corresponding end-tag. The end-tag has the same name as the tag, but is prefixed with a slash, “/”. Al...
Page 7 - Example 1.5
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 is though very simple to understand the basics. If you are able to specify the path to a file on your computer, you are able to specify the path to an el...
Page 9 - The TANDBERG XML Engine
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 TANDBERG system and an external control application. The main features can be summarized to: • Structuring of information • Addressing using XPath • Feedb...
Page 11 - The XML Documents; Example 9
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 documents. The division is based on whether the information is Read Information , Write Information or Read-Write information: 1. Status documents (r) : Docum...
Page 13 - Example 11
TANDBERG MPS API User Guide 11 Example 10 From the XML structure below we see that the BaudRate element of SerialPort[1] is configured to 9600 . The BaudRate element references the SerialPortBaudrate element in the ValueSpace document, showing the value domain for this configuration. <Configurati...
Page 14 - Example 12; Example 13
TANDBERG MPS API User Guide 12 <CallRate item="1" required="False" valueSpaceRef="/ValueSpace/Bandwidth"/> <Restrict item="1" required="False" valueSpaceRef="/ValueSpace/OnOff"/> <NetProfile item="1" required="False" valu...
Page 16 - getxml
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 and receiving (transceiving) information encoded in XML format. The API uses HTTP(S) as the transport mechanism and connects to the normal web port (80). T...
Page 17 - Exercise 1; Exercise 3
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 Explorer. Some of the examples may however also apply to other systems and other browsers. NOTE! Replace the ip address, 10.47.8.41, in the below examples wi...
Page 23 - Example 2.3
TANDBERG MPS API User Guide 21 2.2 The Status-type root commands – xstatus / xhistory The information accessible through these commands is the exact same information that is available in the corresponding XML documents. To get an overview of accessible top-level elements within a status-type root co...
Page 28 - Example 2.10
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 root command, type ? or help after the command-type root command. <command-type root command> ? Example 2.10 xcommand ? - User Commands - Boot DuoVide...
Page 29 - Markup notation
TANDBERG MPS API User Guide 27 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 paramet...
Page 30 - Sequence notation
TANDBERG MPS API User Guide 28 Sequence notation <command-type root command> <command> <value> <value>... When using this notation the parameter values must be entered in the sequence as stated in the help text: Example 2.16 xcommand dial 666 10 128 on Combination A combinati...
Page 32 - Special Commands
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 only applies to the Telnet session or RS232 session from where they are issued. This lets the user/control application individually configure the session(s)...
Page 34 - xcom disc
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=NA, direction=NA): *s/end When conditional XPath expressions are used, the system will provide feedback on all elements within the address the first time th...
Page 36 - xstat call 1 channels 1 audio
TANDBERG MPS API User Guide 34 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, on...
Page 38 - API - Configurations
TANDBERG MPS API User Guide 36 3 API - Configurations This section gives an overview of the Configuration Information available in the Configuration XML documents ( configuration.xml / directory.xml ) and the Configuration root commands ( xconfiguration / xdirectory ) of the XACLI interface. All exa...
Page 39 - Conference
TANDBERG MPS API User Guide 37 3.1 configuration.xml – xconfiguration AllowIncomingTlphCall AllowIncomingTlphCall: <On/Off> Conference Conference [1..35] Numbers E164Alias: <E164: 0, 31> Conference [1..35] Numbers PRI: <S: 0, 60> Conference [1..35] Numbers H323ID: <S: 0, 50> ...
Page 41 - Ethernet
TANDBERG MPS API User Guide 39 <Off/Normal/High> ConferenceTemplate [1..10] OptimalVideoQuality: <On/Off> ConferenceTemplate [1..10] EncoderSelectionPolicy: <BestBitRate/BestVideoStandard/BestResolution> ConferenceTemplate [1..10] BandwidthManagement: <Manual/Auto> Conference...
Page 42 - HTTP
TANDBERG MPS API User Guide 40 H323Gatekeeper [1..2] Authentication Password: <S: 0, 50> HTTP HTTP Mode: <On/Off> HTTPS HTTPS Mode: <On/Off> IPProtocol IPProtocol: <IPv4/IPv6/Both> IP IP [1..2] Address: <S: 0, 15> IP [1..2] SubnetMask: <S: 0, 15> IP [1..2] Gateway...
Page 43 - LoS
TANDBERG MPS API User Guide 41 ISDNInterfaceCard [1..6] ISDN PRI Interface [1..8] MaxChannels: <1..30> ISDNInterfaceCard [1..6] ISDN PRI Interface [1..8] HighChannel: <1..31> ISDNInterfaceCard [1..6] ISDN PRI Interface [1..8] LowChannel: <1..31> ISDNInterfaceCard [1..6] ISDN PRI In...
Page 45 - RTP
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 Audio: <0/1/2/3/4/5/6/7/Auto/Off> QoS [1..2] Precedence VideoTelephony Signalling: <0/1/2/3/4/5/6/7/Auto/Off> QoS [1..2] Precedence VideoTeleph...
Page 47 - Telnet
TANDBERG MPS API User Guide 45 DefaultIpConference: <0..15> TerminalSyncLossTimer: <5..90> GatekeeperAdhocString: <S: 0, 10> TrafficShaping: <On/Off> OutbandDTMF: <On/Off> LanguageAdmin: <S: 0, 3> LanguageGraphic: <S: 0, 3> DefaultConferenceTemplate: <1.....
Page 48 - LocalEntry
TANDBERG MPS API User Guide 46 3.2 directory.xml – xdirectory LocalEntry LocalEntry [1..250] Name: <S: 0, 48> LocalEntry [1.. 250] Number: <S: 0, 60> LocalEntry [1.. 250] SecondNumber: <S: 0, 60> LocalEntry [1.. 250] SubAddress: <S: 0, 60> LocalEntry [1.. 250] CallRate: <1...
Page 53 - ConferenceRedefine
TANDBERG MPS API User Guide 51 • EntryExitTones: <On/Off> • LegacyLevel: <0..15> • TelephoneFilter: <On/Off> • FloorToFull: <On/Off> • BandwidthThreshold: <64/128/192/256/320/384/512/768/1152/1472/1920> • WebCallListTimeout: <On/Off> • PhoneIndication: <On/Off&...
Page 66 - Top level attributes:
TANDBERG MPS API User Guide 64 5.1 status.xml – xstatus Call [1..160] Top level attributes: • conferenceRef: 1..9 • direction: Incoming/Outgoing • logTag: 1… Unique number identifying the call. This tag can be used to track the call in the call log ( history.xml / xhistory ). • protocol: H320/H323 •...
Page 73 - Example
TANDBERG MPS API User Guide 71 Example *s MediaBoard 1: TemperatureCelcius: 30 TemperatureFahrenheit: 86 Description: "" IP: Address: "10.47.9.106" SubnetMask: "255.255.248.0" Gateway: "10.47.8.1" V6: Address 1 (type=NA): "" Address 2 (type=NA): "" Eth...
Page 77 - ExternalManager
TANDBERG MPS API User Guide 75 State: RedAlarm *s/end ExternalManager *s ExternalManager: Address: "10.47.1.10" Protocol: URL: "tms/public/external/management/SystemManagementService.asmx" *s/end NTP *s NTP: Address: "127.0.0.1" *s/end SIP *s SIP: Mode: On Interface: Server (...
Page 78 - SystemLoad
TANDBERG MPS API User Guide 76 URI: "" Registration 21 (status=Inactive): URI: "" Registration 22 (status=Inactive): URI: "" Registration 23 (status=Inactive): URI: "" Registration 24 (status=Inactive): URI: "" Registration 25 (status=Inactive): URI: ""...
Page 79 - Options
TANDBERG MPS API User Guide 77 Options *s Options: Option 1: Key: "****" Description: "40 video telephony ports + 16 telephony ports." Option 2: Key: "****" Description: "Advanced Video Option on 40 sites." Option 3: Key: "****" Description: "Encryption on...
Page 82 - AuthenticationFailure
TANDBERG MPS API User Guide 80 5.3 Event.xml – xevent AuthenticationFailure *e AuthenticationFailure: Service: / RemoteIPAddress: / Uptime: / *e/end CallFURErrorAlert *e CallFURErrorAlert: FURAlert: / Rate: / CallRef: / LogTag: / ConferenceRef: / ConferenceLogTag: / *e/end CallMovedFromReception *e ...
Page 83 - CallSuccessful
TANDBERG MPS API User Guide 81 Incoming: Audio: TotalPackets: / PacketLoss: / PacketsDropped: / MaxJitter: / Video: TotalPackets: / PacketLoss: / PacketsDropped: / MaxJitter: / *e/end CallSuccessful *e CallSuccessful: CallRef: / LogTag: / ConferenceRef: / ConferenceLogTag: / ServiceType: / Protocol:...
Page 84 - SystemActivity
TANDBERG MPS API User Guide 82 *e/end H320Statistics *e H320Statistics: CallRef: / LogTag: / ConferenceRef: / ConferenceLogTag: / Duration: / FramingLoss: Last: / Total: / BondingReSync: Last: / Total: / *e/end SystemActivity *e SystemActivity: Service: / RemoteIPAddress: / Uptime: / Description: / ...