This article contains updates and changes for the XML API monthly SP releases.

For more info on XML API 40 and REST API 40, see the Cisco Webex Meetings API Updates Overview (API 40).

For updates for XML API 11 SP9 and earlier, go to Cisco DevNet.

XML API 39.11.0 Updates

Click here to download the XML API 39.11 schema.

LstSummaryUser can query user accounts by the last modified time

We're upgrading the LstSummaryUser API to be able to let users query user accounts based on the time that they were last modified. Three new elements, modifiedDateStart, modifiedDateEnd, and lastModifiedTime, have been added to the API.


The maximum time scope for this query is 90 days. If you input a time range that's more than 90 days, an error appears: 999999 Maximum date range is 90 days for modified date query.

Affected APIs:

  • LstSummaryUser

LastSummaryUser Request Example:

<?xml version="1.0" encoding="UTF-8"?>
<message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:serv="http://www.webex.com/schemas/2009/05/service">
<header>
  <securityContext>
    <siteName>Site_Name</siteName>
    <webExID>SiteAdmin</webExID>
    <password>Password</password>
    <partnerID>webexpartner</partnerID>
  </securityContext>
</header>
<body>
    <bodyContent xsi:type="java:com.webex.service.binding.user.LstsummaryUser">
        <dataScope>
            <modifiedDateStart>10/01/2019 09:24:54</modifiedDateStart>
            <modifiedDateEnd>11/30/2019 09:24:54</modifiedDateEnd>
            <timeZoneID>4</timeZoneID>
        </dataScope>
    </bodyContent>
</body>
</message>

LstSummaryUser Response Example:

<?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:use="http://www.webex.com/schemas/2002/06/service/user">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="use:lstsummaryUserResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <use:user>
                <use:userID>**5124***</use:userID>
                <use:webExId>***MR***</use:webExId>
                <use:firstName>***MR***</use:firstName>
                <use:lastName>***est***</use:lastName>
                <use:email>***est***@qa.webex.com</use:email>
                <use:userRoleType>HOST</use:userRoleType>
                <use:registrationDate>06/19/2016 22:13:06</use:registrationDate>
                <use:active>DEACTIVATED</use:active>
                <use:timeZoneID>4</use:timeZoneID>
                <use:meetingTypes>
                    <use:meetingType>3</use:meetingType>
                    <use:meetingType>9</use:meetingType>
                    <use:meetingType>10</use:meetingType>
                    <use:meetingType>11</use:meetingType>
                    <use:meetingType>13</use:meetingType>
                    <use:meetingType>14</use:meetingType>
                    <use:meetingType>102</use:meetingType>
                </use:meetingTypes>
                <use:lastLoginTime>10/19/2019 23:13:14</use:lastLoginTime>
                <use:lastModifiedTime>11/11/2019 19:11:11</use:lastModifiedTime>
            </use:user>

XML API 39.10.0 Updates

Click here to download the XML API 39.10 schema.

GetSessionInfo and GetUserCard returns a CAPTCHA code when using anonymous access

As a security update, we've enhanced the GetSessionInfo and GetUserCard APIs with CAPTCHA code response protection. If your applications call the APIs using anonymous access, enhance your application to support CAPTCHA code input.

Affected APIs:

  • GetSessionInfo

  • GetUserCard

CAPTCHA Security and Response Updates:

GetSessionInfo Response Without CAPTCHA Example:

<?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>Corresponding Meeting not found</serv:reason>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
            <serv:exceptionID>060001</serv:exceptionID>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent/>
    </serv:body>
</serv:message>

GetSessionInfo Response With CAPTCHA Example:

<?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>Corresponding Meeting not found</serv:reason>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
            <serv:exceptionID>060001</serv:exceptionID>
            <serv:CAPTCHAID>SDDHEEfgkerwAAAI****qHS****Nfx_d34znF8RdVHzrsMIYFeuArjD96Q2:234322374320JGUBE349924</serv:CAPTCHAID>
           <serv:CAPTCHAImage>
                iVBORw0KGgoAAAANSUhEUgAAAHgAAAAyCAMAAACgee/qAAADAFBMVEUAAAAAADMAAGYAAJkAAMwAAP8AMwAAMzMAM2YA
                ...........
                maorF0PESWQ15APDKJ74YLs/hlGmaRGeJuRxvyyg8smcK3veB/v5sueF/pxD8H4J/A0HPu+ZUFb7SAAAAAElFTkSuQmCC
            </serv:CAPTCHAImage>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent/>
    </serv:body>
</serv:message>

If you receive a CAPTCHA response and continue calling the API, include the CAPTCHAID and CAPTCHAWord in your API request:

<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:serv="http://www.webex.com/schemas/2002/06/service">
<header>
<securityContext>
    <siteName>sqdemo6</siteName>
    <CAPTCHAID>SDDHEEfgkerwAAAI****qHS****Nfx_d34znF8RdVHzrsMIYFeuArjD96Q2:234322374320JGUBE349924</CAPTCHAID>
    <CAPTCHAWord>pyjihk</CAPTCHAWord>
</securityContext>
</header>
<body>
    <bodyContent xsi:type="java:com.webex.service.binding.ep.GetSessionInfo">
        <sessionKey>715801743</sessionKey>
    </bodyContent>
</body>
</serv:message>

GetSessionInfo Response to Incorrect CAPTCHAID and CAPTCHAWord Example:

<?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>CAPTCHA ID and word are invalid or missing</serv:reason>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
            <serv:exceptionID>030113</serv:exceptionID>
            <serv:CAPTCHAID>SDDHEEfgkerwAAAI****qHS****Nfx_d34znF8RdVHzrsMIYFeuArjD96Q2:234322374320JGUBE349924</serv:CAPTCHAID>
           <serv:CAPTCHAImage>
                iVBORw0KGgoAAAANSUhEUgAAAHgAAAAyCAMAAACgee/qAAADAFBMVEUAAAAAADMAAGYAAJkAAMwAAP8AMwAAMzMAM2YA
                ...........
                maorF0PESWQ15APDKJ74YLs/hlGmaRGeJuRxvyyg8smcK3veB/v5sueF/pxD8H4J/A0HPu+ZUFb7SAAAAAElFTkSuQmCC
            </serv:CAPTCHAImage>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent/>
    </serv:body>
</serv:message>

LstSummaryUser support for returning Personal Room URLs

We've added a new response element, personalMeetingRoomURL, to the LstSummaryUser API.

LstSummaryUser Response Example:

XML API 39.9.0 Updates

Click here to download the XML API 39.9 schema.

Support for Short SIP URLs for Personal Meeting Rooms (PMR)

Support for the short SIP URL format for PMRs impacts the GetSessionInfo, GetMeeting, GetUser, and GetMe APIs. A new response element named displayMeetingUrl was added to the GetUser and GetMe APIs, and is already present in GetSessionInfo and GetMeeting. displayMeetingUrl returns a user's PMR URL.

Affected APIs:

  • GetSessionInfo

  • GetMeeting

  • GetUser

  • GetMe

GetUser Response Example:

GetMe Response Example:

GetSessionInfo returns necessary elements for anonymous access

As a security requirement, only necessary elements can now be returned by GetSessionInfo for anonymous access.

GetSessionInfo Response Example:

<serv:bodyContent xsi:type="ep:getSessionInfoResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ep:status>NOT_INPROGRESS</ep:status>
    <ep:sessionkey>715952675</ep:sessionkey>
    <ep:accessControl>
        <ep:listStatus>PUBLIC</ep:listStatus>
        <ep:registration>false</ep:registration>
        <ep:passwordReq>true</ep:passwordReq>
        <ep:registrationURL>https://sqdemo6.dmz.webex.com/ec3300/eventcenter/enroll/register.do?loadFlag=1&amp;reqFlag=1&amp;confId=123203663769372547&amp;siteurl=sqdemo6</ep:registrationURL>
        <ep:registrationURLForMobile>https://sqdemo6.dmz.webex.com/ec3300/eventcenter/enroll/mobileRegister.do?formId=0&amp;formType=0&amp;loadFlag=1&amp;from=mobileClient&amp;siteurl=sqdemo6&amp;confId=123203663769372547</ep:registrationURLForMobile>
    </ep:accessControl>
    <ep:metaData>
        <ep:confName>Anony_Meeting_Retuning</ep:confName>
        <ep:serviceType>MeetingCenter</ep:serviceType>
    </ep:metaData>
    <ep:schedule>
        <ep:startDate>03/29/2019 11:55:00</ep:startDate>
        <ep:duration>60</ep:duration>
        <ep:timeZone>GMT-07:00, Pacific (San Francisco)</ep:timeZone>
        <ep:timeZoneID>4</ep:timeZoneID>
    </ep:schedule>
    <ep:attendeeOptions>
        <ep:joinRequiresAccount>false</ep:joinRequiresAccount>
    </ep:attendeeOptions>
    <ep:isAllowJBH>true</ep:isAllowJBH>
    <ep:isCETMeeting>true</ep:isCETMeeting>
    <ep:isPersonalMeetingRoom>false</ep:isPersonalMeetingRoom>
    <ep:meetingLink>https://sqdemo6.dmz.webex.com/sqdemo6/e.php?MTID=m2399b241f12722ca325388495e845103</ep:meetingLink>
    <ep:sipURL>715952675@sqdemo6.dmz.webex.com</ep:sipURL>
    <ep:displayMeetingUrl>715952675@sqdemo6.dmz.webex.com</ep:displayMeetingUrl>
</serv:bodyContent>

Affected APIs:

  • GetSessionInfo

Schedule meetings and events behavior change

By default, all scheduled meetings are video device-enabled meetings. However, when you schedule a meeting but select None or Others for your meeting's audio, the meeting will be scheduled as a non-video device-enabled Webex meeting.

Affected APIs:

  • CreateMeeting

  • SetMeeting

  • CreateEvent

  • SetEvent

XML API 39.8.0 Updates

Click here to download the XML API 39.8 schema.

LsttrainingattendeeHistory now returns meeting attendee attentiveness

A new response element, attentionToDurationPercentage, was added to the LsttrainingattendeeHistory API. LsttrainingattendeeHistory returns a meeting attendee's attentiveness details. The element is returned in this format:

<history:attentionToDurationPercentage>100</history:AttentionToDurationPercentage>

Affected APIs:

  • LsttrainingattendeeHistory

    • attentionToDurationPercentage

    • attentionToAttendancePercentage

LsttrainingattendeeHistory Response Example:

<history:endTime>04/17/2019 23:37:07</history:endTime>
<history:duration>6</history:duration>
    <history:attentionToDurationPercentage>100</history:AttentionToDurationPercentage>
    <history:attentionToAttendancePercentage>100</history:AttentionToAttendancePercentage>
<history:registered>N</history:registered>
<history:invited>N</history:invited>

GetSite now returns license counts

New response elements were provided to return different license counts in the GetSite API.

Affected APIs:

  • GetSite

    • EEActiveUserCount

    • activeCETHost

    • MCActiveUserCount

    • ECActiveUserCount

    • TCActiveUserCount

    • SCActiveUserCount

GetSiteFT and SetSiteFT Redesign

The GetSiteFT and SetSiteFT APIs were redesigned to allow dynamic feature toggles.

Affected APIs:

  • GetSiteFT

  • SetSiteFT

GetSite Request 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>
            <siteName>{siteName}</siteName>
            <accessToken>{This is machine account access token}</accessToken>
        </securityContext>
    </header>
    <bodyContent xsi:type="java:com.webex.service.binding.site.GetSiteFT">
        <featureToggles>
            <name>SupportCrossLaunch</name>
            <name>RemoveCMRLicenseSA</name>
        </featureToggles>
    </bodyContent>
</body>
</serv:message>

GetSite Response Example:

<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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:getSiteFTResponse">
            <ns1:featureToggles>
                <ns1:featureToggle>
                    <ns1:name>SupportCrossLaunch</ns1:name>
                    <ns1:value>false</ns1:value>
                </ns1:featureToggle>
                <ns1:featureToggle>
                    <ns1:name>RemoveCMRLicenseSA</ns1:name>
                    <ns1:value>false</ns1:value>
                </ns1:featureToggle>
            </ns1:featureToggles>
        </serv:bodyContent>
    </serv:body>
</serv:message>

SetSite Request 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>
            <siteName>{siteName}</siteName>
            <accessToken>{This is machine account access token}</accessToken>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.site.SetSiteFT">
            <featureToggles>
                <featureToggle>
                    <name>SupportCrossLaunch</name>
                    <value>false</value>
                </featureToggle>
                <featureToggle>
                    <name>SupportPeopleInsight</name>
                    <value>true</value>
                </featureToggle>
            </featureToggles>
        </bodyContent>
    </body>
</serv:message>

SetSiteFT Resonse Example:

<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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:setSiteFTResponse"/>
    </serv:body>
</serv:message>

Meeting description length now limited to 2500 characters

The following APIs now have the meeting description element's content length restricted to 2500 characters:

Affected APIs:

  • CreateEvent

  • SetEvent

  • CreateTrainingSession

  • SetTrainingSession

