Webex XML API

Elements in WebEx XML Schema Definitions for the Meeting Service

The following table describes elements that are used in the WebEx XML API for the Meeting service.

Element Constraint(s) Description
accountIndex Optional. Integer. Indicates the account number of a personal conference number, not available for request conference number.
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 meeting participant is a personal contact of the meeting host or is a site-wide (global) contact. Default: “PERSONAL”.
afterMeetingNumber Optional. An integer in the range 0 - 999. For recurring meetings, determines the number of meeting instances to repeat.
agenda Optional. Maximum of 2,500 characters. An agenda of the meeting.
allowContactPrivate Optional. Valid values are TRUE and FALSE. Whether to allow attendees to contact the operator privately.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
annotation Optional. Valid values are TRUE and FALSE. Indicates whether annotation is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
applicationShare Optional. Valid values are TRUE and FALSE. Indicates whether application sharing is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
assistConfirm Optional. Enum {Pending, Confirmed, Cancelled} 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.
attendee Required. String. The URL of an iCalendar file containing meeting information for an attendee.
attendeeEmail Optional. String. Maximum of 64 characters. The email address of the attendee.
attendeeList Optional. Valid values are TRUE and FALSE. Indicates whether an attendee listing is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
attendeeName Optional. String. The attendee’s first name and last name.
attendeeOptions Optional. Complex. Meeting options for the attendees.
Note: For the sake of backward compatibility, the enclosed elements follow the following logic:
■ If auto is set to TRUE, then both registration and request are set to TRUE automatically.
■ If auto is set to FALSE, and either registration or request is set to TRUE, then both registration and request are set to TRUE automatically.
■ If auto is set to FALSE, and both registration and request are set to FALSE, then all the three elements (auto, registration and request) remain unchanged.
See also auto, registration and request.
attendeeRecordMeeting Optional. Valid values are TRUE and FALSE. Indicates whether attendees can record the meeting.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
audioVideo Optional. Valid values are TRUE and FALSE. Indicates whether audio and/or video (from a webcam) is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
auto Optional. Valid values are TRUE and FALSE. Indicates whether all registration requests are automatically accepted. Default: FALSE. See also attendeeOptions.
autoDeleteAfterMeetingEnd Optional. Valid values are TRUE and FALSE. Automatically deletes the meeting from calender after the meeting ends. Defaults to the host’s setting of this option in My Profile of My WebEx.
autoRecord Optional. Boolean Determines whether meetings that are automatically recorded. autoRecord 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 autoRecord.
chat Optional. Valid values are TRUE and FALSE. Indicates whether chat is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
chatAllAttendees Optional. Valid values are TRUE and FALSE. Allows an attendee to participate in private chat with all other attendees.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
chatHost Optional. Valid values are TRUE and FALSE. Allows attendees to participate in private chat with host.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
chatPresenter Optional. Valid values are TRUE and FALSE. Allows attendees to participate in private chat with presenter.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
city Optional. Maximum of 64 characters. The attendee’s city. Default is “”.
closedCaptions Optional. Valid values are TRUE and FALSE. Enables the Closed Captions note taking functionality.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
company Optional. Maximum of 128 characters. The attendee’s company name.
confName Required for Create. Must be a non-null value. Optional for Lst and Set. Not applicable for all other actions. Maximum of 512 characters. The name of the meeting.
contactID Optional. Long. If populated, A reference to another service. A WebEx-maintained reference to the contact information for a meeting attendee.
copyPage Optional. Valid values are TRUE and FALSE. Indicates whether page copying is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
country Optional. Maximum of 64 characters. The attendee’s country. Default is ““.
countyAlias Required. String. Holds the country’s alias.
day Optional. Enumerated string. Valid values are SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, and SATURDAY. For a recurring session, when repeatType=WEEKLY, multiple days can be specified.
dayInMonth Optional. An integer from 1 to 31. For a recurring session, when repeatType=MONTHLY, a specific day in each month can be specified.
dayInWeek Optional. Valid values are SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, and SATURDAY. For a recurring event, on which days of the week it recurs. Works in conjunction with repeatType and interval.
dayInYear This element is deprecated.
daysAhead Optional. If populated, must be a positive integer. Number of days ahead of the meeting to send RemindEmail or call RemindMobile when sendMail or sendMobile is TRUE. Works with hoursAhead and minutesAhead to determine exactly when the message is sent. 0 means the day of the event. Default: “0”.
default Optional. Boolean. Indicates whether to use the site default session template of a service for meeting scheduling. Default: FALSE.
desktopShare Optional. Valid values are TRUE and FALSE. Indicates whether desktop sharing is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
displayQuickStartAttendees Optional. Boolean. Indicates whether the Quick Start tab in the session manager is displayed to attendees as they enter a meeting.
displayQuickStartHost Optional. Boolean. Indicates whether the Quick Start tab in the session manager is displayed to the host and presenter as they enter a meeting.
duration Optional. If populated, must be a positive integer. The duration of the meeting in minutes. Default is 60. Must be no more than the MaxMeetingDuration, which has been set by the WebEx administrator and is defined in the Super Admin Site.
email Required. Maximum of 64 characters. The user’s email address.
emailInvitations Optional. Valid values are TRUE and FALSE. Whether to send invitation email messages to the meeting session attendees. Default is FALSE.
enableReg Optional. Valid values are TRUE and FALSE. This is a deprecated field.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
enableReminder Optional. Valid values are TRUE and FALSE. TRUE for reminders to be enabled; FALSE for no reminder. WebEx turns this value to TRUE if sendMail or sendMobile is set.
enableTSP Optional. Valid values are TRUE and FALSE. Enables the integrated partner Teleconferencing Service Provider functionality.
endDateEnd Optional. End of range of dates from which a user can select for the end date for a meeting.
endDateStart Optional. Beginning of range of dates from which a user can select for the end date for a meeting. Formatted as MM/DD/YYYY HH:MM:SS.
enforcePassword Optional. Boolean. Default value is FALSE. If TRUE, throw an exception when specified meetingPassword does not meet any of the strict password criteria defined in the Site Administration tool.

