Cisco Webex Meetings oversigt over API-opdateringer (API 41)

Du kan få yderligere oplysninger om XML API 39 og XML API 11 i Oversigt over Cisco Webex Meetings XML API-opdateringer (XML API 39 og ældre).

Du kan få yderligere oplysninger om XML API 40 i Oversigt over Cisco Webex Meetings XML API-opdateringer (XML API 40 og nyere).

Gå til Cisco DevNet for opdateringer til XML API 11 SP9 og tidligere.

Opdateringer til XML API 41.12.0

Klik her for at downloade XML API 41.12.0-skemaet.

XMLAPI blokerer planlægning og redigering af Webex Events (klassisk) i henhold til webstedets konfigurationspunkt i Aktivér klassisk begivenhed, der er falsk

Påvirkede API'er og skemaændringer

Hvis afkrydsningsfeltet Aktiver klassisk begivenhed er falsk på webstedsadministrationssiden, understøtter dette websted ikke længere Webex Events møder (klassiske).

Hvis afkrydsningsfeltet Aktiver klassiskEvent er falsk, kan du ringe til disse API'er for at fungere Webex Events møde (klassisk):

Opretbegivenhed, Indstilbegivenhed, Hentbegivenhed, Fåsessionsoplysninger, Sidste oversigtbegivenhed, Lstregeretbegivenhed, OversigtProgram, Overførbegivenhedsbillede

API'en vil svare på ny undtagelse 010106 Den klassiske begivenhed er blevet deaktiveret.

Skemaændringer

Ingen skemaændringer.

EKSEMPEL på API-anmodning og -svar

Opret Event API-anmodning og -svar

Anmodning om CreateEvent

<accessControl>
<sessionsadgangskode>XXXXXXXX</sessionsadgangskode>
</adgangskontrol>
<metaData>
<sessionsnavn>XMLAPI EC-test</sessionsnavn>
</metaData>
<planlæg>
<startdato>07/17/2021 01:29:15</startdato>
<åbningstid>15</åbningstid>
</planlæg>

Svar fra CreateEvent

<?xml version="1.0"-kodning="ISO-8859-1"?>
<serv:meddelelse 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:svar>
<serv:result>MISLYKKET</serv:result>
<serv:reason>Den klassiske begivenhed er blevet deaktiveret.</serv:reason>
<serv:gsbStatus>PRIMÆR</serv:gsbstatus>
<serv:exceptionID>010106</serv:exceptionID>
</serv:respons>
</serv:header>
<serv:krop>
<serv:bodyindhold/>
</serv:krop>

CreateEvent3.1.3 påvirker API'er:

• IndstilBegivenhed Hentbegivenhed

• GetSessionInfo

• LstsummaryEvent

• Lstregeretbegivenhed

• OversigtProgram

• OverførEventImage

XMLAPI Lst-mødetype vil besvare nyt element i delproduktkodepræfikset

Påvirket API'er

Aktuelt svarelementet for API Lst Meeting Type i produktionskodepræfikset: PRO, AUO og andre, der er foruddefinerede Webex-præfiks for mødetype.

Efter denne nye forbedring vil API reagere på nyt element i sub-Prodct-kodepræfikset:PRO1, PRO2 osv., som kan tilpasses mødetypefikset.

Skemaændringer i API: LstMødetype

Den vil svare på et nyt element: præfiks tilunderprodct-kode

EKSEMPEL på API-anmodning og -svar

API-anmodning og svar for Lst-mødetype

Anmodning om Lst-mødetype

<bodyIndhold xsi:type="java:com.webex.service.binding.meetingtype.Lst
Meeting Type">
<meetingTypeID>13810</meeting
Type-ID>
Content>

Svar for lst-mødetype

<serv:bodyIndhold xsi:type="mtgtype:lstMeetingTypeResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<mtgtype:matchingRecords>
<serv:i alt>1</serv:i alt>
<serv:returned>1</serv:returned>
<serv:startfra>1</serv:startfra>
</mtgtype:matchingRecords>

<mtgtype:produktkodepræfix>PRO</mtgtype:produktkodepræfiks>
<mtgtype:subProductCodePrefix>PRO3</mtgtype:subProductCodePrefix> //Nyt element for brugertilpasset mødetype
<mtgtype:active>AKTIVERET</mtgtype:active>
<mtgtype:name>Cus_chat_Lukket</mtgtype:navn>
<mtgtype:displayName>Cus_chat_Lukket</mtgtype:vistnavn>

Opdateringer til XML API 41.11.0