This is to prevent Cisco Webex from being unable to process the request. If the meeting description is longer than 2500 characters, an error message is returned.

XML API 39.5.0 Updates

New element videoMeshInterclusters added to the SetSite and GetSite schemas

A new element, videoMeshInterclusters, was added to the SetSite element. videoMeshInterclusters also contains three children elements videoMeshHomeCluster1, videoMeshHomeCluster2, and videoMeshHomeCluster3.

Affected APIs:

  • SetSite

    • videoMeshInterclusters

      • videoMeshHomeCluster1

      • videoMeshHomeCluster2

      • videoMeshHomeCluster3

  • GetSite

    • videoMeshInterclusters

      • videoMeshHomeCluster1

      • videoMeshHomeCluster2

      • videoMeshHomeCluster3

SetSite Request Updates:

GetSite Response Updates:

XML API 39.3.0 Updates

Short SIP URL in XML API, new element displayMeetingUrl

Click here to download the XML API 39.3 schema.

Currently, when joining a Webex meeting, the app or device must provide site info, making it difficult to join meetings sometimes. This is especially true when dialing in from a SIP device, because the user must type the meeting_number@sitename.webex.com.

To make joining meetings easier, we removed the requirement to enter the site name from the meeting SIP URI: meeting_number@webex.com. To keep backwards compatibility, the old format works at the sipURL and new the format is appended to the new element displayMeetingUrl.

Affected APIs:

  • GetMeeting

    • displayMeetingUrl

  • GetEvent

    • displayMeetingUrl

  • GetSessionInfo

    • displayMeetingUrl

GetMeeting Response Example:

    <meet:isCETMeeting>true</meet:isCETMeeting>
    <meet:meetingLink>https://sqdemo.dmz.webex.com/sqdemo/j.php?MTID=m0cdefe09626ba0bec956cdf9088bff55</meet:meetingLink>
    <meet:sipURL>712296997@sqdemo.dmz.webex.com</meet:sipURL>
    <meet:displayMeetingUrl>712296997@dmz.webex.com</meet:displayMeetingUrl>
</serv:bodyContent>

GetEvent Response Example:

    <event:hostType>1001001</event:hostType>
    <event:isCETMeeting>true</event:isCETMeeting>
    <event:sipURL>713847821@sqdemo.dmz.webex.com</event:sipURL>
    <event:displayMeetingUrl>713847821@dmz.webex.com</event:displayMeetingUrl>
</serv:bodyContent>

GetSessionInfo Response Example:

    <ep:isCETMeeting>true</ep:isCETMeeting>
    <ep:isNextUpcomingInstance>true</ep:isNextUpcomingInstance>
    <ep:meetingLink>https://sqdemo.dmz.webex.com/sqdemo/j.php?MTID=ee7d38639d0b4a9ed2eb8802cfa2810dd</ep:meetingLink>
    <ep:sipURL>713847821@sqdemo.dmz.webex.com</ep:sipURL>
    <ep:displayMeetingUrl>713847821@dmz.webex.com</ep:displayMeetingUrl>
</serv:bodyContent>

Email Example:

Description length now limited to 1024 Characters

The following APIs now have the description element’s content length restricted to 1024 characters:

Affected APIs:

  • CreateTrainingSession

  • SetTrainingSession

  • CreateEvent

  • SetEvent

This change is to prevent Cisco Webex from being unable to process the request. If the description is longer than 1024 characters, an error message is returned: “060067 Illegal input description. The description can't exceed the maximum display characters's length 1024.”

Response Example for Description Length Greater than 1024 Characters:

<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:sess="http://www.webex.com/schemas/2002/06/service/session" xmlns:train="http://www.webex.com/schemas/2002/06/service/trainingsession" xmlns:qti="http://www.webex.com/schemas/2002/06/service/trainingsessionqti" xmlns:qtiasi="http://www.webex.com/schemas/2002/06/service/trainingsessionqtiasi">
    <serv:header>
        <serv:response>
            <serv:result>FAILURE</serv:result>
            <serv:reason>
Illegal input description. The description can't exceed the maximum display characters's length 1024
            </serv:reason>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
            <serv:exceptionID>060067</serv:exceptionID>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent/>
    </serv:body>
</serv:message>

GetSessionInfo now returns only basic information for Personal Rooms when there is an anonymous user using the API

To ensure greater security, we're decreasing the amount of information returned by GetSessionInfo when there's an anonymous attendee user using the API. In this update we'll reduce the following elements in the API response:

Affected APIs:

  • GetSessionInfo

    • <ep:accessControl>

  • <ep:sessionPassword>

    • <ep:telephony>

    • <ep:isAlternateHost>…</ep:isAlternateHost>

    • <ep:isCreator>…</ep:isCreator>

    • <ep:hostKey>…</ep:hostKey>

    • <ep:supportE2E>…</ep:supportE2E>

Response Comparisons:

<serv:bodyContent xsi:type="ep:getSessionInfoResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ep:status>NOT_INPROGRESS</ep:status>
    <ep:isLocked>false</ep:isLocked>
    <ep:sessionkey>712419789</ep:sessionkey>
    <ep:confID>120396209273701973</ep:confID>
    <ep:accessControl>
        <ep:sessionPassword></ep:sessionPassword>   <!--Removed-->
        <ep:listStatus>UNLISTED</ep:listStatus>
        <ep:registration>false</ep:registration>
        <ep:passwordReq>false</ep:passwordReq>
        <ep:isEnforceAudioPassword>false</ep:isEnforceAudioPassword>
        <ep:isEnforceAudioLogin>false</ep:isEnforceAudioLogin>
    </ep:accessControl>
    <ep:metaData>
        <ep:confName>Simon Test's Personal Room</ep:confName>
        <ep:sessionType>3</ep:sessionType>
        <ep:serviceType>MeetingCenter</ep:serviceType>
        <ep:isRecurring>false</ep:isRecurring>
        <ep:agendaFormat>TEXT</ep:agendaFormat>
        <ep:descriptionFormat>TEXT</ep:descriptionFormat>
        <ep:isException>false</ep:isException>
        <ep:seriesMeetingKey>0</ep:seriesMeetingKey>
        <ep:hasException>false</ep:hasException>
    </ep:metaData>
    <ep:telephony>    <!--Removed-->
        <ep:telephonySupport>CALLBACK</ep:telephonySupport> <!--Removed-->
        <ep:globalCallInNumbersURL>https://sqdemo6.dmz.webex.com/sqdemo6/globalcallin.php?serviceType=MC&amp;ED=0</ep:globalCallInNumbersURL>   <!--Removed-->
        <ep:tollFreeRestrictionsURL>https://www.webex.com/pdf/tollfree_restrictions.pdf</ep:tollFreeRestrictionsURL>    <!--Removed-->
        <ep:dialInSequences>AutoDialInSequence:[AccessNumber],,*00*[AccessCode]#,,,[AttendeeID]#|SilentDialInSequence:[AccessNumber],,*01*[AccessCode]#[AttendeeID]#*01*|AutoLGDialInSequence:[AccessNumber],,*00*[AccessCode]#,,,[ProfileID]#,,,[PIN]#|SilentLGDialInSequence:[AccessNumber],,*01*[AccessCode]#[ProfileID]#[PIN]#*01*|AutoLGPWDialInSequence:[AccessNumber],,*00*[AccessCode]#,,,[ProfileID]#,,,[PIN]#,,,[Password]#|SilentLGPWDialInSequence:[AccessNumber],,*01*[AccessCode]#[ProfileID]#[PIN]#[Password]#*01*</ep:dialInSequences>  <!--Removed-->
        <ep:callInNum>    <!--Removed-->
            <serv:tollNum>14085452910</serv:tollNum>    <!--Removed-->
            <serv:globalNum>  <!--Removed-->
                <serv:countryAlias>14085452912</serv:countryAlias>  <!--Removed-->
                <serv:phoneNumber>14085452912</serv:phoneNumber>    <!--Removed-->
                <serv:tollFree>false</serv:tollFree>    <!--Removed-->
                <serv:default>false</serv:default>  <!--Removed-->
            </serv:globalNum> <!--Removed-->
        </ep:callInNum>   <!--Removed-->
        <ep:labels>   <!--Removed-->
            <ep:tollFreeCallInLabel>Call-in toll-free number (US/Canada)</ep:tollFreeCallInLabel>   <!--Removed-->
            <ep:tollCallInLabel>14085452910</ep:tollCallInLabel>    <!--Removed-->
        </ep:labels>  <!--Removed-->
        <ep:isMPAudio>false</ep:isMPAudio>  <!--Removed-->
        <ep:voip>true</ep:voip> <!--Removed-->
        <ep:enableTSP>false</ep:enableTSP>  <!--Removed-->
    </ep:telephony>   <!--Removed-->
    <ep:host>
        <ep:firstName>Simon</ep:firstName>
        <ep:lastName>Test</ep:lastName>
        <ep:email>simon0@qa.webex.com</ep:email>
        <ep:webExId>Simon</ep:webExId>
        <ep:allowAnyoneHostMeeting>false</ep:allowAnyoneHostMeeting>
    </ep:host>
    <ep:schedule>
        <ep:startDate>12/31/2068 13:00:00</ep:startDate>
        <ep:duration>720</ep:duration>
        <ep:timeZone>GMT-08:00, Pacific (San Francisco)</ep:timeZone>
        <ep:timeZoneID>4</ep:timeZoneID>
        <ep:openTimeInSec>0</ep:openTimeInSec>
    </ep:schedule>
    <ep:attendeeOptions>
        <ep:joinRequiresAccount>false</ep:joinRequiresAccount>
    </ep:attendeeOptions>
    <ep:isAudioOnly>false</ep:isAudioOnly>
    <ep:telePresence>false</ep:telePresence>
    <ep:isAlternateHost>false</ep:isAlternateHost>  <!--Removed-->
    <ep:isCreator>true</ep:isCreator>   <!--Removed-->
    <ep:hostKey>954462</ep:hostKey> <!--Removed-->
    <ep:supportE2E>false</ep:supportE2E>    <!--Removed-->
    <ep:isAllowJBH>false</ep:isAllowJBH>
    <ep:isCETMeeting>true</ep:isCETMeeting>
    <ep:isPersonalMeetingRoom>true</ep:isPersonalMeetingRoom>
    <ep:isNextUpcomingInstance>true</ep:isNextUpcomingInstance>
    <ep:meetingLink>https://sqdemo6.dmz.webex.com/sqdemo6/j.php?MTID=m424620ac1c117e156d97665b455192ed</ep:meetingLink>
    <ep:sipURL>simon0@sqdemo6.dmz.webex.com</ep:sipURL>
    <ep:displayMeetingUrl>simon0@sqdemo6.dmz.webex.com</ep:displayMeetingUrl>
    <ep:isAutoRecord>false</ep:isAutoRecord>
</serv:bodyContent>

XML API 39.2.0 Updates

New element lastLoginTime returned in LstSummaryUser response

A new response element, lastLoginTime, was added to the LstSummaryUser API. lastLoginTime returns the last login time for each user. The element is returned in this format:

<lastLoginTime>04/12/2018 22:40:01**</lastLoginTime>

Affected APIs:

  • LstSummaryUser

    • lastLoginTime

LstSummaryUser Response Example:

<?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:use="http://www.webex.com/schemas/2002/06/service/user">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="use:lstsummaryUserResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <use:user>
                <use:userID>3469487</use:userID>
                <use:objectGUID>a14e3312-e1d1-4e41-82b9-6ddac80c9f9a</use:objectGUID>
                <use:webExId>sangeetha.swaminathan@gmail.com</use:webExId>
                <use:firstName>Sangee</use:firstName>
                <use:lastName>Gmail</use:lastName>
                <use:email>sangeetha.swaminathan@gmail.com</use:email>
                <use:userRoleType>HOST</use:userRoleType>
                <use:registrationDate>12/11/2018 14:41:27</use:registrationDate>
                <use:active>DEACTIVATED</use:active>
                <use:timeZoneID>4</use:timeZoneID>
                <use:lastLoginTime>04/12/2018 22:40:01</use:lastLoginTime>
            </use:user>
            <use:matchingRecords>
                <serv:total>1</serv:total>
                <serv:returned>1</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </use:matchingRecords>
        </serv:bodyContent>
    </serv:body>
</serv:message>

XML API 39.1.0 Updates

Click here to download the XML API 39.1.0 schema.

New element apiVer added to GetAPIVersion API

A new response element, apiVer, was added to the GetAPIVersion API. With this update, the XML API version naming convention changes to match a unified version number with other Cisco Webex product areas. apiVer returns the new version information, such as 39.1.0 for the January 2019 update.

Affected APIs:

  • GetAPIVersion

    • apiVer

The element apiVersion will be deprecated on May 1, 2019, and the element release will be assigned a new XML API value on May 1, 2019.

GetAPIVersion Response Example:

<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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ep:getAPIVersionResponse">
            <ep:apiVersion>WebEx XML API V11.0.0</ep:apiVersion>
            <ep:release>SP22</ep:release>
            <ep:apiVer>39.1.0</ep:apiVer>
        </serv:bodyContent>
    </serv:body>
