如需 XML API 39 和 XML API 11 的相關資訊，請參閱 Cisco Webex Meetings XML API 更新概觀（XML API 39 和更低版本）。

如需 XML API 40 的相關資訊，請參閱 Cisco Webex Meetings XML API 更新概觀（XML API 40 和更高版本）。

如需 XML API 11 SP9 及更早版本的更新，請轉至 Cisco DevNet。

API 41.12.0 更新

XML API 41.12.0 更新

按一下這裡以下載 XML API 41.12.0 綱要。

XMLAPI 將阻止 Webex Events（傳統版）排程和編輯，依據網站設定項目 EnableClassicEvent 為 false

受影響的 API 和綱要變更

在網站管理組態頁面中，如果啟用傳統版 Event 勾選方塊為 false，則此網站將不再支援 Webex Events（傳統版）會議。

如果啟用傳統版 Event 勾選方塊為 false，則您可呼叫這些 API 以執行 Webex Events（傳統版）會議：

CreateEvent 、 SetEvent 、 GetEvent 、 GetSessionInfo 、 LstsummaryEvent 、 LstrecordedEvent 、 LstsummaryProgram 、 UploadEventImage

API 將回應新的異常狀況 010106傳統版 Event 已停用。

綱要變更

無綱要變更。

API 請求和回應範例

CreateEvent API 請求和回應

CreateEvent 的請求

<bodyContent xsi:type="java:com.webex.service.binding.event.CreateEvent">
  <accessControl>
    <sessionPassword>XXXXXXXX</sessionPassword>
  </accessControl>
   <metaData>
    <sessionName>XMLAPI EC Testing</sessionName>
   </metaData>
  <schedule>
    <startDate>07/17/2021 01:29:15</startDate>
    <openTime>15</openTime>            
  </schedule>
</bodyContent>
</body>
</serv:message>

CreateEvent 的回應

<?xml version="1.0" encoding="ISO-8859-1"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>FAILURE</serv:result>
            <serv:reason>The classic Event has been disabled.</serv:reason>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
            <serv:exceptionID>010106</serv:exceptionID>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent/>
    </serv:body>
</serv:message>

CreateEvent3.1.3 影響 API：

  • SetEvent GetEvent

  • GetSessionInfo

  • LstsummaryEvent

  • LstrecordedEvent

  • LstsummaryProgram

  • UploadEventImage

XMLAPI LstMeetingType 將回應至新元素 subProductCodePrefix

受影響的 API

目前 API LstMeetingType 回應元素 productionCodePrefix ：PRO、AUO 及其他是 Webex 預先定義的 meet 類型字首。

此次新增增強功能之後，API 將會回應以下新元素： subProdctCodePrefix:PRO1、PRO2 等，可自訂為 meet 類型的字首。

API 上的綱要變更： LstMeetingType

將會回應新元素： subProdctCodePrefix

API 請求和回應範例

LstMeetingType API 請求和回應

請求 LstMeetingType

<bodyContent xsi:type="java:com.webex.service.binding.meetingtype.LstMeetingType">
    <meetingTypeID>13810</meetingTypeID>
</bodyContent>
</body>
</serv:message>

回應 LstMeetingType

<serv:body>
        <serv:bodyContent xsi:type="mtgtype:lstMeetingTypeResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <mtgtype:matchingRecords>
                <serv:total>1</serv:total>
                <serv:returned>1</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </mtgtype:matchingRecords>
            <mtgtype:meetingType>
                <mtgtype:productCodePrefix>PRO</mtgtype:productCodePrefix>
                <mtgtype:subProductCodePrefix>PRO3</mtgtype:subProductCodePrefix>       //New element for customized meeting type
                <mtgtype:active>ACTIVATED</mtgtype:active>
                <mtgtype:name>Cus_Chat_Closed</mtgtype:name>
                <mtgtype:displayName>Cus_Chat_Closed</mtgtype:displayName>

API 41.11.0 更新

XML API 41.11.0 更新

按一下這裡以下載 XML API 41.11.0 綱要。

XML API 支援 Control Hub 管理網站的使用者管理 API 正向相容性

