有关 XML API 39 和 XML API 11 的更多信息,请参阅 Cisco Webex Meetings XML API 更新概述(XML API 39 及更低版本)。
有关 XML API 11 SP9 及更低版本的更新,请转至 Cisco DevNet。
API 40.12.0 更新
XML API 40.12.0 更新
XML API 支持私人会议类型
XML API 受到影响
我们可以使用 API:
CreateMeeting
和SetMeeting
安排或更新私人会议类型的 Webex 会议。如果 Webex 会议安排为私人会议类型,
GetSessionInfo
GetMeeting
、LstSummarySession
和LstCalendarSession
将返回名为PrivateMeeting
的新元素,表明会议的类型。GetMeetingType
和LstMeetingType
返回名为
的新元素,提示是否支持私人会议。SupportPrivateMeeting
架构更改
XML API: GetMeetingType/LstMeetingType: 追加 <SupportPrivateMeeting>
元素。
XML API:LstSummarySession
:追加 <isPrivateMeeting>
元素。
XML API:LstCalendarSession
:追加 <isPrivateMeeting>
元素。
XML API:GetSessionInfo
:追加 <isPrivateMeeting>
元素。
XML API:GetMeeting: 追加 <isPrivateMeeting>
元素。
XML API 请求: CreateMeeting
使用私人会议类型的 CreateMeeting 请求
<body>
<bodyContent xsi:type="java:com.webex.service.binding.meeting.CreateMeeting">
<schedule>
<startDate>10/25/2020 13:00:00</startDate>
<duration>45</duration>
<timeZoneID>45</timeZoneID>
</schedule>
<accessControl>
<meetingPassword>********</meetingPassword>
</accessControl>
<metaData>
<confName>MC_PrivateMeeting_Test</confName>
<meetingType>168</meetingType> //169 是支持私人会议的示例
</metaData>
</bodyContent>
</body>
XML API 的响应: GetSessionInfo
isPrivateMeeting 响应
<ep:supportE2E>false</ep:supportE2E>
<ep:isAllowJBH>true</ep:isAllowJBH>
<ep:isPrivateMeeting>true</ep:isPrivateMeeting> //true: 会议支持私人会议;false: 该会议不支持私人会议。
<ep:isCETMeeting>false</ep:isCETMeeting>
<ep:isPersonalMeetingRoom>false</ep:isPersonalMeetingRoom>
<ep:isNextUpcomingInstance>true</ep:isNextUpcomingInstance>
GetSite API 将返回站点级会议模板
用户故事/任务描述
GetSite API 返回站点级会议模板。 此操作允许 Education Connector 和 Webex Classroom 向教师显示这些模板,供他们在安排在线课程时挑选和选择。
受影响的 API
如果存在站点级的自定义会议模板,GetSite api 将返回这些站点级模板。
元素名称 |
描述 |
---|---|
|
站点级自定义会议模板的名称 |
|
Webex Meetings、Webex Trainings 和 Webex Events |
架构更改
GetSite:追加 <meetingTemplates>
元素。
响应示例
GetSite 响应
<ns1:meetingTypes>
<ns1:meetingTypeID>3</ns1:meetingTypeID>
<ns1:meetingTypeName>PRO</ns1:meetingTypeName>
</ns1:meetingTypes>
<ns1:meetingTemplates>
<ns1:meetingTemplate>
<ns1:meetingTemplateName>MC Meeting Tempalte 1</ns1:meetingTemplateName>
<ns1:serviceType>MeetingCenter</ns1:serviceType>
</ns1:meetingTemplate>
<ns1:meetingTemplate>
<ns1:meetingTemplateName>EC Meeting Tempalte 2</ns1:meetingTemplateName>
<ns1:serviceType>EventCenter</ns1:serviceType>
</ns1:meetingTemplate>
<ns1:meetingTemplate>
<ns1:meetingTemplateName>TC Meeting Template 3</ns1:meetingTemplateName>
<ns1:serviceType>TrainingCenter</ns1:serviceType>
</ns1:meetingTemplate>
</ns1:meetingTemplates>
站点为 CI 统一站点时,XML API SetUser 无法更改 supportedServices
元素
描述
站点是 Control Hub 所链接的 Unified Webex Meeting 站点时,XMLAPI SetUser
不支持更改 API 请求中的“supportedServices
”值。
架构更改
以下 API 没有架构更改: SetUser
。
WEBEX-15436: 添加保护以避免在 Mtgconfattendeelist 中出现重复的电子邮件
描述
如果多个与会者在同一 API 请求中将相同电子邮件添加到同一个会议,系统将仅处理第一个与会者的电子邮件。
受影响的 API
CreateMeetingAttendee
CreateUser
SetUser
CreateMeeting
SetMeeting
CreateEvent
SetEvent
CreateTrainingSession
SetTrainingSession
API 示例
请求
<?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>testSite</siteName>
<webExID>testUser</webExID>
<password>password</password>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.attendee.CreateMeetingAttendee">
<sessionKey>1714904382</sessionKey>
<person>
<email>test@webex.com</email>
<name>name1</name>
</person>
<attendees>
<person>
<email>test@webex.com</email>
<name>name2</name>
</person>
<sessionKey>1714904382</sessionKey>
</attendees>
</bodyContent>
</body>
API 40.11.0 更新
XML API 40.11.0 更新
XMLAPI CreateUser 支持 displayname
CreateUser
支持 dispalyname
(当功能切换 EnableDisplayName
是 1 时)。 如果功能切换不是 1,displayName
将被忽略。
架构更改
CreateUser:
XMLAPI SetUser 支持 displayname
SetUser
支持 dispalyname
(当功能切换 EnableDisplayName
是 1 时)。 如果功能切换不是 1,displayName
将被忽略。
架构更改
SetUser:
XMLAPI GetUser 支持 displayname
GetUser
支持 dispalyname
(当功能切换 EnableDisplayName
是 1 时)。 如果功能切换不是 1,displayName
将不会显示。
当数据库中的 displayName
为空且功能切换 EnableDisplayName
是 1 时,非亚洲字符的 displayName
将显示为 firstName+" "+lastName
,亚洲字符则显示为 firstName+lastName
。
架构更改
GetUserResponse:
CMR 混合网络语音的 XMLAPI 用户级别控制
cmrHybridVoip
设置用于设置和检索 EnableCMRHybridVoIP
的用户级别设置。
架构更改
GetUser 响应:
CreateUser 请求:
SetUser 请求:
API 40.10.0 更新
XML API 40.10.0 更新
XML API 在 API 请求和响应中对 meetingUUID
的支持
示例 XML API: GetSessionInfo
请求:
<?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>
<siteName>xxx</siteName>
<webExID>Test</webExID>
<password>xxx</password>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.ep.GetSessionInfo">
<sessionKey>805325231</sessionKey>
or
<meetingUUID>039c00dd25c64ab0812dda22bb8a4fcc</meetingUUID>
</bodyContent>
</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: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:getSessionInfoResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ep:status>NOT_INPROGRESS</ep:status>
<ep:isLocked>false</ep:isLocked>
<ep:sessionkey>805325231</ep:sessionkey>
<ep:meetingUUID>039c00dd25c64ab0812dda22bb8a4fcc</ep:meetingUUID>
<ep:confID>158941507534980823</ep:confID>
...
...
</serv:bodyContent>
</serv:body>
</serv:message>
受影响的 API:
CreateMeetingAttendee
DelMeetingAttendee
RegisterMeetingAttendee
CreateTeleconferenceSession
SetTeleconferenceSession
GetTeleconferenceSession
CreateTrainingSession
SetTrainingSession
GetTrainingSession
DelTrainingSession
CreateEvent
SetEvent
DelEvent
XMLAPI 将为站点管理员配置返回一个额外的元素,以禁用屏幕截图
此要求源自对 PenTest
Bug 和 Goldman Sachs 等客户的安全性考虑。 这些客户不希望让最终用户在 Meetings 应用程序中进行屏幕截图。与此同时,许多其他客户希望允许屏幕截图的功能。 此外,教育用户也希望允许屏幕截图。 因此,我们将为此提供站点管理员配置,XMLAPI 将返回额外的字段 EnableMobileScreenCapture
(在 GetSite
的响应中)以支持此功能。
GetSite 请求示例
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<header>
<securityContext>
<siteName>xxxx</siteName>
<webExID>Test</webExID>
<password>xxxx</password>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.site.GetSite">
</body>
</serv:message>
<?xml version="1.0" encoding="ISO-8859-1"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:ns1="http://www.webex.com/schemas/2002/06/service/site" xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
<serv:header>
<serv:response>
<serv:result>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="ns1:getSiteResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns1:siteInstance>
...
<ns1:securityOptions>
...
...
<ns1:EnableMobileScreenCapture>false</ns1:EnableMobileScreenCapture>
...
</ns1:securityOptions>
...
</ns1:siteInstance>
</serv:bodyContent>
</serv:body>
</serv:message>
受影响的 API
GetSite
XMLAPI 支持 MEET-269 无 PIN 加入改进
XMLAPI 为个人会议室会议和 MC 会议添加了新选项我的组织中的视频会议系统可以开始和加入会议,而无需提示。
createUser/setUser/getUser
添加了新节点deviceCanStartMyPMR
(在personalMeetingRoom
中)。createMeeting/setMeeting/getMeeting
在安排中添加了新节点deviceCanStartMeeting
。
Webex 用户界面中用于个人会议室会议的选项:
架构更改
CreateUser:
SetUser:
getUserResponse:
CreateMeeting:
setMeeting:
getMeetingResponse:
API 40.9.0 更新
XML API 40.9.0 更新
XML API 对 meetingUUID
请求和响应的支持
我们在支持 meetingKey
或 sessionKey
的位置向 API 请求和响应中添加了 meetingUUID。
示例 XML API: GetSessionInfo
请求:
<?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>
<siteName>xxx</siteName>
<webExID>Test</webExID>
<password>xxx</password>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.ep.GetSessionInfo">
<sessionKey>805325231</sessionKey>
or
<meetingUUID>039c00dd25c64ab0812dda22bb8a4fcc</meetingUUID>
</bodyContent>
</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: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:getSessionInfoResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ep:status>NOT_INPROGRESS</ep:status>
<ep:isLocked>false</ep:isLocked>
<ep:sessionkey>805325231</ep:sessionkey>
<ep:meetingUUID>039c00dd25c64ab0812dda22bb8a4fcc</ep:meetingUUID>
<ep:confID>158941507534980823</ep:confID>
...
...
</serv:bodyContent>
</serv:body>
</serv:message>
受影响的 API:
GetEnrollmentInfo
LstsummaryTrainingSession
AddScheduledTest
SetScheduledTest
DelScheduledTest
GetTestInformation
UploadEventImage
SendInvitationEmail
CreateSupportSession
LstmeetingusagePreliminaryHistory
LstmeetingattendeePreliminaryHistory
LsteventsessionPreliminaryHistory
LsteventattendeePreliminaryHistory
LstTrainingPollResultsHistory
Webex 会议中将添加一个锁定的会议等候区,用户可在其中等待被允许进入会议
当该功能 (ConsistentLockedLobby
) 开启时,XML API 会安排和编辑 MC 会议以支持锁定的等候区。
架构更改
已将三个新元素(externalAttendeeSecurity
、autoLock
和 autoLockWaitTime
)添加到 CreateMeeting、SetMeeting 和 GetMeeting API 中。
元素 |
描述 |
---|---|
|
解锁会议后,有三个外部用户安全性项目可供选择。
|
|
是否自动锁定会议。 True: 会议开始 # 分钟后自动锁定会议 False: 会议开始后不自动锁定会议 |
|
表示会议开始多少分钟(0、5、10、15、20)后自动锁定会议 |
请求和响应示例
CreateMeeting 请求:
<bodyContent xsi:type="java:com.webex.service.binding.meeting.CreateMeeting">
...
<attendeeOptions>
...
<joinRequiresAccount>false</joinRequiresAccount>
<externalAttendeeSecurity>AllowJoinWithLobby</externalAttendeeSecurity>
<autoLock>true</autoLock>
<autoLockWaitTime>10</autoLockWaitTime>
</attendeeOptions>
...
</bodyContent>
SetMeeting 请求:
<bodyContent xsi:type="java:com.webex.service.binding.meeting.SetMeeting">
<meetingkey>2###1###01</meetingkey>
...
<attendeeOptions>
...
<joinRequiresAccount>false</joinRequiresAccount>
<externalAttendeeSecurity>AllowJoinWithLobby</externalAttendeeSecurity>
<autoLock>true</autoLock>
<autoLockWaitTime>10</autoLockWaitTime>
</attendeeOptions>
...
</bodyContent>
GetMeeting
的响应:
<?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:meet="http://www.webex.com/schemas/2002/06/service/meeting" xmlns:att="http://www.webex.com/schemas/2002/06/service/attendee">
<serv:header>
<serv:response>
<serv:result>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="meet:getMeetingResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...
<meet:attendeeOptions>
...
<meet:joinRequiresAccount>false</meet:joinRequiresAccount>
<meet:externalAttendeeSecurity>AllowJoin</meet:externalAttendeeSecurity>
<meet:autoLock>true</meet:autoLock>
<meet:autoLockWaitTime>10</meet:autoLockWaitTime>
</meet:attendeeOptions>
...
受影响的 API:
CreateMeeting
SetMeeting
GetMeeting
增强功能 GetSessionInfo
API 可返回进行中的会话中的参加者状态
已添加两个新元素(hasHostInMeeting
、hasAttendeeInMeeting
)到 GetSessionInfo
的响应中。 当会议为进行中的会议时,将返回这两个元素。
元素 |
描述 |
---|---|
|
主持人是否已加入进行中的会议。 True: 主持人已加入进行中的会议。 False/Null: 主持人未加入进行中的会议,或会议不是进行中的会议。 |
|
进行中的会议是否存在与会者/主持人。 True: 进行中的会议中存在与会者或主持人。 False/Null: 进行中的会议中不存在任何与会者或主持人,或会议不是进行中的会议。 |
API 响应示例:
<?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:meet="http://www.webex.com/schemas/2002/06/service/meeting" xmlns:att="http://www.webex.com/schemas/2002/06/service/attendee">
<serv:header>
<serv:response>
<serv:result>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="meet:getMeetingResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...
<ep:status>INPROGRESS</ep:status>
<ep:hasHostInMeeting>true</ep:hasHostInMeeting>
<ep:hasAttendeeInMeeting>true</ep:hasAttendeeInMeeting>
...
受影响的 API:
GetSessionInfo
API GetUserCard 需要授权。
安全性增强 XML API GetUserCard
需要授权才能获取用户的信息。
受影响的 API:
GetUserCard
API 40.8.0 更新
XML API 40.8.0 更新
GetSessionInfo
响应增强功能
如果您未被邀请或者未获得会议批准,则在调用 XML API 时: GetSessionInfo
将不会在 API 响应正文中返回以下元素: confName、startDate、duration、timeZone、meetingLink、sipURL、displayMeetingUrl
。
会议的 API 响应示例:
<serv:bodyContent xsi:type="ep:getSessionInfoResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ep:status>NOT_INPROGRESS</ep:status>
<ep:sessionkey>1####2###4</ep:sessionkey>
<ep:accessControl>
<ep:listStatus>UNLISTED</ep:listStatus>
<ep:registration>false</ep:registration>
<ep:passwordReq>true</ep:passwordReq>
<ep:isRegisterIDRequired>false</ep:isRegisterIDRequired>
</ep:accessControl>
<ep:metaData>
<ep:serviceType>MeetingCenter</ep:serviceType>
</ep:metaData>
<ep:attendeeOptions>
<ep:joinRequiresAccount>false</ep:joinRequiresAccount>
</ep:attendeeOptions>
<ep:isAllowJBH>true</ep:isAllowJBH>
<ep:isCETMeeting>true</ep:isCETMeeting>
<ep:isPersonalMeetingRoom>false</ep:isPersonalMeetingRoom>
</serv:bodyContent>
培训/活动的 API 响应示例:
<serv:bodyContent xsi:type="ep:getSessionInfoResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ep:status>NOT_INPROGRESS</ep:status>
<ep:sessionkey>1####5###9</ep:sessionkey>
<ep:accessControl>
<ep:listStatus>UNLISTED</ep:listStatus>
<ep:registration>true</ep:registration>
<ep:registrationURL>https://sitename.webex.com/tc3300/trainingcenter/register/registerSession.do?siteurl=sitename&confID=16###92######61</ep:registrationURL>
<ep:passwordReq>true</ep:passwordReq>
<ep:registrationURLForMobile>https://sitename.webex.com/tc3300/trainingcenter/meeting/sessionInfoMobile.do?siteurl=sitename&confID=16###92######61</ep:registrationURLForMobile>
<ep:joinStatus>INVITE/REGISTER/REJECT</ep:joinStatus>
<ep:isRegisterIDRequired>false</ep:isRegisterIDRequired>
</ep:accessControl>
<ep:metaData>
<ep:serviceType>TrainingCenter</ep:serviceType>
</ep:metaData>
<ep:attendeeOptions>
<ep:joinRequiresAccount>false</ep:joinRequiresAccount>
</ep:attendeeOptions>
<ep:isAllowJBH>true</ep:isAllowJBH>
<ep:isCETMeeting>true</ep:isCETMeeting>
<ep:isPersonalMeetingRoom>false</ep:isPersonalMeetingRoom>
</serv:bodyContent>
受影响的 API:
GetSessionInfo
GetSessionInfo, GetUserCard
安全性增强
我们对 XML API GetSessionInfo
和 GetUserCard
进行了安全性增强。 如果用户的调用在一小时之内达到上限,但没有发现数据错误,我们将阻止他们在接下来两个小时内访问这两个 API。
错误状态响应: “403 禁止访问”
受影响的 API:GetSessionInfo
GetUserCard
API 请求和响应中支持 meetingUUID
我们在支持 meetingKey/sessionKey
的位置为 API 请求和响应新增了 meetingUUID。
GetSessionInfo
请求:
<?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>
<siteName>xxx</siteName>
<webExID>Test</webExID>
<password>xxx</password>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.ep.GetSessionInfo">
<sessionKey>805325231</sessionKey>
or
<meetingUUID>039c00dd25c64ab0812dda22bb8a4fcc</meetingUUID>
</bodyContent>
</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: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:getSessionInfoResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ep:status>NOT_INPROGRESS</ep:status>
<ep:isLocked>false</ep:isLocked>
<ep:sessionkey>805325231</ep:sessionkey>
<ep:meetingUUID>039c00dd25c64ab0812dda22bb8a4fcc</ep:meetingUUID>
<ep:confID>158941507534980823</ep:confID>
...
...
</serv:bodyContent>
</serv:body>
</serv:message>
受影响的 API:
LstOpenSession
GetEnrollmentInfo
LstsummaryMeeting
LstScheduledTests
GetEvent
LstsummaryEvent
LstmeetingusageHistory
LsttrainingsessionHistory
LsteventsessionHistory
LstsupportsessionHistory
DelSession
支持 XML API 中的教育站点模板(EDU 会话类型)
当您的站点启用教育讲师 (EDU) 会话类型时,XML API 支持通过 EDU 会议模板安排会议。
受影响的 API:
CreateMeeting
SetMeeting
CreateEvent
SetEvent
CreateTrainingSession
SetTrainingSession
支持 XML API CreateMeetingAttendee
和 RegisterMeetingAttendee
CreateMeetingAttendee
和 RegisterMeetingAttendee
都能检查 Webex Meetings 注册所需的与会者注册表单。
该任务有一个新的异常情况:
异常号码 |
异常消息 |
---|---|
040014 |
缺少必填字段(注册表单): ... |
例如,如果您选择“职位”和“公司名称”作为与会者 Webex Meetings 注册表单(如下所示)中的“必填”字段,则在调用以下两个 API 时,就必须在“职位”和“公司名称”中提供值: CreateMeetingAttendee
和 RegisterMeetingAttendee
。
RegisterMeetingAttendee
请求:
<body>
<bodyContent xsi:type="java:com.webex.service.binding.attendee.RegisterMeetingAttendee">
<attendees>
<person>
<name>FirstNameb LastName</name>
<firstName>FirstNameb</firstName>
<lastName>LastName</lastName>
<title>工程师</title> //Job Title
<company>Cisco1234</company> //Company Name
...
<email>****@*****.com</email>
<type>VISITOR</type>
<sendReminder>true</sendReminder>
</person>
<role>ATTENDEE</role>
<joinStatus>ACCEPT</joinStatus>
<emailInvitations>true</emailInvitations>
<sessionKey>1####4####1</sessionKey>
</attendees>
</bodyContent>
</body>
CreateMeetingAttendee
请求:
<bodyContent xsi:type="java:com.webex.service.binding.attendee.CreateMeetingAttendee">
<person>
<name>FirstNameA LastNameA</name>
<firstName>FirstNameA</firstName>
<lastName>LastNameA</lastName>
<title>工程师</title> //Job Title
<company>Cisco1234</company> //Company Name
...
<email>*****@*****.com</email>
<type>VISITOR</type>
<sendReminder>true</sendReminder>
</person>
<role>ATTENDEE</role>
<joinStatus>ACCEPT</joinStatus>
<emailInvitations>true</emailInvitations>
<sessionKey>1###4####1</sessionKey>
040014 响应异常
示例:
<?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:att="http://www.webex.com/schemas/2002/06/service/attendee">
<serv:header>
<serv:response>
<serv:result>FAILURE</serv:result>
<serv:reason>Missing required fields (registration form) : title,company</serv:reason>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
<serv:exceptionID>040014</serv:exceptionID>
<serv:value>title,company</serv:value>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent/>
</serv:body>
</serv:message>
受影响的 API:
CreateMeetingAttendee
RegisterMeetingAttendee
XML API 电子邮件验证增强功能
XML API 不应允许电子邮件中包含空格字符,因此我们增强了电子邮件验证功能,以与“Webex Meetings”页面行为保持一致。
受影响的 API:
CreateMeetingAttendee
CreateEvent
SetEvent
CreateContact
SetContact
SetRecordingInfo
CreateMeetingAttendee
CreateTrainingSession
SetTrainingSession
CreateUser
SetUser
CreateMeeting
SetMeeting
RegisterMeetingAttendee
API 40.7.0 更新
XML API 40.7.0 更新
meetingUUID
支持
我们在支持 meetingKey 或 sessionKey 的位置向 API 请求和响应中添加了 meetingUUID
。
GetSessionInfo
请求示例:
<?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>
<siteName>xxx</siteName>
<webExID>Test</webExID>
<password>xxx</password>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.ep.GetSessionInfo">
<sessionKey>805325231</sessionKey>
or
<meetingUUID>039c00dd25c64ab0812dda22bb8a4fcc</meetingUUID>
</bodyContent>
</body>
GetSessionInfo
请求示例:
<?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>
<siteName>xxx</siteName>
<webExID>Test</webExID>
<password>xxx</password>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.ep.GetSessionInfo">
<sessionKey>805325231</sessionKey>
or
<meetingUUID>039c00dd25c64ab0812dda22bb8a4fcc</meetingUUID>
</bodyContent>
</body>
GetSessionInfo
响应示例:
<?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: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:getSessionInfoResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ep:status>NOT_INPROGRESS</ep:status>
<ep:isLocked>false</ep:isLocked>
<ep:sessionkey>805325231</ep:sessionkey>
<ep:meetingUUID>039c00dd25c64ab0812dda22bb8a4fcc</ep:meetingUUID>
<ep:confID>158941507534980823</ep:confID>
...
...
</serv:bodyContent>
</serv:body>
</serv:message>
受影响的 API:
LstmeetingattendeeHistory
LsttrainingattendeeHistory
LsteventattendeeHistory
LstsupportattendeeHistory
CreateUser
API 欢迎电子邮件支持四种新语言
XMLAPI 欢迎 html 电子邮件支持以下四种新语言:
捷克语 (languageID=19)
波兰语 (languageID=20)
匈牙利语 (languageID=21)
罗马尼亚语 (languageID=22)
XMLAPI 将根据 CreateUser
请求中的语言或 languageID 发送欢迎电子邮件。
使用 CreateUser
发送 Html 欢迎电子邮件示例(捷克语):
<?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>
<siteName>xxx</siteName>
<webExID>Test</webExID>
<password>xxx</password>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.ep.GetSessionInfo">
<bodyContent xsi:type="java:com.webex.service.binding.user.CreateUser">
<firstName>test</firstName>
<lastName>user</lastName>
<webExId>testuser</webExId>
<password>xxxxxx</password>
<email>testuser@test.com</email>
<privilege>
<host>true</host>
</privilege>
<languageID>19</languageID>
or
<language>Czech</language>
<active>ACTIVATED</active>
<sendWelcome>true</sendWelcome>
<isHTMLEmail>true</isHTMLEmail>
</bodyContent>
</bodyContent>
</body>
API 40.6.1、40.4.9 更新
XML API 40.6.1、40.4.9 更新
CreateMeeting/SetMeeting
支持
在安排 Webex 会议时,您可以使用 XML API CreateMeeting/SetMeeting
选中、取消选中或单击与会者注册表单中的必填字段或非必填字段。
以下是用户网页上的会议安排示例,您可以在其中选中与会者注册表单中的必填字段,例如“职位”、“公司名称”、“县/市”及“省/自治区”:
以下是页面字段和 XML API 元素之间的映射:
页面字段 | XMLAPI 元素 |
---|---|
职位 | <title> |
公司名称 | <company> |
地址 1 | <address1> |
地址 2 | <address2> |
县/市 | <city> |
状态 | <state> |
邮政编码 | <postalCode> |
国家/地区 | <country> |
工作电话 | <phone> |
传真 | <fax> |
已更改架构: 将“registrationForm”元素添加到 CreateMeeting
已更改架构: 将“registrationForm”元素添加到 SetMeeting
已更改架构: 将“registrationForm”元素添加到 GetMeeting
CreateMeeting
请求示例:
<bodyContent xsi:type="java:com.webex.service.binding.meeting.CreateMeeting">
<accessControl>
<meetingPassword>password</meetingPassword>
</accessControl>
<attendeeOptions>
<emailInvitations>true</emailInvitations>
<registration>true</registration>
<auto>false</auto>
</attendeeOptions>
<registrationForm>
<title><req>true</req></title> <!-- true -->
<company><req>true</req></company> <!-- true -->
<address1><req>false</req></address1>
<address2><req>false</req></address2>
<city><req>true</req></city> <!-- true -->
<state><req>true</req></state> <!-- true -->
<postalCode><req>false</req></postalCode>
<country><req>false</req></country>
<phone><req>false</req></phone>
<fax><req>false</req></fax>
</registrationForm>
SetMeeting
请求示例:
<bodyContent xsi:type="java:com.webex.service.binding.meeting.SetMeeting">
<meetingkey>1015045339</meetingkey>
<metaData>
<confName>Conference Name</confName>
<meetingType>3</meetingType>
</metaData>
<attendeeOptions>
<emailInvitations>true</emailInvitations>
<registration>true</registration>
<auto>true</auto>
</attendeeOptions>
<registrationForm>
<title><req>true</req></title>
<company><req>true</req></company>
<address1><req>false</req></address1>
<address2><req>false</req></address2>
<city><req>true</req></city>
<state><req>true</req></state>
<postalCode><req>false</req></postalCode>
<country><req>false</req></country>
<phone><req>false</req></phone>
<fax><req>false</req></fax>
</registrationForm>
GetMeeting
响应示例:
<meet:sipURL>1234567890@sitename.webex.com</meet:sipURL>
<meet:displayMeetingUrl>1234567890@sitename.webex.com</meet:displayMeetingUrl>
<meet:registrationForm>
<meet:phone><meet:req>false</meet:req></meet:phone>
<meet:title><meet:req>true</meet:req></meet:title>
<meet:company><meet:req>true</meet:req></meet:company>
<meet:address1><meet:req>false</meet:req></meet:address1>
<meet:address2><meet:req>false</meet:req></meet:address2>
<meet:city><meet:req>true</meet:req></meet:city>
<meet:state><meet:req>true</meet:req></meet:state>
<meet:postalCode><meet:req>false</meet:req></meet:postalCode>
<meet:country><meet:req>false</meet:req></meet:country>
<meet:fax><meet:req>false</meet:req></meet:fax>
</meet:registrationForm>
受影响的 API:
CreateMeeting
SetMeeting
GetMeeting
DelMeeting
E2EE 会议类型不支持 PMR 会议
如果在使用 API CreateUser/SetUser/GetUser/GetMe
进行呼叫期间启用 PMR,且仅有 E2EE 会议类型可用,则会响应以下错误消息: “110063 用户必须至少有一个非 E2EE 会议类型才能启用 PMR。”
受影响的 API:
CreateUser
SetUser
GetUser
GetMe
API 40.6.0 更新
XML API 40.6.0 更新
添加了用户管理角色
我们创建了用户管理角色,并更改了以下架构文件。
已更改架构: CreateUser
请求:
已更改架构: SetUser
已更改架构: GetMe
响应:
已更改架构: LstsummaryUser
响应:
受影响的 API:
CreateUser
SetUser
GetMe
LstsummaryUser
CreateUser
请求示例:
<?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>
<siteName>xxx</siteName>
<webExID>SiteAdmin</webExID>
<password>xxxx</password>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.user.CreateUser">
<firstName>xxx</firstName>
<lastName>xxx</lastName>
<webExId>xxx</webExId>
<password>xxx</password>
<email>xxx</email>
<privilege>
<umSiteAdmin>true</umSiteAdmin>
<host>false</host>
<siteAdmin>false</siteAdmin>
<labAdmin>false</labAdmin>
<voiceOverIp>false</voiceOverIp>
</privilege>
<languageID>3</languageID>
<active>ACTIVATED</active>
<sendWelcome>true</sendWelcome>
<isHTMLEmail>true</isHTMLEmail>
</bodyContent>
</body>
支持使用 API 密钥访问 GetUserCard
我们现在支持使用 API 密钥(生成的 JWT 令牌)访问 API: GetUserCard
(在此发行版中)。
您可以参考以下页面了解如何应用 API 密钥和生成 JWT 令牌:
GetUserCard
请求示例:
POST https://{sitename}.webex.com/WBXService/XMLService
Header:
Content-Type application/json;charset=utf-8
JWTToken ${jwttoken}
Body:
<?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>{sitename}</siteName>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.user.GetUserCard">
<webExId>{userName}</webExId>
</bodyContent>
</body>
</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: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:getUserCardResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<use:avatar>
<use:url>https://xxxx.webex.com/svc3300/svccomponents/html/img/avatar160.png</use:url>
<use:lastModifiedTime>1587493389768</use:lastModifiedTime>
<use:isUploaded>false</use:isUploaded>
</use:avatar>
<use:personalMeetingRoom>
<use:title>Test's Personal Room</use:title>
<use:personalMeetingRoomURL>https://xxxx.webex.com/meet/Test</use:personalMeetingRoomURL>
<use:accessCode>713289692</use:accessCode>
</use:personalMeetingRoom>
</serv:bodyContent>
</serv:body>
</serv:message>
API 请求和响应中支持 meetingUUID
我们在支持 meetingKey 或 sessionKey 时向 API 请求和响应中添加了 meetingUUID
。
受影响的 API:
LstRecording
LstsummarySession
GetSesssionInfo
GethosturlMeeting
GetjoinurlMeeting
LstMeetingAttendee
CreateMeeting
SetMeeting
GetMeeting
DelMeeting
LstCalendarSession
meetingUUID
请求示例:
<?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>
<siteName>xxx</siteName>
<webExID>Test</webExID>
<password>xxx</password>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.ep.GetSessionInfo">
<sessionKey>805325231</sessionKey>
or
<meetingUUID>039c00dd25c64ab0812dda22bb8a4fcc</meetingUUID>
</bodyContent>
</body>
meetingUUID
响应示例:
<?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: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:getSessionInfoResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ep:status>NOT_INPROGRESS</ep:status>
<ep:isLocked>false</ep:isLocked>
<ep:sessionkey>805325231</ep:sessionkey>
<ep:meetingUUID>039c00dd25c64ab0812dda22bb8a4fcc</ep:meetingUUID>
<ep:confID>158941507534980823</ep:confID>
...
...
</serv:bodyContent>
</serv:body>
</serv:message>
临时停用用户或禁用 PMR 不会更改 PMR 会议密钥
当临时停用的用户或禁用的 PMR 在一周内重新激活时,现在重新激活的用户或启用的 PMR 的会议密钥不会更改,与之前相同。
受影响的 API:
SetUser
DelUser
LstSummarySession
增强功能
我们增强了 API: LstSummarySession
返回已安排的 PMR,在请求中有一个新元素 returnScheduledPMR
。 功能切换缺省设置为关闭。
受影响的 API:
LstSummarySession
架构更改:
我们在 API LstSummarySession 请求中添加了名为 returnScheduledPMR
的新元素。
我们在 API LstSummarySession 响应中添加了名为 isScheduledPMR
的新元素。
LstSummarySession
请求示例:
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<header>
<securityContext>
<siteName>xxx</siteName>
<webExID>Test</webExID>
<password>xxx</password>
<partnerID>xxxx</partnerID>
<clientInfo>xxxx</clientInfo>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.ep.LstsummarySession">
<listControl>
<startFrom>1</startFrom>
<maximumNum>2</maximumNum>
<listMethod>AND</listMethod>
</listControl>
<dateScope>
<startDateStart>11/01/2019 8:0:0</startDateStart>
<startDateEnd>12/01/2019 7:59:59</startDateEnd>
<timeZoneID>4</timeZoneID>
<endDateStart>11/01/2019 8:0:0</endDateStart>
<endDateEnd>12/01/2019 7:59:59</endDateEnd>
</dateScope>
<order>
<orderBy>HOSTWEBEXID</orderBy>
<orderAD>ASC</orderAD>
<orderBy>CONFNAME</orderBy>
<orderAD>ASC</orderAD>
<orderBy>STARTTIME</orderBy>
<orderAD>ASC</orderAD>
</order>
<serviceTypes>
<serviceType>EventCenter</serviceType>
<serviceType>MeetingCenter</serviceType>
<serviceType>SalesCenter</serviceType>
<serviceType>TrainingCenter</serviceType>
<serviceType>SupportCenter</serviceType>
</serviceTypes>
<returnScheduledPMR>true</returnScheduledPMR>
</bodyContent>
</body>
</serv:message>
LstSummarySession
响应示例:
<?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: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:lstsummarySessionResponse">
<ep:matchingRecords>
<serv:total>1787</serv:total>
<serv:returned>2</serv:returned>
<serv:startFrom>1</serv:startFrom>
</ep:matchingRecords>
<ep:session>
<ep:sessionKey>809914325</ep:sessionKey>
<ep:MeetingUUID>809914325</ep:MeetingUUID>
<ep:confName>Team Meeting</ep:confName>
<ep:sessionType>3</ep:sessionType>
<ep:serviceType>MeetingCenter</ep:serviceType>
<ep:hostWebExID>Test</ep:hostWebExID>
<ep:hostFirstName>Test</ep:hostFirstName>
<ep:hostLastName>Test</ep:hostLastName>
<ep:otherHostWebExID>Test</ep:otherHostWebExID>
<ep:timeZoneID>2</ep:timeZoneID>
<ep:timeZone>GMT-10:00, Hawaii (Honolulu)</ep:timeZone>
<ep:status>NOT_INPROGRESS</ep:status>
<ep:startTime>10/12/2019 00:35:41</ep:startTime>
<ep:duration>60</ep:duration>
<ep:listStatus>PUBLIC</ep:listStatus>
<ep:hostEmail>Test@webex.com</ep:hostEmail>
<ep:passwordReq>true</ep:passwordReq>
<ep:hostJoined>false</ep:hostJoined>
<ep:participantsJoined>false</ep:participantsJoined>
<ep:confID>141672157056861215</ep:confID>
<ep:registration>false</ep:registration>
<ep:isRecurring>true</ep:isRecurring>
<ep:hostType>1019001</ep:hostType>
<ep:isAudioOnly>false</ep:isAudioOnly>
<ep:isTCSingleRecurrence>false</ep:isTCSingleRecurrence>
<ep:isAllowJBH>false</ep:isAllowJBH>
<ep:isCETMeeting>true</ep:isCETMeeting>
<ep:isException>false</ep:isException>
<ep:isNextUpcomingInstance>false</ep:isNextUpcomingInstance>
<ep:seriesMeetingKey>0</ep:seriesMeetingKey>
<ep:recurrenceId>0</ep:recurrenceId>
<ep:isScheduledPMR>true</ep:isScheduledPMR>
</ep:session>
<ep:session>
<ep:sessionKey>805660167</ep:sessionKey>
<ep:confName>xmlmc Molly08Console816960001</ep:confName>
<ep:sessionType>3</ep:sessionType>
<ep:serviceType>MeetingCenter</ep:serviceType>
<ep:hostWebExID>Molly08Console81696000</ep:hostWebExID>
<ep:hostFirstName>Molly08Console81696000</ep:hostFirstName>
<ep:hostLastName>Molly08Console81696000</ep:hostLastName>
<ep:otherHostWebExID>Molly08Console81696000</ep:otherHostWebExID>
<ep:timeZoneID>2</ep:timeZoneID>
<ep:timeZone>GMT-10:00, Hawaii (Honolulu)</ep:timeZone>
<ep:status>NOT_INPROGRESS</ep:status>
<ep:startTime>10/12/2019 00:35:41</ep:startTime>
<ep:duration>60</ep:duration>
<ep:listStatus>PUBLIC</ep:listStatus>
<ep:hostEmail>Molly08Console81696000@webex.com</ep:hostEmail>
<ep:passwordReq>true</ep:passwordReq>
<ep:hostJoined>false</ep:hostJoined>
<ep:participantsJoined>false</ep:participantsJoined>
<ep:confID>141672108716459038</ep:confID>
<ep:registration>false</ep:registration>
<ep:isRecurring>true</ep:isRecurring>
<ep:hostType>1019001</ep:hostType>
<ep:isAudioOnly>false</ep:isAudioOnly>
<ep:isTCSingleRecurrence>false</ep:isTCSingleRecurrence>
<ep:isAllowJBH>false</ep:isAllowJBH>
<ep:isCETMeeting>true</ep:isCETMeeting>
<ep:isException>false</ep:isException>
<ep:isNextUpcomingInstance>false</ep:isNextUpcomingInstance>
<ep:seriesMeetingKey>0</ep:seriesMeetingKey>
<ep:recurrenceId>0</ep:recurrenceId>
<ep:isScheduledPMR>true</ep:isScheduledPMR>
</ep:session>
</serv:bodyContent>
</serv:body>
</serv:message>
GetSite
增强功能
我们添加了 GetSite
响应功能切换 SupportXMLAPIReturnScheduledPMR
受影响的 API:
GetSite
架构更改:
XML API GetSite
响应新元素为: SupportXMLAPIReturnScheduledPMR
GetSite
请求示例:
<?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>
<siteName>xxx</siteName>
<webExID>Test</webExID>
<password>xxx</password>
<clientInfo>xxx</clientInfo>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.site.GetSite">
</bodyContent>
</body>
GetSite
响应示例:
<?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:siteCommonOptions>
...
<ns1:SupportXMLAPIReturnScheduledPMR>true</ns1:SupportXMLAPIReturnScheduledPMR>
...
</ns1:siteCommonOptions>
</ns1:siteInstance>
</serv:bodyContent>
</serv:body>
</serv:message>
API 40.4.8、40.2.9 更新
XML API 40.4.8、40.2.9 更新
在 XMLAPI 中更新已安排的会议时的新增响应
当客户使用 XMLAPI 更新通过其页面安排的会议时,我们会在会议电子邮件更新中发送数字密码,并将其应用于 Webex Meetings、Teams 和 Events Center。
这些 API: GetMeeting、GetTrainingSession、GetEvent
和 GetTeleconferenceSession
将以下新元素作为响应: audioPassword
(数字密码)、isEnforceAudioPassword
、isEnforceAudioLogin
(适用于 Webex Meetings、Teams 和 Events Center)。
已更改架构:
受影响的 API:
GetMeeting
GetTrainingSession
GetEvent
GetTeleconferenceSession
GetMeeting
请求示例:
<?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>testSite</siteName>
<webExID>test</webExID>
<password>xxx</password>
<partnerID>xx</partnerID>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.meeting.GetMeeting">
<meetingKey>803328224</meetingKey>
</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:meet="http://www.webex.com/schemas/2002/06/service/meeting" xmlns:att="http://www.webex.com/schemas/2002/06/service/attendee">
<serv:header>
<serv:response>
<serv:result>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="meet:getMeetingResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<meet:accessControl>
<meet:listToPublic>false</meet:listToPublic>
<meet:isPublic>false</meet:isPublic>
<meet:meetingPassword>PkzC8tP7kM5</meet:meetingPassword>
<meet:audioPassword>75928877</meet:audioPassword>
<meet:isEnforceAudioPassword>true</meet:isEnforceAudioPassword>
<meet:isEnforceAudioLogin>false</meet:isEnforceAudioLogin>
</meet:accessControl>
...
...
</serv:bodyContent>
</serv:body>
</serv:message>
API 40.4.5, 40.2.6 更新
XML API 40.4.5, 40.2.6 更新
GetUserCard
和 GetSessionInfo
使用限制
我们对 API GetUserCard
和 GetSessionInfo
执行使用限制,您可能会收到以下错误消息: 如果达到使用限制,将显示“403 禁止访问”。
受影响的 API:
GetUserCard
GetSessionInfo
API 40.4.4, 40.2.5 更新
XML API 40.4.4, 40.2.5 更新
BodyContent
号码限制
我们已在每个 XML API 部分中添加了有限数量的 BodyContent
。 如果您在 API 请求中添加的 BodyContent
过多,系统将返回以下错误代码和消息: “000053 请求中的 BodyContent 计数必须少于 {number} 个”
受影响的 API:
任意 XML API
有多个 BodyContent
的 XML 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>xxxx</webExID>
<password>xxxx</password>
<siteName>xxx</siteName>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.user.GetUser">
<webExId>xxx</webExId>
</bodyContent>
<bodyContent xsi:type="java:com.webex.service.binding.user.GetSite">
</bodyContent>
<bodyContent xsi:type="java:com.webex.service.binding.ep.GetSessionInfo">
<sessionKey>801020403</sessionKey>
</bodyContent>
</body>
API 40.4.3, 40.2.4 更新
XML API 40.4.3, 40.2.4 更新
CreateUser
增强功能
增强的 CreateUser
可支持多种语言的欢迎电子邮件。 CreateUser
现可请求 isHTMLEmail
受影响的 API:
CreateUser
CreateUser
请求示例:
<?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>administrator</webExID>
<password>xxxx</password>
<siteName>xxx</siteName>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.user.CreateUser">
<firstName>xxx</firstName>
<lastName>xxx</lastName>
<webExId>xxx</webExId>
<password>xxx</password>
<email>xxx</email>
<privilege>
<host>true</host>
<siteAdmin>false</siteAdmin>
<labAdmin>false</labAdmin>
<voiceOverIp>false</voiceOverIp>
</privilege>
<languageID>3</languageID>
<active>ACTIVATED</active>
<sendWelcome>true</sendWelcome>
<isHTMLEmail>true</isHTMLEmail>
</bodyContent>
</body>
API 40.4.0 更新
XML API 40.4.0 更新
在 XML API 中更改电子邮件时强制执行电子邮件验证
当站点管理员在 Webex 站点管理中启用用户更新电子邮件地址时需要确认后:
如果非站点管理员帐户调用
SetUser API
来更改电子邮件地址,当前电子邮件将保留,直到验证新电子邮件为止。 帐户更改确认电子邮件将通过“Webex 帐户更改确认”发送至新的电子邮件地址。 单击电子邮件中的链接进行确认后,将立即关联新的电子邮件地址。如果非站点管理员调用
SetUser
API 多次,但都没有完成电子邮件验证流程,则保留当前电子邮件并且必须验证最新的电子邮件。如果站点管理员帐户调用
SetUser
API 来更改电子邮件地址,则不会触发电子邮件验证流程。 新电子邮件将立即与主持人或与会者的帐户关联。
受影响的 API:
SetUser
GetEnrollmentInfo
超时和连接重置
GetEnrollmentInfo
API 当前正在域名系统上查找 IP 地址,这会对性能产生极大影响。 我们计划简化该流程,并在 <domain>
字段给出空白响应。
受影响的 API:
GetEnrollmentInfo
GetEnrollmentInfo
请求示例:
<?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>
<siteName>sqdemo6</siteName>
<webExID>xxx</webExID>
<password>xxxx</password>
<partnerID>webexpartner</partnerID>
</securityContext>
</header>
<body>
<bodyContent
xsi:type="java:com.webex.service.binding.attendee.GetEnrollmentInfo">
<sessionKey>716773566</sessionKey>
</body>
GetEnrollmentInfo
响应示例:
<?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:att="http://www.webex.com/schemas/2002/06/service/attendee">
<serv:header>
<serv:response>
<serv:result>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="att:getEnrollmentInfoResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<att:session>
<att:confID>154279066999981548</att:confID>
<att:attendee>
<att:attendeeID>3191792</att:attendeeID>
<att:enrollFields>
<att:defaultFields>
<att:firstName>Alex</att:firstName>
<att:lastName>Yang</att:lastName>
<att:email>omega.alex.yang@gmail.com</att:email>
<att:company></att:company>
<att:phoneNum></att:phoneNum>
<att:title></att:title>
<att:receiveInfo>false</att:receiveInfo>
<att:address1></att:address1>
<att:address2></att:address2>
<att:city></att:city>
<att:state></att:state>
<att:zipcode></att:zipcode>
<att:country></att:country>
<att:leadSourceID></att:leadSourceID>
<att:leadScore>0.0</att:leadScore>
</att:defaultFields>
<att:customFields/>
</att:enrollFields>
<att:domain> </att:domain>
<att:ipAddress>10.35.240.53</att:ipAddress>
<att:submitTime>02/27/2020 22:03:57</att:submitTime>
<att:status>APPROVED</att:status>
</att:attendee>
<att:attendee>
<att:attendeeID>3191797</att:attendeeID>
<att:enrollFields>
<att:defaultFields>
<att:firstName>AlexKKK</att:firstName>
<att:lastName>Test</att:lastName>
<att:email>achillesyang@hotmail.com</att:email>
<att:company></att:company>
<att:phoneNum></att:phoneNum>
<att:title></att:title>
<att:receiveInfo>false</att:receiveInfo>
<att:address1></att:address1>
<att:address2></att:address2>
<att:city></att:city>
<att:state></att:state>
<att:zipcode></att:zipcode>
<att:country></att:country>
<att:leadSourceID></att:leadSourceID>
<att:leadScore>0.0</att:leadScore>
</att:defaultFields>
<att:customFields/>
</att:enrollFields>
<att:domain> </att:domain>
<att:ipAddress>10.154.181.15</att:ipAddress>
<att:submitTime>02/27/2020 22:07:38</att:submitTime>
<att:status>APPROVED</att:status>
</att:attendee>
<att:matchingRecords>
<serv:total>2</serv:total>
<serv:returned>2</serv:returned>
<serv:startFrom>1</serv:startFrom>
</att:matchingRecords>
<att:sessionKey>716773566</att:sessionKey>
</att:session>
</serv:bodyContent>
</serv:body>
API 40.2.0 更新
XML API 40.2.0 更新
删除对下列项的匿名访问:LstSummarySession
作为安全性增强功能,我们即将停止支持对 LstSummarySession API
的匿名访问。 如果 Webex Meetings 以匿名方式访问 API,则会返回以下错误代码和消息: “000015,非常抱歉,未找到记录。”
受影响的 API:
LstSummarySession
LstSummarySession
请求示例:
<?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>
<siteName>sitename1</siteName>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.ep.LstsummarySession">
<sessionKey>211894651</sessionKey>
</bodyContent>
</body>
</serv:message>
LstSummarySession
响应示例:
<?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: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>
CreateMeeting
和 SetMeeting
安全性增强功能
此更改是在 XML API 40.2.0 中进行的,但在收到客户反馈后已对其描述进行了编辑。 |
作为安全性增强功能,我们对 CreateMeeting
和 SetMeeting
API 进行了更新,不允许用户将会议开始时间安排在过去。 如果他们试图这样做,API 将提示错误消息: “060016 课程开始时间应晚于当前时间。” 如果用户需要安排即时会议,我们建议将会议开始时间设置为比当前时间晚 5 分钟。
受影响的 API:
CreateMeeting
SetMeeting
API 40.1.2 更新
XML API 40.1.2 更新
如果没有提供密码,在安排会议时会自动生成密码
我们增强了 CreateMeeting
、CreateEvent
、CreateTrainingSession
和 CreateTeleconferenceSession
,以在 API 响应正文中包含密码。
缺省情况下,所有会议/活动/课程都必须包含密码设置处于启用状态。 在这种情况下,如果 API 请求中不包含密码,系统会自动从 XML API 服务器生成密码。
如果所有会议/活动/课程都必须包含密码设置被禁用,并且 API 请求中不包含密码,则不会从 XML API 服务器生成密码。
如果 API 请求中包含密码,则无论所有会议/活动/课程都必须包含密码设置被启用还是禁用,响应都将包含该密码。
受影响的 API:
CreateMeeting
CreateEvent
CreateTrainingSession
CreateTeleconferenceSession
CreateMeeting
响应现在具有 meetingPassword
元素:
CreateMeeting
请求示例:
<?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>
<siteName>siteName1</siteName>
<webExID>userID</webExID>
<password>*****</password>
<partnerID>webexpartner</partnerID>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.meeting.CreateMeeting">
<metaData>
<confName>Test_Auto_Generated_mtg_pwd</confName>
<meetingType>3</meetingType>
</metaData>
<schedule>
<startDate>10/28/2020 17:35:00</startDate>
</schedule>
</bodyContent>
</body>
CreateMeeting
响应示例:
<?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:meet="http://www.webex.com/schemas/2002/06/service/meeting" xmlns:att="http://www.webex.com/schemas/2002/06/service/attendee">
<serv:header>
<serv:response>
<serv:result>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="meet:createMeetingResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<meet:meetingkey>806745263</meet:meetingkey>
<meet:meetingPassword>UzXJuzUD428</meet:meetingPassword>
<meet:iCalendarURL>
<serv:host>https://hmwds6.qa.webex.com/hmwds6/j.php?MTID=md225d5935256319ef21b71dd8ebd0640</serv:host>
<serv:attendee>https://hmwds6.qa.webex.com/hmwds6/j.php?MTID=m26bf5e25ca587d32302fb29951b92e15</serv:attendee>
</meet:iCalendarURL>
<meet:guestToken>cfc7f3246d4862f1bb69b803e8615b7a</meet:guestToken>
</serv:bodyContent>
</serv:body>
</serv:message>
CreateEvent
响应现在具有 eventPassword
元素:
CreateTrainingSession
和 CreateTeleconferenceSession
响应现在具有 sessionPassword
元素:
API 40.1.0 更新
XML API 40.1.0 更新
GetSessionInfo
增强功能
我们已将新元素添加到 GetSessionInfo
API 中。 现在,该 API 还会返回移动设备的信息。
受影响的 API:
GetSessionInfo
GetSessionInfo
请求更新:

