Chat with Us!

XML API 11.0.0 SP5 Release Notes

Important: The XML API 11.0.0 SP5 release changes some schema definitions. For the latest schema definitions, see the release notes announcements page. The features in this release are backward compatibility with previous releases.
 

 

Overview

This release note describes the changes made in the release of WebEx XML API 11.0.0 SP5. These changes apply to your integration with WBS 32.
All features are backward compatible with existing integrations. There are changes to the latest schema definitions explained below.

 
 


New value defaultSequence in API GetSessionInfo

The API GetSessionInfo now returns a new value defaultSequence when the phone number is set in the user profile. It can be 0 or 1 (indicating first number or second number) when the value globalNum/default is True.

Meeting setup audio preferences

In order for this new API to be used, the site administration setting “Allow access to teleconference via global call-in numbers” must be enabled for the user.

Site Admin allow teleconference settings

If the host does not set a default call-in number for the session, the site default is used instead.

Site Admin default call-in

Note: This change only affects version WBS32/XMLAPI11.0.0.

APIs impacted

GetSessionInfo response has a new return value defaultSequence. The request is unchanged.

 

Schema changes

GetSessionInfo request: unchanged

GetSessionInfo response: see below:

GetSessionInfo_Response_DefaulSequence

 

Sample response

...
<serv:globalNum>
    <serv:countryAlias>United States of America</serv:countryAlias>
    <serv:phoneNumber>10224462261</serv:phoneNumber>
    <serv:tollFree>true</serv:tollFree>
    <serv:default>false</serv:default>
</serv:globalNum>
<serv:globalNum>
    <serv:countryAlias>Taiwan Toll</serv:countryAlias>
    <serv:phoneNumber>1111111111</serv:phoneNumber>
    <serv:tollFree>false</serv:tollFree>
    <serv:default>true</serv:default>
    <serv:defaultSequence>0</serv:defaultSequence>
</serv:globalNum>
<serv:globalNum>
    <serv:countryAlias>Taiwan Toll-free</serv:countryAlias>
    <serv:phoneNumber>2222222222</serv:phoneNumber>
    <serv:tollFree>true</serv:tollFree>
    <serv:default>true</serv:default>
    <serv:defaultSequence>1</serv:defaultSequence>
</serv:globalNum>
<serv:globalNum>
    <serv:countryAlias>Uganda Toll</serv:countryAlias>
    <serv:phoneNumber>3333333333</serv:phoneNumber>
    <serv:tollFree>false</serv:tollFree>
    <serv:default>false</serv:default>
</serv:globalNum>
...

Known Issues

None

 


Permanently delete recordings bypassing the recycle bin

By customer request, the API DelRecording now has the ability to permanently delete a recording bypassing the recycle bin using the element deletePermanently. This new element can be set to True if the recording must be deleted permanently, bypassing the recycle bin. The element has a default value of False and is optional.

 

APIs impacted

DelRecording

Note: Applies to both XML API 10.0 SP17 and XML API 11.0 SP5.

 

Schema changes

DelRecording

Schema changes to delRecording

 

Behavior Changed

The DelRecording API includes an element which can be set to True if the recording must be deleted permanently, bypassing the recycle bin. The element has a default value of False and is optional.

 

Design

A sample request for DelRecording API is as follows:

<?xml version="1.0" encoding="ISO-8859-1"?>

<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:serv="http://www.webex.com/schemas/2002/06/service">

        <header>

                <securityContext>

                        <webExID>user</webExID>

                        <password>password</password>

                        <siteID>853404</siteID>

                </securityContext>

        </header>

        <body>

                <bodyContent xsi:type="java:com.webex.xmlapi.service.binding.ep.DelRecording">

                        <recordingID>9740658</recordingID>

                        <deletePermanently>true</deletePermanently>

                </bodyContent>

        </body>

</serv:message>

Known Issues

None

 


LstmeetingusageHistory and LsteventsessionHistory now return internal call-out and international call-in details

