Webex XML API
- 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
GetOneClickSettings
Retrieves one-click settings for a host.This API now fully supports WebEx telephony, PCN telephony and TSP.
Note Site administrator can get one-click settings for any user with a specified webExID, while a regular host can only retrieve his or her own one-click settings.
Request
The sample XML document shows an example of a request to retrieve one-click settings for a specific WebEx ID.
xml
Copy<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:serv="http://www.webex.com/schemas/2002/06/service"
xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service
http://www.webex.com/schemas/2002/06/service/service.xsd">
<header>
<securityContext>
<webExID>hostid</webExID>
<password>hostpassword</password>
</securityContext>
</header>
<body>
<bodyContent
xsi:type="java:com.webex.service.binding.ep.GetOneClickSettings"
xmlns:cong="http://www.webex.com/schemas/2002/06/service/ep"
xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service/user"
xmlns:ep="http://www.webex.com/schemas/2002/06/service/ep/ep.xsd">
<hostWebExID>hostid</hostWebExID>
</bodyContent>
</body>
</serv:message>
The following schema diagram shows the structure of the elements in the getOneClickSettings request message.
Figure 4-21 • Schema diagram for getOneClickSettings
Response
The sample XML document shows an example of a possible response to the preceding request document.
xml
Copy<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service"
xmlns:com="http://www.webex.com/schemas/2002/06/common"
xmlns:ep="http://www.webex.com/schemas/2002/06/service/ep"
xmlns:meet="http://www.webex.com/schemas/2002/06/service/meeting">
<serv:header>
<serv:response>
<serv:result>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="ep:getOneClickSettingsResponse"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ep:metaData>
<ep:serviceType>MeetingCenter</ep:serviceType>
<ep:sessionType>3</ep:sessionType>
<ep:confName>sany's meeting</ep:confName>
<ep:sessionPassword>111111</ep:sessionPassword>
<ep:listing>UNLISTED</ep:listing>
<ep:sessionTemplate>
<ep:name>MC_3</ep:name>
<ep:type>User</ep:type>
<ep:value>U;MC;en_US;8.5;111832;MC_3; ; ;</ep:value>
</ep:sessionTemplate>
</ep:metaData>
<ep:trackingCodes>
<ep:trackingCode>
<ep:index>1</ep:index>
<ep:name>Division</ep:name>
<ep:inputMode>Input Text</ep:inputMode>
<ep:value />
</ep:trackingCode>
<ep:trackingCode>
<ep:index>2</ep:index>
<ep:name>Department</ep:name>
<ep:inputMode>Input Text</ep:inputMode>
<ep:value />
</ep:trackingCode>
<ep:trackingCode>
<ep:index>3</ep:index>
<ep:name>Project</ep:name>
<ep:inputMode>Input Text</ep:inputMode>
<ep:value />
</ep:trackingCode>
<ep:trackingCode>
<ep:index>4</ep:index>
<ep:name>Other</ep:name>
<ep:inputMode>Input Text</ep:inputMode>
<ep:value />
</ep:trackingCode>
<ep:trackingCode>
<ep:index>5</ep:index>
<ep:name>Custom5</ep:name>
<ep:inputMode>Input Text</ep:inputMode>
<ep:value />
</ep:trackingCode>
<ep:trackingCode>
<ep:index>6</ep:index>
<ep:name>Custom6</ep:name>
<ep:inputMode>Input Text</ep:inputMode>
<ep:value />
</ep:trackingCode>
<ep:trackingCode>
<ep:index>7</ep:index>
<ep:name>Custom7</ep:name>
<ep:inputMode>Input Text</ep:inputMode>
<ep:value>test17777</ep:value>
</ep:trackingCode>
<ep:trackingCode>
<ep:index>8</ep:index>
<ep:name>Custom8</ep:name>
<ep:inputMode>Input Text</ep:inputMode>
<ep:value />
</ep:trackingCode>
<ep:trackingCode>
<ep:index>9</ep:index>
<ep:name>Custom9</ep:name>
<ep:inputMode>Input Text</ep:inputMode>
<ep:value />
</ep:trackingCode>
<ep:trackingCode>
<ep:index>10</ep:index>
<ep:name>Custom10</ep:name>
<ep:inputMode>Input Text</ep:inputMode>
<ep:value />
</ep:trackingCode>
</ep:trackingCodes>
<ep:telephony>
<ep:telephonySupport>CALLIN</ep:telephonySupport>
<ep:tspAccountIndex>1</ep:tspAccountIndex>
<ep:account>
<serv:tollFreeCallInNumber>1-408197041
</serv:tollFreeCallInNumber>
<serv:tollCallInNumber>1-408197043</serv:tollCallInNumber>
<serv:subscriberAccessCode>10060189
</serv:subscriberAccessCode>
<serv:participantAccessCode>10133851
</serv:participantAccessCode>
<ep:participantLimitedAccessCode />
<ep:globalNum>
<serv:countryAlias>Turks and Caicos</serv:countryAlias>
<serv:phoneNumber>785643556436545</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Sweden</serv:countryAlias>
<serv:phoneNumber>010-111222</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>1111112243433</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Thailand</serv:countryAlias>
<serv:phoneNumber>45545454</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>1-408-197-042</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>32534645656456456456</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>4564445</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>456546545456546456546</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>1242315436546757</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Togo</serv:countryAlias>
<serv:phoneNumber>346547657868</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>355476658989767456</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>3453465546-657658657865
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>354365-567657657657</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>4565676745(768768768)67567
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>5464576568(657567865)(-676
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>546456765785676523213-675
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>45345-787686575654</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>3244365768768768</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Taiwan</serv:countryAlias>
<serv:phoneNumber>56768909(676547)-786587
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>4564563543453543543</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Slovenia</serv:countryAlias>
<serv:phoneNumber>568765443212</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Syria</serv:countryAlias>
<serv:phoneNumber>456543214122323</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Uzbekistan</serv:countryAlias>
<serv:phoneNumber>4564210124114</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Philippines</serv:countryAlias>
<serv:phoneNumber>4532768769325321332</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Slovakia</serv:countryAlias>
<serv:phoneNumber>543123123456546546</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>South Africa</serv:countryAlias>
<serv:phoneNumber>45312.1213546456546</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>45201456354654654</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>454576879879576</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Myanmar</serv:countryAlias>
<serv:phoneNumber>4565476567678753</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>125457768678767</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>1445675876987897687</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>14355476879879</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>1446658789879870879879</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>(76876876)76876876867-7685
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>3545768(546457567)78676876
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>234365776(67657657)7567686
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>3243243254365546546546</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>34543543654643534</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>12342143455657546</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>324354645766546456</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>43546545766756754656</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>1243466588690890879967</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>988655463466876798-8567547
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>5465676867456589-657675675
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>5665767856 567655687658678
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>5675687097657-657867876876
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>436567678(65767658)7686575
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>54634769897645065754-76865
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Tanzania</serv:countryAlias>
<serv:phoneNumber>5567568769879476867</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Wallis And Futuna Islands
</serv:countryAlias>
<serv:phoneNumber>4356587897547978976</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Zimbabwe</serv:countryAlias>
<serv:phoneNumber>14457698078567456534543</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>3456576790456346067546</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>346565869789789</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Panama</serv:countryAlias>
<serv:phoneNumber>2354656765767567567575</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Tajikistan</serv:countryAlias>
<serv:phoneNumber>4567567567856745643879</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Taiwan</serv:countryAlias>
<serv:phoneNumber>6786787845676</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Wallis And Futuna Islands
</serv:countryAlias>
<serv:phoneNumber>5675674564242445657657</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>5674564576874565445645</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Papua New Guinea</serv:countryAlias>
<serv:phoneNumber>4564576789674652345456</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Thailand</serv:countryAlias>
<serv:phoneNumber>3456537687684686788768</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Tonga Islands</serv:countryAlias>
<serv:phoneNumber>4543265654765756756765</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>Tajikistan</serv:countryAlias>
<serv:phoneNumber>254656754675546765546</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>45654654645654</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>23462345234556756545</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>246547657(5465466)45646554
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>(1234422)43546576767-8888
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
<ep:globalNum>
<serv:countryAlias>United States of America
</serv:countryAlias>
<serv:phoneNumber>(6575786876)565467-888888
</serv:phoneNumber>
<serv:tollFree>false</serv:tollFree>
</ep:globalNum>
</ep:account>
<ep:accountLabel>
<serv:tollFreeCallInNumberLabel>
Call-in toll-free number (US/Canada)
</serv:tollFreeCallInNumberLabel>
<serv:tollCallInNumberLabel>Call-in toll number (US/Canada)
</serv:tollCallInNumberLabel>
<serv:subscriberAccessCodeLabel>Host access code
</serv:subscriberAccessCodeLabel>
<serv:participantAccessCodeLabel>
Attendee access code(Full Speaking)
</serv:participantAccessCodeLabel>
<ep:participantLimitedAccessCodeLabel>
Attendee access code(Listen Only)
</ep:participantLimitedAccessCodeLabel>
</ep:accountLabel>
<ep:teleconfServiceName>Personal Conference No.
</ep:teleconfServiceName>
<ep:intlLocalCallIn>true</ep:intlLocalCallIn>
<ep:tollfree>true</ep:tollfree>
<ep:entryExitTone>BEEP</ep:entryExitTone>
</ep:telephony>
<ep:enableOptions>
<ep:voip>false</ep:voip>
</ep:enableOptions>
<ep:attendeeOptions>
<ep:joinApproval>false</ep:joinApproval>
</ep:attendeeOptions>
</serv:bodyContent>
</serv:body>
</serv:message>
The following schema diagram shows the structure of the elements in the getOneClickSettingsResponse message.
Figure 4-22 • Schema diagram for getOneClickSettingsResponse
-
GetOneClickSettingsResponseallows a user to retrieve the listing type of One-Click settings for a user account. - The metadata container holds the
CUVCMeetingIDelement for inviting remote video devices to a WebEx meeting. -
GetOneClickSettingsResponsesets the “Ask for my approval when someone joins” option.