视频会议概述
业务介绍
接入流程
| 步骤 | 介绍 | |
|---|---|---|
| 1 | 创建一个应用 | 如需创建企业自建应用，可参考 自建应用的开发流程如需创建应用商店应用，可参考 开发和上架应用商店应用 |
| 2 | 调用 API，对视频会议进行操作 | 调用 API 前，你需要先获取访问凭证并开启对应的权限，详情参见 如何调用服务端API你还可以在 Postman 工具中快速调试这些 API： 。使用方法参见Postman模版使用说明 |
| 3 | 监听事件，获知视频会议的变化 | 监听事件前，你需要先申请相应的权限，详情参见 事件订阅概述 |
资源介绍
| 资源 | 资源定义 |
|---|---|
| 预约会议 | 用户可以预约会议，提前设置参会成员和会议权限，并获取会议信息 |
| 会议操作 | 用户可以在会议中进行邀请参会成员、移除参会成员和设置主持人等操作 |
| 会议录制 | 用户可以录制一场会议，在会议结束后获得会议录制文件链接 |
| 会议报告 | 会议报告用于记录一段时间内租户会议的使用情况，包括会议数、会议时长和参会人数等信息 |
| 会议室配置 | 会议室配置用于对飞书会议室的背景设置、资源管理等进行配置 |
资源：预约会议
方法列表
“商店”代表 应用商店应用；“自建”代表 企业自建应用
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 |
|---|---|---|---|---|
预约会议POST /open-apis/vc/v1/reserves/apply预约一场视频会议 | 更新会议预约信息 | user_access_token | ✓ | ✓ |
更新会议PUT /open-apis/vc/v1/reserves/:reserve_id更新一场已预约的视频会议配置，包括会议主题、会议权限配置等 | 更新会议预约信息 | user_access_token | ✓ | ✓ |
删除预约DELETE/open-apis/vc/v1/reserves/:reserve_id删除一场已预约的视频会议 | 更新会议预约信息 | user_access_token | ✓ | ✓ |
获取预约GET/open-apis/vc/v1/reserves/:reserve_id获取一场已预约的视频会议的详情，包括会议 ID、会议链接、会议权限 | 获取会议预约信息 | user_access_token | ✓ | ✓ |
获取活跃会议GET/open-apis/vc/v1/reserves/:reserve_id/get_active_meeting获取一场进行中的预约会议详情，包括参会人数、参会人详情等 | 获取会议预约信息 | user_access_token | ✓ | ✓ |
资源：会议
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 |
|---|---|---|---|---|
获取会议详情GET /open-apis/vc/v1/meetings/:meeting_id获取一个会议的详细数据，包括会议主题、会议 ID、会议链接、开始时间、会议状态、参会人列表等 | 获取会议信息 | tenant_access_tokenuser_access_token | ✓ | ✓ |
获取与会议号 相关联的会议列表GET /open-apis/vc/v1/meetings/list_by_no获取指定时间范围会议号关联的会议简要信息列表 | 获取会议信息 | tenant_access_tokenuser_access_token | ✓ | ✓ |
邀请参会人PATCH /open-apis/vc/v1/meetings/:meeting_id/invite邀请参会人加入会议 | 更新会议信息 | user_access_token | ✓ | ✓ |
移除参会人POST /open-apis/vc/v1/meetings/:meeting_id/kickout将参会人从会议中移除 | 更新会议信息 | tenant_access_token | ✓ | ✓ |
设置主持人PATCH /open-apis/vc/v1/meetings/:meeting_id/set_host将某一参会人设置为主持人 | 更新会议信息 | tenant_access_tokenuser_access_token | ✓ | ✓ |
结束会议PATCH /open-apis/vc/v1/meetings/:meeting_id/end结束一场正在进行的会议 | 更新会议信息 | user_access_token | ✓ | ✓ |
事件列表
| 事件 (Event) | 触发时机 | 权限要求（满足任一） | 事件类型 | 商店 | 自建 |
|---|---|---|---|---|---|
| 会议开始 | 会议被开始时 | 获取会议信息 | vc.meeting.meeting_started_v1 | ✓ | ✓ |
| 会议结束 | 会议被结束时 | 获取会议信息 | vc.meeting.meeting_ended_v1 | ✓ | ✓ |
| 加入会议 | 有参会人加入会议时 | 获取会议信息 | vc.meeting.join_meeting_v1 | ✓ | ✓ |
| 离开会议 | 有参会人离开会议时 | 获取会议信息 | vc.meeting.leave_meeting_v1 | ✓ | ✓ |
| 录制开始 | 录制开始时 | 获取会议信息 | vc.meeting.recording_started_v1 | ✓ | ✓ |
| 录制停止 | 录制停止时 | 获取会议信息 | vc.meeting.recording_ended_v1 | ✓ | ✓ |
| 录制完成 | 录制文件上传完毕时 | 获取会议信息 | vc.meeting.recording_ready_v1 | ✓ | ✓ |
| 屏幕共享开始 | 屏幕共享开始时 | 获取会议信息 | vc.meeting.share_started_v1 | ✓ | ✓ |
| 屏幕共享结束 | 屏幕共享结束时 | 获取会议信息 | vc.meeting.share_ended_v1 | ✓ | ✓ |
资源：录制
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 |
|---|---|---|---|---|
开始录制PATCH /open-apis/vc/v1/meetings/:meeting_id/recording/start在会议中开始录制 | 更新会议录制信息 | user_access_token | ✓ | ✓ |
停止录制PATCH /open-apis/vc/v1/meetings/:meeting_id/recording/stop在会议中停止录制 | 更新会议录制信息 | user_access_token | ✓ | ✓ |
获取录制文件GET /open-apis/vc/v1/meetings/:meeting_id/recording获取一个会议的录制文件 | 获取会议录制信息 | user_access_token | ✓ | ✓ |
授权录制文件PATCH /open-apis/vc/v1/meetings/:meeting_id/recording/set_permission将一个会议的录制文件授权给组织、用户或公开到公网 | 更新会议录制信息 | user_access_token | ✓ | ✓ |
资源：会议报告
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 |
|---|---|---|---|---|
获取会议报告GET /open-apis/vc/v1/reports/get_daily获取一段时间内组织的每日会议使用报告，包括总会议数量、总会议时长、总参会人数等 | 获取会议报告 | tenant_access_token | ✓ | ✓ |
获取 Top 用户列表GET /open-apis/vc/v1/reports/get_top_user获取一段时间内组织内会议使用的 Top 用户列表 | 获取会议报告 | tenant_access_token | ✓ | ✓ |
资源：会议室配置
方法列表
| 方法 (API) | 权限要求（满足任一） | 访问凭证（选择其一） | 商店 | 自建 |
|---|---|---|---|---|
查询会议室配置GET /open-apis/vc/v1/room_configs/query查询一个范围内的会议室配置 | 获取视频会议室信息 | tenant_access_token | ✓ | ✓ |
设置会议室配置POST /open-apis/vc/v1/room_configs/set设置一个范围内的会议室配置 | 更新视频会议室信息 | tenant_access_token | ✓ | ✓ |
扫码加入交流群修改于 2022-02-14 09:45:05