Дополнительную информацию об XML API 39 и XML API 11 см. в статье Обзор обновлений XML API Cisco Webex Meetings (XML API 39 и более ранние версии).

Дополнительную информацию об API XML 40 см. в статье Обзор обновлений API XML Cisco Webex Meetings (API XML 40 и последующие версии).

Информацию об обновлениях XML API 11 SP9 и более ранних выпусков см. в разделе Cisco DevNet.

Обновления API 41.12.0

Обновления API XML 41.12.0

Чтобы скачать схему API XML 41.12.0, щелкните здесь.

XMLAPI будет блокировать расписание и изменения в Webex Events (классическая версия) в соответствии с элементом настроек EnableClassicEvent неверно

Затронутые API и изменения схемы

Если на странице конфигурации службы администрирования веб-сайта флажок параметра Включить классическую версию event-совещаний не установлен, этот сайт не будет поддерживать совещания Webex Events (классическая версия).

Если флажок параметра Включить классическую версию event-совещаний не установлен, вы можете воспользоваться этими API для работы с Webex Events (классическая версия).

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

API будет отвечать на новые исключения 010106Классическая версия event-совещаний была отключена.

Изменения схемы

В схеме нет изменений.

Пример запроса и ответа API

CreateEvent Запрос и ответ API

Запрос CreateEvent

<bodyContent xsi:type="java:com.webex.service.binding.event.CreateEvent">
  <accessControl>
    <sessionPassword>XXXXXXXX</sessionPassword>
  </accessControl>
   <metaData>
    <sessionName>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 type.

После этого нового усовершенствования API будет отвечать на новый элемент subProdctCodePrefix:PRO1, PRO2 и т. д., которые могут быть настроены в виде префикса meet type.

Изменения схемы в 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

Обновления API XML 41.11.0

Чтобы скачать схему API XML 41.11.0, щелкните здесь.

Поддержка прямой совместимости API XML в API управления пользователями для веб-сайтов под управлением Control Hub

Затронутые API и изменения схемы

Если в настоящее время приложение интеграции использует API управления пользователями Webex XMLAPI: CreateUser, SetUser, DelUser и GetUser Для инициализации или управления пользователями после преобразования классического веб-сайта Webex в веб-сайт под управлением Control Hub эти API продолжат работать для обеспечения прямой совместимости. Ниже приведены некоторые изменения в поведении.

  • При использовании createUser – если состояние пользователя в Control Hub не "активный", пользователь на веб-сайте также не будет активным. Если состояние пользователя в Control Hub активный, пользователь на веб-сайте также будет активным. Источник: Состояние новых и преобразованных пользователей в Control Hub.

  • Элемент пароля API CreateUser и SetUser будет проигнорирован. Мы начнем рассылку электронных сообщений со ссылкой на активацию для новых пользователей. Пользователи могут перейти по ссылке в электронном письме, чтобы активировать новую учетную запись и ввести новый пароль.

  • Активныйэлемент API CreateUser будет проигнорирован. Новый пользователь (не был подтвержден) не сможет быть активирован с помощью этого параметра, используя APISetUser.

  • Значение элемента webExId в bodyContent API CreateUser должно быть таким же, как и адрес электронной почты. Если webExId отличается от адреса электронной почты, при хранении в WebDB webExId будет обрабатываться как адрес электронной почты, и это значение будет проигнорировано.

  • Значение элемента webExId в bodyContent API SetUser должно являться удостоверением пользователя для адреса электронной почты. Вы можете изменить это, используя <адрес электронной почты> в bodyContent.

  • API SetUser поддерживает изменение адреса электронной почты существующего пользователя в следующем случае: если учетная запись операции в SecurityContext является администратором веб-сайта с полными правами в Control Hub. В противном случае API выдаст сообщение об ошибке вместе с новым кодом ошибки:

    • 030120 Для изменения адреса электронной почты учетная запись должна быть администратором веб-сайта с полными правами.

  • Элемент newWebExId в bodyContent API SetUser будет проигнорирован.

  • API SetUser пытается изменить адрес электронной почты на тот, который уже используется. API выдаст сообщение об ошибке вместе с новым кодом ошибки:

    • 030118 Этот адрес электронной почты уже используется на веб-сайтах под управлением Control Hub.

  • API DelUser деактивирует учетную запись пользователя на стороне совещания Webex и удаляет его лицензию на совещания на веб-сайте Webex. Деактивированный пользователь может быть повторно активирован с помощью API. SetUser (<active>АКТИВИРОВАН</active>) до тех пор, пока пользователь не пройдет верификацию.

  • API CreateUser и SetUser выдают сообщение об ошибке вместе с новым кодом ошибки, как показано ниже:

    • 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

API XML поддерживает прямую совместимость аутентификации существующих пользователей классической версии веб-сайта Webex и конвертированного веб-сайта под управлением Control Hub

