互动工具开发指南

概述

互动加号sdk提供了访问云会议平台的能力，开发者可通过调用开放的API，在自己的互动应用内实现查询参会人列表、邀请参会人发言等功能，整体流程：

云会议中台封装出来的接口文件QS-JSSDK提供了访问云会议平台的能力，开发者开发的网页应用要想与云会议客户端通信，要按照以下步骤：

项目中引入接口文件

<!-- 在html文档中 --><script type="text/javascript" src="https://xxx/qs-js-sdk-1.0.0.js"></script>

引入此文件会在引入一个全局变量qssdk

通过config接口注入权限验证配置（目前没有从server端获取ticket凭证这个步骤）

由于中台提供的接口能力和中台业务功能密切相关，所以调用jsApi之前需要进行鉴权操作

qssdk.config({    typeId: 0, // 互动工具typeId    timestamp: 0, // 时间戳,毫秒级    nonceStr: '', // 随机字符串    signature: '', // 签名    success: function(result) {       // 成功回调，可以在成功之后使用 qssdk.interaction.xxx jsapi    },    fail: function() {       // 失败回调    }})

获取signature签名算法如下：将typeId、timestamp、nonceStr拼接成如下字符串，有两个注意点：

* 字段值采用原始值，不要进行URL转义；* 必须严格按照如下格式拼接，不可变动字段顺序。typeId=typeId&timestamp=timestamp&nonceStr=nonceStr

举例：

以下是参数：

typeId=20000timestamp=1648783294823nonceStr=Wm3WZYTPz0wzccnW

拼接后的string串：

typeId=20000&timestamp=1648783294823&nonceStr=Wm3WZYTPz0wzccnW

对该字符串进行MD5加密，得到signature：

8C0DDC3CE58E58B662135A29C59BD8B1

调用JSAPI

JSAPI调用方式

所有接口都为异步

所有接口必须在 window.qssdk.ready(function(){}) 回调函数里调用

接受一个 object 类型的参数

成功回调 success

失败回调 fail

以获取互动模板数据举例:

window.qssdk.ready(function(){    qssdk.interaction.getInteractiveToolInfo({        templateId: '',        success: function(res){},        fail: function(res){}    })})

调试步骤

下载并安装云会议客户端

如果是新开发的一个互动应用，调试时需要在本地进行配置，打开云会议安装目录下面的config/interaction.config文件，填入开发者对应的互动应用相关信息

<?xml version="1.0" encoding="UTF-8"?><configuration>    <interaction>        <interactiveToolName>投票</interactiveToolName>        <typeId>xxx</typeId>        <iconUrl>xxx</iconUrl>        <floatWindowIconUrl>xxx</floatWindowIconUrl>        <templateEditUrl>xxx</templateEditUrl>        <templatePreviewUrl>xxx</templatePreviewUrl>        <maxTemplateNumber>10</maxTemplateNumber>        <startUrl>xxx</startUrl>        <responseUrl>xxx</responseUrl>     </interaction></configuration>

参数说明：

参数	说明
interactiveToolName	互动工具名称
typeId	互动工具类型id，配置数字
iconUrl	互动工具图标
floatWindowIconUrl	互动工具浮动小球图标
templateEditUrl	互动工具模板创建和模板编辑页面地址
templatePreviewUrl	互动工具模板预览页面地址
maxTemplateNumber	互动工具最大模板数量，0 表示不需要模板
startUrl	互动工具发起地址，会中
responseUrl	互动工具响应页面地址，会中