</serv:message>

HQ and HD parameters removed from XML API

HQ and HD video properties are now determined at the site level, instead of being determined at the user level. The two options for these parameters are ignored when sending requests from the following APIs:

  • CreateMeeting

  • SetMeeting

  • CreateTrainingSession

  • SetTrainingSession

The GetMeeting and GetTrainingSession APIs still return the two options (decided by site level and user level) to avoid breaking existing code.

New element uploadLogFileUrl added to the site metadata returned to the desktop app

A new element uploadLogFileUrl was added to the response returned to the desktop app when it calls the getSite API in the XML API server. The desktop app can upload the log file to uploadLogFileUrl.

Affected APIs:

  • GetSite

    • uploadLogFileUrl

GetSite Response Example:

<?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: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:metaData>
                    <ns1:isEnterprise>true</ns1:isEnterprise>
                    <ns1:serviceType>Meeting Center</ns1:serviceType>
                    <ns1:serviceType>Event Center</ns1:serviceType>
                    <ns1:serviceType>Training Center</ns1:serviceType>
                    <ns1:serviceType>Support Center</ns1:serviceType>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>9</ns1:meetingTypeID>
                        <ns1:meetingTypeName>ONS</ns1:meetingTypeName>
                        <ns1:hideInScheduler>false</ns1:hideInScheduler>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>11</ns1:meetingTypeID>
                        <ns1:meetingTypeName>TRS</ns1:meetingTypeName>
                        <ns1:hideInScheduler>false</ns1:hideInScheduler>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>13</ns1:meetingTypeID>
                        <ns1:meetingTypeName>SC3</ns1:meetingTypeName>
                        <ns1:hideInScheduler>false</ns1:hideInScheduler>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>16</ns1:meetingTypeID>
                        <ns1:meetingTypeName>AUO</ns1:meetingTypeName>
                        <ns1:hideInScheduler>false</ns1:hideInScheduler>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>214</ns1:meetingTypeID>
                        <ns1:meetingTypeName>PRO</ns1:meetingTypeName>
                        <ns1:hideInScheduler>false</ns1:hideInScheduler>
                    </ns1:meetingTypes>
                    <ns1:siteName>sqdemo28</ns1:siteName>
                    <ns1:brandName>sqdemo28</ns1:brandName>
                    <ns1:brandName>sqdemo28-de</ns1:brandName>
                    <ns1:brandName>sqdemo28-en</ns1:brandName>
                    <ns1:brandName>sqdemo28-fr</ns1:brandName>
                    <ns1:region>France</ns1:region>
                    <ns1:currency>French Francs</ns1:currency>
                    <ns1:timeZoneID>4</ns1:timeZoneID>
                    <ns1:timeZone>GMT-08:00, Pacific (San Jose)</ns1:timeZone>
                    <ns1:parterID>7Dsupoc6DOfzpgcNViYvUA</ns1:parterID>
                    <ns1:webDomain>sqwd</ns1:webDomain>
                    <ns1:meetingDomain>sqmd</ns1:meetingDomain>
                    <ns1:telephonyDomain>sqtd</ns1:telephonyDomain>
                    <ns1:pageVersion>T33L</ns1:pageVersion>
                    <ns1:clientVersion>T33L</ns1:clientVersion>
                    <ns1:pageLanguage>FRENCH</ns1:pageLanguage>
                    <ns1:activateStatus>true</ns1:activateStatus>
                    <ns1:webPageType>J2EE</ns1:webPageType>
                    <ns1:iCalendar>true</ns1:iCalendar>
                    <ns1:myWebExDefaultPage>My Meetings</ns1:myWebExDefaultPage>
                    <ns1:componentVersion>cmp3300</ns1:componentVersion>
                    <ns1:accountNumLimit>999999</ns1:accountNumLimit>
                    <ns1:activeUserCount>40</ns1:activeUserCount>
                    <ns1:displayMeetingActualTime>false</ns1:displayMeetingActualTime>
                    <ns1:displayOffset>true</ns1:displayOffset>
                    <ns1:supportWebEx11>false</ns1:supportWebEx11>
                </ns1:metaData>
                <ns1:ucf>
                    <ns1:ucfConfiguration>UCF 2.1</ns1:ucfConfiguration>
                </ns1:ucf>
                <ns1:clientPlatforms>
                    <ns1:msWindows>true</ns1:msWindows>
                    <ns1:macOS9>true</ns1:macOS9>
                    <ns1:macOSX>true</ns1:macOSX>
                    <ns1:sunSolaris>true</ns1:sunSolaris>
                    <ns1:linux>true</ns1:linux>
                    <ns1:hpUnix>false</ns1:hpUnix>
                    <ns1:java>true</ns1:java>
                    <ns1:palm>false</ns1:palm>
                </ns1:clientPlatforms>
                <ns1:resourceRestrictions>
                    <ns1:isLicenseManager>true</ns1:isLicenseManager>
                    <ns1:concurrentLicense>0</ns1:concurrentLicense>
                    <ns1:fileFolderCapacity>1000</ns1:fileFolderCapacity>
                    <ns1:maxConcurrentEvents>0</ns1:maxConcurrentEvents>
                    <ns1:archiveStorageLimit>0</ns1:archiveStorageLimit>
                </ns1:resourceRestrictions>
                <ns1:supportAPI>
                    <ns1:autoLogin>true</ns1:autoLogin>
                    <ns1:aspAndPHPAPI>true</ns1:aspAndPHPAPI>
                    <ns1:backwardAPI>false</ns1:backwardAPI>
                    <ns1:xmlAPI>true</ns1:xmlAPI>
                    <ns1:cAPI>false</ns1:cAPI>
                    <ns1:scorm>true</ns1:scorm>
                </ns1:supportAPI>
                <ns1:myWebExConfig>
                    <ns1:myContacts>true</ns1:myContacts>
                    <ns1:myProfile>true</ns1:myProfile>
                    <ns1:myMeetings>true</ns1:myMeetings>
                    <ns1:trainingRecordings>true</ns1:trainingRecordings>
                    <ns1:folders>false</ns1:folders>
                    <ns1:eventDocument>true</ns1:eventDocument>
                    <ns1:myReport>false</ns1:myReport>
                    <ns1:myComputer>false</ns1:myComputer>
                    <ns1:personalMeetingPage>false</ns1:personalMeetingPage>
                    <ns1:myFilesStorage>1000</ns1:myFilesStorage>
                    <ns1:myComputerNumbers>0</ns1:myComputerNumbers>
                    <ns1:enableMyWebExPro>true</ns1:enableMyWebExPro>
                    <ns1:myWebExProMaxHosts>999999</ns1:myWebExProMaxHosts>
                    <ns1:restrictAccessAnyApps>false</ns1:restrictAccessAnyApps>
                    <ns1:restrictAccessAnyAppsNum>0</ns1:restrictAccessAnyAppsNum>
                    <ns1:addlAccessAnyComputersLimit>STRICT</ns1:addlAccessAnyComputersLimit>
                    <ns1:addlAccessAnyComputers>0</ns1:addlAccessAnyComputers>
                    <ns1:addlStorageLimit>STRICT</ns1:addlStorageLimit>
                    <ns1:addlStorage>0</ns1:addlStorage>
                    <ns1:myContactsPro>true</ns1:myContactsPro>
                    <ns1:myProfilePro>true</ns1:myProfilePro>
                    <ns1:myMeetingsPro>true</ns1:myMeetingsPro>
                    <ns1:trainingRecordingsPro>true</ns1:trainingRecordingsPro>
                    <ns1:foldersPro>false</ns1:foldersPro>
                    <ns1:eventDocumentPro>true</ns1:eventDocumentPro>
                    <ns1:myReportPro>true</ns1:myReportPro>
                    <ns1:myComputerPro>false</ns1:myComputerPro>
                    <ns1:personalMeetingPagePro>true</ns1:personalMeetingPagePro>
                    <ns1:myFilesStoragePro>1000</ns1:myFilesStoragePro>
                    <ns1:myComputerNumbersPro>0</ns1:myComputerNumbersPro>
                    <ns1:PMRheaderBranding>false</ns1:PMRheaderBranding>
                </ns1:myWebExConfig>
                <ns1:telephonyConfig>
                    <ns1:isTSPUsingTelephonyAPI>false</ns1:isTSPUsingTelephonyAPI>
                    <ns1:serviceName>Personal Conference No.</ns1:serviceName>
                    <ns1:participantAccessCodeLabel>Attendee access code</ns1:participantAccessCodeLabel>
                    <ns1:subscriberAccessCodeLabel>Host access code</ns1:subscriberAccessCodeLabel>
                    <ns1:attendeeIDLabel>Attendee ID</ns1:attendeeIDLabel>
                    <ns1:internetPhone>true</ns1:internetPhone>
                    <ns1:supportCallInTypeTeleconf>true</ns1:supportCallInTypeTeleconf>
                    <ns1:callInTeleconferencing>true</ns1:callInTeleconferencing>
                    <ns1:tollFreeCallinTeleconferencing>true</ns1:tollFreeCallinTeleconferencing>
                    <ns1:intlCallInTeleconferencing>true</ns1:intlCallInTeleconferencing>
                    <ns1:callBackTeleconferencing>true</ns1:callBackTeleconferencing>
                    <ns1:callInNumber>1</ns1:callInNumber>
                    <ns1:defaultTeleServerSubject>0.0.0.0</ns1:defaultTeleServerSubject>
                    <ns1:subscribeName>QA</ns1:subscribeName>
                    <ns1:subscribePassword>pass</ns1:subscribePassword>
                    <ns1:defaultPhoneLines>10</ns1:defaultPhoneLines>
                    <ns1:defaultSpeakingLines>10</ns1:defaultSpeakingLines>
                    <ns1:majorCountryCode>1</ns1:majorCountryCode>
                    <ns1:majorAreaCode>408</ns1:majorAreaCode>
                    <ns1:publicName>Call-in User</ns1:publicName>
                    <ns1:hybridTeleconference>true</ns1:hybridTeleconference>
                    <ns1:instantHelp>false</ns1:instantHelp>
                    <ns1:customerManage>false</ns1:customerManage>
                    <ns1:maxCallersNumber>500</ns1:maxCallersNumber>
                    <ns1:isSpecified>false</ns1:isSpecified>
                    <ns1:isContinue>false</ns1:isContinue>
                    <ns1:intlCallBackTeleconferencing>true</ns1:intlCallBackTeleconferencing>
                    <ns1:personalTeleconf>
                        <ns1:primaryLargeServer>
                            <serv:tollNum>14085452910</serv:tollNum>
                            <serv:globalNum>
                                <serv:countryAlias>14085452912</serv:countryAlias>
                                <serv:phoneNumber>14085452912</serv:phoneNumber>
                                <serv:tollFree>false</serv:tollFree>
                                <serv:default>false</serv:default>
                            </serv:globalNum>
                            <serv:enableServer>true</serv:enableServer>
                            <serv:tollLabel>14085452910</serv:tollLabel>
                            <serv:tollFreeLabel>Call-in toll-free number (US/Canada)</serv:tollFreeLabel>
                        </ns1:primaryLargeServer>
                        <ns1:backup1LargeServer>
                            <serv:enableServer>false</serv:enableServer>
                            <serv:tollLabel>Call-in toll number (US/Canada)</serv:tollLabel>
                            <serv:tollFreeLabel>Call-in toll-free number (US/Canada)</serv:tollFreeLabel>
                        </ns1:backup1LargeServer>
                        <ns1:backup2LargeServer>
                            <serv:enableServer>false</serv:enableServer>
                            <serv:tollLabel>Backup call-in toll number (US/Canada)</serv:tollLabel>
                            <serv:tollFreeLabel>Backup call-in toll-free number (US/Canada)</serv:tollFreeLabel>
                        </ns1:backup2LargeServer>
                        <ns1:primarySmallServer>
                            <serv:enableServer>false</serv:enableServer>
                            <serv:tollLabel>Call-in toll number (US/Canada)</serv:tollLabel>
                            <serv:tollFreeLabel>Call-in toll-free number (US/Canada)</serv:tollFreeLabel>
                        </ns1:primarySmallServer>
                        <ns1:backup1SmallServer>
                            <serv:enableServer>false</serv:enableServer>
                            <serv:tollLabel>Call-in toll number (US/Canada)</serv:tollLabel>
                            <serv:tollFreeLabel>Call-in toll-free number (US/Canada)</serv:tollFreeLabel>
                        </ns1:backup1SmallServer>
                        <ns1:backup2SmallServer>
                            <serv:enableServer>false</serv:enableServer>
                            <serv:tollLabel>Backup call-in toll number (US/Canada)</serv:tollLabel>
                            <serv:tollFreeLabel>Backup call-in toll-free number (US/Canada)</serv:tollFreeLabel>
                        </ns1:backup2SmallServer>
                        <ns1:joinBeforeHost>false</ns1:joinBeforeHost>
                    </ns1:personalTeleconf>
                    <ns1:multiMediaPlatform>true</ns1:multiMediaPlatform>
                    <ns1:multiMediaHostName>msa1mcccl01.dmz.webex.com</ns1:multiMediaHostName>
                    <ns1:broadcastAudioStream>true</ns1:broadcastAudioStream>
                    <ns1:tspAdaptorSettings>
                        <ns1:primaryLarge>
                            <ns1:enableAdaptor>false</ns1:enableAdaptor>
                            <ns1:serverIP></ns1:serverIP>
                            <ns1:mpAudio>
                                <ns1:label>Call-in number</ns1:label>
                            </ns1:mpAudio>
                            <ns1:mpAudio>
                                <ns1:label>Call-in toll-free number</ns1:label>
                            </ns1:mpAudio>
                        </ns1:primaryLarge>
                        <ns1:backup1Large>
                            <ns1:enableAdaptor>false</ns1:enableAdaptor>
                            <ns1:serverIP></ns1:serverIP>
                            <ns1:mpAudio>
                                <ns1:label>Call-in number</ns1:label>
                            </ns1:mpAudio>
                            <ns1:mpAudio>
                                <ns1:label>Call-in toll-free number</ns1:label>
                            </ns1:mpAudio>
                        </ns1:backup1Large>
                        <ns1:backup2Large>
                            <ns1:enableAdaptor>false</ns1:enableAdaptor>
                            <ns1:serverIP></ns1:serverIP>
                            <ns1:mpAudio>
                                <ns1:label>Call-in number</ns1:label>
                            </ns1:mpAudio>
                            <ns1:mpAudio>
                                <ns1:label>Call-in toll-free number</ns1:label>
                            </ns1:mpAudio>
                        </ns1:backup2Large>
                    </ns1:tspAdaptorSettings>
                    <ns1:meetingPlace>
                        <ns1:persistentTSP>false</ns1:persistentTSP>
                        <ns1:mpAudioConferencing>WithoutIntegration</ns1:mpAudioConferencing>
                    </ns1:meetingPlace>
                    <ns1:supportOtherTypeTeleconf>false</ns1:supportOtherTypeTeleconf>
                    <ns1:otherTeleServiceName>Other teleconference service</ns1:otherTeleServiceName>
                    <ns1:supportAdapterlessTSP>false</ns1:supportAdapterlessTSP>
                    <ns1:displayAttendeeID>false</ns1:displayAttendeeID>
                    <ns1:provisionTeleAccount>true</ns1:provisionTeleAccount>
                    <ns1:choosePCN>false</ns1:choosePCN>
                    <ns1:audioOnly>true</ns1:audioOnly>
                    <ns1:configTollAndTollFreeNum>false</ns1:configTollAndTollFreeNum>
                    <ns1:configPrimaryTS>false</ns1:configPrimaryTS>
                    <ns1:teleCLIAuthEnabled>false</ns1:teleCLIAuthEnabled>
                    <ns1:teleCLIPINEnabled>false</ns1:teleCLIPINEnabled>
                </ns1:telephonyConfig>
                <ns1:commerceAndReporting>
                    <ns1:trackingCode>false</ns1:trackingCode>
                    <ns1:siteAdminReport>true</ns1:siteAdminReport>
                    <ns1:subScriptionService>false</ns1:subScriptionService>
                    <ns1:isECommmerce>false</ns1:isECommmerce>
                    <ns1:customereCommerce>false</ns1:customereCommerce>
                    <ns1:isLocalTax>false</ns1:isLocalTax>
                    <ns1:localTaxName>VAT</ns1:localTaxName>
                    <ns1:localTaxtRate>0.0</ns1:localTaxtRate>
                    <ns1:holReport>1</ns1:holReport>
                </ns1:commerceAndReporting>
                <ns1:tools>
                    <ns1:businessDirectory>false</ns1:businessDirectory>
                    <ns1:officeCalendar>false</ns1:officeCalendar>
                    <ns1:meetingCalendar>true</ns1:meetingCalendar>
                    <ns1:displayOnCallAssistLink>false</ns1:displayOnCallAssistLink>
                    <ns1:displayProfileLink>true</ns1:displayProfileLink>
                    <ns1:recordingAndPlayback>true</ns1:recordingAndPlayback>
                    <ns1:recordingEditor>true</ns1:recordingEditor>
                    <ns1:publishRecordings>true</ns1:publishRecordings>
                    <ns1:instantMeeting>true</ns1:instantMeeting>
                    <ns1:emails>false</ns1:emails>
                    <ns1:outlookIntegration>true</ns1:outlookIntegration>
                    <ns1:wirelessAccess>false</ns1:wirelessAccess>
                    <ns1:allowPublicAccess>true</ns1:allowPublicAccess>
                    <ns1:ssl>true</ns1:ssl>
                    <ns1:handsOnLab>true</ns1:handsOnLab>
                    <ns1:holMaxLabs>999999</ns1:holMaxLabs>
                    <ns1:holMaxComputers>999999</ns1:holMaxComputers>
                    <ns1:userLockDown>false</ns1:userLockDown>
                    <ns1:meetingAssist>false</ns1:meetingAssist>
                    <ns1:sms>false</ns1:sms>
                    <ns1:encryption>NONE</ns1:encryption>
                    <ns1:internalMeeting>false</ns1:internalMeeting>
                    <ns1:enableTP>false</ns1:enableTP>
                    <ns1:enableTPplus>false</ns1:enableTPplus>
                    <ns1:uploadLogFileUrl>https://sqwd.webex.com/logadmin/spr.do?SiteUrl=sqdemo28&amp;LanguageId=1</ns1:uploadLogFileUrl>
                </ns1:tools>
                <ns1:custCommunications>
                    <ns1:displayType>
                        <ns1:prodSvcAnnounce>false</ns1:prodSvcAnnounce>
                        <ns1:trainingInfo>false</ns1:trainingInfo>
                        <ns1:eNewsletters>false</ns1:eNewsletters>
                        <ns1:promotionsOffers>false</ns1:promotionsOffers>
                        <ns1:pressReleases>false</ns1:pressReleases>
                    </ns1:displayType>
                    <ns1:displayMethod>
                        <ns1:email>false</ns1:email>
                        <ns1:fax>false</ns1:fax>
                        <ns1:phone>false</ns1:phone>
                        <ns1:mail>false</ns1:mail>
                    </ns1:displayMethod>
                </ns1:custCommunications>
                <ns1:trackingCodes/>
                <ns1:supportedServices>
                    <ns1:meetingCenter>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:pageVersion>mc3300</ns1:pageVersion>
                        <ns1:clientVersion>T33L</ns1:clientVersion>
                    </ns1:meetingCenter>
                    <ns1:trainingCenter>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:pageVersion>tc3300</ns1:pageVersion>
                        <ns1:clientVersion>T33L</ns1:clientVersion>
                    </ns1:trainingCenter>
                    <ns1:supportCenter>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:pageVersion>sc3300</ns1:pageVersion>
                        <ns1:clientVersion>T33L</ns1:clientVersion>
                        <ns1:webACD>true</ns1:webACD>
                    </ns1:supportCenter>
                    <ns1:eventCenter>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:pageVersion>ec3300</ns1:pageVersion>
                        <ns1:clientVersion>T33L</ns1:clientVersion>
                        <ns1:marketingAddOn>false</ns1:marketingAddOn>
                        <ns1:optimizeAttendeeBandwidthUsage>false</ns1:optimizeAttendeeBandwidthUsage>
                    </ns1:eventCenter>
                    <ns1:salesCenter>
                        <ns1:enabled>false</ns1:enabled>
                    </ns1:salesCenter>
                </ns1:supportedServices>
                <ns1:securityOptions>
                    <ns1:passwordExpires>false</ns1:passwordExpires>
                    <ns1:passwordLifetime>0</ns1:passwordLifetime>
                    <ns1:ECMeetingsUnlisted>false</ns1:ECMeetingsUnlisted>
                    <ns1:TCMeetingsUnlisted>false</ns1:TCMeetingsUnlisted>
                    <ns1:allMeetingsUnlisted>true</ns1:allMeetingsUnlisted>
                    <ns1:allMeetingsPassword>true</ns1:allMeetingsPassword>
                    <ns1:joinBeforeHost>false</ns1:joinBeforeHost>
                    <ns1:audioBeforeHost>false</ns1:audioBeforeHost>
                    <ns1:audioBeforeHostEC>false</ns1:audioBeforeHostEC>
                    <ns1:audioBeforeHostTC>false</ns1:audioBeforeHostTC>
                    <ns1:changePersonalURL>true</ns1:changePersonalURL>
                    <ns1:changeUserName>false</ns1:changeUserName>
                    <ns1:meetings>
                        <ns1:strictPasswords>true</ns1:strictPasswords>
                    </ns1:meetings>
                    <ns1:strictUserPassword>true</ns1:strictUserPassword>
                    <ns1:accountNotify>false</ns1:accountNotify>
                    <ns1:requireLoginBeforeSiteAccess>false</ns1:requireLoginBeforeSiteAccess>
                    <ns1:changePWDWhenAutoLogin>false</ns1:changePWDWhenAutoLogin>
                    <ns1:enforceBaseline>true</ns1:enforceBaseline>
                    <ns1:passwordChangeIntervalOpt>false</ns1:passwordChangeIntervalOpt>
                    <ns1:passwordChangeInterval>24</ns1:passwordChangeInterval>
                    <ns1:firstAttendeeAsPresenter>false</ns1:firstAttendeeAsPresenter>
                    <ns1:isEnableUUIDLink>true</ns1:isEnableUUIDLink>
                    <ns1:isEnableUUIDLinkForSAC>true</ns1:isEnableUUIDLinkForSAC>
                    <ns1:enforceRecordingPwdForMC>true</ns1:enforceRecordingPwdForMC>
                    <ns1:enforceRecordingPwdForEC>false</ns1:enforceRecordingPwdForEC>
                    <ns1:enforceRecordingPwdForTC>false</ns1:enforceRecordingPwdForTC>
                    <ns1:enforceRecordingPwdForMisc>true</ns1:enforceRecordingPwdForMisc>
                </ns1:securityOptions>
                <ns1:defaults>
                    <ns1:emailReminders>true</ns1:emailReminders>
                    <ns1:entryExitTone>BEEP</ns1:entryExitTone>
                    <ns1:voip>true</ns1:voip>
                    <ns1:teleconference>
                        <ns1:telephonySupport>CALLBACK</ns1:telephonySupport>
                        <ns1:tollFree>true</ns1:tollFree>
                        <ns1:intlLocalCallIn>true</ns1:intlLocalCallIn>
                    </ns1:teleconference>
                    <ns1:joinTeleconfNotPress1>false</ns1:joinTeleconfNotPress1>
                    <ns1:updateTSPAccount>false</ns1:updateTSPAccount>
                </ns1:defaults>
                <ns1:scheduleMeetingOptions>
                    <ns1:scheduleOnBehalf>true</ns1:scheduleOnBehalf>
                    <ns1:saveSessionTemplate>true</ns1:saveSessionTemplate>
                </ns1:scheduleMeetingOptions>
                <ns1:navBarTop>
                    <ns1:button>
                        <ns1:order>1</ns1:order>
                        <ns1:serviceName>Welcome</ns1:serviceName>
                    </ns1:button>
                    <ns1:button>
                        <ns1:order>2</ns1:order>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:serviceName>Meeting Center</ns1:serviceName>
                    </ns1:button>
                    <ns1:button>
                        <ns1:order>3</ns1:order>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:serviceName>Event Center</ns1:serviceName>
                    </ns1:button>
                    <ns1:button>
                        <ns1:order>4</ns1:order>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:serviceName>Support Center</ns1:serviceName>
                    </ns1:button>
                    <ns1:button>
                        <ns1:order>5</ns1:order>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:serviceName>Training Center</ns1:serviceName>
                    </ns1:button>
                    <ns1:button>
                        <ns1:order>6</ns1:order>
                        <ns1:serviceName>Site Administration</ns1:serviceName>
                    </ns1:button>
                    <ns1:button>
                        <ns1:order>7</ns1:order>
                        <ns1:enabled>false</ns1:enabled>
                        <ns1:serviceName>Sales Center</ns1:serviceName>
                    </ns1:button>
                    <ns1:displayDisabledService>true</ns1:displayDisabledService>
                </ns1:navBarTop>
                <ns1:navMyWebEx>
                    <ns1:customLinks>
                        <ns1:customLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:customLink>
                        <ns1:customLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:customLink>
                        <ns1:customLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:customLink>
                    </ns1:customLinks>
                    <ns1:partnerLinks>
                        <ns1:partnerLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:partnerLink>
                        <ns1:partnerLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:partnerLink>
                        <ns1:partnerLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:partnerLink>
                    </ns1:partnerLinks>
                    <ns1:partnerIntegration>true</ns1:partnerIntegration>
                    <ns1:support>
                        <ns1:target>NEW</ns1:target>
                    </ns1:support>
                    <ns1:training>
                        <ns1:target>NEW</ns1:target>
                    </ns1:training>
                </ns1:navMyWebEx>
                <ns1:navAllServices>
                    <ns1:customLinks>
                        <ns1:customLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:customLink>
                        <ns1:customLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:customLink>
                        <ns1:customLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:customLink>
                    </ns1:customLinks>
                    <ns1:support>
                        <ns1:name>Support</ns1:name>
                        <ns1:target>NEW</ns1:target>
                    </ns1:support>
                    <ns1:training>
                        <ns1:name>Training</ns1:name>
                        <ns1:target>NEW</ns1:target>
                    </ns1:training>
                    <ns1:supportMenu>
                        <ns1:userGuides>
                            <ns1:target>NEW</ns1:target>
                        </ns1:userGuides>
                        <ns1:downloads>
                            <ns1:target>NEW</ns1:target>
                        </ns1:downloads>
                        <ns1:training>
                            <ns1:target>NEW</ns1:target>
                        </ns1:training>
                        <ns1:contactUs>
                            <ns1:target>NEW</ns1:target>
                        </ns1:contactUs>
                        <ns1:supportMyResources>true</ns1:supportMyResources>
                    </ns1:supportMenu>
                </ns1:navAllServices>
                <ns1:passwordCriteria>
                    <ns1:mixedCase>false</ns1:mixedCase>
                    <ns1:minLength>4</ns1:minLength>
                    <ns1:minAlpha>0</ns1:minAlpha>
                    <ns1:minNumeric>0</ns1:minNumeric>
                    <ns1:minSpecial>0</ns1:minSpecial>
                    <ns1:disallowWebTextSessions>true</ns1:disallowWebTextSessions>
                    <ns1:disallowWebTextAccounts>true</ns1:disallowWebTextAccounts>
                    <ns1:disallowList>true</ns1:disallowList>
                    <ns1:disallowValue>password</ns1:disallowValue>
                    <ns1:disallowValue>passwd</ns1:disallowValue>
                    <ns1:disallowValue>pass</ns1:disallowValue>
                </ns1:passwordCriteria>
                <ns1:recordingPasswordCriteria>
                    <ns1:mixedCase>true</ns1:mixedCase>
                    <ns1:minLength>8</ns1:minLength>
                    <ns1:minAlpha>2</ns1:minAlpha>
                    <ns1:minNumeric>1</ns1:minNumeric>
                    <ns1:minSpecial>0</ns1:minSpecial>
                    <ns1:disallowWebTextSessions>false</ns1:disallowWebTextSessions>
                    <ns1:disallowList>false</ns1:disallowList>
                    <ns1:disallowValue>password</ns1:disallowValue>
                    <ns1:disallowValue>passwd</ns1:disallowValue>
                    <ns1:disallowValue>pass</ns1:disallowValue>
                </ns1:recordingPasswordCriteria>
                <ns1:accountPasswordCriteria>
                    <ns1:mixedCase>false</ns1:mixedCase>
                    <ns1:minLength>0</ns1:minLength>
                    <ns1:minNumeric>0</ns1:minNumeric>
                    <ns1:minAlpha>0</ns1:minAlpha>
                    <ns1:minSpecial>0</ns1:minSpecial>
                    <ns1:disallow3XRepeatedChar>false</ns1:disallow3XRepeatedChar>
                    <ns1:disallowWebTextAccounts>true</ns1:disallowWebTextAccounts>
                    <ns1:disallowList>true</ns1:disallowList>
                    <ns1:disallowValue>password</ns1:disallowValue>
                    <ns1:disallowValue>passwd</ns1:disallowValue>
                    <ns1:disallowValue>pass</ns1:disallowValue>
                    <ns1:disallowValue>webex</ns1:disallowValue>
                    <ns1:disallowValue>cisco</ns1:disallowValue>
                    <ns1:disallowValue>xebew</ns1:disallowValue>
                    <ns1:disallowValue>ocsic</ns1:disallowValue>
                </ns1:accountPasswordCriteria>
                <ns1:productivityTools>
                    <ns1:enable>true</ns1:enable>
                    <ns1:installOpts>
                        <ns1:autoUpdate>true</ns1:autoUpdate>
                    </ns1:installOpts>
                    <ns1:integrations>
                        <ns1:outlook>true</ns1:outlook>
                        <ns1:outlookForMac>true</ns1:outlookForMac>
                        <ns1:lotusNotes>true</ns1:lotusNotes>
                        <ns1:oneClick>true</ns1:oneClick>
                        <ns1:showSysTrayIcon>true</ns1:showSysTrayIcon>
                        <ns1:office>true</ns1:office>
                        <ns1:excel>true</ns1:excel>
                        <ns1:powerPoint>true</ns1:powerPoint>
                        <ns1:word>true</ns1:word>
                        <ns1:IE>true</ns1:IE>
                        <ns1:firefox>false</ns1:firefox>
                        <ns1:explorerRightClick>false</ns1:explorerRightClick>
                        <ns1:instantMessenger>true</ns1:instantMessenger>
                        <ns1:aolMessenger>false</ns1:aolMessenger>
                        <ns1:googleTalk>false</ns1:googleTalk>
                        <ns1:lotusSametime>true</ns1:lotusSametime>
                        <ns1:skype>true</ns1:skype>
                        <ns1:windowsMessenger>true</ns1:windowsMessenger>
                        <ns1:yahooMessenger>false</ns1:yahooMessenger>
                        <ns1:ciscoIPPhone>false</ns1:ciscoIPPhone>
                        <ns1:pcNow>false</ns1:pcNow>
                        <ns1:iGoogle>false</ns1:iGoogle>
                        <ns1:iPhoneDusting>true</ns1:iPhoneDusting>
                    </ns1:integrations>
                    <ns1:oneClick>
                        <ns1:allowJoinUnlistMeeting>true</ns1:allowJoinUnlistMeeting>
                        <ns1:requireApproveJoin>false</ns1:requireApproveJoin>
                    </ns1:oneClick>
                    <ns1:templates>
                        <ns1:useTemplate>false</ns1:useTemplate>
                    </ns1:templates>
                    <ns1:lockDownPT>
                        <ns1:lockDown>false</ns1:lockDown>
                    </ns1:lockDownPT>
                    <ns1:imSettings>
                        <ns1:attendeeInviteOther>true</ns1:attendeeInviteOther>
                    </ns1:imSettings>
                </ns1:productivityTools>
                <ns1:meetingPlace/>
                <ns1:salesCenter>
                    <ns1:allowJoinWithoutLogin>false</ns1:allowJoinWithoutLogin>
                </ns1:salesCenter>
                <ns1:connectIntegration>
                    <ns1:integratedWebEx11>false</ns1:integratedWebEx11>
                </ns1:connectIntegration>
                <ns1:video>
                    <ns1:HQvideo>true</ns1:HQvideo>
                    <ns1:maxBandwidth>MEDIUM</ns1:maxBandwidth>
                    <ns1:HDvideo>true</ns1:HDvideo>
                </ns1:video>
                <ns1:siteCommonOptions>
                    <ns1:SupportCustomDialRestriction>false</ns1:SupportCustomDialRestriction>
                    <ns1:SupportTelePresence>false</ns1:SupportTelePresence>
                    <ns1:SupportTelePresencePlus>false</ns1:SupportTelePresencePlus>
                    <ns1:EnableCloudTelepresence>true</ns1:EnableCloudTelepresence>
                    <ns1:EnableCMRForAllUsers>true</ns1:EnableCMRForAllUsers>
                    <ns1:enablePersonalMeetingRoom>true</ns1:enablePersonalMeetingRoom>
                    <ns1:SupportAlternateHost>true</ns1:SupportAlternateHost>
                    <ns1:SupportAnyoneHostMeetings>true</ns1:SupportAnyoneHostMeetings>
                </ns1:siteCommonOptions>
                <ns1:samlSSO>
                    <ns1:enableSSO>false</ns1:enableSSO>
                    <ns1:autoAccountCreation>false</ns1:autoAccountCreation>
                </ns1:samlSSO>
                <ns1:attendeeLimitation>
                    <ns1:maxInviteesNumberForMC>1000</ns1:maxInviteesNumberForMC>
                    <ns1:maxRegistrantsNumberForMC>1000</ns1:maxRegistrantsNumberForMC>
                    <ns1:maxInviteesNumberForTC>1000</ns1:maxInviteesNumberForTC>
                    <ns1:maxRegistrantsNumberForTC>1000</ns1:maxRegistrantsNumberForTC>
                    <ns1:maxInviteesNumberForEC>10000</ns1:maxInviteesNumberForEC>
                    <ns1:maxRegistrantsNumberForEC>10000</ns1:maxRegistrantsNumberForEC>
                </ns1:attendeeLimitation>
                <ns1:CISiteLicenseInfo>
                    <ns1:accountNumberLimitForCMRHost>200</ns1:accountNumberLimitForCMRHost>
                    <ns1:allowOverageForCMRHost>true</ns1:allowOverageForCMRHost>
                    <ns1:accountNumberUsedForCMRHost>40</ns1:accountNumberUsedForCMRHost>
                    <ns1:accountNumberLimitForEEHost>200</ns1:accountNumberLimitForEEHost>
                    <ns1:allowOverageForEEHost>true</ns1:allowOverageForEEHost>
                    <ns1:accountNumberUsedForEEHost>40</ns1:accountNumberUsedForEEHost>
                    <ns1:attendeeCapacityForMC>200</ns1:attendeeCapacityForMC>
                    <ns1:attendeeCapacityForTC>200</ns1:attendeeCapacityForTC>
                    <ns1:attendeeCapacityForEC>200</ns1:attendeeCapacityForEC>
                    <ns1:attendeeCapacityForSC>200</ns1:attendeeCapacityForSC>
                </ns1:CISiteLicenseInfo>
            </ns1:siteInstance>
        </serv:bodyContent>
    </serv:body>