To enforce password security when creating a Meeting 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 meeting password will not be checked for security even if Apply strict password is selected in Site Administration.
entryExitTone Optional. Valid values are:
For Meeting Center, Training Center:
■ 0: Beep
■ 1: Announcement
■ 2: No Tone

For Event Center:
■ 0: No Tone
■ 1: Beep
■ 2: Announcement		 The sound that all attendees hear when an attendee joins or exits a meeting.
eventID Optional. Long. An internal unique ID number for a Meeting Center session. Equivalent to meetingKey.
excludePassword Optional. Valid values are TRUE and FALSE. Specifies whether the meeting password should be excluded (true) from the email invitation to an attendee.
expirationDate Optional. The date and time after which a meeting that was set to automatically repeat stops repeating; leave empty to let the meeting repeat forever. Formatted as MM/DD/YYYY HH:MM:SS.
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.
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 meeting’s voice communications (meeting is still recordable). Can be set only if you have super administration privilege.
extURL Optional. String. External URL.
fax Optional. Maximum of 64 characters. The attendee’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 “”.
faxIntoMeeting Optional. Valid values are TRUE and FALSE. Internal use only.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
fileShare Optional. Valid values are TRUE and FALSE. Indicates whether file sharing is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
firstName Optional. String. The first name of the attendee.
fullScreen Optional. Valid values are TRUE and FALSE. Indicates whether full screen is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
globalNum Optional. Container. Corresponds to the Global Call-in Numbers in the telephony domain.
greeting Optional. Maximum of 512 characters. The welcoming greeting for the participants of the meeting. This text appears in a welcome pop-up window.
host Required. String. The URL of an iCalendar file containing meeting information for the host.
hostJoined Boolean. If TRUE, indicates that the host is now in the session; otherwise, returns FALSE.
guestToken Optional. String. Contains the guest’s token for a session.
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.
hostMeetingURL Optional. Maximum of 128 characters. The URL for the host to start the meeting. Default is “”. This element takes the following format: https://customer.webex.com/customer/ p.php?AT=LI&WID=&PW =&MU=https://customer.w ebex.com/customer/m.php?AT=HM& MK=
hostType Optional. String. Returns a code that specifies the application used to schedule and start the meeting. hostType has the following format xyyyzzz where:
■ (x) Meeting type: 1 - Regular, 2 - one-click
■ (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 Optional. Maximum of 64 characters. The WebEx ID of the host user.
hoursAhead Optional. A positive integer. Number of hours ahead of the meeting to send email to RemindEmail or to call RemindMobile when sendEmail or sendMobile is TRUE. Works with daysAhead and minutesAhead to determine exactly when the message is sent. 0 means at the same time of day as indicated in the startDate, 1 is an hour earlier, and so on. Default: “0”.
■ Example 1: If daysAhead, hoursAhead, and minutesAhead are all zero, any reminders are sent on the day and the time of the event.
■ Example 2: If startDate is noon on a particular day, daysAhead is 1, and hoursAhead is 1, any reminders are sent at 11:00 on the day before the event.
HQvideo Optional. Valid values are TRUE and FALSE. Enables high-quality video for the session.

Defaults to the video options set in Site Admin “Default Scheduler Options”.
importDocument Optional. Valid values are TRUE and FALSE. Indicates whether document importing is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
interval Optional. An integer in the range 1 - 99. The interval for a repeating calendar session, as determined by repeatType. Default: 1. daysInWeek determines which days of the week specifically the repetitions occur.
intlLocalCallInNumber Required. String. Indicates the international local call-in telephone numbers for a teleconference-only session.
intLocalCallIn Optional. Valid values are TRUE and FALSE. Allows access to WebEx teleconferencing via international local call-in telephone numbers in a WebEx meeting. Default: FALSE.
intLocalNum Optional. String. Returns the international local call-in telephone numbers for WebEx teleconferencing in a meeting. This element is only returned in GetMeeting and its value is ignored in Create/SetMeeting.
invitation Optional. Maximum of 1,024 characters. The invitation for the meeting.
inviteMeetingURL Optional. String. The URL to have an attendee directly join a meeting from a PC or mobile. Only returned for Meeting Center sessions.
isInternal Optional. Valid values are TRUE and FALSE. Sets the meeting as internal. Defaults to FALSE.
isCETMeeting Optional. Boolean. Indicates whether the event supports Webex video platform version 2 (CMR Version 4.0).
isPublic Optional. Valid values are TRUE or FALSE. Determines whether the meeting displays to public users in Today’s Meetings list. Private meetings show only to the host; invited attendees must have information from the host about how to access the meeting. Default: FALSE.
javaClient Optional. Valid values are TRUE and FALSE. If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.

If the session needs to support only the Java-based Meeting Center client, then you should specify:
<javaClient>TRUE</javaClient>
If the session needs to support both Java and native clients, then specify both:
<javaClient>FALSE</javaClient> <nativeClient>FALSE</nativeClient>
joinMeetingURL Optional. Maximum of 128 characters. The URL for the attendee to join the meeting. Default is “”.
Note: If attendeeName is specified, joinMeetingURL takes the form of the AT=JM URL API command. Otherwise, the current join meeting URL is returned, which requires the user to enter his or her name, email and meeting password before the session starts.
joinNotifyURL Optional. String. URL of the notification message.
joinRequiresAccount Optional. Valid values are TRUE and FALSE. Specifies that attendees must have (true) an account.
joinStatus Optional. Valid values are REGISTER, ACCEPT, REJECT, and INVITE. Indicates the join status of the meeting attendee. Default: REGISTER.
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.
language Required. String. Valid values are: ENGLISH, INTERNATIONAL ENGLISH, SIMPLIFIED CHINESE, TRADITIONAL CHINESE, JAPANESE, KOREAN, FRENCH, CANADIAN FRENCH, GERMAN, ITALIAN, CASTILIAN SPANISH, SPANISH, SWEDISH, DUTCH, and BRAZILIAN PORTUGUESE. Language setting for the session attendee.
lastName Optional. String. The last name of the attendee.
listing Optional. Holds any control listings.
listMethod Optional. 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 sessions 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.
listToPublic Optional. Valid values are TRUE and FALSE. Determines whether the meeting is listed in the Today’s Scheduled Meetings page on the WebEx website. Default: FALSE. This element coexists with isPublic for backward compatibility.
location Optional. Maximum of 256 characters. Any site-defined location for the meeting.
maximumNum Optional. A nonnegative integer. Limits the quantity of returned objects as described in “Choosing A Subset of Records” on page 54.
maxUserNumber Optional. Numeric. A WebEx-maintained estimated number of participants (excluding the host) that can be in the meeting at the same time. Default is 4.
meetingKey Not applicable for Create and Lst. Required for all other requests. Must be non-null. A WebEx-assigned meeting-unique value that is needed to join or identify the particular meeting. A meeting may also be accessible from the Today’s Scheduled Meetings Web page. See also listToPublic.
meetingPassword Optional. Maximum of 16 characters. The password for the meeting. If a value is specified, then attendees are prompted for a password before they can join the meeting. A null password for this element is the same as not using this element.

A meeting password will be validated against the password security options (if enabled) in the Site Administration tool.

If any of the password security rules is violated, an exception will then occur.
meetingPW Optional. Maximum of 16 characters. The password for the meeting.
meetingRecord Optional. Valid values are TRUE and FALSE. Indicates whether recording of meetings is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
meetingType Optional. Integer. The session type ID for a Meeting Center session.
Note: If meetingType is not specified when you use CreateMeeting, the system will automatically determine a proper meeting type based on the following logic:
1 Among all the meeting types allowed for a host, choose a MC PRO based meeting type with the highest meeting type ID.
2 If unavailable, choose a MC STD based meeting type with the highest meeting type ID.
3 If unavailable, choose a MC FRE based meeting type with the highest meeting type ID.
4 If none of the meeting types are available, the system throws an exception.
minutesAhead Optional. Number of minutes ahead of the meeting to send RemindEmail or call RemindMobile when sendEmail or sendMobile is TRUE. Works with daysAhead and hoursAhead to determine exactly when the message is sent. 0 means no minutes beyond the number of hours in hoursAhead. Therefore, if daysAhead, hoursAhead, and minutesAhead are all zero, any reminders are sent at the time of the event. Default: 15.
mobile Optional. Maximum of 64 characters. A mobile phone number for the system to call as a reminder before the event. User can enter pager, cell phone, etc. Format is a series of commaseparated 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: “”.
mobilePhone Optional. Maximum of 64 characters. The attendee’s mobile phone number. Format is a series of commaseparated 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 “”.
monthInYear Optional. An integer from 1 to 12, respectively representing each month of a year. For recurring sessions, when repeatType=MONTHLY or YEARLY, specifies the month number.
multiVideo Optional. Valid values are TRUE and FALSE. Enables Multi-point Video capability.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
name Required. Maximum of 64 characters. The name of the meeting participant.
nativeClient Optional. Valid values are TRUE and FALSE. If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.

If the session needs to support only the native (Windows, Macintosh, etc.) Meeting Center client, then you should specify:
<nativeClient>TRUE</nativeClient>
If the session needs to support both Java and native clients, then specify: <javaClient>FALSE</javaClient> and <nativeClient>FALSE</nativeClient>
notes Optional. Valid values are TRUE and FALSE. Activates the session note-taking feature. If this is TRUE, then either <closedCaptions> or <singleNote> should be set to TRUE as well.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
numPhoneLines Optional. If populated, must be a nonzero value. The number of phone lines to reserve, when using WebEx-supplied telephony, for the meeting. By accurately forecasting this number, you enable WebEx to reserve the appropriate number of phone lines for the meeting. Default: 0.
openTime Optional. Integer. Valid values are 0, 560, 1060, and 15*60. The number of seconds attendees can join a session before its scheduled start time. Specifying a value other than the four valid values may cause problems.

If this is 0, then attendees can only join the session after the host has started it. Default: 0.

If registration is set to TRUE, and openTime is set to a nonzero value, a validation error occurs.
orderAD Optional. Valid values are ASC and DESC. When using orderBy, whether to sort in ascending or descending order.
orderBy Optional. Valid values are HOSTWEBEXID, CONFNAME, STARTTIME, TRACKINGCODE1..10. Which elements to sort by in the meetings returned.
otherHostWebExID Optional. Maximum of 64 characters. In lstsummaryMeetingResponse, this designates another user that can also edit and host the meeting.
panelistNumericPassword Optional. String. Password for joining the Webex meeting from a video conferencing system or application.
participantFullAccessCode Required. String. Indicates the access code for attendees who have full speaking privileges during a teleconference-only session.
participantLimit Optional. Integer. Maximum number of participants allowed in the meeting.
participantLimitedAccessCode Required. String. Indicates the access code for attendees who have limited speaking privileges during a teleconference-only session.
participantsJoined Boolean. If TRUE, indicates that there is at least one participant who has joined the session; otherwise, returns FALSE.
personalAccountIndex Optional. Integer. The index number of the personal teleconference account to be used; if not specified, then personal teleconferencing is not used.
personalConferenceNumber Required. Valid values are TRUE and FALSE. Indicates whether this is a personal conference number or request conference number. Default is FALSE.
phone Optional. Maximum of 64 characters. The attendee’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 Optional. String. Holds the phone number.
pointer Optional. Valid values are TRUE and FALSE. Indicates whether a screen pointer is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
poll Optional. Valid values are TRUE and FALSE. Indicates whether survey polling is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
presentation Optional. Valid values are TRUE and FALSE. Indicates whether whiteboard, presentation and document sharing are supported for sessions of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
printDocument Optional. Valid values are TRUE and FALSE. Indicates whether document printing is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
rcAppShare Optional. Valid values are TRUE and FALSE. Indicates whether remote application sharing is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
rcDesktopShare Optional. Valid values are TRUE and FALSE. Indicates whether remote desktop sharing is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
rcWebTour Optional. Valid values are TRUE and FALSE. Indicates whether remote Web touring is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
RegID Optional. String. The registration ID of the attendee.
registerMeetingURL Optional. String. The URL used by an attendee to register for a meeting from a PC or mobile device.
registration Optional. Valid values are TRUE and FALSE. Whether attendees must register to attend the meeting. Default: FALSE. See also attendeeOptions.
repeatType Optional. Valid values are DAILY, WEEKLY, NO_REPEAT, MONTHLY, YEARLY and CONSTANT. Determines whether the meeting repeats and at what interval. Works together with Interval to determine the exact number of days or weeks apart the repetitions occur.
Default: NO_REPEAT.
Meanings are:
■ DAILY: The event occurs every day of the week.
■ WEEKLY: The meeting recurs every week. Also see dayInWeek for which days.
■ NO_REPEAT: The meeting does not recur.
■ MONTHLY: The meeting recurs every month. Also see dayInMonth.
■ YEARLY: The meeting recurs every year. Also see monthInYear.
■ CONSTANT: The meeting has no fixed date or time so it that it always appears in the My Meetings list, even after it has occurred one or more times, but not in the Meeting Calendar (except for the originally scheduled date and time). A user can start another occurrence of this meeting at any time.
request Optional. Valid values are TRUE and FALSE. Request detailed attendee information. Default: FALSE. See also attendeeOptions.
requestConferenceNumber Optional. Boolean. Request the number of the conference.
requireAccount Optional. Boolean. Determines if a valid account is required.
requireUcfDiagnosis Optional. Boolean. Determines if a UCF diagnosis is required.
returned Required if matchingRecords is specified. Integer. The number of records returned in the response.
role Optional. Enumerated string. Valid values are ATTENDEE, PRESENTER and HOST. The role of the session attendee. The default is ATTENDEE.
Note: By setting role to HOST, you specify an attendee as an alternate host in a Meeting Center session.

If the site does not enable alternate host functionality, an exception is thrown.
saveDocument Optional. Valid values are TRUE and FALSE. Indicates whether document saving is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
scheduleConfID Required. Integer. Indicates the unique identifier of a scheduled teleconference-only session.
sendEmail Optional. Valid values are TRUE and FALSE. Indicates whether to send email as a reminder before the event. Works with daysAhead, hoursAhead, and minutesAhead to determine when to send the email.

If TRUE, the system sends a reminder email to the email address listed in RemindEmail. The default is FALSE.
sendFeedback Optional. Valid values are TRUE and FALSE. If TRUE, sends the feedback form responses to the host’s email.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
sendMobile Optional. Valid values are TRUE and FALSE. Indicates whether to call RemindMobile as a reminder before the event. Works with daysAhead, hoursAhead, and minutesAhead to determine when to call the mobile number. If TRUE, the system calls the number in RemindMobile. The default is FALSE.
sessionKey Not applicable for Create and Lst. Required for all other requests. Must be non-null. A WebEx-assigned meeting-unique value that is needed to join or identify the particular meeting. A meeting may also be accessible from the Today’s Scheduled Meetings Web page. See also listToPublic.
sessionPassword Optional. Maximum of 16 characters. The password for a teleconferenceonly meeting. A 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. The session type ID for a teleconference-only session. If sessionType is not specified when you use CreateTeleconferenceSession, the system will choose an AUO based session type with the highest session type ID.
setNonMTOptions Optional. Boolean. Activates the non MT Options.
showFileContPlayFlag Optional. Valid values are TRUE and FALSE. If TRUE, continuously plays the presentation specified in showFilePath.
showFileInterval Optional. Integer. Designates the number of seconds to wait in between each page of the automatically played document.
showFilePath Optional. String. Full file path of the document that shows automatically when participant joins the meeting.
showFileStartMode Optional. Valid values are TRUE and FALSE. If showFilePath is specified, then the meaning is:
■ TRUE: Automatically starts showing the document.
■ FALSE: Allows the participant to control the file.
singleNote Optional. Valid values are TRUE and FALSE. Enables the Single Note Taker functionality. A FALSE value enables the “Allow all participants to take notes” option on the webpage.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
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).
standaloneDialingIPAddress Optional. String. IP Address for dialing in to the Webex meeting from a video conferencing system or application.
startDate Required for Create. Optional for Lst and Set. Not applicable for all other actions. The starting date and time for the first (or only) occurrence of the meeting. Formatted as MM/DD/YYYY HH:MM:SS. Default is current time.
Note: If an empty element is specified, for example, <startDate/>, then the current time of the XML server is used as the default starting time of the meeting.
startDateEnd Optional. End of range of dates from which a user can select for the start date for a meeting. Formatted as MM/DD/YYYY HH:MM:SS.
startDateStart Optional. Beginning of range of dates from which a user can select for the start date for a meeting. Formatted as MM/DD/YYYY HH:MM:SS.
startFrom Optional. Integer. Works with maximumNum to limit the quantity of returned objects as described in “Choosing A Subset of Records” on page 54.
startFrom (in matchingRecords element) Required. Integer. Record index number that the returned set starts from.
state Optional. Maximum of 32 characters. The attendee’s state of residence. Default is “”.
status Optional. Valid values are INPROGRESS or NOT_INPROGRESS. Indicates whether the meeting is either started and active or not active. Its value is generated by WebEx and cannot be changed.
Default: NOT_INPROGRESS.
subscriberAccessCode Required. String. Indicates the access code for a teleconference-only service subscriber.
supportBreakoutSessions Optional. Valid values are TRUE and FALSE. DEPRECATED. Breakout sessions are enabled per Session Type, not at the individual session level.
supportE2E Optional. Boolean Determines whether a session has end-to-end encryption (E2EE). If E2EE is enabled, the networkBasedRecording, joinBeforeHost, and remoteComputer sharing features are automatically disabled.
supportFeedback Optional. Valid values are TRUE and FALSE. Determines whether or not the Feedback form will be displayed after the session ends.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
supportPanelists Optional. Valid values are TRUE and FALSE. For Meeting Center only.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
supportPKI Optional. Boolean Determines whether a session has AES encryption. If encryption is enabled, the networkBasedRecording, joinBeforeHost, and remoteComputer sharing features are automatically disabled.
supportQandA Optional. Valid values are TRUE and FALSE. DEPRECATED. Q and A sessions are enabled per Session Type, not at the individual session level.
supportRemoteComputer Optional. Valid values are TRUE and FALSE. Determines whether or not sharing a remote computer is enabled.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
supportShareWebContent Optional. Valid values are TRUE and FALSE. Determines whether or not sharing Web Content is enabled.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
supportUCFRichMedia Optional. Valid values are TRUE and FALSE. Enables UCF support for audio, video and Flash files.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
supportUCFWebPages Optional. Valid values are TRUE and FALSE. Enables UCF support for standard Web pages.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
switchPage Optional. Valid values are TRUE and FALSE. Indicates whether page switching is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
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.
templateFilePath Optional. String. File path of the document that appears on the Info tab.
thumbnail Optional. Valid values are TRUE and FALSE. Indicates whether thumbnail is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
timeZone Optional. If specified, must be a value from among those listed in Appendix A, Time Zone, Language Encoding, and Country Codes. Determines the time zone for the geographic location of the meeting. Default is “GMT-08:00, Pacific Time (San Jose)”.
timeZoneID Optional. An integer ranging from 0 to 61. For details, see Appendix A, Time Zone, Language Encoding, and Country Codes. Determines the time zone for the geographic location of the meeting.
title Optional. Maximum of 128 characters. The attendee’s title. Default is “”.
tollCallInNumber Required. String. Indicates the toll call-in telephone number for a teleconference-only session.
tollFree Optional. Valid values are TRUE and FALSE. Specifies whether toll-free call-in numbers are enabled.
tollFreeCallInNumber Required. String. Indicates the toll-free call-in telephone number for a teleconference-only session.
tollFreeNum Optional. String. Returns the toll-free call-in number for WebEx teleconferencing in a WebEx meeting.

