Webex Meetings XML to REST Migration Guide
In preparation for the eventual phase out of the Webex Meetings related XML APIs, we've prepared this guide to help you migrate your Webex applications from the XML APIs to the newer Webex REST APIs. We expect you'll find the REST API much more flexible and quite a bit easier to use. REST APIs support features that were never supported before such as Webhooks, In-meeting controls, Webinars management, transcriptions and more.
Important
The Classic Event Center is replaced by Webex Webinars which are now supported by REST APIs. The retirement date for Classic Event Center will be communicated separately.Important
The Training and Support Center-related APIs will not be supported by the REST API. The XML APIs will be supported until further notice.Important
We encourage our new and existing customers to create new integrations using REST APIs when possible. XML APIs will be deprecated in the future; dates will be communicated separately. For details on the Webex REST API, see Cisco Webex for Developers.Getting Started with the Webex REST APIs
Using the Webex REST APIs is simple:
- Register a free Webex Account if you don't already have one.
- Generate an access token, which can be one of:
- A personal access token from the Webex Developer Portal.
- A Bot token.
- An OAuth token from an Integration or Guest Issuer application.
- Use the access token in an
AuthenticationHTTP header to make REST API calls as required.
Webex REST APIs Learning Resources
You can find comprehensive information on using the Webex REST APIs on the Webex Developer Portal:
- For an introduction to working with the REST APIs, see Getting Started with the Webex API.
- For information on handling authorization and creating integrations using the REST APIs, see Integrations & Authorization.
Tip
For a comprehensive selection of step by step labs on a variety of Webex API topics from basic to advanced, see Get Started with Webex APIs by Cisco DevNet.Using REST and XML APIs Simultaneously
If you need to utilize REST APIs and XML APIs simultaneously, your access token (with SPARK:All scope) must be replaced by a sessionTicket. For more information, see: https://developer.cisco.com/docs/webex-xml-api-reference-guide/#!authenticateuser.
For Assistance
If you need any help with your migration, please don't hesitate to contact us:
- Our amazing Webex Developer Support are available at all hours to help you with questions and for troubleshooting - Webex Developer Support
- Feel free to post questions (and answers!) in our new Webex Developer Community
Mappings between XMLAPI and RESTful Meetings API
The following sections describe mappings between XML APIs and REST APIs when available along with any additional information. If you require a particular XML API that isn't supported in REST, please contact Webex Developer Support.
General Session Service
| XML API Name | Supported in REST API | Dev Portal Link | Notes |
|---|---|---|---|
| CreateContacts | Future consideration | ||
| CreateDistList | Future consideration | ||
| DelSession | Yes | https://developer.webex.com/docs/api/v1/meetings/delete-a-meeting | Supported for Meetings center only and not for other centers |
| GetAPIVersion | No | Not relevant to REST APIs | |
| GetOneClickSettings | Future consideration | ||
| SetOneClickSettings | Future consideration | ||
| GetSessionInfo | Yes | https://developer.webex.com/docs/api/v1/meetings/get-a-meeting | Supported for Meetings center only and not for other centers |
| LstContact | Future consideration | ||
| LstDistList | Future consideration | ||
| SetDistList | Future consideration | ||
| LstOpenSession | Yes | https://developer.webex.com/docs/api/v1/meetings/list-meetings | |
| LstsummarySession | Yes | https://developer.webex.com/docs/api/v1/meetings/list-meetings | Currently supported for Meetings center only and not for other centers |
| SetupOneClickSettings | Future consideration | ||
| LstCalendarSession | Yes | https://developer.webex.com/docs/api/v1/meetings/list-meetings | Currently supported for Meetings center only and not for other centers |
Meeting and Meeting Type Service
Meeting Attendee Service
Recording Service
| XML API Name | Supported in REST API | Dev Portal Link | Notes |
|---|---|---|---|
| LstRecording | Yes | https://developer.webex.com/docs/api/v1/recordings/list-recordings | |
| DelRecording | Yes | https://developer.webex.com/docs/api/v1/recordings/delete-a-recording | Currently supported for Meetings center only and not for other centers |
| LstRecordingInRecycleBin | Future consideration | ||
| SetRecordingInfo | Future consideration | ||
| GetRecordingInfo | Yes | https://developer.webex.com/docs/api/v1/recordings/get-recording-details | Currently supported for Meetings center only and not for other centers |
| RecoverRecordingFromRecycleBin | Future consideration | ||
| DelRecordingFromRecycleBin | Future consideration |
History Service
| XML API Name | Supported in REST API | Dev Portal Link | Notes |
|---|---|---|---|
| LstmeetingattendeeHistory | Yes | https://developer.webex.com/docs/api/v1/meeting-participants/list-meeting-participants | |
| LstmeetingusageHistory | Yes | https://developer.webex.com/docs/api/v1/reports (WAP API) | |
| LstmeetingattendeePreliminaryHistory | Yes | https://developer.webex.com/docs/api/v1/meeting-participants/list-meeting-participants (WAP API) | |
| LstmeetingusagePreliminaryHistory | Yes | https://developer.webex.com/docs/api/v1/reports (WAP API) | |
| LstrecordaccessDetailHistory | Yes | https://developer.webex.com/docs/api/v1/recording-report | Currently supported for Meetings center only and not for other centers |
| LstrecordaccessHistory | Yes | https://developer.webex.com/docs/api/v1/recording-report | Currently supported for Meeting center only and not for other centers |
| LstsupportsessionHistory | No | Not relevant to REST APIs | |
| LsttrainingsessionHistory | No | Not relevant to REST APIs | |
| LsttrainingattendeeHistory | No | Not relevant to REST APIs | |
| LsteventsessionHistory | No | Not relevant to REST APIs | |
| LsteventattendeeHistory | No | Not relevant to REST APIs | |
| LstsupportattendeeHistory | No | Not relevant to REST APIs | |
| LsteventattendeePreliminaryHistory | No | Not relevant to REST APIs | |
| LstTrainingPollResultsHistory | No | Not relevant to REST APIs |
Site Service
| XML API Name | Supported in REST API | Dev Portal Link | Notes |
|---|---|---|---|
| GetSite | Future consideration | ||
| GetSiteType | Future consideration | ||
| GetSiteAdminSessionTicket | Future consideration | ||
| GetSiteFT | Future consideration | ||
| LstTimeZone | Future consideration | ||
| SetSiteFT | Future consideration | ||
| GetSiteAdminNavUrl | Future consideration | ||
| SetSite | Future consideration | ||
| GetSiteInfo | Future consideration |