Webex XML API

Elements in WebEx XML Schema Definitions for the Event Session Service

The following table describes all the elements that are used in the WebEx XML API for the service of event sessions.

Element Constraint(s) Description
absenteeFollowUp Optional. Complex. Defines the template for Absentee Followup Email that is sent to the enrollees who did not attend the event session.
acceptedEmail Optional. Complex. Defines the template for Enrollment Accepted Email which notifies an enrollee that his or her enrollment request has been accepted by the host.
action Required. Enumeration. Valid values are REJECT and APPROVE. Indicates which action to take upon the attendees' enrollments according to the approval rules. Default is REJECT.
address1 Optional. Maximum of 128 characters. The first line of the attendee's street address. Default is "".
address2 Optional. Maximum of 128 characters. The second line of the attendee's street address. Default is "".
addressType Optional. Must be set to either PERSONAL or GLOBAL when the meeting participant that this service represents is not a registered WebEx user. Determines whether the session participant is a personal contact of the session host or is a site-wide (global) contact. Default is PERSONAL.
afterEnrollmentURL Optional. String. The URL after a program enrollment.
allowInviteFriend Optional. Boolean. Valid values are TRUE and FALSE. Indicates whether the current event session allows its attendee to invite a friend to the session. Default is TRUE.
approvalReq Optional. Boolean. Valid values are TRUE and FALSE. Indicates whether the current event session requires enrollment. Default is TRUE.
assistConfirm Optional. Enum {Pending, Confirmed, Canceled} Assist meeting's confirm type. Defaults to Pending.
assistRequest Optional. Enum {None, Dry Run, Consult, Live Event Support, Audio Streaming, Video} Assist meeting's request type. Defaults to None.
attendees Optional. Boolean. Valid values are TRUE and FALSE. Indicates whether to send invitation email messages to attendees. Default is TRUE.
avgLeadScore Required. Float. The average score of the leading user.
broadcastAudioStream Boolean. Optional. Default value is FALSE. Indicates whether the audio streaming broadcast of a teleconference of an event session is enabled.
Note: If you want to use audio streaming, your WebEx service site should have the multimedia platform option enabled.
budget Optional. String. The budget for one program.
city Optional. Maximum of 64 characters. The attendee's city. Default is "".
company Optional. Maximum of 128 characters. The attendee's company name. Default is "".
condition Required. Enumeration. Valid values are CONTAINS, DOESNOT_CONTAIN, BEGINS_WITH, and ENDS_WITH. Specifies the conditions for the approval rules upon attendee enrollments. Default is CONTAINS.
content Optional. String. The body text in an email template.
count Required. Long. The source count.
country Optional. Maximum of 64 characters. The attendee's country. Default is "".
countryAlias Required. String. Holds a country's alias.
default Optional. Boolean. Indicates whether to use the site default session template of a service for session scheduling. Default: FALSE.
defaultChoice Optional. Integer. Indicates the index number of the default choice.
defaultHighestMT Optional. Boolean. Defaults to TRUE. This element is used in conjunction with the sessionType element to set the session type when creating an Event Center session.

If sessionType is specified, then CreateEvent will use this session type and defaultHighestMT will be ignored.

If sessionType is unspecified, then:
■ If defaultHighestMT = TRUE (the default), CreateEvent will use the highest Event session type available for a host.
■ If defaultHighestMT = FALSE, CreateEvent will use the default Event session type = 9.

Most applications should leave sessionType and defaultHighestMT unspecified, which will automatically select the preferred highest Event Center session type available for a host.
deliveredEmail Optional. Enumerated string. Address of invitation emails that have been sent successfully. Default is "".
description Optional. Required for Create. Maximum of 2500 characters. The description of the event session.
destinationURL Optional. String. The URL for accessing the recorded event session.
display Optional. Enum {NO_DISPLAY, POPUP_WINDOW, MAIN_WINDOW} Determines how to display a post event survey to attendees.
displayQuickStartHost Optional. Boolean. Indicates whether the Quick Start tab in the session manager is displayed to the host and presenter as they enter an event session.
duration Optional. If populated, must be a positive integer. The duration of the event session in minutes.
email Required if attendee or panelist element is specified. String. The email address of the corresponding attendee or panelist.
email (in all requests) Optional. String. The email address as stored in the user profile used for authentication in the security header. Authentication is not case sensitive.
emailInvitations Optional. Valid values are TRUE and FALSE. Whether to send invitation email messages to the meeting session attendees. Default is FALSE.
enableTSP Optional. Valid values are TRUE and FALSE. Enables the integrated partner Teleconferencing Service Provider functionality.
endDate Optional. String. The ending date and time of the event session. Formatted as MM/DD/YYYY HH:MM:SS.
endDateEnd Optional. String. End of range of dates from which a user can select for the end date for an event session. Formatted as MM/DD/YYYY HH:MM:SS.
endDateStart Optional. Beginning of range of dates from which a user can select for the end date for an event session. Formatted as MM/DD/YYYY HH:MM:SS.
endURLAfterEnroll Optional. String (max length of 128). The destination URL after attendee enrollment.
enforcePassword Optional. Boolean. Default value is FALSE. If TRUE, throw an exception when specified sessionPassword does not meet any of the strict password criteria defined in the Site Administration tool.

