List Recordings
Lists recordings. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.
Only recordings of meetings hosted by or shared with the authenticated user will be listed.
The list returned is sorted in descending order by the date and time that the recordings were created.
Long result sets are split into pages.
If
meetingIdis specified, only recordings associated with the specified meeting will be listed. NOTE: whenmeetingIdis specified, parameter ofsiteUrlwill be ignored.If
siteUrlis specified, recordings of the specified site will be listed; otherwise, the API lists recordings of all the user's sites. All available Webex sites and preferred site of the user can be retrieved by Get Site List API.
Request Header
timezone: Time zone in conformance with the IANA time zone database. The default is UTC iftimezoneis not defined.
Query Parameters
Maximum number of recordings to return in a single page. max must be equal to or greater than 1 and equal to or less than 100.
Starting date and time (inclusive) for recordings to return, in any ISO 8601 compliant format. from cannot be after to.
Ending date and time (exclusive) for List recordings to return, in any ISO 8601 compliant format. to cannot be before from.
Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When meetingId is specified, the siteUrl parameter is ignored.
Email address for the meeting host. This parameter is only used if the user or application calling the API has the required admin-level meeting scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.
URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the Get Site List API.
External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc.
Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.
Recording's file format. If specified, the API filters recordings by format.
The service type for recordings. If this item is specified, the API filters recordings by service-type.
Recording's status. If not specified or available, retrieves recordings that are available. Otherwise, if specified as deleted, retrieves recordings that have been moved into the recycle bin. The purged status only applies if the user calling the API is a Compliance Officer and meetingId is specified.
Response Properties
An array of recording objects.
A unique identifier for the recording.
Unique identifier for the recording's ended meeting instance.
Unique identifier for the recording's scheduled meeting instance.
Unique identifier for the recording's meeting series.
The recording's topic.
The date and time recording was created in 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.
The date and time recording started in ISO 8601 compliant format. It indicates when the record button was clicked in the meeting.
Site URL for the recording.
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.
The playback link for recording.
The recording's password.
Recording file format is MP4.
Recording file format is ARF, a proprietary Webex recording format.
The recording file is uploaded manually.
The service type for the recording.
The service type for the recording is meeting.
The service type for the recording is the event.
The service type for the recording is the training session.
The service type for the recording is the support meeting.
The duration of the recording, in seconds.
The size of the recording file, in bytes.
Whether or not the recording has been shared to the current user. This attribute is hidden if the user calling the API is a Compliance Officer and hostEmail is not specified.
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.
Recording is available.
Recording has been moved into recycle bin.
Recording has been purged from the recycle bin. Only applies if the user calling the API is a Compliance Officer and meetingId is specified.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.
- Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.
- Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.
- Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.
- Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.
- URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.
- External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc.
- Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.
- Recording's file format. If specified, the API filters recordings by format.
- The service type for recordings. If this item is specified, the API filters recordings by service-type.
- Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.
{
"items": [
{
"id": "4f914b1dfe3c4d11a61730f18c0f5387",
"meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
"meetingSeriesId": "f91b6edce9864428af084977b7c68291",
"topic": "Example Topic",
"createTime": "2020-07-13T17:11:35Z",
"timeRecorded": "2020-07-13T17:05:35Z",
"siteUrl": "site4-example.webex.com",
"downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=b91990e37417bda24986e46cf43345ab",
"playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=69201a61d1d94a84aca18817261d1a73",
"password": "BgJep@43",
"format": "ARF",
"serviceType": "MeetingCenter",
"durationSeconds": 18416,
"sizeBytes": 168103,
"shareToMe": false,
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"status": "available"
},
{
"id": "3324fb76946249cfa07fc30b3ccbf580",
"meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
"meetingSeriesId": "f91b6edce9864428af084977b7c68291",
"topic": "Example Topic",
"createTime": "2020-07-13T17:11:34Z",
"timeRecorded": "2020-07-13T17:05:35Z",
"siteUrl": "site4-example.webex.com",
"downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=8a763939dec1fa26c565700d628fcb98",
"playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=b05e9c4f773745e7b88725cc97bc3161",
"password": "BgJep@43",
"format": "ARF",
"serviceType": "MeetingCenter",
"durationSeconds": 181562,
"sizeBytes": 199134,
"shareToMe": false,
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"status": "available"
},
{
"id": "42b80117a2a74dcf9863bf06264f8075",
"meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
"meetingSeriesId": "f91b6edce9864428af084977b7c68291",
"topic": "Example Topic",
"createTime": "2020-07-13T17:11:33Z",
"timeRecorded": "2020-07-13T17:05:35Z",
"siteUrl": "site4-example.webex.com",
"downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=0edd48adbb183e7da97884a0a984e877",
"playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=b64b28ebf70e4645954420c295a9fcad",
"password": "BgJep@4",
"format": "ARF",
"serviceType": "MeetingCenter",
"durationSeconds": 181562,
"sizeBytes": 199134,
"shareToMe": true,
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"status": "available"
}
]
}