Voor meer informatie over XML API 39 en XML API 11, zie het Cisco Webex Meetings XML API Updates Overzicht (XML API 39 en eerder).

Zie het artikel XML API Updates overzicht (XML API 40 en Cisco Webex Meetings later) voor meer informatie over XML API 40.

Ga naar Cisco DevNet voor updates voor XML API 11 SP9 en eerder.

API 41.12.0-updates

XML API 41.12.0 Updates

Klik hier om het XML API 41.12.0-schema tedownloaden.

XMLAPI blokkeert de planning Webex Events (Klassiek) en bewerkt volgens de siteconfig item van EnableClassicEvent dat onwaar is

Beïnvloede API's en wijzigingen in het schema

Als het selectievakje Klassieke gebeurtenis inschakelen op de configuratiepagina van de site niet waar is, ondersteunt deze site geen Webex Events (klassieke) vergaderingen meer.

Als het selectievakje ClassicEvent inschakelen niet waar is, belt u deze API's om deze Webex Events (klassiek) te gebruiken:

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

De API antwoordt op de nieuwe 010106 De klassiekegebeurtenis isuitgeschakeld.

Wijzigingen in het schema

Geen schemawijzigingen.

API-aanvraag en responsvoorbeeld

API-aanvraag en -respons maken

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>
</body>
</serv:message>

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>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 is van invloed op API's:

  • SetEvent GetEvent

  • GetSessionInfo

  • LstsummaryEvent

  • LstrecordedEvent

  • LstsummaryProgram

  • UploadEventImage

XMLAPI LstMeetingType reactiet op nieuw element van subProductCodePrefix

Beïnvloede API's

De API nu gebruiken LstMeetingType antwoordelement van productionCodePrefix: PRO, AUO en andere die voor Webex zijn gedefinieerd voor het voorvoegsel voor type meet.

Na deze nieuwe verbetering zal de API een reactie geven op het nieuwe element van subProdctCodePrefix:P RO1, PRO2, etc. die kunnen worden aangepast voorvoegsel voor type vergaderen.

Wijzigingen in het schema voor API: LstMeetingType

Het zal een reactie geven op nieuw element: subProdctCodePrefix

API-aanvraag en responsvoorbeeld

LstMeetingType API-aanvraag & antwoord

Verzoek van LstMeetingType

<bodyContent xsi:type="java:com.webex.service.binding.meetingtype.LstMeetingType">
    <meetingTypeID>13810</meetingTypeID>
</bodyContent>
</body>
</serv:message>

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>       //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-updates

XML API 41.11.0 Updates

Klik hier om het XML API 41.11.0-schema tedownloaden.

XML API-ondersteuning forward compatibility in gebruikersbeheer-API voor door Control Hub beheerde sites

Beïnvloede API's en wijzigingen in het schema

