- Webex Meetings XML API Reference Guide
- Introduction
- XML Request and Response Documents
- User Service
- General Session Service
- Overview
- CreateContacts
- CreateDistList
- DelRecording
- DelSession
- DetectSessionByCallback
- GetAPIVersion
- GetOneClickSettings
- GetRecordingInfo
- GetSessionInfo
- LstContact
- LstDistList
- LstOpenSession
- LstRecording
- LstsummarySession
- SetDistList
- SetOneClickSettings
- SetRecordingInfo
- SetupOneClickSettings
- Elements in Webex XML Schema Definitions for the General Session Service
- Meeting Service
- Training Session Service
- Overview
- AddScheduledTest
- CheckLabAvailability
- CopyLibTests
- CreateTrainingSession
- DelLibTests
- DelScheduledTest
- DelTrainingSession
- GetIMStestDetails
- GetIMStestResult
- GetLabInfo
- GetLabSchedule
- GetTestInformation
- GetTrainingSession
- LstLibTests
- LstScheduledTests
- LstsummaryTrainingSession
- LstTrainingSession (Deprecated)
- ReserveLab
- SetScheduledTest
- SetTrainingSession
- UploadIMStest
- Elements in Webex XML Schema Definitions for the Training Session Service
- Event Center Sessions
- Support Center Service
- History Service
- Overview
- LsteventattendeeHistory
- LsteventsessionHistory
- LstmeetingattendeeHistory
- LstmeetingusageHistory
- LstrecordaccessDetailHistory
- LstrecordaccessHistory
- LstsupportattendeeHistory
- LstsupportsessionHistory
- LsttrainingattendeeHistory
- LsttrainingsessionHistory
- Elements in Webex XML Schema Definitions for the History Service
- Site Service
- Meeting Attendee Service
- Meeting Type Service
GetSite
WebEx partners can use the GetSite command to get a list of features, options and privileges that are configured for their WebEx service sites, including Meeting Center, Training Center, Event Center, Support Center, and Sales Center. WebEx partners are able to use this information to customize menu items that appear in the left side and top
navigation bars on their WebEx site.
The first attendee becomes the presenter on MC. The <firstAttendeeAsPresenter> element is available inCreateMeeting, SetMeeting. The element <firstAttendeeAsPresenter> is part of the response for GetMeeting. The element <firstAttendeeAsPresenter> is part of the response for GetSite.
| Element | Parent | Definition | Type | Default |
|---|---|---|---|---|
firstAttendeeAsPresenter |
schedule |
Turns on/off "The first attendee to join will be the presenter" | boolean |
The default value for TopBarIndex returned by getSite is defined in code. The default value is not stored in the database. If the TopBarIndex value has not been customized, then GetSite returns the default value of "WL;MC;EC;SaC;SC;TC;SA;PS;".
If the TopBarIndex value has been customized, then getSite returns the customized value from the database.
GetSite includes the following elements to determine whether the TelePresence integration is enabled for the site and meeting type"Do no display" flag:
| Element | Parent | Definition | Type | Default |
|---|---|---|---|---|
enableTP |
<tools> |
Returns "Enable One Touch TelePresence (MC only)" checkbox status | boolean 0..1 | FALSE |
enableTPplus |
<tools> |
Returns "Enable One Touch Telepresence Plus (MC only)" checkbox status from site admin | boolean 0..1 | FALSE |
hideInScheduler |
<metaData>:<meetingTypes> |
Returns "Do not display in scheduler (For Telepresence only)" checkbox status for meeting type | boolean 0..1 | FALSE |
Note: To enhance Personal Conference security, the XML API supports a user's telephone PIN that is used to add security to Personal
Conference Number audio.
The following element is available in createUser, setUser, and getUser to support a user's telephone PIN:
| Element | Parent | Definition | Type | Default |
|---|---|---|---|---|
PIN |
<phones> |
Secondary level of authentication for PCN and when host is using the phone and inviting additional attendees | string 0..1 |
The following new element has been added to createUser, setUser, and getUser to support PCN Join Before Host:
The joinBeforeHost element is available in the createUser, setUser, and getUser operations to support the "PCN Join Before Host" setting:
| Element | Parent | Definition | Type | Default |
|---|---|---|---|---|
joinBeforeHost |
<personalTeleconf> |
Indicates if PCN-Join Before Host is enabled for the user | boolean 0..1 | FALSE |
Original
in Creat/SetUser is ignored; this flag is not supported at the user level for versions T28 and higher. If an XML API user who has never had a PIN launches a PCN meeting and calls WebEx audio access number on T28, the WebEx audio IVR will prompt user to enter their PIN. The user needs to create their PIN before attempting to launch a PCN meeting on T28. Otherwise, the user will not be able to launch meetings any more.
T28 requires the the host to set a PIN before a PCN account can be added or edited. So the XML API also has this restriction.
Create/SetUser requires user has valid PIN to add or edit PCN account. If a valid PIN does not exist, the XML API throws an exception: "valid
PIN is required".
Logic
1.The PIN can be set through the XML API by using Create/SetUser. GetUser can be used to retrieve host's PIN.
2.When using Create/SetUser to specify the PIN, the XML API will check to see if the value provided is a valid PIN. Single number values and simple sequences, like 1111 or 1234 are not allowed. If value is not a valid PIN, the XML API throws the exception: WBXValidationException
(ID=999999, "Not a valid PIN! PIN must be 4-digit number and not allow PIN to be Single number values or simple sequences, like 1111 or 1234.") "Not a valid PIN".
3.Create/SetUser will only allow the siteadmin to specify <personalTeleconf><joinBeforeHost> for the host. This option
can only be specified on the SiteAdmin page - so the host is not allowed to change the setting. If this rule is violated, the XML API will throw the exception: NoPrivilegeException(ID = 000001, "Access denied, additional privileges are required")
4.If the <personalTeleconf><account><joinBeforeHost> value is set through the XML API Create/SetUser request, this input value will now be ignored. Only the value of new element <personalTeleconf><joinBeforeHost> should be used.
5.The XML API GetUser response will still return <personalTeleconf><account><joinBeforeHost>, but the value will be identical to the value of the new element <personalTeleconf><joinBeforeHost>.
Note This API can be executed by both hosts and site administrators.
Request
The sample XML document shows an example of a request for information about the features enabled for the site.
The following schema diagram shows the structure of the elements in the getSite request message.
Figure 10-1 • Schema diagram for getSite
For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context. For descriptions of the non-global elements, refer to “Elements in WebEx XML Schema Definitions for the Site Service”.
Response
The sample XML document shows an example of a possible response for the preceding query XML document.
The following schema diagrams show the structure of the elements in the getSiteResponse message.
Figure 10-2 • Schema diagram for getSiteResponse
Figure 10-3 • Schema diagram for GetSiteResponse (Part 1)
Figure 10-4 • Schema diagram for GetSiteResponse (Part 2)
Figure 10-5 • Schema diagram for GetSiteResponse (Part 3)
Figure 10-6 • Schema diagram for GetSiteResponse (Part 4)
Figure 10-7 • Schema diagram for GetSiteResponse (Part 5)
Figure 10-8 • Schema diagram for GetSiteResponse (Part 6)
Figure 10-9 • Schema diagram for GetSiteResponse (Part 7
Figure 10-10 • Schema diagram for GetSiteResponse (Part 8)
Figure 10-11 • Schema diagram for GetSiteResponse (Part 9)
Figure 10-12 • Schema diagram for GetSiteResponse (Part 10)
Figure 10-13 • Schema diagram for GetSiteResponse (Part 11)
Note
- Returns the password criteria set by the site admin so that user and
session password definitions will be enforced. - GetSiteResponse returns the following options so WebOffice is able
to control the My Profile display: PMRheaderBranding,
PMRheaderBrandingLocation, changePersonalURL, changeUserName,
displayDisabledService, scheduleOnBehalf, and saveSessionTemplate. - GetSiteResponse returns a “Marketing Add-on” option.
- Integrations that build duplicate WebEx scheduling pages are able to
retrieve the default scheduling settings for a new session. - GetSiteResponse returns the TSP server information configured in the
Super Admin web page. - GetSiteResponse returns a “Train base release name” for J2EE sites.
- GetSiteResponse returns the Persistent TSP Adaptor for MeetingPlace
configuration. - GetSiteResponse returns the Super Admin Multi-Media Platform options
that define the Broadcast audio stream. - GetSiteResponse returns the display name for OTHER teleconferencing
using thefield. - Users are allowed to customize links and fields in the Left
Navigation bar. - GetSiteResponse returns productivity tool and template options from
Super admin and Site admin. - GetSiteResponse is able to return a default My WebEx page along with
it’s component version number.
Table 10-3 shows the variables that can be used when populating the TSP Adaptor Settings page with call-in numbers.
Table 10-3 • Global Call-In URL Variable Definitions
The result and exceptionID global elements allow you to confirm that an instantiation request was successful. These elements are described in
“Global Response Elements Showing Results and Errors”.