Webex Meetings > Develop and Test > XML API > Release Notes

XML API 10.0.0 SP4 Release Notes

Important: The XML API 10.0.0 SP4 release adds a new API call to the 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 with the release of Webex® XML API 10.0.0 SP4. These changes apply to your integration with WBS 31.

All features are backward compatible with existing integrations. There are some changes to the XML API 10.0.0 schema definitions as noted below.

User preferences for default Global Call-in numbers will be supported via APIs

Description

A Site admin can enable users to set their preferred global call-in numbers from a subset of numbers available at the site level. In this release, setUser API has been enhanced to allow a user or a site admin on behalf of user to set two preferred global call-in numbers.

The GetSite API can be used to get a site level list of supported call-in numbers (country aliases). This is an already supported.

A successful request to this API returns information about Personal Meeting Room and avatar image details for a given user identity. A user identity can be one of these three:
  • webExId
  • email address, or
  • personal room url
For the avatar images, size can be specified as well. Because a user can have multiple avatar images, the url to an avatar image which most closely matches the requested size will be returned. There is no authentication required to make a request to this API.

Affected APIs

setUser


The following diagram shows the defaultGlobalCallInNum element that can be used in a SetUser request message:

schema diagram of defaultGlobalCallInNum



Notice that phoneNumber and tollFree elements of the defaultGlobalCallInNum element have been made optional. The <countryAlias> element in the SetUser request and the rest of the information is not useful in this context. Because the defaultGlobalCallInNumType element is not currently used in any of the APIs as part of the request input XML body, there should not be any backward compatibility issue in making these two items optional.

New Guest API to obtain Personal Meeting Room details for other users

Description

This release introduces the getUserCard API operation. The purpose of this API call is to obtain public information about the personal meeting room of other users. This API does not require authentication. The getUserCard API requires one of the following inputs in the request message:

  • Webex site and personal room id,
  • email address, or
  • Webex ID
The API returns basic information about Personal Meeting Room including avatar image and personal room URL. Personal Meeting Room elements are same as the ones returned by the GetUser API for PMR related items. If site has disabled PMR or user has no PMR enabled, PMR items will be null.
For the avatar images, because there can be multiple images size can be specified as well. In that case, the URL to an avatar image that closest matches to the requested size will be returned.

On sites that are non-CI based (not based on the Common Identity architecture), if the image does not exist, an image based on the initials (first letter of First name and Last name) will be returned. If at any point, a valid URL image cannot be returned, the default avatar URL image will be returned.

When the image URL returned is system generated or a default URL, isUploaded is set to false.
For non-CI sites, if the user image file is available on the server file system and for initials-based avatar images, lastModifiedTtime returned is the last modified time of that file.


Affected APIs

getUserCard


Request
The following diagram shows the getUserCard element to use in a request message:

schema diagram of getUserCard



Example Request Message
The following XML snippet shows an example of a request message sent to the getUserCard API to get basic information about the Personal Meeting Room for the specified <webExID>.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <header>
    <securityContext>
      <webExID></webExID>
      <password></password>
      <siteName>sitename</siteName>
    </securityContext>
  </header>
  <body>
    <bodyContent xsi:type="java:com.webex.service.binding.user.GetUserCard">
     <webExId>webexid</webExId>
    </bodyContent>
  </body>
</serv:message>



Response
The following diagram shows the getUserCardResponse object that the User service returns:

schema diagram of getUserCardResponse

The following diagram shows the structure of the avatar element which provides the URL to the user's avatar image, as well as other information about the image:

schema diagram of avatar element

The following diagram shows the structure of the personalMeetingRoom element which is defined as a userCardPMRInfoType type. This element provides information about the PMR URL, as well as other information about the specified user's Personal Meeting Room.

schema diagram of personalMeetingRoom


Example Response Message
The following XML snippet shows an example of a successful getUserCardResponse message sent by the server in response to the above example request.

<?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:getUserCardResponse" 
                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <use:avatar>
        <use:url>https://sitename.webex.com/mw3100/downloadFileServlet?siteurl=sitename
               &fileURI=QUhTSwAAAAWtqciY7HXkkjVkDNt8WxKgf4kZXZsr...VuZbbYI913KLO9Ctkp-jn0kS
               &isAbsolute=true</use:url>
        <use:lastModifiedTime>1454003176000</use:lastModifiedTime>
        <use:initials>UN</use:initials>
        <use:isUploaded>false</use:isUploaded>
      </use:avatar>
      <use:personalMeetingRoom>
        <use:title>User Name's Personal Room</use:title>
        <use:personalMeetingRoomURL>https://sitename.webex.com/meet/user.name</use:personalMeetingRoomURL>
        <use:accessCode>123456789</use:accessCode>
      </use:personalMeetingRoom>
    </serv:bodyContent>
  </serv:body>
</serv:message>


Support Link added to welcome emails sent from CreateUser API


Description

This release changes the welcome email template by adding a new support link. The email template is used when a user is provisioned through the createUser API. The new support link points to training and help information on how to schedule and manage meetings.

Affected APIs

createUser (emails)

When a request to the createUser API (with sendWelcome flag set to TRUE) provisions a new user, the Webex service uses the default email template to send a welcome email message to the new user. This release adds a new variable to that template: %SupportLink%. The XMLAPI replaces the variable with the value: "https://help.webex.com/docs/DOC-7923".

The following screenshot shows an example of the site admin panel that defines the Email template "Welcome Emails from Webex Service":

welcomeEmailTemplate

The following screenshot shows an example of the welcome email that would be received by the new user:

example welcome email




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/