1、HTML5 SDK集成指南

1.1、引入sdk

开发者集成云通讯H5_SDK,需要先引入H5_SDK。即在您的页面中引入ytx-web-im.min-new.js。

Http环境引入代码: <script src="http://app.cloopen.com/im50/ytx-web-im-min-new.js"></script>

Https环境引入代码: <script src="https://app.cloopen.com/im50/ytx-web-im-min-new.js"></script>

注:SDK接口说明请参阅《SDK接口说明》

备注:

(1)H5基本功能以及音视频的兼容性:

a、H5浏览器支持IM功能情况:IE浏览器要求IE9(不含)以上才支持,发送附件要求IE11才支持;Chrome浏览器需要40版本以上内核支持;Firefox浏览器建议50版本以上。

b、H5浏览器支持音视频功能情况:HTTP环境点对点音视频只支持谷歌浏览器(38,44,45,46稳定版),HTTPS环境支持Chrome38以上所有版本及Firefox最新版本(推荐使用Chrome47以上版本)。

c、H5暂不支持和老平台3.6.4互通。

(2)H5_SDK提供音视频功能,如果需要使用该功能,请注意以下三点:

a、音视频功能需要在web环境下使用,需要将本项目部署在tomcat等web容器中才可以使用。

b、demo中配置的默认appid不支持H5的音视频功能,如需使用请修改为自己的appid,并将appid提交给技术支持申请。

c、chrome47以上版本和firefox浏览器需要HTTPS环境才能使用音视频功能

说明:
使用demo替换成自己的appid需要修改的地方,sig要自己重新计算,sig计算规则:MD5(appid+userName+timestamp(yyyyMMddHHmmss)+apptoken); appid和apptoken是用户在我们控制台创建的应用的,测试音视频的话,应用需要在控制台上线,并且提供appid给我们配置,时间戳不要写死,是每次获取登录的系统时间,3rd的地方写客户端计算sig的地址就可以;如果本地计算sig进行测试,直接在demo中justdo.js中进行如下修改即可测试:

(1)._appid : '20150314000000110000000000000010', // 应用ID,换成自己的应用id;

(2)_login : function(user_account,pwd)方法中, var flag = true;//是否从第三方服务器获取sig,flag置为false,else判断中注释代码放开,var appToken = '17E24E5AFDB6D0C1EF32F3533494502B';//使用是赋值为应用对应的appToken,换成自己的应用token。

2、请求回调和通知回调

H5_SDK中和服务端的交互采取异步回调方法,有两种异步回调方法,一种是请求回调方法,一种是通知回调方法,详细介绍如下:

(1)请求回调方法:即由用户主动发出一个操作请求,请求的结果在回调中返回。具体说就是在调用H5_SDK的方法时,H5_SDK的方法参数中有回调方法,请求的结果直接在参数的回调方法中处理。例如发送消息的方法,包含获知消息发送成功和发送失败的回调,此方法就是请求回调方法。

(2)通知回调方法:通知回调是指由云通讯服务端主动给客户端发送的信令或业务消息,如接收消息,就是由服务端通知应用来收消息,此方法就是通知回调方法。

文档更新时间:2017年5月16日