Webex · Schema

RecordingQuery

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
orgId string Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.
urlExpiration integer Expiration time of returned s3 url (in minutes).
taskIds array Comma separated list of taskIds to gather captures for. Maximum number of taskIds allowed are 10
includeSegments boolean Flag; (true) for individual capture segments of main recording, (false) for a stitched capture.
includeVARecordings boolean Flag; (true) for including virtual agent (VA) recordings, (false) for excluding virtual agent recordings. The default value is false.
View JSON Schema on GitHub

JSON Schema

webex-recordingquery-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RecordingQuery",
  "title": "RecordingQuery",
  "required": [
    "taskIds"
  ],
  "type": "object",
  "properties": {
    "orgId": {
      "type": "string",
      "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.",
      "example": "8e18afdf-db79-449b-b4f5-ee4f14d9f45e"
    },
    "urlExpiration": {
      "maximum": 60,
      "type": "integer",
      "description": "Expiration time of returned s3 url (in minutes).",
      "format": "int32",
      "example": 30
    },
    "taskIds": {
      "maxItems": 10,
      "uniqueItems": true,
      "type": "array",
      "description": "Comma separated list of taskIds to gather captures for. Maximum number of taskIds allowed are 10",
      "example": [
        "8e18afdf-db79-449b-b4f5-ee4f14d9f45e"
      ],
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "includeSegments": {
      "type": "boolean",
      "description": "Flag; (true) for individual capture segments of main recording, (false) for a stitched capture.",
      "example": true
    },
    "includeVARecordings": {
      "type": "boolean",
      "description": "Flag; (true) for including virtual agent (VA) recordings, (false) for excluding virtual agent recordings. The default value is false.",
      "example": false
    }
  }
}