Webex · Schema

BulkPurgeRecordingObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
purgeAll boolean If not specified or `false`, purges the recordings specified by `recordingIds`. If `true`, purges all recordings from the recycle bin.
recordingIds array Recording IDs for purging recordings from the recycle bin in batch. Note that all the recording IDs should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.
siteUrl string URL of the Webex site from which the API purges recordings. If not specified, the API purges recordings from user's preferred site. All available Webex sites and preferred sites of the user can be ret
View JSON Schema on GitHub

JSON Schema

webex-bulkpurgerecordingobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BulkPurgeRecordingObject",
  "title": "BulkPurgeRecordingObject",
  "type": "object",
  "properties": {
    "purgeAll": {
      "type": "boolean",
      "description": "If not specified or `false`, purges the recordings specified by `recordingIds`. If `true`, purges all recordings from the recycle bin."
    },
    "recordingIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Recording IDs for purging recordings from the recycle bin in batch. Note that all the recording IDs should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified."
    },
    "siteUrl": {
      "type": "string",
      "example": "example.webex.com",
      "description": "URL of the Webex site from which the API purges recordings. If not specified, the API purges recordings from user's preferred site. All available Webex sites and preferred sites of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
    }
  }
}