Skip to content

Latest commit

 

History

History
20 lines (17 loc) · 4.2 KB

Recording.md

File metadata and controls

20 lines (17 loc) · 4.2 KB

# Recording

Properties

Name Type Description Notes
deleted_time string The time at which recording was deleted. Returned in the response only for trash query. [optional]
download_url string The URL at which to download the the recording. JWT apps To access a private or password-protected cloud recording of a user in your account, use a Zoom JWT app. Use the generated JWT token as the value of the `access_token` query parameter and include this query parameter at the end of the URL. For example: `https://{{base-domain}}/rec/download/{{path-to-file-download}}?access_token={{JWT-token}}` OAuth apps If a user has authorized and installed your OAuth app that contains recording scopes, use the user's OAuth access token to download the file. For example: `https://{{base-domain}}/rec/archive/download/xxx?access_token={{OAuth-access-token}}` Note: This field does not return for Zoom On-Premise accounts. Instead, this API will return the `file_path` field. [optional]
file_path string The file path to the On-Premise account recording. Note: This API only returns this field for Zoom On-Premise accounts. It does not return the `download_url` field. [optional]
file_size float The recording file size. [optional]
file_type string The recording file type. The value of this field could be one of the following:<br> `MP4`: Video file of the recording.<br>`M4A` Audio-only file of the recording.<br>`TIMELINE`: Timestamp file of the recording in JSON file format. To get a timeline file, the &quot;Add a timestamp to the recording&quot; setting must be enabled in the recording settings. The time will display in the host's timezone, set on their Zoom profile. <br> `TRANSCRIPT`: Transcription file of the recording in VTT format.<br> `CHAT`: A TXT file containing in-meeting chat messages that were sent during the meeting.<br>`CC`: File containing closed captions of the recording in VTT file format.<br>`CSV`: File containing polling data in csv format. <br> A recording file object with file type of either `CC` or `TIMELINE` does not have the following properties:<br> `id`, `status`, `file_size`, `recording_type`, and `play_url`. [optional]
id string The recording file ID. Included in the response of general query. [optional]
meeting_id string The meeting ID. [optional]
play_url string The URL using which a recording file can be played. [optional]
recording_end string The recording end time. Response in general query. [optional]
recording_start string The recording start time. [optional]
recording_type string The recording type. The value of this field can be one of the following:<br>`shared_screen_with_speaker_view(CC)`<br>`shared_screen_with_speaker_view`<br>`shared_screen_with_gallery_view`<br>`speaker_view`<br>`gallery_view`<br>`shared_screen`<br>`audio_only`<br>`audio_transcript`<br>`chat_file`<br>`active_speaker`<br>`poll`<br>`timeline`<br>`closed_caption`<br>`audio_interpretation` [optional]
status string The recording status. [optional]

[Back to Model list] [Back to API list] [Back to README]