XML API 10.0.0 SP8 Release Notes

Important: The XML API 10.0.0 SP8 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 10.0.0 SP8. These changes apply to your integration with WBS 31.
All features are backward compatible with existing integrations. There are changes to the latest schema definitions explained below.

 
 

Display extended teleconference information for TSP sites

This new feature allows users to see the extended TSP account information for the mobile app if the meeting was scheduled by XML API. This enables users to directly call the toll or toll-free numbers to join an audio conference.

GetSessionInfo API should return tspConference info stored in wbxMMConfParam table (by createMeeting or setMeeting) if related data exists for the meeting.


APIs impacted

getSessionInfo


Schema changes

None

Behavior Changed

GetSessionInfo API should return tspConference info (by createMeeting or setMeeting) if related data exists for the meeting

Design

For getSessionInfo:

in a Meeting Center meeting:

if (those values from TollCallInNumber, TollFreeCallInNumber, SubscriberAccessCode, ParticipantAccessCode from table wbxMMConfParam for the meeting are not null and not empty)  {

    use those values for returned value in telephony portion

	}

Test Cases

Cases
Expected Response
Verified
call getSessionInfo by a host
sample response
...
<ep:telephony>
    <ep:telephonySupport>CALLIN</ep:telephonySupport>
    <ep:tollFreeRestrictionsURL>
</ep:tollFreeRestrictionsURL>
    <ep:dialInSequences>
AutoDialInSequence:[AccessNumber],,*00*[AccessCode]#,,,[AttendeeID]#|SilentDialInSequence:[AccessNumber],,*01*[AccessCode]#[AttendeeID]#*01*|AutoLGDialInSequence:[AccessNumber],,*00*[AccessCode]#,,,[ProfileID]#,,,[PIN]#|SilentLGDialInSequence:[AccessNumber],,*01*[AccessCode]#[ProfileID]#[PIN]#*01*|AutoLGPWDialInSequence:[AccessNumber],,*00*[AccessCode]#,,,[ProfileID]#,,,[PIN]#,,,[Password]#|SilentLGPWDialInSequence:[AccessNumber],,*01*[AccessCode]#[ProfileID]#[PIN]#[Password]#*01*
</ep:dialInSequences>
    <ep:callInNum>
        <serv:tollNum>1-5102222222</serv:tollNum>
        <serv:tollFreeNum>1-5103333333</serv:tollFreeNum>
    </ep:callInNum>
    <ep:participantAccessCode>23456789</ep:participantAccessCode>
    <ep:subscriberAccessCode>12345678</ep:subscriberAccessCode>
    <ep:labels>
        <ep:tollFreeCallInLabel>Caller-paid Call-in</ep:tollFreeCallInLabel>
        <ep:tollCallInLabel>Call-in</ep:tollCallInLabel>
        <ep:participantAccessLabel>Attendee access code</ep:participantAccessLabel>
        <ep:subscriberAccessLabel>Host access code</ep:subscriberAccessLabel>
    </ep:labels>
    <ep:isMPAudio>false</ep:isMPAudio>
    <ep:voip>true</ep:voip>
    <ep:enableTSP>true</ep:enableTSP>
</ep:telephony>
...
y
call getSessionInfo by an alternate host

Same as the above

y
call getSessionInfo by an attendee with a correct meeting password

Without subscriberAccessCode and subscriberAccessLabel nodes

sample response
...
<ep:telephony>
    <ep:telephonySupport>CALLIN</ep:telephonySupport>
    <ep:tollFreeRestrictionsURL>
</ep:tollFreeRestrictionsURL>
    <ep:dialInSequences>