Als uw integratietoepassing momenteel Webex XMLAPI gebruikersbeheer-API's gebruikt: CreateUser, SetUser, DelUser en GetUser voor het inrichten of beheren van gebruikers. Nadat uw Klassieke Webex-site is geconverteerd naar een beheerde Control Hub-site, blijven deze API's werken voor voorwaartse compatibiliteit. Er zijn gedragwijzigingen die hieronder worden vermeld:

  • Wanneer createUser wordt gebruikt- als de gebruikersstatus in Control Hub niet 'actief' is, is de status van de gebruiker opde site niet actief. Als de gebruikersstatus in Control Hub actief is, is de status van de gebruiker op de site ook actief, naslag: Gebruikersstatus van nieuwe en geconverteerde gebruikers in Control Hub.

  • Het wachtwoordelement van CreateUser en SetUser API's wordt genegeerd. We beginnen met het verzenden van een activeringse-mail naar nieuwe gebruikers, gebruikers kunnen op de koppeling in de e-mail klikken naar een actieve nieuwe account en een nieuw wachtwoord invoeren.

  • Het actieve element van CreateUser API wordt genegeerd, een nieuwe gebruiker (niet geverifieerd) kan niet worden geactiveerd met deze parameter met API SetUser.

  • De waarde van het WebExId-element in de bodyContent van CreateUser API's moet gelijk zijn aan e-mail. Als WebExId verschilt van e-mail , behandelen we webExId hetzelfde als e-mail wanneer deze wordt opgeslagen in WebDB en wordt de waarde genegeerd.

  • De waarde van het webExId-element in de bodyContent vanSetUser API'smoet de gebruikersidentiteit van het e-mailadres zijn. U kunt dit wijzigen met behulp van e-> in bodyContent.

  • De SetUser API ondersteunt het wijzigen van bestaande e-mailadressen van gebruikers: het is gelukt als de bewerkingsaccount in de Beveiligingscontext de volledige sitebeheerder van Control Hub is. Anders geeft de API-rapporten een foutmelding met een nieuwe foutcode en onderstaand bericht:

    • 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 SetUser API probeert een e-mailadres te wijzigen dat al in gebruik is. De API zet de onderstaande nieuwe foutcode en de volgende foutmelding op:

    • 030118-mail wordt al gebruikt in door Control Hub beheerde sites.

  • De DelUser API deactiveert de gebruiker aan de kant van de Webex-vergadering en de overeenkomstige vergaderingslicentie wordt verwijderd van de Webex-site. Deze gedeactiveerde gebruiker kan opnieuw worden geactiveerd met behulp van de API: StelUser <active></active>(geactiveerd) in zolang de gebruiker vóór is geverifieerd.

  • De CreateUser en SetUser API's verhogen nieuwe foutcode en foutmelding op zoals hieronder weergegeven:

    • 030117 bestaat deze gebruiker buiten uw organisatie, dus moet deze worden geclaimd, om via het gebruikersproces voor claimen naar uw organisatiete kunnen gaan. Voor stappen voor het claimen van de gebruiker in uw organisatie, zie Gebruikers claimen bij uw organisatie (Gebruikers converteren). U moet het domein verifiëren waar de gebruiker bij hoort voordat u de gebruiker claimt.

    • 030119 het CI-toegangs token moet het bereik webexsquare bevatten: beheerder bij het inrichten van de gebruiker.

Alleen voor een beperkte periode wordt de voorwaartse compatibiliteit ondersteund. We zullen u een geavanceerde melding geven voordat deze compatibiliteit wordt verwijderd.

Wijzigingen in het schema

Geen wijzigingen in het schema voor deze API's: CreateUser, SetUser, DelUser en GetUser.

API-aanvraag en responsvoorbeeld

CreateUser API request & response

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's beïnvloeden:

  • CreateUser

  • SetUser

  • DelUser

XML-API ondersteunt de compatibiliteit voor doorsturen van bestaande gebruikers nadat de klassieke Webex-site is geconverteerd naar een beheerde Control Hub-site

Beïnvloede API's

Nadat de klassieke Webex-site is geconverteerd naar een beheerde Control Hub-site, moet de waarde van het element in hetzelfde zijn als e-mail. <webExID> <securityContext> Onderstaande details:

  • Voor bestaande gebruikers die zijn gemaakt op de klassieke Webex-site, ondersteunen we zowel de oude WebExID (bijvoorbeeld: Jack) en nieuwe webExID (de inhoud is hetzelfde als e-mail, bijvoorbeeld: Jack@xx.com) voor aanmelden, is deze verificatie achterwaartse compatibiliteit voor alle XML-API's.

  • Voor nieuwe gebruikers die zijn gemaakt in door Control Hub beheerde sites, moet de waarde van het WebExID-element gelijk zijn aan het e-mailadres voor aanmelding.


<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's beïnvloeden:

Alle XML-API's.

Nadat de klassieke Webex-site is geconverteerd naar een door Control Hub beheerde site, moet de waarde van element bodyContent > gelijk zijn aan het e-mailadres. <webExID> Onderstaande details:

  • Voor bestaande gebruikers die zijn gemaakt op de klassieke Webex-site, ondersteunen we zowel oude webExId(bijvoorbeeld: Jack) en nieuwe webExId (de inhoud is hetzelfde als e-mail, bijvoorbeeld: Jack@xx.com) in bodyContent.

  • Voor nieuwe gebruikers die zijn gemaakt in door Control Hub beheerde sites, moet de waarde van het WebExId-element gelijk zijn aan het e-mailadres in 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's beïnvloeden:GetUser, SetUser en DelUser.

