Release Notes 10.0.0 SP8
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 compatible 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. The changes to the latest schema definitions are explained below.
What is New in this Release
This section describes the new features in XML API 10.0.0 SP8.
- Display extended teleconference information for TSP sites
- Search meetings based on the date the meeting was modified
Display extended teleconference information for TSP sites
This new feature allows the user to see the extended TSP account information for the mobile application 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 the wbxMMConfParam
table (by createMeeting
or setMeeting
) if related data exists for the meeting.
Affected API
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
- call getSessionInfo by a host sample response
...
<ep:telephony>
<ep:telephonySupport>CALLIN</ep:telephonySupport>
<ep:tollFreeRestrictionsURL>
https://www.webex.com/pdf/tollfree_restrictions.pdf
</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>
...
- call getSessionInfo by an alternate host sample response
Same as the above
call getSessionInfo by an attendee with a correct meeting password sample response:
Without subscriberAccessCode and subscriberAccessLabel nodes.
...
ep:telephony ep:telephonySupportCALLIN ep:tollFreeRestrictionsURL https://www.webex.com/pdf/tollfree_restrictions.pdf 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:callInNum serv:tollNum1-5102222222 serv:tollFreeNum1-5103333333 ep:participantAccessCode23456789 ep:labels ep:tollFreeCallInLabelCaller-paid Call-in ep:tollCallInLabelCall-in ep:participantAccessLabelAttendee access code ep:isMPAudiofalse ep:voiptrue ep:enableTSPtrue ...
1. call getSessionInfo by an attendee without a meeting password sample response:
No telephony info
1. To set a meeting, sample response is:
<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">
### Search meetings based on the date the meeting was modified
The API `lstSummarySession` now allows the 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.
### Affected API
* `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"/>
### Behavior Changed
No new items are added to the response. Additionally, optional search criteria is added to the query based on the updated (created and modified) time.
### Known Issues
1. Search criteria based on the 'modified time' cannot exceed two weeks range.
1. If the provided range exceeds two weeks, 'modifiedDateEnd' value is adjusted to two weeks from 'modifedDateStart' value.
1. If only one of the 'modifiedDateStart' or 'modifiedDateEnd' value is provided, other value is set to make sure that the range is two weeks.
1. 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:
[XML API Reference](https://developer.cisco.com/docs/webex-xml-api-reference-guide/#!xml-api-reference-guide)
The URL API release notes are available at the Cisco Webex Developer Portal:
[URL API Reference](https://d1nmyq4gcgsfi5.cloudfront.net/fileMedia/4588769e-3624-4778-9aa6-9456e8336a2f/URL%20API%20WBS%2027%20Ref%20Guide.pdf)