Find all the important information that you need about the Cisco Webex Meetings API, such as schema changes and other announcements.
For more info on XML API 39 and XML API 11, see the Cisco Webex Meetings XML API Updates Overview (XML API 39 and Earlier).
For more info on XML API 40, see the Cisco Webex Meetings XML API Updates Overview (XML API 40 and Later).
For more info on XML API 41, see the Cisco Webex Meetings API Updates Overview (API 41).
For updates for XML API 11 SP9 and earlier, go to Cisco DevNet.
API 42.6.0 Updates
XML API 42.6.0 Updates
Click here to download the XML API 42.6.0 schema.
Administrators can't create a new user or modify an existing user when the Webex site is suspended
Impacted APIs and Schema changes
When the Webex site is suspended, then the site administrator can't create new users and modify existing users via XML API: CreateUser, SetUser.
It will response exception 010107 The site is suspended when one site administrator tries to create a new user or modify one existing user.
The non-administrator user (owner self) are able to modify self information under this suspended site.
Schema changes
no schema change.
Affect APIs:
-
CreateUser
-
SetUser
API 42.5.0 Updates
XML API 42.5.0 Updates
Click here to download the XML API 42.5.0 schema.
When the Webex site suspended, it won't allow you to schedule or edit Webinars, Webex Events (classic), Webex Trainings, and Webex Support meetings
Impacted APIs and Schema changes
When the Webex site is suspended, it won't allow you to schedule or edit Webinars, Webex Events (classic), Webex Trainings, and Webex Support meetings, the site only supports free Webex Meetings type.
There are new exception codes and messages: "010107 The site is suspended" when call those APIs ( CreateMeeting
, SetMeeting
, CreateEvent
, SetEvent
, CreateTrainingSession
, SetTrainingSession
, CreateSupportSession
) hitting on this limitation.
Schema changes
No schema change.
Affect APIs:
-
CreateMeeting, SetMeeting
-
CreateEvent, SetEvent
-
CreateTrainingSession, SetTrainingSession
-
CreateSupportSession
API 42.4.0 Updates
API 42.4.0 Updates
There are no schema changes to the XML API 42.4.0 schema. |
API 42.3.0 Updates
XML API 42.3.0 Updates
XMLAPI has a new ability to send a notification email to the host when the meeting recordings are deleted or reassigned by others
Impacted APIs and Schema change
The XML API: DelRecording
sends a notification email to the host when the meeting recordings are deleted or reassigned by others.
Schema changes
No schema change
Affect APIs: DelRecording
DelRecording
API sends a notification email to the recording owner when it's operated on by a site administrator.
API request example
XML API: DelRecording
example
<?xml version="1.0" encoding="UTF-8"?>
<serv:message
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:serv="http://www.webex.com/schemas/2002/06/service"
xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service
http://www.webex.com/schemas/2002/06/service/service.xsd">
<header>
<securityContext>
<webExID>siteadmin</webExID>
<password>xxxxxx</password>
<siteName>testsite</siteName>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.ep.DelRecording">
<recordingID>1234567890</recordingID>
<isServiceRecording>true</isServiceRecording>
<deletePermanently>false</deletePermanently>
</bodyContent>
</body>
</serv:message>
Example of a notification email (moved to trash):
Example of a notification email (permanently deleted):
API 42.2.0 Updates
XML API 42.2.0 Updates
GetSite responds to new elements as: allowChangeFirstName
, allowChangeLastName
, and allowChangeDisplayName
Impacted APIs and Schema changes
The XML API: GetSite returns new elements: allowChangeFirstName
, allowChangeLastName
, and allowChangeDisplayName
. The toggle for this feature is EnableCustomizeProfileFields
.
-
allowChangeFirstName
, true or false, means allow the user to change the first name -
allowChangeLastName
, true or false, means allow the user to change the last name -
allowChangeDisplayName
, true or false, means allow the user to change the display name
AllowUploadPRAvatar
is returned. True or false, means to allow a user to upload an Avatar.
Above changes are only available on non-Control Hub managed sites.
Schema changes
In getSite
response, we return new attributes: allowChangeFirstName
, allowChangeLastName
, allowChangeDisplayName
, and AllowUploadPRAvatar
under myWebExConfig
.
Affect APIs: GetSite
API request and response example
XML API: GetSite
example
GetSiteResponse
<?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:ns1="http://www.webex.com/schemas/2002/06/service/site" xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
<serv:header>
<serv:response>
<serv:result>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="ns1:getSiteResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns1:siteInstance>
...
<ns1:myWebExConfig>
...
<ns1:allowChangeFirstName>false</ns1:allowChangeFirstName>
<ns1:allowChangeLastName>false</ns1:allowChangeLastName>
<ns1:allowChangeDisplayName>true</ns1:allowChangeDisplayName>
<ns1:AllowUploadPRAvatar>true</ns1:AllowUploadPRAvatar>
...
</ns1:myWebExConfig>
...
</ns1:siteInstance>
</serv:bodyContent>
</serv:body>
</serv:message>
API 42.1.0 Updates
XML API 42.1.0 Updates
Business logic changed on both XML API: LstSummarySession
and GetSessionInfo
on response element: enableEvent
and enableWebniar
mpacted APIs and Schema changes
The XML API: LstSummarySession
and GetSessionInfo
on response element: enableEvent
and enableWebniar
, have business logic changed as following:
-
When
enableEvent
is true, the meeting is a Webex webinar, false is not a Webex webinar. -
If
enableEvent
is true and then theenableWebniar
can be true or false, true means the webinar's attendee only with view-only privileges, false means the webinar's attendee do not limit on view-only privileges. -
If
enableEvent
is false, no meaningful onenableWebniar
response.
Schema changes
No schema change.
Affect APIs:
-
LstSummarySession
-
GetSessionInfo
Add max register limitation per one API call on XML API: CreateMeetingAttendee
, RegisterMeetingAttendee
Impacted APIs
We added 50 maximum registration limitation per one API call on both APIs: CreateMeetingAttendee
and RegisterMeetingAttendee
.
If client's one time API call registering number of attendees is more than 50, then the APIs response error code and message is:
"040015 Register attendee number over limit in one API call"
Schema changes on API
No schema change.
API request and response example
CreateMeetingAttendee
and RegisterMeetingAttendee
API request and response Request of CreateMeetingAttendee
<?xml version="1.0" encoding="UTF-8"?>
<serv:message
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:serv="http://www.webex.com/schemas/2002/06/service"
xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service
http://www.webex.com/schemas/2002/06/service/service.xsd">
<header>
<securityContext>
<webExID>host1</webExID>
<password>xxxxxx</password>
<siteName>testsite</siteName>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.attendee.CreateMeetingAttendee">
<person>
<name>test001</name>
<email>test001@test.com</email>
</person>
<sessionKey>987654321</sessionKey>
<attendees>
<person>
<name>test002</name>
<email>test002@test.com</email>
</person>
<sessionKey>987654321</sessionKey>
</attendees>
...
..
<attendees>
<person>
<name>test051</name>
<email>test051@test.com</email>
</person>
<sessionKey>987654321</sessionKey>
</attendees>
</bodyContent>
</body>
</serv:message>
Response of CreateMeetingAttendee
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service"
xmlns:com="http://www.webex.com/schemas/2002/06/common"
xmlns:att="http://www.webex.com/schemas/2002/06/service/attendee">
<serv:header>
<serv:response>
<serv:result>FAILURE</serv:result>
<serv:reason>Register attendee number over limit in one API call: 50</serv:reason>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
<serv:exceptionID>040015</serv:exceptionID>
<serv:value>50</serv:value>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent/>
</serv:body>
</serv:message>