GetEvent

Webex XML API

Webex Meetings XML API Reference Guide

GetEvent returns detailed information about a specified session.

Note

Site administrators or hosts can only get information for event sessions scheduled or owned by themselves. An exceptionID of 000001 is returned if a user requests information for sessions scheduled by other hosts.

Request

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

Figure 7-5 • Schema Diagram for getEvent

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, see Elements in the Event Session Service.

The XML code below shows a sample request. It requests detailed information for an event session with the sessionKey value of 713082671. (Be sure to provide a valid value for your website.

xml

Copy<?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>
            <siteName>sqdemo6</siteName>
            <webExID>simon</webExID>
            <password>P@ss1234</password>
            <partnerID>webexpartner</partnerID>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.event.GetEvent">
            <sessionKey>713082671</sessionKey>

        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 7-6 • Schema Diagram for getEventResponse

The ability to programmatically assign an Event Center event to a specific program can be done from the scheduling web pages.

The GetEventResponse message allows you to see whether or not attendees can join the teleconference before the host does. This functionality is located in the schedule element. It also adds the functionality to determine whether or not participant callers will be muted upon joining the meeting.

Note the “Include iCalendar Attachments” option that allows you to specify whether to attach an iCal file to the response.

The <endURLAfterEnroll> element redirects an attendee to a designated page after registering for an Event session.

The GetEventResponse message allows hosts to create a survey for attendees to take after an event. The GetEventResponse includes the <panelistsInfo> field in Event Center.

The result and exceptionID global elements enable you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

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 XML code below shows a possible response to to a getEvent request such as the one 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:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="event:getEventResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <event:accessControl>
                <event:listing>UNLISTED</event:listing>
                <event:sessionPassword>P@ss1234</event:sessionPassword>
            </event:accessControl>
            <event:metaData>
                <event:sessionName>XML_EC_ICalendar_Ser_003</event:sessionName>
                <event:sessionType>9</event:sessionType>
                <event:description></event:description>
                <event:postEventSurvey/>
            </event:metaData>
            <event:schedule>
                <event:startDate>11/12/2018 14:29:15</event:startDate>
                <event:timeZoneID>4</event:timeZoneID>
                <event:duration>60</event:duration>
                <event:openTime>15</event:openTime>
                <event:hostWebExID>Simon</event:hostWebExID>
                <event:entryExitTone>BEEP</event:entryExitTone>
                <event:extNotifyTime>0</event:extNotifyTime>
                <event:joinTeleconfBeforeHost>false</event:joinTeleconfBeforeHost>
            </event:schedule>
            <event:telephony>
                <event:telephonySupport>NONE</event:telephonySupport>
            </event:telephony>
            <event:tracking/>
            <event:remind>
                <event:minutesAhead>10</event:minutesAhead>
            </event:remind>
            <event:panelists>
                <event:panelistPassword></event:panelistPassword>
                <event:panelist xsi:type="event:attendee">
                    <com:name>Simon</com:name>
                    <com:firstName>Simon</com:firstName>
                    <com:address>
                        <com:addressType>PERSONAL</com:addressType>
                    </com:address>
                    <com:phones/>
                    <com:email>sihe@cisco.com</com:email>
                    <com:type>PANELIST</com:type>
                    <event:joinStatus>INVITE</event:joinStatus>
                </event:panelist>
                <event:panelist xsi:type="event:attendee">
                    <com:name>Simon_2</com:name>
                    <com:firstName>Simon_2</com:firstName>
                    <com:address>
                        <com:addressType>PERSONAL</com:addressType>
                    </com:address>
                    <com:phones/>
                    <com:email>simon2@qa.webex.com</com:email>
                    <com:type>PANELIST</com:type>
                    <event:joinStatus>INVITE</event:joinStatus>
                </event:panelist>
                <event:joinURLForPanelist>https://sqdemo6.dmz.webex.com/sqdemo6/onstage/g.php?MTID=e6ab46f501cd9a501032c9710fb526dc6</event:joinURLForPanelist>
            </event:panelists>
            <event:attendees>
                <event:attendee>
                    <com:name>Simon_4</com:name>
                    <com:firstName>Simon_4</com:firstName>
                    <com:address>
                        <com:addressType>PERSONAL</com:addressType>
                    </com:address>
                    <com:phones/>
                    <com:email>simon4@qa.webex.com</com:email>
                    <com:type>VISITOR</com:type>
                    <event:joinStatus>INVITE</event:joinStatus>
                </event:attendee>
                <event:attendee>
                    <com:name>seaboy</com:name>
                    <com:firstName>seaboy</com:firstName>
                    <com:address>
                        <com:addressType>PERSONAL</com:addressType>
                    </com:address>
                    <com:phones/>
                    <com:email>seaboyhe@gmail.com</com:email>
                    <com:type>VISITOR</com:type>
                    <event:joinStatus>INVITE</event:joinStatus>
                </event:attendee>
            </event:attendees>
            <event:extOptions>
                <event:enrollmentNumber>10000</event:enrollmentNumber>
                <event:allowInviteFriend>false</event:allowInviteFriend>
                <event:viewAttendeeList>HOST,PRESENTER,PANELISTS</event:viewAttendeeList>
                <event:participantLimit>4</event:participantLimit>
                <event:displayQuickStartHost>true</event:displayQuickStartHost>
                <event:voip>true</event:voip>
                <event:registration>false</event:registration>
            </event:extOptions>
            <event:emailTemplates>
                <event:format>TEXT</event:format>
                <event:invitationMsgs>
                    <event:participantsEmail>
                        <event:subject>Your invitation to -- %Topic%</event:subject>
                        <event:from>%SenderEmailAddress%</event:from>
                        <event:replyTo>%HostEmail%</event:replyTo>
                        <event:content>Hello %ParticipantName%,
%HostName% has invited you to attend the following web seminar using WebEx:

Topic: %Topic%
%MeetingTimeInformation%

Please click the following link to see more information about the event or to join the event.

%MeetingInfoURL%

To contact %HostName%, send a message to this address: %HostEmail%

%EmailFooter%
    </event:content>
                    </event:participantsEmail>
                    <event:panelistsEmail>
                        <event:subject>You're invited as a panelist in a web seminar: %Topic%</event:subject>
                        <event:from>%SenderEmailAddress%</event:from>
                        <event:replyTo>%HostEmail%</event:replyTo>
                        <event:content>
Hello %PaneliestName%, 
%HostName% has invited you to be part of a WebEx web seminar.  Here is your panelist information for this event.

Topic: %Topic% 
Date: %MeetingDate% 
Time: %MeetingTime%, %EventTimeZone% 
Event Number: %MeetingNumber%    
Panelist Password: %PanelistPassword% 
Teleconference: %TeleconferenceInfo%

To join this event, click on the following link: %PanelistEntranceURL% , %PanelistJoinBeforeHost%  

NOTE: If you have any difficulty joining as a panelist, you may use the information below to join as an attendee.

Here is the attendee information for this event.  You can cut-and-paste the below information to send to any enrollees or attendees.

Topic: %Topic% 
Date: %MeetingDate% 
Time: %MeetingTime%, %EventTimeZone%
Event Number: %MeetingNumber%
Enrollment password: %RegistrationPassword%    
Event Entrance for Attendees: %MeetingInfoURL%
Teleconference: 
%TeleconferenceInfo% 

%UCFAttendeeVerifyPlayers%

To contact %HostName%, send a message to this address: %HostEmail%

%EmailFooter%
    </event:content>
                    </event:panelistsEmail>
                </event:invitationMsgs>
                <event:enrollmentMsgs>
                    <event:pendingEmail>
                        <event:subject>Enrollment Pending</event:subject>
                        <event:from>%SenderEmailAddress%</event:from>
                        <event:replyTo>%HostEmail%</event:replyTo>
                        <event:content>Hello %AttendeeName%,

Your registration for this event is now pending.

Topic: %Topic%
Date: %MeetingDate%
Time: %MeetingTime%, %EventTimeZone%

We will send an updated email to you once your status changes.

To contact %HostName%, call %HostPhone%
send a message to this address: %HostEmail%

%EmailFooter%
    </event:content>
                        <event:send>false</event:send>
                    </event:pendingEmail>
                    <event:acceptedEmail>
                        <event:subject>Enrollment Approved</event:subject>
                        <event:from>%SenderEmailAddress%</event:from>
                        <event:replyTo>%HostEmail%</event:replyTo>
                        <event:content>Hello %AttendeeName%,

Your registration for this event has been accepted.

Topic: %Topic%
Host: %HostName%
Date: %MeetingDate%
Time: %MeetingTime%, %EventTimeZone%
Event Number: %MeetingNumber%
Enrollment ID: %EnrollmentID%
Event Password: %EventPassword%
Teleconference: %TeleconferenceInfo%

Please click the following link to join the event.

%MeetingInfoURL%

%DownloadInstruction%

%UCFAttendeeVerifyPlayers%

To contact %HostName%, call %HostPhone%
send a message to this address: %HostEmail%

%EmailFooter%
    </event:content>
                        <event:send>false</event:send>
                    </event:acceptedEmail>
                    <event:rejectedEmail>
                        <event:subject>Enrollment Rejected</event:subject>
                        <event:from>%SenderEmailAddress%</event:from>
                        <event:replyTo>%HostEmail%</event:replyTo>
                        <event:content>Hello %AttendeeName%,

Your registration for this event has been declined.

Topic: %Topic%
Date: %MeetingDate%
Time: %MeetingTime%, %EventTimeZone%

To contact %HostName%, call %HostPhone%
send a message to this address: %HostEmail%

%EmailFooter%
    </event:content>
                        <event:send>false</event:send>
                    </event:rejectedEmail>
                    <event:eventUpdatedEmail>
                        <event:subject>Event Reminder</event:subject>
                        <event:from>%SenderEmailAddress%</event:from>
                        <event:replyTo>%HostEmail%</event:replyTo>
                        <event:content>Dear %AttendeeName%:

Due to overwhelming response, we have extended our event duration. You will not need to register for this event again. We look forward to seeing you online at this event.

Event Information:
Event:%Event Name% 
Date: %Date%  
Time: %Time%  %EventTimeZone% 

Please join us at least 10 minutes prior to the presentation to ensure the automatic system set-up has been properly established.

%UCFAttendeeVerifyPlayers%

Attendee Instructions:
1) Direct your web browser to  %site%
2) Locate the event on the list
3) Click the Join button for this event
3a) If prompted, enter the enrollment ID: %enrollment ID% 
4) If prompted, enter the password: %password%

