Webex XML API

Elements in WebEx XML Schema Definitions for the User Service

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

Element Constraint(s) Description
acceptLinkRequest Optional. Valid values are TRUE and FALSE. Toggles the feature of accepting link requests. Default: FALSE.
accessCode Optional. String. Maximum of 32 characters. The access code for a third party teleconference.
accessToken Optional. String. The string provided in a request as the credential for authentication. This method of authentication can be used on sites that use the Common Identity service.
accountIndex Optional. An integer ranging from 1 to 3. Specifies which of the user’s TSP accounts to use for teleconferencing.
accountIndex (in personalTeleconf element) Required. An integer ranging from 1 to 3. Holds the index of a WebEx personal teleconference account.
accountIndex (in thirdPartyTeleconf element) Required. An integer ranging from 1 to 3. Holds the index of a third party teleconference account.
active Optional. Valid values are ACTIVATED, REQUEST_TO_ACTIVATE, or DEACTIVATED. Determines whether the user account has been staged for use. The CreateUser/SetUser command will return an exceededSiteHostLimit error if you set a user's active=ACTIVATED parameter so that the WebEx site's host limit is exceeded. Default: ACTIVATED.
address1 Optional. Maximum of 128 characters. The first line of the street address for the user’s Office Profile. Default: “”.
address2 Optional. Maximum of 128 characters. The second line of the street address for the user’s Office Profile. Default: “”.
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”.
addressVisible Optional. Valid values are TRUE and FALSE. Toggles the address for the user. Default: FALSE.
apiVersion Required. String. The XML API version number.
asst For Sales Center only. Optional. Valid values are TRUE and FALSE. Indicates whether the user is a sales assistant.
attendeeOnly Optional. Valid values are TRUE and FALSE. If TRUE, then indicates that the user’s role is attendee only. If set to TRUE, then the host, the siteAdmin, the labAdmin and the roSiteAdmin elements should be FALSE. Default: FALSE.
Note: The site must have Enable attendee accounts enabled. Otherwise, createUser and setUser with attendeeOnly set to TRUE will return an exception.
autoDeleteAfterMeetingEnd Optional. Valid values are TRUE and FALSE. Determines if meetings should be automatically deleted from My Meetings after a session is completed.
autoGenerate Optional. Valid values are TRUE and FALSE. Determines if the API automatically generates a PCN account by telephony server or not.
backURL Optional. A URL to which the user is returned after the command completes.
categoryID Optional. A reference to another service or zero. A reference to the office category for the user’s office. Default: 0.
cellPhoneVisible Optional. Valid values are TRUE and FALSE. Toggles the cell phone number for the user. Default: FALSE.
city Optional. Maximum of 64 characters. The city for the user’s Office Profile. Default: “”.
company Optional. Maximum of 128 characters. The user’s company name.
confBridgeNum Required for createUser. Optional for setUser. String. The bridge telephone number in a third party teleconferencing account. The country code and the area code should be separated by hyphens. Example: 1-866- 555-5234.
confName Required. String. Specifies the name of a one-click conference.
country Optional. Maximum of 64 characters. The country for the user. Default: “”.
createOnBridge Optional. Valid values are TRUE and FALSE. If TRUE, then the user teleconferencing account will be created on the telephony bridge. If FALSE, then the account specified must already exist on the bridge. If your site allows TSP Account Provisioning, the account is created and the new account information is added to the user’s profile. Otherwise, only an existing TSP bridge account can be added to the user’s profile.
createTime Optional. String. Date when the sessionTicket was created.
custom1 Optional. String. Stores additional fields associated with the user teleconferencing account.
custom2 Optional. String. Stores additional fields associated with the user teleconferencing account.
custom3 Optional. String. Stores additional fields associated with the user teleconferencing account.
defaultFlag Optional. Valid values are TRUE and FALSE. Determines if the account is to be used as the default account. Default value is FALSE.
defaultServiceType Optional. com:serviceType Type. Service info of a Default session type.
defaultSessionType Optional. Integer. Session info of a Default session type.
delete Optional. Valid values are TRUE and FALSE. Determines if an account is to be deleted by its index.
description Optional. Maximum of 4000 characters. A description of the user’s virtual office. Default: “”.
description (in smeInfo element) For Sales Center only. Required if sme is specified. String. Maximum of 512 characters. Description of the user’s subject matter expertise.
displayQuickStartAttendees Optional. Valid values are TRUE and FALSE. Determines whether or not to show QuickStart to the Attendees.
displayQuickStartHost Optional. Valid values are TRUE and FALSE. Determines whether or not to show QuickStart to the Host and the Presenter.
electronicInfo Optional. Valid values are TRUE and FALSE. Indicates electronic information. Default: FALSE.
email Required for Create. Optional for Lst and Set. String. Must be a valid email address. Not applicable for all other actions. Maximum of 64 characters. The email address of the user. Notifications of messages left by office visitors will be sent to this 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.
email (in commOptions element) Optional. Valid values are TRUE and FALSE. Indicates the email address of the user. Default: FALSE.
email2 Optional. Maximum of 64 characters. The secondary email address for the user’s Office Profile.
emailVisible Optional. Valid values are TRUE and FALSE. Toggles the feature of displaying Email addresses. Default: FALSE
enable Optional. Valid values are TRUE and FALSE. Enables Service Desk integration for user in Support Center. Default is FALSE.
enable (autoRequest element) Required. Valid values are TRUE and FALSE. Determines if the request is enabled when a session begins.
enforce Required. Valid values are TRUE and FALSE. Determines whether or not to enforce automatic recording.
eventCenter Optional. Valid values are TRUE and FALSE. If TRUE, enables the Event Center service (if available on the site) for the user.
expirationDate Optional. A WebEx-maintained date and time at which the user’s account expires. Formatted as MM/DD/YYYY HH:MM:SS. Default: 12/31/2010 00:00:00.
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 (in commOptions element) Optional. Maximum of 64 characters. The fax number for the user’s Office Profile. 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: “”.
fax (in phones element) Optional. Valid values are TRUE and FALSE. Indicates the fax number for the user. Default: FALSE.
faxVisible Optional. Valid values are TRUE and FALSE. Toggles the fax number for the user. Default: FALSE
firstName Required for Create. Optional for Lst and Set. Must be a non-null value. Not applicable for all other actions. Maximum of 64 characters. The user’s first name.
firstNameVisible Optional. Valid values are TRUE and FALSE. Toggles the first name of the user. Default: FALSE.
folderRead Optional. Valid values are TRUE and FALSE. Toggles the accessibility of the folder. Default: FALSE.
folderWrite Optional. Valid values are TRUE and FALSE. Toggles the accessibility of the folder. Default: FALSE.
followMeEnable Optional. Valid values are TRUE and FALSE. Toggles the follow-me wizard for the meeting. Default: FALSE.
forceChangePassword Optional. Valid values are TRUE and FALSE. Determines if a user is forced to change their password on their next login. Is set to TRUE if resetPassword is set to TRUE. Defaults to FALSE.
headerImageBranding Optional. Valid values are TRUE and FALSE. Toggles whether or not to use the branding image of the header area.
headerImageURL Optional. String. A branding header image URL.
holdOnLinkRequest Optional. Valid values are TRUE and FALSE. Toggles the feature of holding on link requests. Default: FALSE.
host Optional. Valid values are TRUE and FALSE. Indicates whether the user is the host for the meeting. Default: FALSE.
hostPIN String. Four digits. The PIN for hosting meetings.
hostWebExID Optional. String. The WebEx ID for a host.
HQvideo Optional. Valid values are TRUE and FALSE. Enables high-quality video for the user. Default: TRUE.
iconSelect1 Optional. Valid values are TRUE and FALSE. Toggles the feature of selecting icons. Default: FALSE.
iconSelect2 Optional. Valid values are TRUE and FALSE. Toggles the feature of selecting icons. Default: FALSE.
inputMode Required. String. Specifies a tracking code display type.
imageData Optional. base64Binary. Image data.
imageFor Optional. imageForType {Photo, Header}. What the image will be used for.
index Required. Integer. Specifies a tracking code.
intlLocalCallIn Optional. String. Specifies whether international call-in is enabled.
intlLocalCallInNumber Optional. String. Telephone number for international participants.
isAgent Optional. Valid values are TRUE and FALSE. Determines if a user is considered an agent.
isMgr Optional. Valid values are TRUE and FALSE. Determines if a user is considered a manager.
isMyWebExPro Optional. Valid values are TRUE and FALSE. If TRUE, then user has access to additional My WebEx Pro features which usually includes My Reports, Access Anywhere, and Personal Meetings Page. Note If TRUE, and WebEx super administrator has limited the number of My WebEx Pro hosts, then the number of existing My WebEx hosts can’t exceed the max number set by the super administrator; otherwise, a NoWebExProLicensesAvailable error occurs.
joinBeforeHost Optional. Valid values are TRUE and FALSE. Determines if attendees are allowed to join a meeting before the host.
labAdmin Optional. Valid values are TRUE and FALSE. If TRUE, then user has access to the Hands-on Lab administration pages. Defaults to site setting. This element is effective only when Hands-on Lab is enabled.
label Required. String. The label of an item.
language Optional. String. Sets the preferred language for the user.
languageID Optional. Long. The ID of a language in the database.
lastName Required for Create. Optional for Lst and Set. Must be a non-null value. Not applicable for all other actions. Maximum of 64 characters. The user’s last name.
lastNameVisible Optional. Valid values are TRUE and FALSE. Toggles the last name of the user. Default: FALSE.
listInCategory Optional. Valid values are TRUE and FALSE. Toggles the feature of listing in categories. Default: FALSE.
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.
locale Optional. String. Holds user locale information.
location Optional. String. Holds the recording location.
lockAccount Optional. Valid values are TRUE and FALSE. Prevents a user from being able to login.
mail Optional. Valid values are TRUE and FALSE. Indicates the mail information for the user. Default: FALSE
manager For Sales Center only. Optional. String. Maximum of 128 characters. The webExID of the user’s sales manager. See also webExID.
maximumNum Optional. Integer. Limits the quantity of returned objects as described in “Choosing A Subset of Records” on page 54.
meetingAssist Optional. Valid values are TRUE and FALSE. Enables Meeting Assist.
meetingCenter Optional. Valid values are TRUE and FALSE. If TRUE, enables the Meeting Center service for the user.
meetingType Optional. Integer. The meeting type ID.
messageVisible Optional. Valid values are TRUE and FALSE. Toggles the feature of displaying messages. Default: FALSE.
mgr For Sales Center only. Optional. Valid values are TRUE and FALSE. Indicates whether the user is a sales manager.
mobilePhone Optional. Maximum of 64 characters. The attendee’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 “”.
mobilePhone2 Optional. Maximum of 64 characters. This element is deprecated.
mpProfileNumber Optional. String. Holds the MeetingPlace profile number.
myComputer Optional. Integer. Enables the My WebEx, Access Anywhere feature and sets the number of Access Anywhere computers for the user. Setting this value to 0 disables Access Anywhere.
Note The logic of this element is as follows: ■ If the myComputer value exceeds the Access Anywhere # of computers set for each user on the site then the user's Additional computers field will be set to the difference. The Access Anywhere # of computers and Additional computers per user are fields in the Site Administration tool. ■ If the site strictly limits the Additional number of Access Anywhere Computers for this site and the sum of this user and other user's Additional computers exceeds the limit then exceptionID=030017 is returned. For details, see “Exception Messages in Response Documents” on page 701. The Additional number of Access Anywhere Computers for this site value is defined in the Super Administration tool.
myContact Optional. Valid values are TRUE and FALSE. Enables the My WebEx, My Contacts feature for the user.
myFolders Optional. Valid values are TRUE and FALSE. Enables the My WebEx, My Folders feature for the user.
myMeetings Optional. Valid values are TRUE and FALSE. Enables the My WebEx, My Meetings feature for the user.
myPartnerLinks Optional. Valid values are TRUE and FALSE. Indicates whether the partner links for a host are displayed in My WebEx. Default: FALSE.
myProfile Optional. Valid values are TRUE and FALSE. Enables the My WebEx, My Profile feature for the user.
myReports Optional. Valid values are TRUE and FALSE. Enables the My WebEx, My Reports feature for the user.
myWorkspaces Optional. Valid values are TRUE and FALSE. Defines whether or not My Workspaces is enabled for WebOffice integration.
name Required. String. Maximum of 128 characters. Holds the name of the item.
name (in thirdPartyTeleconf element) Required for CreateUser. Optional for SetUser. String. Maximum of 32 characters. The name for a third party teleconferencing account. The name can include alphanumeric, underscore, dot, hyphen, and space characters.
nbrDialOut Optional. Enum {TOLL, TOLL_FREE} Selects the call out number to use for network based recording and audio broadcasts. Defaults to TOLL_FREE.
newWebExId Optional. String. Allows a new user name to be created.
notes Optional. Maximum of 2,048 characters. The host’s notes about the user. Default is “”.
notifyOnLinkRequest Optional. Valid values are TRUE and FALSE. Toggles the feature of notifying on link request. Default: FALSE.
notifyOnMeeting Optional. Valid values are TRUE and FALSE. Toggles the feature of notification upon the meeting’s start time. Default: FALSE.
notifyOnNewMessage Optional. Valid values are TRUE and FALSE. Toggles the feature of notification upon new messages’ arrival. Default: FALSE.
officeGreeting Optional. Maximum of 512 characters. The welcoming greeting for the user. This text appears in a welcome pop-up window.
officeurl Optional. String. Deprecated field.
officeUrlVisible Optional. Valid values are TRUE and FALSE. Toggles the URL for the user office. Default: FALSE.
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.
otherTelephony Optional. Valid values are TRUE and FALSE. Specifies whether a user account has the privilege to schedule a session with “other teleconferencing” feature enabled. Default value depends on the configurations on the user’s website.
pager Optional. Maximum of 64 characters. The user’s Office Profile pager number. Default: “”.
pagerVisible Optional. Valid values are TRUE and FALSE. Toggles the pager number for the user. Default: FALSE.
participantAccessCode Optional. String. The teleconferencing participant access code supplied by the telephony service provider.
participantAccessCodeLabel Required. String. Name of the participant access code.
participantFullAccessCode Optional. String. User-defined access code for a participant with the full speaking privilege in a WebEx personal teleconference.
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.
password Required for createUser. Optional for setUser. Maximum of 60 characters. User password. A user password will be validated against the password security options if enabled in the Site Administration tool: Require strict passwords for user account (for Create/SetUser). Do not allow cyclic passwords (for SetUser). ■ Do not allow site administrator to input password for other hosts (for Create/SetUser and ActivateUser). If any of the above password security rules is violated, an exception then occurs.
passwordDaysLeft Optional. Integer. Holds the number of days until the password must be changed.
passwordExpires Required. Boolean. Indicates whether the “Force users to change password every X days” option is enabled in the Site Administration tool.
passwordHint Optional. Maximum of 128 characters. The question for which passwordHintAnswer is an answer for the user. Default: “”.
passwordHintAnswer Optional. Maximum of 32 characters. The answer to the passwordHint for the user. If the user can answer the challenge correctly then he can be instantly presented with the password or it can be sent to him in an email message. Default: “”.
passwordLifetime Required. Integer. Indicates the number of days left until the password of a user will expire if the “Force users to change password every X days” option is enabled in the Site Administration tool.
pause Optional. A nonnegative integer with maximum value of 99. The number of seconds to pause during WebEx Network Based Recording (NBR) server’s dialing to a third party teleconference. Default: 0 (zero).
peActive Optional. Boolean. Applies to Personal Edition > Credit Card Billing sites. If TRUE, indicates user Subscription is active. Note can have a different value than the user’s status.
peExpired Optional. Boolean. Applies to Personal Edition > Credit Card Billing sites. If TRUE, indicates either: ■ For Subscriptions (non-PPU), the expiration date is past. ■ For Trial Offers, the trial duration days or trial minutes are used up. Note will not be returned when is FALSE.
personalAccountIndex Optional. Integer. Specifies the personal telephony account.
personalMeetingRoom Optional. Valid values are TRUE and FALSE. Enables the My WebEx, Personal Meetings Page feature for the user.
personalUrl Optional. Maximum of 128 characters. The user’s website. Default: “”.
phone (in commOptions element) Optional. Maximum of 64 characters. The user’s Office Profile 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: “”.
phone (in phones element) Optional. Valid values are TRUE and FALSE. Indicates the phone number for the user. Default: FALSE.
phone2 Optional. Maximum of 64 characters. The user’s secondary Office Profile 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: “”.
photoURL Optional. String Holds the URL for a personal photo.
pictureVisible Optional. Valid values are TRUE and FALSE. Toggles the pictures of the user office. Default: FALSE.
press Optional. Valid values are TRUE and FALSE. Indicates press releases. Default: FALSE.
prodAnnounce Optional. Valid values are TRUE and FALSE. Indicates product/service announcements. Default: FALSE.
prodID For Sales Center only. Required. Integer. ID of the product in which the user specializes.
promos Optional. Valid values are TRUE and FALSE. Indicates promotions and special offers. Default: FALSE.
protocol Optional. Enum{SAML1.1, SAML2.0} Specifies the SAML authentication protocol version. Default: SAML1.1.
recordedEvents Optional. Valid values are TRUE and FALSE. Enables the My WebEx, My Files: Recorded Events feature for the user.
recordingEditor Optional. Valid values are TRUE and FALSE. Indicates whether a user has the privilege to download WebEx Recording Editor from My WebEx > Support. Default: FALSE. Note In the Site Administration tool, Recording Editor must be enabled for a host. Otherwise, setting recordingEditor to TRUE will throw an exception.
regDateEnd Optional. End of range to select for a user’s registration date. Formatted as MM/DD/YYYY HH:MM:SS.
regDateStart Optional. Beginning of range to select for a user’s registration date. Formatted as MM/DD/YYYY HH:MM:SS.
registrationDate Optional. String. Returns the creation date for the user in the following format: MM/DD/YYYY HH:MM:SS.
rep For Sales Center only. Optional. Valid values are TRUE and FALSE. Indicates whether the user is a sales representative.
request Optional. Enum{DESK_VIEW, DESK_CTRL, APP_VIEW, APP_CTRL} Contains the action that is being requested from the customer.
resetPassword Optional. Valid values are TRUE and FALSE. Resets the user’s password to a random string and notifies the user of the change. Automatically sets forceChangePassword to TRUE. Defaults to FALSE.
returned Required if matchingRecords is specified. Integer. The number of records returned in the response.
returnPrefs Optional. Valid values are TRUE and FALSE. Determines if the WebACD preferences are returned. Defaults to TRUE.
roSiteAdmin Optional. Valid values are TRUE and FALSE. Indicates whether the current user is a site administrator with view only privilege. Default: FALSE.
salesCenter Optional. Valid values are TRUE and FALSE. Enables the Sales Center service (if available on the site) for the user.
samlResponse Required. String. An X.509 signed SAML 1.1 response which contains an assertion with uid=webexID.
schedulingPermission Optional. String. A semi-colon (;) separated list of WebEx IDs for other users that are allowed to schedule Training Center sessions on behalf of this user. Example: <schedulingPermission> jeffr;jasony;benh</schedulingPermission>
sendWelcome Optional. Valid values are TRUE and FALSE. Sends a welcome email to the new host if set to TRUE. Default is FALSE.
service Optional. Valid values are FREE_OFFICE, STANDARD_OFFICE, and PRO_OFFICE. The type of service that the user has. Default: FREE_OFFICE.
serviceType Required. Enumerated string. Valid values are MeetingCenter, TrainingCenter, EventCenter, SupportCenter, SalesCenter. In a Set API, specifies the default service type in a host’s one-click settings; in a Get API, holds the default service type returned from a query for a host’s one- click settings. Note When calling SetOneClickSettings, the service type cannot be set to EventCenter since Event Center does not support one-click.
sessionPassword Optional. String. Specifies the password for a meeting.
sessionTemplate Optional. 0..n Holds the user’s current session scheduling template.
sessionTicket Required. String. A random 32 alphanumeric character string that is associated with an authenticated user for the duration of a session.
sessionType Required. Integer. In a Set API, specifies the default session type in a host’s one-click settings; in a Get API, holds the default session type returned from a query for a host’s one- click settings. Note When calling SetOneClickSettings, the session type cannot be set to AUO since an audio- only session does not support one-click.
sharingColor Optional. Enum {256, 16BIT} Contains the sharing color.
sharingView Optional. Enum{FS_SCALE, FS, WIN, WIN_SCALE} Contains the sharing view.
singleSessClient Optional, Enum{NEW_CONSL, OLD_CONSL} Determines the single session client console type.
siteAdmin Optional. Valid values are TRUE and FALSE. Indicates whether the user has administrative privilege for the meeting. Default: FALSE.
sme For Sales Center only. Optional. Valid values are TRUE and FALSE. Indicates whether the user is a subject matter expert.
startFrom (in listControl element) Optional. Integer. Works with maximumNum to limit the quantity of returned objects as described in "Choosing A Subset of Records”.
startFrom (in matchingRecords element) Required. Integer. Record index number that the returned set starts from.
state Optional. Maximum of 32 characters. The country of residence for the user’s Office Profile. Default: “”.
status Required. Valid values are SUCCESS and FAILURE. Denotes if the specified username is disabled or not.
subscriberAccessCode Optional. String. The teleconferencing subscriber access code supplied by the telephony service provider.
subscriberAccessCode (in personalTeleconf element) Required. String. Holds the access code for the host in a WebEx personal teleconference.
subscriberAccessCodeLabel Optional. String. Name for the subscriber access code.
subscriptionOffice Optional. Valid values are TRUE and FALSE. Toggles the feature of subscription office. Default: FALSE.
supportApp Optional. Valid values are TRUE and FALSE. Toggles the feature of supporting applications. Default: FALSE.
supportAppshareRemote Optional. Valid values are TRUE and FALSE. Toggles the feature of supporting remote application sharing. Default: FALSE.
supportCenter Optional. Valid values are TRUE and FALSE. Enables the Support Center service for the user.
supportDesktopShare Optional. Valid values are TRUE and FALSE. Toggles the feature of supporting desktop sharing. Default: FALSE.
supportDesktopShareRemote Optional. Valid values are TRUE and FALSE. Toggles the feature of supporting remote desktop sharing. Default: FALSE.
supportFileShare Optional. Valid values are TRUE and FALSE. Toggles the feature of supporting file sharing. Default: FALSE.
supportMeetingRecord Optional. Valid values are TRUE and FALSE. Toggles the feature of supporting meeting recording. Default: FALSE.
supportVideo Optional. Valid values are TRUE and FALSE. Toggles the feature of supporting video for the meeting. Default: FALSE.
supportWebTourRemote Optional. Valid values are TRUE and FALSE. Toggles the feature of supporting remote web tour. Default: FALSE.
syncWebOffice Optional. Valid values are TRUE and FALSE. Indicates whether or not the user account is synchronized with WebOffice. Default: TRUE.
tab Enum {Tools, Desktop, Application, Session}, 4..4. Tab labels.
teleConfCallIn Optional. Valid values are TRUE and FALSE. Indicates whether conference calling into meetings is supported for the meeting. Defaults to site setting.
teleConfCallInInternational Optional. Valid values are TRUE and FALSE. Allows a user to access WebEx teleconferencing via international local call-in telephone numbers. Defaults to site setting. Note This option applies when the site has both Call-in teleconferencing and Allow access to teleconference via international local call-in numbers enabled in the Site Administration tool.
teleConfCallOut Optional. Valid values are TRUE and FALSE. Indicates whether conference calling out of meetings is supported for the meeting. Defaults to site setting.
teleConfCallOutInter national Optional. Valid values are TRUE and FALSE. Indicates whether international calling out of meetings is supported for the meeting. Defaults to site setting.
teleconfLocation Optional. String. Locale of the teleconference.
teleconfServiceName Optional. String. Name of the teleconferencing service.
teleConfTollFreeCallIn Optional. Valid values are TRUE and FALSE. Indicates whether toll-free calling into meetings is supported for the user. Defaults to site setting.
telephonySupport Required Enumerated string. Valid values are NONE, CALLIN, CALLBACK, OTHER. Specifies the type of telephone support.
templateType Optional. Enum {User Site}. Specifies the type of template to be used.
ticket Required. String. A random 32-character identifier string that is associated with a host, used for login authentication.
timeToLive Optional. String. Number of seconds that the sessionTicket is valid.
timeZone Optional. Requires 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 user or user’s office. Default is “GMT -08:00, Pacific Time (San Jose)”.
timeZoneID Optional. An integer ranging from 0 to 61. For details, see Time Zone, Language Encoding, and Country Codes. Determines the time zone for the geographic location of the meeting.
timeZoneWithDST Optional. String. A timezone description which is adjusted by DST, e.g. GMT-7:00, Pacific (San Francisco).
title Optional. Maximum of 128 characters. The user’s title. Default is “”.
titleVisible Optional. Valid values are TRUE and FALSE. Toggles the feature of displaying the user’s title. Default: FALSE.
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.
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.
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.
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.
total Required if matchingRecords is specified. Total number of records matching the query request.
tollFreeCallInNumberLabel Required. String. Name displayed for toll-free numbers.
tollCallInNumberLabel Required. String. Name displayed for toll numbers.
totalStorageSize Optional. Integer. Default My WebEx file storage size for the user. Note The logic of this element is as follows: If the totalStorageSize value exceeds the Total storage size set for each user on the site, then the user’s Additional storage field will be set to the difference. (The Total storage size and Additional storage per user are fields in the Site Administration tool.) If the site strictly limits the Additional storage for this site and the sum of this user and other user’s Additional storage values exceeds the site limit, then exceptionID=030016 is returned. For details, see “Exception Messages in Response Documents”. (The Additional storage for this site value is defined in the Super Administration Tool.)
trackingCode1..10 Optional. Maximum of 128 characters each. Ten text elements that you can use for any information about a user, such as project names, departments, or anything else of your choice. Default: “”.
trainingCenter Optional. Valid values are TRUE and FALSE. Enables the Training Center service (if available on the site) for the user.
trainingInfo Optional. Valid values are TRUE and FALSE. Indicates training information. Default: FALSE.
trainingRecordings Optional. Valid values are TRUE and FALSE. Enables the My WebEx, My Files: Training Recordings feature for the user.
tspAccountIndex Optional. Integer. Specifies the tsp account.
type Optional. Enum {NBR, LOCAL} `specifies the recording type.
type (defaultClient) Required. Enum{MULTI_SESS, SINGLE_SESS} Contains the default client type to be used.
url Optional. Maximum of 128 characters. The user’s URL, such as the URL of the user’s office. Default is “”.
userId Optional. A WebEx-assigned identification number that uniquely identifies a user within your website.
userloginURL Optional. Maximum of 128 characters. The URL for the user to log into WebEx services. Default is “”.
userlogoutURL Optional. Maximum of 128 characters. The URL for the user to log out WebEx services. Default is “”.
value Optional. String. Specifies the value of a tracking code.
value (in sessionTemplateSummaryType) Required. String. The value of a template.
visitCount Optional. A nonnegative integer value. A WebEx-maintained visitor count reflecting how many times users have visited the office Web page for the user. Default: 0.
voiceOverIp Optional. Valid values are TRUE and FALSE. Indicates voice communications over Internet protocols is supported for the meeting. Defaults to site setting.
voip Optional. Valid values are TRUE and FALSE. Specifies whether Voice Over IP telephony is enabled.
webExID Required for SetUser and DelUser. Optional for CreateUser and LstUser. String. Maximum of 64 characters. A reference to the WebEx user account for the meeting participant. Empty if the attendee is a VISITOR.
welcomeMessage Optional. String. Holds a welcome message for when people enter the meeting room.
workPhoneVisible Optional. Valid values are TRUE and FALSE. Toggles the work phone number for the user. Default: FALSE.
zipCode Optional. Maximum of 16 characters. The ZIP Code portion of the user’s Office Profile address. Default: “”.
Next