受影響的 API 和綱要變更

如果您的整合應用程式目前正在使用 Webex XMLAPI 使用者管理 API： CreateUser 、 SetUser 、 DelUser 和 GetUser 若要佈建或管理使用者，在 Webex 傳統版網站轉換為 Control Hub 管理網站後，這些 API 將會繼續執行正向相容。 會變更部分行為，如下所述：

  • 使用 createUser 時－如果 Control Hub 中的使用者狀態並非「啟用中」，則網站上的使用者狀態也將不會是啟用中。 如果 Control Hub 中的使用者狀態為啟用中，則網站上的使用者狀態也會是啟用中，請參照： 新使用者及已轉換使用者在 Control Hub 中的使用者狀態

  • 密碼元素（屬於　CreateUser 和 SetUser API）將受到忽略，我們會開始傳送啟用電子郵件給新使用者，使用者可按一下電子郵件中的連結，以啟用新帳戶並輸入新密碼。

  • 啟用中元素（屬於CreateUser API）將受到忽略，新使用者（尚未驗證）將無法透過此參數使用 API SetUser啟用。

  • 數值（屬於　webExId） 元素（位於　CreateUser API　bodyContent）必須與電子郵件相同。 若webExId 不同於 電子郵件，我們會視 webExId　為與電子郵件相同（在儲存至 WebDB 時），且將會忽略該數值。

  • 數值（屬於　webExId） 元素（位於 SetUser APIs bodyContent　中）必須為電子郵件地址的使用者身分，您可以使用 <電子郵件> bodyContent　中來變更。

  • SetUser API 將支援變更現有使用者的電子郵件： 如果 SecurityCoNtext 中的操作帳戶是 Control Hub 完整網站管理員，則將會成功。 否則，API 會報告錯誤，並顯示以下新錯誤代碼和訊息：

    • 030120 帳戶必須為完整網站管理員才能變更電子郵件。

  • newWebExId 元素（位於 SetUser API bodyContent 中）將受到忽略。

  • SetUser API 會嘗試變更為已在使用中的電子郵件，API 會顯示以下新錯誤代碼和錯誤訊息：

    • 030118 電子郵件已用於 Control Hub 管理的網站中。

  • DelUser API 會在 Webex 會議端停用使用者，並從 Webex 網站移除對應的會議授權。 可使用 API 重新啟用此已停用使用者： SetUser（<active>已啟用</active>）只要使用者之前已驗證即可。

  • CreateUser 和 SetUser API 會顯示新錯誤代碼和錯誤訊息，如下所示：

    • 030117，此使用者存在於您組織之外，因此需要受到宣告，以透過宣告使用者過程來移入您的組織。 有關將使用者宣告進入您組織的步驟，請參閱向您的組織宣告使用者（轉換使用者）。 在宣告使用者之前，您需要先驗證使用者所屬的網域。

    • 030119 CI 存取權杖必須包含範圍 webexsquare： 管理員（佈建使用者時）。

僅支援有限時段的正向相容性。 在移除此相容性之前，我們將提供提前通知。

綱要變更

這些 API 上並無綱要變更： CreateUser 、 SetUser 、 DelUser 和 GetUser 。

API 請求和回應範例

CreateUser API 請求和回應

API request:
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:serv="http://www.webex.com/schemas/2002/06/service"
   xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service http://www.webex.com/schemas/2002/06/service/service.xsd">
<header>
    <securityContext>
      <siteName>{siteName}</siteName>
      <webExID>{site Admin account}</webExID>
      <email>{site Admin account}</email>
      <sessionTicket>xxxx</sessionTicket> or <password> or <webExAccessToken>
                  or <accessToken>, when using CI "accessToken", it must include scope webexsquare:admin when provisioning user
    </securityContext>
</header>



<body>
<bodyContent xsi:type="java:com.webex.service.binding.user.CreateUser">
    <webExId>Jack@qa.webex.com</webExId> --- it should is user identity of email address
    <email>Jack@qa.webex.com</email>
    <firstName>Jack</firstName>
    <lastName>Smith</lastName>
    <password>....</password>
    <privilege>
        <host>true</host>
    </privilege>
    <active>ACTIVATED</active> ---this parameter can't active the user directly until the user self activate itself via activation email.
