Get meeting recordings

GET

/meetings/{meetingId}/recordings

Cloud Recording

Get all the recordings from a meeting or Webinar instance.

The recording files can be downloaded via the download_url property listed in the response.

To access a password protected cloud recording, add an "access_token" parameter to the download URL and provide OAuth access token or JWT as the value of the "access_token".

Scopes: recording:read:admin recording:read

Rate Limit Label: Light

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/meetings//recordings'

响应示例

200 - response

{
  "account_id": "EABkdslfBBBdk",
  "duration": 1,
  "host_id": "z8yBXksaAAjdhfsfdfkjgg",
  "id": 68000000031879,
  "recording_count": 3,
  "recording_files": [
    {
      "download_url": "https://api.zoom.us/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB",
      "file_size": 37285,
      "file_type": "MP4",
      "id": "96119skjlfhdshkjf-djkfndjf0-f791",
      "meeting_id": "gkABCDEbbbbbbbkPuA==",
      "play_url": "https://api.zoom.us/recording/play/Qg75t7xZBtEbAkjdlgbfdngBBBB",
      "recording_end": "2019-08-29T21:55:24Z",
      "recording_start": "2019-08-29T21:54:55Z",
      "recording_type": "shared_screen_with_speaker_view",
      "status": "completed"
    },
    {
      "download_url": "https://api.zoom.us/recording/download/ABdkEEEfhlgldfjkglfghlkfdklhsg",
      "file_size": 10098,
      "file_type": "M4A",
      "id": "5890sfjkdsf-aaaakdf-fbbb618718e",
      "meeting_id": "gkABCDEbbbbbbbkPuA==",
      "play_url": "https://api.zoom.us/recording/play/ABdkEEEfhlgldfjkglfghlkfdklhsg",
      "recording_end": "2019-08-29T21:55:24Z",
      "recording_start": "2019-08-29T21:54:55Z",
      "recording_type": "audio_only",
      "status": "completed"
    },
    {
      "download_url": "https://api.zoom.us/recording/download/e2ed-dlkjgdfkgh-kslsdbsjf1a",
      "file_type": "TIMELINE",
      "meeting_id": "gkABCDEbbbbbbbkPuA==",
      "recording_end": "2019-08-29T21:55:24Z",
      "recording_start": "2019-08-29T21:54:55Z"
    }
  ],
  "share_url": "https://api.zoom.us/recording/share/abcdkhfdbbfdjbg",
  "start_time": "2019-08-29T21:54:49Z",
  "timezone": "America/Los_Angeles",
  "topic": "MyTestPollMeeting",
  "total_size": 47383,
  "type": 2,
  "uuid": "gkABCDEbbbbbbbkPuA=="
}

请求参数

Path 参数

meetingId

string

必需

To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.

To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.

If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

Query 参数

include_fields

string

可选

Get the download_access_token field for downloading meeting recordings.

ttl

integer

可选

Time to live (TTL) of the download_access_token. This is only valid if the include_fields query parameter contains download_access_token. The range is between 0-604800.

>= 0<= 604800

返回响应

🟢200**Error Code:** `200` You do not have the right permissions. **HTTP Status Code:** `200` Recording object returned.

application/json

Body

The recording meeting object.

account_id

string

可选

Unique Identifier of the user account.

duration

integer

可选

Meeting duration.

host_id

string

可选

ID of the user set as host of meeting.

string

可选

Meeting ID - also known as the meeting number.

recording_count

string

可选

Number of recording files returned in the response of this API call.

start_time

string <date-time>

可选

The time at which the meeting started.

topic

string

可选

Meeting topic.

total_size

string

可选

Total size of the recording.

type

string

可选

Type of the meeting that was recorded.

Meeting Types:
1 - Instant meeting.
2 - Scheduled meeting.
3 - Recurring meeting with no fixed time.
8 - Recurring meeting with fixed time.

uuid

string

可选

Unique Meeting Identifier. Each instance of the meeting will have its own UUID.

recording_files

array [object {11}]

Recording file List

可选

List of recording file.

deleted_time

string

可选

The time at which recording was deleted. Returned in the response only for trash query.

download_url

string

可选

The URL using which the recording file can be downloaded. To access a private or password protected cloud recording of a user in your account, you can use a Zoom JWT App Type. 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 as shown in the example.

Example: https://api.zoom.us/recording/download/{{ Download Path }}?access_token={{ JWT Token }}

Similarly, if the user has installed your OAuth app that contains recording scope(s), you can also use the user's OAuth access token to download the Cloud Recording.

Example: https://api.zoom.us/recording/download/{{ Download Path }}?access_token={{ OAuth Access Token }}

file_size

number

可选

The recording file size.

file_type

string

可选

The recording file type. The value of this field could be one of the following:
MP4: Video file of the recording.
M4A Audio-only file of the recording.
TIMELINE: Timestamp file of the recording in JSON file format. To get a timeline file, the "Add a timestamp to the recording" setting must be enabled in the recording settings. The time will display in the host's timezone, set on their Zoom profile.

TRANSCRIPT: Transcription file of the recording in VTT format.
CHAT: A TXT file containing in-meeting chat messages that were sent during the meeting.
CC: File containing closed captions of the recording in VTT file format.
CSV: File containing polling data in csv format.

A recording file object with file type of either CC or TIMELINE does not have the following properties:
id, status, file_size, recording_type, and play_url.

string

可选

The recording file ID. Included in the response of general query.

meeting_id

string

可选

The meeting ID.

play_url

string

可选

The URL using which a recording file can be played.

recording_end

string

可选

The recording end time. Response in general query.

recording_start

string

可选

The recording start time.

recording_type

string

可选

The recording type. The value of this field can be one of the following:
shared_screen_with_speaker_view(CC)
shared_screen_with_speaker_view
shared_screen_with_gallery_view
speaker_view
gallery_view
shared_screen
audio_only
audio_transcript
chat_file
active_speaker
poll

status

enum<string>

可选

The recording status.

枚举值:

completed

download_access_token

string

可选

JWT token for downloading the meeting recording.
This is only returned if the include_fields query parameter contains download_access_token.

🟠400**HTTP Status Code:** `400` **Error Code:** `1010` User not found on this account: {accountId}.

🟠404**HTTP Status Code:** `404` Meeting recording not found. **Error Code:** `1001` User {userId} does not exist or does not belong to this account. **Error Code:** `3301` There is no recording for this meeting.

修改于 2024-04-24 09:06:48

Delete meeting recordings

List recording registrants