Webex XML API

Elements in WebEx XML Schema Definitions for the General Session Service

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

Element Constraint(s) Description
account Optional. String. Account in SaC.
action Optional. String. Clickable test action.
actionURL Optional. String. The URL used to show if an action clicked.
actualStartTime Optional. String. The actual start time of the meeting.
address1 Optional. Maximum of 128 characters. The first line of an contact’s street address.
address2 Optional. Maximum of 128 characters. The second line of an contact’s street address.
addressType Optional. Enumerated string. Valid values are PERSONAL and GLOBAL. Holds the type of the address. Default: PERSONAL.
Note: This element is ignored in CreateContacts.
agenda Optional. String. The agenda for the meeting.
alternateHost Optional. String. The full name of a session’s alternate host.
altHost Optional. Valid values are TRUE and FALSE. Determines if a session invites an alternative host that is specified in <hostWebExID> or <hostEmail>.
apiVersion Optional. String. Version information of WebEx API service on the current XML server.
attendeeDownload Optional. Valid values are TRUE and FALSE. Indicates whether an attendee can download a recording.
attendeeList Optional. Valid values are TRUE and FALSE. Indicates whether participant listing is enabled during recording playback.
attendeeOptions Optional. Container. Holds the attendee options.
attendeeView Optional. Valid values are TRUE and FALSE. Indicates whether an attendee can view a recording.
author Optional. String. Holds the name of the author.
backupTollNum Optional. String. Holds the backup toll call in number for PCN telephony.
basic Optional. Container. Holds the basic recording options.
callInNum Optional. callInNumType. Holds the call in telephony info for WebEx and TSP telephony.
caseSensitive Optional. Boolean. Indicates whether or not to sort returned records in a case-sensitive manner.

