有关 XML API 39 和 XML API 11 的更多信息,请参阅 Cisco Webex Meetings XML API 更新概述(XML API 39 及更低版本)

有关 XML API 40 的更多信息,请参阅 Cisco Webex Meetings XML API 更新概述(XML API 40 及更高版本)

有关 XML API 11 SP9 及更低版本的更新,请转至 Cisco DevNet

API 41.8.0 更新

XML API 41.8.0 更新

单击此处下载 XML API 41.8.0 架构

为所有 T31 站点停用 XML API 10.0.0

Webex 计划为所有 T31 站点终止支持 10.0.0 版 XML API。

Webex 发现有些客户的客户端使用如下不正确的方式访问 XML API 的 URL: https://{siteName}.webex.com/WBXService/xml10.0.0/XMLService,访问 XML API URL 的正确方式为: https://{siteName}.webex.com/WBXService/XMLService。

请在我们终止支持 10.0.0 版 XML API 之前,使用正确的方式切换代码访问 XML API 以避免影响。

API 41.7.0 更新

XML API 41.7.0 更新

单击此处下载 XML API 41.7.0 架构

应该通过站点管理选项控制从移动设备删除和编辑录制文件: 允许主持人重新分配、编辑、禁用和删除录制文件

受影响的 API 和架构更改

GetSite:返回新元素,其名称为 enableNBRMCModifyseparateNoRecordingEdit (在工具下)。

响应示例

GetSiteResponse

GetSite

<?xml version="1.0" encoding="ISO-8859-1"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:ns1="http://www.webex.com/schemas/2002/06/service/site" xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="ns1:getSiteResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            ....
            <ns1:tools>
                    ...
                    <ns1:enableNBRMCModify>false</ns1:enableNBRMCModify>
                    <ns1:separateNoRecordingEdit>true</ns1:separateNoRecordingEdit>
                    ...
            </ns1:tools>
        </serv:bodyContent>
    </serv:body>
</serv:message>

API 41.6.3 更新

XML API 41.6.3 更新

单击此处下载 XML API 41.6.3 架构

GetSite 响应以下新元素 supportLargeEvent

受影响的 API 和架构更改

GetSite: 返回新元素,其名称为 supportLargeEvent 下方 siteCommonOptions 让主叫方了解该站点是否支持“大型活动(Webex Events(新版))”。

架构更改

响应示例

GetSiteResponse

GetSite

<?xml version="1.0" encoding="ISO-8859-1"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:ns1="http://www.webex.com/schemas/2002/06/service/site" xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="ns1:getSiteResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            ....
            <ns1:siteCommonOptions>
                    ...
                    <ns1:enablePreMeetingLobby>false</ns1:enablePreMeetingLobby>
                    <ns1:supportLargeEvent>true</ns1:supportLargeEvent>
            </ns1:siteCommonOptions>
        </serv:bodyContent>
    </serv:body>
</serv:message>

API 41.6.0 更新

XML API 41.6.0 更新

单击此处下载 XML API 41.6.0 架构

XMLAPI 在预配置中支持 Webex Events 2.0

受影响的 API

GetUser:返回新元素命名 largeEventCapacity 显示此用户帐户下新 Event 2.0 (EC 2.0) 的功能。 例如,如果用户帐户具有 CI_EC3K 许可证,则 largeEventCapacity 的值为 3000。

架构更改

响应示例

GetUserResponse:

XMLAPI LstRecording 的 CreateTime 使用录制开始时间

受影响的 API

LstRecordingLstRecording 响应中返回 CreateTime 作为用户实际按下录制按钮的时间。

详细信息

过去,XML API 使用在数据库中创建录制文件的时间戳作为 LstRecording 响应中的创建时间。 现在就是用户实际开始制作录制文件的时间。 此更改适用于所有服务录制文件。 没有架构更改。

API 41.5.0 更新

XML API 41.5.0 更新

单击此处下载 XML API 41.5.0 架构

XMLAPI 能够作为主持人从 PSTN 启动 Webex 安排的会议

受影响的 API

  • CreateUser:生成 hostPIN ,无论在用户角色为主持人、完全权限管理员或只读管理员或用户管理站点管理员时,用户 PMR 是否启用。

  • SetUser:设置 hostPIN 使用 phones.hostPINpersonalMeetingRoom.hostPIN 不在 XML 请求中时(前提条件: 功能切换 AllowStartScheduledMtgFromPhone已启用)。

  • GetUser:返回 phones.hostPIN ,无论用户 PMR 是否启用。(前提条件: 功能切换 AllowStartScheduledMtgFromPhone 已启用)。

架构更改

GetUserResponse

SetUser

响应示例

GetUserResponse

SetUser

XMLAPI GetSite 响应移动客户端的两个新元素

受影响的 API

  • GetSiteGetSite 现在将响应两个新元素以实现对移动客户端的支持,其中具有显示或不显示录制文件标签页的逻辑。

    • enableRecordingAccess :true 或 false,Webex 超级管理员可以启用或禁用录制文件访问,方法是采用切换开关( EnableRecordingAccesses )。

    • storageEmptyStatus :true 或 false,如果两个站点都不支持 NBR 功能,并且分配的 NBR 存储空间为零,则状态响应为 true,否则为 false。

架构更改

请求示例: GetSite

响应示例: Getsite

包含非 ASCII 字符的电子邮件主题将使用 RFC2047 编码。 对于纯 ASCII 字符的电子邮件主题,则不存在编码

受影响的 API

