Get Recording Details
Retrieves details for a recording with a specified recording ID.
Only recordings of meetings hosted by or shared with the authenticated user may be retrieved.
Request Header
timezone: Time zone in conformance with the IANA time zone database. The default is UTC iftimezoneis not defined.
URI Parameters
A unique identifier for the recording.
Query Parameters
Its value true or false means that the query scope will or not includes the recordings that were moved to the recycle bin. Same as false if not specified.
Email address for the meeting host. Only used if the user or application calling the API has admin-level scopes. If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.
Response Properties
A unique identifier for recording.
Unique identifier for the parent ended meeting instance which the recording belongs to.
Unique identifier for the parent scheduled meeting which the recording belongs to.
Unique identifier for the parent meeting series which the recording belongs to.
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 on page when editing a recording.
The playback link for recording.
The recording's password.
Recording file format is MP4.
Recording file format is ARF, a private format of Webex recordings. This format requires the Cisco ARF recording player.
Recording service-type is MeetingCenter.
Recording service-type is EventCenter.
Recording service-type is SupportCenter.
Recording service-type is TrainingCenter.
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.
The download links for MP4, audio, and transcript of the recording without HTML page rendering in browser or HTTP redirect. 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 on page when editing a recording. Note that there are various products in Webex Suite such as Cisco Webex Meetings, Cisco Webex Training and Cisco Webex Events. Currently, this attribute is only available for Cisco Webex Meetings.
The download link for recording MP4 file without HTML page rendering in browser or HTTP redirect. Expires 3 hours after the API request.
The download link for recording audio file without HTML page rendering in browser or HTTP redirect. Expires 3 hours after the API request.
The download link for recording transcript file without HTML page rendering in browser or HTTP redirect. Expires 3 hours after the API request.
The date and time when recordingDownloadLink, audioDownloadLink, and transcriptDownloadLink expire in ISO 8601 compliant format.
External keys of the parent meeting created by an integration application. The key can 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 to the recycle bin.
Recording has been purged from the recycle bin. Please note that only a compliance officer can access recordings with a purged status.
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
- Its value `true` or `false` means that the query scope will or not includes the recordings that were moved to the recycle bin. Same as false if not specified.
- Email address for the meeting host. Only used if the user or application calling the API has admin-level scopes. If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.
{
"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",
"temporaryDirectDownloadLinks": {
"recordingDownloadLink": "https://site4-example.webex.com/nbr/MultiThreadDownloadServlet?siteid=2062842&recordid=305462&confid=137735449369118342&language=en_US&userid=3516472&serviceRecordID=305492&ticket=SDJTSwAAAIUBSHkvL6Z5ddyBim5%2FHcJYcvn6IoXNEyCE2mAYQ5BlBg%3D%3D×tamp=1567125236465&islogin=yes&isprevent=no&ispwd=yes",
"audioDownloadLink": "https://site4-example.webex.com/nbr/downloadMedia.do?siteid=2062842&recordid=305462&confid=137735449369118342&language=en_US&userid=3516472&serviceRecordID=305492&ticket=SDJTSwAAAIXCIXsuBt%2BAgtK7WoQ2VhgeI608N4ZMIJ3vxQaQNZuLZA%3D%3D×tamp=1567125236708&islogin=yes&isprevent=no&ispwd=yes&mediaType=1",
"transcriptDownloadLink": "https://site4-example.webex.com/nbr/downloadMedia.do?siteid=2062842&recordid=305462&confid=137735449369118342&language=en_US&userid=3516472&serviceRecordID=305492&ticket=SDJTSwAAAAJVUJDxeA08qKkF%2FlxlSkDxuEFPwgGT0XW1z21NhY%2BCvg%3D%3D×tamp=1567125236866&islogin=yes&isprevent=no&ispwd=yes&mediaType=2",
"expiration": "2022-05-01T10:30:25Z"
},
"format": "ARF",
"serviceType": "MeetingCenter",
"durationSeconds": 18416,
"sizeBytes": 168103,
"shareToMe": false,
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"status": "available"
}