TANDBERG D14172.01 manual Introduction to Tandberg XML API Service Txas, Bare-bone Https access

Page 14

TANDBERG Gatekeeper/Border Controller API User Guide

1.5Introduction to TANDBERG XML API Service (TXAS)

TXAS is a service provided by TANDBERG units for transmitting and receiving 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 URLs uniquely identify the request, and

SOAP, where a single URI is used but the request itself is encoded with XML.

1.5.1 Bare-bone HTTP(S) access

The bare-bone HTTP(S) mode uses a unique URL to identify the specific request. The contents of the HTTP body will be a XML document (or part of it).

Bare-bone HTTP(S) access is accomplished by passing arguments in the query string (after '?' in a URI) in a GET request, or using the "application/x-www-form-urlencoded" content-type method of POSTing form data.

getxml

Request URI:

/getxml

 

 

Request parameter:

location = XPath expression

 

 

The getxml request returns an XML document based on the location parameter passed to the request. The elements (or complete document) matching the expression will be returned.

If an invalid XPath expression is supplied, a <Fault> element with a <XPathError> element will be returned.

Example 1.15

Using the Unix curl command, the up time of a system can be retrieved from the Status document:

curl –k –u admin:<password> \ https://10.0.0.1/getxml?location=Status/SystemUnit/Uptime

<?xml version="1.0"?> <Status>

<SystemUnit item="1">

<Uptime item="1">604800</Uptime> </SystemUnit>

</Status>

formputxml

Request URI:

/formputxml

 

 

Request parameter:

xmldoc = "an XML document of Configuration or a Command"

 

 

This is most useful in a POST (to extend character limit of 255 of GET urls). It posts a Configuration or Command document to set some configuration values or issue a command.

D14172.01

page 14 of 84

Image 14
Contents Tandberg Table of Contents Tandberg API Introduction to XML Mode item=1On/ModeConfiguration Status NTP item=1 status=Inactive/ /StatusNTP Status Domain item=1 DNS ConfigurationStatus Server item=2Configuration/IP/DNS/Server2/Address Configuration/SNMPConfiguration/SNMP/CommunityName Configuration/IP/DNS/Server/AddressStatus/Zones/Zone@status=Failed/Name Status/Registrations/Registration/Aliases/AliasStatus//Alias Structuring of Information Addressing using XPathTandberg XML Engine FeedbackStatus Documents r XML DocumentsDocuments Gatekeeper item=1 status=Failed Configuration documents rwStatus Zones item=1 Zone item=2 status=Failed Bandwidth Zone Zones Status Zones item=1Command documents w EthernetSpeed ValueSpaceCommand Dial item=1 Dial CommandCommand DialResult item=1 status=OK SystemUnit item=1 Introduction to Tandberg XML API Service TxasBare-bone Https access Success Configuration DialResult Command$client-Dial arraycallSrc = Alice, callDst = Bob ? Soap?php SetConfiguration GetConfigurationGetConfigurationXML SetConfigurationXMLExample Exercises ExerciseSystemContactAdministrator/SystemContact Snmp NTPAddressing Accessing XacliRoot commands ElemName item elemName itemZones Zone 1 status=Active Root command address expression exposure optionExposure options Misc Zones Zone 1 status=Active *s/endStatus-type root commands xstatus / xhistory LastUpdate 2008-01-01 LastCorrection 1 *s/end FormatConfiguration-type root commands xconfiguration Configuration helpConfiguration-type root command address expr Configuration readConfiguration set write Configuration-type root command address expr valueIp address Ip/address Command root command ?? Command-type root commands xcommandCommand-type root command ? Xcommand dial ??Command-type root command command name ? Command helpIssuing a command Xcommand dial Bandwidth384 callDstbob callSrcaliceXcommand dial alice B384 bob Command-type root command command value valueXcommand dial alice bob XML Output xgetxml Xgetxml status/ntp StatusAliases Special CommandsXfeedback Zones Zone 1 status=Failed Cause No gatekeeper reachable Alias 2 type=E164, origin=EndpointXfeedback register status/zones/zone@status=Failed Xpreferences Snmp SystemContact AdministratorSystemContact item=1Administrator/SystemContact Xcommand dial alice bob Command DialResult item=1 status=OK Xpreferences xmlstatusfeedback on/offSystemUnit Name S 0 Configuration.xml xconfigurationSystemUnit Password S 0 Option 1..64 Key S 0Session TimeOut Ldap Password S 0Snmp Mode On/Off Telnet Mode On/OffHttps Mode On/Off SSH Mode On/OffHttp Mode On/Off ExternalManager Address S 0Gatekeeper Policy Mode On/Off Gatekeeper DNSResolution Mode On/OffGatekeeper Enum Mode On/Off Gatekeeper ForwardLocationRequests On/OffGatekeeper Unregistered Caller Mode On/Off Gatekeeper Downspeed PerCall Mode On/OffGatekeeper Downspeed Total Mode On/Off Gatekeeper Unregistered Caller Fallback S 0Authentication Mode On/Off Traversal AssentEnabled On/OffTraversal H46018Enabled On/Off Authentication UserName S 0Authentication Ldap AliasOrigin LDAP/Endpoint/Combined Authentication Database LocalDatabase/LDAPDatabaseAuthentication Ldap BaseDN S 0 Authentication Credential 1..2500 Name S 0Zones TraversalZone 1..50 Name S 1 Zones TraversalZone 1..50 Mode Assent/H46018Zones Zone 1..100 Match 1..5 Pattern Replace S 0 Zones TraversalZone 1..50 AccountName S 0SubZones DefaultSubZone Bandwidth PerCall Intra Limit SubZones DefaultSubZone Bandwidth Total LimitSubZones DefaultSubZone Bandwidth PerCall Inter Limit Zones TraversalZone 1..50 Match 1..5 Pattern Replace S 0SubZones SubZone 1..100 Bandwidth Total Limit SubZones TraversalSubZone Bandwidth PerCall LimitSubZones SubZone 1..100 Name S 1 SubZones SubZone 1..100 Bandwidth PerCall Inter LimitServices AdHocConferencing ID S 3 Services CallTransfer Mode On/OffServices AdHocConferencing Mode On/Off Services AdHocConferencing Prefix S 0API Commands Command.xml xcommandAdds an entry to the Deny List Patternr S 1 Deletes a link LinkIdr Index of the link to be deleted Deletes a pipe PipeIdr Index of the pipe to be deleted SubZoneAdd SubZoneDelete Tandberg Gatekeeper/Border Controller API User Guide Tandberg Gatekeeper/Border Controller API User Guide ZoneAdd Tandberg Gatekeeper/Border Controller API User Guide Tandberg Gatekeeper/Border Controller API User Guide ZoneDelete Status.xml xstatus SystemUnitOptions EthernetIP DNS Server 1..5 Address String NTP LastUpdate StringIP IPv6 Gateway IPv4Addr IP DNS Domain Name IPv4AddrExternalManager ResourceUsageGatekeeper CallsCalls Call 1..900 Leg 1..2 Alias String Calls Call 1..900 Leg 1..2 RegistrationID StringCalls Call 1..900 Leg 1..2 SerialNumber String Calls Call 1..900 Leg 1..2 Address StringRegistrations Zones Zones Zone 1..50 status = Warning/Active/Failed Zones TraversalZone 1..50 Bandwidth PerCall StringZones TraversalZone 1..50 Bandwidth Used String Zones Zone 1..50 Cause StringSubzones Links PipesHistory.xml xhistory Registrations Registration 1..255 Gateway Registrations Registration 1..255 EndpointRegistrations Registration 1..255 Gatekeeper Registrations Registration 1..255 MCUTandberg Gatekeeper/Border Controller API User Guide Event.xml xevent CallAttemptConnected Disconnected ConnectionFailure Registration Unregistration RegistrationFailure RegistrationFailure Registration 1..3750 StartTime String RegistrationFailure Registration 1..3750 MCURegistrationFailure Registration 1..3750 SubZone String RegistrationFailure Registration 1..3750 EndTime StringBandwidth Locate ResourceUsage

