Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide
Usage requirements
This section describes the licensing, permission, and authentication requirements for using the APIs.
API licensing
The API functions that require a license key are the following:
n
GetRecordingAliases
n
GetTransactionsSince
n
SaveConference
n
SaveConferenceRecInstance
n
SaveConferences
The remaining API features do not require special licensing for use. Contact your Cisco reseller/partner for
more licensing information.
more licensing information.
Licensing requirements
Each telepresence endpoint to be booked through Cisco TMSBA must already have been added to Cisco
TMS and licensed for general Cisco TMS usage.
TMS and licensed for general Cisco TMS usage.
Additionally, in order to use Cisco TMSBA for booking these endpoints, you must have one of the following:
n
One Cisco TMSXE – Extension for Microsoft Exchange option key per 25 telepresence endpoints
integrated with Cisco TMS, usually recommended for smaller deployments. See below for detail on how
system licenses are activated.
integrated with Cisco TMS, usually recommended for smaller deployments. See below for detail on how
system licenses are activated.
n
One Cisco TelePresence Management Suite Booking API license per 25 registered endpoints per 25
telepresence endpoints integrated with Cisco TMS, usually recommended for smaller deployments. See
below for detail on how system licenses are activated.
telepresence endpoints integrated with Cisco TMS, usually recommended for smaller deployments. See
below for detail on how system licenses are activated.
n
One Cisco TelePresence Management Suite Extension for IBM Lotus Notes option key per 25
telepresence endpoints integrated with Cisco TMS, usually recommended for smaller deployments. See
below for detail on how system licenses are activated.
telepresence endpoints integrated with Cisco TMS, usually recommended for smaller deployments. See
below for detail on how system licenses are activated.
n
One Application Integration Package option key per Cisco TMSBA installation. This option is
recommended for deployments with a large number of endpoints.
recommended for deployments with a large number of endpoints.
If both license keys are present, Cisco TMS will only use the Application Integration Package key.
Enabling option keys
To enable an option key in Cisco TMS:
1. Go to
Administrative Tools > Configuration > General Settings
.
2. In the
Licenses and Option Keys
pane, click Add Option Key.
3. Input the option key string.
4. Click Save.
Cisco TelePresence Management Suite Extension Booking API Programming Reference Guide (14.4)
Page 14 of 77
Using the APIs for remote setup and booking
Usage requirements