尋找您需要的關於 Cisco Webex Meetings API 的所有重要資訊,例如綱要變更和其他公告。
如需 XML API 41 的相關資訊,請參閱 Cisco Webex Meetings API 更新概觀 (API 41)
如需 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 is a sample which supports Private Meeting
</metaData>
</bodyContent>
</body>
XML API 的回應: GetSessionInfo
回應 isPrivateMeeting
<ep:supportE2E>false</ep:supportE2E>
<ep:isAllowJBH>true</ep:isAllowJBH>
<ep:isPrivateMeeting>true</ep:isPrivateMeeting> //true: the meeting supports Private Meeting; false: the meeting does
not support Private Meeting.
<ep:isCETMeeting>false</ep:isCETMeeting>
<ep:isPersonalMeetingRoom>false</ep:isPersonalMeetingRoom>
<ep:isNextUpcomingInstance>true</ep:isNextUpcomingInstance>
GetSite API 將傳回網站層級的會議範本
使用者案例/任務說明
GetSite API,用以傳回網站層級的會議範本。 這將允許 Education Connector 和 Webex 教室顯示這些範本,供教師在安排其線上課程時選擇。
受影響的 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>
XML API SetUser 無法變更元素 supportedServices
當網站是 CI 統一網站時
說明
XMLAPI SetUser
不支援 API 請求中的變更值「 supportedServices
」(當網站是 Control Hub 鏈結的統一 Webex 會議網站時)。
綱要變更
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>
</serv:message>
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
在 DB 中是空值且功能切換 EnableDisplayName
為 1, displayName
將被 firstName+" "+lastName
適用於非亞洲字元及 firstName+lastName
適用於亞洲字元。
綱要變更
GetUserResponse:
適用於 CMR 混合 VoIP 的 XMLAPI 使用者層級控制項
該 cmrHybridVoip
設定用於設定和擷取以下內容的使用者層級設定 EnableCMRHybridVoIP
。
綱要變更
GetUser Response:
CreateUser Request:
SetUser Request:
API 40.10.0 更新
XML API 40.10.0 更新
XML API support for meeting UUID
在 API 請求和回應中
範例 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>
</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: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
錯誤和客戶,例如 Goldman Sachs。 他們不希望最終使用者在 Meetings 應用程式中擷取螢幕。同時,也有很多其他客戶希望允許螢幕擷取這一功能。 此外,教育使用者也希望允許螢幕擷取。 因此,我們將為此提供一個網站管理員設定,XMLAPI 將傳回額外的欄位 EnableMobileScreenCapture
(在 GetSite 的回應中) 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
inpersonalMeetingRoom
。createMeeting/setMeeting/getMeeting
新增一個節點deviceCanStartMeeting
(在排程中)。
Webex 使用者介面中用於個人會議室會議的選項:
綱要變更
CreateUser:
SetUser:
getUserResponse:
CreateMeeting:
setMeeting:
getMeetingResponse:
API 40.9.0 更新
XML API 40.9.0 更新
XML API support for meeting UUID
請求和回應
我們已將會議 UUID 新增至 API 請求和回應,我們在其中支援作為 meetingKey
或 sessionKey
。
範例 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>
</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: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)後自動鎖定會議 |
請求和回應範例
Request of 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>
</body>
</serv:message>
Request of 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>
</body>
</serv:message>
回應 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>
...
</bodyContent>
</body>
</serv:message>
受影響的 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>
...
</bodyContent>
</body>
</serv:message>
受影響的 API:
GetSessionInfo
API GetUserCard 需要授權。
安全性增強 XML API GetUserCard
需要授權才能取得使用者的資訊。
受影響的 API:
GetUserCard
API 40.8.0 更新
XML API 40.8.0 更新
GetSessionInfo
回應增強
如果您未收到來自會議的邀請或未被核准,請呼叫 XML API: GetSessionInfo
將不會返回以下元素: confName, startDate, duration, timeZone, meetingLink, sipURL, displayMeetingUrl
(在 API 回應內文中)。
Meetings 的 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>
Trainings/Events 的 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
meetingUUID
(在 API 請求和回應支援中)
我們已將會議 UUID 新增至 API 請求和回應,我們在其中支援 meetingKey/sessionKey
。
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>
</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: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 階段作業類型)
當您的網站啟用 Education Instructor (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>Engineer</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>
</serv:message>
CreateMeetingAttendee
請求:
<bodyContent xsi:type="java:com.webex.service.binding.attendee.CreateMeetingAttendee">
<person>
<name>FirstNameA LastNameA</name>
<firstName>FirstNameA</firstName>
<lastName>LastNameA</lastName>
<title>Engineer</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 Exception of Response
範例:
<?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
支援
我們已新增 meetingUUID
至 API 請求和回應,我們在其中支援 meetingKey 或 sessionKey。
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>
</serv:message>
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>
</serv:message>
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 請求中的語言或語言 ID 傳送歡迎使用電子郵件 CreateUser
請求開始活動的問題。
使用 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>
</serv:message>
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>
</serv:bodyContent>
</serv:body>
</serv:message>
受影響的 API:
CreateMeeting
SetMeeting
GetMeeting
DelMeeting
E2EE 會議類型不支援 PMR 會議
在使用 API 進行呼叫期間啟用 PMR: CreateUser/SetUser/GetUser/GetMe
且只有 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>
</serv:message>
支援使用 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>
支援 meetingUUID
在 API 請求和回應中
我們在支援 meetingKey 或 sessionKey 時已新增 meetingUUID
至 API 請求和回應。
受影響的 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>
</serv:message>
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
返回 scheduled-PMR 以便具有一個新元素, returnScheduledPMR
(在請求中)。 且功能切換預設為關閉。
受影響的 API:
LstSummarySession
綱要變更:
我們新增了一個新的元素名稱 returnScheduledPMR
(在 API LstSummarySession 請求中)。
我們新增了一個新的元素名稱 isScheduledPMR
(在 API LstSummarySession 回應中)。
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>
</serv:message>
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、Webex Teams 和 Webex Events 中心。
這些 API: GetMeeting, GetTrainingSession, GetEvent
和 GetTeleconferenceSession
,將使用這些新元素作為回應: audioPassword
(數字密碼), isEnforceAudioPassword
、 isEnforceAudioLogin
適用於 Webex Meetings、Teams 和 Events 中心。
已變更的綱要:
受影響的 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
數量限制
我們新增了數量有限的 BodyContent
(在每個 XML API 區段中)。 當您在 API 請求中新增太多 BodyContent
,將傳回下列錯誤代碼和訊息: 「000053 請求中的 BodyContent 計數必須小於 {number}」
受影響的 API:
任何 XML API
XML API 請求,其包含多個 BodyContent
範例:
<?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>
</serv:message>
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>
</serv:message>
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>
</bodyContent>
</body>
</serv:message>
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>
</serv:message>
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>
</serv:message>
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>
</serv:message>
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>
</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>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:bodyContent>
</serv:body>
</serv:message>