</serv:message>

XML API 11.0.0 SP22 Updates

File size limitation for UploadPMRImage

When uploading avatars using the API UploadPMRImage, a new limitation restricts the file size to 5 MB. Attempts to upload files larger than this will now receive an error message: "010100 Size of the image being uploaded is too big. Try an image smaller than 5MB in size."

XML API 11.0.0 SP21 Updates

Click here to download the XML API 11.0 SP21 schema.

New element autoRecord added to CreateMeeting, SetMeeting, GetMeeting, and LstMeeting

A new element, named autoRecord was added to the CreateMeeting, SetMeeting, GetMeeting, and LstMeeting APIs. autoRecord allows users to automatically record Webex meetings directly from the meeting scheduler. This provides meeting-level granularity, where the previous method to automatically record meetings could only be accessed globally at the site-level.


The autoRecord element only applies to Webex Meetings. It doesn't apply to Webex Events or Webex Training.

Affected APIs:

  • CreateMeeting

    • autoRecord

  • SetMeeting

    • autoRecord

  • GetMeeting

    • autoRecord

  • LstMeeting

    • autoRecord

CreateMeeting Updates:

autoRecord Setting

Behavior when Automatically record all sessions using Network Based Recording is disabled on Site Administration

True

Automatically start recording when the meeting starts