请求示例:
<?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>
<siteName>sqdemo11</siteName>
<webExID>siteadmin</webExID>
<password>P@ss1234</password>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.ep.GetSessionInfo">
<sessionKey>713707633</sessionKey>
<pmrUrl>https://go.webex.com/join/dongchen</pmrUrl>
<sipUrl>dongchen@go.webex.com or 123456789_go@webex.com or 123456789@go.webex.com</sipUrl>
<meetingLink>https://go.webex.com/go/j.php?MTID=m814c6a483d4b5052d539f88d67acbad6</meetingLink>
<meetingUuid>34567323456787654323456787654</meetingUuid>
</bodyContent>
</body>
</serv:message>
LstAccessAnywhereHistory
增强功能
我们添加了新的 API lstAccessAnywhereHistory
,用于响应 Webex Access Anywhere 报告信息。
受影响的 API:
LstAccessAnywhereHistory
LstAccessAnywhereHistory
请求更新:

LstAccessAnywhereHistory
响应更新:

请求示例:
<?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>
<siteName>sqdemo6</siteName>
<webExID>test</webExID>
<password>P@ss1234</password>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.history.LstAccessAnywhereHistory">
<hostWebexID>test1</hostWebexID>
<startTimeScope>
<sessionStartTimeStart>09/29/2019 00:42:34</sessionStartTimeStart>
<sessionStartTimeEnd>12/29/2019 04:42:34</sessionStartTimeEnd>
</startTimeScope>
<endTimeScope>
<sessionEndTimeStart>9/29/2019 02:42:34</sessionEndTimeStart>
<sessionEndTimeEnd>12/29/2019 05:42:34</sessionEndTimeEnd>
</endTimeScope>
<listControl>
<serv:startFrom>1</serv:startFrom>
<serv:maximumNum>10</serv:maximumNum>
<serv:listMethod>OR</serv:listMethod>
</listControl>
<order>
<orderBy>STARTTIME</orderBy>
<orderAD>ASC</orderAD>
</order>
</bodyContent>
</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>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="history:LstAccessAnywhereHistoryResponse">
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<history:matchingRecords>
<serv:total>775</serv:total>
<serv:returned>10</serv:returned>
<serv:startFrom>1</serv:startFrom>
</history:matchingRecords>
<history:accessAnyWhereInfo>
<history:confID>123456</history:confID>
<history:userName>dean</history:userName>
<history:computerName>6926_dean</history:computerName>
<history:clientIP>10.224.222.183</history:clientIP>
<history:startTime>11/29/2019 03:05:44</history:startTime>
<history:endTime>11/29/2019 03:10:06</history:endTime>
<history:duration>5</history:duration>
</history:accessAnyWhereInfo>
</serv:body>