</bodyContent>
</body>
</serv:message>

API response example:
<?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:createUserResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <use:userId>23778617</use:userId>
        </serv:bodyContent>
    </serv:body>
</serv:message>

影響 API：

  • CreateUser

  • SetUser

  • DelUser

在 Webex 傳統版網站轉換為 Control Hub 管理的網站後，XML API 會支援現有使用者的驗證正向相容性

受影響的 API

在 Webex 傳統版網站轉換為 Control Hub 管理的網站後，<webExID> 元素數值（位於 <securityContext> 中）便需要與電子郵件相同，詳細資料如下：

  • 針對在 Webex 傳統版網站中建立的現有使用者，我們支援兩個舊版webExID （例如： Jack）和新 webExID（內容與電子郵件相同，範例： Jack@xx.com）用來登入，此驗證反向相容於所有 XML API。

  • 若為在 Control Hub 管理的網站中建立的新使用者，webExID 元素的數值必須與登入電子郵件相同。


<header>
    <securityContext>
      <siteName>{siteName}</siteName>
      <webExID>{userName}</webExID> --- existing users were created in webEx classic site, it can be: jack or jack@xx.com; new user must use jack@xx.com
      <sessionTicket>xxxx</sessionTicket> or <password> or <webExAccessToken> or <accessToken>
    </securityContext>
</header>

影響 API：

所有 XML API。

在 Webex 傳統版網站轉換為 Control Hub 管理的網站後，<webExID> 元素數值 <bodyContent> 便需要與電子郵件相同，詳細資料如下：

  • 針對在 Webex 傳統版網站中建立的現有使用者，我們支援兩個舊版webExID例如： Jack）和新 webExId （內容與電子郵件相同，範例： Jack@xx.com）位於 bodyContent 中。

  • 若為在 Control Hub 管理的網站中建立的新使用者，webExId 元素的數值必須與位於以下位置的電子郵件相同： bodyContent。

<bodyContent xsi:type="java:com.webex.service.binding.user.GetUser or SetUser or DelUser">
    <webExId>xxxx</webExId> --- existing users were created in webEx classic site, it can be: jack or jack@xx.com; new user must use jack@xx.com
</bodyContent>

影響 API：GetUser 、 SetUser 和 DelUser 。

綱要變更

無任何 API 上的綱要變更。

API 請求和回應範例

GetUser API 請求和回應

API request:
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:serv="http://www.webex.com/schemas/2002/06/service"
   xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service http://www.webex.com/schemas/2002/06/service/service.xsd">
<header>
    <securityContext>
      <siteName>{siteName}</siteName>
      <webExID>{userName}</webExID> --- existing users were created in webEx classic site, it can be: jack or jack@xx.com; new user must use jack@xx.com
      <sessionTicket>xxxx</sessionTicket> or <password> or <webExAccessToken> or <accessToken>
    </securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.user.GetUser or SetUser or DelUser">
    <webExId>xxxx</webExId> --- existing users were created in webEx classic site, it can be: jack or jack@xx.com; new user must use jack@xx.com
</bodyContent>
</body>
</serv:message>

API response example:
...same as before

增強錄製檢視歷史記錄報告 API，以支援 Webex Meetings、Webex Events（新版）和 Webex Events（傳統版）

受影響的 API

現行 API： lstrecordaccessHistory 和 lstrecordaccessDetailHistory 僅支援 Webex Trainings 錄製檢視存取之歷史記錄報告。 新的增強功能可支援 Webex Meetings、Webex Events（新版）和　Webex Events（傳統）錄製檢視存取之歷史記錄報告。

綱要變更

我們支援新增以下新綱要至 API 請求內文的 API lstrecordaccessHistory：

<serviceTypes>
       <serviceType>MeetingCenter</serviceType>
       <serviceType>TrainingCenter</serviceType>
       <serviceType>EventCenter</serviceType>
</serviceTypes>

詳細資料

