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 は、チェックが入っていないサイト設定アイテム EnableClassicEvent に従って、Webex Events (クラシック) のスケジュールと編集をブロックします

影響を受ける API とスキーマの変更

サイトの管理の設定ページで、[クラシック イベントを有効にする] チェックボックスにチェックが入っていない場合、このサイトは Webex Events (クラシック) ミーティングをサポートしなくなります。

[クラシック イベントを有効にする] チェックボックスにチェックが入っていない場合、次の API を呼び出して、Webex Events (クラシック) ミーティングを操作します:

CreateEvent を設定し、 SetEvent を設定し、 GetEvent を設定し、 GetSessionInfo を設定し、 LstsummaryEvent を設定し、 LstrecordedEvent を設定し、 LstsummaryProgram を設定し、 UploadEventImage

API は新しい例外 010106クラシック イベントが無効に応答します。

スキーマの変更

スキーマは変更されません。

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 事前定義済みミーティング タイプ プレフィックス

この新たな機能強化後 API は、 subProdctCodePrefix の新しい要素 (PRO1、PRO2 などカスタマイズ可能なミーティング タイプ プレフィックス) に応答するようになります。

API のスキーマ変更: LstMeetingType

次の新しい要素に応答するようになります: subProdctCodePrefix

API リクエストと応答の例

LstMeetingType API のリクエストと応答

次の ＡＰＩ のリクエスト: LstMeetingType

<bodyContent xsi:type="java:com.webex.service.binding.meetingtype.LstMeetingType">
    <meetingTypeID>13810</meetingTypeID>
</bodyContent>
</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 を使用してこのパラメーターから有効化することはできません。

  • CreateUser API の bodyContent 内の webExId 要素の値は、メールと同じである必要があります。webExId がメール と異なる場合、webExId を WebDB に保存する際にメールと同様に処理され、値は無視されます。

  • SetUser API の bodyContent 内の webExId 要素の値は、メール アドレスのユーザー アイデンティティである必要があります。bodyContent の <email> を使って変更できます。

  • SetUser API は、既存ユーザーのメールの変更をサポートします。 SecurityContext のオペレーション アカウントが Control Hub フル サイト管理者であれば、正常に完了します。 そうでない場合、API は以下の新しいエラー コードとメッセージを報告します。

    • 030120 メールを変更するには、アカウントはフル サイト管理者である必要があります。

  • 要素 newWebExId (SetUser API の bodyContent 内) は無視されます。

  • SetUser API は、すでに使用されているメールに変更しようとし、以下の新しいエラー コードとエラー メッセージを表示します。

    • 030118 メールは Control Hub 管理サイトで、すでに使用されています。

  • DelUser API は Webex ミーティング側でユーザーを無効化し、対応するミーティング ライセンスを Webex サイトから削除します。 この無効化されたユーザーは、以前確認済みである限り、API の SetUser (<active>ACTIVATED</active>) を使って再有効化できます。

  • CreateUser および SetUser API は、以下の新しいエラー コードとエラー メッセージを表示します。

    • 030117 このユーザーは組織外に存在しているため、ユーザー要求プロセスで組織内に移動するよう要求する必要があります。 組織内へのユーザー移動を要求するステップについては、「ユーザーを組織に要求する (ユーザーの変換)」を参照してください。 ユーザーを要求する前に、そのユーザーが所属するドメインを確認する必要があります。

    • 030119 ユーザーのプロビジョン時には、CI アクセス トークンに範囲 webexsquare: admin を含める必要があります。

上位互換性は限定された期間のみサポートされています。 この互換性を終了する際には、前もって通知します。

スキーマの変更

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

XML API は Webex クラシック サイトが Control Hub 管理サイトに変換された後、既存ユーザーの認証の上位互換性をサポートします

影響を受ける 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 Event (クラシック)、Webex Trainings の録画ビュー アクセス履歴を返せます。

  • API リクエストで serviceType が指定されていない場合、API lstrecordaccessHistory は Webex Trainings 録画ビュー アクセス履歴のみを返します。

  • serviceType が MeetingCenter の場合、API lstrecordaccessHistory は Webex Meetings と Webex Events (新) 両方の録画ビュー アクセス履歴を返します。

  • serviceType が EventCenter の場合、API lstrecordaccessHistory は Webex Event (クラシック) の録画ビュー アクセス履歴を返します。

