DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSubmission Checklist for Embedded Apps
Design Guidelines
MeetingsMessagingDevices
API Reference
BotsButtons and CardsIntegrationsLogin with WebexWidgetsGuest IssuerWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP Basics
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSpace ClassificationsTracking CodesWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Workspace SettingsWholesale Billing ReportsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Integrations and AuthorizationWebex for BroadWorksWebex for WholesaleWholesale and Broadworks Common Guide
Reference
BroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportSCIM2-GroupVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWholesale Billing ReportsWholesale CustomersWholesale Subscribers
Contact Center
Overview
Devices
Overview
Guides
DevicesWorkspace Integrations Guide
Reference
Device ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording ReportRecordingsSCIM2-GroupSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Overview
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSCIM2-GroupSecurity Audit EventsSession TypesSite
GETGet Meeting Common Settings Configuration
PATCHUpdate Meeting Common Settings Configuration
Space ClassificationsTeam MembershipsTeamsTracking CodesVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWebhooksWholesale Billing ReportsWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

Update Meeting Common Settings Configuration

Site administrators can use this API to update the option of features, options and privileges that are configured for their WebEx service sites.

PATCH/v1/admin/meeting/config/commonSettings
Body Parameters
siteOptions
object

Site Options on Webex Administration.

allowCustomPersonalRoomURL
boolean

Allow hosts to change their Personal Room URLs.

defaultSchedulerOptions
object

Default Scheduler Options on Webex Administration (These options are applied to the site as defaults, but individual users can change them).

entryAndExitTone
enumrequired

Determines if a sound is made when someone enters or exits.

NoTone
string

No tone.

Beep
string

Beep.

AnnounceName
string

Announce name.

joinTeleconfNotPress1
boolean

Specifies whether or not joining teleconference without pressing 1 is checked by default.

telephonySupport
enumrequired

Specifies the type of teleconference support for meetings.

None
string

None.

WebexTeleconferencing
string

