XML API Overview
The Webex Meetings XML Application Programming Interface (Webex Meetings XML API) enables you to manage XML Services, which can be used to set up and manage Webex Meetings collaboration services.
Important
The Meetings-related XML APIs will be deprecated and the End-of-Support (EoS) date is planned for the second half of
2023. Cisco will continue to resolve bugs up to this date, but new features will only be implemented for the REST APIs
suite. The End-of-life (EoL) timeframe for Meetings-related XML APIs is targeted for the first quarter of 2024, at which
time the APIs will be retired. For information on how to migrate from XML to REST APIs, please see
Webex Meetings XML to REST Migration Guide. User management APIs such as
CreateUser
,
SetUser
,
DelUser
, etc. are
NOT affected by this EOL
announcement.
The Webex Meetings products provide services that involve a few key entities. The primary entities are the following:
Webex Meetings services such as creating a user, modifying information about a user, creating a meeting, exchanging files, and so on, are implemented via a set of operations. You can use these Webex Meeting operations to facilitate specific aspects of Webex Meetings online sessions. You can deploy these Webex Meetings services through the exchange of well-formed XML documents between your application or service and a Webex Meetings server.
To access Webex Meetings services through the exchange of XML documents, you must design your application to send XML request documents to the Webex Meetings XML server and to process the received responses.
The XML API is a comprehensive set of services supporting most aspects of the Webex Meetings services. Webex Meetings maintains a database of user and site data. Your application or service and Webex Meetings exchange this data using XML, which allows your application or service to interact with Webex Meetings independent of how Webex Meetings stores the information internally. To help ensure that the meanings and the boundaries for each unit of data are well preserved, Webex Meetings standardizes the format of XML data exchanges between your application or service and the Webex Meetings servers by requiring them to conform to the XML Schema Definition (XSD). Documents that comply with the XSD are the only type of XML document supported in the two-way XML flow between your application and the Webex Meetings servers.
Various XML request and response messages enable you to retrieve and change the information within those services. To optimize flexibility when making requests, the Webex Meetings server can handle more complex and lengthy stretches of markup that includes request control elements in addition to the elements of a particular operation.
The following figure provides a simplified representation of the architecture of the Webex Meetings XML Model Architecture: