Webex · Schema

RecordingObjectForAdminAndCO

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string A unique identifier for the recording.
meetingId string Unique identifier for the recording's ended meeting instance.
scheduledMeetingId string Unique identifier for the recording's scheduled meeting instance.
meetingSeriesId string Unique identifier for the recording's meeting series.
topic string The recording's topic.
createTime string The date and time recording was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. Please note that it's not the time the record button was clicked in meeting but the time
timeRecorded string The date and time recording started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. It indicates when the record button was clicked in the meeting.
hostDisplayName string Display name for the meeting host.
hostEmail string Email address for the meeting host.
siteUrl string Site URL for the recording.
downloadUrl string The download link for recording. This attribute is not available if **Prevent downloading** has been turned on for the recording being requested. The **Prevent downloading** option can be viewed and s
playbackUrl string The playback link for recording.
format string * `MP4` - Recording file format is MP4. * `ARF` - Recording file format is ARF, a proprietary Webex recording format. * `UPLOADED` - The recording file is uploaded manually.
serviceType string The service type for the recording. * `MeetingCenter` - The service type for the recording is meeting. * `EventCenter` - The service type for the recording is the event. * `TrainingCenter` - The servi
durationSeconds number The duration of the recording, in seconds.
sizeBytes number The size of the recording file, in bytes.
integrationTags array External keys of the parent meeting created by an integration application. They could be Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. The integration application queries recordings b
status string * `available` - Recording is available. * `deleted` - Recording has been moved into recycle bin. * `purged` - Recording has been purged from the recycle bin. Please note that only a compliance officer
View JSON Schema on GitHub

JSON Schema

webex-recordingobjectforadminandco-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RecordingObjectForAdminAndCO",
  "title": "RecordingObjectForAdminAndCO",
  "type": "object",
  "required": [
    "id",
    "meetingId",
    "topic",
    "createTime",
    "timeRecorded",
    "hostDisplayName",
    "hostEmail",
    "siteUrl",
    "downloadUrl",
    "playbackUrl",
    "format",
    "serviceType",
    "durationSeconds",
    "sizeBytes",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "4f914b1dfe3c4d11a61730f18c0f5387",
      "description": "A unique identifier for the recording."
    },
    "meetingId": {
      "type": "string",
      "example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
      "description": "Unique identifier for the recording's ended meeting instance."
    },
    "scheduledMeetingId": {
      "type": "string",
      "example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
      "description": "Unique identifier for the recording's scheduled meeting instance."
    },
    "meetingSeriesId": {
      "type": "string",
      "example": "f91b6edce9864428af084977b7c68291",
      "description": "Unique identifier for the recording's meeting series."
    },
    "topic": {
      "type": "string",
      "example": "John's Meeting",
      "description": "The recording's topic."
    },
    "createTime": {
      "type": "string",
      "example": "2019-01-27T17:43:24Z",
      "description": "The date and time recording was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. Please note that it's not the time the record button was clicked in meeting but the time the recording file was generated offline."
    },
    "timeRecorded": {
      "type": "string",
      "example": "2019-01-27T17:40:20Z",
      "description": "The date and time recording started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. It indicates when the record button was clicked in the meeting."
    },
    "hostDisplayName": {
      "type": "string",
      "example": "John Andersen",
      "description": "Display name for the meeting host."
    },
    "hostEmail": {
      "type": "string",
      "example": "[email protected]",
      "description": "Email address for the meeting host."
    },
    "siteUrl": {
      "type": "string",
      "example": "site4-example.webex.com",
      "description": "Site URL for the recording."
    },
    "downloadUrl": {
      "type": "string",
      "example": "https://site4-example.webex.com/site4/lsr.php?RCID=60b864cc80aa5b44fc9769c8305b98b7",
      "description": "The download link for recording. This attribute is not available if **Prevent downloading** has been turned on for the recording being requested. The **Prevent downloading** option can be viewed and set by a site admin on [Control Hub](https://help.webex.com/en-us/article/sxdj4ab/Manage-Security-for-a-Cisco-Webex-Site-in-Cisco-Webex-Control-Hub)."
    },
    "playbackUrl": {
      "type": "string",
      "example": "https://site4-example.webex.com/site4/ldr.php?RCID=7a8a476b29a32cd1e06dfa6c81970f19",
      "description": "The playback link for recording."
    },
    "format": {
      "type": "string",
      "enum": [
        "MP4",
        "ARF",
        "UPLOADED"
      ],
      "description": " * `MP4` - Recording file format is MP4.\n * `ARF` - Recording file format is ARF, a proprietary Webex recording format.\n * `UPLOADED` - The recording file is uploaded manually.\n"
    },
    "serviceType": {
      "type": "string",
      "enum": [
        "MeetingCenter",
        "EventCenter",
        "TrainingCenter",
        "SupportCenter"
      ],
      "description": "The service type for the recording.\n * `MeetingCenter` - The service type for the recording is meeting.\n * `EventCenter` - The service type for the recording is the event.\n * `TrainingCenter` - The service type for the recording is the training session.\n * `SupportCenter` - The service type for the recording is the support meeting.\n"
    },
    "durationSeconds": {
      "type": "number",
      "example": 4472,
      "description": "The duration of the recording, in seconds."
    },
    "sizeBytes": {
      "type": "number",
      "example": 248023188,
      "description": "The size of the recording file, in bytes."
    },
    "integrationTags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "External keys of the parent meeting created by an integration application. They could be Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. The integration application queries recordings by a key in its own domain."
    },
    "status": {
      "type": "string",
      "enum": [
        "available",
        "deleted",
        "purged"
      ],
      "description": " * `available` - Recording is available.\n * `deleted` - Recording has been moved into recycle bin.\n * `purged` - Recording has been purged from the recycle bin. Please note that only a compliance officer can access recordings with a `purged` status.\n"
    }
  }
}