Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide

API Overview

This chapter provides an overview of the basic principles of Cisco TMSBA.

Functional Overview

Cisco TMSBA makes it possible to let users book resources from custom booking applications (in this document 
referred to as "clients"), integrating the custom booking application with the Cisco TMS reservation database.

Using Cisco TMSBA to interact with Cisco TMS is the only safe and supported way of integrating third party or custom 
booking applications with Cisco TMS. The Cisco TMSBA is a versioned and stable interface into Cisco TMS, where 
backward compatibility is guaranteed in new releases.

Main Features

Cisco TMSBA has three main features:

 

■

Importing and/or displaying Cisco TMS-managed resources in a client or booking system external to Cisco TMS.

 

■

Reading and displaying system availability information and bookings from the reservation database of Cisco 
TMS. This information can be used for replicating bookings from Cisco TMS to the external booking system.

 

■

Forwarding booking requests made by an external booking system to Cisco TMS. Forwarding a booking request 
to Cisco TMS lets the client utilize the routing logic of Cisco TMS, which determines whether network resources 
like an Multipoint Control Unit (MCU) are required, and automatically reserves these resources. The client 
therefore does not need to worry about infrastructure resources such as gateways and MCU port availability.

Booking Ownership

The client can choose whether to authenticate with Cisco TMS as a service account or as the user actually making 
the booking. If authenticating as a service account, the client must explicitly specify the actual owner of the booking 
when performing the 

SaveConferenceWithMode

 function. If choosing this option, it is important that the service account 

is a member of a group having  Book on behalf of permissions in Cisco TMS.

IsTMSBookOnBehalfUser

 and 

IsBookonBehalfOfUser

 in the remote setup API can be used to assess whether a service 

account or other user has Book on behalf of permissions. The 

GenerateConferenceAPIUser

 function can be used for 

creating a service account. See 

.

Conference Routing

When booking through the Cisco TMSBA, clients book endpoints only. Network infrastructure products, such as 
gateways and Multipoint Control Units (MCUs) are automatically added by Cisco TMS if needed. The settings under 

 in Cisco TMS are used when routing 

conferences created through Cisco TMSBA.

Cisco Systems, Inc.

     www.cisco.com

4