RecordingBodyParams

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/webex/json-schema/webex-recording-body-params-schema.json",
  "title": "RecordingBodyParams",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/webex-captures-api-openapi.yml#/components/schemas/RecordingBodyParams",
  "required": [
    "query"
  ],
  "type": "object",
  "properties": {
    "query": {
      "$ref": "#/$defs/RecordingQuery"
    }
  },
  "$defs": {
    "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."
        },
        "urlExpiration": {
          "maximum": 60,
          "type": "integer",
          "description": "Expiration time of returned s3 url (in minutes).",
          "format": "int32"
        },
        "taskIds": {
          "maxItems": 10,
          "uniqueItems": true,
          "type": "array",
          "description": "Comma separated list of taskIds to gather captures for. Maximum number of taskIds allowed are 10",
          "items": {
            "type": "string",
            "format": "uuid"
          }
        },
        "includeSegments": {
          "type": "boolean",
          "description": "Flag; (true) for individual capture segments of main recording, (false) for a stitched capture."
        },
        "includeVARecordings": {
          "type": "boolean",
          "description": "Flag; (true) for including virtual agent (VA) recordings, (false) for excluding virtual agent recordings. The default value is false."
        },
        "includeScreenRecordings": {
          "type": "boolean",
          "description": "Flag; (true) will return screen recording if available else will return empty array, (false) will exclude screen recordings. The default value is false."
        },
        "includeAllDigitalVersions": {
          "type": "boolean",
          "description": "Flag; (true) returns all available digital transcript artifacts for each requested task, including both legacy and schema-versioned digital transcript artifacts when both exist. (false) or omitted returns the default Captures behavior. This field applies only to digital transcript artifacts and does not change recording or voice transcript retrieval."
        }
      }
    }
  }
}