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

Page of 53
Booking API reference
Cisco TMSBA Programming Reference Guide
Page 39 of 53
Booking API functions
This reference section describes all the available functions of the booking API.
DeleteConferenceById 
Deletes a conference with the given ConferenceId (as defined in Cisco TMS). If the conference is part of a 
recurring series, the whole series will be deleted.
Supported parameters:
ConferenceId
The ConferenceId of the conference to delete.
Returned data:
 Nothing.
If the provided ID does not exist, this will cause an error. See the section 
DeleteConferenceRecInstanceById 
Deletes an occurrence of a recurring conference with the given ConferenceId (as defined in Cisco TMS). This 
function is typically used when deleting a single meeting in a recurring series.
Supported parameters:
ConferenceId
The ConferenceId of the conference to delete.
Returned data:
 Nothing.
If the provided ID does not exist, this will cause an error. See the section 
EndConferenceById 
Ends an ongoing conference with the given ConferenceId (as defined in Cisco TMS). The conference will be 
set to Finished, and the end time will be set to the time of execution of the function. This function is typically 
used to end a running conference from a third party front-end GUI. The function will fail with an error if the 
conference has not yet started.
Supported parameters:
ConferenceId
The ConferenceId of the conference to delete.
Returned data:
 Nothing.
If the provided ID does not exist, this will cause an error. See the section 
GetConferenceById 
Get the available information about a particular conference.