Klik her for at downloade XML API 41.11.0-skemaet.

UNDERSTØTTELSE af XML API forudkompatibilitet i brugeradministrations API for Control Hub-administrerede websteder

Påvirkede API'er og skemaændringer

Hvis din integrationsapplikation i øjeblikket bruger Webex XMLAPI-brugeradministrations-API'er: Opret, indstil bruger, del bruger, og få bruger til at klargøre eller administrere brugere, når dit klassiske Webex-websted er konverteret til Control Hub-administreret websted, vil disse API'er fortsat arbejde for viderekompatibilitet. Der er nogle adfærdsændringer som nævnt herunder:

• Når du bruger createUser – hvis brugerstatus i Control Hub ikke er "aktiv", vil brugerens status på webstedet ikke være aktiv. Hvis brugerstatus i Control Hub er aktiv , er brugerens status på-webstedet også aktiv. Brugerstatus for nye og konverterede brugere i Control Hub.

• Adgangskodeelementet i CreateUser og SetUser API'er vil blive ignoreret. Vi begynder at sende aktiverings-e-mail til nye brugere. Brugere kan klikke på linket i e-mailen for at aktivere en ny konto og indtaste ny adgangskode.

• Det aktive element i Opret bruger API ignoreres, ny bruger (kan ikke bekræftes) kan ikke aktiveres via denne parameter ved hjælp af API-indstillingsbruger.

• Værdien af webExId-elementet i bodyContent for CreateUser API'er skal være den samme som e-mail. Hvis web Ex-ID er anderledes end e-mail, behandler vi web Ex-ID'et på samme måde som e-mail, når det gemmes i Web DB, og værdien ignoreres.

• Værdien af web Ex-ID-elementet i brødindholdet i indstillede bruger-API'er skal være brugeridentiteten på e-mailadressen. Du kan ændre den ved hjælp af <e-mail> i brødindhold.

• SetUser API'en understøtter ændring af eksisterende brugers e-mailadresse: Det lykkes, hvis handlingskontoen i SecurityContext er Control Hub fuld webstedsadministrator. Ellers rapporterer API-fejl med ny fejlkode og meddelelse herunder:

  • 030120 Kontoen skal være en fuld webstedsadministrator for at ændre e-mail.

• Det nye elementWebExId i bodyContent af SetUser API vil blive ignoreret.

• SetUser API forsøger at ændre til en e-mail, der allerede er i brug, hæver API'en under den nye fejlkode og fejlmeddelelse:

  • 030118 E-mail bruges allerede i Control Hub-administrerede websteder.

• DelUser API deaktiverer brugeren på Webex-mødesiden, og den tilsvarende mødelicens fjernes fra Webex-webstedet. Denne deaktiverede bruger kan genaktiveres ved at bruge API: Indstil bruger (AKTIVERET), så længe brugeren er bekræftet før.

• CreateUser og SetUser API'erne giver ny fejlkode og fejlmeddelelse, som vist herunder:

  • 030117, Denne bruger findes uden for din organisation, så der skal gøres krav på, at du kan flytte ind i din organisation via kravbrugerprocessen. Få en vejledning i at gøre brugeren krav på din organisation i Gør krav på brugere til din organisation (Konverter brugere). Du skal bekræfte det domæne, som brugeren tilhører, før brugeren kan gøre krav på det.

  • 030119 CI-adgangstokenet skal omfatte webexsquare: administrator, når brugeren klargøres.

Skemaændringer

Ingen skemaændringer på disse API'er: Opret bruger, indstil bruger, del bruger, og hent.

EKSEMPEL på API-anmodning og -svar

Opret API-anmodning og -svar

API-anmodning:
<?xml version="1.0"-kodning="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:serv="http://www.webex.com/schemas/2002/06/service"
xsi:skemaPlacering="http://www.webex.com/schemas/2002/06/service http://www.webex.com/schemas/2002/06/service/service.xsd">
<sidehoved>
<sikkerhedKontekst>
<webstedsnavn>{webstedsnavn}</webstedsnavn>
<webExID>{webstedsadministrationskonto}</webExID>
<email>{webstedsadministrationskonto}</e-mail>
<sessionTicket>xxxx</sessionsbillet> eller eller
eller , når du bruger CI "accessToken", skal det omfatte anvendelsesområde webexsquare:admin ved klargøring af bruger
</sikkerhedKontekst>
</sidehoved>



<krop>

