XML Request and Response Documents

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 March 31, 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.

Webex Meetings XML API uses XML documents for request and response. XML documents are sent via HTTPS POST to https://api.webex.com/WBXService/XMLService. Response data is returned in XML format.

All Webex Meetings XML API request documents follow the same basic formatting. XML request name is included as part of the xsi:type string in the bodyContent declaration. Request specific information or filtering options are included as children of bodyContent. securityContext includes authentication details and Webex site identification.

Example Request

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
            <siteName>webex_subdomain</siteName>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.ep.GetAPIVersion">
        </bodyContent>
    </body>
</serv:message>

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<serv:message 
 xmlns:serv="http://www.webex.com/schemas/2002/06/service" 
 xmlns:com="http://www.webex.com/schemas/2002/06/common" 
 xmlns:ep="http://www.webex.com/schemas/2002/06/service/ep" 
 xmlns:meet="http://www.webex.com/schemas/2002/06/service/meeting">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="ep:getAPIVersionResponse" 
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ep:apiVersion>WebEx XML API V11.0.0</ep:apiVersion>
            <ep:release>SP26</ep:release>
            <ep:apiVer>39.7.0</ep:apiVer>
        </serv:bodyContent>
    </serv:body>
</serv:message>