腾讯会议教育场景API集成白皮书-腾讯会议

腾讯会议教育场景API集成白皮书 Version 1.2

1.API简介
腾讯会议为企业IT、ISV系统集成商、SaaS服务商提供API，无缝对接企业邮箱、日程、智慧教室/会议室管理系统，实现行业应用、办公平台与腾讯会议音视频的连接，让腾讯会议更好地“为你的组织所用”，轻松适配多样场景，会议全流程一键达成，全面助力各类企事业单位内外部高效沟通协作，打造一体化办公体验。

API主要分为REST API和Webhook两部分，其中REST API主要用于会前/会后的相关操作及用户管理，具体包括会议管理、直播管理、用户管理、录制管理、文档管理、会议嘉宾管理和仪表盘等功能模块；Webhook主要用于订阅会中事件，目前有会议事件和云录制事件等功能模块。用户可以单独集成REST API实现会议管理，也可以同时集成REST API和Webhook，推拉结合，更好的实现交互处理。

API官网文档链接为：https://cloud.tencent.com/document/product/1095/42407

腾讯及腾讯会议团队对本标准拥有最终解释权，且保留随时更新文档内容的权利，而无需提前通知。此类更新的目的包括且不限于腾讯会议平台上的新功能、新设备类别以及外围设备中使用的硬件的性能改进等。

2.开始使用API

2.1.创建一个REST API应用（学校或企业内部应用鉴权）
购买腾讯会议企业版，将自动开通企业 API 接入能力，企业管理员可登录腾讯会议官网（https://meeting.tencent.com/），单击页面右上角【用户中心】，选择左侧菜单栏中的【高级】-【restApi】进入应用创建页面，点击添加应用即可创建密钥对。

提交之后会生成对应的SDK ID、SecretID和SecretKey，可以使用这些信息加上APPID用于后续应用的开发。

2.2.创建一个Webhook应用
使用前面创建生成的应用，打开通知状态开关

此时可以点击【消息通知】进入，然后点击右上角的【添加消息通知】进行设置。URL为提供webhook服务的地址，需要注意的是只有webhook服务已经正常启动才能保存配置生效。

点击【添加事件】可以订阅需要的通知事件，当前已支持会议事件和录制事件。

3.场景介绍与实现

以下为部分API应用场景的实现方案介绍，对于API应用鉴权及相关接口使用可参考官网API文档。

3.1.招生面试&答辩场景

3.1.1.实现效果示例

Step1预约面试

Step2发送邀请

Step3开始面试

3.1.2.场景特点与实现
这种场景有多名老师入会，学生分不同时间段进入，学生使用一路或者两路视频接入，有录制、会议通知、等候室，面试官匿名等需求。

创建会议（https://api.meeting.qq.com/v1/meetings）
这种类型的会议一般系统中订会，创建会议建议参数如下：

面试者/学生一般使用个人免费版账号，因此面试者/学生的信息应该是记录在用户系统中，不用传递到腾讯会议。

面试/答辩通知
会议预约成功后会收到会议详情回复，此时可以将获取到的会议号、密码、会议时间及入会链接等信息分别发送给老师和学生，具体通知方式（邮件/短信/微信等）取决于用户已实现的对接方式。

修改面试/答辩（https://api.meeting.qq.com/v1/meetings/{meetingId}）
会议信息有修改时，可调用修改会议接口修改对应参数，会议设置相关参数基本与创建会议参数一致，这里不再重复描述。

取消面试/答辩（https://api.meeting.qq.com/v1/meetings/{meetingId}/cancel）
会议被取消时调用取消会议接口，该会议号会被回收，无法入会且无法恢复。

录制处理
会议录制分为本地录制和云录制，如果创建会议或者会中选择的是本地录制，需要主持人自行将录制好的文件上传到用户的系统中；如果是云录制，可以通过webhook订阅录制完成事件来触发录制文件相关操作，webhook收到录制完成事件时，会得到录制文件信息（record_file_id），此时可以调用查询单个录制地址接口来获取到录制文件链接，将文件下载后上传到用户系统或者直接将链接保存到用户系统。

3.2.在线课程&一对一辅导场景

3.2.1.实现效果示例

Step1师生可通过学校公众号、电子校园卡或提醒通知快速进入线上会议的日程安排。

Step2点击日程安排，直接进入腾讯会议。系统自动为日程上的每个会议预约腾讯会议，并指定老师为主持人。老师通过腾讯会议直接进入会议，无需进行任何其他配置，易操作。

3.2.2.场景特点与实现 – 在线课程

这种场景一般只有一位老师入会，学生多以个人账号登入，多为周期性会议，有会议密码、会议通知及考勤需求，部分会有录像需求。

创建课程（https://api.meeting.qq.com/v1/meetings）
这种类型的会议一般对接课表系统，由课表系统自动发起订会，创建会议建议参数如下：

在线课程场景学生参会频率较高，可以将学生的个人账号加入guests列表中，这样会议记录会出现在学生客户端的会议列表中，学生可以点击会议链接直接进入，免去手动输入会议号的动作。以会议嘉宾身份入会时会跳过等候室直接进入到会议中，因此希望无关人员不能进入会议时可以同时开启会议嘉宾和等候室功能。

课程通知
课程预约成功后会收到会议详情回复，此时可以将获取到的会议号、密码、会议时间及入会链接等信息分别发送给老师和学生，具体通知方式（邮件/短信/微信等）取决于用户已实现的对接方式。

修改课程（https://api.meeting.qq.com/v1/meetings/{meetingId}）
课程信息有修改时，可调用修改会议接口修改对应参数，会议设置相关参数基本与创建会议参数一致，这里不再重复描述。

