XML API 41.5.0 Updates

Click here to download the XML API 41.5.0 schema.

XMLAPI has ability to start Webex scheduled meetings from PSTN as host

Impacted APIs

• CreateUser: generates hostPIN regardless user PMR is enabled or not when the user role is host or full or read-only or user-management site administrators.

• SetUser: sets hostPIN using phones.hostPIN when personalMeetingRoom.hostPIN isn’t in XML request (pre-condition: feature toggle AllowStartScheduledMtgFromPhone is enabled).

• GetUser: returns phones.hostPIN regardless user PMR is enabled or not. (pre-condition: feature toggle AllowStartScheduledMtgFromPhone is enabled).

Schema Changes

GetUserResponse:

SetUser:

Response example

GetUserResponse:

SetUser:

XMLAPI GetSite response two new elements for mobile client

Impacted APIs

• GetSite: GetSite will now response two new elements to support mobile client has the logic to display or not display the recording tab.

  • enableRecordingAccess: true or false, Webex super administrators can enable or disable recording access by the toggle(EnableRecordingAccesses).

  • storageEmptyStatus: true or false, if both the sites don't support NBR function and allocated the NBR storage space as zero, then the status response is true, else is false.

Schema Changes

Sample Request for GetSite

Sample Response for Getsite

Email subject that has non-ASCII characters will be encoded with RFC2047. In case of a pure ASCII character email subject, there’s no encoding

There are no impacts on any API request, responses payload, but it changes email subject's encode behavior. When email's subject that has non-ASCII characters will be encoded with RFC2047. In case of a pure ASCII character email subject, there’s no encoding.

Schema Changes

There are no schema changes.

XML API 41.4.0 Updates

Click here to download the XML API 41.4.0 schema.

Create Event scheduled Webex Events can leverage site-level default on entry and exit tone

XMLAPI aligns with the current new logic for controlling entry and exit tone. All tones for Webex Events was controlled by a different setting in site administration. In GetSite, XMLAPI returns an extra field entryExitToneEC to indicate the value. Originally, when the site administrator set a default to the tone, create Event won’t leverage this setting by applying XMLAPI default.

Impacted APIs

The XML API: GetSite returns one new element entryExitToneEC to indicate the value.

The XML API: CreateEvent, SetEvent, GetEvent back end business logic reads the value of entryExitToneEC.

Schema changes

XML API: GetSite response sample:

<ns1:defaults>
    <ns1:emailReminders>true</ns1:emailReminders>
    <ns1:entryExitTone>ANNOUNCENAME</ns1:entryExitTone>
    <ns1:entryExitToneEC>NOTONE</ns1:entryExitToneEC>
    <ns1:voip>true</ns1:voip>
    <ns1:teleconference>
        <ns1:telephonySupport>NONE</ns1:telephonySupport>
    </ns1:teleconference>
    <ns1:joinTeleconfNotPress1>true</ns1:joinTeleconfNotPress1>
    <ns1:updateTSPAccount>false</ns1:updateTSPAccount>
</ns1:defaults>

Affect APIs:

• GetSite

• CreateEvent

• SetEvent

• GetEvent

XMLAPI just returns the large event (Webex Event 2.0) detail information

1. If the Webex Meeting is the large event or webcast, GetSessionInfo returns some detail information including meeting password, meeting numeric password, panelist password, and panelist numeric password (No schema be changed).

2. XMLAPI doesn’t support creating and editing any large event or webcast feature, so CreateMeeting and SetMeeting return a new exception (110064, The event and webcast session type aren’t supported.) for large event or webcast case.

Impact APIs

XML API 41.3.0 Updates

Click here to download the XML API 41.3.0 schema.

The XML API new changes support Webex Events 2.0 feature

Impacted APIs

Both the APIs: GetSessionInfo and GetMeeting return elements enableEvent and enableWebniar too.

XMLAPI support returns above two elements for EC 2.0. Current XML API release doesn't support to schedule and set EC2.0 meeting.

Schema changes

GetSessionInfo returns elements enableEvent and enableWebniar for EC 2.0.

GetMeeting returns elements enableEvent and enableWebniar for EC 2.0.

Response Sample:

GetSessionInfo response:

<ep:accessControl>
                <ep:listStatus>PUBLIC</ep:listStatus>
                <ep:registration>false</ep:registration>
                <ep:passwordReq>true</ep:passwordReq>
                <ep:isEnforceAudioPassword>false</ep:isEnforceAudioPassword>
                <ep:isEnforceAudioLogin>false</ep:isEnforceAudioLogin>
                <ep:enableEvent>false</ep:enableEvent>
                <ep:enableWebniar>false</ep:enableWebniar>
                <ep:enablePreMeetingLobby>true</ep:enablePreMeetingLobby>
            </ep:accessControl>

GetMeeting response:

  <meet:supportPKI>false</meet:supportPKI>
                <meet:HQvideo>true</meet:HQvideo>
                <meet:HDvideo>true</meet:HDvideo>
                <meet:viewVideoThumbs>true</meet:viewVideoThumbs>
                <meet:enableEvent>false</meet:enableEvent>
                <meet:enableWebniar>false</meet:enableWebniar>
                <meet:enablePreMeetingLobby>true</meet:enablePreMeetingLobby>
            </meet:enableOptions>