D14172.01 specifications

The TANDBERG D14172.01 is a sophisticated video conferencing solution designed to enhance communication for businesses and organizations. Renowned for its reliability and advanced features, the D14172.01 facilitates seamless interactions across different locations, promoting effective collaboration among teams.

One of the main features of the TANDBERG D14172.01 is its exceptional video quality. With high-definition resolution, it delivers crystal-clear visuals, making virtual meetings feel more personal and engaging. The system supports a wide range of codecs, ensuring compatibility with various devices and platforms, thereby streamlining the integration process into existing communication setups.

Another significant characteristic of the D14172.01 is its user-friendly interface. Designed with simplicity in mind, it allows users to initiate and manage video calls effortlessly. The intuitive controls enable both tech-savvy individuals and those less familiar with technology to navigate the system with ease, reducing the learning curve and enhancing user adoption.

The inclusion of advanced audio technologies further elevates the user experience. With noise suppression features and high-fidelity microphones, the TANDBERG D14172.01 ensures that participants can hear and be heard clearly, minimizing disruptions and allowing for more productive conversations. This feature is particularly beneficial in larger meeting rooms where background noise can be a concern.

Flexibility is another hallmark of the D14172.01. It supports multiple connectivity options, including Wi-Fi, Ethernet, and Bluetooth, enabling users to connect from virtually anywhere. This versatility is essential in today’s hybrid work environments, where team members may be working remotely or on-the-go.

Importantly, the system boasts robust security features, safeguarding sensitive information exchanged during video conferences. With encryption protocols and secure access controls, organizations can confidently communicate without the fear of privacy breaches.

In summary, the TANDBERG D14172.01 stands out in the realm of video conferencing solutions due to its high-definition video quality, user-friendly interface, advanced audio technologies, connectivity options, and strong security measures. These features make it an invaluable tool for businesses seeking to enhance their communication capabilities and foster greater collaboration among their teams, regardless of geographical barriers. With the D14172.01, organizations can significantly improve their virtual meeting experiences, driving productivity and innovation in an increasingly digital world.