Webex · Schema

GetLocationCallCaptionsObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
locationClosedCaptionsEnabled boolean Location-level closed captions are enabled or disabled.
locationTranscriptsEnabled boolean Location-level transcripts are enabled or disabled.
orgClosedCaptionsEnabled boolean Organization closed captions are enabled or disabled.
orgTranscriptsEnabled boolean Organization transcripts are enabled or disabled.
useOrgSettingsEnabled boolean If `useOrgSettingsEnabled` is `true`, organization-level settings will control the location's closed captions and transcripts. Otherwise, location-level settings are used.
View JSON Schema on GitHub

JSON Schema

webex-getlocationcallcaptionsobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetLocationCallCaptionsObject",
  "title": "GetLocationCallCaptionsObject",
  "type": "object",
  "required": [
    "locationClosedCaptionsEnabled",
    "locationTranscriptsEnabled",
    "orgClosedCaptionsEnabled",
    "orgTranscriptsEnabled",
    "useOrgSettingsEnabled"
  ],
  "properties": {
    "locationClosedCaptionsEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Location-level closed captions are enabled or disabled."
    },
    "locationTranscriptsEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Location-level transcripts are enabled or disabled."
    },
    "orgClosedCaptionsEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Organization closed captions are enabled or disabled."
    },
    "orgTranscriptsEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Organization transcripts are enabled or disabled."
    },
    "useOrgSettingsEnabled": {
      "type": "boolean",
      "example": true,
      "description": "If `useOrgSettingsEnabled` is `true`, organization-level settings will control the location's closed captions and transcripts. Otherwise, location-level settings are used."
    }
  }
}