AudioObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AudioObject",
  "title": "AudioObject",
  "type": "object",
  "required": [
    "defaultAudioType",
    "otherTeleconferenceDescription",
    "enabledGlobalCallIn",
    "enabledTollFree",
    "enabledAutoConnection",
    "officeNumber",
    "mobileNumber"
  ],
  "properties": {
    "defaultAudioType": {
      "type": "string",
      "enum": [
        "webexAudio",
        "voipOnly",
        "otherTeleconferenceService",
        "none"
      ],
      "description": "Default audio type. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API.\n * `webexAudio` - Webex audio. This supports telephony and VoIP.\n * `voipOnly` - Support only VoIP.\n * `otherTeleconferenceService` - Other teleconference service. Details are defined in the `otherTeleconferenceDescription` parameter.\n * `none` - No audio.\n"
    },
    "otherTeleconferenceDescription": {
      "type": "string",
      "description": "Phone number and other information for the teleconference provider to be used, along with instructions for invitees. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API."
    },
    "enabledGlobalCallIn": {
      "type": "boolean",
      "description": "Flag to enable/disable global call ins. ***Note***: If the site does not support global call-ins, you cannot set this option. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API."
    },
    "enabledTollFree": {
      "type": "boolean",
      "description": "Flag to enable/disable call-ins from toll-free numbers.  ***Note***: If the site does not support calls from toll-free numbers, you cannot set this option. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API."
    },
    "enabledAutoConnection": {
      "type": "boolean",
      "description": "Flag to enable/disable automatically connecting to audio using a computer. The meeting host can enable/disable this option. When this option is set to `true`, the user is automatically connected to audio via a computer when they start or join a Webex Meetings meeting on a desktop. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API."
    },
    "audioPin": {
      "type": "string",
      "description": "PIN to provide a secondary level of authentication for calls where the host is using the phone and may need to invite additional invitees. It must be exactly 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeat a digit 4 times, such as 1111. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API."
    },
    "officeNumber": {
      "type": "object",
      "required": [
        "countryCode",
        "number",
        "enabledCallInAuthentication",
        "enabledCallMe"
      ],
      "properties": {
        "countryCode": {
          "type": "string",
          "description": "Country code for the phone number. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API."
        },
        "number": {
          "type": "string",
          "description": "Phone number. It cannot be longer than 30 characters. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API."
        },
        "enabledCallInAuthentication": {
          "type": "boolean",
          "description": "Flag identifying the phone number as the one that will be used to dial into a teleconference. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API."
        },
        "enabledCallMe": {
          "type": "boolean",
          "description": "Flag to enable/disable Call Me number display on the meeting client. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. ***Note***: This feature is only effective if the site supports the ***Call Me*** feature."
        }
      },
      "description": "Office phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API."
    },
    "mobileNumber": {
      "type": "object",
      "required": [
        "countryCode",
        "number",
        "enabledCallInAuthentication",
        "enabledCallMe"
      ],
      "properties": {
        "countryCode": {
          "type": "string",
          "description": "Country code for the phone number. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API."
        },
        "number": {
          "type": "string",
          "description": "Phone number. It cannot be longer than 30 characters. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API."
        },
        "enabledCallInAuthentication": {
          "type": "boolean",
          "description": "Flag identifying the phone number as the one that will be used to dial into a teleconference. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API."
        },
        "enabledCallMe": {
          "type": "boolean",
          "description": "Flag to enable/disable Call Me number display on the meeting client. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. ***Note***: This feature is only effective if the site supports the ***Call Me*** feature."
        }
      },
      "description": "Mobile phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API."
    }
  }
}