Webex teleconferencing (Unabled when Webex Super Admin hasn't turned on call-in teleconferencing and call-back teleconferencing).

Other
string

Other Teleconferencing (Unabled when Webex Super Admin hasn't turned on other teleconferencing).

tollFree
boolean

Specifies whether toll-free call-in is available, it can't be specified when telephonySupport was not WebexTeleconferencing, and it can't be specified as true when Webex Super Admin hasn't turned on toll-free call-in teleconferencing.

VoIP
boolean

Denotes if VoIP protocols are being used, it can't be specified as true when Webex Super Admin hasn't turned on Voice Over IP functionality.

scheduleMeetingOptions
object

Schedule Meeting Options on Webex Administration.

emailReminders
boolean

Determines if email reminders are to be sent out.

securityOptions
object

Security Options on Webex Administration.

joinBeforeHost
boolean

Allow attendees or panelists to join before the host.

audioBeforeHost
boolean

Allows attendees or panelists to join the teleconference before the host, it can't be turned on when joinBeforeHost was false.

firstAttendeeAsPresenter
boolean

Allows first attendee or panelist as the presenter, it can't be turned on when firstAttendeeAsPresenter was false.

unlistAllMeetings
boolean

Specifies that all meetings must be unlisted.

requireLoginBeforeAccess
boolean

Determines if a user must login before getting site access.

allowMobileScreenCapture
boolean

Allow screen capture (Android devices only).

requireStrongPassword
boolean

Determines if strict passwords are required for meetings.

passwordCriteria
object

Criteria of a strong password, which cannot be specified when requireStrongPassword was false.

mixedCase
boolean

Determines if a password requires mixed case.

minLength
number

Sets the minimum password length, maximum value limit of 12.

minNumeric
number

Sets the minimum number of numeric characters in the password, maximum value limit of 12.

minAlpha
number

Sets the minimum number of alphabetical characters in the password, maximum value limit of 12.

minSpecial
number

Sets the minimum number of special characters in the password, maximum value limit of 12.

disallowDynamicWebText
boolean

Do not allow dynamic web page text for meeting passwords (like site name, host's name, username, meeting topic).

disallowList
boolean

Specifies if passwords from the disallowValues list are to be allowed.

disallowValues
array[string]

Sets password values that are not allowed, and cannot type repeated items in it.

Response Properties
siteOptions
object

Site Options on Webex Administration.

allowCustomPersonalRoomURL
boolean

Allow hosts to change their Personal Room URLs.

telephonyConfig
object

Telephony Configuration on WebEx Super Admin (These options are read-only, unable to update by Update Common Settings API).

allowCallIn
boolean

Whether call-in teleconferencing for sessions was enabled.

allowCallBack
boolean

Whether call-back teleconferencing for sessions was enabled.

allowOtherTeleconf
boolean

Whether other teleconferencing for sessions was enabled.

allowTollFreeCallin
boolean

Whether toll-free call-in teleconferencing was enabled.

allowInternationalCallin
boolean

Whether international call-in teleconferencing was enabled.

allowInternationalCallback
boolean

Whether international call-back teleconferencing was enabled.

VoIP
boolean

Whether Voice Over IP functionality using the attendee computer's speakers and microphones was enabled.

defaultSchedulerOptions
object

Default Scheduler Options on Webex Administration (These options are applied to the site as defaults, but individual users can change them).

entryAndExitTone
enum

Determines if a sound is made when someone enters or exits.

NoTone
string

No tone.

Beep
string

Beep.

AnnounceName
string

Announce name.

joinTeleconfNotPress1
boolean

Specifies whether or not joining teleconference without pressing 1 is checked by default.

telephonySupport
enum

Specifies the type of teleconference support for meetings.

None
string

None.

WebexTeleconferencing
string

Webex teleconferencing.

Other
string

Other Teleconferencing.

tollFree
boolean

Specifies whether toll-free call-in is available.

VoIP
boolean

Denotes if VoIP protocols are being used.

scheduleMeetingOptions
object

Schedule Meeting Options on Webex Administration.

emailReminders
boolean

Determines if email reminders are to be sent out.

securityOptions
object

Security Options on Webex Administration.

joinBeforeHost
boolean

Allow attendees or panelists to join before the host.

audioBeforeHost
boolean

Allows attendees or panelists to join the teleconference before the host.

firstAttendeeAsPresenter
boolean

Allows first attendee or panelist as the presenter.

unlistAllMeetings
boolean

Specifies that all meetings must be unlisted.

requireLoginBeforeAccess
boolean

Determines if a user must login before getting site access.

allowMobileScreenCapture
boolean

Allow screen capture (Android devices only).

requireStrongPassword
boolean

Determines if strict passwords are required for meetings.

passwordCriteria
object

Criteria of a strong password.

mixedCase
boolean

Determines if a password requires mixed case.

minLength
number

Sets the minimum password length.

minNumeric
number

Sets the minimum number of numeric characters in the password.

minAlpha
number

Sets the minimum number of alphabetical characters in the password.

minSpecial
number

Sets the minimum number of special characters in the password.

disallowDynamicWebText
boolean

Do not allow dynamic web page text for meeting passwords (like site name, host's name, username, meeting topic).

disallowList
boolean

Specifies if passwords from the disallowValues list are to be allowed.

disallowValues
array[string]

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.

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
  • Try it
  • Example
PATCH
/v1/admin/meeting/config/commonSettings
Log in to try the API.
Header
Body
  • Site Options on Webex Administration.
  • Default Scheduler Options on Webex Administration (These options are applied to the site as defaults, but individual users can change them).
  • Schedule Meeting Options on Webex Administration.
  • Security Options on Webex Administration.
  • Request
  • Response
{
    "defaultSchedulerOptions": {
        "entryAndExitTone": "AnnounceName",
    },
    "scheduleMeetingOptions": {
        "emailReminders": false,
    },
    "securityOptions": {
        "joinBeforeHost": true,
        "audioBeforeHost": false,
        "firstAttendeeAsPresenter": false,
        "requireStrongPassword": true,
        "passwordCriteria": {
            "mixedCase": false,
            "disallowValues": [
                "password",
                "passwd",
                "pwd"
            ]
        }
    }
}
200 / OK
{
    "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"
            ]
        }
    }
}

Connect

Support

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2023 Cisco and/or its affiliates. All rights reserved.