Затронутые API

После преобразования классического веб-сайта Webex в веб-сайт под управлением Control Hub значение <webExID> элемента в <securityContext> должно совпадать с адресом электронной почты. Подробные сведения приведены ниже.

  • Для существующих пользователей, созданных в классической версии веб-сайта Webex, поддерживаются оба старых webExID (например, Jack) и новый webExID (контент совпадает с адресом электронной почты. Пример: Jack@xx.com) для входа. Обратная совместимость аутентификации существует для всех API XML.

  • Для новых пользователей, созданных на веб-сайтах под управлением 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:

Все API XML

После преобразования классического веб-сайта 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 lstrecordaccessHistory в теле запроса API:

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

Сведения

API: lstrecordaccessHistory может вернуть историю просмотров записей для Webex Meetings, Webex Events (новая версия) и Webex Events (классическая версия).

  • Если в запросе 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

Исправьте несоответствие максимальной допустимой длины описания Webex Events (Classic) между XMLAPI и страницей Webex.

Затронутые 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

API XML: 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

В схеме API XML 41.10.0 нет изменений.

Обновления API 41.9.0

Обновления API XML 41.9.0

Чтобы скачать схему API XML 41.9.0, щелкните здесь.

Вывод из эксплуатации API XML 10.0.0 для всех веб-сайтов T31

Webex планирует завершить поддержку API XML версии 10.0.0 для всех веб-сайтов T31.

В обновлении 41.9.0 из всех продуктов будет исключен код API XML версии 10.0.0.

Обновления API 41.8.0

Обновления API XML 41.8.0

Чтобы скачать схему API XML 41.8.0, щелкните здесь.

Вывод из эксплуатации API XML 10.0.0 для всех веб-сайтов T31

Webex планирует завершить поддержку API XML версии 10.0.0 для всех веб-сайтов T31.

Webex обнаружил, что некоторые клиенты обращаются к URL-адресу API XML некорректным способом: https://{siteName}.webex.com/WBXService/xml10.0.0/XMLService. Правильный способ доступа к URL-адресу API XML: https://{siteName}.webex.com/WBXService/XMLService.

Испрвальте путь доступа для кода API XML, чтобы избежать негативных последствий до того, как поддержка API XML версии 10.0.0 будет завершена.

Обновления API 41.7.0

Обновления API XML 41.7.0

Чтобы скачать схему API XML 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

Обновления API XML 41.6.3

Чтобы скачать схему API XML 41.6.3, щелкните здесь.

GetSite Ответ с новым элементом supportLargeEvent

Затронутые API и изменения схемы

GetSite: возвращает новый элемент с именем supportLargeEvent в разделе siteCommonOptions для информирования вызывающего абонента о том, поддерживает ли веб-сайт крупные event-совещания (Webex Events (новая версия)) или нет.

Изменение схемы

Пример ответа

GetSiteResponse:

GetSite

<?xml version="1.0" encoding="ISO-8859-1"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:ns1="http://www.webex.com/schemas/2002/06/service/site" xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>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

Обновления API XML 41.6.0

Чтобы скачать схему API XML 41.6.0, щелкните здесь.

API XML поддерживает Webex Events 2.0 в процессе предоставления

Затронутые API

GetUser: возвращает новое имя элемента largeEventCapacity в котором показана емкость новой версии Event 2.0 (EC 2.0) в рамках этого учетная запись пользователя. Например, если для учетной записи пользователя предусмотрена лицензия CI_EC3K, значение largeEventCapacity – 3000.

Изменения схемы

Пример ответа

GetUserResponse:

Значение CreateTime LstRecording API XML применяется к началу записи

Затронутые API

LstRecording: LstRecording ответ CreateTime время, когда пользователь фактически нажимает кнопку записи.

Сведения

Ранее API XML использовал метку времени создания записи в базе данных в качестве времени создания в LstRecording. Теперь это время, когда пользователь фактически начинает запись. Это изменение применяется ко всем записям службы. Изменения схемы отсутствуют.

Обновления API 41.5.0

Обновления API XML 41.5.0

Чтобы скачать схему API XML 41.5.0, щелкните здесь.

С помощью API XML можно начинать запланированные совещания Webex из сети PSTN в качестве организатора

Затронутые 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, если оба веб-сайта не поддерживают функцию сетевой записи и выделили нулевое пространство хранилища сетевых записей, то ответ о состоянии будет иметь значение true, а остальные – false.

Изменения схемы

Пример запроса для GetSite

Пример ответа для Getsite

Тема электронного сообщения, которая содержит символы, не относящиеся к коду ASCII, будет зашифрована по стандарту RFC 2047. Если же тема электронного сообщения содержит только символы ASCII, кодирование не требуется.

Затронутые API

