Webex · Schema

GetMeetingConfigurationCommonSettingObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
siteOptions object Site Options on Webex Administration.
telephonyConfig object Telephony Configuration on WebEx Super Admin (These options are read-only, unable to update by Update Common Settings API).
defaultSchedulerOptions object Default Scheduler Options on Webex Administration (These options are applied to the site as defaults, but individual users can change them).
scheduleMeetingOptions object Schedule Meeting Options on Webex Administration.
securityOptions object Security Options on Webex Administration.
View JSON Schema on GitHub

JSON Schema

webex-getmeetingconfigurationcommonsettingobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetMeetingConfigurationCommonSettingObject",
  "title": "GetMeetingConfigurationCommonSettingObject",
  "type": "object",
  "properties": {
    "siteOptions": {
      "type": "object",
      "properties": {
        "allowCustomPersonalRoomURL": {
          "type": "boolean",
          "description": "Allow hosts to change their Personal Room URLs."
        }
      },
      "description": "Site Options on Webex Administration."
    },
    "telephonyConfig": {
      "type": "object",
      "properties": {
        "allowCallIn": {
          "type": "boolean",
          "description": "Whether call-in teleconferencing for sessions was enabled."
        },
        "allowCallBack": {
          "type": "boolean",
          "description": "Whether call-back teleconferencing for sessions was enabled."
        },
        "allowOtherTeleconf": {
          "type": "boolean",
          "description": "Whether other teleconferencing for sessions was enabled."
        },
        "allowTollFreeCallin": {
          "type": "boolean",
          "description": "Whether toll-free call-in teleconferencing was enabled."
        },
        "allowInternationalCallin": {
          "type": "boolean",
          "description": "Whether international call-in teleconferencing was enabled."
        },
        "allowInternationalCallback": {
          "type": "boolean",
          "description": "Whether international call-back teleconferencing was enabled."
        },
        "VoIP": {
          "type": "boolean",
          "description": "Whether Voice Over IP functionality using the attendee computer's speakers and microphones was enabled."
        }
      },
      "description": "Telephony Configuration on WebEx Super Admin (These options are read-only, unable to update by Update Common Settings API)."
    },
    "defaultSchedulerOptions": {
      "type": "object",
      "required": [
        "entryAndExitTone",
        "telephonySupport"
      ],
      "properties": {
        "entryAndExitTone": {
          "type": "string",
          "enum": [
            "NoTone",
            "Beep",
            "AnnounceName"
          ],
          "description": "Determines if a sound is made when someone enters or exits.\n * `NoTone` - No tone.\n * `Beep` - Beep.\n * `AnnounceName` - Announce name.\n"
        },
        "joinTeleconfNotPress1": {
          "type": "boolean",
          "description": "Specifies whether or not joining teleconference without pressing 1 is checked by default."
        },
        "telephonySupport": {
          "type": "string",
          "enum": [
            "None",
            "WebexTeleconferencing",
            "Other"
          ],
          "description": "Specifies the type of teleconference support for meetings.\n * `None` - None.\n * `WebexTeleconferencing` - Webex teleconferencing.\n * `Other` - Other Teleconferencing.\n"
        },
        "tollFree": {
          "type": "boolean",
          "description": "Specifies whether toll-free call-in is available."
        },
        "VoIP": {
          "type": "boolean",
          "description": "Denotes if VoIP protocols are being used."
        }
      },
      "description": "Default Scheduler Options on Webex Administration (These options are applied to the site as defaults, but individual users can change them)."
    },
    "scheduleMeetingOptions": {
      "type": "object",
      "properties": {
        "emailReminders": {
          "type": "boolean",
          "description": "Determines if email reminders are to be sent out."
        }
      },
      "description": "Schedule Meeting Options on Webex Administration."
    },
    "securityOptions": {
      "type": "object",
      "properties": {
        "joinBeforeHost": {
          "type": "boolean",
          "description": "Allow attendees or panelists to join before the host."
        },
        "audioBeforeHost": {
          "type": "boolean",
          "description": "Allows attendees or panelists to join the teleconference before the host."
        },
        "firstAttendeeAsPresenter": {
          "type": "boolean",
          "description": "Allows first attendee or panelist as the presenter."
        },
        "unlistAllMeetings": {
          "type": "boolean",
          "description": "Specifies that all meetings must be unlisted."
        },
        "requireLoginBeforeAccess": {
          "type": "boolean",
          "description": "Determines if a user must login before getting site access."
        },
        "allowMobileScreenCapture": {
          "type": "boolean",
          "description": "Allow screen capture (Android devices only)."
        },
        "requireStrongPassword": {
          "type": "boolean",
          "description": "Determines if strict passwords are required for meetings."
        },
        "passwordCriteria": {
          "type": "object",
          "properties": {
            "mixedCase": {
              "type": "boolean",
              "description": "Determines if a password requires mixed case."
            },
            "minLength": {
              "type": "number",
              "example": 8,
              "description": "Sets the minimum password length."
            },
            "minNumeric": {
              "type": "number",
              "example": 2,
              "description": "Sets the minimum number of numeric characters in the password."
            },
            "minAlpha": {
              "type": "number",
              "example": 4,
              "description": "Sets the minimum number of alphabetical characters in the password."
            },
            "minSpecial": {
              "type": "number",
              "example": 1,
              "description": "Sets the minimum number of special characters in the password."
            },
            "disallowDynamicWebText": {
              "type": "boolean",
              "description": "Do not allow dynamic web page text for meeting passwords (like site name, host's name, username, meeting topic)."
            },
            "disallowList": {
              "type": "boolean",
              "description": "Specifies if passwords from the `disallowValues` list are to be allowed."
            },
            "disallowValues": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Sets password values that are not allowed."
            }
          },
          "description": "Criteria of a strong password."
        }
      },
      "description": "Security Options on Webex Administration."
    }
  }
}