腾讯会议SDK项目交付指导

SDK接入流程

启动阶段

开通腾讯会议企业版账号和SDK功能

客户下单购买腾讯会议企业版或者商务申请开通POC资源，并开启SDK功能

SDK配置开通

1）企业用户管理模式&SSO域名前缀修改

SDK登录鉴权需要使用到IDaaS服务，因此需要客户将企业版的用户管理模式更改成自动模式。另外默认生成的SSO域名前缀也需要改成对客户有实际意义的域名。具体操作参考文档《企业用户管理模式—手动同步模式'切换为'自动同步模式&SSO登录域名修改2.0》。

2）实施账号提供

腾讯会议后台需要使用实施账号完成SDK开通配置，客户超管可参考《实施账号开通方法》文档来开通实施账号。

3）SDK对接信息提供

客户需要完成企业用户管理模式&SSO域名前缀修改步骤，并提供实施账号给腾讯会议技术支持同学，然后由腾讯会议技术支持同学将实施账号发送给腾讯会议后台获取SDK对接信息。由于对接信息中含秘钥等敏感信息，需要注意传播范围。

接入材料提供

SDK对接涉及的所有文档见本文附录，开发包线下提供。

预研&设计阶段

方案设计

如果客户前期已经对接过其他会议类SDK，可沿用之前的设计。腾讯会议SDK也提供了会前和会后的功能，如果会前会后功能不需要个性化的实现可以使用SDK自带的页面，否则需要与API配合使用，实现更加个性化的定制。新接入会议SDK的客户可以参考以下功能点进行设计。

入会链接调起APP

腾讯入会链接调起SDK客户端，参考文档《如何让腾讯会议链接打开之后调起自己开发的SDK客户端》

代理设置

当用户的使用场景包括海外接入或企业内部有复杂的网络访问权限规则时，可以考虑使用代理接入的方式，以解决部分用户的接入使用问题。对于网络强管控的用户，强烈建议在调用SDK初始化接口时就设置代理。出于成本考量，可将代理方式设置为除媒体外（音视频流不走代理）。

创建预约会议

使用API自定义实现

API创建会议有很多参数可以设置，一般只需要设置会议主题、会议时间、参会人等参数即可，其他参数可保持默认。如果使用的场景对静音、云录制等其他参数有比较强的诉求，也可以放在常用设置项。下面两个是客户根据自己的需求设计的创建预约会议的页面。

自定义创建会议实现效果1

自定义创建会议实现效果2

使用SDK自带的UI

当使用SDK自带的功能来创建会议时，调用SDK的showScheduleMeetingView接口即可唤起创建会议页面，如下图：

SDK自带的创建会议页面

点对点呼叫/IM群快速会议

点对点会叫或者IM群快速发起一个会议是常见的SDK使用场景。实现时在IM群聊或者单聊页面提供一个会议入口，点击后创建一个会议并将会议信息发送给对方，同时本人入会并调用SDK的addUsersWithParam接口呼叫其他参会成员。被呼叫人员将收到呼叫弹框，可选择是否加入会议。

1）创建会议

创建快速会议

2）呼叫成员

呼叫待参会成员

3）成员响应呼叫

被呼叫用户弹出入会弹框

会议列表

使用API自定义实现

通过调用查询用户的会议列表API接口来获取用户待参加的会议，同时还可以与Webhook结合，订阅会议创建和会议更新等事件消息，即时刷新新的会议记录。下图是自定义会议列表效果

自定义会议列表效果

使用SDK自带的UI

通过调用SDK的showPreMeetingView接口唤起自带的会前页面，有经典样式和多Tab样式可以选择。下面分别是这两种样式的效果：

会前页面-经典样式

会前页面-多Tab样式

无线投屏

SDK提供了showScreenCastView和startScreenCast两个无线投屏的接口，其中showScreenCastView自带UI，除了直接投屏外还支持超声波投屏；startScreenCast接口不带UI，如果要使用超声波投屏，还要和decodeUltrasoundScreenCastCode接口搭配使用。无线投屏功能效果如下图：

无线投屏功能

会中邀请

SDK会中支持邀请回调弹框自定义，如果没有同步组织架构到腾讯会议，但是需要在会中拉取通讯录，可通过自定义回调实现。邀请弹框中的Rooms、MRA和PSTN等呼叫功能可以使用REST API来配合实现。下图分别是SDK自带的邀请弹框和自定义实现的效果。

SDK默认会中邀请效果

自定义会中邀请效果

历史会议信息查询

SDK提供了showHistoricalMeetingView接口用于展示历史会议，也可通过查询用户已结束会议列表API接口自定义实现类似的功能。

SDK历史会议列表页面

会议详情

会议结束后用户需要在会议详情获取云录制、本地录制等会议沉淀结果。SDK提供了showMeetingDetailView接口来展示会议详情获取会议沉淀信息。如果自定义实现可配合云录制相关API接口+本地录制相关SDK接口来获取会议沉淀信息。

SDK会议详情页面

SDK日志获取

SDK当前提供了showLogs和collectLogFiles两个接口用于获取日志。当客户APP没有后台收集日志功能时，建议接入showLogs接口；如果APP有后台收集日志功能，可接入collectLogFiles接口将获取到的日志打包后上传到APP后台。

客户端/后台文档学习&接口验证

参考附录的文档链接

开发&联调阶段

UI开发

实现自定义的会前、会中和会后的页面设计

客户端SDK开发接入

根据需要选择对应的客户端SDK进行开发接入，具体接入方法参考SDK包中的demo代码，《SDK鉴权与登录说明》，《XX接入手册》和《TencentMeetingSDK（TMSDK）接口参考文档》。接入过程中遇到问题可先参考接入文档及demo代码进行调试定位。如果仍不能解决，可前往开发者社区，查看相关解决方案，或者提问发起讨论，点击前往，提问时需要勾选腾讯会议和腾讯会议SDK标签。

在开发联调阶段如果遇到问题需要SDK解决，可以在修复问题后使用调测包或者正式包继续开发接入工作。

鉴权登录开发

后台开发实现该功能，使用从腾讯会议侧获取到的SDK ID和Secret信息生成SDK token用于提供给客户端SDK初始化使用；使用腾讯会议IDaaS获取到的私钥及userid生成ID token用于提供给客户端SDK登录使用。具体实现参考《SDK鉴权与登录说明》和《如何生成腾讯会议SDK鉴权所需的SDK Token和ID Token等信息》。

后台REST API & Webhook开发接入

参考附录文档接口描述及示例代码进行接入

后台IDaaS API开发接入

参考附录文档接口描述及示例代码进行接入

系统测试阶段

首次接入SDK一般建议系统测试两轮，在首次转测及灰度版本出包时需要使用SDK的正式包，中间bug修复验证可使用正式包或者调测包。

灰度上线阶段

灰度上线意味着SDK已经接入完成，后续每次发布都需要使用SDK正式包。为了保证充分灰度验证及预留足够bug修复时间，一般建议灰度时间不少于一个月。

附录：文档说明