Webex XML API

GetSessionInfo

GetSessionInfo returns meeting information. It enables the retrieval of meeting information required for integration.

GetSessionInfo returns a limited amount of information when a request is made with only siteName specified in the security context and with a sessionKey specified. In the table below, wherever an element is marked as being always returned (with a ‘✓’), that element is returned in this anonymous mode.

The information returned by getSessionInfoResponse is based on where the request is made. Table 4-3 lists each element and defines whether or not it is returned based on the service calling the function, as follows:

  • ‘✓’ means that the element is always returned
  • ‘X’ means that the element that is never returned
  • ‘PW’ means that an element that is returned only if the meeting password has been supplied; or if the caller is the session host, an invited attendee, a panelist or a presenter.

Elements and Information Returned ny getSessionInfoResponse for Each Service

Element MC $C TC EC AO Comments
status ✓ ✓ ✓ ✓ X
isLocked ✓ ✓ ✓ ✓ ✓
presenter X X ✓ X X
panelistsInfo X X X ✓ X
programName X X X ✓ X
sessionKey ✓ ✓ ✓ ✓ ✓
confID ✓ ✓ ✓ ✓ ✓
verifyFlashMediaURL PW PW X X X
verifyWinMediaURL PW PW X X X
accessControl ✓ ✓ ✓ ✓ ✓
sessionPassword PW PW PW X PW
listStatus ✓ ✓ ✓ ✓ ✓
registration ✓ X ✓ ✓ X
registrationURL PW X ✓ ✓ X
metaData ✓ ✓ ✓ ✓ ✓
confName ✓ ✓ ✓ ✓ ✓
sessionType ✓ ✓ ✓ ✓ ✓
serviceType ✓ ✓ ✓ ✓ ✓
agenda PW PW PW X X
description X X ✓ ✓ X
account X PW X X X
opportunity X PW X X X
isRecurring ✓ ✓ ✓ ✓ ✓
telephony PW PW PW X PW
telephonySupport PW PW PW X PW
extTelephonyDescription PW PW PW X PW
globalCallinNumbersURL PW PW PW X PW
tollFreeRestrictionsURL PW PW PW X PW
callInNum PW PW PW X PW
backupTollNum PW PW PW X PW
particpantAccessCode PW PW PW X PW
participantLimitedAccessLabel X X X X PW
material X X PW ✓ X
imageURL X X X ✓ X
document X X PW PW X
name X X PW PW X
URL X X PW PW X
size X X PW PW X
test X X PW X X
title X X PW X X
titleURL X X PW X X
delivery X X PW X X
status X X PW X X
action X X PW X X
actionURL X X PW X X
host ✓ ✓ ✓ ✓ ✓
firstName ✓ ✓ ✓ ✓ ✓
lastName ✓ ✓ ✓ ✓ ✓
email ✓ ✓ ✓ ✓ ✓
webExID ✓ ✓ ✓ ✓ ✓
alternateHost PW PW X X PW
schedule ✓ ✓ ✓ ✓ ✓
startDate ✓ ✓ ✓ ✓ ✓
duration ✓ ✓ ✓ ✓ ✓
timeZone ✓ ✓ ✓ ✓ ✓
sipURL ✓ X ✓ ✓ X See Note below.
isAutoRecord ✓ X ✓ ✓ X See Note below.

Notes

  • For sipURL, the link returned supports Webex video platform version 1.0 or later (CMR version 3.0 or later) for meetings (previously referred to as the Meeting Center, or MC), and version 2.0 or later (CMR version 4.0 or later) for events (previously referred to as the Event Center, or EC).

  • The isAutoRecord element identifies meetings that are automatically recorded. This feature governs whether a meeting is automatically recorded if Automatically record all sessions using Network-Based Recording is not enabled (checked) on the Site Admin page. If the latter is enabled, it overrides isAutoRecord.

Global Call-In URL Variable Definitions

Name Description
%TollNum% Toll number from the TSP account in use.
%TollNumCC% The country code for the toll number.
%TollFreeNum% The toll-free number from the TSP account in use.
%TollFreeNumCC% The country code for the toll-free number.
%ParticipantCode% The participant code for the TSP account in use.
%SubscriberCode% The subscriber code for the TSP account in use.

For descriptions of the global elements in the security context of the request header, see Global Request Elements in Security Context. For descriptions of the non-global elements, refer to Elements in WebEx XML Schema Definitions for the General Session Service.

Request

The following schema diagram shows the structure of the elements in a getSessionInfo request message.

Figure 4-27 • Schema Diagram for getSessionInfo

