Webex · Schema

GetVideoObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
videoDevices	array	Array of video devices. This attribute can be modified with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetVideoObject",
  "title": "GetVideoObject",
  "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": "[email protected]",
            "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."
    }
  }
}