开发指南

1、HTML5 SDK集成指南                

1.1、引入sdk                

开发者集成云通讯H5_SDK,需要先引入H5_SDK。即在您的页面中引入如下代码:

                

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

                                 

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

                                

SDK接口说明请参阅《SDK接口说明》。

注意:SDK自5.4.0版本开始,去掉了jQuery库,如果您的项目中有用到,请自行导入。

1.2、H5浏览器兼容性说明

1.H5浏览器支持IM功能情况

IE浏览器要求IE10及以上才支持,发送附件要求IE11才支持;Chrome浏览器需要40版本以上内核支持;Firefox浏览器建议50版本以上。

2.H5浏览器支持音视频功能情况

(1) HTTP协议点对点音视频只支持谷歌浏览器(44,45,46稳定版);HTTPS协议支持Chrome40以上所有版本(推荐使用Chrome47以上版本)及Firefox最新版本,支持Edge浏览器40以上。

(2)Android:必须为HTTPS协议。

Android Webkit 53以上支持音视频功能。

webview是安卓原生代码里用于显示html代码的地方,内核为webkit,与谷歌浏览器的内核相同。支持微信和QQ内置浏览器。

(3) IOS:必须为HTTPS协议

目前仅支持ios11的safari浏览器

3.不同终端测试H5点对点音视频总结说明

(1)安卓端浏览器(谷歌、火狐、微信)与IOS Safari相互之间,由于支持编码不同,暂不支持通讯。

(2)安卓端浏览器(谷歌、微信)与MAC Safari相互之间音频通话正常,视频通话无法建立。

(3)由于PC和IOS端微信不支持H5音视频功能,因此未进行统计。

 该测试结果仅供参考

                   被叫
主叫
                 安卓端IOSWindows
                    MAC快聊
谷歌火狐微信Safari谷歌火狐Safari谷歌火狐安卓iOS
安卓端谷歌× ××
火狐× ×
微信×××
iOSSafari×××××
Windows
谷歌××
火狐
MACSafari×××
谷歌×××
火狐×
快聊安卓×
iOS×

测试设备说明:

安卓机型:三星S5(6.0.1)  、(华为)BLN-AL40 7.0

谷歌版本:62.0

火狐版本:57.0.1

微信版本:6.6.1

 

IOS机型:7PLUS

系统:11.2.1

Safari版本:11.2.1

 

Windows系统:win10

谷歌版本:63.0.3239.108

火狐版本:57.0.4

MAC系统:10.12.6

Safari版本:11.0.2

谷歌版本:63.0.3239.84

火狐版本:57.0.1

                       

4.H5_SDK提供音视频功能,如果需要使用该功能,请注意:                                 

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

                                                       

在demo中替换appid说明:

使用demo替换成自己的appid需要修改的地方:

sig要自己重新计算,sig计算规则:MD5(appid+userName+timestamp(yyyyMMddHHmmss)+apptoken);                                 

appid和apptoken是用户在我们控制台创建的应用的,测试音视频的话,应用需要在控制台上线,时间戳建议每次获取登录的系统时间,3rd的地方写客户端计算sig的地址就可以;如果本地计算sig进行测试,直接在demo中justdo.js中进行如下修改即可测试:                             

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

(2)._appToken = '17E24E5AFDB6D0C1EF32F3533494502B';//使用是赋值为应用对应的appToken,换成自己的应用token。                   

(3).flag = true;//是否从第三方服务器获取sig。flag置为false,则需要本地计算sig。  

                               

2、请求回调和通知回调

                

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

                

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

                

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