Default: TRUE.
chat Optional. Valid values are TRUE and FALSE. Indicates whether chat is enabled during recording playback.
city Optional. Maximum of 64 characters. The city for a contact.
company Optional. Maximum of 128 characters. The company name for a contact.
confID Required. Long. A unique identification number associated with a session.
confID (in lstRecording) Optional. Long. A unique identification number associated with a session recording.
confID (in lstsummarySession) Optional. Long. A unique identification number associated with a session.
confName Required. String. Specifies the name of a one-click conference.
confName (in getSessionInfoResponse) Required. String. Specifies the session name.
confName (in lstsummarySession) Optional. String. Matches all meeting topic names that start with the string specified in this query field.
contact Optional. personType. Holds contact data.
contactID Integer. The identifier of a contact.
contactOperation Enumerated string. Valid values are ADD, DELETE, and DELETE_ALL. Performs contact distribution list operations. Valid values are:
■ ADD: Adds contacts, as specified by contactID, to a distribution list.
■ DELETE: Deletes contacts, as specified by contactID, from a distribution list.
■ DELETE_ALL: Removes all the contacts from a distribution list.
country Optional. Maximum of 64 characters. The country for a contact.
countryAlias Required. String. Holds an alias for a country.
createTime Required. Time String. The creation time of the recording with respect to a specified time zone.
createTimeEnd Required. Time string. Creates the recording end time.
createTimeScope Optional. Container. Holds the date scope range.
createTimeStart Required. Time string. Creates the recording start time.
CUVCMeetingID Optional. String. CUVC customized meeting ID.
delivery Required. Enum {WEBSITE, IN_SESSION}. How the test will be delivered.
desc Optional. String. The descriptive information about a distribution list.
description Optional. String. Session description for TC and EC only.
distListID Integer. Required for SetDistList. The identifier of a distribution list.
distListID (in LstContact) Optional. Integer. ID of a distribution list in order to retrieve contacts.
distListName Optional. String. Name of a distribution list in order to retrieve contacts.
duration Required. Integer. The duration of the session in seconds.
email Required. Maximum of 64 characters. Stores a person’s email address.
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.
endPlayURL Optional. String. Defines the URL to display at the end of recording playback.
entryExitTone Optional. Valid values are TRUE and FALSE. Determines if entry and exit tones are played.
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.”
fax Optional. Maximum of 64 characters. The contact’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".
fileAccess Optional. Container. Holds the recording file access options.
fileShare Optional. Valid values are TRUE and FALSE. Indicates whether file sharing is enabled during recording playback.
fileURL Required. String. URL to download the file.
firstName Required. String. The first name of the session’s host.
format Required. String. Holds the format type.
globalCallInNumbersLabel Optional. String. The display label for the TSP global callin URL.
globalCallInNumbersURL Optional. String. The URL used to display international global call in numbers.
globalNum Optional. Container. Corresponds to the Global Call-in Numbers in the telephony domain.
hostEmail Optional. String. Specifies the host email address used for a query, or holds the email address returned from the query. If not specified, defaults to the current host.
hostFirstName Optional. String. Returns the host’s first name.
hostJoined Boolean. If TRUE, indicates that the host is now in the session; otherwise, returns FALSE.
hostLastName Optional. String. Returns the host’s last name.
hostType Optional. String. Holds the hostType column in the mtgconference table.
hostWebExID Optional. String. The WebEx ID of the host of the returned open session.
hostWebExID (in lstContact) Optional. String. Allows the Site Admin to specify another user’s WebEx ID to retrieve their contacts. Default: SecurityContext.webExID.
imageURL Optional. String. The URL to upload a session image.
inclAudioOnly Optional. Valid values are TRUE and FALSE. Determines if an AUO meeting is included in the query or not. Defaults to FALSE.
includeNBRcontrols Optional. Valid values are TRUE and FALSE. Indicates whether the NBR player controls are enabled during recording playback.
index Required. Integer. Specifies a tracking code index with values [1..10].
inputMode Required. String. Specifies a tracking code display type.
intlLocalCallIn Optional. Valid values are TRUE and FALSE. Specifies whether international call-in is enabled or displayed.
intlLocalCallInNumber Optional. String. Telephone number for international participants.
invited Required. Valid values are TRUE and FALSE. Determines whether or not returned sessions include those that a user is invited to. Defaults to FALSE.
isAutoRecord Optional. Boolean Identifies meetings that are automatically recorded. This feature governs whether a meeting is automatically recorded if Automatically record all sessions using Network-Based Recording is not enabled (checked) on the Site Admin page. If the latter is enabled, it overrides isAutoRecord. Please note that this element is only returned for meetings, but not other sessions.
isCETMeeting Optional. Boolean. Indicates whether the event supports Webex video platform version 2 (CMR Version 4.0).
isInternal Optional. Valid values are TRUE and FALSE. Determines if a meeting is internal or not. TRUE = internal.
isRecurring Required. Valid values are TRUE and FALSE. Defines whether or not the session is a repeating or a single event.
isServiceRecording Optional. Valid values are TRUE and FALSE. Indicates whether the recording is service specific (TRUE) or networkbased (FALSE).
joinApproval Optional. Valid values are TRUE and FALSE. Determines if attendees ask for approval from the user when they join.
joinRequiresAccount Optional. Valid values are TRUE and FALSE. Determines if attendees are required to have an account to join.
label Optional. String. Label for the phone number.
language Optional. String. The language of the contact.
lastName Required. String. The last name of the session’s host.
listControl Optional. Container. Controls the data result set.
listing Optional. Enum {PUBLIC, PRIVATE, UNLISTED} Holds the listing type.
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. Enumerated string. Valid values are PUBLIC, PRIVATE, and UNLISTED. Indicates which users can see this 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.

