在开始系统集成小程序SDK开发之前,您需要完成相应的准备工作,包括开通云视讯 API 服务、注册应用、微信推拉流权限和开发配置;
云视讯 API 只开放给签署合作协议的伙伴。在开始使用云视讯 API 之前,您需要首先联系当地销售或渠道伙伴,完成云视讯 API 开通流程。 云视讯 API 是以企业为单位进行开通的,在开通之前您需要确保待开发应用所服务的企业已经在小鱼平台开通了企业管理后台。
云视讯 API 的开通由销售或渠道伙伴发起,审批通过后,由小鱼易连协助在平台开通该企业的服务。 完成云视讯 API 开通后,企业管理员可使用对应的管理员账号登录云视讯管理平台,通过“系统服务 -〉 云视讯 API -〉 基本信息”查看开发应用需要的企业 ID(enterpriseId)及 token。
其中,企业 ID(enterpriseId)用来唯一标识云视讯 API 的使用企业;token 作为 API 访问凭证,由云视讯后台系统自动产生,并通过企业管理平台分发给授权开发者。
应用开发者通过 enterpriseId 及 token 获取访问企业 API 的权限,因此开发者需要确保 enterpriseId 和 token 不会泄露,以避免有其他人非法使用。
开通企业的云视讯 API 以后,企业管理员登录云视讯管理平台,通过“系统服务 -〉 云视讯 API “ 界面注册应用。应用注册后开发者即可进行应用的集成开发。
目前企业管理平台支持注册 Android、iOS、Mac、小程序、Web、Electron。应用注册成功后,系统会针对小程序应用生成 Appid,可作为后期查询应用数据时的凭证,并需要配置在SDK中使用;
小程序直接通过应用名称注册即可(SDK APP ID即为appid值):
出于政策和合规的考虑,微信暂未放开所有小程序对实时音视频功能(即 live-pusher 和 live-player 标签)的支持:
1、小程序推拉流标签使用权限暂时只开放给有限类目,具体请参见下表:
小程序推拉流标签不支持个人小程序,只支持企业类小程序。
3、符合类目要求的小程序,需要在 微信公众平台 > 开发 > 开发设置 > 接口设置 中开通该组件权限,如下图所示:
4、在小程序后台配置服务域名白名单,需在 微信公众平台 > 开发 > 开发设置 > 服务器域名 中添加如下 request 合法域名:
https://wxrtc.xylink.com
5、在小程序后台配置 socket 服务域名白名单,需在 微信公众平台 > 开发 > 开发设置 > 服务器域名 中添加 socket 合法域名:
wss://wxrtc.xylink.com
6、开发者工具中配置:
准备完成如上工作后,即可以开始集成小程序SDK;
小鱼易连开发平台分为终端 SDK 和服务端 API,实现完整的音视频通话场景需要同时进行服务端和终端的集成开发。 系统集成架构如上图所示,分为:
小鱼易连开发平台的音视频通话是在云会议室进行的,在进行音视频呼叫之前,您可以通过服务端 API 创建云会议室,云会议室为虚拟的会议号码。 服务端 API 基于 rest api 提供服务,建议您通过您的服务端访问小鱼易连开发平台服务端 API,便于后期维护控制。