Wijzigingen in het schema

Geen wijzigingen in het schema voor API's.

API-aanvraag en responsvoorbeeld

GetUser API-verzoek & antwoord

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

Verbetering van de GESCHIEDENISrapport-API voor opnamenweergave ter ondersteuning in Webex Meetings, Webex Events (Nieuw) en Webex Events (Klassiek)

Beïnvloede API's

Huidige API: lstrecordaccessHistory en lstrecordaccessDetailHistory ondersteunt alleen Webex Trainings-opnameweergave toegangsgeschiedenisrapport. De nieuwe verbetering ondersteunt Webex Meetings, Webex Events (nieuw) en Webex Events (klassiek) opnameweergavetoegangsgeschiedenisrapport.

Wijzigingen in het schema

We ondersteunen het onderstaande nieuwe schema in API lstrecordaccessHistory in de API-verzoek hoofdinformatie:

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

Details

De API: lstrecordaccessHistory kan de toegangsgeschiedenis voor opnamen voor opnames Webex Meetings, Webex Events (nieuw), Webex Events (klassiek) en Webex-trainingen retourneren.

  • Als er geen serviceType is opgegeven in de API-aanvraag, wordt de API van lstrecordaccessHistory retourneert alleen de opname van Webex Trainingstoegangsgeschiedenis.

  • Als het serviceType MeetingCenter is, wordt de API van lstrecordaccessHistory retourneert de Webex Meetings en Webex Events (nieuwe) opnameweergave die toegang heeft tot de geschiedenis.

  • Als het serviceType EventCenter is, wordt de API van lstrecordaccessHistory retourneert Webex Events (klassieke) opnameweergavetoegangsgeschiedenis.

De API: lstrecordaccessDetailHistory kan gegevens retourneren door recordID van Webex Meetings, Webex Events (nieuw), Webex Events (klassiek) en Webex-trainingen.

API-aanvraag en responsvoorbeeld

lstrecordaccessHistory Api's verzoek en antwoord

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
            <webExID>{userName}</webExID>
            <password>{password}</password>          
            <siteName>{siteName}</siteName>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.history.LstrecordaccessHistory">
            <viewTimeScope>
                <viewTimeStart>9/20/2021 00:00:00</viewTimeStart>
                <viewTimeEnd>9/28/2021 23:59:59</viewTimeEnd>
            </viewTimeScope>
            <listControl>
                <startFrom>1</startFrom>
                <maximumNum>100</maximumNum>
            </listControl>
            <order>
                <orderBy>RECORDID</orderBy>
                <orderAD>ASC</orderAD>
            </order>
            <serviceTypes>
                <serviceType>MeetingCenter</serviceType>
                <serviceType>TrainingCenter</serviceType>
                <serviceType>EventCenter</serviceType>
            </serviceTypes>
        </bodyContent>
    </body>