API： lstrecordaccessHistory 可傳回 Webex Meetings、Webex Events（新版）、Webex Events（傳統版）和 Webex Trainings 的錄製檢視存取之歷史紀錄。

  • 若 API 中未指定 serviceType，則其 API lstrecordaccessHistory 僅會傳回 Webex Trainings 錄製檢視存取之歷史記錄。

  • 當 serviceType 為 MeetingCenter 時，其 API lstrecordaccessHistory 會傳回 Webex Meetings 和 Webex Events（新版）錄製檢視存取之歷史紀錄。

  • 當 serviceType 為 EventCenter 時，其 API lstrecordaccessHistory 會傳回 Webex Events（傳統版）錄製檢視存取之歷史記錄。

API： lstrecordaccessDetailHistory 可透過以下方式傳回詳細資訊： recordID Webex Meetings、Webex Events（新版）、Webex Events（傳統版）和 Webex Trainings。

API 請求和回應範例

lstrecordaccessHistory API 的請求和回應

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
            <webExID>{userName}</webExID>
            <password>{password}</password>          
            <siteName>{siteName}</siteName>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.history.LstrecordaccessHistory">
            <viewTimeScope>
                <viewTimeStart>9/20/2021 00:00:00</viewTimeStart>
                <viewTimeEnd>9/28/2021 23:59:59</viewTimeEnd>
            </viewTimeScope>
            <listControl>
                <startFrom>1</startFrom>
                <maximumNum>100</maximumNum>
            </listControl>
            <order>
                <orderBy>RECORDID</orderBy>
                <orderAD>ASC</orderAD>
            </order>
            <serviceTypes>
                <serviceType>MeetingCenter</serviceType>
                <serviceType>TrainingCenter</serviceType>
                <serviceType>EventCenter</serviceType>
            </serviceTypes>
        </bodyContent>
    </body>
</serv:message>

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:history="http://www.webex.com/schemas/2002/06/service/history">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="history:lstrecordaccessHistoryResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <history:recordAccessHistory>
                <history:recordID>1XXXXXXX7</history:recordID>
                <history:recordName>LstrecordaccessHistory test TC-20210924 1324-1</history:recordName>
                <history:creationTime>09/24/2021 13:28:13</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>2</history:downloaded>
                <history:viewed>1</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:recordAccessHistory>
                <history:recordID>1XXXXXXX7</history:recordID>
                <history:recordName>TestErollment_001-20210610 1905-1</history:recordName>
                <history:creationTime>06/10/2021 19:10:15</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>0</history:downloaded>
                <history:viewed>3</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:recordAccessHistory>
                <history:recordID>1XXXXXXX7</history:recordID>
                <history:recordName>Test instant playback 2-20210705 0709-1</history:recordName>
                <history:creationTime>07/05/2021 07:15:06</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>0</history:downloaded>
                <history:viewed>1</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:recordAccessHistory>
                <history:recordID>1XXXXXXX7</history:recordID>
                <history:recordName>EC2.0_232423-20210922 0447-1</history:recordName>
                <history:creationTime>09/22/2021 04:53:05</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>0</history:downloaded>
                <history:viewed>1</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:recordAccessHistory>
                <history:recordID>1XXXXXXX7</history:recordID>
                <history:recordName>LstrecordaccessHistory test EC2.0-20210924 1315-1</history:recordName>
                <history:creationTime>09/24/2021 13:19:00</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>1</history:downloaded>
                <history:viewed>1</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:recordAccessHistory>
                <history:recordID>1XXXXXXX7</history:recordID>
                <history:recordName>LstrecordaccessHistory test MC-20210924 1319-1</history:recordName>
                <history:creationTime>09/24/2021 13:25:12</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>1</history:downloaded>
                <history:viewed>1</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:recordAccessHistory>
                <history:recordID>1XXXXXXX7</history:recordID>
                <history:recordName>LstrecordaccessHistory test EC classic-20210924 1331-1</history:recordName>
                <history:creationTime>09/24/2021 13:37:28</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>1</history:downloaded>
                <history:viewed>1</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:matchingRecords>
                <serv:total>8</serv:total>
                <serv:returned>7</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </history:matchingRecords>
        </serv:bodyContent>
    </serv:body>
