Webex · Schema

GetUserCallCaptionsObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

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

JSON Schema

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