API: lstrecordaccessDetailHistory の場合は、Webex Meetings、Webex Events (新)、Webex Events (クラシック)、Webex Trainings の recordID ごとに詳細を返せます。

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 の説明の要素は、最大 10,000 文字の入力を許可します。最大文字数を超えて入力すると、新しいエラー コードとメッセージが表示されます。

060068 説明の入力が不正です。 10,000 文字を超えて入力できません。

スキーマの変更

スキーマは変更されません。

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.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 バージョン 10.0.0 のサポートが終了する前に、適切な方法で XML API にアクセスするコードを切り替えてください。

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: サイトが大規模イベント（Webex Event（New））をサポートするかどうかを supportLargeEvent 発信元に知らせるために、 siteCommonOptions の下に新しい名前の要素を返します。

スキーマの変更

応答例

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 スキーマをダウンロードします。

プロビジョニングでの Webex Events 2.0 に対する XMLAPI サポート

影響を受ける API

GetUser: largeEventCapacity という新しい要素を返します。この要素は、このユーザー アカウントでの新しい Events 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 には主催者として Webex のスケジュール済みミーティングを PSTN から開始する機能があります

影響を受ける API

  • CreateUser：ユーザーロールがホスト、フル、読み取り専用、またはユーザー管理サイトの管理者である場合、ユーザーPMRが有効かどうかにかかわらず、 hostPIN を生成します。

  • SetUser：XML リクエスト hostPIN にない場合に、 phones.hostPIN を使用して設定します（前提条件： personalMeetingRoom.hostPIN フィーチャー トグル が有効になって AllowStartScheduledMtgFromPhoneいる）。

  • GetUser：ユーザー PMR が有効がどうかにかかわらず phones.hostPIN を返します (前提条件： が有効になって AllowStartScheduledMtgFromPhone いる）。

スキーマの変更

GetUserResponse:

SetUser:

応答例

GetUserResponse:

SetUser:

XMLAPI GetSite 応答のモバイル クライアント用の 2 つの新しい要素

影響を受ける API

  • GetSite: GetSite は、2 つの新しい要素を返し、録画タブの表示または非表示のロジックのあるモバイル クライアントをサポートできるようになりました。

    • enableRecordingAccess ：true または false。Webex スーパー管理者はトグルから録画アクセスを有効または無効にできます ( EnableRecordingAccesses ）。

    • storageEmptyStatus ：true または false。両方のサイトが NBR 機能をサポートしておらず、NBR ストレージ スペースを 0 として割り当てている場合は、ステータスの応答は 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 は 1 つの新しい要素 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 Meeting が大規模なイベントまたはウェブキャストの場合、 GetSessionInfo はミーティング パスワード、ミーティング数字パスワード、パネリスト パスワード、パネリスト数字パスワードなどの詳細情報を返します (スキーマに変更はありません)。

  2. XMLAPI は大規模なイベントやウェブキャストの機能の作成と編集には対応していないため、 CreateMeeting および SetMeeting は大規模なイベントまたはウェブキャストの場合、新しい例外 (110064、イベントとウェブキャストのセッション タイプはサポートされていません) を返します。

影響を与える API

API 名

説明

備考

GetSessionInfo

Webex Meeting が大規模なイベントまたはウェブキャストの場合、 GetSessionInfo はミーティング パスワード、ミーティング数字パスワード、パネリスト パスワード、パネリスト数字パスワードを返します。

スキーマは変更できません。

CreateMeeting

SetMeeting

ユーザーが CreateMeeting API を使って大規模なイベントのセッション タイプを作成または SetMeeting をコールして実際には大規模なイベントやウェブキャストである Webex Meeting を編集しようとした場合、新しい例外 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 の 2 つ以上の要素を返します。 現在の XML API リリースは EC2.0 ミーティングのスケジュールと設定をサポートしていません。

スキーマの変更

GetSessionInfo は EC 2.0 の要素 enableEvent および enableWebniar を返します。

GetMeeting は EC 2.0 の要素 enableEvent および enableWebniar を返します。

応答例：

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 テレフォニーをサポートする場合は、XMLAPI で「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 をサポートするために、新しい 2 つの要素を返します

要素名

説明

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 は MCT 統合のためのサイト ユーザーの Webex-voice-assistant オプションを返します

Affected API

GetUser は新しい要素 webexAssistantEnabled(true または false) を応答で返します。

スキーマの変更

getUserResponse:

応答例

API 41.1.0 更新

XML API 41.1 に対するスキーマ変更はありません。