Webex Meetings > Develop and Test > XML API > Release Notes

XML API 9.0.0 SP5.1 Release Notes

Important: The XML API 9.0.0 SP5.1 release does not include any changes to schema definitions. The changes in this release are backward compatibility with previous releases.
 

 

Overview

This release note describes the changes made with the release of Webex® XML API 9.0.0 SP5.1. These changes apply to your integration with WBS 30.

All features are backward compatible with existing integrations. There are no changes to the latest schema definitions.

Rate Limiting Of APIs

Description

In order to protect the Webex services from denial of service attacks and possible developer errors that might overload the servers, throttling is being introduced.

API calls from all authenticated calls are going to be throttled based on the groups the APIs belong to: User operations, Meeting Write operations, Meeting List operations. There will be global limits as well as site-level limits (available on request and validation by Webex Product Management) for the number of APIs per minute per caller. When enforced, the limits will be enforced for a specific period of time: 60 seconds. This means that an API call that results in a rate limit error can still be submitted 60 seconds later when the specific API is once again available.

This capability will be enabled at a later time. For now, the only change that has occurred is to collect data and metrics. The reason for collecting data is to establish baselines of rate usage for each of the different kinds of API calls. We are doing this to understand what constitutes normal usage.


Affected APIs

All APIs that require authentication.

Error Message

There is a  new error code. When an API call hits the rate limit the system returns the following message:

000045: API Rate Limit Reach

Example Error Message

The following XML snippet shows an example return message with error 000045: API Rate Limit Reached.

<?xml version="1.0" encoding="ISO-8859-1"?>
<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>FAILURE</serv:result>
      <serv:reason>API rate limit reached</serv:reason>
      <serv:gsbStatus>PRIMARY</serv:gsbStatus>
      <serv:exceptionID>000045</serv:exceptionID>
    </serv:response>
  </serv:header>
  <serv:body>
    <serv:bodyContent/>
  </serv:body>
</serv:message>


Related Release Information

The XML API schemas and release notes are available at the Cisco Webex Developer Portal:
https://developer.cisco.com/site/collaboration/webex/webex-developer/develop-test/xml-api/reference/

The URL API release notes are available at the Cisco Webex Developer Portal:
https://developer.cisco.com/site/collaboration/webex/webex-developer/develop-test/url-api/reference/