<webExId>Jack@qa.webex.com</webExId> --- det bør være brugeridentitet for e-mailadressen
<email>Jack@qa.webex.com</email>
<fornavn>Jack</fornavn>
<efternavn>Smith</efternavn>
<adgangskode>...</adgangskode>
<privilegium>
sand
</privilegium>
<active>AKTIVERET</active> – denne parameter kan ikke aktivere brugeren direkte, før brugeren selv aktiverer sig via aktiverings-e-mail.
</kropsindhold>



API-svareksempel:
<?xml version="1.0"-kodning="UTF-8"?>
<serv:meddelelse 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:svar>
<serv:result>GENNEMFØRT</serv:result>
<serv:gsbStatus>PRIMÆR</serv:gsbstatus>
</serv:respons>
</serv:header>
<serv:krop>
<serv:bodyIndhold xsi:type="use:createuser response" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<use:userId>23778617</use:userId>
</serv:bodyindhold>

Påvirker API'er:

• Opretbruger

• SetUser

• DelUser

XML API understøtter eksisterende kompatibilitet for videresendelse af brugerbekræftelse, efter Webex klassiske websted er konverteret til et Control Hub-administreret websted

Påvirket API'er

Når det klassiske Webex-websted er konverteret til et Control Hub-administreret websted, skal værdien af -elementet i være den samme som e-mail, detaljer nedenfor:

• For eksisterende brugere oprettet på det klassiske Webex-websted understøtter vi begge gamle webExID (For eksempel: Jack) og nyt webExID (indholdet er det samme som e-mail, eksempel: Jack@xx.com) når du logger ind, er denne bagudkompatibilitet med godkendelse for alle XML API'er.

• For nye brugere, der er oprettet på websteder, der administreres i Control Hub, skal værdien af webExID-elementet være den samme som e-mail for login.

{siteName}
{userName} –-- eksisterende brugere blev oprettet på webEx klassisk websted, det kan være: jack eller jack@xx.com; ny bruger skal bruge jack@xx.com
<sessionTicket>xxxx</sessionTicket> eller eller eller <access
Token>

Påvirker API'er:

Alle XML API'er.

Når det klassiske Webex-websted er konverteret til et Control Hub-administreret websted, skal værdien af <webEx-ID>-elementet <body> være den samme som e-mail, detaljer nedenfor:

• Opret: genererer værtspinkode , uanset at bruger-PMR er aktiveret eller ikke, når brugerrollen er vært eller administratorer med fuld eller skrivebeskyttet eller bruger-administration-websted.

• Indstil: indstiller værtspinkode ved brug af telefoner.værtspinkode , når personlig mødelokale.host-pinkode ikke er i XML-anmodning (forhåndsbetingelse: funktionen til/fra TilladStartPlanlagtMtg fra telefon er aktiveret).

• Hent: returnerer phones.host-pinkode uanset bruger-PMR er aktiveret eller ej. (forhåndsbetingelse: funktionen til/fra TilladStartPlanlagtMtg fra telefon er aktiveret).

Skemaændringer

Få brugersvar

Indstil:

Svareksemne

Få brugersvar

Indstil:

XMLAPI Get webstedssvar to nye elementer til mobilklient

Påvirket API'er

• Hent: Få websted svarer nu to nye elementer for at understøtte mobilklienten, der har logikken til at vise eller ikke vise optagelsesfanen.

  • Aktivér adgang til optagelse sand eller falsk, Webex-superadministratorer kan aktivere eller deaktivere optagelsesadgang ved hjælp af til/fra-knappen (Aktivér).

  • Opbevaring: sand eller falsk, hvis begge websteder ikke understøtter NBR-funktionen og tildeler NBR-lagerplads som nul, så er statussvaret sandt, ellers er forkert.

Skemaændringer

Prøveanmodning om Hent

Prøverespons for getsite

E-mailens emne, der har ikke-ASCII-tegn, vil blive kodet med RFC2047. I tilfælde af et rent ASCII-tegn e-mailens emne findes der ingen kodning

Der er ingen indvirkning på nogen API-anmodning eller nyttedata for svar, men den ændrer e-mailens kodeadfærd. Når e-mailens emne, der har ikke-ASCII tegn, vil blive kodet med RFC2047. I tilfælde af ren ASCII tegn e-mail emne, er der ingen kodning.

Skemaændringer

Der er ingen skemaændringer.

Opdateringer til XML API 41.4.0

Klik her for at downloade XML API 41.4.0-skemaet.

Opret begivenhed planlagt Webex Events kan udnytte webstedets standard ved ind- og udgangs tone