To enforce password security when creating an Event with XML API, make sure you have both selected the Apply strict password option and defined strict password criteria in Site Administration, and then set this element to TRUE.

If FALSE, the session password will not be checked for security even if Apply strict password is selected in Site Administration.
enrollField Required. String. Name of an enrollment field.
enrollFieldID Required. Long. Unique identifier for an enrollment field that the approval rule applies to. Default is -13.
enrollmentNumber Optional. Integer. Maximum number of enrollments for the event session.
entryExitTone Optional. Enumerated string. Valid values are NOTONE, BEEP, ANNOUNCENAME. The sound that all attendees hear when an attendee joins or exits the event session.
estAttendance Required. Long. Holds the estimated attendance.
estEnrollment Required. Long. Holds the estimated enrollment.
eventID Optional. Long. An internal unique ID number for an Event Center session. Equivalent to sessionKey.
eventName Required. String. The name of the recorded event.
eventType Required. String. List status of the recorded event session. Valid values are PUBLIC and PRIVATE. For more information, see listStatus.
eventUpdatedEmail Optional. Complex. Defines the template for Event Updated Email which notifies an enrollee that the event has been updated by the host.
expectedEnrollment Optional. String. The expected enrollment for one program.
extNotifyTime Optional. Integer. The number of times to notify someone.
extTelephonyDescription Optional. Maximum of 2,048 characters. A description of your telephony services if you use your own as indicated in extTelephonyURL and in telephonySupport. By default, this is "Enter teleconference number, pass code, and other instructions here."
extTelephonyURL Optional. Maximum of 2,048 characters. The URL of your telephony server if you want to use it as an alternative to WebEx to support the session's voice communications (session is still recordable). Can be set only if you have super admin privilege.
extURL Optional. String. External URL.
fax Optional. Maximum of 64 characters. The user's fax number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional.
For example, "11,444,5551212" or "5553234". Default is "".
fieldID Optional. Long. Unique identifier generated by the API server for the field.
firstReminder Optional. Complex. Defines the template for First Reminder Email which notifies an enrollee that he or she has enrolled an event with the event information included.
format Optional. Enumeration. Valid values are TEXT and HTML. Specifies the email format for all email templates. Default is TEXT.
from Optional. String. Maximum of 128 characters. Indicates the email address of the sender.
futureInfo Optional. Complex. Allows the attendees to specify whether they would like to receive information about future seminars via email messages.
globalNum Optional. Container. Corresponds to the Global Call-in Numbers in the telephony domain.
guestToken Optional. String. Contains the guest's token for a session.
height Optional. Integer. Specifies the number of lines for the text box on the enrollment form.
hostKey Optional. String. The host key of a session host. The host key allows the host to pass privileges to another attendee or to reclaim the host role upon rejoining a session.
hostType Optional. String. Code specifying the application used to schedule and start the meeting. hostType has the following format xyyyzzz where:
■ (x) Meeting type: 1 - Regular, 2 - oneclick.
■ (yyy) Scheduled from: 001 - webpage, 002 - PT, 003 - OI, 004 - NI, 005 - MSN, 006 - Yahoo, 007 - AIM, 008 - Skype, 009 - Gtalk, 010 - Sametime, 011 - LCS, 012 - WebexToolbar, 013 - IPPhone, 016 - iPhone dusting, 017 - Webex Connect, 018 - TP meeting, 019 - generic XML API app.
■ (zzz) Started from: Uses the same codes as yyy.
hostWebExID String. The user name of a host.
iCalendar Optional. Boolean. Valid values are TRUE and FALSE. Mapping to EC scheduler page "include iCalendar attachments" options, determines whether or not to send the including iCalendar attachment. Defaults to either the Meeting Template or Site setting.
idReq Optional. Boolean. Valid values are TRUE and FALSE. Specifies whether the current event session requires attendees to provide enrollment ID before they can join. Default is FALSE.
Note: The value switches to TRUE if passwordReq=TRUE.
imageData Required. Base64Binary encoded data. The Base64Binary encoded data of the JPG/GIF image that the host uploads.
imageType Required. Enumeration. Valid values are JPG and GIF. The image type for the picture that the host uploads.
incl Optional. Boolean. Valid values are TRUE and FALSE. Specifies whether to include current field in the enrollment form. Default is TRUE.
index Optional. Integer. Indexing number of the item.
intLocalCallIn Optional. Valid values are TRUE and FALSE. Allows access to WebEx teleconferencing via international local call-in telephone numbers in a WebEx event. Default: FALSE.
intLocalNum Optional. String. Returns the international local call-in telephone numbers for WebEx teleconferencing in an event. This element is only returned in GetEvent and its value is ignored in Create/SetEvent.
isAccessPassword Optional. Valid values are TRUE and FALSE. Whether accessing the recorded event requires password.
isCETMeeting Optional. Boolean. Indicates whether the event supports Webex video platform version 2 (CMR Version 4.0).
isEnrollmentPassword Optional. Valid values are TRUE and FALSE. Whether the event session requires a password for enrollment. The default value is FALSE.
joinNotifyURL Optional. String. URL of the notification message.
joinTeleconfBeforeHost Optional. Valid values are TRUE and FALSE. Determines whether or not attendees are allowed to join the teleconference before the host.
Defaults to FALSE.
label Required. String. Maximum of 256 characters. Specifies the label for the current field.
Default is "".
leadSourceID Required. String. The ID of the leading user.
listing Optional. Indicates which users can see this scheduled session in lists of events on pages on your WebEx-hosted website. Valid values are:
■ UNLISTED: Unlisted for all users except the host.
■ PUBLIC: Listed for all users.
■ PRIVATE: Listed only for authorized users.
Default is PUBLIC.
listMethod Optional. Enumerated string. Valid values are AND and OR. Specifies whether to use AND or OR for multiple search values as described in "Specifying Boolean Relationships for Searches" on page 55. Default is AND.
listStatus Optional. Indicates which users can see this scheduled session in lists of events on pages on your WebEx-hosted website. Valid values are:
■ UNLISTED: Unlisted for all users except the host.
■ PUBLIC: Listed for all users.
■ PRIVATE: Listed only for authorized users.
matchCase Optional. Boolean. Valid values are TRUE and FALSE. Specifies whether the query field of the approval rule is case sensitive. Default is FALSE.
matchingRecords Optional. Contains information about the returned records. See also total, returned, and startFrom for more information.
maximumNum Optional. Integer. Limits the quantity of returned records as described in "Choosing A Subset of Records" on page 54.
minutesAhead Optional. Integer. Number of minutes ahead of the event session to send the reminding messages.
mobilePhone Optional. Maximum of 64 characters. The user's mobile phone number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, "11,444,5551212" or "5553234". Default is "".
muteUponEntry Optional. Valid values are TRUE and FALSE. Determines whether or not all participant callers will be muted upon joining the meeting. Defaults to FALSE.
name Required for each attendee or panelist specified. Maximum of 64 characters. The name of the session participant (attendee or panelist).
notes Optional. Maximum of 2,048 characters. The host's notes about the session attendee or panelist. Default is "".
numEmployees Optional. Complex. Allows the enrollee to specify the number of employees in his or her organization.
numPhoneLines Optional. If populated, must be a nonzero value. The number of phone lines to reserve, when using WebEx-supplied telephony, for the session. By accurately forecasting this number, you enable WebEx to reserve the appropriate number of phone lines for the event. Default: 4.
openTime Optional. Integer. Valid values are 0, 5, 10, 15, 20, 30, 45, and 60. Defines the number of minutes allowed for the attendees to join the event session before the start time. Default is 15.
Note: Specifying a value other than the valid values may cause problems.
orderAD Optional. Valid values are ASC and DESC. Whether to sort the result in ascending or descending order when using orderBy.
orderBy Optional. Enumerated string. Valid values are EVENTNAME, STARTTIME and HOSTWEBEXID. Which elements to sort by in the sessions returned.
panelistPassword Optional. String. Session password of a panelist.
panelists Optional. Boolean. Valid values are TRUE and FALSE. Indicates whether to send invitation email messages to panelists. Default is FALSE.
panelistsEmail Optional. Complex. Defines the template for Panelists Invitation Email that is sent to all panelists of the event session.
panelistNumericPassword Optional. String. Password for joining the Webex meeting from a video conferencing system or application.
panelistsInfo Optional. String. Panelists Info for a scheduled event.
participantLimit Optional. Integer. Maximum number of participants allowed.
participantsEmail Optional. Complex. Defines the template for Invitee Invitation Email that is sent to all invited participants of the event session.
Note: If the event session's listing status is PRIVATE, this template is titled "Invitee Invitation for Private Event"; otherwise, this template is titled "Invitee Invitation for Public or Unlisted Event".
password Optional. String. Maximum of 16 characters. The password for the attendees when they enroll for the event. Default is "".
passwordReq Optional. Boolean. Valid values are TRUE and FALSE. Specifies whether the current event session requires attendees to provide password before they can enroll. Default is FALSE.
Note: The value switches to TRUE if the host specifies an enrollment password when scheduling.
pendingEmail Optional. Complex. Defines the template for Enrollment Pending Email that notifies an enrollee that his or her enrollment status is now pending.
personalAccountIndex Optional. Integer. The index number of the personal teleconference account to be used; if not specified, then personal teleconferencing is not used.
phone Optional. Maximum of 64 characters. The user's phone number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, "11,444,5551212" or "5553234". Default is "".
phoneNumber Required. String. Holds the global phone number.
playTime Optional. Integer. The duration of the recorded event session.
postalCode Optional. Maximum of 16 characters. The postal code of the enrollee's address. Default is "".
postEventSurvey Optional. Container. Holds the post event survey fields.
programID Optional. Long. The identifier for a program (campaign).
programID (in metaData) Optional. Integer. Assigns the program identifier for an event. Default is 0.
programName Required. String. The topic for one program in a returned set of programs.
programURL Optional. String. The URL of a Web page for one program.
queryField Required. String. Maximum of 50 characters. The query word that matches the approval rule. Default is "".
Note: Quotation marks are not allowed in queryField.
recordFilePath Optional. String. The file path of the recorded event session on the server.
recordingStartTime Optional. String. The starting time of the recording.
registration Optional. Boolean. Valid values are TRUE and FALSE. Indicates whether or not the event requires registration.
rejectedEmail Optional. Complex. Defines the template for Enrollment Rejected Email that notifies an enrollee that his or her enrollment request has been declined by the host.
replyTo Optional. String. Maximum of 128 characters. The email address for the recipients to send reply email messages.
req Optional. Boolean. Valid values are TRUE and FALSE. Specifies whether to make the current field required in the enrollment form. Default is FALSE.
returned Required. Integer. Number of records returned in this response. See also matchingRecords.
score Optional. Integer. The score for current field.
secondReminder Optional. Complex. Defines the template for First Reminder Email which notifies an enrollee that he or she has enrolled an event with the event information included.
send Optional. Boolean. Valid values are TRUE and FALSE. Whether to send current email message. Default is TRUE.
sendDateTime Optional. String. Specifies the time to send current email message. Default is session scheduled start time. Formatted as MM/DD/YYYY HH:MM:SS.
sessionKey Required for Get, Set, and Del. Optional for Lst. Not applicable for Create. Must be non-null. A WebEx-assigned session-unique value that is needed to identify the particular event session.
sessionName Required for Create. String. The name of the event session.
sessionPassword Optional. Maximum of 16 characters. The password for the event session. If a value is specified, then attendees are prompted for a password before they can join the event session. A null password for this element is the same as not using this element.