By customer request, internal call-out and international call-in details are now part of the XML response for these APIs:

  • LstmeetingusageHistory
  • LsteventsessionHistory
  • Both APIs now include two additional elements in the response:

    • totalCallOutInternal
    • totalCallInInternational

     

    Schema changes

    LstmeetingUsageHistory:

    <!--Meeting Center usage history-->

     <xsd:complexType name="meetingUsageHistoryInstanceType">

     <xsd:complexContent>

     <xsd:extension base="serv:bodyContentType">

     <xsd:sequence>

     <xsd:element name="sessionKey" type="xsd:long" minOccurs="0"/>

     <xsd:element name="confName" type="xsd:string" minOccurs="0"/>

     <xsd:element name="meetingStartTime" type="xsd:string" minOccurs="0"/>

     <xsd:element name="meetingEndTime" type="xsd:string" minOccurs="0"/>

     <xsd:element name="duration" type="xsd:long" minOccurs="0"/>

     <xsd:element name="timezone" type="com:timeZoneType" minOccurs="0"/>

     <xsd:element name="timeZoneID" type="xsd:long" default="-1" minOccurs="0"/>

     <xsd:element name="timeZoneWithDST" type="xsd:string" minOccurs="0"/>

     <xsd:element name="trackingCode" type="com:trackingType" minOccurs="0"/>

     <xsd:element name="meetingType" type="xsd:string" minOccurs="0"/>

     <xsd:element name="hostWebExID" type="xsd:string" minOccurs="0"/>

     <xsd:element name="hostName" type="xsd:string" minOccurs="0"/>

     <xsd:element name="hostEmail" type="xsd:string" minOccurs="0"/>

     <xsd:element name="totalCallInMinutes" type="xsd:long" minOccurs="0"/>

     <xsd:element name="totalPeopleMinutes" type="xsd:long" minOccurs="0"/>

     <xsd:element name="totalCallInTollfreeMinutes" type="xsd:long" minOccurs="0"/>

     <xsd:element name="totalCallOutDomestic" type="xsd:long" minOccurs="0"/>

     <xsd:element name="totalCallOutInternational" type="xsd:long" minOccurs="0"/>

     <xsd:element name="totalCallOutInternal" type="xsd:long" minOccurs="0"/>

     <xsd:element name="totalCallInInternational" type="xsd:long" minOccurs="0"/>

     <xsd:element name="totalVoipMinutes" type="xsd:long" minOccurs="0"/>

     <xsd:element name="userID" type="xsd:integer" minOccurs="0"/>

     <xsd:element name="totalParticipants" type="xsd:integer" minOccurs="0"/>

     <xsd:element name="totalParticipantsVoip" type="xsd:int" minOccurs="0"/>

     <xsd:element name="totalParticipantsCallIn" type="xsd:integer" minOccurs="0"/>

     <xsd:element name="totalParticipantsCallOut" type="xsd:integer" minOccurs="0"/>

     <xsd:element name="confID" type="xsd:long" minOccurs="0"/>

     <xsd:element name="peakAttendee" type="xsd:long" minOccurs="0"/>

     <xsd:element name="assistService" type="serv:meetingAssistType" minOccurs="0"/>

     </xsd:sequence>

     </xsd:extension>

     </xsd:complexContent>

     </xsd:complexType>

     

    LsteventsessionHistory 

    <xsd:complexType name="eventSessionHistoryInstanceType">

     <xsd:complexContent>

     <xsd:extension base="serv:bodyContentType">

     <xsd:sequence>

     <xsd:element name="confID" type="xsd:long" minOccurs="0"/>

     <xsd:element name="sessionKey" type="xsd:long" minOccurs="0"/>

     <xsd:element name="confName" type="xsd:string" minOccurs="0"/>

     <xsd:element name="sessionStartTime" type="xsd:string" minOccurs="0"/>

     <xsd:element name="sessionEndTime" type="xsd:string" minOccurs="0"/>

     <xsd:element name="duration" type="xsd:int" minOccurs="0"/>

     <xsd:element name="timezone" type="xsd:long" minOccurs="0"/>

     <xsd:element name="timeZoneID" type="xsd:long" default="-1" minOccurs="0"/>

     <xsd:element name="timeZoneWithDST" type="xsd:string" minOccurs="0"/>

     <xsd:element name="trackingCode" type="com:trackingType" minOccurs="0"/>

     <xsd:element name="meetingType" type="xsd:string" minOccurs="0"/>

     <xsd:element name="userID" type="xsd:int" minOccurs="0"/>

     <xsd:element name="hostWebExID" type="xsd:string" minOccurs="0"/>

     <xsd:element name="hostName" type="xsd:string" minOccurs="0"/>

     <xsd:element name="hostEmail" type="xsd:string" minOccurs="0"/>

     <xsd:element name="totalPeopleMinutes" type="xsd:int" minOccurs="0"/>

     <xsd:element name="totalCallInMinutes" type="xsd:int" minOccurs="0"/>

     <xsd:element name="totalCallInTollfreeMinutes" type="xsd:int" minOccurs="0"/>

     <xsd:element name="totalCallOutDomestic" type="xsd:int" minOccurs="0"/>

     <xsd:element name="totalCallOutInternational" type="xsd:int" minOccurs="0"/>

     <xsd:element name="totalCallOutInternal" type="xsd:long" minOccurs="0"/>

     <xsd:element name="totalCallInInternational" type="xsd:long" minOccurs="0"/>

     <xsd:element name="totalVoipMinutes" type="xsd:int" minOccurs="0"/>

     <xsd:element name="totalParticipants" type="xsd:int" minOccurs="0"/>

     <xsd:element name="totalParticipantsVoip" type="xsd:int" minOccurs="0"/>

     <xsd:element name="totalParticipantsCallIn" type="xsd:integer" minOccurs="0"/>

     <xsd:element name="totalParticipantsCallOut" type="xsd:integer" minOccurs="0"/>

     <xsd:element name="source" type="history:sourceType" minOccurs="0"/>

     <xsd:element name="peakAttendee" type="xsd:long" minOccurs="0"/>

     <xsd:element name="assistService" type="serv:meetingAssistType" minOccurs="0"/>

     </xsd:sequence>

     </xsd:extension>

     </xsd:complexContent>

     </xsd:complexType>

     

    Behavior Changed

    The LstmeetingusageHistory and LsteventsessionHistory API include two additional elements in the response, namely totalCallOutInternal and totalCallInInternational.

     

    Design

    A sample response for LstmeetingusageHistory or LsteventsessionHistory includes:

    <history:totalCallInTollfreeMinutes>0</history:totalCallInTollfreeMinutes>
    <history:totalCallOutDomestic>0</history:totalCallOutDomestic>
    <history:totalCallOutInternational>0</history:totalCallOutInternational>
    <history:totalCallOutInternal>1</history:totalCallOutInternal>
    <history:totalCallInInternational>0</history:totalCallInInternational>
    <history:totalVoipMinutes>0</history:totalVoipMinutes>

     

    DB Design

    The fields are present in the current design.

     

    Known Issues

    None


    Related Release Information

    The XML API schemas and release notes are available at the Cisco WebEx Developer Portal:
    https://developer.cisco.com/site/collaboration/webex/webex-developer/develop-test/xml-api/reference/

    The URL API release notes are available at the Cisco WebEx Developer Portal:
    https://developer.cisco.com/site/collaboration/webex/webex-developer/develop-test/url-api/reference/