AutoDialInSequence:[AccessNumber],,*00*[AccessCode]#,,,[AttendeeID]#|SilentDialInSequence:[AccessNumber],,*01*[AccessCode]#[AttendeeID]#*01*|AutoLGDialInSequence:[AccessNumber],,*00*[AccessCode]#,,,[ProfileID]#,,,[PIN]#|SilentLGDialInSequence:[AccessNumber],,*01*[AccessCode]#[ProfileID]#[PIN]#*01*|AutoLGPWDialInSequence:[AccessNumber],,*00*[AccessCode]#,,,[ProfileID]#,,,[PIN]#,,,[Password]#|SilentLGPWDialInSequence:[AccessNumber],,*01*[AccessCode]#[ProfileID]#[PIN]#[Password]#*01*
</ep:dialInSequences>
    <ep:callInNum>
        <serv:tollNum>1-5102222222</serv:tollNum>
        <serv:tollFreeNum>1-5103333333</serv:tollFreeNum>
    </ep:callInNum>
    <ep:participantAccessCode>23456789</ep:participantAccessCode>
    <ep:labels>
        <ep:tollFreeCallInLabel>Caller-paid Call-in</ep:tollFreeCallInLabel>
        <ep:tollCallInLabel>Call-in</ep:tollCallInLabel>
        <ep:participantAccessLabel>Attendee access code</ep:participantAccessLabel>
    </ep:labels>
    <ep:isMPAudio>false</ep:isMPAudio>
    <ep:voip>true</ep:voip>
    <ep:enableTSP>true</ep:enableTSP>
</ep:telephony>
...
y
call getSessionInfo by an attendee without a meeting password No telephony info y

To set a meeting:

<?xml version="1.0" encoding="UTF-8"?>
<serv:message
    <header>
        <securityContext>
            <webExID>xxxxx</webExID>
            <password>xxxxx</password>
            <siteName>xxxxx</siteName>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.meeting.SetMeeting">
            <meetingkey>xxxxx</meetingkey>
            <telephony>
                <meet:telephonySupport>CALLIN</meet:telephonySupport>
                <meet:tspConference>
                    <serv:tollFreeCallInNumber>1-xxxxx</serv:tollFreeCallInNumber>
                    <serv:tollCallInNumber>1-xxxxx</serv:tollCallInNumber>
                    <serv:subscriberAccessCode>12345678</serv:subscriberAccessCode>
                    <serv:participantAccessCode>23456789</serv:participantAccessCode>
                </meet:tspConference>
            </telephony>
        </bodyContent>
    </body>
</serv:message>

Search meetings based the date the meeting was modified

The API lstSummarySession now allows site administrators to search for meetings based on when they were last modified.

Backward compatibility is fully supported for any previous API usage when this new search filter is not being used.

APIs impacted

LstsummarySession

Schema changes

The below highlighted optional elements are added to the 'dateScope'.

<xsd:complexType name="dateScopeType">
<xsd:sequence>
  <xsd:element name="startDateStart" type="xsd:string" minOccurs="0"/>
  <xsd:element name="startDateEnd" type="xsd:string" minOccurs="0"/>
  <xsd:element name="endDateStart" type="xsd:string" minOccurs="0"/>
  <xsd:element name="endDateEnd" type="xsd:string" minOccurs="0"/>
  <xsd:element name="modifiedDateStart" type="xsd:string" minOccurs="0"/>  <--New element 
  <xsd:element name="modifiedDateEnd" type="xsd:string" minOccurs="0"/>    <--New Element
  <xsd:element name="timeZoneID" type="xsd:integer" default="-1" minOccurs="0"/>
  <xsd:element name="returnSpecifiedTimeZone" type="xsd:boolean" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>

Behavior Changed

No new items are added to the response. Additional optional search criteria is added to query based on updated (created and modified) time.

Known Issues

  1. Search criteria based on the 'modified time' cannot exceed two weeks range.
  2. If the provided range exceeds two weeks, 'modifiedDateEnd' value is adjusted to two weeks from 'modifedDateStart' value.
  3. If only one of the 'modifiedDateStart' or 'modifiedDateEnd' is provided, other value is set to make sure that the range is two weeks.
  4. When 'modifiedDate' criteria is provided, any 'startDate' or 'endDate' value in the request will be ignored.

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/