Keresse meg az összes fontos információt, amelyre szüksége van a Cisco Webex Meetings API-val kapcsolatban, például sémaváltozásokat és egyéb közleményeket.
Az XML API 39 és AZ XML API 11-ről további információt a Cisco Webex Meetings XML API-frissítések áttekintésében (XML API 39 és Korábbi)talál.
Az XML API 40-ről további információt a Cisco Webex Meetings XML API-frissítések áttekintésében (XML API 40 és Újabb)talál.
Az XML API 11 SP9 és korábbi frissítéseit a Cisco DevNetwebhelyen kaphatja meg.
API 41.12.0 frissítések
XML API 41.12.0 frissítések
Kattintson ide az XML API 41.12.0 sémaletöltéséhez.
Az XMLAPI blokkolja a Webex Events (Classic) ütemezését és szerkesztését a webhely konfigurációs elemének megfelelően EnableClassicEvent
Ez hamis
Érintett API-k és sémaváltozások
A webhelyfelügyelet konfigurációs lapján, ha a Klasszikus esemény engedélyezése jelölőnégyzet hamis, ez a webhely már nem támogatja a Webex Events (klasszikus) értekezleteket.
Ha a ClassicEvent engedélyezése jelölőnégyzet hamis, hívja fel ezeket az API-kat a Webex Events (klasszikus) értekezlet működtetéséhez:
CreateEvent
, SetEvent
, GetEvent
, GetSessionInfo
, LstsummaryEvent
, LstrecordedEvent
, LstsummaryProgram
, UploadEventImage
Az API új kivételt válaszol meg, 010106A klasszikus esemény le van tiltva.
Sémamódosítások
Nincs sémamódosítás.
API-kérelem és válasz példa
CreateEvent API-kérés és válasz
A CreateEvent kérelme
<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>
A CreateEvent válasza
<?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-k hatása:
SetEvent GetEvent
GetSessionInfo
LstsummaryEvent
LstrecordedEvent
LstsummaryProgram
UploadEventImage
XMLAPI LstMeetingType
reagál a subProductCodePrefix
Érintett API-k
Az API aktuális LstMeetingType
válaszelem productionCodePrefix
: PRO, AUO és mások, amelyek Webex előre meghatározott megfelelnek típus előtag.
Az új fejlesztés után az API válaszol a subProdctCodePrefix
:P RO1, PRO2 stb., amely testreszabható megfelel-típusú előtag.
Sémaváltozások az API-n: LstMeetingType
Új elemre fog válaszolni: subProdctCodePrefix
API-kérelem és válasz példa
LstMeetingType
API-kérés és válasz
Kérelem LstMeetingType
<bodyContent xsi:type="java:com.webex.service.binding.meetingtype.LstMeetingType">
<meetingTypeID>13810</meetingTypeID>
</bodyContent>
</body>
</serv:message>
A válasz 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 frissítések
XML API 41.11.0 frissítések
Kattintson ide az XML API 41.11.0 sémaletöltéséhez.
XML API-támogatás a control hub által felügyelt webhelyek felhasználói felügyeleti API-jában
Érintett API-k és sémaváltozások
Ha az integrációs alkalmazás jelenleg Webex XMLAPI felhasználói felügyeleti API-kat használ: CreateUser
, SetUser
, DelUser
és GetUser
a felhasználók kiépítéséhez vagy kezeléséhez a Webex klasszikus webhelyÉnek Control Hub által felügyelt webhelyré való átalakítása után ezek az API-k továbbra is működnek az előre kompatibilitás érdekében. Van néhány viselkedésbeli változás az alábbiak szerint:
CreateUser használatakor – ha a Control Hub felhasználói állapota nem"aktív", akkor a felhasználó állapota a webhelyen nem lesz aktív. Ha a Control Hub felhasználói állapota aktív , akkor a felhasználó állapota a webhelyen isaktív, hivatkozás: Új és konvertált felhasználók felhasználói állapota a ControlHubban .
A CreateUser és a SetUser API-k jelszóelemét figyelmen kívül hagyjuk, elkezdjük elküldeni az aktiválási e-maileket az új felhasználóknak, a felhasználók rákattinthatnak az e-mailben található linkre az aktív új fiókhoz, és új jelszót adhatnak meg.
A CreateUser API aktív elemefigyelmen kívül marad, az új felhasználó (nem ellenőrizhető) nem aktiválható ezzel a paraméterrel az API SetUserhasználatával.
A webExId elem értékének a bodyContent of CreateUser API-k értékének meg kell egynek lennie az e-mailekkel. Ha a webExId különbözik az e-mailektől,akkor a webExId-et ugyanúgy kezeljük, mint az e-maileket, amikor a WebDB-be tároljuk, és az értéket figyelmen kívül hagyjuk.
A webExId elem értéke a bodyContent of SetUser API-knak az e-mail-cím felhasználói identitásának kell lennie, ezta bodyContent e-mail > segítségévelmódosíthatja.
A SetUser API támogatja a meglévő felhasználók e-mail címének módosítását: akkor sikeres, ha a SecurityContext műveleti fiókja a Control Hub teljes webhely rendszergazdája. Ellenkező esetben az API új hibakóddal és üzenettel jelenti a hibát:
030120 Az e-mail módosításához a fióknak teljes webhely-rendszergazdának kell lennie.
A setUser API bodycontent újWebExId elemét a rendszer figyelmen kívül hagyja.
A SetUser API megpróbál olyan e-mailre váltani, amely már használatban van, az API az új hibakód és hibaüzenet alá emel:
030118 e-mail már használatban van a Control Hub felügyelt helyein.
A DelUser API inaktiválja a felhasználót a Webex értekezlet oldalán, és a megfelelő értekezlet-licenc törlődik a Webex webhelyről. Ez az inaktivált felhasználó az API használatával újraaktiválható: SetUser (<active>ACTIVATED ),</active>mindaddig, amíg a felhasználót korábban ellenőrizték.
A CreateUser és a SetUser API-k új hibakódot és hibaüzenetet hoznak létre az alábbiak szerint:
030117 ,Ez a felhasználó a szervezeten kívül létezik, ezért igényelni kell, hogy a jogcím felhasználói folyamatán keresztül belépjen a szervezetbe. A felhasználó szervezetbe való igénylésével kapcsolatos lépéseket a Felhasználók igénye a szervezethez (Felhasználók konvertálása) című témakörbentalál. A felhasználó igénylése előtt ellenőriznie kell azt a tartományt, amelyhez a felhasználó tartozik.
030119 A CI hozzáférési jogkivonatnak tartalmaznia kell a webexsquare hatókört: rendszergazda a felhasználó kiépítésekor.
Csak korlátozott ideig támogatott az előre kompatibilitás. A kompatibilitás eltávolítása előtt előzetes értesítést küldünk. |
Sémamódosítások
Nincsenek sémamódosítások ezeken az API-kon: CreateUser
, SetUser
, DelUser
és GetUser
.
API-kérelem és válasz példa
CreateUser API-kérelem és válasz
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-k hatása:
CreateUser
SetUser
DelUser
Az XML API támogatja a meglévő felhasználó hitelesítési előretekerhetőségét a Webex klasszikus webhelyének Control Hub felügyelt webhelyré konvertálása után
Érintett API-k
Miután a Webex klasszikus webhelye Control Hub felügyelt webhelyre vált, az elem értékének <webExID> <securityContext> meg kell egyezettnek lennie az e-maillel, az alábbi részleteket:
A Webex klasszikus webhelyén létrehozott meglévő felhasználók esetében támogatjuk mind a régi webExID-et (például: Jack) és az új webExID (a tartalom ugyanaz, mint az e-mail, például: Jack@xx.com) a bejelentkezéshez ez a hitelesítési visszamenőleges kompatibilitás az összes XML API-ra.
A Control Hub által felügyelt webhelyeken létrehozott új felhasználók esetében a webExID elem értékének meg kell egyezéssel meg kell egyezéssel rendelkeznie a bejelentkezéshez.
<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-k hatása:
Minden XML API.
Miután a Webex klasszikus webhelye Control Hub felügyelt webhelyré alakult át, a bodyContent > elem értékének <webExID> meg kellegyezettnek lennie az e-maillel, az alábbi részleteket:
A Webex klasszikus webhelyén létrehozott meglévő felhasználók számára támogatjuk mind a régi webExId-et(pl.: Jack) és az új webExId (a tartalom ugyanaz, mint az e-mail, például: Jack@xx.com) a testcontent.
A Control Hub által felügyelt webhelyeken létrehozott új felhasználók esetében a webExId elem értékének meg kell egynek lennie az e-mail
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-k hatása:GetUser
, SetUser
és DelUser
.
Sémamódosítások
Nincs sémamódosítás egyetlen API-n sem.
API-kérelem és válasz példa
GetUser API-kérés és válasz
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
A webex-értekezletek, a Webex-események (Új) és a Webex-események (Klasszikus) támogatásához a rögzítési nézetelőzmények jelentés API-ja
Érintett API-k
Jelenlegi API: lstrecordaccessHistory
és lstrecordaccessDetailHistory
csak támogatja a Webex Trainings felvételi nézethez hozzáfért előzményekről szóló jelentést. Az új fejlesztés támogatja a Webex Meetings, a Webex Events (új) és a Webex Events (klasszikus) felvételi nézet által elérhető előzményekről szóló jelentést is.
Sémamódosítások
Az alábbi új sémát támogatjuk az API lstrecordaccessHistory-ba az API-kérelem törzsében:
<serviceTypes>
<serviceType>MeetingCenter</serviceType>
<serviceType>TrainingCenter</serviceType>
<serviceType>EventCenter</serviceType>
</serviceTypes>
részletei
Az API: lstrecordaccessHistory
képes visszaadni a webex meetings, a Webex Events (új), a Webex Events (klasszikus) és a Webex-tréningek rögzített nézethez való hozzáférésű előzményeit.
Ha az API-kérelemben nincs megadva serviceType, a
lstrecordaccessHistory
csak a Webex Trainings felvételi nézethez hozzáfért előzményeit adja vissza.Ha a serviceType a MeetingCenter, a
lstrecordaccessHistory
mind a Webex Meetings, mind a Webex Events (új) felvételi nézethez hozzáfért előzményeket ad vissza.Ha a serviceType EventCenter, a
lstrecordaccessHistory
a Webex Events (klasszikus) felvételi nézethez hozzáfért előzményeket ad vissza.
Az API: lstrecordaccessDetailHistory
képes a részleteket a recordID
Webex találkozók, Webex események (új), Webex események (klasszikus) és Webex tréningek.
API-kérelem és válasz példa
lstrecordaccessHistory
Az API kérése és válasza
<?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
Az API kérése és válasza
<?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-k hatása:
lstrecordaccessHistory
lstrecordaccessDetailHistory
Javítsa ki a maximálisan engedélyezett Webex-események (Klasszikus) leírási hossza közötti különbséget az XMLAPI és a Webex lap között.
Érintett API-k
Az XML API: A CreateEvent és a SetEvent leírási eleme legfeljebb 10000 karakteres bevitelt tesz lehetővé, ha a méretbemenet túl van, akkor az új hibakódot és üzenetet eredményezi:
060068 illegális beviteli leírás. Ez a leírás nem haladhatja meg az 10000 karaktert.
Sémamódosítások
Nincs sémaváltozás.
API-kérelem és válasz példa
CreateEvent API-kérés és válasz
#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-k hatása:
CreateEvent
SetEvent
XML API: A GetUser visszaadja a freeAccount új elemét
Érintett API-k
GetUser
új elemet ad vissza, amely azonosítja a freeAccount
A felhasználói fiók FreeAccount
vagy sem.
Sémamódosítások
GetUser válasz példa
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-k hatása:
GetUser
API 41.10.0 frissítések
Az XML API 41.10.0 sémájában nincsenek sémamódosítások. |
API 41.9.0 frissítések
XML API 41.9.0 frissítések
Xml API 10.0.0 leszerelése az összes T31-webhelyhez
A Webex azt tervezi, hogy az összes T31 webhely esetében befejezi az XML API ver 10.0.0-t.
A 41.9.0 frissítés összes termeléséből leállítjuk az XML API 10.0.0 kódot.
API 41.8.0 frissítések
XML API 41.8.0 frissítések
Kattintson ide az XML API 41.8.0 sémaletöltéséhez.
Xml API 10.0.0 leszerelése az összes T31-webhelyhez
A Webex azt tervezi, hogy az összes T31 webhely esetében befejezi az XML API ver 10.0.0-t.
A Webex talált néhány ügyfelet, akik az XML API URL-címéhez fértek hozzá, helytelen módon: https://{siteName}.webex.com/WBXService/xml10.0.0/XMLService, az XML API URL-címének helyes elérése a következőképpen: https://{siteName}.webex.com/WBXService/XMLService.
Kérjük, váltson a kódhozzáférés XML API-ját a megfelelő módon, hogy elkerülje az ütközést, mielőtt az XML API 10.0.0-s verziójára az életfenntartó rendszer végére érnénk.
API 41.7.0 frissítések
XML API 41.7.0 frissítések
Kattintson ide az XML API 41.7.0 sémaletöltéséhez.
A mobil törlést és szerkesztési felvételt a webhelyfelügyeleti lehetőségnek kell szabályoznia: A állomások újbóli hozzárendelésének, szerkesztésének, letiltásának és törlésének engedélyezése
Érintett API-k és sémaváltozások
GetSite
: új elemek elnevezése enableNBRMCModify
és separateNoRecordingEdit
eszközök alatt.
Válasz példa
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 Frissítések
XML API 41.6.3 frissítések
Kattintson ide az XML API 41.6.3 sémaletöltéséhez.
GetSite
Válasz új eleme supportLargeEvent
Érintett API-k és sémaváltozások
GetSite: új elemek elnevezését adja vissza supportLargeEvent
alatt siteCommonOptions
hogy a hívó tudassa a hívóval, hogy a webhely támogatja-e a Nagy eseményt (Webex Esemény (új)) vagy sem.
Séma módosítása
Válasz példa
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 frissítések
XML API 41.6.0 frissítések
Kattintson ide az XML API 41.6.0 sémaletöltéséhez.
AZ XMLAPI támogatja a Webex Events 2.0-t a kiépítésben
Érintett API-k
GetUser
: új elem elnevezést ad vissza largeEventCapacity
amely az új 2.0-s esemény (EC 2.0) kapacitását mutatja ezen a felhasználói fiók alatt. Ha például a felhasználói fiók CI_EC3K licenccel rendelkezik, a largeEventCapacity
Az 3000.
Sémamódosítások
Válasz példa
GetUserResponse:
AZ XMLAPI LstRecording CreateTime a felvétel kezdési idejét alkalmazza
Érintett API-k
LstRecording
: LstRecording
válasz CreateTime
mint az az idő, amikor a felhasználó ténylegesen megnyomja a rekord gombot.
részletei
A múltban az XML API időbélyegzőt használt annak, hogy mikor hozták létre a felvételt az adatbázisban, mint a LstRecording
válasz. Most itt az ideje, hogy a felhasználó ténylegesen elkezdje a felvételt. Ez a változás minden szolgáltatásfelvételre vonatkozik. Nincs sémaváltozás.
API 41.5.0 frissítések
XML API 41.5.0 frissítések
Kattintson ide az XML API 41.5.0 sémaletöltéséhez.
Az XMLAPI képes elindítani a Webex ütemezett értekezleteit a PSTN-ből, mint házigazda
Érintett API-k
CreateUser
: generálhostPIN
függetlenül attól, hogy a felhasználói PMR engedélyezve van-e vagy sem, ha a felhasználói szerepkör gazdagép, vagy teljes vagy írásvédett vagy felhasználókezelő webhely rendszergazdái.SetUser
: készletekhostPIN
Használphones.hostPIN
mikorpersonalMeetingRoom.hostPIN
nincs xml-kérelemben (előfeltétel: funkció ki-/bekapcsolásaAllowStartScheduledMtgFromPhone
engedélyezve van).GetUser
: visszatérphones.hostPIN
függetlenül attól, hogy a felhasználó PMR engedélyezve van-e vagy sem. (előfeltétel: funkció ki-/bekapcsolásaAllowStartScheduledMtgFromPhone
engedélyezve van).
Sémaváltozások
GetUserResponse
:
SetUser
:
Válasz példa
GetUserResponse
:
SetUser
:
XMLAPI GetSite
válasz két új elem mobil kliens
Érintett API-k
GetSite
:GetSite
most választ ad két új elem támogatja a mobil kliens a logika megjelenítésére, vagy nem jeleníti meg a felvétel fület.enableRecordingAccess
: igaz vagy hamis, a Webex szuperadminisztrátorai engedélyezhetik vagy letilthatják a felvételhez való hozzáférést a kapcsolóval(EnableRecordingAccesses
).storageEmptyStatus
: igaz vagy hamis, ha mindkét webhely nem támogatja az NBR függvényt, és az NBR-tárolóhelyet nullára osztotta, akkor az állapotválasz igaz, különben hamis.
Sémaváltozások
Mintakérés GetSite
Mintaválasz Getsite
A nem ASCII karakterekkel rendelkező e-mail-téma RFC2047 kódolással lesz kódolva. Abban az esetben, egy tiszta ASCII karakter e-mail tárgy, nincs kódolás
Érintett API-kNincs hatással semmilyen API-kérésre, válasz hasznos terhelésére, de megváltoztatja az e-mail-téma kódolási viselkedését. Ha az e-mail nem ASCII karaktereket tartalmazó tárgya RFC2047 kódolású lesz. Tiszta ASCII karakteres e-mail tárgy esetén nincs kódolás.
Sémaváltozások
Nincsenek sémaváltozások.
API 41.4.0 frissítések
XML API 41.4.0 frissítések
Kattintson ide az XML API 41.4.0 sémaletöltéséhez.
Eseményütemezett Webex-események létrehozása kihasználhatja a webhelyszintű alapértelmezett értéket a belépési és kilépési hangon
Az XMLAPI igazodik a belépési és kilépési hang szabályozásának jelenlegi új logikájához. A Webex-események minden hangnemét a webhelyfelügyelet egy másik beállítása szabályozta. Ebben: GetSite
, AZ XMLAPI egy extra mezőt ad vissza entryExitToneEC
az érték jelzésére. Eredetileg, ha a webhely rendszergazdája alapértelmezett értéket állított be a hangnemre, az Esemény létrehozása nem használja ki ezt a beállítást az XMLAPI alapértelmezett alkalmazásával.
Érintett API-k
Az XML API: A GetSite egy új elemet ad vissza entryExitToneEC
az érték jelzésére.
Az XML API: CreateEvent, SetEvent, GetEvent back end üzleti logika olvassa el az értékét entryExitToneEC
.
Sémamódosítások
XML API: GetSite válaszminta:
<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-k hatása:
GetSite
CreateEvent
SetEvent
GetEvent
XmlAPI csak visszaadja a nagy esemény (Webex Event 2.0) részletes információk
Ha a Webex-értekezlet a nagy esemény vagy webcast,
GetSessionInfo
ad vissza néhány részletinformációt, beleértve az értekezlet jelszavát, az értekezlet numerikus jelszavát, a panelista jelszót és a panelista numerikus jelszót (Nincs séma megváltoztatva).Az XMLAPI nem támogatja a nagy esemény- vagy webcast funkció létrehozását és szerkesztését, így
CreateMeeting
ésSetMeeting
a nagy esemény- vagy webcast eset esetén új kivételt (110064, Az esemény és a webcast munkamenet típusa nem támogatott.) ad vissza.
API-k hatása
API neve |
Leírás |
Megjegyzés |
---|---|---|
|
Ha a Webex-értekezlet a nagy esemény vagy webcast, |
A séma nem módosítható. |
|
Ha a felhasználó megpróbálja használni a |
A viselkedés megváltoztatható. |
API 41.3.0 frissítések
XML API 41.3.0 frissítések
Kattintson ide az XML API 41.3.0 sémaletöltéséhez.
Az XML API új módosításai támogatják a Webex Events 2.0 funkciót
Érintett API-k
Mindkét API: GetSessionInfo és GetMeeting visszatérési elemek enableEvent
és enableWebniar
is.
Elem neve |
Leírás |
---|---|
enableEvent |
Támogatja az EC 2.0-t egy Webex találkozón |
enableWebniar |
Támogatja a webináriumot egy Webex találkozón |
Az XMLAPI-támogatás az EC 2.0 két eleme felett ad vissza. Az XML API jelenlegi kiadása nem támogatja az EC2.0 értekezlet ütemezését és beállítását. |
Sémamódosítások
GetSessionInfo
elemeket ad vissza enableEvent
és enableWebniar
az EK 2.0 esetében.
GetMeeting
elemeket ad vissza enableEvent
és enableWebniar
az EK 2.0 esetében.
Válaszminta:
GetSessionInfo
válasz:
<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
válasz:
<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>
Az XMLAPI új módosításai támogatják az értekezlet előtti lobby funkciót
Érintett API-k
Az XML API: GetSite
, LstSummarySession
, GetSessionInfo
és GetMeeting
válaszol az új elemre enablePreMeetingLobby
a találkozó előtti lobbi számára.
Sémamódosítások
Az XML API: GetSite
visszaadja az elemet enablePreMeetingLobby
a találkozó előtti lobbi számára.
Az XML API: LstSummarySession
visszaadja az elemet enablePreMeetingLobby
a találkozó előtti lobbi számára.
Az XML API: GetSessionInfo
visszaadja az elemet enablePreMeetingLobby
a találkozó előtti lobbi számára.
Az XML API: GetMeeting
visszaadja az elemet enablePreMeetingLobby
a találkozó előtti lobbi számára.
Válaszminta:
GetSite
válasz:
<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
válasz:
<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
válasz:
<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
válasz:
<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>
Az XML API GetSite
válasz Információ viselkedésváltozás nyilvánosságra hozatala
Érintett API-k
Az XML API: GetSite
csak válasz a rendszergazdai fiók elemei alatt, amelyek szerepköröket tartalmaznak: SiteAdmin
, RO_SiteAdmin
és 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>
Megváltozott a viselkedés
Csak akkor engedélyezze, hogy a rendszergazdai szerepkör rendelkezik a GetSite
. A gazdagép vagy a résztvevő nem kapja meg ezeket a licencadatokat GetSite
válasz.
Az alábbiakban API: GetSite's
válasz példa a siteadmin
vagy csak kész siteadmin
vagy felhasználó-menedzsment admin:
API 41.2.0 frissítések
XML API 41.2.0 frissítések
Kattintson ide az XML API 41.2.0 sémaletöltéséhez.
Az XMLAPI-nak támogatnia kell a "CMR Hybrid VOIP"-ot, ha a webhely támogatja a Webex telefonálást
Érintett API-k
GetSite
új elemet ad visszaIsWebexTelephony
a válaszban.CreateUser
ésSetUser
frissítheti acmrHybridVoip
elem, haIsWebexTelephony
más feltételekkel együtt igaz.IsTSPUsingTelephonyAPI
már nem következményes.
Sémamódosítások
XML API: GetSite
A válasz egy további elemet ad vissza IsWebexTelephony
GetSite
válasz tartalmazza ezt az új elemet:
<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
támogatja az EC2.0-t
Az XML API-k hatása
LstSummarySession
új két elemet ad vissza az EK 2.0 támogatására
Elem neve |
Leírás |
---|---|
enableEvent |
Támogatja az EC 2.0-t egy Webex találkozón |
enableWebniar |
Támogatja a webináriumot egy Webex találkozón |
Sémamódosítások
XML API: LstSummarySession
: Fűzze hozzá a < enableEvent
> és enableWebniar
> elemek
Az XML API válasza: LstSummarySession
Válasz az EK 2.0-ra
<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>
Az XMLAPI támogatja a webhely felhasználójának visszaadását Webex-voice-assistant
MCT integráció lehetősége
Érintett API
GetUser
új elemet ad vissza webexAssistantEnabled
(igaz vagy hamis) a válaszban.
Sémamódosítások
getUserResponse
:
Válasz példa
API 41.1.0 frissítések
Az XML API 41.1 sémájában nincsenek sémamódosítások. |