Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide
Booking API reference
Cisco TMS Extension Booking API Programming Reference Guide (13.0.1)
Page 23 of 33
ConferenceId
The ConferenceId of the conference to delete.
Returns nothing
GetConferenceById
Input
ConferenceId
The ID of the conference (Based on Cisco TMS IDs)
Returns a Conference object based on the ConferenceId.
GetRecordingAliases
Input
UserName
The user to retrieve recording alias for. If no UserName is provided (empty
string), the logged in user will be used.
string), the logged in user will be used.
Returns an array of RecordingDevice, where the key is the string representation of a recording device
name, or a recording cluster name. The value is an array of AliasInfo for that particular recording
device/cluster, holding an AliasId (string) and a SystemId (int) . The AliasId and SystemId can be used to
add a recording participant to a conference.
name, or a recording cluster name. The value is an array of AliasInfo for that particular recording
device/cluster, holding an AliasId (string) and a SystemId (int) . The AliasId and SystemId can be used to
add a recording participant to a conference.
GetConferenceForUser
This function returns all conferences owned by a particular user between two dates.
Input
UserName
The TMS user to get bookings for. If no user name is provided (empty string),
the logged in user is used
the logged in user is used
StartTime
The start date of bookings
EndTime
The end date of bookings
ConferenceStatus
An enumeration of what type of conferences that will be fetched from TMS. (All,
AllExceptDeleted, Pending, Ongoing, Finished, PendingAndOngoingm
MeetingRequest, Rejected, Finished or Deleted).
AllExceptDeleted, Pending, Ongoing, Finished, PendingAndOngoingm
MeetingRequest, Rejected, Finished or Deleted).
Returns an array with Conference objects.
GetConferenceIdByExternalId
Returns a ConferenceId (as defined in Cisco TMS) given an ExternalSourceId and ExternalConferenceId.
This function is used to look up conference that have been updated in the external source, and that must
be updated in Cisco TMS. The ExternalSourceId and the ExternalPrimaryKey fields must have been
provided in the initial SaveConference call.
This function is used to look up conference that have been updated in the external source, and that must
be updated in Cisco TMS. The ExternalSourceId and the ExternalPrimaryKey fields must have been
provided in the initial SaveConference call.
This function is typically used when information about a conference reserved in the external application is
needed. First this function is call to get the corresponding conference is Cisco TMS. The
GetConferenceById is used to get information about the conference from Cisco TMS.
needed. First this function is call to get the corresponding conference is Cisco TMS. The
GetConferenceById is used to get information about the conference from Cisco TMS.
Input
ExternalSourceId
Unique identifier of the external source (i.e. server IP-address).
ExternalConferenceId
Unique identifier of the conference within the external source (e.g. primary key