False (Default) or no element

Doesn't automatically start recording when the meeting starts


If Automatically record all sessions using Network Based Recording is enabled, the element is ignored and recording automatically starts when the meeting starts.

SetMeeting Updates:

autoRecord Setting

Behavior when Automatically record all sessions using Network Based Recording is disabled on Site Administration

True

Automatically start recording when the meeting starts

False (Default) or no element

Doesn't automatically start recording when the meeting starts


If Automatically record all sessions using Network Based Recording is enabled, the element is ignored and recording automatically starts when the meeting starts.

GetMeeting Updates:

autoRecord Setting

Behavior when Automatically record all sessions using Network Based Recording is disabled on Site Administration

True

Automatically start recording when the meeting starts

False

Doesn't automatically start recording when the meeting starts


If Automatically record all sessions using Network Based Recording is enabled, the element is ignored and recording automatically starts when the meeting starts.

GetMeeting Response Example:

LstMeeting Updates:

autoRecord Setting

Behavior when Automatically record all sessions using Network Based Recording is disabled on Site Administration

True

Automatically start recording when the meeting starts

False

Doesn't automatically start recording when the meeting starts


If Automatically record all sessions using Network Based Recording is enabled, the element is ignored and recording automatically starts when the meeting starts.

LstMeeting Response Example:

New element isAutoRecord added to GetSessionInfo API

Along with the changes made to the above APIs, a new element, isAutoRecord, was added to the GetSessionInfo API. This element can be used to indicate whether recording automatically starts when a meeting starts.

Affected APIs:

  • GetSessionInfo

    • isAutoRecord

GetSessionInfo Updates:

isAutoRecord Setting

Behavior when Automatically record all sessions using Network Based Recording is disabled on Site Administration

True

Automatically start recording when the meeting starts

False

Doesn't automatically start recording when the meeting starts


If Automatically record all sessions using Network Based Recording is enabled, the element is ignored and recording automatically starts when the meeting starts.

GetSessionInfo Response Example:

XML API 11.0.0 SP20 Updates

Click here to download the XML API 11.0 SP20 schema.

New element returnShareToMeRecording added to LstRecording API request


