Webex XML API

Elements in WebEx XML Schema Definitions for the History Service

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

Element Constraint(s) Description
accessTime Optional. String. Holds when the record was accessed.
account Optional. String. Filters by account.
address1 Optional. String. Session participant's address line 1.
address2 Optional. String. Session participant's address line 2.
attendeeEmail Optional. String. Session participant's email address.
attendeeName Optional. String. Session participant's name.
attendeeStats Optional. Valid values are TRUE or FALSE. Determines if the status of an attendee is displayed.
attendeeType Optional. Enum {PROSPECT, SALESTEAM} Holds the type of attendee.
avgLeadScore Required. Float. Average of the leading score.
city Optional. String. Session participant's city.
clientAgent Optional. String. Session participant's operating system and browser, such as “Windows, IE”.
company Optional. String. Session participant's company.
confID Optional. Long. The unique conference ID associated with a session, with which you take operations such as to query the session’s history data.
Note: confID takes priority over sessionKey and meetingType. Thus, if a wrong confID is specified, the system throws an exception and stops processing sessionKey and meetingType even if they are also specified.
confName Optional. Maximum of 512 characters. Name of the meeting.
count Required. Long. Counter variable.
country Optional. String. Session participant's country.
creationTime Optional. String. Creation time of a recording. Formatted as MM/DD/YYYY HH:MM:SS. If specified, creationTimeEnd must also be specified.
creationTimeEnd Optional. Required if creationTimeScope is specified. String. Return all recordings that were created between creationTimeStart and this time. Formatted as MM/DD/YYYY HH:MM:SS If specified, creationTime must also be specified.
creationTimeStart Optional. Required if creationTimeScope is specified. String. Return all recordings that were created between creationTimeEnd and this time. Formatted as MM/DD/YYYY HH:MM:SS.
downloaded Optional. Integer. The number of times that a recorded session has been downloaded.
duration Optional. Integer. The number of minutes (rounded up) that the session lasted.
email Optional. String. Session participant's email address.
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.
endTime Optional. String. Time when the participant left the session or the session ended, in GMT.
fax Optional. String. A participant’s fax number.
firstName Optional. String. A person’s given name.
hostEmail Optional. String. Email address for the session host.
hostName Optional. String. Full name of the session host.
hostWebExID Optional. String. WebEx ID of the session host.
inclAudioOnly Optional. Valid values are TRUE and FALSE. Determines if attendee information will be returned for audio only sessions. Default: FALSE.
invited Optional. String. Number of participants who were invited to the session. This only includes participants who were invited from the CreateMeeting/TrainingSession, CreateMeetingAttendee requests or the schedule session site web pages. This number does not include participants who were invited from the session client window once the session has started.
ipAddress Optional. String. IP address for the participant's computer.
joinTime Optional. String. Time at which the participant joined the session.
label Optional. String. The name of a field.
lastName Optional. String. A participant’s family name.
leadScore Optional. Float. Holds the lead score.
leadSourceID Optional. String. Holds the ID of the lead source.
leaveTime Optional. String. Time when the participant left the session.
listControl Optional. Container. Controls the data result set.
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.
matchingRecords Optional. Container. Holds the date scope range.
maximumNum Optional. Integer. Limits the quantity of returned objects as described in “Choosing A Subset of Records” on page 54.
meetingEndTime Optional. String. Time when the session ended, in GMT.
meetingKey Optional. Integer. Unique identifier for a meeting. A recurring or constant meeting will have one meetingKey but each individual session will have a unique confID.
meetingStartTime Optional. String. Time when the session began, in GMT.
meetingType Optional. String. Valid values are:
■ PRE, PRO and STD (Meeting Center)
■ OCS and SC3 (Support Center)
■ ONS (Event Center)
■ TRS (Training Center)
■ RAS (Access Anywhere)		 An abbreviated code to designate the session type.
name Optional. String. Full name for session participant.
opportunity Optional. String. Filter by opportunity.
orderAD Optional. Valid values are ASC and DESC. When using orderBy whether to sort in ascending or descending order. Default: ASC.
orderBy Optional. Which elements to sort by in the sessions returned.
■ For LsttrainingsessionHistory, valid values are: CONFNAME, STARTTIME, TOTALINVITED, TOTALREGISTERED, TOTALATTENDEE, ASSISTREQUEST, and ASSISTCONFIRM.
■ For LstrecordaccessHistory, valid value is RECORDID.
■ For LsttrainingattendeeHistory, valid values are NAME, STARTTIME, COMPANY, COUNTRY, STATE, CITY and CONFID.
■ For LstmeetingusageHistory and LstsalesSessionHistory, valid values are CONFNAME, STARTTIME, TOTALATTENDEE and HOSTNAME, ASSISTREQUEST, ASSISTCONFIRM.
■ For LstmeetingattendeeHistory and LstsalesAttendeeHistory, valid values are CONFID, STARTTIME, COMPANY, COUNTRY, STATE and CITY.
■ For LsteventsessionHistory, valid values are CONFID, STARTTIME and CONFNAME, ASSISTREQUEST, ASSISTCONFIRM.
■ For LsteventattendeeHistory, valid values are STARTTIME, ATTENDEENAME, SESSIONKEY and CONFID.
■ For LstsupportsessionHistory, valid values are CONFID, SESSIONSTARTTIME and CONFNAME.
■ For LstsupportattendeeHistory, valid values are ATTENDEENAME, STARTTIME, SESSIONKEY and CONFID.
participantEmail Optional. String. Holds the email of a participant.
participantName Optional. String. Holds the name of a participant.
participantType Optional. Enumeration. Valid values are HOST, ATTENDEE, OTHER. Role of a participant in the meeting.
partnerID Optional. The WebEx assigned unique identification number that is assigned to each partner. Its value is returned in Response commands.
peakAttendee Long. Holds the maximum number of simultaneous participants in a session.
phone Optional. String. Session participant's telephone number.
phoneNumber Optional. String. Session participant's telephone number.
postalCode Optional. String. A participant’s zip code.
recordDetail Optional. Container. Holds the NBR recordings.
recordID Optional. Integer. ID of the recording.
recordName Optional. String. Name of the recording.
regA Required. String. Holds an answer.
registerDate Optional. String. Holds the register date.
registered Optional. String. Quantity of registered attendees.
regQ Required. String. Holds a question.
returned Required if matchingRecords is specified. Integer. The number of records returned in the response.
returnPSOFields Optional. Valid values are TRUE or FALSE. Determines if the PSO Fields will be returned.
returnRegFields Optional. Valid values are TRUE or FALSE. Determines if the registration fields will be returned.
sessionEndTime Optional. String. Time when the session actually ended, in GMT.
sessionEndTimeEnd Required if endTimeScope is specified. String. Returns all sessions that ended between sessionEndTimeStart and this time, in GMT. Formatted as MM/DD/YYYY HH:MM:SS.
sessionEndTimeStart Required if endTimeScope is specified. String. Returns all sessions that ended between sessionEndTimeEnd and this time, in GMT. Formatted as MM/DD/YYYY HH:MM:SS.
sessionKey Optional. Long. Unique identification number for a WebEx session.
sessionStartTime Optional. String. Time when the session actually started, in GMT.
sessionStartTimeEnd Required if startTimeScope is specified. String. Returns all sessions that started between sessionStartTimeStart and this time, in GMT. Formatted as MM/DD/YYYY HH:MM:SS.
sessionStartTimeStart Required if startTimeScope is specified. String. Returns all sessions that started between sessionEndTimeEnd and this time, in GMT. 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.
startTime Optional. String. Time when the participant joined the session, in GMT.
state Optional. String. Session participant's state.
timeZone Optional. String. A string containing the GMT offset and timezone name and example city. See Appendix A, Time Zone, Language Encoding, and Country Codes.
timeZoneID Optional. An integer ranges from 0 to 61. An index into the table of time zones as shown in Appendix A, Time Zone, Language Encoding, and Country Codes. Default is 20.
title Optional. String. Session participant's title.
total Required if matchingRecords is specified. Integer. Total number of records matching the query request.
totalAttendee Optional. Numeric. Total number of attendees.
totalCallInMinutes Optional. Integer. Total number of minutes used in the session for dial in teleconferencing.
totalCallInTollfreeMinutes Optional. Integer. Total number of minutes used in the session for toll free dial in teleconferencing.
totalCallOutDomestic Optional. Integer. Total minutes used for dial out domestic teleconferencing.
totalCallOutInternational Optional. Integer. Total minutes used for dial out international teleconferencing.
totalInvited Optional. Integer. Total number of invited users.
totalParticipants Optional. Integer. Total number of participants including attendees and the host.
totalParticipantsCallIn Optional. Integer. Total number of participants who used standard and toll-free dial-in teleconferences.
totalParticipantsCallOut Optional. Integer. Total number of participants who used domestic and international dial-out teleconferences.
totalParticipantsVoip Optional. Integer. Total number of participants who used Voice over IP.
totalPeopleMinutes Optional. Integer. Total minutes used by all participants in the WebEx session.
totalRegistered Optional. Integer. Total number of registered users.
totalVoipMinutes Optional. Integer. Total number of minutes used for Voice over IP.
trackingCode1..10 Optional. Ten text elements that you can use for any information about a session, such as project names, departments, or anything else of your choice.
userID Optional. Integer. Unique identifier for the session host.
value Optional. String. Any user entered value.
viewed Optional. Integer. The number of times that this recording has been viewed.
viewID Optional. Long. Holds the ID of what is being viewed.
viewTimeEnd Required. String. View the end time.
viewTimeScope Optional. viewTimeScopeType. Views the time scope.
viewTimeStart Required. String. View the start time.
voipDuration Optional. Integer. Minutes for Voice over IP conference that an attendee has participated in during a meeting.
zip Optional. String. Postal code of the session participant.
zipCode Optional. String. Postal code of the session participant.
Next