</serv:message>

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:history="http://www.webex.com/schemas/2002/06/service/history">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="history:lstrecordaccessHistoryResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <history:recordAccessHistory>
                <history:recordID>1XXXXXXX7</history:recordID>
                <history:recordName>LstrecordaccessHistory test TC-20210924 1324-1</history:recordName>
                <history:creationTime>09/24/2021 13:28:13</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>2</history:downloaded>
                <history:viewed>1</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:recordAccessHistory>
                <history:recordID>1XXXXXXX7</history:recordID>
                <history:recordName>TestErollment_001-20210610 1905-1</history:recordName>
                <history:creationTime>06/10/2021 19:10:15</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>0</history:downloaded>
                <history:viewed>3</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:recordAccessHistory>
                <history:recordID>1XXXXXXX7</history:recordID>
                <history:recordName>Test instant playback 2-20210705 0709-1</history:recordName>
                <history:creationTime>07/05/2021 07:15:06</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>0</history:downloaded>
                <history:viewed>1</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:recordAccessHistory>
                <history:recordID>1XXXXXXX7</history:recordID>
                <history:recordName>EC2.0_232423-20210922 0447-1</history:recordName>
                <history:creationTime>09/22/2021 04:53:05</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>0</history:downloaded>
                <history:viewed>1</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:recordAccessHistory>
                <history:recordID>1XXXXXXX7</history:recordID>
                <history:recordName>LstrecordaccessHistory test EC2.0-20210924 1315-1</history:recordName>
                <history:creationTime>09/24/2021 13:19:00</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>1</history:downloaded>
                <history:viewed>1</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:recordAccessHistory>
                <history:recordID>1XXXXXXX7</history:recordID>
                <history:recordName>LstrecordaccessHistory test MC-20210924 1319-1</history:recordName>
                <history:creationTime>09/24/2021 13:25:12</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>1</history:downloaded>
                <history:viewed>1</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:recordAccessHistory>
                <history:recordID>1XXXXXXX7</history:recordID>
                <history:recordName>LstrecordaccessHistory test EC classic-20210924 1331-1</history:recordName>
                <history:creationTime>09/24/2021 13:37:28</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>1</history:downloaded>
                <history:viewed>1</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:matchingRecords>
                <serv:total>8</serv:total>
                <serv:returned>7</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </history:matchingRecords>
        </serv:bodyContent>
    </serv:body>
</serv:message>

lstrecordaccessDetailHistory Api's verzoek en antwoord

<?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's beïnvloeden:

  • lstrecordaccessHistory

  • lstrecordaccessDetailHistory

Los het gat op van de maximaal toegestane Webex Events beschrijvingslengte (Klassiek) tussen XMLAPI en Webex Page.

Beïnvloede API's

De XML-API: CreateEvent and SetEvent's element van beschrijving is max. 10000 tekens invoer, als over grootte invoer, zal dit resulteren in de nieuwe foutcode en bericht:

060068 beschrijving van niet-weergegeven invoer. Deze beschrijving mag niet langer zijn dan 10.000 tekens.

Wijzigingen in het schema

Geen schemawijziging.

API-aanvraag en responsvoorbeeld

API-aanvraag en -respons maken

#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's beïnvloeden:

  • CreateEvent

  • SetEvent

XML-API: GetUser retourneert nieuw element van gratis account

Beïnvloede API's

GetUser retourneert een nieuw element dat freeAccount de gebruikersaccount is FreeAccount of niet.

Wijzigingen in het schema

Voorbeeld van getUser-antwoord


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's beïnvloeden:

GetUser

API 41.10.0-updates

Er zijn geen wijzigingen in het XML API 41.10.0-schema.

API 41.9.0-updates

XML API 41.9.0 Updates

Klik hier om het XML API 41.9.0-schema te downloaden.

XML-API 10.0.0 voor alle T31-sites de actieve tijd niet actief

Webex wil de ondersteuning voor XML API ver 10.0.0 voor alle T31-sites beëindigen.

De XML API 10.0.0-code van alle a xml wordt tijdens de update van 41.9.0 niet meer mogelijk gemaakt.

API 41.8.0-updates

XML API 41.8.0 Updates

Klik hier om het XML API 41.8.0-schema tedownloaden.

XML-API 10.0.0 voor alle T31-sites de actieve tijd niet actief

Webex wil de ondersteuning voor XML API ver 10.0.0 voor alle T31-sites beëindigen.

Webex heeft een aantal klanten gevonden die op een onjuiste manier toegang krijgen tot de URL van XML API als: https://{siteName}.webex.com/WBXService/xml10.0.0/XMLService is de juiste manier om de XML API-URL te openen als: https://{siteName}.webex.com/WBXService/XMLService.

Schakel op de juiste manier naar de XML API voor toegang tot uw code om dit te voorkomen voordat de XML API-versie 10.0.0 niet meer wordt ondersteund.