The XMLAPI new changes support Pre-Meeting lobby feature

Impacted APIs

The XML API: GetSite, LstSummarySession, GetSessionInfo, and GetMeeting will response the new element enablePreMeetingLobby for Pre-Meeting Lobby.

Schema changes

The XML API: GetSite returns element enablePreMeetingLobby for Pre-Meeting Lobby.

The XML API: LstSummarySession returns element enablePreMeetingLobby for Pre-Meeting Lobby.

The XML API: GetSessionInfo returns element enablePreMeetingLobby for Pre-Meeting Lobby.

The XML API: GetMeeting returns element enablePreMeetingLobby for Pre-Meeting Lobby.

Response Sample:

GetSite response:

<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:SupportXMLAPIReturnScheduledPMR>false</ns1:SupportXMLAPIReturnScheduledPMR>
                    <ns1:SupportAnyoneHostMeetings>true</ns1:SupportAnyoneHostMeetings>
                    <ns1:enablePreMeetingLobby>true</ns1:enablePreMeetingLobby>
                </ns1:siteCommonOptions>

LstSummarySession response:

<ep:isException>false</ep:isException>
                <ep:isNextUpcomingInstance>true</ep:isNextUpcomingInstance>
                <ep:seriesMeetingKey>0</ep:seriesMeetingKey>
                <ep:isScheduledPMR>false</ep:isScheduledPMR>
                <ep:enableEvent>false</ep:enableEvent>
                <ep:enableWebniar>false</ep:enableWebniar>
               <ep:enablePreMeetingLobby>true</ep:enablePreMeetingLobby>
            </ep:session>

GetSessionInfo response:

<ep:accessControl>
                <ep:listStatus>PUBLIC</ep:listStatus>
                <ep:registration>false</ep:registration>
                <ep:passwordReq>true</ep:passwordReq>
                <ep:isEnforceAudioPassword>false</ep:isEnforceAudioPassword>
                <ep:isEnforceAudioLogin>false</ep:isEnforceAudioLogin>
                <ep:enableEvent>false</ep:enableEvent>
                <ep:enableWebniar>false</ep:enableWebniar>
                <ep:enablePreMeetingLobby>true</ep:enablePreMeetingLobby>
            </ep:accessControl>

GetMeeting response:

<meet:supportPKI>false</meet:supportPKI>
                <meet:HQvideo>true</meet:HQvideo>
                <meet:HDvideo>true</meet:HDvideo>
                <meet:viewVideoThumbs>true</meet:viewVideoThumbs>
                <meet:enableEvent>false</meet:enableEvent>
                <meet:enableWebniar>false</meet:enableWebniar>
                <meet:enablePreMeetingLobby>true</meet:enablePreMeetingLobby>
            </meet:enableOptions>

The XML API GetSite response Information behavior change disclose

Impacted APIs

The XML API: GetSite only response below elements for administrator account, which include roles: SiteAdmin, RO_SiteAdmin, and UserAdmin.

<ns1:activeUserCount>...</ns1:activeUserCount>
<ns1:EEActiveUserCount>...</ns1:EEActiveUserCount>
<ns1:activeCETHost>...</ns1:activeCETHost>
<ns1:auoActiveUserCount>...</ns1:auoActiveUserCount>
<ns1:MCActiveUserCount>...</ns1:MCActiveUserCount>
<ns1:ECActiveUserCount>...</ns1:ECActiveUserCount>
<ns1:TCActiveUserCount>...</ns1:TCActiveUserCount>
<ns1:SCActiveUserCount>...</ns1:SCActiveUserCount>

Behavior changed

Only allow Admin role have response license data of GetSite. Host or attendee won't get those license data in GetSite response.

Below are API: GetSite's response example for siteadmin or ready-only siteadmin or user-management admin:

XML API 41.2.0 Updates

Click here to download the XML API 41.2.0 schema.

XMLAPI should support "CMR Hybrid VOIP" if the site supports Webex telephony

Impacted APIs

• GetSite returns a new element IsWebexTelephony in the response.

• CreateUser and SetUser can update the cmrHybridVoip element if IsWebexTelephony is true along with other conditions. IsTSPUsingTelephonyAPI is no longer consequential.

Schema changes

XML API: GetSite response returns an additional element IsWebexTelephony

GetSite response include this new element:

<ns1:telephonyConfig>

<ns1:isWebexTelephony>true</ns1:isWebexTelephony>
<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:telephonyConfig>

LstSummarySession supports EC2.0

XML APIs be impacted

LstSummarySession will return new two elements to support EC 2.0

Schema changes

XML API: LstSummarySession: Append the <enableEvent> and <enableWebniar> elements

Response of XML API: LstSummarySession

Response for EC 2.0

<ep:isNextUpcomingInstance>true</ep:isNextUpcomingInstance>

                <ep:seriesMeetingKey>0</ep:seriesMeetingKey>
                <ep:isScheduledPMR>false</ep:isScheduledPMR>
                <ep:enableEvent>true</ep:enableEvent>
                <ep:enableWebniar>true</ep:enableWebniar>
            </ep:session>

XMLAPI supports to return site user Webex-voice-assistant option for MCT integration

Affected API

GetUser returns a new element webexAssistantEnabled (true or false) in the response.

Schema changes

getUserResponse:

Response example