Teleconference Information: 
%TeleconferenceInfo%

If you have any questions or require online assistance, please contact the event coordinator. 

Sincerely,
Your WebEx Event Center Team. 

===========================
WebEx Events Requirements:
-Internet connection=56K kbps connection or better(AOL users: AOL5.0 and above only)
-Netscape 4.x or Internet Explorer 4.x and above
-For teleconference participants, a separate telephone line is required (in addition to the line used to dial up to ISP, if applicable)
    </event:content>
                    </event:eventUpdatedEmail>
                </event:enrollmentMsgs>
                <event:reminderMsgs>
                    <event:firstReminder>
                        <event:subject>Event Reminder</event:subject>
                        <event:from>%SenderEmailAddress%</event:from>
                        <event:replyTo>%HostEmail%</event:replyTo>
                        <event:content>Dear %AttendeeName%, 

This is a reminder that you have enrolled in %Topic%. We look forward to seeing you online at this event. 

Event Information: 
Event: %Topic% 
Event Number: %MeetingNumber%
Date: %MeetingDate% 
Time: %MeetingTime%, %EventTimeZone% 

Please join us at least 10 minutes prior to the presentation to ensure the automatic system set-up has been properly established.

%UCFAttendeeVerifyPlayers%

Attendee Instructions:
1) Direct your web browser to %MeetingInfoURL% 
2) Locate the event on the list 
3) Click the Join button for this event 
3a) If prompted, enter the enrollment ID: %EnrollmentID% 
4) If prompted, enter the password: %EventPassword% 