</serv:message>

lstrecordaccessDetailHistory API 的請求和回應

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>{userName}</webExID>
            <password>{password}</password>          
            <siteName>{siteName}</siteName>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type=
            "java:com.webex.service.binding.history.LstrecordaccessDetailHistory">
            <recondID>1XXXXXX7</recondID>
            <timeZoneID>20</timeZoneID>
        </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:lstrecordaccessDetailHistoryResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <history:recordDetail>
                <history:viewID>1XXXXXX7</history:viewID>
                <history:participantName>Axxxg</history:participantName>
                <history:participantEmail>Axxxg@qa.webex.com</history:participantEmail>
                <history:accessTime>09/24/2021 13:27:26</history:accessTime>
                <history:registered>false</history:registered>
                <history:downloaded>false</history:downloaded>
                <history:viewed>true</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordDetail>
            <history:recordDetail>
                <history:viewID>1XXXXXX7</history:viewID>
                <history:participantName>Axxxg</history:participantName>
                <history:participantEmail>Axxxg@qa.webex.com</history:participantEmail>
                <history:accessTime>09/24/2021 13:27:39</history:accessTime>
                <history:registered>false</history:registered>
                <history:downloaded>true</history:downloaded>
                <history:viewed>false</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordDetail>
            <history:matchingRecords>
                <serv:total>2</serv:total>
                <serv:returned>2</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </history:matchingRecords>
        </serv:bodyContent>
    </serv:body>
</serv:message>

影響 API：

  • lstrecordaccessHistory

  • lstrecordaccessDetailHistory

修正 XMLAPI 和 Webex 頁面之間 Webex Events（傳統版）說明長度的上限差距。

受影響的 API

XML API： CreateEvent 和 SetEvent 的元素 描述說明 將允許輸入最多10000 個字元，如果輸入過多字元，將會導致新的錯誤代碼和訊息產生：

060068 輸入說明無效。 此描述不得超過 10000 個字元。

綱要變更

無綱要變更。

API 請求和回應範例

CreateEvent API 請求和回應

#API request example:
...
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.event.CreateEvent"
            xmlns:att="http://www.webex.com/schemas/2002/06/service/event" xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service/event http://www.webex.com/schemas/2002/06/service/event/event.xsd">
            <accessControl>
                <sessionPassword>111111</sessionPassword>
                <listing>PRIVATE</listing>
            </accessControl>
            <metaData>
                <sessionName>EC test</sessionName>
                <description>.......Suppose you filling in 10000 characters in description.......</description>
            </metaData>
...


------------------------------------
#API response example when the description exceeds 10000 characters:

<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>FAILURE</serv:result>
            <serv:reason>Illegal input description. The description can't exceed 10000 characters</serv:reason>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
            <serv:exceptionID>060068</serv:exceptionID>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent/>
    </serv:body>
</serv:message>

影響 API：

  • CreateEvent

  • SetEvent

XML API： GetUser 會傳回 freeAccount 的新元素

受影響的 API

GetUser 傳回新元素來識別 freeAccount 是否為 FreeAccount 使用者帳戶。

綱要變更

GetUser 回應範例


GetUser response:
                <use:initials>AW</use:initials>
                <use:isUploaded>false</use:isUploaded>
            </use:avatar>
            <use:largeEventCapacity>3</use:largeEventCapacity>
            <use:freeAccount>false</use:freeAccount>
        </serv:bodyContent>
    </serv:body>
</serv:message>

影響 API：

GetUser

API 41.10.0 更新

XML API 41.10.0 綱要不存在任何變更。

API 41.9.0 更新

XML API 41.9.0 更新

按一下這裡以下載 XML API 41.9.0 綱要。

針對所有 T31 網站停用 XML API 10.0.0

Webex 計劃終止支援所有 T31 網站的 XML API 10.0.0 版。

我們會在 41.9.0 的產品更新版中停用所有 XML API 10.0.0 版本號。

API 41.8.0 更新

XML API 41.8.0 更新

按一下這裡以下載 XML API 41.8.0 綱要。

