{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MeetingPreferenceObject",
  "title": "MeetingPreferenceObject",
  "type": "object",
  "required": [
    "personalMeetingRoom",
    "audio",
    "video",
    "schedulingOptions"
  ],
  "properties": {
    "personalMeetingRoom": {
      "type": "object",
      "required": [
        "topic",
        "hostPin",
        "personalMeetingRoomLink",
        "enabledAutoLock",
        "enabledNotifyHost",
        "supportCoHost",
        "sipAddress",
        "dialInIpAddress",
        "telephony"
      ],
      "properties": {
        "topic": {
          "type": "string",
          "example": "John's PMR",
          "description": "Personal Meeting Room topic. The length of `topic` must be between 1 and 128 characters. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API."
        },
        "hostPin": {
          "type": "string",
          "example": "4325",
          "description": "PIN for joining the room as host. The host PIN must be digits of a predefined length, e.g. 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeated digits of the predefined length, such as 1111. The predefined length for host PIN can be viewed in user's `My Personal Room` page. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API."
        },
        "personalMeetingRoomLink": {
          "type": "string",
          "example": "https://site4-example.webex.com/meet/john",
          "description": "Personal Meeting Room link. It cannot be empty. ***Note***: This is a read-only attribute."
        },
        "enabledAutoLock": {
          "type": "boolean",
          "description": "Option to automatically lock the Personal Room a number of minutes after a meeting starts. When a room is locked, invitees cannot enter until the owner admits them. The period after which the meeting is locked is defined by `autoLockMinutes`. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API."
        },
        "autoLockMinutes": {
          "type": "number",
          "description": "Number of minutes after which the Personal Room is locked if `enabledAutoLock` is enabled. Valid options are 0, 5, 10, 15 and 20. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API."
        },
        "enabledNotifyHost": {
          "type": "boolean",
          "description": "Flag to enable notifying the owner of a Personal Room when someone enters the Personal Room lobby while the owner is not in the room. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API."
        },
        "supportCoHost": {
          "type": "boolean",
          "description": "Flag allowing other invitees to host a meeting in the Personal Room without the owner. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API."
        },
        "supportAnyoneAsCoHost": {
          "type": "boolean",
          "description": "Whether or not to allow any attendee with a host account on the target site to become a cohost when joining the Personal Room. The target site is user's preferred site. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API."
        },
        "allowFirstUserToBeCoHost": {
          "type": "boolean",
          "description": "Whether or not to allow the first attendee with a host account on the target site to become a cohost when joining the Personal Room. The target site is user's preferred site. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API."
        },
        "allowAuthenticatedDevices": {
          "type": "boolean",
          "description": "Whether or not to allow authenticated video devices in the user's organization to start or join the meeting without a prompt. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API."
        },
        "coHosts": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "email",
              "displayName"
            ],
            "properties": {
              "email": {
                "type": "string",
                "example": "john.andersen@example.com",
                "description": "Email address for cohost. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API."
              },
              "displayName": {
                "type": "string",
                "example": "John Andersen",
                "description": "Display name for cohost. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API."
              }
            }
          },
          "description": "Array defining cohosts for the room if both `supportAnyoneAsCoHost` and `allowFirstUserToBeCoHost` are `false` This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API."
        },
        "sipAddress": {
          "type": "string",
          "example": "john.andersen@example.com",
          "description": "SIP address for callback from a video system."
        },
        "dialInIpAddress": {
          "type": "string",
          "example": "192.168.100.100",
          "description": "IP address for callback from a video system."
        },
        "telephony": {
          "type": "object",
          "required": [
            "accessCode",
            "callInNumbers"
          ],
          "properties": {
            "accessCode": {
              "type": "string",
              "example": "1234567890",
              "description": "Code for authenticating a user to join teleconference. Users join the teleconference using the call-in number or the global call-in number, followed by the value of the `accessCode`."
            },
            "callInNumbers": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "label",
                  "callInNumber",
                  "tollType"
                ],
                "properties": {
                  "label": {
                    "type": "string",
                    "example": "Call-in toll-free number (US/Canada)",
                    "description": "Label for call-in number."
                  },
                  "callInNumber": {
                    "type": "string",
                    "example": "123456789",
                    "description": "Call-in number to join teleconference from a phone."
                  },
                  "tollType": {
                    "type": "string",
                    "enum": [
                      "toll",
                      "tollFree"
                    ],
                    "description": "Type of toll for the call-in number."
                  }
                }
              },
              "description": "Array of call-in numbers for joining teleconference from a phone."
            },
            "links": {
              "type": "object",
              "required": [
                "rel",
                "href",
                "method"
              ],
              "properties": {
                "rel": {
                  "type": "string",
                  "example": "globalCallinNumbers",
                  "description": "Link relation describing how the target resource is related to the current context (conforming with [RFC5998](https://tools.ietf.org/html/rfc5988))."
                },
                "href": {
                  "type": "string",
                  "example": "/api/v1/meetings/2c87cf8ece4e414a9fe5516e4a0aac76/globalCallinNumbers",
                  "description": "Target resource URI (conforming with [RFC5998](https://tools.ietf.org/html/rfc5988))."
                },
                "method": {
                  "type": "string",
                  "example": "GET",
                  "description": "Target resource method (conforming with [RFC5998](https://tools.ietf.org/html/rfc5988))."
                }
              },
              "description": "[HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) information of global call-in numbers for joining teleconference from a phone."
            }
          },
          "description": "Information for callbacks from meeting to phone or for joining a teleconference using a phone."
        }
      },
      "description": "Personal Meeting Room options."
    },
    "audio": {
      "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."
        }
      },
      "description": "Audio Preferences. ***Note***: These audio settings do not apply to Personal Room meetings"
    },
    "video": {
      "type": "object",
      "required": [
        "videoDevices"
      ],
      "properties": {
        "videoDevices": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "deviceName",
              "deviceAddress",
              "isDefault"
            ],
            "properties": {
              "deviceName": {
                "type": "string",
                "example": "device1",
                "description": "Video system name. It cannot be empty. This attribute can be modified with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API."
              },
              "deviceAddress": {
                "type": "string",
                "example": "device1@example.com",
                "description": "Video address. It cannot be empty and must be in valid email format. This attribute can be modified with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API."
              },
              "isDefault": {
                "type": "boolean",
                "example": true,
                "description": "Flag identifying the device as the default video device. If user's video device list is not empty, one and only one device must be set as default. This attribute can be modified with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API."
              }
            }
          },
          "description": "Array of video devices. This attribute can be modified with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API."
        }
      },
      "description": "Information for video conferencing systems used to connect to Webex meetings. ***Note***: The ***Call My Video System*** feature is available only if it has been purchased for your site and your administrator has enabled it."
    },
    "schedulingOptions": {
      "$ref": "#/components/schemas/SchedulingOptionsObject",
      "description": "Meeting scheduling options."
    },
    "sites": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "siteUrl",
          "default"
        ],
        "properties": {
          "siteUrl": {
            "type": "string",
            "example": "site1-example.webex.com",
            "description": "Access URL for the site. ***Note***: This is a read-only attribute. The value can be assigned as user's default site with the [Update Default Site](/docs/api/v1/meeting-preferences/update-default-site) API."
          },
          "default": {
            "type": "boolean",
            "description": "Flag identifying the site as the default site. Users can list meetings and recordings, and create meetings on the default site."
          }
        }
      },
      "description": "List of user's Webex meeting sites including default site."
    }
  }
}