List all recordings
GET {{baseUrl}}/users/:userId/recordings?page_size=30&next_page_token=<string>&mc=false&trash=false&from=<date>&to=<date>&trash_type=meeting_recordings&meeting_id=<integer>
Lists all cloud recordings for a user.
For user-level apps, pass the
me
value
instead of the
userId
parameter. To access a user's passcode protected cloud recording, send the user's
OAuth access token
as a bearer token in the authorization header.
Example:
curl -H "Authorization: Bearer <ACCESS_TOKEN>" https://{{base-domain}}/rec/archive/download/xyz
Prerequisites:
-
Must have a Pro or a higher plan.
-
Must enable Cloud Recording on the user's account.
Scopes:
recording:read:admin
,
recording:read
Rate Limit Label
:
MEDIUM
Request Params
| Key | Datatype | Required | Description |
| page_size
| number | | The number of records returned within a single API call. |
| next_page_token
| string | | The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
| mc
| boolean | | The query metadata of the recording if using an on-premise meeting connector for the meeting. |
| trash
| boolean | | The query trash.
true
- List recordings from trash.false
- Do not list recordings from the trash.
The default value is false
. If you set it to true
, you can use the trash_type
property to indicate the type of Cloud recording that you need to retrieve. |
| from
| string | | The start date in 'yyyy-mm-dd' UTC format for the date range where you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be current date.
For example, if you make the API request on June 30, 2020, without providing the from
and to
parameters, by default the value of 'from' field will be 2020-06-30
and the value of the 'to' field will be 2020-07-01
.
Note: The trash
files cannot be filtered by date range and thus, the from
and to
fields should not be used for trash files. |
| to
| string | | The end date in 'yyyy-mm-dd' 'yyyy-mm-dd' UTC format. |
| trash_type
| string | | The type of cloud recording to retrieve from the trash.
meeting_recordings
: List all meeting recordings from the trash.recording_file
: List all individual recording files from the trash. | |meeting_id
| string | | The meeting ID. |
HEADERS
| Key | Datatype | Required | Description |
| Accept
| string | | |
RESPONSES
status: OK
{"from":"\u003cdate\u003e","to":"\u003cdate\u003e","next_page_token":"\u003cstring\u003e","page_count":"\u003cinteger\u003e","page_size":30,"total_records":"\u003cinteger\u003e","meetings":[{"account_id":"\u003cstring\u003e","duration":"\u003cinteger\u003e","host_id":"\u003cstring\u003e","id":"\u003cinteger\u003e","recording_count":"\u003cinteger\u003e","start_time":"\u003cdateTime\u003e","topic":"\u003cstring\u003e","total_size":"\u003clong\u003e","type":"8","uuid":"\u003cstring\u003e","recording_play_passcode":"\u003cstring\u003e","recording_files":[{"deleted_time":"\u003cstring\u003e","download_url":"\u003cstring\u003e","file_path":"\u003cstring\u003e","file_size":"\u003cnumber\u003e","file_type":"MP4","file_extension":"M4A","id":"\u003cstring\u003e","meeting_id":"\u003cstring\u003e","play_url":"\u003cstring\u003e","recording_end":"\u003cstring\u003e","recording_start":"\u003cstring\u003e","recording_type":"thumbnail","status":"completed"},{"deleted_time":"\u003cstring\u003e","download_url":"\u003cstring\u003e","file_path":"\u003cstring\u003e","file_size":"\u003cnumber\u003e","file_type":"CHAT_MESSAGE","file_extension":"MP4","id":"\u003cstring\u003e","meeting_id":"\u003cstring\u003e","play_url":"\u003cstring\u003e","recording_end":"\u003cstring\u003e","recording_start":"\u003cstring\u003e","recording_type":"poll","status":"completed"}]},{"account_id":"\u003cstring\u003e","duration":"\u003cinteger\u003e","host_id":"\u003cstring\u003e","id":"\u003cinteger\u003e","recording_count":"\u003cinteger\u003e","start_time":"\u003cdateTime\u003e","topic":"\u003cstring\u003e","total_size":"\u003clong\u003e","type":"99","uuid":"\u003cstring\u003e","recording_play_passcode":"\u003cstring\u003e","recording_files":[{"deleted_time":"\u003cstring\u003e","download_url":"\u003cstring\u003e","file_path":"\u003cstring\u003e","file_size":"\u003cnumber\u003e","file_type":"TB","file_extension":"VTT","id":"\u003cstring\u003e","meeting_id":"\u003cstring\u003e","play_url":"\u003cstring\u003e","recording_end":"\u003cstring\u003e","recording_start":"\u003cstring\u003e","recording_type":"shared_screen_with_speaker_view(CC)","status":"completed"},{"deleted_time":"\u003cstring\u003e","download_url":"\u003cstring\u003e","file_path":"\u003cstring\u003e","file_size":"\u003cnumber\u003e","file_type":"TRANSCRIPT","file_extension":"VTT","id":"\u003cstring\u003e","meeting_id":"\u003cstring\u003e","play_url":"\u003cstring\u003e","recording_end":"\u003cstring\u003e","recording_start":"\u003cstring\u003e","recording_type":"sign_interpretation","status":"completed"}]}]}