This element is only returned in GetMeeting and its value is ignored in Create/SetMeeting.
tollNum Required if callInNum is specified. String. Returns the toll call-in number for a WebEx integrated teleconference. This element is only returned in GetMeeting and its value is ignored in Create/SetMeeting.
total Required if matchingRecords is specified. Integer. Total number of records matching the query request.
trackingCode1..10 Optional. Maximum of 128 characters. Ten text elements that you can use for any information about a meeting, such as project names, departments, or anything else of your choice.
Note: Validation of the tracking code template will be added in future release. If your tracking code has customized templates, please consult your site administrator about relevant tracking code values before specifying them.
tspAccessCodeOrder Optional. Determines in which order access codes should be used.
tspAccountIndex Optional. An integer ranging from 1 to 3. Specifies which of the user's TSP Accounts to use for teleconferencing. The TSP accounts are defined in CreateUser/tspAccount.
Note: This element follows the following logic:
■ If the specified value is outside the valid range, a validation error occurs.
■ If the specified value is within the valid range, then the system checks the TSP setting of the host and decides which TSP account to use.
■ If no value is specified, then the default TSP account of the host is used.
type Optional. Valid values are MEMBER and VISITOR. The WebEx-maintained determination of whether the meeting participant represented by a service of this type is a member (registered on your WebEx XML server as a user) or a visitor. Default: VISITOR.
url Optional. Maximum of 128 characters. The attendee’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.
viewAnyDoc Optional. Valid values are TRUE and FALSE. Allows attendees to view any document.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
viewAnyPage Optional. Valid values are TRUE and FALSE. Allows attendees to view any page of the document.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
voip Optional. Valid values are TRUE and FALSE. Indicates whether voice communications over the Internet (VoIP) is supported for meetings of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
webExID Optional. String. Maximum of 64 characters. A reference to the WebEx user account for the meeting participant. Empty if the attendee is a VISITOR.
webTour Optional. Valid values are TRUE and FALSE. Indicates whether web tour is supported for meeting of this type.

If this element is unspecified, its value will default to the session template specified in:
<sessionTemplate> <use>Template Name</use> </sessionTemplate>

If a template name is not specified, setting:
<sessionTemplate> <default>true</default> </sessionTemplate>

will use the default template for the Meeting Type.
weekInMonth Integer. Valid values are 1 to 5. The week number in a month.
zipCode Optional. Maximum of 16 characters. The ZIP Code portion of the attendee’s address. Default is “”.
zoom Optional. Valid values are TRUE and FALSE. Indicates whether zooming is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: Template Name If a template name is not specified, setting: true will use the default template for the Meeting Type.
Next