CreateEvent

Webex XML API

Webex Meetings XML API Reference Guide

Allows event session hosts to schedule a new event session. This API filters for unsafe HTML input fields. See Table 2-8, “HTML Tags Checked”
for the fields affected.

Note: Lower Case email address modification

When creating meetings, events, and training sessions as well as creating or registering meeting attendees, email addresses will be
converted to lower case when saved in the report DB to match with the URL APIs behavior that converts the email into lower case

Not backward compatible; this may impact the current APP that has attendee email in mixes case.

Request

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

Figure 7-1 • Schema diagram for createEvent

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

The CreateEvent API allows you to specify 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.

An “Include iCalendar Attachments” options has been incorporated.

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

The CreateEvent API supports Join Before Host Telephony for TSP sessions. It also supports the <panelistsInfo> field that is part of Event Center.

The following sample XML document shows an example that creates a new event service instance named “Example1112”.

xml

Copy<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>
            <siteID>0000</siteID>
            <partnerID>9999</partnerID>
            <email>johnsmith@xyz.com</email>
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.event.CreateEvent">
            <accessControl>
                <listing>PUBLIC</listing>
                <sessionPassword>111111</sessionPassword>
            </accessControl>
            <schedule>
                <startDate>04/05/2004 10:00:00</startDate>
                <duration>60</duration>
                <timeZoneID>45</timeZoneID>
                <entryExitTone>NOTONE</entryExitTone>
            </schedule>
            <enrollment>
                <endURLAfterEnroll>www.yahoo.com</endURLAfterEnroll>
            </enrollment>
            <metaData>
                <sessionName>Example1112</sessionName>
                <sessionType>9</sessionType>
                <description>this is a test</description>
            </metaData>
            <telephony>
                <telephonySupport>CALLIN</telephonySupport>
                <enableTSP>true</enableTSP>
                <tspAccountIndex>1</tspAccountIndex>
                <muteUponEntry>true</muteUponEntry>
            </telephony>
            <tracking>
                <trackingCode1>test1</trackingCode1>
                <trackingCode2>test2</trackingCode2>
                <trackingCode3>test3</trackingCode3>
                <trackingCode4>test4</trackingCode4>
                <trackingCode5>test5</trackingCode5>
                <trackingCode6>test6</trackingCode6>
                <trackingCode7>test7</trackingCode7>
                <trackingCode8>test8</trackingCode8>
                <trackingCode9>test9</trackingCode9>
                <trackingCode10>test10</trackingCode10>
            </tracking>
            <panelists>
                <panelistPassword>String</panelistPassword>
                <panelist>
                    <name>panelist01</name>
                    <title>panelistTitle</title>
                    <company>webex</company>
                    <webExId>test</webExId>
                    <address>
                        <addressType>PERSONAL</addressType>
                        <address1>String1</address1>
                        <address2>String2</address2>
                        <city>String1</city>
                        <state>String2</state>
                        <zipCode>215011</zipCode>
                        <country>china</country>
                    </address>
                    <phones>
                        <phone>123456</phone>
                        <mobilePhone>0123545</mobilePhone>
                        <fax>0123545</fax>
                    </phones>
                    <email>stevez@sz.webex.com</email>
                    <notes>String</notes>
                    <url>String</url>
                    <type>PANELIST</type>
                </panelist>
            </panelists>
            <attendees>
                <attendee>
                    <name>attendee01</name>
                    <title>attendeeTitle</title>
                    <company>webex</company>
                    <webExId>test</webExId>
                    <address>
                        <addressType>PERSONAL</addressType>
                        <address1>String1</address1>
                        <address2>String2</address2>
                        <city>String1</city>
                        <state>String2</state>
                        <zipCode>215011</zipCode>
                        <country>china</country>
                    </address>
                    <phones>
                        <phone>456566</phone>
                        <mobilePhone>9076</mobilePhone>
                        <fax>46</fax>
                    </phones>
                    <email>test@sz.webex.com</email>
                    <notes>String</notes>
                    <url>String</url>
                    <type>VISITOR</type>
                </attendee>
            </attendees>
            <extOptions>
                <enrollmentNumber>100</enrollmentNumber>
                <destinationURL>String</destinationURL>
                <allowInviteFriend>true</allowInviteFriend>
                <viewAttendeeList>HOST,PRESENTER,PANELISTS</viewAttendeeList>
            </extOptions>
            <emailTemplates>
                <format>TEXT</format>
                <invitationMsgs>
                    <participantsEmail>
                        <subject>Your invitation to -- %Topic%</subject>
                        <from>%SenderEmailAddress%</from>
                        <replyTo>%HostEmail%</replyTo>
                        <content>Hello %ParticipantName%, %HostName% has invited you
                            to attend a Webinar on the web using WebEx. Topic: %Topic%
                            Date: %MeetingDate% Time: %MeetingTime%, %EventTimeZone%
                            Enrollment password: %RegistrationPassword% To attend
                            this webinar, you must first register for it. Please click
                            the following link to see more information about and
                            register for this event. Once you have registered for the
                            session, you will receive an email message confirming your
                            registration. This message will provide the information
                            that you need to join the session. Please click the
                            following link to see more information about the event and
                            register. %MeetingInfoURL% To contact %HostName%,
                            %PhoneContactInfo% send a message to this address:
                            %HostEmail% %EmailFooter%
                        </content>
                    </participantsEmail>
                    <panelistsEmail>
                        <subject>
                            You're invited to be a panelist a Webinar: -- %Topic%
                        </subject>
                        <from>%SenderEmailAddress%</from>
                        <replyTo>%HostEmail%</replyTo>
                        <content>Hello %PanelistName%, %HostName% has invited you to
                            be a panelist in a Webinar on the web using WebEx. Topic:
                            %Topic% Date: %MeetingDate% Time: %MeetingTime%,
                            %EventTimeZone% Event Number: %MeetingNumber% Event
                            Entrance for Attendees: %MeetingInfoURL% Panelist
                            Password: %PanelistPassword% (Please do not share
                            panelist password) Teleconference: %TeleconferenceInfo%
                            %PanelistJoinBeforeHost% %PanelistEntranceURL%
                            %UCFAttendeeVerifyPlayers% To contact %HostName%,
                            %PhoneContactInfo% send a message to this address:
                            %HostEmail% %EmailFooter%
                        </content>
                    </panelistsEmail>
                </invitationMsgs>
                <enrollmentMsgs>
                    <pendingEmail>
                        <subject>Enrollment Pending</subject>
                        <from>%SenderEmailAddress%</from>
                        <replyTo>%HostEmail%</replyTo>
                        <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%
                        </content>
                        <send>true</send>
                    </pendingEmail>
                </enrollmentMsgs>
                <reminderMsgs>
                    <firstReminder>
                        <subject>Event Reminder</subject>
                        <from>%SenderEmailAddress%</from>
                        <replyTo>%HostEmail%</replyTo>
                        <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)
                        </content>
                        <send>true</send>
                        <sendDateTime>05/20/2004 10:00:00</sendDateTime>
                    </firstReminder>
                </reminderMsgs>
                <followUpMsgs>
                    <thanksForAttending>
                        <subject>Event Thank you</subject>
                        <from>%SenderEmailAddress%</from>
                        <replyTo>%HostEmail%</replyTo>
                        <content>Hello %AttendeeName%, Thank you for attending the
                            event %Topic% on %MeetingDate%. If you have comments or
                            questions concerning the event, you can contact %HostName%
                            by: Phone: %HostPhone% Email: %HostEmail% We look forward
                            to seeing you again. %EmailFooter%
                        </content>
                        <send>true</send>
                        <sendDateTime>05/20/2004 10:00:00</sendDateTime>
                    </thanksForAttending>
                </followUpMsgs>
            </emailTemplates>
            <enrollment>
                <idReq>true</idReq>
                <passwordReq>true</passwordReq>
                <password>password</password>
                <approvalReq>true</approvalReq>
                <approvalRules>
                    <rule>
                        <enrollFieldID>-4</enrollFieldID>
                        <condition>CONTAINS</condition>
                        <queryField>query word</queryField>
                        <action>REJECT</action>
                        <matchCase>false</matchCase>
                    </rule>
                </approvalRules>
            </enrollment>
            <enrollmentForm>
                <standardFields>
                    <city>
                        <incl>true</incl>
                        <req>false</req>
                    </city>
                    <state>
                        <incl>true</incl>
                        <req>false</req>
                    </state>
                </standardFields>
                <customFields>
                    <textBox>
                        <incl>true</incl>
                        <req>true</req>
                        <label>old</label>
                        <type>SINGLE_LINE</type>
                        <width>50</width>
                    </textBox>
                    <checkBoxGroup>
                        <incl>true</incl>
                        <req>false</req>
                        <label>sex</label>
                        <checkBox>
                            <label>man</label>
                            <score>1</score>
                            <state>SELECTED</state>
                        </checkBox>
                        <checkBox>
                            <label>woman</label>
                            <score>2</score>
                            <state>CLEARED</state>
                        </checkBox>
                    </checkBoxGroup>
                </customFields>
            </enrollmentForm>
        </bodyContent>
    </body>
</serv:message>

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context.

For descriptions of the non-global elements, see Elements in the Event Session Service.

For enrollment, reminder, and follow-up email messages, your event service website sends them automatically. However, you can also send those messages manually at any time after you schedule or update the event, or take actions upon the enrollment requests.

For invitation emails, your event service website does not send them automatically. You need to call the SendInvitationEmail API to send the invitation email messages to invited attendees and panelists. For details, please refer to “SendInvitationEmail”. You can also send those messages on the Event Information page, after you schedule or update the event.

Response

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

Figure 7-2 • Schema diagram for `createEventResponse`

The following sample XML document shows an example of a possible response to the preceding request document.

xml

Copy<?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: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:createEventResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <event:sessionKey>804606039</event:sessionKey>
            <event:guestToken>66d8f3aae7e410a9ed2d1e95bd6486f4</event:guestToken>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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