Default is PUBLIC.
locale Optional. String. The locale for the contact.
language Optional. String. The primary language for the contact.
matchingRecords Optional. Contains information about the returned records. See also total, returned and startFrom for more information.
maximumNum Optional. A nonnegative integer. Limits the quantity of returned objects as described in “Choosing A Subset of Records” on page 54.
metaData Required. Container. Holds the meeting options.
mobilePhone Optional. Maximum of 64 characters. The contact’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".
mpProfileNumber Optional. String. Contains the Cisco Unified MeetingPlace number for the host.
name Required. String. Holds the name of the complex element.
notes Optional. Maximum of 2,048 characters. Any note information about a contact.
notes (in `playback) Optional. Valid values are TRUE and FALSE. Indicates whether taking notes is enabled during recording playback.
openTime Optional. Integer. The number of minutes an attendee can join before the host.
opportunity Optional. String. Account in SaC.
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. String. In lstsummarySessionResponse, this designates another user that can also edit and host the session.
panelist Optional. String. Panelist who made the recording.
panelistNumericPassword Optional. String. Password for joining the Webex meeting from a video conferencing system or application.
panelistsInfo Optional. String. Panelist information for EC only.
partialEnd Optional. Integer. The location in a recording to start playback, in seconds.
partialStart Optional. Integer. The location in a recording to stop playback, in seconds.
participantAccessCode Optional. String. The teleconferencing participant access code.
participantAccessCodeLabel Optional. String. Name of the participant access code.
participantAccessLabel Optional. String. Returns the attendee access code label as defined in Super Admin >` Telephony Config. Suffixed with (full speaking) for WebEx telephony.
participantLimitedAccessCode Optional. String. User-defined access code for a participant with the limited speaking privilege in a WebEx personal teleconference.
participantLimitedAccessCodeLabel Optional. String. Name of the listen-only attendee access code.
participantLimitedAccessLabel Optional. String. Returns the attendee access code label as defined in Super Admin >` WebEx Telephony Config. Suffixed with (Listen Only).
participantsJoined Boolean. If TRUE, indicates that there is at least one participant who has joined the session; otherwise, returns FALSE.
password Optional. String. The password required to access a recording.
passwordReq Required. Boolean. TRUE if a session requires a password; otherwise, FALSE.
personalAccountIndex Optional. Integer. Specifies the personal telephony account.
phone Optional. Maximum of 64 characters. The contact’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".
phoneNumber Required. String. Holds the associated phone number.
playback Optional. Container. Holds the recording playback options.
polling Optional. Valid values are TRUE and FALSE. Indicates whether survey polling is supported during recording playback.
postRecordingSurvey Optional. Valid values are TRUE and FALSE. Indicates whether to conduct a survey after the recording.
presenter Optional. String. The name of the presenters in the TC.
programName Optional. String. The name of the EC program.
range Optional. Enumerated string. Valid values are FULL and PARTIAL. Indicates the recording playback range.
■ FULL: Play the entire recording.
■ PARTIAL: Play a portion of the recording as indicated by partialStart and partialEnd.
recording Optional. Container. Holds information about NBR recordings.
recordingID Required. Integer. The unique identifier for a recording.
recordingType Required. Integer. Holds the type of recording.
■ 0: Network
■ 2: Local
recordingType (in recording) Required. Integer. Determines the formatting of the recording.
■ 1: URL
■ 2: Local File
■ 5: NBR recording
recordName Optional. String. Holds the name of a record.
recurrence Optional. Valid values are TRUE and FALSE. Allows recurring sessions to be retrieved over a specified date range.
registerReq Optional. Valid values are TRUE and FALSE. Determines whether or not registration is required.
registration Required. Valid values are TRUE and FALSE. Specifies whether registration is required for each session.
registrationURL Optional. String. The URL for the attendee session registration page. Is only returned if registration is enabled.
release Optional. String. The release number of WebEx XML API in addition to its major version expressed in the apiVersion element. For example, for XML API 3.9.1, apiVersion returns “XML API V3.9.0” while release will return “SP1”.
returnAssistFields Optional. Valid values are TRUE and FALSE. Determines whether or not to return assist fields. Defaults to FALSE.
returned Required. Integer. Number of records returned in this response. See also matchingRecords.
returnPSOFields Optional. Valid values are TRUE and FALSE. Determines whether or not to return psoFields.
returnSessionDetails Optional. Valid values are TRUE and FALSE. Returns the sessionKey and tracking codes if set to TRUE.
returnShareToMeRecording Optional. Boolean. If set TRUE, the API returns recordings for which the user was an attendee/invitee or were shared with the user, in addition to recordings for which the user is the owner.

If set FALSE or omitted, the API returns only recordings for which the user is the owner.
returnSpecifiedTimeZone Optional. Valid values are TRUE and FALSE. Determines if <startTime> is returned in the timezone specified in <dateScope><timeZoneID>.
Default is FALSE.
returnTrainReleaseVersion Optional. Valid values are TRUE and FALSE. Determines if the release version is returned.
sendReminder Optional. Valid values are TRUE and FALSE. Indicates whether to send reminders to attendee/presenter.
services Optional. Contains service information and session information about the returned open sessions.
serviceType Enumerated string. Valid values are MeetingCenter, EventCenter, TrainingCenter, SupportCenter, and SalesCenter. The services (Meeting Center, Event Center, Training Center, Support Center, Sales Center) that are supported for this site.
serviceTypes Optional. Container. Holds the service types.
sessionKey Required. Long. A WebEx-assigned session-unique value that is needed to identify the returned sessions.
sessionName Optional. String. The name of the open session.
sessionPassword Optional. String. The session password.
sessions Optional. Contains information about the returned open sessions.
sessionTemplate Optional. Container. Holds the session template.
sessionType Required. Integer. WebEx XML API provides two kinds of session types: root session types and sub-session types.

Root session types are fixed, which include the following valid values:
■ 1: FRE (Free meeting)
■ 2: STD (Standard meeting)
■ 3: PRO (Pro meeting)
■ 4: SOS (Standard subscription office meeting)
■ 5: SOP (Pro subscription office meeting)
■ 6: PPU (Pay-per-use meeting)
■ 7: OCS (OnCall support session)
■ 8: COB (OnTour Session)
■ 9: ONS (OnStage meeting)
■ 10: RAS (Access Anywhere session)
■ 11: TRS (Training session)
■ 13: SC3 (Support Center Session)
■ 14: SMT (SMARTtech session)
■ 15: SAC (Sales session)
■ 16: AUO (Teleconference Only meeting)

Sub-session types are customizable. For detailed information on sub-session types, please contact WebEx API Support team.

Note: When calling SetOneClickSettings, the session type cannot be set to AUO since an audio-only session does not support one-click.
setupStatus Required. Valid values are TRUE and FALSE. Specifies whether one-click sessions are set up.
shareToMe Optional. Boolean. If TRUE, the user was an attendee or invitee for the recording, or it was shared with the user by the owner.

If FALSE or omitted, the user is the owner of the recording.
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 4.0 or later) for events (previously referred to as the Event Center, or EC).
size Required. Integer. Size of the file in bytes.
size (in recordedEvent) Required. Float. Size of the recording in MB.
standaloneDialingIPAddress Optional. String. IP Address for dialing in to the Webex meeting from a video conferencing system or application.
startDate Required. String. Holds the session starting date and time in the selected time zone. Formatted as MM/DD/YYYY HH:MM:SS.
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 Required. Integer. Record index number that the returned set starts from. See also matchingRecords.
startTime Optional. String. The time when the session starts. Formatted as MM/DD/YYYY HH:MM:SS.
state Optional. Maximum of 32 characters. The contact’s state of residence.
status Optional. Enumerated string. Valid values are NOT_INPROGRESS, INPROGRESS. Specifies the session status used for a query. If not specified, the query returns sessions of all statuses.
status (in getSessionInfoResponse) Required. Enum {NOT_STARTED, STARTED, ENDED}. Defines the status of the test.
streamURL Required. String. The URL for the recording stream.
subscriberAccessCode Optional. String. The teleconferencing subscriber access code supplied by the telephony service provider.
subscriberAccessCodeLabel Optional. String. The subscriber access code label for TSP audio.
subscriberAccessLabel Optional. String. Host access code label to TSP/PCN accounts.
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.
supportQandA Optional. Valid values are TRUE and FALSE. Indicates whether the Training Center client Q&A feature is enabled during recording playback.
teleconfLocation Optional. String. Locale of the teleconference.
teleconfServiceName Optional. String. Name of the teleconferencing service.
telephony Optional. Container. Holds the audio conference.
telephonySupport Required Enumerated string. Valid values are NONE, CALLIN, CALLBACK, OTHER. Specifies the type of telephone support.
timeZone Required. String. Selected time zone description for a session.
timeZoneID Optional. Integer. 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 session.
title Optional. Maximum of 128 characters. The title of a contact.
title (in getSessionInfoResponse) Required. String. Name of the test.
titleURL Required. String. URL to show if the test tile was clicked.
toc Optional. Valid values are TRUE and FALSE. Indicates whether a table of contents is available during recording playback.
tollCallInData Optional. String. Information about the call. This field controls the Toll-Free checkbox and sets the country code. The value must be formatted as “TollFreeFlag,CountryCode”.

■ The TollFreeFlag value will be 1 or 0 (“1” enables the checkbox and “0” will disable it).
■ The CountryCode value must be set to the specific country code value as shown in Appendix A.3, Telephone Country Codes. For example “86” represents China.
tollCallInLabel Required. String. Returns the phone number label as defined for the WebEx or TSP Telephony Domain.
tollCallInNumber Optional. String. Teleconference toll call in number for the user as assigned by the telephony service provider.
Note: The telephone number should include a country code and an area code For example, 1,408,555-1212. Commas are required to parse the country code and the area code into different fields on WebEx Web pages. Commas do NOT represent a dialing pause. tollCallInNumberLabel Required String. Name displayed for toll numbers.
tollFree Optional. Valid values are TRUE and FALSE. Specifies whether toll-free call-in is enabled.
tollFreeCallInData Optional. String. Information about the call. This field controls the Toll-Free checkbox and sets the country code. The value must be formatted as “TollFreeFlag,CountryCode”.

■ The TollFreeFlag value will be 1 or 0 (“1” enables the checkbox and “0” will disable it).
■ The CountryCode value must be set to the specific country code value as shown in Appendix A.3, Telephone Country Codes. For example “86” represents China.
tollFreeCallInLabel Required. String. Returns the phone number label as defined for the WebEx or TSP Telephony Domain.
tollFreeCallInNumber Optional. String. Teleconference toll free call in number for the user as assigned by the telephony service provider.
Note: The telephone number should include a country code and an area code. For example, 1,408,555-1212. Commas are required to parse the country code and the area code into different fields on WebEx Web pages. Commas do NOT represent a dialing pause.
tollFreeCallInNumberLabel Required. String. Name displayed for toll-free numbers.
tollFreeRestrictionsURL Optional. String. The URL used to display toll free dialing restrictions.
topic Optional. String. The recording topic.
total Required. Integer. Total number of records matching the query. See also matchingRecords.
tracking Optional. Container. Holds the tracking codes.
trackingCode1..10 Optional. String. Holds the value for a tracking code. Up to 10 tracking codes are available at a time, trackingCode1, trackingCode2, ...
trainingRecordings Optional. Valid values are TRUE and FALSE. Enables the My WebEx, My Files: Training Recordings feature for the user.
trainReleaseVersion Optional. String. Holds the release version of the site.
tspAccountIndex Optional. Integer. Specifies the tsp account.
type Optional. Valid values are MEMBER and VISITOR. Default: VISITOR.
Note: This element is ignored by CreateContacts.
type (in sessionTemplate) Required. Enum {User, Site, Service} Holds the template type.
url Optional. Maximum of 128 characters. The URL for a contact.
URL (in getSessionInfoResponse) Required. String. The URL that tells attendees where to download the document.
value Optional. String. Specifies the value of a tracking code.
value Optional. String. Specifies the value of a tracking code.
verifyFlashMediaURL Optional. String. The URL used to verify the user’s Adobe Flash player.
verifyWinMediaURL Optional. String. The URL used to verify the user’s Windows Media player.
video Optional. Valid values are TRUE and FALSE. Indicates whether video is supported during recording playback.
viewURL Required. String. The URL string used to access the streaming recording. Corresponds to “Stream recording link” in the web page.
voip Optional. Valid values are TRUE and FALSE. Specifies whether Voice Over IP telephony is enabled.
webExID Optional. Maximum of 64 characters. WebEx user account name.
webExID (in getSessionInfoResponse) Required. String. The WebEx username of the session’s host.
zipCode Optional. Maximum of 16 characters. The ZIP code for a contact.
Next