- Start
- /
- Artikel
Zoek alle belangrijke informatie die u nodig hebt over de Cisco Webex Meetings API, zoals wijzigingen in het schema en andere aankondigingen.
Voor meer informatie over XML API 39 en XML API 11, zie het Cisco Webex Meetings XML API Updates Overview (XML API 39 en eerder).
Zie het XML API Updates Overview (XML API 40 en Cisco Webex Meetings later) voor meer informatie over XML API 40 .
Voor updates voor XML API 11 SP9 en eerder kunt u Cisco DevNet raadplegen.
API 41.12.0-updates
XML API 41.12.0-updates
XMLAPI blokkeert de planning en bewerking van Webex Events (klassiek) op basis van het siteconfiguratie-item van EnableClassicEvent
dat niet waar is
Beïnvloede API's en schemawijzigingen
Als het selectievakje Klassieke gebeurtenis inschakelen op de configuratiepagina van Sitebeheer onwaar is, ondersteunt deze site geen Webex Events (klassieke) vergaderingen meer.
Als het selectievakje Enable classicEvent onwaar is, belt u deze API's om de Webex Events-vergadering (klassiek) te bedienen:
CreateEvent
, SetEvent
, GetEvent
, GetSessionInfo
, LstsummaryEvent
, LstrecordedEvent
, LstsummaryProgram
, UploadEventImage
De API reageert op een nieuwe uitzondering 010106Het klassieke evenement is uitgeschakeld.
Wijzigingen in het schema
Geen schemawijzigingen.
Voorbeeld van API verzoek en -antwoord
CreateEvent API-verzoek en -antwoord
Aanvraag van 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>
Reactie van 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>FOUT</serv:result>
<serv:reason>Het klassieke evenement is uitgeschakeld.</serv:reason>
<serv:gsbStatus>PRIMAIR</serv:gsbStatus>
<serv:exceptionID>010106</serv:exceptionID>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent/>
</serv:body>
</serv:message>
CreateEvent3.1.3 Invloed hebben op API's:
SetEvent GetEvent
GetSessionInfo
LstsummaryEvent
LstrecordedEvent
LstsummaryProgram
UploadEventImage
XMLAPI LstMeetingType
zal reageren op nieuw element van subProductCodePrefix
Beïnvloede API's
Huidige API LstMeetingType
responselement van productionCodePrefix
: PRO, AUO en andere voorgedefinieerde voorvoegsels voor vergaderingstype van Webex.
Na deze nieuwe verbetering reageert de API op een nieuw element van subProdctCodePrefix
:PRO1, PRO2, enz. die kunnen worden aangepast aan type voorvoegsel.
Schemawijzigingen in API: LstMeetingType
Het zal een antwoord zijn op een nieuw element: subProdctCodePrefix
Voorbeeld van API verzoek en -antwoord
LstMeetingType
API-verzoek en -antwoord
Aanvraag van LstMeetingType
<bodyContent xsi:type="java:com.webex.service.binding.meetingtype.LstMeetingType">
<meetingTypeID>13810</meetingTypeID>
</bodyContent>
Reactie van 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> //Nieuw element voor aangepast vergaderingstype
<mtgtype:active>ACTIVATED</mtgtype:active>
<mtgtype:name>Cus_Chat_Closed</mtgtype:name>
<mtgtype:displayName>Cus_Chat_Closed</mtgtype:displayName>
API 41.11.0-updates
XML API 41.11.0-updates
XML API ondersteunt voorwaartse compatibiliteit in gebruikersbeheer-API voor door Control Hub beheerde sites
Beïnvloede API's en schemawijzigingen
Als uw integratietoepassing momenteel gebruikmaakt van Webex XMLAPI-gebruikersbeheer-API's: CreateUser
, SetUser
, DelUser
en GetUser
om gebruikers in te richten of te beheren, blijven deze API's werken voor voorwaartse compatibiliteit nadat uw Webex Classic-site is geconverteerd naar een door Control Hub beheerde site. Er zijn enkele gedragsveranderingen zoals hieronder vermeld:
Wanneer u createUser gebruikt: als de gebruikersstatus in Control Hub niet 'actief' is, wordt de gebruikersstatus op de site niet actief. Als de gebruikersstatus in Control Hub actief is, is de gebruikersstatus op de site ook actief, zie: Gebruikersstatus van nieuwe en geconverteerde gebruikers in Control Hub.
Het wachtwoordelement van de API's CreateUser en SetUser wordt genegeerd. We beginnen met het verzenden van een activeringse-mail naar nieuwe gebruikers. Gebruikers kunnen op de koppeling in de e-mail klikken om een actief nieuw account te openen en een nieuw wachtwoord in te voeren.
De actiefelementvanCreateUser API wordt genegeerd, nieuwe gebruiker (niet geverifieerd) kan niet worden geactiveerd via deze parameter met behulp van API Gebruiker instellen.
De waarde van webExId element in de bodyInhoud van CreateUser API's moet hetzelfde zijn als e-mail. Indien webExId is anders dan e-mail, behandelen we de webExId hetzelfde als e-mail bij het opslaan in WebDB en de waarde wordt genegeerd.
De waarde van webExId element in the bodyContent of SetUser APIs must be user identity of email address, you can change it using <e-mail> in bodyContent.
De SetUser API ondersteunt het wijzigen van het e-mailadres van de bestaande gebruiker: het is gelukt als het bedrijfsaccount in SecurityContext de volledige sitebeheerder van Control Hub is. Anders rapporteert de API een fout met een nieuwe foutcode en een nieuw bericht hieronder:
030120 Het account moet een volledige sitebeheerder zijn om het e-mailadres te wijzigen.
Het element newWebExId in de bodyContent van SetUser API wordt genegeerd.
De API SetUser probeert te wijzigen in een e-mail die al in gebruik is. De API wordt onder de nieuwe foutcode en het foutbericht weergegeven:
030118 E-mail wordt al gebruikt op door Control Hub beheerde sites.
De DelUser API deactiveert de gebruiker aan de kant van de Webex-vergadering en de bijbehorende vergaderingslicentie wordt verwijderd van de Webex-site. Deze gedeactiveerde gebruiker kan opnieuw worden geactiveerd met behulp van API: SetUser (<active>ACTIVATED</active>) zolang de gebruiker vooraf is geverifieerd.
De API's CreateUser en SetUser genereren een nieuwe foutcode en een foutbericht, zoals hieronder wordt weergegeven:
030117, Deze gebruiker bestaat buiten uw organisatie, dus moet worden geclaimd, om naar uw organisatie te verplaatsen via het gebruikersproces voor de claim. Zie Gebruikers claimen voor uw organisatie (Gebruikers converteren) voor stappen bij het claimen van de gebruiker in uw organisatie. U moet het domein waartoe de gebruiker behoort verifiëren voordat u de gebruiker claimt.
030119 Het CI-toegangstoken moet het bereik bevatten webexsquare: beheerder bij het inrichten van gebruiker.
Alleen voor een beperkte periode wordt forward-compatibiliteit ondersteund. We geven een voorafgaande kennisgeving voordat deze compatibiliteit wordt verwijderd. |
Wijzigingen in het schema
Geen schemawijzigingen voor deze API's: CreateUser
, SetUser
, DelUser
en GetUser
.
Voorbeeld van API verzoek en -antwoord
API-verzoek en antwoord voor CreateUser aanmaken
API-verzoek:
<?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/servicehttp://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> of <password> of <webExAccessToken>
of <accessToken>, bij gebruik van CI "accessToken", moet het scope webexsquare omvatten:admin wanneer het inrichten van gebruiker
</accessToken></webExAccessToken></password></securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.user.CreateUser">
<webExId>Jack@qa.webex.com</webExId> --- het moet de gebruikersidentiteit van het e-mailadres zijn
<email>Jack@qa.webex.com</email>
<firstName>Jack</firstName>
<lastName>Smith</lastName>
<password>....</password>
<privilege>
<host>true</host>
</privilege>
<active>ACTIVATED</active> ---deze parameter kan de gebruiker niet direct activeren totdat de gebruiker zichzelf activeert via activeringsmail.
</bodyContent>
</body>
Voorbeeld van API-respons:
<?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>SUCCES</serv:result>
<serv:gsbStatus>PRIMAIR</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>
Invloed hebben op API's:
Gebruiker maken
Gebruiker instellen
Deelgebruiker
XML-API ondersteunt de compatibiliteit voor verificatie doorschakelen van bestaande gebruikers nadat de klassieke Webex-site is geconverteerd naar de door Control Hub beheerde site
Beïnvloede API's
Nadat de Webex Classic-site is geconverteerd naar een door Control Hub beheerde site, moet de waarde van <webExID> element in <securityContext> hetzelfde zijn als het e-mailadres. Hieronder vindt u meer informatie:
Voor bestaande gebruikers die zijn gemaakt op de Webex Classic-site, ondersteunen we zowel oude webExID (Bijvoorbeeld: Jack) en nieuwe webExID (de inhoud is hetzelfde als e-mail, bijvoorbeeld: Jack@xx.com) om in te loggen, is deze verificatie achterwaartse compatibiliteit voor alle XML-API's.
Voor nieuwe gebruikers die zijn gemaakt op door Control Hub beheerde sites, moet de waarde van het element webExID hetzelfde zijn als het e-mailadres voor aanmelding.
<header>
<securityContext>
<siteName>{siteName}</siteName>
<webExID>{userName}</webExID> --- bestaande gebruikers zijn gemaakt in webEx klassieke site, het kan zijn: jack of jack@xx.com; nieuwe gebruiker moet jack@xx.com
<sessionTicket>xxxx</sessionTicket> of <password> of <webExAccessToken> gebruiken <accessToken>
</accessToken></webExAccessToken></password></securityContext>
</header>
Invloed hebben op API's:
Alle XML-API's.
Nadat de klassieke Webex-site is geconverteerd naar een door Control Hub beheerde site, moet de waarde van <webExID> element <bodyContent> hetzelfde zijn als het e-mailadres. Hieronder vindt u meer informatie:
Voor bestaande gebruikers die zijn gemaakt op de Webex Classic-site, ondersteunen we zowel oude webExId(bv.: Jack) en nieuw webExId (de inhoud is gelijk aan e-mail, bijvoorbeeld: Jack@xx.com) in bodyContent.
Voor nieuwe gebruikers die zijn gemaakt in door Control Hub beheerde sites, is de waarde van webExId element moet hetzelfde zijn als e-mail in
bodyContent
.
<bodyContent xsi:type="java:com.webex.service.binding.user.GetUser or SetUser or DelUser">
<webExId>xxxx</webExId> --- bestaande gebruikers zijn gemaakt in webEx klassieke site, het kan zijn: jack of jack@xx.com; nieuwe gebruiker moet jack@xx.com gebruiken
</bodyContent>
Invloed hebben op API's:GetUser
, SetUser
en DelUser
.
Wijzigingen in het schema
Geen schemawijzigingen op API's.
Voorbeeld van API verzoek en -antwoord
GetUser API-verzoek en -antwoord
API-verzoek:
<?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/servicehttp://www.webex.com/schemas/2002/06/service/service.xsd">
<header>
<securityContext>
<siteName>{siteName}</siteName>
<webExID>{userName}</webExID> --- bestaande gebruikers zijn gemaakt in webEx klassieke site, het kan zijn: jack of jack@xx.com; nieuwe gebruiker moet jack@xx.com
<sessionTicket>xxxx</sessionTicket> of <password> of <webExAccessToken> of <accessToken>
</accessToken></webExAccessToken></password></securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.user.GetUser or SetUser or DelUser">
<webExId>xxxx</webExId> gebruiken --- bestaande gebruikers zijn aangemaakt op de klassieke website webEx, het kan gaan om: jack of jack@xx.com; nieuwe gebruiker moet jack@xx.com
</bodyContent>
</body>
voorbeeld API-respons:
...zelfde als voorheen
Verbetering van de API voor geschiedenisrapporten van de opnameweergave voor ondersteuning in Webex Meetings, Webex Events (nieuw) en Webex Events (klassiek)
Beïnvloede API's
Huidige API: lstrecordaccessHistory
en lstrecordaccessDetailHistory
alleen ondersteuning bieden voor Webex Trainings-opnameweergave geopend geschiedenisrapport. De nieuwe verbetering ondersteunt ook de opnameweergave van Webex Meetings, Webex Events (nieuw) en Webex Events (klassiek) geopend geschiedenisrapport.
Wijzigingen in het schema
We ondersteunen hieronder een nieuw schema in API lstrecordaccessHistory in de API-verzoektekst:
<serviceTypes>
<serviceType>MeetingCenter</serviceType>
<serviceType>TrainingCenter</serviceType>
<serviceType>EventCenter</serviceType>
</serviceTypes>
Details
De API: lstrecordaccessHistory
kan de geopende geschiedenis van de opnameweergave terugkeren voor Webex Meetings, Webex Events (nieuw), Webex Events (klassiek) en Webex Trainings.
Als er geen serviceType opgegeven in API-aanvraag, de API van
lstrecordaccessHistory
retourneert alleen de geopende geschiedenis van de opnameweergave van Webex Trainings.Wanneer het serviceType MeetingCenter is, wordt de API van
lstrecordaccessHistory
retourneert de (nieuwe) opnameweergavegeschiedenis van zowel Webex Meetings als Webex Events.Wanneer de serviceType is EventCenter, de API van
lstrecordaccessHistory
retourneert de geopende geschiedenis van de opnameweergave van Webex Events (klassiek).
De API: lstrecordaccessDetailHistory
kunt u gegevens retourneren door recordID
van Webex Meetings, Webex Events (nieuw), Webex Events (klassiek) en Webex Trainings.
Voorbeeld van API verzoek en -antwoord
lstrecordaccessHistory
Verzoek en reactie van 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>20-9-2021 00:00:00</viewTimeStart>
<viewTimeEnd>28-9-2021 23:59:59</viewTimeEnd>
</viewTimeScope>
<listControl>
<startFrom>1</startFrom>
<maximumNum>100</maximumNum>
</listControl>
<order>
<orderBy>OPGENOMEN</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>GESLAAGD</serv:result>
<serv:gsbStatus>PRIMAIR</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>LstrecordaccessGeschiedenistest TC-20210924 1324-1</history:recordName>
<history:creationTime>24-09-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>Direct afspelen testen 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>22-09-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>LstrecordaccessGeschiedenis test EC2.0-20210924 1315-1</history:recordName>
<history:creationTime>24-09-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>LstrecordaccessGeschiedenistest MC-20210924 1319-1</history:recordName>
<history:creationTime>24-09-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>LstrecordaccessGeschiedenis test EC classic-20210924 1331-1</history:recordName>
<history:creationTime>24-09-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
Verzoek en reactie van 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>
</body>
<?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>GESLAAGD</serv:result>
<serv:gsbStatus>PRIMAIR</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>24-09-2021 13:27:26</history:accessTime>
<history:registered>vals</history:registered>
<history:downloaded>vals</history:downloaded>
<history:viewed>waar</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>24-09-2021 13:27:39</history:accessTime>
<history:registered>vals</history:registered>
<history:downloaded>waar</history:downloaded>
<history:viewed>vals</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>
Invloed hebben op API's:
lstrecordaccessHistory
lstrecordaccessDetailHistory
Repareer het gat tussen de lengte van de maximaal toegestane Webex Events-beschrijving (klassiek) tussen XMLAPI en de Webex-pagina.
Beïnvloede API's
De XML API: Element CreateEvent en SetEvent van beschrijving staat maximaal 10000 tekens in. Als u te groot invoert, leidt dit tot de nieuwe foutcode en het nieuwe bericht:
060068 Beschrijving illegale invoer. Deze beschrijving mag niet langer zijn dan 10000 tekens.
Wijzigingen in het schema
Geen schemawijziging.
Voorbeeld van API verzoek en -antwoord
CreateEvent API-verzoek en -antwoord
#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/eventhttp://www.webex.com/schemas/2002/06/service/event/event.xsd">
<accessControl>
<sessionPassword>111111</sessionPassword>
<listing>PRIVATE</listing>
</accessControl>
<metaData>
<sessionName>EC test</sessionName>
<description>.......Stel dat je 10000 karakters invult in beschrijving.......</description>
</metaData>
...
------------------------------------
#API-responsvoorbeeld wanneer de beschrijving meer dan 10000 tekens bevat:
<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>FOUT</serv:result>
<serv:reason>Ongeldige invoerbeschrijving. De beschrijving mag niet langer zijn dan 10000 tekens</serv:reason>
<serv:gsbStatus>PRIMAIR</serv:gsbStatus>
<serv:exceptionID>060068</serv:exceptionID>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent/>
</serv:body>
</serv:message>
Invloed hebben op API's:
CreateEvent
SetEvent
XML API: GetUser retourneert nieuw element van freeAccount
Beïnvloede API's
GetUser
retourneert een nieuw element dat freeAccount
het gebruikersaccount is FreeAccount
of niet.
Wijzigingen in het schema
Voorbeeld van antwoord van GetUser
Antwoord van de GetUser:
<use:initials>AW</use:initials>
<use:isUploaded>niet waar</use:isUploaded>
<use:largeEventCapacity>3</use:largeEventCapacity>
<use:freeAccount>niet waar</use:freeAccount>
Invloed hebben op API's:
GetUser
API 41.10.0-updates
Er zijn geen schemawijzigingen in het XML API 41.10.0-schema. |
API 41.9.0-updates
XML API 41.9.0-updates
XML API 10.0.0 buiten gebruik stellen voor alle T31-sites
Webex is van plan de ondersteuning voor XML API ver 10.0.0 voor alle T31-sites te beëindigen.
We deactiveren de XML API 10.0.0-code van alle producties in de 41.9.0-update.
API 41.8.0-updates
XML API 41.8.0-updates
XML API 10.0.0 buiten gebruik stellen voor alle T31-sites
Webex is van plan de ondersteuning voor XML API ver 10.0.0 voor alle T31-sites te beëindigen.
Webex heeft een aantal klanten gevonden die op een onjuiste manier toegang kregen tot de URL van XML API: https://{siteName}.webex.com/WBXService/xml10.0.0/XMLService, de juiste manier om de XML-API-URL te openen als: https://{siteName}.webex.com/WBXService/XMLService.
Schakel de XML API voor codetoegang op de juiste manier om een impact te voorkomen voordat we ondersteuning voor XML API versie 10.0.0 beëindigen.
API 41.7.0-updates
XML API 41.7.0-updates
Mobiele opname verwijderen en bewerken moet worden beheerd door de sitebeheeroptie: Hosts toestaan om opnamen opnieuw toe te wijzen, te bewerken, uit te schakelen en te verwijderen
Beïnvloede API's en schemawijzigingen
GetSite
: zal nieuwe elementen naamgeving teruggeven enableNBRMCModify
en separateNoRecordingEdit
onder gereedschap.
Voorbeeld van respons
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>SUCCES</serv:result>
<serv:gsbStatus>PRIMAIR</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>onwaar</ns1:enableNBRMCModify>
<ns1:separateNoRecordingEdit>waar</ns1:separateNoRecordingEdit>
...
</ns1:tools>
</serv:bodyContent>
</serv:body>
</serv:message>
API 41.6.3-updates
XML API 41.6.3-updates
GetSite
Respons nieuw element van supportLargeEvent
Beïnvloede API's en schemawijzigingen
GetSite: geeft nieuwe elementen naamgeving terug supportLargeEvent
onder siteCommonOptions
om beller te laten weten of de site Grote gebeurtenis (Webex Event (nieuw)) ondersteunt of niet.
Schemawijziging
Voorbeeld van respons
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>SUCCES</serv:result>
<serv:gsbStatus>PRIMAIR</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>onwaar</ns1:enablePreMeetingLobby>
<ns1:supportLargeEvent>waar</ns1:supportLargeEvent>
</ns1:siteCommonOptions>
</serv:bodyContent>
</serv:body>
</serv:message>
API 41.6.0-updates
XML API 41.6.0-updates
XMLAPI ondersteunt Webex Events 2.0 in inrichting
Beïnvloede API's
GetUser
: retourneert naamgeving nieuw element largeEventCapacity
waarin de capaciteit van nieuwe Event 2.0 (EC 2.0) onder dit gebruikersaccount wordt weergegeven. Als het gebruikersaccount bijvoorbeeld een CI_EC3K-licentie heeft, is de waarde van largeEventCapacity
is 3000.
Wijzigingen in het schema
Voorbeeld van respons
GetUserResponse:
XMLAPI LstRecording's CreateTime past begintijd van opname toe
Beïnvloede API's
LstRecording
: LstRecording
reactie CreateTime
als het tijdstip waarop de gebruiker daadwerkelijk op de opnameknop drukt.
Details
In het verleden gebruikte XML API de tijdstempel van wanneer de opname in de database is gemaakt als de aanmaaktijd in LstRecording
reactie. Nu is het tijd dat de gebruiker daadwerkelijk begint met het maken van de opname. Deze wijziging is van toepassing op alle serviceopnamen. Er is geen schemawijziging.
API 41.5.0-updates
XML API 41.5.0-updates
XMLAPI kan geplande Webex-vergaderingen starten vanuit PSTN als host
Beïnvloede API's
CreateUser
: genereerthostPIN
ongeacht of de PMR van de gebruiker is ingeschakeld of niet wanneer de gebruikersrol host of volledige of alleen-lezen of sitebeheerders voor gebruikersbeheer is.SetUser
: setshostPIN
gebruikenphones.hostPIN
wanneerpersonalMeetingRoom.hostPIN
staat niet in XML-aanvraag (voorwaarde: functieschakelaarAllowStartScheduledMtgFromPhone
is ingeschakeld).GetUser
: retournerenphones.hostPIN
ongeacht of de PMR van de gebruiker is ingeschakeld of niet. (voorwaarde: functieschakelaarAllowStartScheduledMtgFromPhone
is ingeschakeld).
Schemawijzigingen
GetUserResponse
:
SetUser
:
Voorbeeld van respons
GetUserResponse
:
SetUser
:
XMLAPI GetSite
antwoord twee nieuwe elementen voor mobiele client
Beïnvloede API's
GetSite
:GetSite
zal nu reageren op twee nieuwe elementen ter ondersteuning van de mobiele client heeft de logica om het tabblad opname weer te geven of niet weer te geven.enableRecordingAccess
: waar of niet waar, Webex-superbeheerders kunnen opnametoegang in- of uitschakelen met de schakelaar(EnableRecordingAccesses
).storageEmptyStatus
: waar of onwaar, als beide sites de NBR-functie niet ondersteunen en de NBR-opslagruimte als nul hebben toegewezen, is de statusrespons waar, anders is het onwaar.
Schemawijzigingen
Voorbeeldaanvraag voor GetSite
Voorbeeldrespons voor Getsite
E-mailonderwerp met niet-ASCII-tekens wordt gecodeerd met RFC2047. In het geval van een zuiver e-mailonderwerp met ASCII-tekens is er geen codering
Beïnvloede API'sEr zijn geen gevolgen voor een API-verzoek, responspayload, maar het wijzigt het coderingsgedrag van het e-mailonderwerp. Wanneer het onderwerp van de e-mail met niet-ASCII-tekens wordt gecodeerd met RFC2047. In het geval van een zuiver e-mailonderwerp met ASCII-tekens is er geen codering.
Schemawijzigingen
Er zijn geen schemawijzigingen.
API 41.4.0-updates
XML API 41.4.0-updates
Als u een gebeurtenis maakt die is gepland, kan Webex Events de standaard op siteniveau gebruiken bij de toon voor aanmelden en afsluiten
XMLAPI stemt overeen met de huidige nieuwe logica voor het beheren van de toon voor binnenkomen en afsluiten. Alle tonen voor Webex Events werden beheerd door een andere instelling in sitebeheer. In GetSite
, XMLAPI geeft een extra veld terug entryExitToneEC
om de waarde aan te geven. Wanneer de sitebeheerder oorspronkelijk een standaardinstelling instelt op de toon, wordt deze instelling niet gebruikt door Gebeurtenis maken door de XMLAPI-standaardinstelling toe te passen.
Beïnvloede API's
De XML API: GetSite retourneert een nieuw element entryExitToneEC
om de waarde aan te geven.
De XML API: CreateEvent, SetEvent, GetEvent zakelijke logica leest de waarde van entryExitToneEC
.
Wijzigingen in het schema
XML API: Voorbeeld van GetSite-antwoord:
<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>
Invloed hebben op API's:
GetSite
Gebeurtenis maken
Gebeurtenis instellen
Evenement ophalen
XMLAPI geeft alleen de gedetailleerde informatie over de grote gebeurtenis (Webex Event 2.0) terug
Als de Webex-vergadering de grote gebeurtenis of webcast is,
GetSessionInfo
retourneert enkele detailgegevens, waaronder het wachtwoord voor de vergadering, het numerieke wachtwoord voor de vergadering, het wachtwoord voor panelleden en het numerieke wachtwoord voor panelleden (er wordt geen schema gewijzigd).XMLAPI biedt geen ondersteuning voor het maken en bewerken van een grote gebeurtenis of webcastfunctie, dus
CreateMeeting
enSetMeeting
een nieuwe uitzondering retourneren (110064, Het gebeurtenis- en webcastsessietype worden niet ondersteund.) voor een grote gebeurtenis of webcastcase.
Impact-API's
API-naam | Beschrijving | Opmerking |
---|---|---|
| Als de Webex-vergadering de grote gebeurtenis of webcast is, | Er wordt geen schema gewijzigd. |
| Als de gebruiker probeert te gebruiken | Gedrag wordt gewijzigd. |
API 41.3.0-updates
XML API 41.3.0-updates
De nieuwe XML API-wijzigingen ondersteunen de Webex Events 2.0-functie
Beïnvloede API's
Beide API's: Terugkeerelementen GetSessionInfo en GetMeeting enableEvent
en enableWebniar
ook.
Elementnaam | Beschrijving |
---|---|
enableEvent | Ondersteunt EC 2.0 in een Webex-vergadering |
enableWebniar | Ondersteunt Webinar in een Webex-vergadering |
XMLAPI-ondersteuning keert terug boven twee elementen voor EC 2.0. De huidige XML API-versie biedt geen ondersteuning voor het plannen en instellen van EC2.0-vergaderingen. |
Wijzigingen in het schema
GetSessionInfo
retourelementen enableEvent
en enableWebniar
voor EC 2.0.
GetMeeting
retourelementen enableEvent
en enableWebniar
voor EC 2.0.
Voorbeeld van respons:
GetSessionInfo
antwoord:
<ep:accessControl>
<ep:listStatus>OPENBAAR</ep:listStatus>
<ep:registration>onwaar</ep:registration>
<ep:passwordReq>waar</ep:passwordReq>
<ep:isEnforceAudioPassword>onwaar</ep:isEnforceAudioPassword>
<ep:isEnforceAudioLogin>onwaar</ep:isEnforceAudioLogin>
<ep:enableEvent>onwaar</ep:enableEvent>
<ep:enableWebniar>onwaar</ep:enableWebniar>
<ep:enablePreMeetingLobby>waar</ep:enablePreMeetingLobby>
</ep:accessControl>
GetMeeting
antwoord:
<meet:supportPKI>onwaar</meet:supportPKI>
<meet:HQvideo>waar</meet:HQvideo>
<meet:HDvideo>waar</meet:HDvideo>
<meet:viewVideoThumbs>waar</meet:viewVideoThumbs>
<meet:enableEvent>onwaar</meet:enableEvent>
<meet:enableWebniar>onwaar</meet:enableWebniar>
<meet:enablePreMeetingLobby>waar</meet:enablePreMeetingLobby>
De nieuwe XMLAPI-wijzigingen ondersteunen de functie Lobby voorafgaand aan de vergadering
Beïnvloede API's
De XML API: GetSite
, LstSummarySession
, GetSessionInfo
en GetMeeting
zal reageren op het nieuwe element enablePreMeetingLobby
voor de lobby voorafgaand aan de vergadering.
Wijzigingen in het schema
De XML API: GetSite
retourelement enablePreMeetingLobby
voor de lobby voorafgaand aan de vergadering.
De XML API: LstSummarySession
retourelement enablePreMeetingLobby
voor de lobby voorafgaand aan de vergadering.
De XML API: GetSessionInfo
retourelement enablePreMeetingLobby
voor de lobby voorafgaand aan de vergadering.
De XML API: GetMeeting
retourelement enablePreMeetingLobby
voor de lobby voorafgaand aan de vergadering.
Voorbeeld van respons:
GetSite
antwoord:
<ns1:siteCommonOptions>
<ns1:SupportCustomDialRestriction>onwaar</ns1:SupportCustomDialRestriction>
<ns1:SupportTelePresence>onwaar</ns1:SupportTelePresence>
<ns1:SupportTelePresencePlus>onwaar</ns1:SupportTelePresencePlus>
<ns1:EnableCloudTelepresence>waar</ns1:EnableCloudTelepresence>
<ns1:EnableCMRForAllUsers>waar</ns1:EnableCMRForAllUsers>
<ns1:enablePersonalMeetingRoom>waar</ns1:enablePersonalMeetingRoom>
<ns1:SupportAlternateHost>waar</ns1:SupportAlternateHost>
<ns1:SupportXMLAPIReturnScheduledPMR>onwaar</ns1:SupportXMLAPIReturnScheduledPMR>
<ns1:SupportAnyoneHostMeetings>waar</ns1:SupportAnyoneHostMeetings>
<ns1:enablePreMeetingLobby>waar</ns1:enablePreMeetingLobby>
</ns1:siteCommonOptions>
LstSummarySession
antwoord:
<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>
GetSessionInfo
antwoord:
<ep:accessControl>
<ep:listStatus>OPENBAAR</ep:listStatus>
<ep:registration>onwaar</ep:registration>
<ep:passwordReq>waar</ep:passwordReq>
<ep:isEnforceAudioPassword>onwaar</ep:isEnforceAudioPassword>
<ep:isEnforceAudioLogin>onwaar</ep:isEnforceAudioLogin>
<ep:enableEvent>onwaar</ep:enableEvent>
<ep:enableWebniar>onwaar</ep:enableWebniar>
<ep:enablePreMeetingLobby>waar</ep:enablePreMeetingLobby>
</ep:accessControl>
GetMeeting
antwoord:
<meet:supportPKI>onwaar</meet:supportPKI>
<meet:HQvideo>waar</meet:HQvideo>
<meet:HDvideo>waar</meet:HDvideo>
<meet:viewVideoThumbs>waar</meet:viewVideoThumbs>
<meet:enableEvent>onwaar</meet:enableEvent>
<meet:enableWebniar>onwaar</meet:enableWebniar>
<meet:enablePreMeetingLobby>waar</meet:enablePreMeetingLobby>
De XML API GetSite
reactie Informatie gedragsverandering openbaar maken
Beïnvloede API's
De XML API: GetSite
alleen respons onder elementen voor beheerdersaccount, waaronder rollen: SiteAdmin
, RO_SiteAdmin
en 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>
Gedrag gewijzigd
Alleen toestaan dat de beheerdersrol responslicentiegegevens heeft van GetSite
. Host of deelnemer krijgt deze licentiegegevens niet binnen GetSite
reactie.
Hieronder vindt u API: GetSite's
voorbeeld van respons voor siteadmin
of kant en klaar siteadmin
of beheerder van gebruikersbeheer:
API 41.2.0-updates
XML API 41.2.0-updates
XMLAPI moet 'hybride CMR VOIP' ondersteunen als de site Webex-telefonie ondersteunt
Beïnvloede API's
GetSite
retourneert een nieuw elementIsWebexTelephony
in de reactie.CreateUser
enSetUser
kan decmrHybridVoip
element indienIsWebexTelephony
is waar, samen met andere voorwaarden.IsTSPUsingTelephonyAPI
heeft geen gevolgen meer.
Wijzigingen in het schema
XML API: GetSite
reactie geeft een extra element terug IsWebexTelephony
GetSite
antwoord omvat dit nieuwe element:
<ns1:telephonyConfig>
<ns1:isWebexTelephony>waar</ns1:isWebexTelephony>
<ns1:isTSPUsingTelephonyAPI>niet waar</ns1:isTSPUsingTelephonyAPI>
<ns1:serviceName>Persoonlijk conferentienummer.</ns1:serviceName>
<ns1:participantAccessCodeLabel>Toegangscode deelnemer</ns1:participantAccessCodeLabel>
<ns1:subscriberAccessCodeLabel>Toegangscode host</ns1:subscriberAccessCodeLabel>
<ns1:attendeeIDLabel>Deelnemer-id</ns1:attendeeIDLabel>
.....
</ns1:telephonyConfig>
LstSummarySession
ondersteunt EC2.0
XML-API's worden beïnvloed
LstSummarySession
zal nieuwe twee elementen teruggeven ter ondersteuning van EC 2.0
Elementnaam | Beschrijving |
---|---|
enableEvent | Ondersteunt EC 2.0 in een Webex-vergadering |
enableWebniar | Ondersteunt Webinar in een Webex-vergadering |
Wijzigingen in het schema
XML API: LstSummarySession
: Voeg de < toe enableEvent
> en < enableWebniar
> elementen
Reactie van XML API: LstSummarySession
Respons voor EC 2.0
<ep:isNextUpcomingInstance>waar</ep:isNextUpcomingInstance>
<ep:seriesMeetingKey>0</ep:seriesMeetingKey>
<ep:isScheduledPMR>waar</ep:isScheduledPMR>
<ep:enableEvent>waar</ep:enableEvent>
<ep:enableWebniar>waar</ep:enableWebniar>
XMLAPI ondersteunt om sitegebruiker terug te sturen Webex-voice-assistant
optie voor MCT-integratie
Beïnvloede API
GetUser
retourneert een nieuw element webexAssistantEnabled
(waar of niet waar) in de reactie.
Wijzigingen in het schema
getUserResponse
:
Voorbeeld van respons
API 41.1.0-updates
Er zijn geen schemawijzigingen in het XML API 41.1-schema. |