Znajdź wszystkie ważne informacje potrzebne na temat interfejsu Cisco Webex Meetings API, takie jak zmiany schematu i inne ogłoszenia.
Aby uzyskać więcej informacji na temat XML API 39 i XML API 11, zobacz Cisco Webex Meetings XML API Updates Overview (XML API 39 i wcześniejsze).
Aby uzyskać więcej informacji na temat interfejsu XML API 40, zobacz Omówienie aktualizacji interfejsu API XML Cisco Webex Meetings (XML API 40 i nowsze).
Aby uzyskać aktualizacje interfejsu XML API 11 z dodatkiem SP9 i starszych wersji, przejdź do cisco DevNet.
Aktualizacje interfejsu API 41.12.0
Aktualizacje XML API 41.12.0
XMLAPI zablokuje harmonogram Webex Events (Classic) i edycję zgodnie z elementem konfiguracji witryny EnableClassicEvent
który jest fałszywy
Zmiany interfejsów API i schematu, których to dotyczy
Na stronie konfiguracji administracji witryny, jeśli pole wyboru Włącz klasyczne zdarzenie ma wartość false, ta witryna nie będzie już obsługiwać spotkań Webex Events (klasycznych).
Jeśli pole wyboru Włącz klasyczne ujście ma wartość false, należy wywołać następujące interfejsy API w celu obsługi spotkania Webex Events (classic):
CreateEvent
, SetEvent
, GetEvent
, GetSessionInfo
, LstsummaryEvent
, LstrecordedEvent
, LstsummaryProgram
, UploadEventImage
Interfejs API odpowie na nowy wyjątek 010106Zdarzenie klasyczne zostałowyłączone.
Zmiany schematu
Brak zmian schematu.
Przykład żądania i odpowiedzi interfejsu API
Żądanie i odpowiedź interfejsu API CreateEvent
Prośba o 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>
Odpowiedź 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 Wpływa na interfejsy API:
SetEvent GetEvent
GetSessionInfo
LstsummaryEvent
LstrecordedEvent
LstsummaryProgram
UploadEventImage
XMLAPI LstMeetingType
odpowie na nowy element subProductCodePrefix
Interfejsy API, których dotyczy wpływ
Bieżące API LstMeetingType
element odpowiedzi productionCodePrefix
: PRO, AUO i inne, które są predefiniowanym prefiksem typu spotkania Webex.
Po tym nowym ulepszeniu interfejs API odpowie na nowy element subProdctCodePrefix
:P RO1, PRO2 itp., Które można dostosować do prefiksu typu meet.
Zmiany schematu w interfejsie API: LstMeetingType
Odpowie na nowy element: subProdctCodePrefix
Przykład żądania i odpowiedzi interfejsu API
LstMeetingType
Żądanie i odpowiedź API
Wniosek LstMeetingType
<bodyContent xsi:type="java:com.webex.service.binding.meetingtype.LstMeetingType">
<meetingTypeID>13810</meetingTypeID>
</bodyContent>
</body>
</serv:message>
Odpowiedź 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>
Aktualizacje API 41.11.0
Aktualizacje XML API 41.11.0
Zgodność interfejsu XML API z interfejsem API zarządzania użytkownikami dla witryn zarządzanych przez centrum Control Hub
Zmiany interfejsów API i schematu, których to dotyczy
Jeśli aplikacja integracyjna korzysta obecnie z interfejsów API zarządzania użytkownikami Webex XMLAPI: CreateUser
, SetUser
, DelUser
i GetUser
aby aprowizować użytkowników lub zarządzać nimi, po przekonwertowaniu klasycznej witryny Webex na witrynę zarządzaną usługi Control Hub te interfejsy API będą nadal działać w celu zapewnienia zgodności z przekazywaniem. Istnieją pewne zmiany w zachowaniu, jak wspomniano poniżej:
Podczas korzystania z createUser- jeśli stan użytkownika w Control Hub nie jest "aktywny", status użytkownika w witrynie nie będzie aktywny. Jeśli stan użytkownika w Control Hub jest aktywny , to stan użytkownika wwitrynie jest również aktywny, odniesienie: Stan nowych i przekonwertowanych użytkowników w centrum sterowania.
Element hasła interfejsów API CreateUser i SetUser zostanie zignorowany, zaczniemy wysyłać e-mail aktywacyjny do nowych użytkowników, użytkownicy mogą kliknąć link w wiadomości e-mail do aktywnego nowego konta i wprowadzić nowe hasło.
AktywnyelementInterfejsu API CreateUser zostanie zignorowany, nowy użytkownik (nie zostanie zweryfikowany) nie może zostać aktywowany za pomocą tego parametru za pomocą API SetUser.
Wartość elementu webExId w bodyContent interfejsów API CreateUser musi być taka sama jak w wiadomości e-mail. Jeśli webExId różni się od e-maila,będziemy traktować webExId tak samo jak e-mail podczas przechowywania go w WebDB, a wartość zostanie zignorowana.
Wartość elementu webExId w bodyContent interfejsów API SetUser musi być tożsamością użytkownika adresu e-mail, możesz ją zmienić za pomocą> e-mailw bodyContent.
Interfejs API SetUser będzie obsługiwał zmianę adresu e-mail istniejącego użytkownika: powiedzie się, jeśli konto operacji w SecurityContext to Control Hub pełny administrator witryny. W przeciwnym razie interfejs API zgłasza błąd z nowym kodem błędu i komunikatem poniżej:
030120 Konto musi być pełnym administratorem witryny, aby zmienić adres e-mail.
Element newWebExId w bodyContent interfejsu API SetUser zostanie zignorowany.
Interfejs API SetUser próbuje zmienić na adres e-mail, który jest już używany, interfejs API podnosi poniżej nowy kod błędu i komunikat o błędzie:
030118 Poczta e-mail jest już używana w witrynach zarządzanych przez centrum Control Hub.
Interfejs API DelUser dezaktywuje użytkownika po stronie spotkania Webex, a odpowiednia licencja na spotkanie jest usuwana z witryny Webex. Tego dezaktywowanego użytkownika można ponownie aktywować za pomocą interfejsu API: SetUser (<active>ACTIVATED ), o ile użytkownik został wcześniej</active>zweryfikowany.
Interfejsy API CreateUser i SetUser wyświetlają nowy kod błędu i komunikat o błędzie, jak pokazano poniżej:
030117 ,Ten użytkownik istnieje poza Twoją organizacją, więc musi zostać zgłoszony, aby przejść do Twojej organizacji poprzez proces użytkownika roszczenia. Aby zapoznać się z instrukcjami zgłaszania praw użytkownika do organizacji, zobacz Zgłaszanie praw do użytkowników w organizacji (konwertowanie użytkowników). Musisz zweryfikować domenę, do której należy użytkownik, zanim zgłosisz prawa do użytkownika.
030119 Token dostępu CI musi zawierać zakres webexsquare: admin podczas inicjowania obsługi administracyjnej użytkownika.
Tylko przez ograniczony czas obsługiwana jest zgodność z przyszłością. Powiadomimy z wyprzedzeniem, zanim ta zgodność zostanie usunięta. |
Zmiany schematu
Brak zmian schematu w tych interfejsach API: CreateUser
, SetUser
, DelUser
i GetUser
.
Przykład żądania i odpowiedzi interfejsu API
Żądanie i odpowiedź interfejsu API CreateUser
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>
Wpływ na interfejsy API:
CreateUser
SetUser
DelUser
Interfejs API XML obsługuje zgodność z istniejącym uwierzytelnianiem użytkownika po przekonwertowaniu klasycznej witryny Webex na witrynę zarządzaną przez Control Hub
Interfejsy API, których dotyczy wpływ
Po przekonwertowaniu klasycznej witryny Webex na witrynę zarządzaną Control Hub wartość <webExID> elementu w musi być taka sama jak w wiadomości <securityContext> e-mail, szczegóły poniżej:
Dla istniejących użytkowników utworzonych w klasycznej witrynie Webex obsługujemy zarówno stary webExID (na przykład: Jack) i nowy webExID (treść jest taka sama jak e-mail, przykład: Jack@xx.com) do logowania, ta zgodność uwierzytelniania z poprzednimi wersjami dotyczy wszystkich interfejsów API XML.
W przypadku nowych użytkowników utworzonych w witrynach zarządzanych przez Control Hub wartość elementu webExID musi być taka sama jak w przypadku adresu e-mail do logowania.
<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>
Wpływ na interfejsy API:
Wszystkie interfejsy API XML.
Po przekonwertowaniu klasycznej witryny Webex na witrynę zarządzaną przez Control Hub wartość <webExID> elementubodyContent> musi być taka sama jak w wiadomości e-mail, szczegóły poniżej:
Dla istniejących użytkowników utworzonych w klasycznej witrynie Webex obsługujemy zarówno stary webExId(np.: Jack) i nowy webExId (treść jest taka sama jak e-mail, na przykład: Jack@xx.com) w bodyContent.
W przypadku nowych użytkowników utworzonych w witrynach zarządzanych przez Control Hub wartość elementu webExId musi być taka sama jak w wiadomości e-mail w
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>
Wpływ na interfejsy API:GetUser
, SetUser
i DelUser
.
Zmiany schematu
Brak zmian schematu w żadnych interfejsach API.
Przykład żądania i odpowiedzi interfejsu API
Żądanie i odpowiedź Interfejsu API GetUser
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
Ulepszenie rejestrowania raportu historii widoku API do obsługi w Webex Meetings, Webex Events (Nowy) i Webex Events (Classic)
Interfejsy API, których dotyczy wpływ
Aktualne API: lstrecordaccessHistory
i lstrecordaccessDetailHistory
obsługuje tylko Webex Trainings nagrywanie widoku dostępu do raportu historii. Nowe ulepszenie obsługuje również webex Meetings, Webex Events (nowy) i Webex Events (klasyczny) widok nagrywania raportu historii.
Zmiany schematu
Obsługujemy poniższy nowy schemat do API lstrecordaccessHistory w treści żądania API:
<serviceTypes>
<serviceType>MeetingCenter</serviceType>
<serviceType>TrainingCenter</serviceType>
<serviceType>EventCenter</serviceType>
</serviceTypes>
Szczegóły
Interfejs API: lstrecordaccessHistory
jest w stanie zwrócić widok nagrywania, do którego uzyskano dostęp do historii Webex Meetings, Webex Events (nowy), Webex Events (klasyczny) i Webex Trainings.
Jeśli w żądaniu interfejsu API nie określono typu serviceType, interfejs API
lstrecordaccessHistory
zwraca tylko widok nagrywania Webex Trainings.Gdy serviceType jest MeetingCenter, interfejs API
lstrecordaccessHistory
zwraca zarówno Webex Meetings, jak i Webex Events (nowy) widok nagrywania historii dostępu.Gdy serviceType jest EventCenter, interfejs API
lstrecordaccessHistory
zwraca webex Events (klasyczny) widok nagrywania historii dostępu.
Interfejs API: lstrecordaccessDetailHistory
jest w stanie zwrócić dane przez recordID
Webex Meetings, Webex Events (nowy), Webex Events (klasyczny) i Webex Trainings.
Przykład żądania i odpowiedzi interfejsu API
lstrecordaccessHistory
Żądanie i odpowiedź 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
Żądanie i odpowiedź 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>
Wpływ na interfejsy API:
lstrecordaccessHistory
lstrecordaccessDetailHistory
Napraw lukę maksymalnej dozwolonej długości opisu zdarzeń Webex (classic) między XMLAPI a stroną Webex.
Interfejsy API, których dotyczy wpływ
Interfejs API XML: Element opisu CreateEvent i SetEvent pozwoli na wprowadzenie maksymalnie 10000 znaków, jeśli wprowadzisz ponad rozmiar, spowoduje to nowy kod błędu i komunikat:
060068 Opis nielegalnych danych wejściowych. Ten opis nie może przekraczać 10000 znaków.
Zmiany schematu
Bez zmiany schematu.
Przykład żądania i odpowiedzi interfejsu API
Żądanie i odpowiedź interfejsu API CreateEvent
#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>
Wpływ na interfejsy API:
CreateEvent
SetEvent
Interfejs API XML: GetUser zwraca nowy element freeAccount
Interfejsy API, których dotyczy wpływ
GetUser
zwraca nowy element, który identyfikuje freeAccount
konto użytkownika jest FreeAccount
lub nie.
Zmiany schematu
Przykład odpowiedzi 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>
Wpływ na interfejsy API:
GetUser
Aktualizacje interfejsu API 41.10.0
Nie ma żadnych zmian schematu w schemacie XML API 41.10.0. |
Aktualizacje api 41.9.0
Aktualizacje XML API 41.9.0
Likwidacja interfejsu API XML 10.0.0 dla wszystkich lokacji T31
Webex planuje zakończyć obsługę XML API ver 10.0.0 dla wszystkich witryn T31.
W aktualizacji 41.9.0 likwidujemy kod XML API 10.0.0 ze wszystkich produkcji.
Aktualizacje api 41.8.0
Aktualizacje XML API 41.8.0
Likwidacja interfejsu API XML 10.0.0 dla wszystkich lokacji T31
Webex planuje zakończyć obsługę XML API ver 10.0.0 dla wszystkich witryn T31.
Webex znalazł niektórych klientów uzyskujących dostęp do adresu URL XML API przy użyciu nieprawidłowego sposobu: https://{siteName}.webex.com/WBXService/xml10.0.0/XMLService, właściwy sposób uzyskiwania dostępu do adresu URL interfejsu API XML jako: https://{nazwa_witryny}.webex.com/WBXService/XMLService.
Przełącz interfejs XML API dostępu do kodu we właściwy sposób, aby uniknąć wpływu przed zakończeniem wsparcia technicznego XML w wersji 10.0.0.
Aktualizacje interfejsu API 41.7.0
Aktualizacje XML API 41.7.0
Mobilne usuwanie i edycja nagrań powinna być kontrolowana przez opcję administrowania witryną: Zezwalanie hostom na ponowne przypisywanie, edytowanie, wyłączanie i usuwanie nagrań
Zmiany interfejsów API i schematu, których to dotyczy
GetSite
: zwróci nowe nazewnictwo elementów enableNBRMCModify
i separateNoRecordingEdit
pod narzędziami.
Przykład odpowiedzi
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>
Aktualizacje api 41.6.3
Aktualizacje XML API 41.6.3
GetSite
Odpowiedź nowy element supportLargeEvent
Zmiany interfejsów API i schematu, których to dotyczy
GetSite: zwraca nowe nazewnictwo elementów supportLargeEvent
w obszarze siteCommonOptions
, aby poinformować rozmówcę, czy witryna obsługuje duże zdarzenie (zdarzenie Webex (nowe)), czy nie.
Zmiana schematu
Przykład odpowiedzi
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>
Aktualizacje interfejsu API 41.6.0
Aktualizacje XML API 41.6.0
Obsługa interfejsu XMLAPI Webex Events 2.0 w inicjowaniu obsługi administracyjnej
Interfejsy API, których dotyczy wpływ
GetUser
: zwraca nowe nazewnictwo elementów largeEventCapacity
który pokazuje pojemność nowego zdarzenia 2.0 (EC 2.0) w ramach tego konta użytkownika. Na przykład, jeśli konto użytkownika ma licencję CI_EC3K, wartość largeEventCapacity
wynosi 3000.
Zmiany schematu
Przykład odpowiedzi
GetUserResponse:
XMLAPI LstRecording's CreateTime stosuje czas rozpoczęcia nagrywania
Interfejsy API, których dotyczy wpływ
LstRecording
: LstRecording
odpowiedź CreateTime
jako czas, w którym użytkownik faktycznie naciska przycisk nagrywania.
Szczegóły
W przeszłości interfejs API XML używał sygnatury czasowej, kiedy nagranie zostało utworzone w bazie danych jako czas tworzenia w LstRecording
odpowiedź. Teraz jest to czas, w który użytkownik faktycznie zaczyna nagrywać. Ta zmiana dotyczy wszystkich nagrań serwisowych. Schemat nie został uchytny.
Aktualizacje interfejsu API 41.5.0
Aktualizacje XML API 41.5.0
XMLAPI ma możliwość uruchamiania zaplanowanych spotkań Webex z PSTN jako hosta
Interfejsy API, których dotyczy wpływ
CreateUser
: generujehostPIN
niezależnie od tego, czy PMR użytkownika jest włączony, czy nie, gdy rolą użytkownika jest host lub pełny, tylko do odczytu lub administrator witryny zarządzania użytkownikami.SetUser
: zestawyhostPIN
Za pomocąphones.hostPIN
kiedypersonalMeetingRoom.hostPIN
nie ma w żądanym pliku XML (warunek wstępny: přepínání funkceAllowStartScheduledMtgFromPhone
jest włączona).GetUser
: zwrotyphones.hostPIN
niezależnie od tego, czy PMR użytkownika jest włączony, czy nie. (warunek wstępny: přepínání funkceAllowStartScheduledMtgFromPhone
jest włączona).
Zmiany schematu
GetUserResponse
:
SetUser
:
Przykład odpowiedzi
GetUserResponse
:
SetUser
:
XMLAPI GetSite
odpowiedź na dwa nowe elementy dla klienta mobilnego
Interfejsy API, których dotyczy wpływ
GetSite
:GetSite
odpowie teraz na dwa nowe elementy do obsługi klienta mobilnego ma logikę do wyświetlania lub nie wyświetlania karty nagrywania.enableRecordingAccess
: prawda lub fałsz, superadministratodawcy Webex mogą włączać lub wyłączać dostęp do nagrywania za pomocą przełącznika(EnableRecordingAccesses
).storageEmptyStatus
: true lub false, jeśli obie witryny nie obsługują funkcji NBR i przydzielili przestrzeń dyskową NBR jako zero, odpowiedź stanu jest prawdziwa, w przeciwnym razie jest fałszywa.
Zmiany schematu
Przykładowa prośba o GetSite
Przykładowa odpowiedź dla Getsite
Temat wiadomości e-mail zawierający znaki inne niż ASCII zostanie zakodowany w dokumencie RFC2047. W przypadku czystego tematu wiadomości e-mail ze znakiem ASCII nie ma kodowania
Interfejsy API, których dotyczy wpływNie ma wpływu na żadne żądanie interfejsu API, ładunek odpowiedzi, ale zmienia zachowanie kodowania tematu wiadomości e-mail. Gdy temat wiadomości e-mail zawierający znaki inne niż ASCII zostanie zakodowany za pomocą specyfikacji RFC2047. W przypadku czystego tematu wiadomości e-mail ze znakiem ASCII nie ma kodowania.
Zmiany schematu
Nie ma żadnych zmian schematu.
Aktualizacje API 41.4.0
Aktualizacje XML API 41.4.0
Tworzenie zdarzeń Webex zaplanowanych na wydarzenia może wykorzystywać domyślne ustawienia na poziomie witryny przy wejściu i wyjściu
Interfejs XMLAPI jest zgodny z bieżącą nową logiką sterowania tonem wejścia i wyjścia. Wszystkie dźwięki dla Webex Events były kontrolowane przez inne ustawienie w administracji witryny. W GetSite
, XMLAPI zwraca dodatkowe pole entryExitToneEC
, aby wskazać wartość. Pierwotnie, gdy administrator witryny ustawi domyślny dźwięk, opcja Utwórz zdarzenie nie wykorzysta tego ustawienia, stosując domyślny interfejs XMLAPI.
Interfejsy API, których dotyczy wpływ
Interfejs API XML: GetSite zwraca jeden nowy element entryExitToneEC
, aby wskazać wartość.
Interfejs API XML: Logika biznesowa zaplecza CreateEvent, SetEvent, GetEvent odczytuje wartość entryExitToneEC
.
Zmiany schematu
Interfejs API XML: Przykład odpowiedzi 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>
Wpływ na interfejsy API:
GetSite
CreateEvent
SetEvent
GetEvent
XMLAPI zwraca tylko informacje szczegółowe o dużym zdarzeniu (Webex Event 2.0)
Jeśli Webex Meeting jest dużym wydarzeniem lub webcastem,
GetSessionInfo
zwraca niektóre szczegółowe informacje, w tym hasło spotkania, hasło numeryczne spotkania, hasło panelisty i hasło numeryczne panelisty (schemat nie może zostać zmieniony).XMLAPI nie obsługuje tworzenia i edytowania żadnych dużych wydarzeń ani funkcji webcastu, więc
CreateMeeting
iSetMeeting
zwróć nowy wyjątek (110064, Typ sesji zdarzenia i webcastu nie są obsługiwane.) dla dużych zdarzeń lub spraw dotyczących emisji internetowej.
Interfejsy API wpływu
Nazwa interfejsu API |
Opis |
Uwaga |
---|---|---|
|
Jeśli Webex Meeting jest dużym wydarzeniem lub webcastem, |
Schemat nie może zostać zmieniony. |
|
Jeśli użytkownik próbuje użyć |
Zachowanie należy zmienić. |
Aktualizacje api 41.3.0
Aktualizacje XML API 41.3.0
Nowe zmiany w interfejsie API XML obsługują funkcję Webex Events 2.0
Interfejsy API, których dotyczy wpływ
Oba interfejsy API: GetSessionInfo i GetMeeting zwracają elementy enableEvent
i enableWebniar
także.
Nazwa elementu |
Opis |
---|---|
enableEvent |
Obsługa EC 2.0 na spotkaniu Webex |
enableWebniar |
Obsługuje webinarium na spotkaniu Webex |
Obsługa XMLAPI zwraca wartość powyżej dwóch elementów dla EC 2.0. Bieżąca wersja interfejsu API XML nie obsługuje planowania i ustawiania spotkania EC2.0. |
Zmiany schematu
GetSessionInfo
zwraca elementy enableEvent
i enableWebniar
dla EC 2.0.
GetMeeting
zwraca elementy enableEvent
i enableWebniar
dla EC 2.0.
Próbka odpowiedzi:
GetSessionInfo
odpowiedź:
<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
odpowiedź:
<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>
Nowe zmiany XMLAPI obsługują funkcję lobby przed spotkaniem
Interfejsy API, których dotyczy wpływ
Interfejs API XML: GetSite
, LstSummarySession
, GetSessionInfo
i GetMeeting
odpowie na nowy element enablePreMeetingLobby
dla poczekalni przed spotkaniem.
Zmiany schematu
Interfejs API XML: GetSite
zwraca element enablePreMeetingLobby
dla poczekalni przed spotkaniem.
Interfejs API XML: LstSummarySession
zwraca element enablePreMeetingLobby
dla poczekalni przed spotkaniem.
Interfejs API XML: GetSessionInfo
zwraca element enablePreMeetingLobby
dla poczekalni przed spotkaniem.
Interfejs API XML: GetMeeting
zwraca element enablePreMeetingLobby
dla poczekalni przed spotkaniem.
Próbka odpowiedzi:
GetSite
odpowiedź:
<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
odpowiedź:
<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
odpowiedź:
<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
odpowiedź:
<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>
Interfejs API XML GetSite
odpowiedź Ujawnienie zmiany zachowania informacji
Interfejsy API, których dotyczy wpływ
Interfejs API XML: GetSite
tylko odpowiedź poniżej elementów dla konta administratora, które obejmują role: SiteAdmin
, RO_SiteAdmin
i 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>
Zachowanie zmienione
Zezwalaj tylko na rolę administratora mają dane licencji odpowiedziGetSite
. Gospodarz lub uczestnik nie otrzyma tych danych licencyjnych w GetSite
odpowiedź.
Poniżej znajdują się API: GetSite's
przykład odpowiedzi dla siteadmin
lub tylko gotowe siteadmin
lub administrator zarządzania użytkownikami:
Aktualizacje api 41.2.0
Aktualizacje XML API 41.2.0
XMLAPI powinien obsługiwać "CMR Hybrid VOIP", jeśli witryna obsługuje telefonię Webex
Interfejsy API, których dotyczy wpływ
GetSite
zwraca nowy elementIsWebexTelephony
w odpowiedzi.CreateUser
iSetUser
może aktualizowaćcmrHybridVoip
element ifIsWebexTelephony
jest prawdą wraz z innymi warunkami.IsTSPUsingTelephonyAPI
nie ma już większego sensu.
Zmiany schematu
Interfejs API XML: GetSite
response zwraca dodatkowy element IsWebexTelephony
GetSite
odpowiedź zawiera ten nowy element:
<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
obsługuje EC2.0
Wpływ na interfejsy API XML
LstSummarySession
przywróci nowe dwa elementy wspierające WE 2.0
Nazwa elementu |
Opis |
---|---|
enableEvent |
Obsługa EC 2.0 na spotkaniu Webex |
enableWebniar |
Obsługuje webinarium na spotkaniu Webex |
Zmiany schematu
Interfejs API XML: LstSummarySession
: Dołącz < enableEvent
> i enableWebniar
elementy >
Odpowiedź XML API: LstSummarySession
Odpowiedź dla 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 obsługuje zwracanie użytkownika witryny Webex-voice-assistant
opcja integracji MCT
Interfejs API, którego dotyczy problem
GetUser
zwraca nowy element webexAssistantEnabled
(prawda lub fałsz) w odpowiedzi.
Zmiany schematu
getUserResponse
:
Przykład odpowiedzi
Aktualizacje api 41.1.0
W schemacie XML API 41.1 nie ma żadnych zmian schematu. |