The event session password will be validated against the password security options (if enabled) in the Site Administration tool.

If the password security rules are violated, an exception occurs.
sessionType Optional. Integer. In CreateEvent, if sessionType is specified, then CreateEvent will use this session type and defaultHighestMT will be ignored.

If sessionType is unspecified, then:
■ If defaultHighestMT=TRUE (the default), CreateEvent will use the highest Event session type available for a host.
■ If defaultHighestMT=FALSE, CreateEvent will use the default Event session type = 9.

Most applications should leave sessionType and defaultHighestMT unspecified, which will automatically select the preferred highest Event Center session type available for a host.

In GetEventResponse, returns the session type of an Event session.

In SetEvent, updates the session type of an Event session.
sipURL Optional. String. URL for joining the Webex meeting from a video conferencing system or application. 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 3.0 or later) for events (previously referred to as the Event Center, or EC).
size Required. Integer. The file size of the recorded event.
standaloneDialingIPAddress Optional. String. IP Address for dialing in to the Webex meeting from a video conferencing system or application.
startDate Optional. String. The starting date and time of the event session. Formatted as MM/DD/YYYY HH:MM:SS.
startDateEnd Optional. String. End of range of dates from which a user can select for the start date for the event sessions. Formatted as MM/DD/YYYY HH:MM:SS.
startDateStart Optional. String. Beginning of range of dates from which a user can select for the start date for the event sessions. Formatted as MM/DD/YYYY HH:MM:SS.
startFrom Required. Integer. When a records set is returned, indicates the record index number from which the set starts. See also matchingRecords.
state (in attendee) Optional. Maximum of 32 characters. The attendee's state of residence. Default is "".
state (in checkBox) Optional. Enumeration. Valid values are CLEARED and SELECTED. The status of current check box. Default is CLEARED.
status Optional. String. Valid values are INPROGRESS or NOT_INPROGRESS. Indicates whether the session is either started and active or not active. Its value is generated by WebEx and cannot be changed. Default: NOT_INPROGRESS.
subject Optional. String. Maximum of 512 characters. The subject of current email template.
teleconfLocation Optional. String. Holds information about teleconferencing country location.
telephonySupport Optional. Valid values are NONE, CALLIN, CALLBACK, and OTHER. Indicates whether telephony is supported and, if so, in what mode. Default: NONE. Meanings are:
■ NONE: The session does not support telephony; for all other values, telephony is supported.
■ CALLIN: Call-in teleconference (attendees call in to join the meeting or session).
■ CALLBACK: Call-back teleconference (attendees receive a callback to join the meeting or session).
■ OTHER: Other teleconferencing service; in this case, you can describe the service using extTelephonyDescription.
thanksForAttending Optional. Complex. Defines the template for Thanks For Attending Email that is sent to all participants after the event session ends.
timeZoneID Optional. An integer ranging from 0 to 61. Determines the time zone for the geographic location of the event. For details, see Appendix A, Time Zone, Language Encoding, and Country Codes.
title Optional. Maximum of 128 characters. The participant's title. Default is "".
tollFree Optional. Valid values are TRUE and FALSE. Specifies whether toll-free call-in numbers are enabled.
tollFreeNum Optional. String. Returns the toll-free call-in number for WebEx teleconferencing in a WebEx event. This element is only returned in GetEvent and its value is ignored in Create/SetEvent.
tollNum Required if callInNum is specified. String. Returns the toll call-in number for WebEx teleconferencing in a WebEx event. This element is only returned in GetEvent and its value is ignored in Create/SetEvent.
total Required. A positive integer. Total number of records matching the query. See also matchingRecords.
trackingCode1..10 Optional. Maximum of 128 characters. Ten text elements that you can use for any information about a session, such as project names, departments, or anything else of your choice.
tspAccessCodeOrder Optional. Determines in which order access codes should be used.
tspAccountIndex Optional. An integer ranging from 1 to 3. Designates which of the subscriber's teleconferencing accounts (1-3) to use for the session. Requires enableTSP=TRUE and the user to have defined their teleconferencing service provider accounts in create/SetUser.
type (in attendees or panelists) Optional. Valid values are MEMBER, VISITOR and PANELIST. The WebEx-maintained determination of whether the session participant (attendee or panelist) represented by a service of this type is a member (registered on your WebEx XML server as a user) or a visitor or a panelist. Default: VISITOR.
type (in textBox) Optional. Enumeration. Valid values are SINGLE_LINE and MULTI_LINE.
url (in attendee) Optional. Maximum of 128 characters. The user's URL, such as the URL of the attendee's office. Default is "".
use Optional. String. Indicates the name of the session template whose settings are used for meeting scheduling options.
viewAttendeeList Optional. Enumerated string. Indicates the role that can view the attendee list. Valid values are:
■ ALL
■ HOST, PRESENTER, PANELISTS
viewURL Required. String. An URL string to access the streaming recording. Corresponds to "Stream recording link" in the web page.
voip Optional. Valid values are TRUE and FALSE. Specifies if voice over IP is enabled for the session. Default is defined in the Site Admin and session template.
webExId Optional. Maximum of 64 characters. A reference to the WebEx user account for the session participant.
width Optional. Integer. Specifies the number of lines for the text box on the enrollment form.
zipCode Optional. Maximum of 16 characters. The ZIP Code portion of the participant's address. Default is "".
Next