This change was previously announced in XML API 11.0 SP17, but is being applied to this update.

A new element, returnShareToMeRecording, was added to the LstRecording API. returnShareToMeRecording is a Boolean in the request for LstRecording.

This new element was added to support finding attendee or invitee recordings. returnShareToMeRecording is a flag to let the LstRecording API know it must return attendee or invitee recordings.

When returnShareToMeRecording is set to True, LstRecording returns the recording user as the owner, and also returns the recording user as an attendee or invitee shared by the owner.


If auto-share and manual share flags are both OFF, LstRecording returns the user only as the owner of the recordings.

When returnShareToMeRecording is set to False, or this element isn't included in the request, LstRecording follows the same logic as before: it returns the recordings user as the owner.

Affected APIs:

  • LstRecording

    • returnShareToMeRecording

LstRecording Updates:

Element shareToMe added to LstRecording API response


This change was previously announced in XML API 11.0 SP17, but is being applied to this update.

A new element, shareToMe, was added to the LstRecording API. shareToMe is a Boolean in the response for LstRecording.

This new element was added to support finding attendee or invitee recordings. shareToMe is a flag to define if the user is the owner of or an attendee for current recording.

When shareToMe is True, the user isn't the owner of current recording. The user may be an attendee, or the recording is shared by the owner.

When shareToMe is False, or this element isn't in the response, LstRecording follows the same logic as before: the user is the owner of the current recording.

Affected APIs:

  • LstRecording

    • shareToMe

LstRecording Updates:

returnShareToMeRecording and shareToMe Request Examples:

<bodyContent xsi:type=”java.com.webex.service.binding..ep.LstRecording”>
<hostWebExID>auto243</hostWebExID>
<createTimeScope>
<createTimeStart>08/15/2018 8:0:0</createTimeStart>
<createTimeEnd>09/05/2018 7:59:59</createTimeEnd>
<timeZoneID>20</timeZoneID>
</createTimeScope>
<serviceTypes>
<serviceType>MeetingCenter</serviceType>
<serviceType>EventCenter</serviceType>
<serviceType>TrainingCenter</serviceType>
</serviceTypes>
<returnShareToMeRecording>true</returnShareToMeRecording>
</bodyContent>

returnShareToMeRecording and shareToMe Response Examples:

New elements added to GetEvent API

Four new elements were added to the GetEvent API:

  • isCETMeeting: a Boolean True/False indicating if the Webex event supports Webex Video platform 2 (CMR 4.0)

  • sipURL: the URL used to join Webex Video meeting from a video conferencing system or application

  • standaloneDialingIPAddress: the IP address that can be used to dial into the Webex Video meeting from a video conferencing system or application

  • panelistNumericPassword: the password for joining the Webex Video meeting from a video conferencing system or application

If the site supports Webex Video, the host has Webex Events video privileges, and the event supports Webex Video platform 2 (CMR 4.0), GetEvent returns these elements. Otherwise, GetEvent doesn't return them.

Affected APIs:

  • GetEvent

    • isCETMeeting

    • sipURL

    • standaloneDialingIPAddress

    • panelistNumericPassword

New element panelistNumericPassword added to GetSessionInfo API

GetSessionInfo has a new element, panelistNumericPassword, which contains the password for joining the Webex Video meeting from a video conferencing system or application.

If the site supports Webex Video, the host has Webex Events video privileges, and the event supports Webex Video platform 2 (CMR 4.0), GetSessionInfo returns these four elements:

  • isCETMeeting: a Boolean True/False indicating if the Webex event supports Webex Video platform 2 (CMR 4.0)

  • sipURL: the URL used to join Webex Video meeting from a video conferencing system or application

  • standaloneDialingIPAddress: the IP address that can be used to dial into the Webex Video meeting from a video conferencing system or application

  • panelistNumericPassword: the password for joining the Webex Video meeting from a video conferencing system or application


For Webex Meetings, these elements already existed in GetSessionInfo:

  • isCETMeeting

  • sipURL

  • standaloneDialingIPAddress

Affected APIs:

  • GetSessionInfo

    • panelistNumericPassword

Schema changes made to GetEvent and GetSessionInfo

GetEvent Updates:

GetSessionInfo Updates:

XML API 11.0.0 SP18 Updates

Click here to download the XML API 11.0 SP18 schema.

New element EnableCloudTelepresence added to getSite API

A new element, EnableCloudTelepresence was added to the getSite API.

When the option EnableCETForAllUsers is enabled, Webex checks to see whether the user supports Webex video (CMR). It now also returns a new element EnableCloudTelepresence in the getSite API.

Affected APIs:

  • getSite

  • EnableCloudTelepresence

getSite Example Response:

XML API 11.0.0 SP17 Updates

New element returnShareToMeRecording added to LstRecording API request

A new element, returnShareToMeRecording, was added to the LstRecording API. returnShareToMeRecording is a Boolean in the request for LstRecording.

This new element was added to support pulling attendee or invitee recordings. returnShareToMeRecording is a flag to let the LstRecording API know it must return attendee or invitee recordings.

When returnShareToMeRecording is set to True, LstRecording returns the recordings user as owner, and also returns the recordings user as an attendee or invitee shared by the owner.


If auto-share and manual share flags are disabled, LstRecording returns only the user as the owner of the recordings.

When returnShareToMeRecording is set to False, or this element isn't included in the request, LstRecording follows the same logic as before: it returns the recordings user as the owner.

Affected APIs:

  • LstRecording

  • returnShareToMeRecording

LstRecording Updates:

New element shareToMe added to LstRecording API response

A new element, shareToMe, was added to the LstRecording API. shareToMe is a Boolean in the response for LstRecording.

This new element was added to support pulling attendee or invitee recordings. shareToMe is a flag to define if the user is the owner, or the attendee or invitee for current recording.

When shareToMe is True, the user isn't the owner of the current recording. The user may be an attendee or invitee, or the recording is shared by the owner.

When shareToMe is False, or this element isn't in the response, LstRecording follows the same logic as before: the user is the owner of the current recording.

Affected APIs:

  • LstRecording

  • shareToMe

LstRecording Updates:

New Elements for Attendee Capacity added to API getSite Response

Four new elements were added to the getSite API to indicate the attendee capacity for the following Webex services:

attendeeCapacityForMC - Webex Meetings

attendeeCapacityForEC – Webex Events

attendeeCapacityForTC – Webex Training

attendeeCapacityForSC – Webex Support

These returned values indicate the maximum number of attendees the meeting, event, or session can have. They are children of the CISiteLicenseInfo element in the response.

Affected APIs:

  • getSite

  • attendeeCapacityForMC

  • attendeeCapacityForEC

  • attendeeCapacityForTC

  • attendeeCapacityForSC

getSite Response Example:

<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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:getSiteResponse">
            <ns1:siteInstance>
...
...
                <ns1:CISiteLicenseInfo>
                    <ns1:accountNumberLimitForMC>999</ns1:accountNumberLimitForMC>
                    <ns1:allowOverageForMC>false</ns1:allowOverageForMC>
                    <ns1:accountNumberUsedForMC>43</ns1:accountNumberUsedForMC>
                    <ns1:accountNumberLimitForTC>999</ns1:accountNumberLimitForTC>
                    <ns1:allowOverageForTC>false</ns1:allowOverageForTC>
                    <ns1:accountNumberUsedForTC>44</ns1:accountNumberUsedForTC>
                    <ns1:accountNumberLimitForEC>999</ns1:accountNumberLimitForEC>
                    <ns1:allowOverageForEC>false</ns1:allowOverageForEC>
                    <ns1:accountNumberUsedForEC>22</ns1:accountNumberUsedForEC>
                    <ns1:accountNumberLimitForSC>999999</ns1:accountNumberLimitForSC>
                    <ns1:allowOverageForSC>false</ns1:allowOverageForSC>
                    <ns1:accountNumberUsedForSC>13</ns1:accountNumberUsedForSC>
                    <ns1:accountNumberLimitForCMRHost>999999</ns1:accountNumberLimitForCMRHost>
                    <ns1:allowOverageForCMRHost>false</ns1:allowOverageForCMRHost>
                    <ns1:accountNumberUsedForCMRHost>4</ns1:accountNumberUsedForCMRHost>
                    <ns1:attendeeCapacityForMC>1000</ns1:attendeeCapacityForMC>
                    <ns1:attendeeCapacityForTC>1000</ns1:attendeeCapacityForTC>
                    <ns1:attendeeCapacityForEC>3000</ns1:attendeeCapacityForEC>
                    <ns1:attendeeCapacityForSC>500</ns1:attendeeCapacityForSC>
                </ns1:CISiteLicenseInfo>
            </ns1:siteInstance>
        </serv:bodyContent>
    </serv:body>
</serv:message>

XML API 11.0.0 SP16 Updates

New API hostStreamURL added to lstRecordingResponse

The element hostStreamURL was added to the LstRecording response as part of the recording details. hostStreamURL returns a URL for the host to use to view the recording without having to sign in first. This URL is valid for 30 minutes after it is generated.

Affected APIs:

  • hostStreamURL

hostStreamURL Response Example:

<xsd:complexType name="recordingType">
<xsd:sequence>
<xsd:element name="recordingID" type="xsd:int"/>
<xsd:element name="hostWebExID" type="xsd:string"/>
<xsd:element name="name" type="xsd:string"/>
<xsd:element name="description" type="xsd:string"/>
<xsd:element name="createTime" type="xsd:string"/>
<xsd:element name="timeZoneID" type="xsd:int"/>
<xsd:element name="size" type="xsd:float"/>
<xsd:element name="streamURL" type="xsd:string"/>
<xsd:element name="hostStreamURL" type="xsd:string" minOccurs="0"/>
<xsd:element name="fileURL" type="xsd:string"/>

GetSite API uses new WebDB modeling to return data

By customer request, the API GetSite now retrieves more accurate host license, usage reporting data, and other data using the new WebDB modeling for CI sites.

Affected APIs:

  • GetSite

GetSite Response Example:

<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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:getSiteResponse">
            <ns1:siteInstance>
...
...
                <ns1:CISiteLicenseInfo>
                    <ns1:accountNumberLimitForMC>999</ns1:accountNumberLimitForMC>
                    <ns1:allowOverageForMC>false</ns1:allowOverageForMC>
                    <ns1:accountNumberUsedForMC>43</ns1:accountNumberUsedForMC>
                    <ns1:accountNumberLimitForTC>999</ns1:accountNumberLimitForTC>
                    <ns1:allowOverageForTC>false</ns1:allowOverageForTC>
                    <ns1:accountNumberUsedForTC>44</ns1:accountNumberUsedForTC>
                    <ns1:accountNumberLimitForEC>999</ns1:accountNumberLimitForEC>
                    <ns1:allowOverageForEC>false</ns1:allowOverageForEC>
                    <ns1:accountNumberUsedForEC>22</ns1:accountNumberUsedForEC>
                    <ns1:accountNumberLimitForSC>999999</ns1:accountNumberLimitForSC>
                    <ns1:allowOverageForSC>false</ns1:allowOverageForSC>
                    <ns1:accountNumberUsedForSC>13</ns1:accountNumberUsedForSC>
                    <ns1:accountNumberLimitForCMRHost>999999</ns1:accountNumberLimitForCMRHost>
                    <ns1:allowOverageForCMRHost>false</ns1:allowOverageForCMRHost>
                    <ns1:accountNumberUsedForCMRHost>4</ns1:accountNumberUsedForCMRHost>
                </ns1:CISiteLicenseInfo>
            </ns1:siteInstance>
        </serv:bodyContent>
    </serv:body>
</serv:message>

GetSite Response Example for EE sites:

<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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:getSiteResponse">
            <ns1:siteInstance>
...
...
                <ns1:CISiteLicenseInfo>
                    <ns1:accountNumberLimitForCMRHost>80</ns1:accountNumberLimitForCMRHost>
                    <ns1:allowOverageForCMRHost>true</ns1:allowOverageForCMRHost>
                    <ns1:accountNumberUsedForCMRHost>99</ns1:accountNumberUsedForCMRHost>
                    <ns1:accountNumberLimitForEEHost>999999</ns1:accountNumberLimitForEEHost>
                    <ns1:allowOverageForEEHost>false</ns1:allowOverageForEEHost>
                    <ns1:accountNumberUsedForEEHost>368</ns1:accountNumberUsedForEEHost>
                </ns1:CISiteLicenseInfo>
            </ns1:siteInstance>
        </serv:bodyContent>
    </serv:body>
</serv:message>

XML API 11.0.0 SP15 Updates

Return Webex Meetings meeting link using the GetSessionsInfo API

The schema for the GetSessionInfo API has a new return value, meetingLink. You can use a meeting link to start a Webex meeting as a host or by joining a Webex meeting as an attendee.

Affected APIs:

  • GetSessionInfo

  • meetingLink

GetSessionInfo Response Example:

    <ep:meetingLink>https://hmwds6.qa.webex.com/hmwds6/j.php?MTID=m265e64705c6660d4132c2d4f19aed7e7</ep:meetingLink>
</serv:bodyContent>