Teleconference Information: 
Dial the appropriate number according to your geographic location: 
%TeleconferenceInfo% 

For operator assistance, please dial *0 on your touch-tone phone. 

If you have any questions or require online assistance, please contact the event coordinator. 

Sincerely,
Your WebEx Event Center Team. 

===========================
WebEx Events Requirements:
-Internet connection=56K kbps connection or better(AOL users: AOL5.0 and above only)
-Netscape 4.x or Internet Explorer 4.x and above
-For teleconference participants, a separate telephone line is required (in addition to the line used to dial up to ISP, if applicable)
    </event:content>
                        <event:send>false</event:send>
                        <event:sendDateTime>11/11/2018 14:29:15</event:sendDateTime>
                    </event:firstReminder>
                    <event:secondReminder>
                        <event:subject>Final Event reminder</event:subject>
                        <event:from>%SenderEmailAddress%</event:from>
                        <event:replyTo>%HostEmail%</event:replyTo>
                        <event:content>Dear %AttendeeName%, 

This is a final reminder that you have enrolled in %Topic%. We look forward to seeing you online at this event. 

Event Information: 
Event: %Topic% 
Event Number: %MeetingNumber%
Date: %MeetingDate% 
Time: %MeetingTime%, %TimeZone% 

Please join us at least 10 minutes prior to the presentation to ensure the automatic system set-up has been properly established. 

%UCFAttendeeVerifyPlayers%

Attendee Instructions: 
1) Direct your web browser to %MeetingInfoURL% 
2) Locate the event on the list 
3) Click the Join button for this event 
4) If prompted, enter the enrollment ID: %EnrollmentID% 
5) If prompted, enter the password: %EventPassword% 