任何 API 请求、响应有效内容都不会受影响,但它会更改电子邮件主题的编码行为。 包含非 ASCII 字符的电子邮件主题将使用 RFC2047 编码。 对于纯 ASCII 字符的电子邮件主题,则不存在编码。

架构更改

没有架构更改。

API 41.4.0 更新

XML API 41.4.0 更新

单击此处下载 XML API 41.4.0 架构

创建活动安排的 Webex Events 可以利用站点级别的进入和退出声音默认设置

XMLAPI 符合当前控制进入和退出声音的新逻辑。 Webex Events 的所有声音均受站点管理中其他设置的控制。 在 GetSite 中,XMLAPI 返回一个额外字段 entryExitToneEC 以表示值。 最初,当站点管理员设置默认提示音时,创建活动不会通过应用 XMLAPI 默认值来利用此设置。

受影响的 API

XML API: GetSite 返回一个新元素entryExitToneEC 以表示值。

XML API: CreateEvent、SetEvent、GetEvent 后端业务逻辑读取entryExitToneEC

架构更改

XML API: GetSite 响应示例:

<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>

影响 API:

  • GetSite

  • CreateEvent

  • SetEvent

  • GetEvent

XMLAPI 仅返回大型活动 (Webex Event 2.0) 详细信息

  1. 如果 Webex 会议是大型活动或网络广播, GetSessionInfo 返回一些详细信息,包括会议密码、会议数字密码、答疑者密码和答疑者数字密码(不会更改架构)。

  2. XMLAPI 不支持创建和编辑任何大型活动或网络广播功能,因此 CreateMeetingSetMeeting 对于大型活动或网络广播情况返回新的异常(110064,不支持“活动”和“网络广播”会话类型。)。

影响 API

API 名称

描述

备注

GetSessionInfo

如果 Webex 会议是大型活动或网络广播, GetSessionInfo 返回会议密码、会议数字密码、答疑者密码和答疑者数字密码。

不会更改架构。

CreateMeeting

SetMeeting

如果用户尝试使用 CreateMeeting api 以创建大型活动会话类型的 Webex 会议,或调用 SetMeeting 以编辑实际为大型活动或网络广播的 Webex 会议,请返回新的异常 110064。 不支持“活动”和“网络广播”会话类型。

行为会已发生更改。

API 41.3.0 更新

XML API 41.3.0 更新

单击此处下载 XML API 41.3.0 架构

XML API 新更改支持 Webex Events 2.0 功能

受影响的 API

两种 API: GetSessionInfo 和 GetMeeting 也返回元素 enableEventenableWebniar

元素名称

描述

enableEvent

在 Webex 会议中支持 EC 2.0

enableWebniar

在 Webex 会议中支持网络研讨会


XMLAPI 支持对于 EC 2.0 的以上两个返回元素。 当前 XML API 发行版不支持安排和设置 EC2.0 会议。

架构更改

GetSessionInfo 返回元素 enableEventenableWebniar (对于 EC 2.0)。

GetMeeting 返回元素 enableEventenableWebniar (对于 EC 2.0)。

响应示例:

GetSessionInfo 响应:

<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 响应:

  <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>

XMLAPI 新更改支持会议前等候区功能

受影响的 API

XML API: GetSite, LstSummarySession, GetSessionInfoGetMeeting 将响应新元素 enablePreMeetingLobby 以用于会议前等候区。

架构更改

XML API: GetSite 返回元素 enablePreMeetingLobby 以用于会议前等候区。

XML API: LstSummarySession 返回元素 enablePreMeetingLobby 以用于会议前等候区。

XML API: GetSessionInfo 返回元素 enablePreMeetingLobby 以用于会议前等候区。

XML API: GetMeeting 返回元素 enablePreMeetingLobby 以用于会议前等候区。

响应示例:

GetSite 响应:

<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 响应:

<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 响应:

<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 响应:

<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>

XML API GetSite 响应信息行为更改公开

受影响的 API

XML API: GetSite 仅响应管理员帐户的以下元素,其中包括角色: SiteAdmin, RO_SiteAdminUserAdmin

<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>

行为已更改。

仅允许管理员角色有响应许可证数据(针对 GetSite。 主持人或与会者不会在 GetSite 响应中的创建时间。

以下是 API: GetSite's 的响应示例,针对 siteadmin 或只读 siteadmin 或用户管理管理员:

API 41.2.0 更新

XML API 41.2.0 更新

单击此处下载 XML API 41.2.0 架构

如果站点支持 Webex 电话服务,XMLAPI 应支持“CMR 混合网络语音”

受影响的 API

  • GetSite 返回响应中的新元素 IsWebexTelephony

  • CreateUserSetUser 可以更新 cmrHybridVoip 元素,前提是 IsWebexTelephony 为 true,并满足其他条件。 IsTSPUsingTelephonyAPI 不再重要。

架构更改

XML API: GetSite 响应返回附加元素 IsWebexTelephony

GetSite 响应包含以下新元素:

<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 支持 EC2.0

XML API 受到影响

LstSummarySession 将返回两个新元素以实现对 EC 2.0 的支持

元素名称

描述

enableEvent

在 Webex 会议中支持 EC 2.0

enableWebniar

在 Webex 会议中支持网络研讨会

架构更改

XML API: LstSummarySession 追加 < enableEvent> 和 < enableWebniar> 元素

XML API 的响应: LstSummarySession

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 支持返回站点用户 Webex-voice-assistant MCT 集成选项

受影响的 API

GetUser 返回响应中的新元素 webexAssistantEnabled (true 或 false)。

架构更改

getUserResponse

响应示例

API 41.1.0 更新


XML API 41.1 架构存在架构更改。