New condition for querying by RecordingID on LstRecording API

You can now use LstRecording to query recordings using recordingID. There are two kinds of recording IDs:

  • Recording IDs for Webex Meetings, Webex Events, and Webex Training

  • NBR Recording IDs for miscellaneous recordings

If there's a serviceType element in the XML request, then LstRecording returns a Service Recording (Webex Meetings, Webex Events, and Webex Training) only.

If there is no serviceType element in the XML request, then LstRecording returns an NBR Recording only.

Affected APIs:

  • LstRecording

  • RecordingID

LstRecording Response Examples:

Request Example for a Service Recording ID:

<bodyContent xsi:type="java:com.webex.service.binding.ep.LstRecording">
    <serviceTypes>
        <serviceType>MeetingCenter</serviceType>
        <serviceType>EventCenter</serviceType>
        <serviceType>TrainingCenter</serviceType>
    </serviceTypes>
    <recordingID>974164492</recordingID>
    <order>
         <orderBy>CREATETIME</orderBy>
         <orderAD>DESC</orderAD>
         <orderBy>HOSTID</orderBy>
         <orderAD>ASC</orderAD>
         <orderBy>RECORDNAME</orderBy>
         <orderAD>ASC</orderAD>
    </order>
</bodyContent>

Request Example for an NBR Recording ID:

<bodyContent xsi:type="java:com.webex.service.binding.ep.LstRecording">
    <recordingID>974154032</recordingID>
    <order>
         <orderBy>CREATETIME</orderBy>
         <orderAD>DESC</orderAD>
         <orderBy>HOSTID</orderBy>
         <orderAD>ASC</orderAD>
         <orderBy>RECORDNAME</orderBy>
         <orderAD>ASC</orderAD>
    </order>
</bodyContent>

XML API 11.0.0 SP14 Updates

Preliminary Usage Summary Reports for Meeting Center

Two new APIs were added for Meeting Center preliminary reports, LstmeetingusagePreliminaryHistory and LstmeetingattendeePreliminaryHistory. These will have the same behavior as LsteventsessionPreliminaryHistory and LsteventattendeePreliminaryHistory in the final report.

Affected APIs:

  • LstmeetingusagePreliminaryHistory

  • LstmeetingattendeePreliminaryHistory

LstmeetingusagePreliminaryHistory Request 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>testuser</webExID>
            <password>****</password>
            <siteName>testsite</siteName>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.history.LstmeetingusagePreliminaryHistory">
            <startTimeScope>
                <sessionStartTimeStart>4/23/2018 00:00:00</sessionStartTimeStart>
                <sessionStartTimeEnd>4/24/2018 11:59:59</sessionStartTimeEnd>
            </startTimeScope>
            <listControl>
                <startFrom>1</startFrom>
                <maximumNum>10</maximumNum>
                <listMethod>AND</listMethod>
            </listControl>
            <order>
                <orderBy>STARTTIME</orderBy>
                <orderAD>ASC</orderAD>
                <orderBy>CONFNAME</orderBy>
                <orderAD>ASC</orderAD>
                <orderBy>CONFID</orderBy>
                <orderAD>ASC</orderAD>
            </order>
        </bodyContent>
    </body>
</serv:message>

LstmeetingusagePreliminaryHistory Response Example:

<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:history="http://www.webex.com/schemas/2002/06/service/history">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="history:lstmeetingusagePreliminaryHistoryResponse">
            <history:meetingUsagePreliminaryHistory>
                <history:confID>93115261364733685</history:confID>
                <history:sessionKey>800150023</history:sessionKey>
                <history:confName>200804231215</history:confName>
                <history:openTime>04/23/2018 19:16:34</history:openTime>
                <history:timeZoneID>4</history:timeZoneID>
                <history:meetingType>PRO</history:meetingType>
                <history:timeZoneWithDST>San Francisco (Pacific Daylight Time, GMT-07:00)</history:timeZoneWithDST>
                <history:trackingCode>
                    <com:trackingCode1>mytrackingcode1</com:trackingCode1>
                    <com:trackingCode2>mytrackingcode2</com:trackingCode2>
                </history:trackingCode>
                <history:registered>1</history:registered>
                <history:invited>1</history:invited>
                <history:attended>3</history:attended>
            </history:meetingUsagePreliminaryHistory>
            <history:matchingRecords>
                <serv:total>1</serv:total>
                <serv:returned>1</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </history:matchingRecords>
        </serv:bodyContent>
    </serv:body>
</serv:message>

LstmeetingattendeePreliminaryHistory Request 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>testuser</webExID>
            <password>****</password>
            <siteName>testsite</siteName>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.history.LstmeetingattendeePreliminaryHistory">
            <startTimeScope>
                <sessionStartTimeStart>4/23/2018 00:00:00</sessionStartTimeStart>
                <sessionStartTimeEnd>4/24/2018 11:59:59</sessionStartTimeEnd>
            </startTimeScope>
            <listControl>
                <startFrom>1</startFrom>
                <maximumNum>10</maximumNum>
                <listMethod>AND</listMethod>
            </listControl>
            <order>
                <orderBy>STARTTIME</orderBy>
                <orderAD>ASC</orderAD>
                <orderBy>CONFID</orderBy>
                <orderAD>ASC</orderAD>
            </order>
        </bodyContent>
    </body>
</serv:message>

LstmeetingattendeePreliminaryHistory Response Example:

<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:history="http://www.webex.com/schemas/2002/06/service/history">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="history:lstmeetingattendeePreliminaryHistoryResponse">
            <history:meetingAttendeePreliminaryHistory>
                <history:meetingKey>800150023</history:meetingKey>
                <history:confName>200804231215</history:confName>
                <history:company>XYZ</history:company>
                <history:title>DJ</history:title>
                <history:phoneNumber>1,222,654-3210,,,,</history:phoneNumber>
                <history:address1>1 Any Street</history:address1>
                <history:address2>xyz</history:address2>
                <history:city>SanJose</history:city>
                <history:state>CA</history:state>
                <history:country>USA</history:country>
                <history:zipCode>95111</history:zipCode>
                <history:name>user test2</history:name>
                <history:email>ut2@qa.webex.com</history:email>
                <history:joinTime>04/23/2018 19:13:06</history:joinTime>
                <history:participantType>ATTENDEE</history:participantType>
                <history:confID>93115261364733685</history:confID>
            </history:meetingAttendeePreliminaryHistory>
            <history:meetingAttendeePreliminaryHistory>
                <history:meetingKey>800150023</history:meetingKey>
                <history:confName>200804231215</history:confName>
                <history:name>zzz zzzz</history:name>
                <history:email>z6@webex.com</history:email>
                <history:joinTime>04/23/2018 19:14:10</history:joinTime>
                <history:participantType>ATTENDEE</history:participantType>
                <history:confID>93115261364733685</history:confID>
            </history:meetingAttendeePreliminaryHistory>
            <history:meetingAttendeePreliminaryHistory>
                <history:meetingKey>800150023</history:meetingKey>
                <history:confName>200804231215</history:confName>
                <history:name>test host</history:name>
                <history:email>testuser@webex.com</history:email>
                <history:joinTime>04/23/2018 19:12:42</history:joinTime>
                <history:participantType>ATTENDEE</history:participantType>
                <history:confID>93115261364733685</history:confID>
            </history:meetingAttendeePreliminaryHistory>
            <history:matchingRecords>
                <serv:total>3</serv:total>
                <serv:returned>3</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </history:matchingRecords>
        </serv:bodyContent>
    </serv:body>
</serv:message>

Returning SIP URL and Skype URL from GLA GetsessionInfo API

Two new elements, <sipURL> and <skypeURL>, were appended to the response when calling the GLA GetSessionInfo API. These elements are base elements which can be returned for anonymous access.

  • <sipURL> can be used to join meetings from a TelePresence or other Cisco video device. This way, only meetings using Cisco video platform versions 1.0 or 2.0 should GetSessionInfo return the <sipURL> element.

  • <skypeURL> can be used to join meetings from a Microsoft Skype app, without any limitations or conditions, so it can be returned for each call.

Affected APIs:

  • GetSessionInfo

Response Example:

Returning SIP URL and Meeting Link from GetMeeting API

Three new elements, <isCETMeeting>, <meetingLink>, and <sipURL>, were appended to the response when calling the GetMeeting API.

  • <isCETMeeting> returns whether the meeting is using a Cisco video platform (supports TelePresence and video).

  • <meetingLink> can be used to connect to meetings.

  • <sipURL> can be used to join meetings from a TelePresence or other Cisco video device. This way, only meetings using Cisco video platform versions 1.0 or 2.0 should GetMeeting return the element.

Affected APIs:

  • GetMeeting

GetMeeting Response Example:

XML API 11.0.0 SP13 Updates

Announcement of deprecation of the <siteID> element in parent <securityContext>

Cisco plans to deprecate the <siteID> element in the parent <securityContext> element, and replace it with the <siteName>. Due to a large number of <siteID> elements often being changed during site migrations, organizations incur high maintenance costs to keep using this element. This is a two year advance notification.

  • For existing WebEx customers the impact will occur May 1, 2020.

  • New customers must use the <siteName> element beginning May 1, 2018.

  • Customers doing integrations with CI, Spark, or the Atlas system, must use the <siteName> element beginning May 1, 2018.

Affected APIs:

  • <siteName>

  • <securityContext>

Data validation of the <tollCallInData> and <tollFreeCallInData> Elements

Beginning June 1, 2018, both the <tollCallInData> and <tollFreeCallInData> APIs will be data validated. This affects the <CreateUser> and <SetUser> APIs.

Sites that use non-valid strings or improperly-formatted strings in their call in data must correct the strings in order for these elements to pass data validation.

Below are examples of CreateUser and SetUser, tollCallInData and tollFreeCallInData in the correct format:

<tspAccount>
    <tspAccount>
        <tollFreeCallInNumber>86,123,4567000</tollFreeCallInNumber>
        <tollFreeCallInData>1,86</tollFreeCallInData>
        <accountIndex>1</accountIndex>
        <tollCallInNumber>86,123,4567890</tollCallInNumber>
        <tollCallInData>0,86</tollCallInData>
        <subscriberAccessCode>12341234</subscriberAccessCode>
        <participantAccessCode>12341234</participantAccessCode>
        <createOnBridge>false</createOnBridge>
        <defaultFlag>false</defaultFlag>
    </tspAccount>
</tspAccount>
...

XML API 11.0.0 SP12 Updates

Two new APIs SetContact and DelContacts

The XML API schema previously only had the two APIs CreateContacts and LstContacts, which did not provide complete management of user contacts. In order to provide better functionality for managing user contact using the XML API, we’ve added these two new APIs, SetContact and DelContacts.

API

Notes

SetContact

Call this API to modify contact information such as email, name, title, and language.

Exceptions:

  • If the contact isn't found by the contactEmail element, the exception 140004 "Contact not found" is returned

  • If the Webex site doesn't support a given language, the exception 030060 "Not a valid language" is returned

  • If the new email address that the user want to change to is a duplicate with another contact in the My Contacts list, the exception 140001 "Email is used by another contact" is returned

DelContacts

Call this API to delete one or more contacts from the My Contacts list based on given emails.

contactID is returned if the given email can be found from the My Contacts list, and ignores the given email if it isn't in the My Contacts list.

If all given emails aren't found in the My Contacts list, the exception 00015 (Sorry, no record found) is returned.

Affected APIs:

  • SetContact

  • DelContacts

SetContact Request Example:

<?xml version="1.0" encoding="ISO-8859-1"?>
<serv:message  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:serv="http://www.webex.com/schemas/2002/06/service">
<header>
    <securityContext>
      <siteName>SiteName</siteName>
      <webExID>UserID</webExID>
       <password>UserPWD</password>
    </securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.ep.SetContact">
            <contactEmail>Contact Email adress</contactEmail>
           <contact>
                <name>New Contact Name</name>
                <email>New Contact Email Address</email>
                <title>New Title</title>
                <company>New Company</company>
                <notes>New Notes</notes>
                <url>New Link</url>
                <phones>
                    <phone>1,,408######,,,,</phone>
                    <mobilePhone>1,,408######,,,,</mobilePhone>
                    <fax>1,,408######,,,,</fax>
                </phones>
                <address>
                    <address1>New Address 1</address1>
                    <address2>New Address 2</address2>
                    <city>New City</city>
                    <state>New State</state>
                    <zipCode>New ZipCode</zipCode>
                    <country>New Company</country>
                </address>
                <language>New Language</language>
            </contact>
</bodyContent>
</body>
</serv:message>

SetContact Response Example:

<?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>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="ep:setContactResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
    </serv:body>
</serv:message>

DelContacts Request Example:

<?xml version="1.0" encoding="ISO-8859-1"?>
<serv:message  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:serv="http://www.webex.com/schemas/2002/06/service">
<header>
    <securityContext>
      <siteName>SiteName</siteName>
      <webExID>UserID</webExID>
       <password>UserPWD</password>
    </securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.ep.DelContacts">
        <contactEmail>contact1@qa.webex.com</contactEmail>
        <contactEmail>contact2@qa.webex.com</contactEmail>