Teleconference Information: 
Dial the appropriate number according to your geographic location: 
%TeleconferenceInfo% 

For operator assistance, please dial *0 on your touch-tone phone. 

If you have any questions or require online assistance, please contact the event coordinator. 

Sincerely, 
Your WebEx Event Center Team. 

===========================
WebEx Events Requirements:
-Internet connection=56K kbps connection or better(AOL users: AOL5.0 and above only)
-Netscape 4.x or Internet Explorer 4.x and above
-For teleconference participants, a separate telephone line is required (in addition to the line used to dial up to ISP, if applicable)
    </event:content>
                        <event:send>false</event:send>
                        <event:sendDateTime>11/11/2018 14:29:15</event:sendDateTime>
                    </event:secondReminder>
                </event:reminderMsgs>
                <event:followUpMsgs>
                    <event:thanksForAttending>
                        <event:subject>Event Thank you</event:subject>
                        <event:from>%SenderEmailAddress%</event:from>
                        <event:replyTo>%HostEmail%</event:replyTo>
                        <event:content>
        Hello %AttendeeName%,
        Thank you for attending the event %Topic% on %MeetingDate%. If you have any comments or questions concerning the event, you can contact %HostName% by:
        Phone: %HostPhone%
        Email: %HostEmail%
        We look forward to seeing you again.
        %EmailSignature%
    </event:content>
                        <event:send>false</event:send>
                        <event:sendDateTime>11/12/2018 15:29:15</event:sendDateTime>
                    </event:thanksForAttending>
                    <event:absenteeFollowUp>
                        <event:subject>Event Followup</event:subject>
                        <event:from>%SenderEmailAddress%</event:from>
                        <event:replyTo>%HostEmail%</event:replyTo>
                        <event:content>
        Hello %AttendeeName%,
        According to our record, you have registered for event %Topic% which is held on %MeetingDate%. However, we regret that we did not see you joining the meeting.
        If you want to contact %HostName% concerning the event, you can do so by:
        Phone: %HostPhone%
        Email: %HostEmail%
        %EmailSignature%
    </event:content>
                        <event:send>false</event:send>
                        <event:sendDateTime>11/12/2018 15:29:15</event:sendDateTime>
                    </event:absenteeFollowUp>
                </event:followUpMsgs>
                <event:iCalendar>true</event:iCalendar>
            </event:emailTemplates>
            <event:sessionKey>713082671</event:sessionKey>
            <event:status>NOT_INPROGRESS</event:status>
            <event:enrollment>
                <event:idReq>false</event:idReq>
                <event:passwordReq>false</event:passwordReq>
                <event:password></event:password>
                <event:approvalReq>false</event:approvalReq>
            </event:enrollment>
            <event:enrollmentForm>
                <event:standardFields>
                    <event:firstName>
                        <event:incl>true</event:incl>
                        <event:req>true</event:req>
                        <event:fieldID>-14</event:fieldID>
                    </event:firstName>
                    <event:lastName>
                        <event:incl>true</event:incl>
                        <event:req>true</event:req>
                        <event:fieldID>-13</event:fieldID>
                    </event:lastName>
                    <event:emailAddress>
                        <event:incl>true</event:incl>
                        <event:req>true</event:req>
                        <event:fieldID>-12</event:fieldID>
                    </event:emailAddress>
                    <event:phone>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-11</event:fieldID>
                    </event:phone>
                    <event:company>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-10</event:fieldID>
                    </event:company>
                    <event:title>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-9</event:fieldID>
                    </event:title>
                    <event:numEmployees>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-2</event:fieldID>
                    </event:numEmployees>
                    <event:futureInfo>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-1</event:fieldID>
                    </event:futureInfo>
                    <event:address1>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-8</event:fieldID>
                    </event:address1>
                    <event:address2>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-7</event:fieldID>
                    </event:address2>
                    <event:city>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-6</event:fieldID>
                    </event:city>
                    <event:state>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-5</event:fieldID>
                    </event:state>
                    <event:postalCode>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-4</event:fieldID>
                    </event:postalCode>
                    <event:country>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-3</event:fieldID>
                    </event:country>
                </event:standardFields>
                <event:customFields/>
            </event:enrollmentForm>
            <event:hostKey>316312</event:hostKey>
            <event:eventID>2450537</event:eventID>
            <event:guestToken>4ca17ff3d8f71d00cc23b055947bf15c</event:guestToken>
            <event:hostType>1019001</event:hostType>
            <event:isCETMeeting>false</event:isCETMeeting>
        </serv:bodyContent>
    </serv:body>
</serv:message>