概述
业务介绍
视频会议（Video Conferencing，简称 VC）是指飞书音视频会议业务域，包括 飞书视频会议 和 飞书会议室 解决方案，为不同区域的用户提供完善、便捷的高质量音视频交互体验，满足线上实时沟通协作的需求。通过视频会议 API，你可以实现多种功能，例如：
- 会议预约，如预约会议、更新会议等
- 会议操作，如邀请参会人、设置主持人、结束会议等
- 会议录制，如开启/停止录制、获取录制文件等
- 会议报告，如获取会议数据报告、Top 用户列表等
- 会议室，如查询会议室、创建会议室、更新会议室等
- 会议室层级，如查询会议室层级、创建会议室层级等
- 会议室配置，如设置背景图、设置数字标牌等
- 导出，如导出会议明细数据、参会人明细数据等
接入流程
| 步骤 | 介绍 | |
|---|---|---|
| 1 | 创建一个应用 | - 如需创建企业自建应用，可参考 自建应用的开发流程 - 如需创建应用商店应用，可参考 开发和上架应用商店应用 |
| 2 | 调用 API，对视频会议进行操作 | 调用 API 前，你需要先获取访问凭证并开启对应的权限，详情参见 如何调用服务端API 你还可以在 API 调试台 中快速调试这些 API ，使用方法参见API 调试台使用指南。 |
| 3 | 监听事件，获知视频会议的变化 | 监听事件前，你需要先申请相应的权限，详情参见 事件订阅概述。目前仅通过开放平台进行预约的会议能够监听到相关事件，详情参见预约会议。 |
资源介绍
视频会议业务域以“资源”为中心进行开放，资源的关系图如下：
视频会议的相关资源定义如下：
| 资源 | 资源定义 |
|---|---|
| 预约会议 | 用户可以预约会议，提前设置参会成员和会议权限，并获取会议信息 |
| 会议操作 | 用户可以在会议中进行邀请参会成员、移除参会成员和设置主持人等操作 |
| 会议录制 | 用户可以录制一场会议，在会议结束后获得会议录制文件链接 |
| 会议报告 | 会议报告用于记录一段时间内租户会议的使用情况，包括会议数、会议时长和参会人数等信息 |
| 会议室 | 用户可以进行查询会议室、创建会议室、更新会议室、删除会议室等操作 |
| 会议室层级 | 用户可以进行查询会议室层级、创建会议室层级、更新会议室层级等操作 |
| 会议室配置 | 会议室配置用于对飞书会议室的背景设置、资源管理等进行配置 |
| 导出 | 用于导出一段时间内租户的会议数据，包括会议明细、参会人明细、会议室预定数据、参会人会议质量数据等 |
以下将详细介绍每个资源的字段、方法、事件。
资源：预约会议
查看资源字段及示例
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 |
|---|---|---|---|---|
[预约会议](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/apply) POST /open-apis/vc/v1/reserves/apply >预约一场视频会议 | 更新会议预约信息 | user_access_token | ✓ | ✓ |
[更新会议](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/update) PUT /open-apis/vc/v1/reserves/:reserve_id >更新一场已预约的视频会议配置，包括会议主题、会议权限配置等 | 更新会议预约信息 | user_access_token | ✓ | ✓ |
[删除预约](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/delete) DELETE/open-apis/vc/v1/reserves/:reserve_id >删除一场已预约的视频会议 | 更新会议预约信息 | user_access_token | ✓ | ✓ |
[获取预约](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/get) GET/open-apis/vc/v1/reserves/:reserve_id >获取一场已预约的视频会议的详情，包括会议 ID、会议链接、会议权限 | 获取会议预约信息 | user_access_token | ✓ | ✓ |
[获取活跃会议](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/get_active_meeting) GET/open-apis/vc/v1/reserves/:reserve_id/get_active_meeting >获取一场进行中的预约会议详情，包括参会人数、参会人详情等 | 获取会议预约信息 | user_access_token | ✓ | ✓ |
资源：会议
查看资源字段及示例
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 |
|---|---|---|---|---|
[获取会议详情](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/get) GET /open-apis/vc/v1/meetings/:meeting_id >获取一个会议的详细数据，包括会议主题、会议 ID、会议链接、开始时间、会议状态、参会人列表等 | 获取会议信息 | tenant_access_token user_access_token | ✓ | ✓ |
[获取与会议号相关联的会议列表](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/list_by_no) GET /open-apis/vc/v1/meetings/list_by_no >获取指定时间范围会议号关联的会议简要信息列表 | 获取会议信息 | tenant_access_token user_access_token | ✓ | ✓ |
[邀请参会人](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/invite) PATCH /open-apis/vc/v1/meetings/:meeting_id/invite >邀请参会人加入会议 | 更新会议信息 | user_access_token | ✓ | ✓ |
[移除参会人](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/kickout) POST /open-apis/vc/v1/meetings/:meeting_id/kickout >将参会人从会议中移除 | 更新会议信息 | tenant_access_token | ✓ | ✓ |
[设置主持人](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/set_host) PATCH /open-apis/vc/v1/meetings/:meeting_id/set_host >将某一参会人设置为主持人 | 更新会议信息 | tenant_access_token user_access_token | ✓ | ✓ |
[结束会议](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/end) PATCH /open-apis/vc/v1/meetings/:meeting_id/end >结束一场正在进行的会议 | 更新会议信息 | user_access_token | ✓ | ✓ |
事件列表
| 事件 (Event) | 触发时机 | 权限要求（满足任一） | 事件类型 | 商店 | 自建 |
|---|---|---|---|---|---|
[会议开始](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/events/meeting_started) | 会议被开始时 | 获取会议信息 | vc.meeting.meeting_started_v1 | ✓ | ✓ |
[会议结束](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/events/meeting_ended) | 会议被结束时 | 获取会议信息 | vc.meeting.meeting_ended_v1 | ✓ | ✓ |
[加入会议](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/events/join_meeting) | 有参会人加入会议时 | 获取会议信息 | vc.meeting.join_meeting_v1 | ✓ | ✓ |
[离开会议](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/events/leave_meeting) | 有参会人离开会议时 | 获取会议信息 | vc.meeting.leave_meeting_v1 | ✓ | ✓ |
[录制开始](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/events/recording_started) | 录制开始时 | 获取会议信息 | vc.meeting.recording_started_v1 | ✓ | ✓ |
[录制停止](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/events/recording_ended) | 录制停止时 | 获取会议信息 | vc.meeting.recording_ended_v1 | ✓ | ✓ |
[录制完成](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/events/recording_ready) | 录制文件上传完毕时 | 获取会议信息 | vc.meeting.recording_ready_v1 | ✓ | ✓ |
[屏幕共享开始](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/events/share_started) | 屏幕共享开始时 | 获取会议信息 | vc.meeting.share_started_v1 | ✓ | ✓ |
[屏幕共享结束](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/events/share_ended) | 屏幕共享结束时 | 获取会议信息 | vc.meeting.share_ended_v1 | ✓ | ✓ |
资源：录制
查看资源字段及示例
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 |
|---|---|---|---|---|
[开始录制](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/start) PATCH /open-apis/vc/v1/meetings/:meeting_id/recording/start >在会议中开始录制 | 更新会议录制信息 | user_access_token | ✓ | ✓ |
[停止录制](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/stop) PATCH /open-apis/vc/v1/meetings/:meeting_id/recording/stop >在会议中停止录制 | 更新会议录制信息 | user_access_token | ✓ | ✓ |
[获取录制文件](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/get) GET /open-apis/vc/v1/meetings/:meeting_id/recording >获取一个会议的录制文件 | 获取会议录制信息 | user_access_token | ✓ | ✓ |
[授权录制文件](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/set_permission) PATCH /open-apis/vc/v1/meetings/:meeting_id/recording/set_permission >将一个会议的录制文件授权给组织、用户或公开到公网 | 更新会议录制信息 | user_access_token | ✓ | ✓ |
资源：会议报告
查看资源字段及示例
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 |
|---|---|---|---|---|
[获取会议报告](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/report/get_daily) GET /open-apis/vc/v1/reports/get_daily >获取一段时间内组织的每日会议使用报告，包括总会议数量、总会议时长、总参会人数等 | 获取会议报告 | tenant_access_token | ✓ | ✓ |
[获取 Top 用户列表](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/report/get_top_user) GET /open-apis/vc/v1/reports/get_top_user >获取一段时间内组织内会议使用的 Top 用户列表 | 获取会议报告 | tenant_access_token | ✓ | ✓ |
资源：会议室
查看资源字段及示例
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 |
|---|---|---|---|---|
[查询会议室列表](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/list) GET /open-apis/vc/v1/rooms >查询某个会议室层级下会议室列表 | 更新视频会议室信息 获取视频会议室信息 | tenant_access_token user_access_token | ✓ | ✓ |
[查询会议室详情](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/get) GET /open-apis/vc/v1/rooms/:room_id >使用会议室ID查询会议室详情 | 更新视频会议室信息 获取视频会议室信息 | tenant_access_token user_access_token | ✓ | ✓ |
[批量查询会议室详情](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/mget) POST /open-apis/vc/v1/rooms/mget >使用会议室ID批量查询会议室详情 | 更新视频会议室信息 获取视频会议室信息 | tenant_access_token user_access_token | ✓ | ✓ |
[创建会议室](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/create) POST /open-apis/vc/v1/rooms >用于创建会议室 | 更新视频会议室信息 获取视频会议室信息 | tenant_access_token user_access_token | ✓ | ✓ |
[更新会议室](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/patch) PATCH /open-apis/vc/v1/rooms/:room_id >用于更新会议室 | 更新视频会议室信息 | tenant_access_token user_access_token | ✓ | ✓ |
[删除会议室](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/delete) DELETE /open-apis/vc/v1/rooms/:room_id >用于删除会议室 | 更新视频会议室信息 | tenant_access_token user_access_token | ✓ | ✓ |
[搜索会议室](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/search) POST /open-apis/vc/v1/rooms/search >用于搜索会议室 | 更新视频会议室信息 获取视频会议室信息 | user_access_token | ✓ | ✓ |
资源：会议室层级
查看资源字段及示例
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 |
|---|---|---|---|---|
[查询会议室层级列表](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/list) GET /open-apis/vc/v1/room_levels >查询某个会议室层级下的子层级列表 | 更新视频会议室信息 获取视频会议室信息 | tenant_access_token user_access_token | ✓ | ✓ |
[查询会议室层级详情](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/get) GET /open-apis/vc/v1/room_levels/:room_level_id >使用会议室层级ID查询会议室层级详情 | 更新视频会议室信息 获取视频会议室信息 | tenant_access_token user_access_token | ✓ | ✓ |
[批量查询会议室层级详情](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/mget) POST /open-apis/vc/v1/room_levels/mget >使用会议室层级ID批量查询会议室层级详情 | 更新视频会议室信息 获取视频会议室信息 | tenant_access_token user_access_token | ✓ | ✓ |
[创建会议室层级](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/create) POST /open-apis/vc/v1/room_levels >用于创建会议室层级 | 更新视频会议室信息 获取视频会议室信息 | tenant_access_token user_access_token | ✓ | ✓ |
[更新会议室层级](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/patch) PATCH /open-apis/vc/v1/room_levels/:room_level_id >用于更新会议室层级 | 更新视频会议室信息 | tenant_access_token user_access_token | ✓ | ✓ |
[删除会议室层级](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/del) POST /open-apis/vc/v1/room_levels/del >用于删除会议室层级 | 更新视频会议室信息 | tenant_access_token user_access_token | ✓ | ✓ |
[搜索会议室层级](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/search) POST /open-apis/vc/v1/room_levels/search >用来搜索会议室层级 | 更新视频会议室信息 获取视频会议室信息 | tenant_access_token user_access_token | ✓ | ✓ |
资源：会议室配置
查看资源字段及示例
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 |
|---|---|---|---|---|
[设置会议室配置](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/scope_config/create) POST /open-apis/vc/v1/scope_config >设置某个会议层级范围下或者某个会议室的配置 | 更新视频会议室信息 | tenant_access_token user_access_token | ✓ | ✓ |
[查询会议室配置](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/scope_config/get) GET /open-apis/vc/v1/scope_config >查询某个会议层级范围下或者某个会议室的配置 | 更新视频会议室信息 获取视频会议室信息 | tenant_access_token user_access_token | ✓ | ✓ |
资源：导出
查看资源字段及示例
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 |
|---|---|---|---|---|
[查询导出任务结果](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/get) GET /open-apis/vc/v1/exports/:task_id >查看异步导出的进度 | 导出视频会议信息 | tenant_access_token user_access_token | ✓ | ✓ |
[导出会议明细](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/meeting_list) POST /open-apis/vc/v1/exports/meeting_list >导出会议明细 | 导出视频会议信息 | tenant_access_token user_access_token | ✓ | ✓ |
[导出参会人明细](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/participant_list) POST /open-apis/vc/v1/exports/participant_list >导出一个会议的参会人详情列表 | 导出视频会议信息 | tenant_access_token user_access_token | ✓ | ✓ |
[导出参会人会议质量数据](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/participant_quality_list) POST /open-apis/vc/v1/exports/participant_quality_list >导出一场会议一个参会人的音视频和共享质量数据 | 导出视频会议信息 | tenant_access_token user_access_token | ✓ | ✓ |
[导出会议室预定数据](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/resource_reservation_list) POST /open-apis/vc/v1/exports/resource_reservation_list >导出会议室预定数据 | 导出视频会议信息 | tenant_access_token user_access_token | ✓ | ✓ |