开放性应用实践概览
亿联云视讯提供了服务端API开放和客户端SDK开放,开发者可基于自己的应用场景灵活地集成亿联云视讯的开放性接口。
本章介绍了几个基于亿联云视讯API集成和客户端SDK集成的最佳实践,以帮助开发者们了解几种典型场景下的集成方案。
表1 服务端API集成最佳实践
实践 | 应用场景 |
---|---|
实践1:账号同步 | 用于获取亿联云视讯用户账号数据,提供第三方同步组织架构。 |
实践2:预约会议 | 通过API预约一场在线会议,可预添加参会成员,预约成功后将生成会议,对应参会用户的客户端上将收到会议日程,届时可自行加入会议。 |
实践3:基础会控(开关参会者麦和摄像头、踢人) | 用于邀请成员入会后,对会议中的参会者进行麦克风和摄像头的开关操作、剔除出会的基本会控操作。 |
实践4:获取录制文件 | 邀请自定义数量成员成功入会vmr后,开启会议录制,结束录制后将自动生成录播文件,可通过查询录制记录列表,对应获取需求的录播文件的下载链接,提供用户下载保存。 |
一、服务端API集成最佳实践1:账号同步
1、调用流程:
本场景需发送查询用户树请求(若需更详细的用户信息,可选使用查询用户列表接口,但该接口返回数据中不包含分组的节点名称),获取到所有企业用户账号及架构信息,开发者通过解析返回的JSON文件,可获取对应的组织架构。
2、流程图:
二、服务端API集成最佳实践2:预约会议
1、调用流程:
1)获取token后,发送添加会议请求,添加预约会议成功,返回该会议对应的会议id。
2)亿联会议平台将根据已配置好事件订阅地址,自动推送会议添加成功的事件;
tips:若您有获取webhook事件的需求,详情可查看服务端API参考中的webhook配置方法。
2、流程图:
三、服务端API集成最佳实践3:基础会控(开关参会者麦和摄像头、踢人)
1、调用流程:
1)获取token后,发送邀请入会请求,邀请成员入会成功;
2)发送查询会议用户信息请求,获取到参会成员各自对应的userID标识;
3)依据自身需求,选择性发送禁言、解除禁言、请求打开视频、关闭视频、踢人请求,根据userID标识,对相关参会成员执行基础会控操作。
2、流程图:
四、服务端API集成最佳实践4:获取录制文件
1、调用流程:
1)发送邀请入会请求,邀请自定义数量的成员入会,入会成功;
2)发送设置会议录制状态请求,开启录制,随后结束录制,将自动生成录播文件;
3)发送查询企业录制记录列表请求,获取到录制记录列表后,第三方根据返回的数据,自行判断筛选出所需的录制mp4文件记录对应的id;
4)发送查询企业录制文件下载地址请求,返回对应录制mp4文件的下载地址,即可访问下载链接,获得录制的mp4文件。
2、流程图:
五、SSO单点登陆最佳实践
单点登录功能支持企业直接使用第三方账号登录亿联会议,无需提前同步账号信息。已支持oauth2.0/CAS等标准协议,无需定制开发通过web配置即可实现单点登陆对接。
第三方单点登陆要求:
1、标准的oauth2.0/CAS协议。
2、单点登陆服务器必须公网可访问。
2、通过token获取的用户信息,必须包含姓名、手机号;最好有组织架构字段方便创建对应的组织架构,否则只能统一放到根目录下。
单点登陆流程图:
表2 SDK集成最佳实践
实践 | 应用场景 |
---|---|
实践1:客户端原生SDK集成 | 将亿联会议原生SDK集成到客户CS架构的应用里面,实现音视频会议。 |
实践2:webapp SDK集成 | 将亿联会议webapp SDK集成到客户BS架构的页面中,实现音视频会议。 |
六、SDK集成最佳实践1:客户端原生SDK集成
1、SDK初始化:需要传递appid和appSecret,联系亿联销售/售前工程师申请。
2、登录Yealink账号,账号需要提前在YMS/Cloud平台上注册,SDK登录成功后,才具备来电监听的功能。
备注:匿名入会的场景,无需经过这个一步。
3、加入固定VMR场景:调用“joinMeeting”接口传递对应的会议号、密码,即可加入对应的会议室。
创建即时会议场景:调用“start”接口创建一个临时会议,并邀请相应人员入会。
4、调用“leave”接口,离开会议。