- 主页
- /
- 文章
了解有关 Cisco Webex Meetings API 的所有重要信息,如架构更改和其他公告。
有关 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.12.0 更新
XML API 41.12.0 更新
XMLAPI 将根据错误的站点配置项目,锁定 Webex Events(经典版) EnableClassicEvent
安排和编辑
受影响的 API 和架构更改
在站点管理配置页面中,如果启用经典版 Event复选框错误,此站点将不再支持 Webex Events(经典版)会议。
如果启用经典版 Event 复选框错误,您可以调用这些 API 以运行 Webex Events(经典版)会议:
CreateEvent
, SetEvent
, GetEvent
, GetSessionInfo
, LstsummaryEvent
, LstrecordedEvent
, LstsummaryProgram
, UploadEventImage
API 将响应新的异常 010106。经典版 Event 已被禁用。
架构更改
无架构更改。
API 请求和响应示例
CreateEvent API 请求和响应
CreateEvent 请求
<bodyContent xsi:type="java:com.webex.service.binding.event.CreateEvent">
<accessControl>
<sessionPassword>XXXXXXXX</sessionPassword>
</accessControl>
<metaData>
<sessionName>XMLLAPI EC测试</sessionName>
</metaData>
<schedule>
<startDate>2021年7月17日01:29:15</startDate>
<openTime>15</openTime>
</schedule>
</bodyContent>
CreateEvent 响应
<?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:event="http://www.webex.com/schemas/2002/06/service/event">
<serv:header>
<serv:response>
<serv:result>失败</serv:result>
<serv:reason>经典事件已被禁用。</serv:reason>
<serv:gsbStatus>主</serv:gsbStatus>
<serv:exceptionID>010106</serv:exceptionID>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent/>
</serv:body>
</serv:message>
CreateEvent 3.1.3 影响 API:
SetEvent GetEvent
GetSessionInfo
LstsummaryEvent
LstrecordedEvent
LstsummaryProgram
UploadEventImage
XMLAPI LstMeetingType
将响应受影响的 subProductCodePrefix
受影响的 API
当前 API LstMeetingType
响应元素 productionCodePrefix
:PRO、AUO 和其他 Webex 预定义的会议类型前缀。
在经过这一全新的功能增强后,API 将响应新元素 subProdctCodePrefix
:PRO1、PRO2 等,其可预定义会议类型前缀。
API 上的架构更改: LstMeetingType
它将响应新元素: subProdctCodePrefix
API 请求和响应示例
LstMeetingType
API 请求与响应
更新请求 LstMeetingType
<bodyContent xsi:type="java:com.webex.service.binding.meetingtype.LstMeetingType">
<meetingTypeID>13810</meetingTypeID>
</bodyContent>
的回应: LstMeetingType
<serv:body>
<serv:bodyContent xsi:type="mtgtype:lstMeetingTypeResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<mtgtype:matchingRecords>
<serv:total>1</serv:total>
<serv:returned>1</serv:returned>
<serv:startFrom>1</serv:startFrom>
</mtgtype:matchingRecords>
<mtgtype:meetingType>
<mtgtype:productCodePrefix>PRO</mtgtype:productCodePrefix>
<mtgtype:subProductCodePrefix>PRO3</mtgtype:subProductCodePrefix> //定制会议类型的新元素
<mtgtype:active>已激活</mtgtype:active>
<mtgtype:name>Cus_Chat_已关闭</mtgtype:name>
<mtgtype:displayName>Cus_Chat_已关闭</mtgtype:displayName>
API 41.11.0 更新
XML API 41.11.0 更新
在控制中心管理的站点中,XML API 在用户管理 API 中支持向前兼容性
受影响的 API 和架构更改
如果您的集成应用程序当前正在使用 Webex XMLAPI 用户管理 API: CreateUser
, SetUser
, DelUser
和 GetUser
为配置或管理用户,在将 Webex 经典版站点转换为控制中心管理的站点后,这些 API 将继续保持向前兼容性。 将有一些行为变更,情况如下:
使用 createUser 时—如果控制中心中的用户状态不是“激活”,则站点上的用户状态将不是激活状态。 如果控制中心中的用户状态处于激活状态,则站点上的用户状态也是激活,参考: 控制中心中新用户和已转化用户的用户状态。
CreateUser 和 SetUser API 的密码元素将被忽略,我们将开始向新用户发送激活电子邮件,用户可以单击电子邮件中的链接以激活新帐户输入新密码。
CreateUser API 的激活元素 将被忽略,新用户(未验证)无法使用 API SetUser 通过此参数激活。
CreateUser API bodyContent 中的 webExId 元素的数值必须与电子邮件相同。 如果 webExId 与电子邮件 不同,在将 webExId 存储至 WebDB 中时,我们会以和电子邮件相同的方式进行处理,并且该值将被忽略。
SetUser API bodyContent 中的 webExId 元素的值必须是电子邮件地址的用户身份,您可以用 bodyContent 中的 < 电子邮件 > 进行更改。
SetUser API 将支持更改现有用户的电子邮件: 如果 SecurityContext 中的操作帐户是控制中心全站管理员,则成功。 否则,API 报告错误,并在下面显示新的错误代码和消息:
030120 必须是全站管理员帐户才能更改电子邮件。
newWebExId 元素(在 SetUser API 的 bodyContent 中)将被忽略。
SetUser API 尝试更改为已使用的电子邮件,API 将发出下述新错误代码和错误消息:
030118 电子邮件已用于控制中心管理的站点。
DelUser API 在 Webex 会议侧停用用户,并从 Webex 站点中删除相应的会议许可。 可通过使用 API 重新激活已停用的用户: SetUser(<active>已激活</active>),只要用户之前已经过验证。
CreateUser 和 SetUser API 将发出新的错误代码和错误消息,如下所示:
030117,该用户存在于您的组织以外,因此需要进行申领,以通过申领用户流程进入您的组织。 有关将用户申领到您的组织的步骤,请参阅将用户申领到您的组织(转换用户)。 在申领用户之前,您需要验证用户所属的域。
030119 CI 访问令牌必须包含范围 webexsquare: 管理员配置用户时。
只支持有限的向前兼容性。 在删除此兼容性之前,我们会提前通知。 |
架构更改
这些 API 均没有架构更改: CreateUser
, SetUser
, DelUser
和 GetUser
。
API 请求和响应示例
CreateUser API 请求和响应
API请求:
<?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/servicehttp://www.webex.com/schemas/2002/06/service/service.xsd">
<header>
<securityContext>
<siteName>{siteName}</siteName>
<webExID>{站点管理员帐户}</webExID>
<email>{站点管理员帐户}</email>
<sessionTicket>xxxx</sessionTicket>或<password>或<webExAccessToken>
或<accessToken>,使用CI "access "时,在预配置用户时必须包含scope webexsquare:admin
</accessToken></webExAccessToken></password></securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.user.CreateUser">
<webExId>Jack@qa.webex.com</webExId>---它应该是电子邮件地址的用户标识
<email>Jack@qa.webex.com</email>
<firstName>杰克</firstName>
<lastName>史密斯</lastName>
<password>…</password>
<privilege>
<host>真</host>
</privilege>
<active>已激活</active>---在用户通过激活电子邮件自行激活之前,此参数无法直接激活用户。
</bodyContent>
</body>
API响应示例:
<?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>成功</serv:result>
<serv:gsbStatus>主要</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="use:createUserResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<use:userId>23778617</use:userId>
</serv:bodyContent>
</serv:body>
</serv:message>
影响API:
创建用户
设置用户
DelUser
在将 Webex 经典版站点转换为控制中心管理的站点后,XML API 支持现有用户验证向前兼容
受影响的 API
在 Webex 经典版站点转换为控制中心管理的站点后,<webExID>元素值(在<securityContext>中)需要与电子邮件相同,详情如下:
对于在 Webex 经典版站点中创建的现有用户,我们支持旧的 webExID (例如: Jack)和新的 webExID(内容与电子邮件相同,例如: Jack@xx.com),以便登录,此验证向后兼容适用于所有 XML API。
对于在控制中心管理的站点中创建的新用户 ,webExID 元素的值必须与登录电子邮件中的相同。
<header>
<securityContext>
<siteName>{siteName}</siteName>
<webExID>{userName}</webExID> ---现有用户是在webEx经典站点中创建的,可以是: jack或jack@xx.com;新用户必须使用jack@xx.com
<sessionTicket> xx</sessionTicket> 或<password> 或<webExAccessToken> 或 <accessToken>
</accessToken></webExAccessToken></password></securityContext>
</header>
影响API:
所有 XML API。
在 Webex 经典版站点转换为控制中心管理的站点后,<webExID>元素值(在bodyContent中)需要与电子邮件相同,详情如下:
对于在 Webex 经典版站点中创建的现有用户,我们支持旧的 webExId (例如: Jack)和新的 webExId(内容与电子邮件相同,例如: Jack@xx.com),位置是在 bodyContent 中。
对于在控制中心管理的站点中创建的新用户,webExId 元素的值必须与电子邮件中的相同
bodyContent
。
<bodyContent xsi:type="java:com.webex.service.binding.user.GetUser or SetUser or DelUser">
<webExId>xxxx</webExId> ---已有用户是在webEx经典站点中创建的,可以是: jack或jack@xx.com;新用户必须使用jack@xx.com
</bodyContent>
影响API:GetUser
, SetUser
和 DelUser
。
架构更改
任何 API 均没有架构更改。
API 请求和响应示例
GetUser API 请求和响应
API请求:
<?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/servicehttp://www.webex.com/schemas/2002/06/service/service.xsd">
<header>
<securityContext>
<siteName>{siteName}</siteName>
<webExID>{userName}</webExID> ---现有用户是在webEx经典站点中创建的,可以是: jack或jack@xx.com;新用户必须使用jack@xx.com
<sessionTicket>xxxx</sessionTicket> 或 <password>或 <webExAccessToken>或 <accessToken>
</accessToken></webExAccessToken></password></securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.user.GetUser or SetUser or DelUser">
<webExId>xxxx</webExId> ---现有用户是在webEx经典站点中创建的,可以是: jack或jack@xx.com;新用户必须使用jack@xx.com
</bodyContent>
</body>
API响应示例:
…与之前一样
增强录制文件视图历史报告 API,支持 Webex Meetings、Webex Events(新版)和 Webex Events(经典版)
受影响的 API
当前 API: lstrecordaccessHistory
和 lstrecordaccessDetailHistory
仅支持 Webex Trainings 录制文件视图访问的历史记录报告。 这项新增强功能还支持 Webex Meetings、Webex Events(新版)和 Webex Events(经典版)录制文件视图访问的历史记录报告。
架构更改
在 API 请求主体中,我们支持以下 lstrecordaccessHistory API 新架构:
<serviceTypes>
<serviceType>MeetingCenter</serviceType>
<serviceType>TrainingCenter</serviceType>
<serviceType>EventCenter</serviceType>
</serviceTypes>
详细信息
API: lstrecordaccessHistory
可以返回 Webex Meetings、Webex Events(新版)、Webex Events(经典版)和 Webex Trainings 的录制文件视图访问的历史记录。
如果在 API 请求中未指定 serviceType,则 API
lstrecordaccessHistory
仅返回 Webex Trainings 录制文件视图访问的历史记录。当 serviceType 是 MeetingCenter 时,API
lstrecordaccessHistory
返回 Webex Meetings 和 Webex Events(新版)的录制文件访问历史记录。当 serviceType 是 EventCenter 时,API
lstrecordaccessHistory
返回 Webex Events(经典版)的录制文件视图访问历史记录。
API: lstrecordaccessDetailHistory
可以返回 recordID
Webex Meetings、Webex Events(新版)、Webex Events(经典版)和 Webex Trainings 的详细信息。
API 请求和响应示例
lstrecordaccessHistory
API 请求和响应
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<header>
<securityContext>
<webExID>{userName}</webExID>
<password>{password}</password>
<siteName>{siteName}</siteName>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.history.LstrecordaccessHistory">
<viewTimeScope>
<viewTimeStart>2021年9月20日00:00:00</viewTimeStart>
<viewTimeEnd>2021年9月28日23:59:59</viewTimeEnd>
</viewTimeScope>
<listControl>
<startFrom>1</startFrom>
<maximumNum>100</maximumNum>
</listControl>
<order>
<orderBy>已完成</orderBy>
<orderAD>ASC</orderAD>
</order>
<serviceTypes>
<serviceType>MeetingCenter</serviceType>
<serviceType>TrainingCenter</serviceType>
<serviceType>EventCenter</serviceType>
</serviceTypes>
</bodyContent>
</body>
</serv:message>
<?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>成功</serv:result>
<serv:gsbStatus>主</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="history:lstrecordaccessHistoryResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>LstrecordaccessHistory测试TC-20210924,1324-1</history:recordName>
<history:creationTime>2021年9月24日13:28:13</history:creationTime>
<history:registered>0</history:registered>
<history:downloaded>2</history:downloaded>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>测试Erollment_001-20210610,1905-1</history:recordName>
<history:creationTime>2021年6月10日19:10:15</history:creationTime>
<history:registered>0</history:registered>
<history:downloaded>0</history:downloaded>
<history:viewed>3</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>测试即时播放2-20210705,0709-1</history:recordName>
<history:creationTime>2021年7月5日07:15:06</history:creationTime>
<history:registered>0</history:registered>
<history:downloaded>0</history:downloaded>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>EC2.0_232423-20210922,0447-1</history:recordName>
<history:creationTime>2021年9月22日04:53:05</history:creationTime>
<history:registered>0</history:registered>
<history:downloaded>0</history:downloaded>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>LstrecordaccessHistory测试EC2.0-20210924,1315-1</history:recordName>
<history:creationTime>2021年9月24日13:19:00</history:creationTime>
<history:registered>0</history:registered>
<history:downloaded>1</history:downloaded>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>LstrecordaccessHistory测试MC-20210924,1319-1</history:recordName>
<history:creationTime>2021年9月24日13:25:12</history:creationTime>
<history:registered>0</history:registered>
<history:downloaded>1</history:downloaded>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>LstrecordaccessHistory测试EC classic-20210924,1331-1</history:recordName>
<history:creationTime>2021年9月24日13:37:28</history:creationTime>
<history:registered>0</history:registered>
<history:downloaded>1</history:downloaded>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:matchingRecords>
<serv:total>8</serv:total>
<serv:returned>7</serv:returned>
<serv:startFrom>1</serv:startFrom>
</history:matchingRecords>
</serv:bodyContent>
</serv:body>
</serv:message>
lstrecordaccessDetailHistory
API 请求和响应
<?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">
<header>
<securityContext>
<webExID>{userName}</webExID>
<password>{password}</password>
<siteName>{siteName}</siteName>
</securityContext>
</header>
<body>
<bodyContent xsi:type="">
"java:com.webex.service.binding.history.LstrecordaccessDetailHistory">
<recondID>1XXXXXX7</recondID>
<timeZoneID>20</timeZoneID>
</body>
<?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>成功</serv:result>
<serv:gsbStatus>主</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="history:lstrecordaccessDetailHistoryResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<history:recordDetail>
<history:viewID>1XXXXXX7</history:viewID>
<history:participantName>Axxxg</history:participantName>
<history:participantEmail>Axxxg@qa.webex.com</history:participantEmail>
<history:accessTime>2021年9月24日13:27:26</history:accessTime>
<history:registered>false</history:registered>
<history:downloaded>false</history:downloaded>
<history:viewed>真</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordDetail>
<history:recordDetail>
<history:viewID>1XXXXXX7</history:viewID>
<history:participantName>Axxxg</history:participantName>
<history:participantEmail>Axxxg@qa.webex.com</history:participantEmail>
<history:accessTime>2021年9月24日13:27:39</history:accessTime>
<history:registered>false</history:registered>
<history:downloaded>真</history:downloaded>
<history:viewed>false</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordDetail>
<history:matchingRecords>
<serv:total>2</serv:total>
<serv:returned>2</serv:returned>
<serv:startFrom>1</serv:startFrom>
</history:matchingRecords>
</serv:bodyContent>
</serv:body>
</serv:message>
影响API:
lstrecordaccessHistory
lstrecordaccessDetailHistory
修复了 XMLAPI 和 Webex 页面之间的 Webex Events(经典版)描述的最大长度。
受影响的 API
XML API: CreateEvent 和 SetEvent's 的描述元素最多允许输入 10000 个字符,如果超过输入限制,将会出现新的错误代码和消息:
060068 非法的输入描述。 描述不能超过 10000 个字符。
架构更改
未更改架构。
API 请求和响应示例
CreateEventAPI 请求和响应
#API请求示例:
…
<body>
<bodyContent xsi:type="java:com.webex.service.binding.event.CreateEvent">
xmlns:att="http://www.webex.com/schemas/2002/06/service/event" xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service/eventhttp://www.webex.com/schemas/2002/06/service/event/event.xsd">
<accessControl>
<sessionPassword>1111111</sessionPassword>
<listing>私人</listing>
</accessControl>
<metaData>
<sessionName>EC测试</sessionName>
<description>……假设您在描述中输入10000个字符……</description>
</metaData>
...
------------------------------------
#当说明超过10000个字符时的API响应示例:
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
<serv:header>
<serv:response>
<serv:result>FAILURE非法的输入描述。</serv:result>
<serv:reason> 描述不能超过10000个字符</serv:reason>
<serv:gsbStatus>主</serv:gsbStatus>
<serv:exceptionID>060068</serv:exceptionID>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent/>
</serv:body>
</serv:message>
影响API:
CreateEvent
SetEvent
XML API: GetUser 返回 freeAccount 的新元素
受影响的 API
GetUser
返回一个新元素,用于确认 freeAccount
用户帐户是否 FreeAccount
存在。
架构更改
GetUser 响应示例
GetUser响应:
<use:initials>AW</use:initials>
<use:isUploaded>false</use:isUploaded>
<use:largeEventCapacity>3</use:largeEventCapacity>
<use:freeAccount>false</use:freeAccount>
影响API:
GetUser
API 41.10.0 更新
XML API 41.10.0 架构未进行架构更改。 |
API 41.9.0 更新
XML API 41.9.0 更新
为所有 T31 站点停用 XML API 10.0.0
Webex 计划为所有 T31 站点终止支持 10.0.0 版 XML API。
我们将在 41.9.0 更新中停用所有产品中的 XML API 10.0.0 代码。
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 更新
应该通过站点管理选项控制从移动设备删除和编辑录制文件: 允许主持人重新分配、编辑、禁用和删除录制文件
受影响的 API 和架构更改
GetSite
:返回新元素,其名称为 enableNBRMCModify
和 separateNoRecordingEdit
(在工具下)。
响应示例
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>成功</serv:result>
<serv:gsbStatus>主要</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 更新
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>成功</serv:result>
<serv:gsbStatus>主要</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 更新
XMLAPI 在预配置中支持 Webex Events 2.0
受影响的 API
GetUser
:返回新元素命名 largeEventCapacity
显示此用户帐户下新 Event 2.0 (EC 2.0) 的功能。 例如,如果用户帐户具有 CI_EC3K 许可证,则 largeEventCapacity
的值为 3000。
架构更改
响应示例
GetUserResponse:
XMLAPI LstRecording 的 CreateTime 使用录制开始时间
受影响的 API
LstRecording
: LstRecording
响应中返回 CreateTime
作为用户实际按下录制按钮的时间。
详细信息
过去,XML API 使用在数据库中创建录制文件的时间戳作为 LstRecording
响应。 现在就是用户实际开始制作录制文件的时间。 此更改适用于所有服务录制文件。 没有架构更改。
API 41.5.0 更新
XML API 41.5.0 更新
XMLAPI 能够作为主持人从 PSTN 启动 Webex 安排的会议
受影响的 API
CreateUser
:生成hostPIN
,无论在用户角色为主持人、完全权限管理员或只读管理员或用户管理站点管理员时,用户 PMR 是否启用。SetUser
:设置hostPIN
使用phones.hostPIN
当personalMeetingRoom.hostPIN
不在 XML 请求中时(前提条件: 功能切换AllowStartScheduledMtgFromPhone
已启用)。GetUser
:返回phones.hostPIN
,无论用户 PMR 是否启用。(前提条件: 功能切换AllowStartScheduledMtgFromPhone
已启用)。
架构更改
GetUserResponse
:
SetUser
:
响应示例
GetUserResponse
:
SetUser
:
XMLAPI GetSite
响应移动客户端的两个新元素
受影响的 API
GetSite
:GetSite
现在将响应两个新元素以实现对移动客户端的支持,其中具有显示或不显示录制文件标签页的逻辑。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 更新
创建活动安排的 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>宣布</ns1:entryExitTone>
<ns1:entryExitToneEC>no one</ns1:entryExitToneEC>
<ns1:voip>true</ns1:voip>
<ns1:teleconference>
<ns1:telephonySupport>no</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) 详细信息
如果 Webex 会议是大型活动或网络广播,
GetSessionInfo
返回一些详细信息,包括会议密码、会议数字密码、答疑者密码和答疑者数字密码(不会更改架构)。XMLAPI 不支持创建和编辑任何大型活动或网络广播功能,因此
CreateMeeting
和SetMeeting
对于大型活动或网络广播情况返回新的异常(110064,不支持“活动”和“网络广播”会话类型。)。
影响 API
API 名称 | 描述 | 备注 |
---|---|---|
| 如果 Webex 会议是大型活动或网络广播, | 不会更改架构。 |
| 如果用户尝试使用 | 行为会已发生更改。 |
API 41.3.0 更新
XML API 41.3.0 更新
XML API 新更改支持 Webex Events 2.0 功能
受影响的 API
两种 API: GetSessionInfo 和 GetMeeting 也返回元素 enableEvent
和 enableWebniar
。
元素名称 | 描述 |
---|---|
enableEvent | 在 Webex 会议中支持 EC 2.0 |
enableWebniar | 在 Webex 会议中支持网络研讨会 |
XMLAPI 支持对于 EC 2.0 的以上两个返回元素。 当前 XML API 发行版不支持安排和设置 EC2.0 会议。 |
架构更改
GetSessionInfo
返回元素 enableEvent
和 enableWebniar
(对于 EC 2.0)。
GetMeeting
返回元素 enableEvent
和 enableWebniar
(对于 EC 2.0)。
响应示例:
GetSessionInfo
响应:
<ep:accessControl>
<ep:listStatus>公开</ep:listStatus>
<ep:registration>false</ep:registration>
<ep:passwordReq>真</ep:passwordReq>
<ep:isEnforceAudioPassword>false</ep:isEnforceAudioPassword>
<ep:isEnforceAudioLogin>false</ep:isEnforceAudioLogin>
<ep:enableEvent>false</ep:enableEvent>
<ep:enableWebniar>false</ep:enableWebniar>
<ep:enablePreMeetingLobby>真</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>
XMLAPI 新更改支持会议前等候区功能
受影响的 API
XML API: GetSite
, LstSummarySession
, GetSessionInfo
和 GetMeeting
将响应新元素 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>
GetSessionInfo
响应:
<ep:accessControl>
<ep:listStatus>公开</ep:listStatus>
<ep:registration>false</ep:registration>
<ep:passwordReq>真</ep:passwordReq>
<ep:isEnforceAudioPassword>false</ep:isEnforceAudioPassword>
<ep:isEnforceAudioLogin>false</ep:isEnforceAudioLogin>
<ep:enableEvent>false</ep:enableEvent>
<ep:enableWebniar>false</ep:enableWebniar>
<ep:enablePreMeetingLobby>真</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>
XML API GetSite
响应信息行为更改公开
受影响的 API
XML API: GetSite
仅响应管理员帐户的以下元素,其中包括角色: SiteAdmin
, RO_SiteAdmin
和 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>
行为已更改。
仅允许管理员角色有响应许可证数据(针对 GetSite
。 主持人或与会者不会在 GetSite
响应。
以下是 API: GetSite's
的响应示例,针对 siteadmin
或只读 siteadmin
或用户管理管理员:
API 41.2.0 更新
XML API 41.2.0 更新
如果站点支持 Webex 电话服务,XMLAPI 应支持“CMR 混合网络语音”
受影响的 API
GetSite
返回响应中的新元素IsWebexTelephony
。CreateUser
和SetUser
可以更新cmrHybridVoip
元素,前提是IsWebexTelephony
为 true,并满足其他条件。IsTSPUsingTelephonyAPI
不再重要。
架构更改
XML API: GetSite
响应返回附加元素 IsWebexTelephony
GetSite
响应包含以下新元素:
<ns1:telephonyConfig>
<ns1:isWebexTelephony>true</ns1:isWebexTelephony>
<ns1:isTSPUsingTelephonyAPI>false</ns1:isTSPUsingTelephonyAPI>
<ns1:serviceName>个人会议号码</ns1:serviceName>
<ns1:participantAccessCodeLabel>与会者访问码</ns1:participantAccessCodeLabel>
<ns1:subscriberAccessCodeLabel>主持人访问码</ns1:subscriberAccessCodeLabel>
<ns1:attendeeIDLabel>与会者标识</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>真</ep:isNextUpcomingInstance>
<ep:seriesMeetingKey>0</ep:seriesMeetingKey>
<ep:isScheduledPMR>假</ep:isScheduledPMR>
<ep:enableEvent>真</ep:enableEvent>
<ep:enableWebniar>真</ep:enableWebniar>
XMLAPI 支持返回站点用户 Webex-voice-assistant
MCT 集成选项
受影响的 API
GetUser
返回响应中的新元素 webexAssistantEnabled
(true 或 false)。
架构更改
getUserResponse
:
响应示例
API 41.1.0 更新
XML API 41.1 架构未进行架构更改。 |