取消课程（https://api.meeting.qq.com/v1/meetings/{meetingId}/cancel）
课程被取消时调用取消会议接口，对于周期性会议，如果只取消某一次会议，需要传递子会议ID，否则是取消该系列周期会议，取消后的会议号无法入会且无法恢复。

录制处理
会议录制分为本地录制和云录制，如果创建会议或者会中选择的是本地录制，需要主持人（老师）自行将录制好的文件分享给学生；如果是云录制，可以通过webhook订阅录制完成事件来触发录制文件相关操作，webhook收到录制完成事件时，会得到录制文件信息（record_file_id），此时可以调用查询单个录制地址接口来获取到录制文件链接，将文件下载后上传到用户系统或者直接将链接保存到用户系统或者发送给学生等。

考勤处理
可以选择创建一个API定时任务，每天获取当天的参会成员的考勤信息或者使用Webhook订阅会议结束事件。定时任务实现该功能需要组合使用获取账户级已结束会议列表和获取参会成员列表两个接口；webhook订阅会议结束事件方式在收到会议结束事件消息时判断会议是否需要统计考勤，需要的话调用获取参会成员列表接口。由于参会成员多为企业外用户，获取到的参会成员userid字段为空，需要使用phone字段来作为唯一标识进行去重和统计。

3.2.3.场景特点与实现 – 一对一辅导

这种场景一般只有一位老师入会，学生多以个人账号登入，有会议密码、会议通知及考勤需求，部分会有录像需求。

创建课程（https://api.meeting.qq.com/v1/meetings）
这种类型的会议一般对接课表系统，由课表系统自动发起订会，创建会议建议参数如下：

取消会议（https://api.meeting.qq.com/v1/meetings/{meetingId}/cancel）
课程被取消时调用取消会议接口，对于周期性会议，如果只取消某一次会议，需要传递子会议ID，否则是取消该系列周期会议，取消后的会议号无法入会且无法恢复。

录制处理
会议录制分为本地录制和云录制，这种场景建议使用云录制，可以通过webhook订阅录制完成事件来触发录制文件相关操作，webhook收到录制完成事件时，会得到录制文件信息（record_file_id），此时可以调用查询单个录制地址接口来获取到录制文件链接，将文件下载后上传到用户系统或者直接将链接保存到用户系统或者发送给学生等。

考勤处理
建议使用webhook实时处理会议结束的回调消息，在会议结束后即时获取参会成员的考勤信息。实现该功能需要组合使用获取参会成员列表接口。

3.3.内部会议&外部交流&对外宣讲场景

3.3.1.实现效果示例

预订会议时可以添加多名参会者，会议通知通过邮件/企微等方式发送给与会人。

3.3.2.场景特点与实现 – 内部会议&对外交流

会议通过API或者客户端发起，可能为立即会议，有会议通知，会议密码，水印，录制，考勤等需求，人数多时可设置等候室。

创建会议（https://api.meeting.qq.com/v1/meetings）
可能为API创建也可能通过客户端发起，API创建会议建议参数如下：

会议通知
当用户从客户端直接发起会议时API无法实时获取，建议使用webhook收到的会议创建成功事件来发送会议通知，具体通知方式（邮件/短信/微信等）取决于用户已实现的对接方式。

修改会议（https://api.meeting.qq.com/v1/meetings/{meetingId}）
会议信息有修改时，可调用修改会议接口修改对应参数，会议设置相关参数基本与创建会议参数一致，这里不再重复描述。

取消会议（https://api.meeting.qq.com/v1/meetings/{meetingId}/cancel）
会议被取消时调用取消会议接口，对于周期性会议，如果只取消某一次会议，需要传递子会议ID，否则是取消该系列周期会议，取消后的会议号无法入会且无法恢复。

录制处理
会议录制分为本地录制和云录制，如果创建会议或者会中选择的是本地录制，需要主持人自行将录制好的文件分享给其他人；如果是云录制，可以通过webhook订阅录制完成事件来触发录制文件相关操作，webhook收到录制完成事件时，会得到录制文件信息（record_file_id），此时可以调用查询单个录制地址接口来获取到录制文件链接，将文件下载后上传到用户系统或者直接将链接保存到用户系统或者发送给与会者等。

考勤处理
建议使用webhook订阅会议结束事件，webhook在收到会议结束事件消息时判断会议是否需要统计考勤，需要的话调用获取参会成员列表接口。如果参会成员有企业外用户，获取到的企业外参会成员userid字段为空，因此需要使用phone字段来作为唯一标识进行去重和统计。

3.3.3.场景特点与实现 – 对外宣讲

会议一般通过API发起，大部分与会人为外部成员，有录制，直播等需求，如果参会人数大于300人，需要给创建人配置大型会议权限或者使用直播。配置大型会议权限需要管理员登录腾讯会议官网，在【用户中心】-【账户管理】-【资源配置】-【大型会议】处设置。

创建会议（https://api.meeting.qq.com/v1/meetings）
API创建会议建议参数如下：

会议通知
会议预约成功后会收到会议详情回复，此时可以选择根据该回复或者webhook收到的会议创建成功事件来发送会议通知，具体通知方式（邮件/短信/微信等）取决于用户已实现的对接方式。如果用户使用的其他场景需要使用到webhook处理预订会议消息，建议统一在收到webhook回调消息后进行通知处理，以免重复通知。

取消会议（https://api.meeting.qq.com/v1/meetings/{meetingId}/cancel）
会议被取消时调用取消会议接口，该会议号会被回收，无法入会且无法恢复。

直播回放
如果开启了直播回放，在会议结束后可以通过调用获取直播回看地址相关接口将直播回放链接推送给未观看直播的用户。