The XML code below shows a sample request for session information using a specific key and password.

xml
Copy<?xml version="1.0" encoding="ISO-8859-1"?>
<!-- Created with Liquid Studio 2018 (https://www.liquid-technologies.com) -->
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <siteName>demosite</siteName>
            <webExID>demouser</webExID>
            <password>P@ssw0rd</password>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.ep.GetSessionInfo">
            <sessionKey>12345678</sessionKey>
            <!--sessionPassword>mXCCM286</sessionPassword-->
        </bodyContent>
    </body>
</serv:message>

Response

The following schema diagram shows the structure of the elements in the
getSessionInfoResponse message.

Figure 4-28 • Schema Diagram for getSessionInfoResponse

The XML code below shows an example of a possible response to the example request above.

xml
Copy<?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:ep="http://www.webex.com/schemas/2002/06/service/ep" 
              xmlns:meet="http://www.webex.com/schemas/2002/06/service/meeting">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="ep:getSessionInfoResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ep:status>NOT_INPROGRESS</ep:status>
            <ep:isLocked>false</ep:isLocked>
            <ep:sessionkey>712475980</ep:sessionkey>
            <ep:confID>112354352425862187</ep:confID>
            <ep:accessControl>
                <ep:sessionPassword>C!sco!23</ep:sessionPassword>
                <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:accessControl>
            <ep:metaData>
                <ep:confName>XML_AutoRecord_002</ep:confName>
                <ep:sessionType>3</ep:sessionType>
                <ep:serviceType>MeetingCenter</ep:serviceType>
                <ep:agenda>Test</ep:agenda>
                <ep:isRecurring>false</ep:isRecurring>
                <ep:agendaFormat>TEXT</ep:agendaFormat>
                <ep:descriptionFormat>TEXT</ep:descriptionFormat>
                <ep:isException>false</ep:isException>
                <ep:seriesMeetingKey>0</ep:seriesMeetingKey>
                <ep:hasException>false</ep:hasException>
            </ep:metaData>
            <ep:telephony>
                <ep:telephonySupport>CALLBACK</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>14085452910</serv:tollNum>
                </ep:callInNum>
                <ep:labels>
                    <ep:tollFreeCallInLabel>Call-in toll-free number (US/Canada)</ep:tollFreeCallInLabel>
                    <ep:tollCallInLabel>14085452910</ep:tollCallInLabel>
                </ep:labels>
                <ep:isMPAudio>false</ep:isMPAudio>
                <ep:voip>true</ep:voip>
                <ep:enableTSP>false</ep:enableTSP>
            </ep:telephony>
            <ep:host>
                <ep:firstName>Simon</ep:firstName>
                <ep:lastName>Test</ep:lastName>
                <ep:email>simon0@qa.webex.com</ep:email>
                <ep:webExId>Simon</ep:webExId>
                <ep:allowAnyoneHostMeeting>false</ep:allowAnyoneHostMeeting>
            </ep:host>
            <ep:schedule>
                <ep:startDate>11/28/2018 10:10:10</ep:startDate>
                <ep:duration>20</ep:duration>
                <ep:timeZone>GMT-08:00, Pacific (San Francisco)</ep:timeZone>
                <ep:timeZoneID>4</ep:timeZoneID>
                <ep:openTimeInSec>300</ep:openTimeInSec>
            </ep:schedule>
            <ep:attendeeOptions>
                <ep:joinRequiresAccount>false</ep:joinRequiresAccount>
            </ep:attendeeOptions>
            <ep:isAudioOnly>false</ep:isAudioOnly>
            <ep:telePresence>false</ep:telePresence>
            <ep:isAlternateHost>false</ep:isAlternateHost>
            <ep:isCreator>true</ep:isCreator>
            <ep:hostKey>260806</ep:hostKey>
            <ep:supportE2E>false</ep:supportE2E>
            <ep:isAllowJBH>true</ep:isAllowJBH>
            <ep:isCETMeeting>true</ep:isCETMeeting>
            <ep:isPersonalMeetingRoom>false</ep:isPersonalMeetingRoom>
            <ep:isNextUpcomingInstance>true</ep:isNextUpcomingInstance>
            <ep:meetingLink>https://sqdemo6.dmz.webex.com/sqdemo6/j.php?MTID=mb5c5c82e92c6e9ad3614a65354798e38</ep:meetingLink>
            <ep:sipURL>712475980@sqdemo6.dmz.webex.com</ep:sipURL>
            <ep:isAutoRecord>false</ep:isAutoRecord>
        </serv:bodyContent>
    </serv:body>
</serv:message>
Next