Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide
Booking API Reference
The booking API lets you schedule conferences in Cisco TMS using a third-party client, and replicate existing
bookings between the two. This chapter is a reference to the conference object and to all available functions and
parameters.
bookings between the two. This chapter is a reference to the conference object and to all available functions and
parameters.
Conference Object
This object can be used to read and write:
■
Conference properties such as Start Time, End Time, Conference Title, and Conference Password.
■
Conference call-related values such as Bandwidth, Picture mode, and Encryption mode.
All conference resources, including video participants, audio participants, phone book participants, external
participants and so on, are held in this object, together with routing information for connecting the resources. You
also use the Conference object to define the conference type, that is, how the conference should be connected.
participants and so on, are held in this object, together with routing information for connecting the resources. You
also use the Conference object to define the conference type, that is, how the conference should be connected.
Conference data can be saved/updated, and handled by Cisco TMS using the
SaveConferenceWithMode
function
described below.
Conference
Attribute
Read/Write
Description
ConferenceId
r/w,
optional
optional
When using SaveConferenceWithMode:
■
Set to -1 to create a new conference using
GetDefaultConference.
GetDefaultConference.
■
Set to a value greater than 0 to update the existing
conference that has the given ID in the Cisco TMS
database.
conference that has the given ID in the Cisco TMS
database.
Title
r/w,
optional
optional
If no title is specified, the Cisco TMS default will be used. Title
values can not exceed 255 characters.
values can not exceed 255 characters.
StartTimeUTC
r/w,
required
required
The start and end times of the conference in UTC format.
Only UTC date-time groups ending with Z are supported.
Example: 1975-06-01 23:32:11Z.
Example: 1975-06-01 23:32:11Z.
EndTimeUTC
r/w,
required
required
Cisco Systems, Inc.
24