TANDBERG MPS API User Guide TANDBERG D13639 Rev 07 March 2008
TANDBERG MPS API User Guide Table of Contents User Guide................................................................................................................................. 1 1 The TANDBERG API.............................................................................................................. 1 1.1 Introduction to XML.......................................................................................................... 2 1.2 Introduction to XML Path Language (XPath) ..............
TANDBERG MPS API User Guide 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 transmitted, in any form, or by any means, electronically, mechanically, by photocopying, or otherwise, without the prior written permission of TANDBERG.
TANDBERG MPS API User Guide 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 endtag. The end-tag has the same name as the tag, but is prefixed with a slash, “/”. All tags are put within angular brackets (“< >”). Example 1.1 Below is an example of how configurations of a Serial Port could be represented using XML.
TANDBERG MPS API User Guide Example 1.3 If we now look at the call element for an active call we see that call element contains a large sub-structure: 768 10.47.15.
TANDBERG MPS API User Guide 1 Auto 4
TANDBERG MPS API User Guide 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 element in a XML structure. Example 1.5 Let us go back to the serial port configurations of Example 1.1.
TANDBERG MPS API User Guide Example 1.8 XPath also supports addressing by putting constraints on element attributes. Let’s go back to the Call element in Example 1.2. The below expression will address the CallRate element of all Synced calls in a system: Status/Call[@status=”Synced”]/CallRate To add more constraints on element attributes, XPath supports boolean expressions.
TANDBERG MPS API User Guide 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 • Feedback 1.3.1 Structuring of Information An application programming interface can be seen as a gate where information is exchanged between two systems - a control application and a target system.
TANDBERG MPS API User Guide configuration hierarchies it wants to monitor by using XPath. The user/control application can therefore limit the amount of information it receives from the target system to only those parts being of interest for the given application.
TANDBERG MPS API User Guide 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): Documents holding all available Status Information in the system. Supported documents: a. status.xml b. history.xml 2. Configuration documents (rw): Documents holding all system configurations. Supported documents: a.
TANDBERG MPS API User Guide 10.47.8.41:2326 AES-128 Off 0 64 367 0 0 . . .
TANDBERG MPS API User Guide 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. > 9600 . . . .
TANDBERG MPS API User Guide To issue a command, the command structure is posted back to the system together with values for the various parameters. Optional parameters can be omitted when posting the structure back to the system.
TANDBERG MPS API User Guide Example 14 Below is an example of the Dial command, not being accepted by the system: 17 Too much bandwidth requested 13
TANDBERG MPS API User Guide 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). TXAS can be accessed in two ways; bare-bone HTTP requests where URL’s uniquely identifies the request, and SOAP where a single URI is used but the request itself is encoded with XML. 1.5.
TANDBERG MPS API User Guide 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 with the ip address of your system. Exercise 1 The example in this exercise shows how to read the supported XML documents from the system using a web browser.
TANDBERG MPS API User Guide 2400 Off Off -- 10.47.8.
TANDBERG MPS API User Guide 2 The XML-based Advanced Command Line Interface The XML-based Advanced Command Line Interface, XACLI, is a very flexible interface both optimized for machine-machine interaction and man-machine interaction. It is based on the powerful TANDBERG XML engine and offers many of the same features as the TANDBERG XML interface. The main distinction between XACLI and the TANDBERG XML interface is the input format.
TANDBERG MPS API User Guide 2.1 XACLI 2.1.1 Accessing XACLI XACLI can be accessed through Telnet via the LAN interface or through RS-232 by connecting a serial cable to the serial interface connector, referred to as the Dataport. 48 Telnet sessions can be active at the same time in addition to the RS-232 connection. 2.1.2 Root commands For each of the XML documents supported by the system, there is a corresponding XACLI root command.
TANDBERG MPS API User Guide 2.1.4 Exposure options By adding an exposure option after the address (XPath or SimplePath) expression, the system can be instructed to return only parts of the information within an element structure. Supported exposure options: • • “-“ hides all value elements “--" hides all sub-elements Example 2.
TANDBERG MPS API User Guide Audio (status=Active): Video 1 (status=Active): Video 2 (status=Inactive): / Data (status=Inactive): / Channels 2 (type=Outgoing): Encryption (status=Off): / Audio (status=Active): Video 1 (status=Active): Video 2 (status=Inactive): / Data (status=Inactive): / *s/end Request for Call 1 element with exposure option “--“: xstatus call 1 -*s Call 1 (status=Synced, type=Vtlph, protocol=H323, direction=Outgoing): *s/end 2.1.5 Misc The XACLI interface is not case sensitive.
TANDBERG MPS API User Guide 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 command, type ? or help after the status-type root command. Example 2.3 xstatus ? - Status Call [1..188] Conference [1..40] Ethernet ExternalManager Feedback [1..3] GatewayCall [1..
TANDBERG MPS API User Guide o o o XACLI is using indent spaces to present the data structure XACLI hides instance number (item number in XML) of an element if there only exist one instance of a given element A status top level element starts with “*s” Example 2.5 shows XML formatting and XACLI formatting for the same status element, IP. Example 2.5 XML: 10.47.8.20 255.255.248.0 10.47.8.
TANDBERG MPS API User Guide 2.3 The Configuration-type root commands xconfiguration/xdirectory 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 configuration elements, type ? or help after the configuration-type root command: ? Example 2.6 xconfiguration ? - User Configurations - AllowIncomingTlphCall AllowNTSCCP HTTPS IP [1..2] Conference [1.
TANDBERG MPS API User Guide ?/help Example 2.7 User wants to configure IP: xconfiguration ip ? *h xConfiguration IP *h xConfiguration IP *h xConfiguration IP *h xConfiguration IP Assignment: Address: SubnetMask: Gateway: NOTE! Only typing xconfiguration ?, actually addresses all configuration elements within the xconfiguration root command.
TANDBERG MPS API User Guide Example 2.
TANDBERG MPS API User Guide 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. ? Example 2.
TANDBERG MPS API User Guide Example 2.12 xcommand Dial ? *h xCommand Dial Number(r): SubAddress: CallRate: <1xh221/2xh221/64/128/256... Restrict: 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.
TANDBERG MPS API User Guide Sequence notation ... 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 combination of mark-up notation and sequence are also supported.
TANDBERG MPS API User Guide 2.5 XML Output - xgetxml As an alternative to the standard XACLI output format, XML format is supported through the root command xgetxml. xgetxml takes an XPath expression as parameter and the elements (or complete document) matching the expression will be returned. Example 2.19 xgetxml status/ip 10.47.8.20 255.255.248.0 10.47.8.
TANDBERG MPS API User Guide 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) in use. Supported special commands: • xfeedback (not supported on all platforms) • xpreferences 2.6.
TANDBERG MPS API User Guide Example 2.21 Exposure options are also supported together with feedback. User only wants to monitor call setup progression. xfeedback register status/call-OK xcom dial 10.47.15.
TANDBERG MPS API User Guide *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 the condition is true. Example 2.23 User wants to monitor call changes only when the call is in Synced state.
TANDBERG MPS API User Guide Rate: 768 Restrict: Off Encryption (status=Off): / Audio (status=Active): Protocol: G722 Rate: 64 Video 1 (status=Active): Protocol: H263+ Resolution: ICIF Rate: 704 Video 2 (status=Inactive): / Data (status=Inactive): / *s/end …suddenly there is a change in audio protocol: *s Call 1 (status=Synced, type=Vtlph, protocol=H323, direction=Outgoing): Channels 1 (type=Incoming): Rate: 704 Audio (status=Inactive): / *s/end *s Call 1 (status=Synced, type=Vtlph, protocol=H323, directio
TANDBERG MPS API User Guide 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, only the information elements with a detail level equal to or less than the detaillevel defined for the interface will be listed. Example 2.
TANDBERG MPS API User Guide 2400 xpreferences xmlstatusfeedback If xmlstatusfeedback is set to on, all status feedback will be returned in XML-format instead of the standard XACLI status format. Example 2.
TANDBERG MPS API User Guide 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 examples are presented using the standard XACLI format.
TANDBERG MPS API User Guide 3.1 configuration.xml – xconfiguration AllowIncomingTlphCall AllowIncomingTlphCall: Conference Conference [1..35] Numbers E164Alias: Conference [1..35] Numbers PRI: Conference [1..35] Numbers H323ID: Conference [1..35] Numbers SIP URI: ConferenceTemplate ConferenceTemplate [1..10] Name: ConferenceTemplate [1..
TANDBERG MPS API User Guide ConferenceTemplate [1..10] EntryExitTones: ConferenceTemplate [1..10] WelcomeMessage: ConferenceTemplate [1..10] LegacyLevel: <0..15> ConferenceTemplate [1..10] DuoVideo: ConferenceTemplate [1..10] AudioG728: ConferenceTemplate [1..10] CascadingPreference: ConferenceTemplate [1..10] BillingCode: ConferenceTemplate [1..10] CPAutoSwitch: <0..60> ConferenceTemplate [1..
TANDBERG MPS API User Guide ConferenceTemplate [1..10] OptimalVideoQuality: ConferenceTemplate [1..10] EncoderSelectionPolicy: ConferenceTemplate [1..10] BandwidthManagement: ConferenceTemplate [1..10] WebSnapshots: ConferenceTemplate [1..10] AutoAspectRatio4x3: Ethernet Ethernet [1..
TANDBERG MPS API User Guide H323Gatekeeper [1..2] Authentication Password: HTTP HTTP Mode: HTTPS HTTPS Mode: IPProtocol IPProtocol: IP IP [1..2] Address: IP [1..2] SubnetMask: IP [1..2] Gateway: IP [1..2] DNS Server [1..5] Address: IP [1..2] DNS Domain Name: IP [1..2] Description: ISDNInterfaceCard ISDNInterfaceCard [1..6] NetType: ISDNInterfaceCard [1..
TANDBERG MPS API User Guide 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 Interface [1..8] Search: ISDNInterfaceCard [1..6] ISDN PRI Interface [1..8] NumberRangeStart: ISDNInterfaceCard [1..6] ISDN PRI Interface [1..8] NumberRangeStop: ISDNInterfaceCard [1..
TANDBERG MPS API User Guide LoS Polarity: LoS Retry: <0..65535> MCU MCU AdditiveRegEnable: MCU H264: MCU H264RCDO: MediaBoard MediaBoard [1..12] IP Address: MediaBoard [1..12] IP SubnetMask: MediaBoard [1..12] IP Gateway: MediaBoard [1..12] IP NetworkId: <1..2> MediaBoard [1..12] Ethernet Speed: MediaBoard [1..12] Description: NetProfile NetProfile [1..
TANDBERG MPS API User Guide 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 VideoTelephony Video: <0/1/2/3/4/5/6/7/Auto/Off> QoS [1..2] Precedence VideoTelephony Data: <0/1/2/3/4/5/6/7/Auto/Off> QoS [1..2] Diffserv Telephony Audio: <0..63> QoS [1..2] Diffserv Telephony Signalling: <0..63> QoS [1..
TANDBERG MPS API User Guide SingleNumberDialIn SingleNumberDialIn Active: SingleNumberDialIn Numbers ISDN: SingleNumberDialIn Numbers IP: SingleNumberDialIn Numbers H323Alias: SingleNumberDialIn Numbers H323ID: SingleNumberDialIn Numbers SIP: SingleNumberDialIn Password: SingleNumberDialIn NumberOfLoginTries: <1..10> SingleNumberDialIn WaitingRoomTimer: <1..
TANDBERG MPS API User Guide DefaultIpConference: <0..15> TerminalSyncLossTimer: <5..90> GatekeeperAdhocString: TrafficShaping: OutbandDTMF: LanguageAdmin: LanguageGraphic: DefaultConferenceTemplate: <1..10> Telnet Telnet Mode: * The Gateway LoadLimit command will not be available if 1) MPS doesn't have GW option; 2) MPS have MCU and GW option.
TANDBERG MPS API User Guide 3.2 directory.xml – xdirectory LocalEntry LocalEntry [1..250] Name: LocalEntry [1.. 250] Number: LocalEntry [1.. 250] SecondNumber: LocalEntry [1.. 250] SubAddress: LocalEntry [1.. 250] CallRate: <1xh221/2xh221/64/128/192/256/320/384/512/768/1152/1472/1920/Tlph/H0/ Max/Auto> LocalEntry [1.. 250] Restrict: LocalEntry [1.. 250] NetProfile: <1..7> LocalEntry [1.. 250] NetworkId: <1..32> LocalEntry [1.. 250] NetworkModule: <0..
TANDBERG MPS API User Guide 4 API - Commands This section gives an overview of the supported system Commands. All examples are presented using the standard XACLI format.
TANDBERG MPS API User Guide 4.1 command.xml – xcommand Boot Command used to reboot the system. Parameters: None 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 boot *r Result (status=OK): *r/end OK CallFURBlock Command used to block Fast updates to a call Parameters: • Call(r): <1..
TANDBERG MPS API User Guide • • Cause: <1…> Cause code specifying why the command was not accepted by the system Description Textual description of the cause code. Example: xcommand callmute call:2 mode:on *r Result (status=OK): *r/end OK CallMuteOutgoing Command used to mute outgoing audio from a specific call. Parameters: • Call(r): <1..128> Reference to the call to be muted or unmuted. • Mode(r): Denotes whether the call is to be muted or unmuted.
TANDBERG MPS API User Guide CallMuteVideo Command used to mute incoming video from a specific call. Parameters: • Call(r): <1..128> Reference to the call to be muted or unmuted. • Mode(r): Denotes whether video is to be muted or unmuted. 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.
TANDBERG MPS API User Guide • EntryExitTones: • LegacyLevel: <0..15> • TelephoneFilter: • FloorToFull: • BandwidthThreshold: <64/128/192/256/320/384/512/768/1152/1472/1920> • WebCallListTimeout: • PhoneIndication: • SpeakerIndication: • VideoText: • VideoTextTimeout: <0..
TANDBERG MPS API User Guide • • • • • • • • • AudioG728: CascadingPreference: BillingCode: CPAutoSwitch: <0..60> NetworkId: <1..32> ConferenceSelfview: Protect: TemplateReference: <1..10> HDEnabled: 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.
TANDBERG MPS API User Guide • Description Textual description of the cause code. Example: xcommand conferencestart conference:1 *r Result (status=OK): *r/end OK ConferenceStop Command used to stop a conference. All active calls must be disconnected prior to stopping the conference. Parameters: • Conference(r): <1..35> 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.
TANDBERG MPS API User Guide *r/end OK DefaultValuesSet Command used to reset configurations to default values. Parameters: • Level: <1..3> Configurations are divided into three different storage classes. The level parameter denotes that configurations on this level and all levels below are to be reset. 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.
TANDBERG MPS API User Guide OK DialGroupEntry Command used to dial an entry from the Group Directory. Dialing from the Group Directory makes it possible to set up a MultiSite conference in one operation. Parameters: • Conference(r): <1..35> • GroupEntryId(r): <1..16> Reference to the directory entry to be dialed. OK Result parameters: The system will return the following elements for each call initiated. • CallRef: <1..96> Reference to the call. To be used as reference when monitoring the call.
TANDBERG MPS API User Guide • • DialLocalEntry Cause: <1…> Cause code specifying why the call was not accepted by the system Description Textual description of the cause code. Command used to dial a number from the locally stored directory. Parameters: • Conference(r): <1..35> • LocalEntryId(r): <1..99> Reference to the directory entry to be dialed. OK Result parameters: • CallRef: <1..96> Reference to the call. To be used as reference when monitoring the call. • LogTag: <1…> Unique reference to call.
TANDBERG MPS API User Guide • accepted by the system Description Textual description of the cause code. Example: xcommand disconnectgwcall gatewaycall:1 *r Result (status=OK): *r/end OK FeedbackDeregister Command used to deregister XML feedback over HTTP(S). Parameters: • ID: <1..3> ID for the registration to deregister. OK Result parameters: • ID: <1..
TANDBERG MPS API User Guide *r/end OK FloorToSite Command used to assign floor to a specific site in a conference. Parameters: • Conference(r): <1..35> • MCUID(r): <1..191> MCUID to the MultiSite the site is connected to. • TerminalID(r): <1..191> The site’s terminal id, referenced to the MultiSite it is connected to. 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.
TANDBERG MPS API User Guide • GroupEntryId: <1..16> Reference to the Group Directory position the entry is stored. 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 groupentryadd name:”The Team” localentryid.1:17 localentryid.2:29 localentryid.
TANDBERG MPS API User Guide • • Window(r): <1..16> CallID(r): <1..176> Call. ERROR Result parameters: • Cause: <1…> Cause code specifying why the command was not accepted by the system • Description Textual description of the cause code. LocalEntryAdd Command used to add a new entry to the locally stored Directory. The entry is stored in the first vacant position in the Directory. Parameters: • Name: The entry’s name. • Number: The entry’s number.
TANDBERG MPS API User Guide *r Result (status=OK): *r/end OK OptionKeyAdd Command used to add option key. Parameters: • Key(r): Option key string 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. OptionKeyDelete Command used to remove option key. Parameters: • OptionKeyId(r): <1..
TANDBERG MPS API User Guide ProtectNumberRemove Command used to remove a protect number. Parameters: • Conference(r): <1..15> Conference to remove number • NetProfile(r): <2..7> Net Profile to remove • Number(r): Number to remove 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. VideoTextSet Command used to set video text for a call.
TANDBERG MPS API User Guide 5 API - Status This section gives an overview of the Status Information available in the Status XML documents (status.xml / history.xml) and the Status root commands (xstatus / xhistory) of the XACLI interface. All examples are presented using the standard XACLI format.
TANDBERG MPS API User Guide 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).
TANDBERG MPS API User Guide LocalIPAddress: "10.47.9.150:2344" Encryption (status=Off): / RSVP: Off RSVPRate: 0 DynamicRate: 157 TotalPackets: 476674 PacketLoss: 1 Jitter: 10 Video 2 (status=Active): Protocol: H263+ Resolution: XGA Rate: 160 RemoteIPAddress: "" LocalIPAddress: "10.47.9.
TANDBERG MPS API User Guide Conference [1..
TANDBERG MPS API User Guide FarTlphEchoSupression: Normal NetErrorHandling: None IPLRRobustMode: Auto FURBlockSites: Auto FURFilterInterval: 3 HDEnabled: Off VoiceSwitchTimeout: 2 OptimalVideoQuality: On/Off EncoderSelectionPolicy: BestBitRate/BestVideoStandard BandwidthManagement: Auto/Manual WebSnapshots: On/Off AutoAspectRatio4x3: Off *s/end *s Conference 1 (status=Active): Calls: CallRef 1: 1 CallRef 2: 2 CallRef 3: 3 DuoVideo (status=Off): / Floor: None Current: CallRef: 3 Previous: CallRef: 2 Outgoing
TANDBERG MPS API User Guide Picture: NA CallRef: None Window 6: Picture: NA CallRef: None OutgoingPicture 3 (name=Duo): Layout (type=NA): / PictureModeActual: Full MCUID: 1 CascadingMode: StandAlone MCUSiteList: Site 1: MCUID: 1 TerminalID: 2 Name: "System1" CallRef: 1 Site 2: MCUID: 1 TerminalID: 3 Name: "System2" CallRef: 2 Site 3: MCUID: 1 TerminalID: 4 Name: "System3" CallRef: 3 IPOnly: On FullySwitched: Off Dynamic: Off Hybrid: On Properties: Name: "TCS Test" CallRate: 384 Restrict: Off Password: "" Pa
TANDBERG MPS API User Guide PhoneIndication: On SpeakerIndication: On VideoText: On VideoTextTimeout: 5 ChairControl: Off LectureMode: Off Protect: Off VideoCodingMode: Transcoding SecondaryRate: Off FarTlphEchoSupression: Normal NetErrorHandling: None IPLRRobustMode: Auto FURBlockSites: Auto FURFilterInterval: 3 HDEnabled: Off VoiceSwitchTimeout: 2 *s/end Ethernet [1..
TANDBERG MPS API User Guide *s/end H323Gatekeeper [1..2] Top level attributes: • status:Required/Discovering/Discovered/Authenticating/ Authenticated/Registering/Registered/Rejected/Inactive Summary: • Returns H323Gatekeeper status Examples: *s H323Gatekeeper 1 (status=Inactive): / *s/end *s H323Gatekeeper 1 (status=Registered): Address: "10.47.9.1" Port: 1719 *s/end *s H323Gatekeeper 1 (status=Rejected): Address: "10.47.9.0" Port: 0 *s/end IP [1..
TANDBERG MPS API User Guide Example *s MediaBoard 1: TemperatureCelcius: 30 TemperatureFahrenheit: 86 Description: "" IP: Address: "10.47.9.106" SubnetMask: "255.255.248.0" Gateway: "10.47.8.
TANDBERG MPS API User Guide SerialNumber: "44a00003" MainBoard: "113637 MCP 820 System Controller" BootSoftware: "PPCBUG" Used: Total: Conference: 2 Telephony: 0 VideoTelephony: 1 BChanPRI: 0 Bandwidth: 384 Gateway: GatewayCall: 0 BChanPRI: 0 MCU: Conference: 2 Telephony: 0 VideoTelephony: 1 Bandwidth: 384 BChanPRI: 0 *s/end Top level attributes: SerialInterfaceCard • status: on/off Summary: • Returns information about the Serial interface card Example *s SerialInterfaceCard 1 (status=Off): Description: ""
TANDBERG MPS API User Guide Channels 22 (type=BChannel, status=Idle): / Channels 23 (type=BChannel, status=Idle): / Channels 24 (type=BChannel, status=Idle): / Channels 25 (type=BChannel, status=Idle): / Channels 26 (type=BChannel, status=Idle): / Channels 27 (type=BChannel, status=Idle): / Channels 28 (type=BChannel, status=Disconnected): CallingNumber: "098228199" CauseLocation: 0 ChannelCause: 16 ConnectionTime: 16 Channels 29 (type=BChannel, status=Disconnected): CallingNumber: "074859215" CauseLocation
TANDBERG MPS API User Guide CauseLocation: 2 ChannelCause: 17 ConnectionTime: 0 Channels 26 (type=BChannel, status=Disconnected): CallingNumber: "061336971" CauseLocation: 2 ChannelCause: 17 ConnectionTime: 0 Channels 27 (type=BChannel, status=Disconnected): CallingNumber: "061336971" CauseLocation: 2 ChannelCause: 17 ConnectionTime: 0 Channels 28 (type=BChannel, status=Disconnected): CallingNumber: "061336971" CauseLocation: 0 ChannelCause: 16 ConnectionTime: 0 Channels 29 (type=BChannel, status=Disconnect
TANDBERG MPS API User Guide State: RedAlarm *s/end ExternalManager NTP SIP *s ExternalManager: Address: "10.47.1.10" Protocol: URL: "tms/public/external/management/SystemManagementServ ice.asmx" *s/end *s NTP: Address: "127.0.0.1" *s/end *s SIP: Mode: On Interface: Server (status=Active): Address: "10.47.8.
TANDBERG MPS API User Guide URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" Registration URI: "" 21 (status=Inactive): 22 (status=Inactive): 23 (status=
TANDBERG MPS API User Guide 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 40 sites.
TANDBERG MPS API User Guide Option Option Option Option Option Option Option Option Option Option Option Option Option *s/end 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: / / / / / / / / / / / / / 78
TANDBERG MPS API User Guide 5.2 history.xml – xhistory Call [1..96] Top level attributes: • type: Tlph/Vtlph • protocol: H320/H323/SIP • direction: Incoming/Outgoing • PartOf: Conference/GatewayCall Summary: • Returns information about disconnected calls Examples: *l Call 1 (type=Vtlph, protocol=H323, direction=Outgoing, PartOf=Conference): LogTag: 4 ConferenceLogTag: 2 ConferenceRef: 1 RemoteNumber: "10.47.12.
TANDBERG MPS API User Guide 5.3 Event.
TANDBERG MPS API User Guide Incoming: Audio: TotalPackets: / PacketLoss: / PacketsDropped: / MaxJitter: / Video: TotalPackets: / PacketLoss: / PacketsDropped: / MaxJitter: / *e/end CallSuccessful *e CallSuccessful: CallRef: / LogTag: / ConferenceRef: / ConferenceLogTag: / ServiceType: / Protocol: / Direction: / CallRate: / RemoteNumber: / Encryption: Incoming: / Outgoing: / *e/end DialInError *e DialInError: IncomingNumber: / RemoteNumber: / *e/end DownspeedingFinished *e DownspeedingFinished: CallRef
TANDBERG MPS API User Guide *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: / *e/end 82
