List Recordings for Admin or Compliance officer
List recordings for admin or compliance officer. You can specify a date range, and the maximum number of recordings to return.
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.
List recordings requires the spark-compliance:recordings_read scope for compliance officer and spark-admin:recordings_read scope for admin.
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. The interval between from and to must be within 30 days.
Ending date and time (exclusive) for List recordings to return, in any ISO 8601 compliant format. to cannot be before from. The interval between from and to must be within 30 days.
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.
Recording's service-type. If this item is specified, the API filters recordings by service-type. Valid values are calling.
Recording's file format. If specified, the API filters recordings by format. Valid values are MP3.
Webex user Id to fetch recordings for a particular user.
Webex email address to fetch recordings for a particular user.
Recording based on type of user.
Recording stored in certain Webex locations.
Fetch recordings for users in a particular Webex Calling location (as configured in Control Hub).
Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.
Response Properties
An array of recording objects.
A unique identifier for the recording.
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.
Recording file format is MP3.
Recording service type is Webex Call.
The duration of the recording, in seconds.
The size of the recording file, in bytes.
Recording is available.
Recording has been moved into recycle bin.
Webex UUID for recording owner/host.
Webex email for recording owner/host.
Recording belongs to a user.
Recording belongs to a workspace device.
Recording belongs to a workspace device.
Storage location for recording within Webex datacenters.
Fields relevant to each service Type.
Webex calling location for recording user.
Call ID for which recording was done.
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`. The interval between `from` and `to` must be within 30 days.
- 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`. The interval between `from` and `to` must be within 30 days.
- 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.
- Recording's service-type. If this item is specified, the API filters recordings by service-type. Valid values are `calling`.
- Recording's file format. If specified, the API filters recordings by format. Valid values are `MP3`.
- Webex user Id to fetch recordings for a particular user.
- Webex email address to fetch recordings for a particular user.
- Recording based on type of user.
- Recording stored in certain Webex locations.
- Fetch recordings for users in a particular Webex Calling location (as configured in Control Hub).
- Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.
{
"items": [
{
"id": "baa93e55c62e4663ae24f13fbfdb247f",
"topic": "call with title",
"createTime": "2023-10-31T16:24:12+08:00",
"timeRecorded": "2023-10-31T10:41:28+08:00",
"ownerId": "d7468402-e95f-42a9-92c8-dd65f45d40ba",
"ownerType": "virtualLine",
"ownerEmail": "Rbs_TA_Admin@wbxlab.us",
"format": "MP3",
"durationSeconds": 60,
"sizeBytes": 244333,
"serviceType": "calling",
"storageRegion": "US",
"status": "available",
"serviceData": {
"locationId": "US",
"callSessionId": "7ba2967530164bf0af1966cf2854b000"
}
},
{
"id": "518cdca461c747dc840b29827d0cb62d",
"topic": "call with title",
"createTime": "2023-10-30T22:30:53+08:00",
"timeRecorded": "2023-10-30T22:17:19+08:00",
"ownerId": "d7468402-e95f-42a9-92c8-dd65f45d40ba",
"ownerType": "virtualLine",
"ownerEmail": "Rbs_TA_Admin@wbxlab.us",
"format": "MP3",
"durationSeconds": 60,
"sizeBytes": 244326,
"serviceType": "calling",
"storageRegion": "US",
"status": "available",
"serviceData": {
"locationId": "US",
"callSessionId": "7ba2967530164bf0af1966cf2854b000"
}
}
]
}