XMLAPI afstemmes med den aktuelle nye logik for at kontrollere ind- og udgang tone. Alle toner til Webex Events blev kontrolleret af en anden indstilling i webstedsadministration. I GetSitereturnerer XMLAPI et ekstra feltindtastningExitToneEC for at angive værdien. Når webstedsadministratoren oprindeligt indstiller en standard til tonen, vil opret begivenhed ikke udnytte denne indstilling ved at anvende XMLAPI-standardindstillingen.

Påvirket API'er

The XML API: Hent websted returnerer et nyt element indgangstone Exit Tone for at angive værdien.

The XML API: OpretBegivenhed, Indstil begivenhed, Hent begivenhed tilbage slutvirksomhedens logik læser værdien af ExitTone.

Skemaændringer

XML API: Få webstedssvareksempel:

<ns1:defaults>
<ns1:e-mailPåmindelser>sand</ns1:e-mailpåmindelser>
<ns1:entryExit Tone>ANGIV NAVN</ns1:entryExit Tone>
<ns1:entryExit ToneEC>NOTONE</ns1:entryExit ToneEC>
<ns1:voip>true</ns1:voip>
<ns1:telekonference>
<ns1:telefoniSupport>INGEN</ns1:telefoniSupport>
</ns1:telekonference>
<ns1:DeltagTeleconf DoNot Press1>true</ns1:Deltag Teleconf DoNot Press1>
<ns1:opdaterTSPA-konto>falsk</ns1:opdaterTSPA-konto>
</ns1:defaults>

Påvirker API'er:

• GetSite

• Opretbevent

• Indstilbelig

• Hentbevent

XMLAPI returnerer blot oplysninger om den store begivenhed (Webex Event 2.0)

1. Hvis Webex-mødet er den store begivenhed eller webcast, returnerer GetSessionInfo nogle detaljer, herunder mødeadgangskode, møde numerisk adgangskode, paneldelistadgangskode og paneldelterens numeriske adgangskode (intet skema ændres).

2. XMLAPI understøtter ikke oprettelse og redigering af nogen store begivenheder eller webcast-funktioner, så CreateMeeting og SetMeeting returnerer en ny undtagelse (110064, begivenheden og webcast-sessionstypen understøttes ikke.) til store begivenheder eller webcast-sager.

Virknings-API'er

Opdateringer til XML API 41.3.0

Klik her for at downloade XML API 41.3.0-skemaet.

Den XML API nye ændringer understøtter Webex Events 2.0 funktion

Påvirket API'er

Både API'erne: FåSessionsoplysninger og Få mødereturelementer aktivere begivenhed og aktivere Webniar.

Skemaændringer

Få sessionsoplysninger returnerer elementer til at aktivere begivenhed og aktivere Webniar til EC 2.0.

Få mødereturelementer aktivere Begivenhed og aktivér Webniar for EC 2.0.

Svareksempel:

Få sessionsoplysninger:

<ep:accessControl>
<ep:listStatus>PUBLIC</ep:list
Status>
<ep:registrering>false</ep:
<ep:adgangskodeReq>true</ep:adgangskode
Req Req
<ep:isGennemtving lydadgangskode>
<ep:isGennemtving lydlogin>false</ep:isGennemtving lydlogin>false</ep:is
Gennemtving begivenhed>false</ep:enableEvent>
<ep:enableWebniar>false</ep:enableWebniar>
<ep:enablePreMeeting Lobby>true</ep:EnablePreMeeting Lobby>

Få mødesvar:

<meet:supportPKI>false</meet:support
<meet:HQ video>true</meet:HQ video>
<meet:HD video>true</meet:HD video>
<meet:viewVideoThumbs>true</meet:viewVideothumbs>
<meet:enableEvent>false</meet:enableEvent>
<meet:enableWebniar>false</meet:enableWebniar>false
<meet:enablePreMeeting Lobby>true</meet:enablePreMeeting Lobby>
</meet:enablePre-meeting Lobby

De nye XMLAPI-ændringer understøtter lobbyfunktionen før mødet

Påvirket API'er

The XML API: Hent, Lst, Fåsessionsoplysninger og Get møde vil besvare det nye element aktivere Lobby før møde for lobby før mødet.

Skemaændringer

The XML API: Hent webstedets returelement aktivere Lobby før møde for lobby før mødet.

The XML API: Sidste oversigtssession returnerer element aktiverer Lobby før møde for lobby.

The XML API: Få Sessionsoplysninger tilbage, aktivér Lobby før møde for lobby før mødet.