获取会议录音

返回会议的所有 [录音](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording # h_7420acb5-1897-4061-87b4-5b76e99c03b4)。使用响应中列出的 'download_url' 属性下载录制文件。

要访问受密码保护的云记录，请将用户的 OAuth访问令牌作为授权标头中的承载令牌发送。示例:

'Curl-H' 授权: 承载 <ACCESS_TOKEN>'https://{{base-domain}}/rec/archive/download/xyz'

** 范围: ** '录音: master'

** [速率限制标签](https://marketplace.zoom.us/docs/api-reference/Rate-limits # 速率限制):** 'LIGHT'

请求参数

Path 参数

meetingId

string

必需

要获取会议的云录制，请提供会议ID或UUID。如果提供会议ID而不是UUID，则响应将针对最新的会议实例。

要获取网络研讨会的云记录，请提供网络研讨会的ID或UUID。如果提供网络研讨会ID而不是UUID，则响应将针对最新的网络研讨会实例。

如果UUID以 “/” 开头或包含 “//” (例如: '/ajXp112QmuoKj4854875 = = '), **[double encode](/docs/api-reference/using-zoom-apis/# meeting-id-and-uuid) API请求前的UUID **。

accountId

string

帐户的唯一标识符。

必需

Query 参数

include_fields

string

可选

用于下载会议录制的 'download_access_token' 值。

ttl

integer

可选

'download_access_token' 生存时间 (TTL) 值。仅当 “include_fields” 查询参数包含 “download_access_token” 值时，此参数才有效。

返回响应

🟢200** HTTP状态代码: ** '200' 已返回录制对象。 ** 错误代码: ** '200' 您没有正确的权限。

application/json

Body

返回每个参与者的录制文件列表。仅当启用 ** 录制每个参与者的单独音频文件 ** 设置时，API才会返回此响应。

recording_play_passcode

string

可选

要在URL中使用的云录制的密码。直接在 'play_url' 或 'share_url' 中拼接此录音的密码与 '？pwd =' 以访问和播放。示例: 'https:// zoom.us/rec/share/*************？pwd = yNYIS408EJygs7rE5vVsJwXIz4-VW7MH'。

示例值:

yNYIS408EJygs7rE5vVsJwXIz4-VW7MH

recording_files

array [object {13}]

录制文件的列表。

可选

file_path

string

可选

本地帐户记录的文件路径。

** 注意: ** 此API仅返回缩放本地帐户的此字段。它 ** 不 ** 返回 'download_url' 字段。

示例值:

/9090876528/path01/demo.mp4

play_url

string

可选

可以播放录制文件的URL。

示例值:

https://example.com/rec/play/Qg75t7xZBtEbAkjdlgbfdngBBBB

meeting_id

string

会议ID。

可选

示例值:

L0AGOEPVR9m5WSOOs/d+FQ==

file_size

number

录制文件大小。

可选

示例值:

7220

recording_end

string

可选

录制结束时间。一般查询中的响应。

示例值:

2021-03-18T05:41:36Z

file_type

enum<string>

可选

录制文件类型。

'Mp4'-录制的视频文件。
'M4A'-录音的纯音频文件。
'TIMELINE'-JSON文件格式的录音的时间戳文件。要获取时间线文件，必须在 [录制设置](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-recording # h_3f14c3a4-d16b-4a3c-bbe5-ef7d24500048) 中启用 ** 为录制添加时间戳 ** 设置。时间将显示在主机的时区中，在其缩放配置文件上设置。

'转录'-VTT格式的记录的转录文件。
“聊天”-包含会议期间发送的会议内聊天消息的TXT文件。
'CC'-包含VTT文件格式的录音的隐藏式字幕的文件。
“csv”-包含csv格式的轮询数据的文件。

文件类型为 “cc” 或 “timeline” ** 的录制文件对象不具有 ** 这些属性。

“Id” 、 “status” 、 “file_size” 、 “recording_type” 和 “play_url”。
'SUMMARY'-JSON文件格式的录音摘要文件。

枚举值:

MP4M4ACHATTRANSCRIPTCSVTBCCCHAT_MESSAGESUMMARY

示例值:

MP4

recording_type

enum<string>

可选

录制类型。
'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'
'时间线'
'closed_caption'
'audio_interpretation'
'摘要'
'summary_next_steps'
'summary_smart_chapters'
'sign_interpretation'
'production_studio'

枚举值:

shared_screen_with_speaker_view(CC)shared_screen_with_speaker_viewshared_screen_with_gallery_viewactive_speakergallery_viewshared_screenaudio_onlyaudio_transcriptchat_filepollhost_videoclosed_captiontimelinethumbnailaudio_interpretationsummarysummary_next_stepssummary_smart_chapterssign_interpretationproduction_studio

示例值:

shared_screen_with_speaker_view

download_url

string

可选

用于下载录音的URL。

如果用户已授权并安装了包含录制范围的OAuth应用，请使用用户的 OAuth访问令牌下载文件，并在授权头中设置 'access_token' 作为Bearer令牌。

'Curl-H' 授权: 承载 <ACCESS_TOKEN>'https://{{base-domain}}/rec/archive/download/xyz'。

** 注意: ** 此字段 ** 不 ** 返回 Zoom on-premise帐户。相反，此API返回 “file_path” 字段。

示例值:

https://example.com/rec/download/Qg75t7xZBtEbAkjdlgbfdngBBBB

file_extension

enum<string>

可选

录制文件的文件扩展名类型。

枚举值:

MP4M4ATXTVTTCSVJSONJPG

示例值:

M4A

string

可选

录制文件ID。包括在一般查询的响应中。

示例值:

72576a1f-4e66-4a77-87c4-f13f9808bd76

deleted_time

string

可选

删除录制的时间。仅针对垃圾查询在响应中返回。

示例值:

2021-03-18T05:41:36Z

recording_start

string

录制开始时间。

可选

示例值:

2021-03-18T05:41:36Z

status

enum<string>

录制状态。

可选

枚举值:

completed

示例值:

completed

participant_audio_files

array [object {10}]

可选

录制文件的列表。仅当启用 ** 录制每个参与者的单独音频文件 ** 设置时，API才会返回此响应。

file_path

string

可选

本地帐户记录的文件路径。

** 注意: ** 此API仅返回缩放本地帐户的此字段。它 ** 不 ** 返回 'download_url' 字段。

示例值:

/9090876528/path01/demo.mp4

play_url

string

可选

可以打开和播放录制文件的URL。

示例值:

https://example.com/rec/play/Qg75t7xZBtEbAkjdlgbfdngBBBB

file_name

string

录制文件的名称。

可选

示例值:

test.json

file_type

string

可选

录制文件的格式。

'Mp4'-视频文件。

'M4A'-仅音频文件。

'TIMELINE'-录制的时间戳文件，JSON文件格式。要获取时间线文件，在 [录音设置](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-recording # h_3f14c3a4-d16b-4a3c-bbe5-ef7d24500048) 中，必须启用 ** 为录音添加时间戳 **。时间将显示在主机的时区中。

“转录”-VTT格式的录音抄本。

“聊天”-包含会议期间发送的聊天消息的文本文件。

'CC'-包含录制的隐藏式字幕的文件，采用VTT文件格式。

'CSV'-包含轮询数据的文件，CSV格式。

具有文件 “cc” 或 “timeline” 值 ** 的录制文件对象不具有 “id” 、 “status” 、 “file_size” 、 “recording_type” 和 “play_url” 属性。

示例值:

M4A

download_url

string

可选

用于下载录音的URL。如果用户已授权并安装了包含录制范围的OAuth应用，请使用用户的 OAuth访问令牌下载文件，并在授权头中设置 'access_token' 作为Bearer令牌。

'Curl-H' 授权: 承载 <ACCESS_TOKEN>'https://{{base-domain}}/rec/archive/download/xyz'

** 注意: ** 此字段 ** 不 ** 返回 Zoom On-Premise帐户。相反，此API将返回 “file_path” 字段。

示例值:

https://example.com/rec/download/Qg75t7xZBtEbAkjdlgbfdngBBBB

string

可选

录制文件的唯一ID。这包括在常规查询响应中。

示例值:

a2f19f96-9294-4f51-8134-6f0eea108eb2

file_size

number

可选

录制文件的大小 (以字节为单位)。

示例值:

65536

recording_end

string <date-time>

可选

录制文件的结束时间。这包括在常规查询响应中。

示例值:

2021-06-30T22:14:57Z

recording_start

string <date-time>

可选

录制文件的开始时间。

示例值:

2021-06-30T22:14:57Z

status

enum<string>

录制文件的状态。

可选

枚举值:

completed

示例值:

completed

total_size

integer <int64>

可选

录音的总文件大小。这包括 'recording_files' 和 'participant_audio_files' 文件。

示例值:

recording_count

integer

可选

此API调用的响应中返回的录制文件数。这包括 'recording_files' 和 'participant_audio_files' 文件。

示例值:

type

enum<string>

可选

录音的关联会议或网络研讨会类型。

如果录音是会议的:

'1'-即时会议。

'2'-预定的会议。

'3'-没有固定时间的定期会议。

'4'-通过PMI (个人会议ID) 创建的会议。

'7' - A 个人音频会议 (PAC)。

'8'-固定时间的定期会议。

如果录制的是网络研讨会:

'5'-网络研讨会。

'6'-没有固定时间的经常性网络研讨会

'9'-固定时间的定期网络研讨会。

如果录音 ** 不是 ** 来自会议或网络研讨会:

'99'-通过Zoom门户网站上的 ** 记录 ** 界面上传的记录。

枚举值:

12345678999

示例值:

uuid

string

可选

唯一会议标识符。会议的每个实例都有自己的UUID。

示例值:

BOKXuumlTAGXuqwr3bLyuQ==

host_id

string

可选

设置为会议主持人的用户的ID。

示例值:

_0ctZtY0REqWalTmwvrdIw

duration

integer

会议持续时间。

可选

示例值:

start_time

string <date-time>

会议开始的时间。

可选

示例值:

2021-03-18T05:41:36Z

password

string

云录音的密码。

可选

示例值:

981651

account_id

string

可选

用户帐户的唯一标识符。

示例值:

Cx3wERazSgup7ZWRHQM8-w

topic

string

会议主题。

可选

示例值:

My Personal Meeting

integer

可选

会议ID，也称为会议编号。

示例值:

6840331990

download_access_token

string

可选

用于下载会议录音的JWT令牌。仅当 'include_fields' 查询参数中包含 'download_access_token' 时，此响应才会返回。

示例值:

abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ

示例

{
    "recording_play_passcode": "yNYIS408EJygs7rE5vVsJwXIz4-VW7MH",
    "recording_files": [
        {
            "file_path": "/9090876528/path01/demo.mp4",
            "play_url": "https://example.com/rec/play/Qg75t7xZBtEbAkjdlgbfdngBBBB",
            "meeting_id": "L0AGOEPVR9m5WSOOs/d+FQ==",
            "file_size": 7220,
            "recording_end": "2021-03-18T05:41:36Z",
            "file_type": "MP4",
            "recording_type": "shared_screen_with_speaker_view(CC)",
            "download_url": "https://example.com/rec/download/Qg75t7xZBtEbAkjdlgbfdngBBBB",
            "file_extension": "MP4",
            "id": "72576a1f-4e66-4a77-87c4-f13f9808bd76",
            "deleted_time": "2021-03-18T05:41:36Z",
            "recording_start": "2021-03-18T05:41:36Z",
            "status": "completed"
        }
    ],
    "participant_audio_files": [
        {
            "file_path": "/9090876528/path01/demo.mp4",
            "play_url": "https://example.com/rec/play/Qg75t7xZBtEbAkjdlgbfdngBBBB",
            "file_name": "test.json",
            "file_type": "M4A",
            "download_url": "https://example.com/rec/download/Qg75t7xZBtEbAkjdlgbfdngBBBB",
            "id": "a2f19f96-9294-4f51-8134-6f0eea108eb2",
            "file_size": 65536,
            "recording_end": "2021-06-30T22:14:57Z",
            "recording_start": "2021-06-30T22:14:57Z",
            "status": "completed"
        }
    ],
    "total_size": 22,
    "recording_count": 22,
    "type": "1",
    "uuid": "BOKXuumlTAGXuqwr3bLyuQ==",
    "host_id": "_0ctZtY0REqWalTmwvrdIw",
    "duration": 20,
    "start_time": "2021-03-18T05:41:36Z",
    "password": "981651",
    "account_id": "Cx3wERazSgup7ZWRHQM8-w",
    "topic": "My Personal Meeting",
    "id": 6840331990,
    "download_access_token": "abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ"
}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误代码: ** '1010' 在该帐户上找不到用户: {accountId}

🟠404** HTTP状态代码: ** '404' 未找到 ** 错误代码: ** '1001' 用户 “{userId}” 不存在或不属于此帐户。 ** 错误代码: ** '3301' 没有此会议的录音。

请求参数

示例代码

返回响应