SDK嵌入
SDK嵌入
1.1问答嵌入接口定义
使用问答嵌入首先要开通API/SDK权限。
URL
http://e.vhall.com/webinar/qa?id=123456789&account=123456&name=visitor&signed_at=1474617658&app_key=11111&sign=17e3dcb69
注:在调用接口的时候要将新生成的sign和创建sign时候的参数一起写入URL。
URL参数
id:必填参数,创建活动得到的九位数活动id
account: 必填参数,第三方唯一识别ID。
name: 必填参数,此字段表示用户昵称、姓名或其他有意义的字符串。可以为中文,但必须为UTF-8,且经过URL编码(urlencode)。
signed_at:必填参数,签名生成时间戳,签名有效期一个小时。
app_key: 必填参数,从此页面获取API/SDK的使用权限信息:
sign: 必填参数签名,用于验证链接的有效性,签名生成规则详见API调用说明 三、接口定义5. 签名方式调用 (此接口只存在签名方式调用一种,auth_type可以省略。每请求一次都要从新生成一次sgin)
1.2、聊天JS SDK嵌入
如需要对聊天进行管理操作(禁言、踢出等功能),请前往微吼平台上进行操作主要调用API注:目前聊天模块只支持观看端。
本说明只对网页文档中的初始化验证进行说明。
使用聊天 JS SDK 嵌入首先要开通API/SDK权限。
SDK引入、初始化并注入权限验证
依赖库: 本SDK依赖于JQuery库,请在需要引入JQuery的页面插入以下代码进行引入
<script src="http://cnstatic01.e.vhall.com/3rdlibs/jquery/1.11.2/jquery.min.js" type="text/javascript"></script>
引入JS文件: 在需要调用SDK的页面插入以下代码以引入JS文件:
<script type="text/javascript" src="http://cnstatic01.e.vhall.com/static/js/webSDK/vhallSDK.js"></script>
注:目前暂不支持https,支持使用AMD/CMD标准模块加载规范加载
初始化及权限验证:
1.请使用以下的方法和参数进行SDK的初始化以及权限的验证(需要先生成sign)
2.参数sign的生成规则如下:
将account、email、username、roomid、app_key(注意此处参数名为app_key而不是init方法中的appkey)以及signedat这些参数:
初始化主要错误码
对上述内容中所提appkey、app_key以及secret_key三个参数的说明:
appkey和app_key均表示添加应用后所得到的AppKey列对应的值
secret_key表示添加应用后所得到的SecretKey(注意与AppSecretKey区分)列对应的值
获取用户参会状态
初始化完成后可通过VHALL_SDK.onReady获取当前参会用户状态VHALL_SDK.userinfo对象下会有用户踢出状态,禁言状态,头像等信息。