API 41.7.0-updates

XML API 41.7.0 Updates

Klik hier om het XML API 41.7.0-schema tedownloaden.

Mobiele opname verwijderen en bewerken moet worden beheerd door de sitebeheeroptie: Hosts toestaan opnamen opnieuw toe te toewijzen, te bewerken, uit te schakelen en te verwijderen

Beïnvloede API's en wijzigingen in het schema

GetSite: gaat nieuwe naamelementen retourneren enableNBRMCModify en separateNoRecordingEdit onder hulpmiddelen.

Voorbeeld van antwoord

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-updates

XML-API 41.6.3-updates

Klik hier om het XML API 41.6.3-schema tedownloaden.

GetSite Nieuw antwoordelement van supportLargeEvent

Beïnvloede API's en wijzigingen in het schema

GetSite: retourneert nieuwe elementen naamgeving supportLargeEvent onder siteCommonOptions om de beller te laten weten of de site een grote gebeurtenis ondersteunt (Webex Event (nieuw)) of niet.

Schemawijziging

Voorbeeld van antwoord

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-updates

XML API 41.6.0-updates

Klik hier om het XML API 41.6.0-schema tedownloaden.

XMLAPI-Webex Events 2.0 in de inrichting

Beïnvloede API's

GetUser: retourneert nieuwe elementnaam largeEventCapacity waarin de capaciteit van het nieuwe evenement 2.0 (EC 2.0) wordt onder deze gebruikersaccount. Als de gebruikersaccount bijvoorbeeld een_EC3K-licentie heeft, wordt de waarde van largeEventCapacity is 3000.

Wijzigingen in het schema

Voorbeeld van antwoord

GetUserResponse:

CreateTime van XMLAPI LstRecording is van toepassing op de begintijd van de opname

Beïnvloede API's

LstRecording: LstRecording Reactie CreateTime zoals het moment waarop de gebruiker daadwerkelijk op de opnameknop drukt.

Details

In het verleden gebruikte de XML-API tijdstempel wanneer de opname in de database werd gemaakt als aangemaakte tijd in LstRecording Reactie. Het is nu de tijd dat de gebruiker daadwerkelijk begint met het maken van de opname. Deze wijziging is van toepassing op alle service-opnamen. Er is geen schemawijziging.

API 41.5.0-updates

XML API 41.5.0 Updates

Klik hier om het XML API 41.5.0-schema tedownloaden.

XMLAPI kan geplande Webex-vergaderingen starten vanaf PSTN host

Beïnvloede API's

  • CreateUser: genereert hostPIN ongeacht of gebruikersaccounts PMR ingeschakeld of niet als de gebruikersrol host of volledig of alleen-lezen is of sitebeheerders met gebruikersbeheer.

  • SetUser: sets hostPIN Gebruik phones.hostPIN Wanneer personalMeetingRoom.hostPIN is niet in XML-verzoek (voorwaarde: functieschakelaar AllowStartScheduledMtgFromPhoneis ingeschakeld).

  • GetUser: retourneert phones.hostPIN ongeacht of PMR is ingeschakeld of niet. (voorwaarde: functieschakelaar AllowStartScheduledMtgFromPhone is ingeschakeld).

Wijzigingen in het schema

GetUserResponse:

SetUser:

Voorbeeld van antwoord

GetUserResponse:

SetUser:

XMLAPI GetSite antwoord twee nieuwe elementen voor de mobiele client

Beïnvloede API's

  • GetSite: GetSite antwoordt nu twee nieuwe elementen voor ondersteuning van mobiele client heeft de logica voor het wel of niet weergeven van het tabblad Opname.

    • enableRecordingAccess: true of false, de Webex-hoofdbeheerders kunnen opnametoegang met de schakelaar in- of uitschakelen. EnableRecordingAccesses).

    • storageEmptyStatus: true of false, als beide sites de NBR-functie niet ondersteunen en de NBR-opslagruimte als nul hebben toegewezen, is het andere statusreactie waar.

Wijzigingen in het schema

Voorbeeld van een aanvraag voor GetSite

