Get Meeting Common Settings Configuration
Site administrators can use this API to get a list of functions, options, and privileges that are configured for their Webex service sites.
- If
siteUrlis specified, common settings of the meeting's configuration of the specified site will be queried; otherwise, the API will query from the site administrator's preferred site. All available Webex sites and preferred site of the user can be retrieved by Get Site List API.
Query Parameters
URL of the Webex site which the API queries common settings of the meeting's configuration from. If not specified, the API will query from the site administrator's preferred site. All available Webex sites and the preferred site of the user can be retrieved by the Get Site List API.
Response Properties
Site Options on Webex Administration.
Allow hosts to change their Personal Room URLs.
Telephony Configuration on WebEx Super Admin (These options are read-only, unable to update by Update Common Settings API).
Whether call-in teleconferencing for sessions was enabled.
Whether call-back teleconferencing for sessions was enabled.
Whether other teleconferencing for sessions was enabled.
Whether toll-free call-in teleconferencing was enabled.
Whether international call-in teleconferencing was enabled.
Whether international call-back teleconferencing was enabled.
Whether Voice Over IP functionality using the attendee computer's speakers and microphones was enabled.
Default Scheduler Options on Webex Administration (These options are applied to the site as defaults, but individual users can change them).
Determines if a sound is made when someone enters or exits.
No tone.
Beep.
Announce name.
Specifies whether or not joining teleconference without pressing 1 is checked by default.
Specifies the type of teleconference support for meetings.
None.
Webex teleconferencing.
Other Teleconferencing.
Specifies whether toll-free call-in is available.
Denotes if VoIP protocols are being used.
Schedule Meeting Options on Webex Administration.
Determines if email reminders are to be sent out.
Security Options on Webex Administration.
Allow attendees or panelists to join before the host.
Allows attendees or panelists to join the teleconference before the host.
Allows first attendee or panelist as the presenter.
Specifies that all meetings must be unlisted.
Determines if a user must login before getting site access.
Allow screen capture (Android devices only).
Determines if strict passwords are required for meetings.
Criteria of a strong password.
Determines if a password requires mixed case.
Sets the minimum password length.
Sets the minimum number of numeric characters in the password.
Sets the minimum number of alphabetical characters in the password.
Sets the minimum number of special characters in the password.
Do not allow dynamic web page text for meeting passwords (like site name, host's name, username, meeting topic).
Specifies if passwords from the disallowValues list are to be allowed.
Sets password values that are not allowed.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- URL of the Webex site which the API queries common settings of the meeting's configuration from. If not specified, the API will query from the site administrator's preferred site. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.
{
"siteOptions": {
"allowCustomPersonalRoomURL": true
},
"telephonyConfig": {
"allowCallIn": true,
"allowCallBack": true,
"allowOtherTeleconf": true,
"allowTollFreeCallin": true,
"allowInternationalCallin": true,
"allowInternationalCallback": true,
"VoIP": true
},
"defaultSchedulerOptions": {
"entryAndExitTone": "Beep",
"joinTeleconfNotPress1": true,
"telephonySupport": "WebexTeleconferencing",
"tollFree": true,
"VoIP": false
},
"scheduleMeetingOptions": {
"emailReminders": true
},
"securityOptions": {
"joinBeforeHost": true,
"audioBeforeHost": true,
"firstAttendeeAsPresenter": true,
"unlistAllMeetings": false,
"requireLoginBeforeAccess": false,
"allowMobileScreenCapture": true,
"requireStrongPassword": true,
"passwordCriteria": {
"mixedCase": true,
"minLength": 8,
"minNumeric": 2,
"minAlpha": 4,
"minSpecial": 1,
"disallowDynamicWebText": true,
"disallowList": true,
"disallowValues": [
"password",
"Admin@123",
"passwd",
"pass"
]
}
}
}