</bodyContent>
</body>
</serv:message>

DelContacts Response Examples:


In this example, two existing contacts are deleted from the My Contacts list.

<?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>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="ep:delContactsResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ep:contactID>31830997</ep:contactID>
            <ep:contactID>31831002</ep:contactID>
        </serv:bodyContent>
    </serv:body>
</serv:message>


In this example, the emails aren't in the My Contacts list.

<?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>Sorry, no record found</serv:reason>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
            <serv:exceptionID>000015</serv:exceptionID>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent/>
    </serv:body>
</serv:message>

XML API 11.0.0 SP11 Updates

New API LstTrainingPollResultsHistory

The LstTrainingPollResultsHistory API was originally implemented in the URL API. By customer request, it's now implemented in the XML API.

List polling results are returned by inputting a Training Center sessionKey. The API can be requested by either the Training Center session owner or a site administrator.


The Enhanced TC Polling setting must be enabled before training poll results are stored in the WebEx DB:

Affected APIs:

  • LstTrainingPollResultsHistory

LstTrainingPollResultHistory Request 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>
            <!-- <returnAdditionalInfo>true</returnAdditionalInfo> -->
            <webExID>ut2</webExID>
            <password>xxxxxxx</password>
            <siteName>testsite1</siteName>
        </securityContext>
    </header>
    <body>
        <bodyContent
xsi:type="java:com.webex.service.binding.history.LstTrainingPollResultsHistory"
            xmlns:meet="http://www.webex.com/schemas/2002/06/service/history">
            <listControl>
                <startFrom>1</startFrom>
                <maximumNum>10</maximumNum>
            </listControl>
            <confID>81722715648558691</confID>
        </bodyContent>
    </body>
</serv:message>


The request is only for T32/XML API 11.0.0.

LstTrainingPollResultHistory Response Example:

<?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:history="http://www.webex.com/schemas/2002/06/service/history">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="history:lstTrainingPollResultsHistoryResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <history:matchingRecords>
                <serv:total>2</serv:total>
                <serv:returned>2</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </history:matchingRecords>
            <history:sessionInfo>
                <history:sessionKey>81901776767288734</history:sessionKey>
                <history:confName>TC poll test 20171220 1635</history:confName>
                <history:host>John Doe</history:host>
            </history:sessionInfo>
            <history:polls>
                <history:poll>
                    <history:pollDesc>Test</history:pollDesc>
                    <history:timeLimit>300</history:timeLimit>
                    <history:startTime>12/20/2017 16:54:48</history:startTime>
                    <history:endTime>12/20/2017 16:58:07</history:endTime>
                    <history:numAttendees>3</history:numAttendees>
                    <history:questions>
                        <history:question>
                            <history:questionSequence>1</history:questionSequence>
                            <history:questionDesc>test question 1 (multi-choice/single-answer)</history:questionDesc>
                            <history:questionType>1</history:questionType>
                            <history:answerChoices>
                                <history:answerChoice>test answer 4</history:answerChoice>
                                <history:answerChoice>test answer 3</history:answerChoice>
                                <history:answerChoice correct="true">test answer 2</history:answerChoice>
                                <history:answerChoice>test answer 1</history:answerChoice>
                            </history:answerChoices>
                            <history:attendees>
                                <history:attendee>
                                    <history:username>2128465742</history:username>
                                    <history:fullName>test</history:fullName>
                                    <history:email>test@qa.webex.com</history:email>
                                    <history:pollResponse>test answer 2</history:pollResponse>
                                    <history:isCorrect>true</history:isCorrect>
                                </history:attendee>
                                <history:attendee>
                                    <history:username>2128465747</history:username>
                                    <history:fullName>test2</history:fullName>
                                    <history:email>test2@qa.webex.com</history:email>
                                    <history:pollResponse>test answer 1</history:pollResponse>
                                    <history:isCorrect>false</history:isCorrect>
                                </history:attendee>
                                <history:attendee>
                                    <history:username>2128465752</history:username>
                                    <history:fullName>test3</history:fullName>
                                    <history:email>test3@qa.webex.com</history:email>
                                    <history:pollResponse>No Answer</history:pollResponse>
                                    <history:isCorrect>false</history:isCorrect>
                                </history:attendee>
                            </history:attendees>
                        </history:question>
                        <history:question>
                            <history:questionSequence>2</history:questionSequence>
                            <history:questionDesc>test question 2 (multi-choiec.multi-answer)</history:questionDesc>
                            <history:questionType>2</history:questionType>
                            <history:answerChoices>
                                <history:answerChoice>test answer D</history:answerChoice>
                                <history:answerChoice>test answer C</history:answerChoice>
                                <history:answerChoice correct="true">test answer B</history:answerChoice>
                                <history:answerChoice correct="true">test answer A</history:answerChoice>
                            </history:answerChoices>
                            <history:attendees>
                                <history:attendee>
                                    <history:username>2128465742</history:username>
                                    <history:fullName>test</history:fullName>
                                    <history:email>test@qa.webex.com</history:email>
                                    <history:pollResponse>test answer B,test answer A</history:pollResponse>
                                    <history:isCorrect>true</history:isCorrect>
                                </history:attendee>
                                <history:attendee>
                                    <history:username>2128465747</history:username>
                                    <history:fullName>test2</history:fullName>
                                    <history:email>test2@qa.webex.com</history:email>
                                    <history:pollResponse>test answer D,test answer C,test answer B,test answer A</history:pollResponse>
                                    <history:isCorrect>false</history:isCorrect>
                                </history:attendee>
                                <history:attendee>
                                    <history:username>2128465752</history:username>
                                    <history:fullName>test3</history:fullName>
                                    <history:email>test3@qa.webex.com</history:email>
                                    <history:pollResponse>No Answer</history:pollResponse>
                                    <history:isCorrect>false</history:isCorrect>
                                </history:attendee>
                            </history:attendees>
                        </history:question>
                        <history:question>
                            <history:questionSequence>3</history:questionSequence>
                            <history:questionDesc>test question 2 (short answer)</history:questionDesc>
                            <history:questionType>3</history:questionType>
                            <history:attendees>
                                <history:attendee>
                                    <history:username>2128465742</history:username>
                                    <history:fullName>test</history:fullName>
                                    <history:email>test@qa.webex.com</history:email>
                                    <history:pollResponse>ans1</history:pollResponse>
                                </history:attendee>
                                <history:attendee>
                                    <history:username>2128465747</history:username>
                                    <history:fullName>test2</history:fullName>
                                    <history:email>test2@qa.webex.com</history:email>
                                    <history:pollResponse>ans2</history:pollResponse>
                                </history:attendee>
                                <history:attendee>
                                    <history:username>2128465752</history:username>
                                    <history:fullName>test3</history:fullName>
                                    <history:email>test3@qa.webex.com</history:email>
                                    <history:pollResponse>No Answer</history:pollResponse>
                                </history:attendee>
                            </history:attendees>
                        </history:question>
                    </history:questions>
                </history:poll>
                <history:poll>
                    <history:pollDesc>Survey</history:pollDesc>
                    <history:timeLimit>300</history:timeLimit>
                    <history:startTime>12/20/2017 16:58:57</history:startTime>
                    <history:endTime>12/20/2017 17:02:39</history:endTime>
                    <history:numAttendees>3</history:numAttendees>
                    <history:questions>
                        <history:question>
                            <history:questionSequence>1</history:questionSequence>
                            <history:questionDesc>survey question 1 (multi-choiec/sinngle-answer)</history:questionDesc>
                            <history:questionType>1</history:questionType>
                            <history:answerChoices>
                                <history:answerChoice>survey answer 3</history:answerChoice>
                                <history:answerChoice>survey answer 2</history:answerChoice>
                                <history:answerChoice>survey answer 1</history:answerChoice>
                            </history:answerChoices>
                            <history:attendees>
                                <history:attendee>
                                    <history:username>2128465757</history:username>
                                    <history:fullName>test</history:fullName>
                                    <history:email>test@qa.webex.com</history:email>
                                    <history:pollResponse>survey answer 3</history:pollResponse>
                                </history:attendee>
                                <history:attendee>
                                    <history:username>2128465762</history:username>
                                    <history:fullName>test2</history:fullName>
                                    <history:email>test2@qa.webex.com</history:email>
                                    <history:pollResponse>survey answer 2</history:pollResponse>
                                </history:attendee>
                                <history:attendee>
                                    <history:username>2128465767</history:username>
                                    <history:fullName>test3</history:fullName>
                                    <history:email>test3@qa.webex.com</history:email>
                                    <history:pollResponse>No Answer</history:pollResponse>
                                </history:attendee>
                            </history:attendees>
                        </history:question>
                        <history:question>
                            <history:questionSequence>2</history:questionSequence>
                            <history:questionDesc>survey question 2 (multi-choiec/multi-answer)</history:questionDesc>
                            <history:questionType>2</history:questionType>
                            <history:answerChoices>
                                <history:answerChoice>survey answer D</history:answerChoice>
                                <history:answerChoice>survey answer C</history:answerChoice>
                                <history:answerChoice>survey answer B</history:answerChoice>
                                <history:answerChoice>survey answer A</history:answerChoice>
                            </history:answerChoices>
                            <history:attendees>
                                <history:attendee>
                                    <history:username>2128465757</history:username>
                                    <history:fullName>test</history:fullName>
                                    <history:email>test@qa.webex.com</history:email>
                                    <history:pollResponse>survey answer D,survey answer C</history:pollResponse>
                                </history:attendee>
                                <history:attendee>
                                    <history:username>2128465762</history:username>
                                    <history:fullName>test2</history:fullName>
                                    <history:email>test2@qa.webex.com</history:email>
                                    <history:pollResponse>survey answer C,survey answer B</history:pollResponse>
                                </history:attendee>
                                <history:attendee>
                                    <history:username>2128465767</history:username>
                                    <history:fullName>test3</history:fullName>
                                    <history:email>test3@qa.webex.com</history:email>
                                    <history:pollResponse>No Answer</history:pollResponse>
                                </history:attendee>
                            </history:attendees>
                        </history:question>
                        <history:question>
                            <history:questionSequence>3</history:questionSequence>
                            <history:questionDesc>survey question 3 (short answer)</history:questionDesc>
                            <history:questionType>3</history:questionType>
                            <history:attendees>
                                <history:attendee>
                                    <history:username>2128465757</history:username>
                                    <history:fullName>test</history:fullName>
                                    <history:email>test@qa.webex.com</history:email>
                                    <history:pollResponse>AAA</history:pollResponse>
                                </history:attendee>
                                <history:attendee>
                                    <history:username>2128465762</history:username>
                                    <history:fullName>test2</history:fullName>
                                    <history:email>test2@qa.webex.com</history:email>
                                    <history:pollResponse>BBB</history:pollResponse>
                                </history:attendee>
                                <history:attendee>
                                    <history:username>2128465767</history:username>
                                    <history:fullName>test3</history:fullName>
                                    <history:email>test3@qa.webex.com</history:email>
                                    <history:pollResponse>No Answer</history:pollResponse>
                                </history:attendee>
                            </history:attendees>
                        </history:question>
                    </history:questions>
                </history:poll>
            </history:polls>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The response is different if the meeting isn't found, doesn't belong to the user requesting it, or if the user requesting it isn't also a site administrator.

Response Example:

<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:history="http://www.webex.com/schemas/2002/06/service/history">
    <serv:header>
        <serv:response>
            <serv:result>FAILURE</serv:result>
            <serv:reason>Sorry, no record found</serv:reason>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
            <serv:exceptionID>000015</serv:exceptionID>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent/>
    </serv:body>
</serv:message>

New attendeeSendVideo option in the APIs CreateTrainingSession, SetTrainingSession, and GetTrainingSession

Because the options available when scheduling a Training Center session include Send Video, the XML API has now added the attendeeSendVideo option to create, get, and set APIs for Training Center sessions.

Affected APIs:

  • CreateTrainingSession

  • SetTrainingSession

  • GetTrainingSession

Design

The option was stored in DB table WbxMMConfParam/paramvalue as paramname = 'optionSupportSendVideo'

CreateTrainingSession Request Updates:

SetTrainingSession Request Updates:


The request is only for T32/XML API11.0.0.

GetTrainingSession Response Updates:

Change ConfName size limit maximum to 128 display characters

The conference name string ConfName is now limited to a maximum of 128 display characters. This change aligns with the J2EE home page limitation. If an API request includes ConfName that is empty or exceeds a 128 display character length, the following error message is displayed:

"060065 Illegal input conference name. The conference name can't be empty or exceed the maximum display character length 128."

Affected APIs:

  • ConfName

Exception message changed in API LstRecording

The exception message thrown when the query time scope exceeds the maximum limit on the API LstRecording was changed. By default, queries support 4 weeks of recordings. Requests of more than four weeks receive the following error message:

"999999 Exceeded maximum querying time scope of 28 days".

Affected APIs:

  • LstRecording

XML API 11.0.0 SP10 Updates

The XML API 11.0 SP10 update has no schema changes.