針對所有 T31 網站停用 XML API 10.0.0

Webex 計劃終止支援所有 T31 網站的 XML API 10.0.0 版。

Webex 發現一些客戶用戶端以錯誤的方式存取 XML API 的 URL，如下所示： https://{siteName}.webex.com/WBXService/xml10.0.0/XMLService，存取 XML API URL 的正確方式如下所示： https://{siteName}.webex.com/WBXService/XMLService。

請使用正確的方式切換您的程式碼存取 XML API，以避免在終止支援 XML API 10.0.0 版之前受到影響。

API 41.7.0 更新

XML API 41.7.0 更新

按一下這裡以下載 XML API 41.7.0 綱要。

行動裝置刪除和編輯錄製檔功能應該由網站管理選項控制： 允許主持人重新指定、編輯、停用和刪除錄製檔

受影響的 API 和綱要變更

GetSite：將在工具下傳回新元素命名 enableNBRMCModify 和 separateNoRecordingEdit 。

回應範例

GetSiteResponse ：

GetSite

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

API 41.6.3 更新

XML API 41.6.3 更新

按一下這裡以下載 XML API 41.6.3 綱要。

GetSite 回應新元素 supportLargeEvent

受影響的 API 和綱要變更

GetSite： 傳回新元素命名 supportLargeEvent 下方 siteCommonOptions 以告知呼叫者網站是否支援大型活動（Webex 活動（新版））。

綱要變更

回應範例

GetSiteResponse ：

GetSite

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

API 41.6.0 更新

XML API 41.6.0 更新

按一下這裡以下載 XML API 41.6.0 綱要。

XMLAPI 支援 Webex Events 2.0 佈建

受影響的 API

GetUser：傳回新元素命名 largeEventCapacity 顯示此使用者帳戶下新 Event 2.0 (EC 2.0) 的容量。 比方說，如果使用者帳戶具有 CI_EC3K 授權，則 largeEventCapacity 的值為 3000。

綱要變更

回應範例

GetUserResponse：

XMLAPI LstRecording 的 CreateTime 會套用錄製開始時間

受影響的 API

LstRecording： LstRecording 回應中傳回 CreateTime 作為使用者實際按下錄製按鈕的時間。

詳細資料

過去，XML API 使用資料庫中建立錄製檔時的時間戳記作為 LstRecording 回應中的建立時間。 現在是使用者實際開始建立錄製檔的時間。 此變更會套用至所有服務錄製檔。 沒有綱要變更。

API 41.5.0 更新

XML API 41.5.0 更新

按一下這裡以下載 XML API 41.5.0 綱要。

XMLAPI 能夠以主持人身分從 PSTN 開始 Webex 排定的會議

受影響的 API

  • CreateUser：在以下情況下會產生 hostPIN ：當使用者角色是主持人、完全管理員、唯讀管理員或使用者管理網站管理員時，而無論是否啟用了使用者 PMR。

  • SetUser：在以下情況下會設定 hostPIN 使用 phones.hostPIN 當 personalMeetingRoom.hostPIN 不在 XML 請求中時（前提條件： 功能切換 AllowStartScheduledMtgFromPhone已啟用）。

  • GetUser：會傳回 phones.hostPIN ，而無論是否啟用了使用者 PMR。（前提條件： 功能切換 AllowStartScheduledMtgFromPhone 已啟用）。

綱要變更

GetUserResponse ：

SetUser ：

回應範例

GetUserResponse ：

SetUser ：

XMLAPI GetSite 為行動用戶端回應兩個新元素