Это не влияет на полезную нагрузку запроса или ответа API, однако меняет поведение кодирования темы электронного сообщения. Если тема сообщения электронной почты содержит символы, не относящиеся к коду ASCII, она будет зашифрована по стандарту RFC 2047. Если же тема сообщения электронной почты содержит только символы ASCII, кодирование не требуется.

Изменения схемы

Изменения схемы отсутствуют.

Обновления API 41.4.0

Обновления API XML 41.4.0

Чтобы скачать схему API XML 41.4.0, щелкните здесь.

При создании запланированных event-совещаний Webex Events может использоваться по умолчанию на уровне веб-сайта при тоновом сигнале входа и выхода

XMLAPI соответствует существующей новой логике для управления тоновым сигналом входа и выхода. Управление всеми тоновыми сигналами для Webex Events осуществлялось различными настройками в службе администрирования веб-сайта. В GetSite API XML возвращает дополнительное поле entryExitToneEC для указания значения. Первоначально, когда администратор сайта устанавливал тональный сигнал по умолчанию, при создании event-совещания этот параметр не использовался с помощью XMLAPI по умолчанию.

Затронутые API

XML API: GetSite возвращает один новый элемент entryExitToneEC для указания значения.

XML API: Серверная бизнес-логика CreateEvent, SetEvent, GetEvent считывает значение entryExitToneEC.

Изменения схемы

API XML: Пример ответа 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 просто возвращает подробную информацию о крупном event-совещании (Webex Event 2.0)

  1. Если совещанием Webex является крупное event-совещание или веб-трансляция, GetSessionInfo возвращает некоторую подробную информацию, в том числе пароль совещания, числовой пароль совещания, пароль и числовой пароль для членов команды-организатора (схема не будет изменена).

  2. API XML не поддерживает функцию создания и редактирования крупных event-совещаний или веб-трансляций, поэтому CreateMeeting и SetMeeting возвращают новое исключение – 110064 The event and webcast session type aren’t supported (Тип сеанса event-совещания и веб-трансляции не поддерживаются), если это крупное event-совещание или веб-трансляция.

Затронутые API

Имя API

Описание

Замечание

GetSessionInfo

Если совещанием Webex является крупное event-совещание или веб-трансляция, GetSessionInfo возвращает пароль совещания, числовой пароль совещания, пароль и числовой пароль членов команды-организатора.

Схема не будет изменена.

CreateMeeting

SetMeeting

Если пользователь пытается использовать API CreateMeeting для создания совещания Webex с типом сеанса крупного event-совещания или отправляет запрос SetMeeting для редактирования совещания Webex, которое фактически является крупным event-совещанием или веб-трансляцией, возвращается новое исключение – 110064. Тип сеанса Event-совещания и веб-трансляции не поддерживаются.

Поведение изменено.

Обновления API 41.3.0

Обновления API XML 41.3.0

Чтобы скачать схему API XML 41.3.0, щелкните здесь.

Новые изменения в API XML поддерживают функцию Webex Events 2.0.

Затронутые API

Оба API: GetSessionInfo и GetMeeting также возвращают элементы enableEvent и enableWebniar .

Название элемента

Описание

enableEvent

Поддержка EC 2.0 на совещании Webex

enableWebniar

Поддержка вебинара на совещании Webex

Поддержка XMLAPI возвращает более двух элементов для EC 2.0. Текущий выпуск API XML не поддерживает планирование и устанавку совещания 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>

Обнаружение изменений в поведении информации в ответе API XML 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

Обновления API XML 41.2.0

Чтобы скачать схему API XML 41.2.0, щелкните здесь.

Если веб-сайт поддерживает телефонию Webex, для API XML требуется поддержка параметра "Передача голоса по IP для CMR гибридного типа"

Затронутые API

  • GetSite возвращает новый элемент IsWebexTelephony в ответе.

  • CreateUser и SetUser может обновить элемент cmrHybridVoip, если условие имеет значение IsWebexTelephony true, как и другие условия. IsTSPUsingTelephonyAPI больше не является последовательным параметром.

Изменения схемы

API XML: 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 поддерживает EC 2.0

Будут также затронуты API XML

LstSummarySession будет возвращать два новых элемента для поддержки EC 2.0

Название элемента

Описание

enableEvent

Поддержка EC 2.0 на совещании Webex

enableWebniar

Поддержка вебинара на совещании Webex

Изменения схемы

API XML: LstSummarySession: добавляет элементы < enableEvent> и < enableWebniar>

Ответ API XML: 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>

API XML поддерживает возврат параметра пользователя веб-сайта Webex-voice-assistant для интеграции MCT

Затронутые API

GetUser возвращает новый элемент webexAssistantEnabled(true или false) в ответе.

Изменения схемы

getUserResponse:

Пример ответа

Обновления API 41.1.0

В схеме API XML 41.1 нет изменений.