Voorbeeld van een respons voor Getsite

E-mailonderwerp met niet-ASCII-tekens wordt gecodeerd met RFC2047. Als er een e-mailonderwerp met een asCII-teken bestaat, is er geen codering

Beïnvloede API's

Er zijn geen gevolgen voor een API-aanvraag, de reacties van payload, maar het codeergedrag van het e-mailonderwerp wordt gewijzigd. Als het onderwerp van de e-mail met niet-ASCII-tekens wordt gecodeerd met RFC2047. Als er een e-mailonderwerp met een asCII-teken is, is er geen codering.

Wijzigingen in het schema

Er zijn geen schemawijzigingen.

API 41.4.0-updates

XML API 41.4.0 Updates

Klik hier om het XML API 41.4.0-schema tedownloaden.

Geplande gebeurtenis maken Webex Events standaardinstellingen op siteniveau gebruiken voor de toon voor bij binnenkomst en vertrek

XMLAPI is afgestemd op de huidige nieuwe logica voor het beheren van de toon voor binnenkomst en vertrek. Alle tonen voor Webex Events zijn beheerd door een andere instelling in Sitebeheer. In GetSite, XMLAPI geeft een extra veld weer entryExitToneEC om de waarde aan te geven. Wanneer de sitebeheerder oorspronkelijk een standaardtoon heeft ingesteld, zal Het maken van Gebeurtenis deze instelling niet gebruiken door de XMLAPI-standaard toe te passen.

Beïnvloede API's

De XML-API: GetSite retourneert één nieuw element entryExitToneEC om de waarde aan te geven.

De XML-API: CreateEvent, SetEvent, GetEvent back end bedrijfslogica leest de waarde van entryExitToneEC.

Wijzigingen in het schema

XML-API: Voorbeeld getSite-respons:

<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's beïnvloeden:

  • GetSite

  • Vent maken

  • InstellenEvent

  • GetEvent

XMLAPI geeft zojuist de grote gebeurtenisdetails (Webex Event 2.0) weer

  1. Als de Webex Meeting de grote gebeurtenis of webcast is, GetSessionInfo geeft enkele gedetailleerde gegevens weer, waaronder het vergaderwachtwoord, het numerieke wachtwoord voor de vergadering, het wachtwoord voor panelleden en numeriek panellidwachtwoord (er wordt geen schema gewijzigd).

  2. XMLAPI biedt geen ondersteuning voor het maken en bewerken van grote gebeurtenissen of webcasts, dus CreateMeeting en SetMeeting retourneer een nieuwe uitzondering (110064 gebeurtenis- en webcast-sessietype niet ondersteund.) voor grote gebeurtenis of webcastcase.

Impact API's

API-naam

Beschrijving

Opmerking

GetSessionInfo

Als de Webex Meeting de grote gebeurtenis of webcast is, GetSessionInfo retourneert vergaderingwachtwoord, numeriek wachtwoord voor vergadering, wachtwoord voor panelleden en numeriek panellidwachtwoord.

Er wordt geen schema gewijzigd.

CreateMeeting

SetMeeting

Als de gebruiker het CreateMeeting api om een gesprek Webex Meeting grote gebeurtenisgebeurtenissen sessietype gebeurtenissen of bellen SetMeeting Als u een gebeurtenis Webex Meeting grote gebeurtenis of webcast wilt bewerken, retournt u een nieuwe uitzondering 110064. De gebeurtenis- en sessietype worden niet ondersteund.

Gedrag wordt gewijzigd.

API 41.3.0-updates

XML API 41.3.0-updates

Klik hier om het XML API 41.3.0-schema tedownloaden.

De nieuwe XML-API-wijzigingen ondersteunen Webex Events 2.0-functie

Beïnvloede API's

De API's beide: GetSessionInfo en GetMeeting retourelementen enableEvent en enableWebniar Te.

Elementnaam

Beschrijving

Event inschakelen

Ondersteunt EC 2.0 in een Webex-vergadering

webniar inschakelen

Ondersteunt Webinar in een Webex-vergadering