受影響的 API

  • GetSite： GetSite 現在將回應兩個新元素以支援行動用戶端具有顯示或不顯示錄製檔標籤的邏輯。

    • enableRecordingAccess ：true 或 false，Webex 超級管理員可以啟用或停用錄製檔存取，方式是切換 ( EnableRecordingAccesses ）。

    • storageEmptyStatus ：true 或 false，如果兩個網站都不支援 NBR 功能並且已將 NBR 儲存空間分配為零，則狀態回應為 true，否則為 false。

綱要變更

下列項目的範例請求： GetSite

下列項目的範例回應： Getsite

具有非 ASCII 字元的電子郵件主旨將使用 RFC2047 進行編碼。 如果是純 ASCII 字元的電子郵件主旨，則沒有編碼

受影響的 API

對任何 API 請求、回應承載都沒有任何影響，但它會變更電子郵件主旨的編碼行為。 如果電子郵件主旨具有非 ASCII 字元，將使用 RFC2047 進行編碼。 如果是純 ASCII 字元的電子郵件主旨，則沒有編碼。

綱要變更

沒有綱要變更。

API 41.4.0 更新

XML API 41.4.0 更新

按一下這裡以下載 XML API 41.4.0 綱要。

建立活動排定的 Webex Events，可以利用網站層級的進入與離開音效預設值

XMLAPI 能夠配合目前用於控制進入與離開音效的新邏輯。 Webex Events 的所有音效都由網站管理中的不同設定控制。 位於 GetSite 中，XMLAPI 會傳回額外的欄位 entryExitToneEC 以指示值。 原本在網站管理員設定音效的預設設定時，建立活動不會套用 XMLAPI 預設值而利用此設定。

受影響的 API

XML API： GetSite 會傳回一個新元素 entryExitToneEC 以指示值。

XML API： CreateEvent、SetEvent、GetEvent 後端商業邏輯會讀取下列元素的值： entryExitToneEC 。

綱要變更

XML API： GetSite 回應範例：

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

影響 API：

  • GetSite

  • CreateEvent

  • SetEvent

  • GetEvent

XMLAPI 僅返回大型活動 (Webex Event 2.0) 詳細資訊

  1. 如果 Webex 會議是大型活動或網路廣播，則 GetSessionInfo 會傳回一些詳細資訊，包括會議密碼、會議數字密碼、答疑者密碼和答疑者數字密碼（不會變更任何綱要）。

  2. XMLAPI 不支援建立和編輯任何大型活動或網路廣播功能，因此 CreateMeeting 和 SetMeeting 對於大型活動或網路廣播的情況，會傳回新的異常狀況（110064：不支援活動與網路廣播階段作業類型。）

影響 API

API 名稱

說明

附註

GetSessionInfo

如果 Webex 會議是大型活動或網路廣播，則 GetSessionInfo 會傳回會議密碼、會議數字密碼、答疑者密碼和答疑者數字密碼。

不會變更任何架構。

CreateMeeting

SetMeeting

如果使用者嘗試使用 CreateMeeting API 來建立類型為大型活動階段作業的 Webex 會議，或調用 SetMeeting 來編輯實際上是大型活動或網路廣播的 Webex 會議，則會傳回新的異常狀況 110064。 不支援活動與網路廣播階段作業類型。

行為已變更。

API 41.3.0 更新

XML API 41.3.0 更新

按一下這裡以下載 XML API 41.3.0 綱要。

XML API 新變更支援 Webex Events 2.0 功能

受影響的 API

這兩個 API： GetSessionInfo 和 GetMeeting 也會傳回元素 enableEvent 和 enableWebniar 。

元素名稱

說明

enableEvent

在 Webex 會議中支援 EC 2.0

enableWebniar

在 Webex 會議中支援網路研討會

XMLAPI 支援會為 EC 2.0 返回上述兩個元素。 目前的 XML API 發行版本不支援排定和設定 EC2.0 會議。

綱要變更

GetSessionInfo 會傳回元素 enableEvent 和 enableWebniar （針對 EC 2.0）。

GetMeeting 會傳回元素 enableEvent 和 enableWebniar （針對 EC 2.0）。

回應範例：

GetSessionInfo 回應：

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

GetMeeting 回應：

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

XMLAPI 新變更支援會議前大廳功能

受影響的 API

XML API： GetSite 、 LstSummarySession 、 GetSessionInfo 和 GetMeeting 將回應新元素 enablePreMeetingLobby （針對會議前大廳）。

綱要變更

XML API： GetSite 會傳回元素 enablePreMeetingLobby （針對會議前大廳）。

XML API： LstSummarySession 會傳回元素 enablePreMeetingLobby （針對會議前大廳）。

XML API： GetSessionInfo 會傳回元素 enablePreMeetingLobby （針對會議前大廳）。

XML API： GetMeeting 會傳回元素 enablePreMeetingLobby （針對會議前大廳）。

回應範例：

GetSite 回應：

<ns1:siteCommonOptions>
                    <ns1:SupportCustomDialRestriction>false</ns1:SupportCustomDialRestriction>
                    <ns1:SupportTelePresence>false</ns1:SupportTelePresence>
                    <ns1:SupportTelePresencePlus>false</ns1:SupportTelePresencePlus>
                    <ns1:EnableCloudTelepresence>true</ns1:EnableCloudTelepresence>
                    <ns1:EnableCMRForAllUsers>true</ns1:EnableCMRForAllUsers>
                    <ns1:enablePersonalMeetingRoom>true</ns1:enablePersonalMeetingRoom>
                    <ns1:SupportAlternateHost>true</ns1:SupportAlternateHost>
                    <ns1:SupportXMLAPIReturnScheduledPMR>false</ns1:SupportXMLAPIReturnScheduledPMR>
                    <ns1:SupportAnyoneHostMeetings>true</ns1:SupportAnyoneHostMeetings>
                    <ns1:enablePreMeetingLobby>true</ns1:enablePreMeetingLobby>
                </ns1:siteCommonOptions>

LstSummarySession 回應：

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

GetSessionInfo 回應：

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

GetMeeting 回應：

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

XML API GetSite 回應資訊行為變更披露

受影響的 API

XML API： GetSite 僅為管理員帳戶回應以下元素，其中包括角色： SiteAdmin 、 RO_SiteAdmin 和 UserAdmin 。

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

行為已變更

僅允許管理員角色具有下列項目的回應授權資料： GetSite。 主持人或出席者不會在 GetSite 回應中的建立時間。

以下是 API： GetSite's 回應範例（針對 siteadmin 或唯讀 siteadmin 或使用者管理管理員）：

API 41.2.0 更新

XML API 41.2.0 更新

按一下這裡以下載 XML API 41.2.0 綱要。

如果網站支援 Webex 電話語音，XML API 應該支援「CMR 混合 VOIP」

受影響的 API

  • GetSite 會在回應中傳回新元素 IsWebexTelephony 。

  • CreateUser 和 SetUser 可以更新 cmrHybridVoip 元素，前提是 IsWebexTelephony 為 true（連同其他條件）。 IsTSPUsingTelephonyAPI 不再重要。

綱要變更

XML API： GetSite 回應會傳回其他元素 IsWebexTelephony

GetSite 回應包括以下新元素：

<ns1:telephonyConfig>

<ns1:isWebexTelephony>true</ns1:isWebexTelephony>
<ns1:isTSPUsingTelephonyAPI>false</ns1:isTSPUsingTelephonyAPI>
<ns1:serviceName>Personal Conference No.</ns1:serviceName>
<ns1:participantAccessCodeLabel>Attendee access code</ns1:participantAccessCodeLabel>
<ns1:subscriberAccessCodeLabel>Host access code</ns1:subscriberAccessCodeLabel>
<ns1:attendeeIDLabel>Attendee ID</ns1:attendeeIDLabel>

.....

</ns1:telephonyConfig>

LstSummarySession 支援 EC2.0

XML API 會受影響

LstSummarySession 將傳回兩個新元素來支援 EC 2.0

元素名稱

說明

enableEvent

在 Webex 會議中支援 EC 2.0

enableWebniar

在 Webex 會議中支援網路研討會

綱要變更

XML API： LstSummarySession ： 附加 < enableEvent> 和 < enableWebniar> 元素

XML API 的回應： LstSummarySession

EC 2.0 的回應

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

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

XMLAPI 支援傳回網站使用者 Webex-voice-assistant 選項以進行 MCT 整合

受影響的 API

GetUser 會在回應中傳回新元素 webexAssistantEnabled （true 或 false）。

綱要變更

getUserResponse ：

回應範例

API 41.1.0 更新

XML API 41.1 綱要不存在任何變更。