XMLAPI-ondersteuning keert terug naar twee elementen voor EC 2.0. De huidige XML API-release biedt geen ondersteuning voor het plannen en instellen van EC2.0-vergadering.

Wijzigingen in het schema

GetSessionInfo retourneert elementen enableEvent en enableWebniar voor EC 2.0.

GetMeeting retourneert elementen enableEvent en enableWebniar voor EC 2.0.

Responsvoorbeeld:

GetSessionInfo Reactie:

<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 Reactie:

  <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>

De nieuwe XMLAPI-wijzigingen ondersteunen de lobbyfunctie vóór de vergadering

Beïnvloede API's

De XML-API: GetSite, LstSummarySession, GetSessionInfo en GetMeeting zal het nieuwe element respons enablePreMeetingLobby voor de lobby vóór de vergadering.

Wijzigingen in het schema

De XML-API: GetSite Element retourneren enablePreMeetingLobby voor de lobby vóór de vergadering.

De XML-API: LstSummarySession Element retourneren enablePreMeetingLobby voor de lobby vóór de vergadering.

De XML-API: GetSessionInfo Element retourneren enablePreMeetingLobby voor de lobby vóór de vergadering.

De XML-API: GetMeeting Element retourneren enablePreMeetingLobby voor de lobby vóór de vergadering.

Responsvoorbeeld:

GetSite Reactie:

<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 Reactie:

<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 Reactie:

<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 Reactie:

<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>

De XML-API GetSite reactiegegevens gedrag veranderen openbaar maken

Beïnvloede API's

De XML-API: GetSite alleen antwoord hieronder elementen voor beheerdersaccount, die rollen bevatten: 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 de beheerdersrol toestaan, heeft responslicentiegegevens van GetSite. Host of deelnemer ontvangt deze licentiegegevens niet in GetSite Reactie.

Hieronder vindt u API: GetSite's antwoordvoorbeeld voor siteadmin of alleen-gereed siteadmin of beheerder van gebruikersbeheer:

API 41.2.0-updates

XML API 41.2.0 Updates

Klik hier om het XML API 41.2.0-schema tedownloaden.

XMLAPI moet 'voip hybride CMR bieden' als de site Webex-telefonie ondersteunt

Beïnvloede API's

  • GetSite retourneert een nieuw element IsWebexTelephony in het antwoord.

  • CreateUser en SetUser kunt u de cmrHybridVoip element indien IsWebexTelephony is waar, samen met andere voorwaarden. IsTSPUsingTelephonyAPI bestaat niet meer.

Wijzigingen in het schema

XML-API: GetSite antwoord retourneert een extra element IsWebexTelephony

GetSite van de respons dit nieuwe element op:

<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 ondersteunt EC2.0

XML-API's worden beïnvloed

LstSummarySession gaat de nieuwe twee elementen terug naar de ondersteuning van EC 2.0

Elementnaam

Beschrijving

Event inschakelen

Ondersteunt EC 2.0 in een Webex-vergadering

webniar inschakelen

Ondersteunt Webinar in een Webex-vergadering

Wijzigingen in het schema

XML-API: LstSummarySession: < enableEvent> en enableWebniar> elementen

Reactie van XML-API: LstSummarySession

Reactie op EC 2.0

<ep:isNextUpcomingInstance>true</ep:isNextUpcomingInstance>

                <ep:seriesMeetingKey>0</ep:seriesMeetingKey>
                <ep:isScheduledPMR>false</ep:isScheduledPMR>
                <ep:enableEvent>true</ep:enableEvent>
                <ep:enableWebniar>true</ep:enableWebniar>
            </ep:session>

XMLAPI ondersteunt om sitegebruiker terug te keren Webex-voice-assistant optie voor MCT-integratie

Beïnvloede API

GetUser retourneert een nieuw element webexAssistantEnabled(true of false) in het antwoord.

Wijzigingen in het schema

getUserResponse:

Voorbeeld van antwoord

API 41.1.0-updates

Er zijn geen wijzigingen in het XML API 41.1-schema.