风火轮小e开发板sdk包开发手册

1、J-SDKJ-SDK开发手册V易通（北京）科技发展官网地址：官网：开发快开发快官网1 / 43J-SDK文档修改开发快官网2 / 43版本号发布日期描述作者V2015-09-24创建文档HuangPengJuV2016-01-27更新接口名称，更新邀请接口参数 ，修改创建会场接口，增加表格图片代码编号YangXianZhi GuoHuaHuiV2016-01-28更新文档格式GuoHuaHuiV2016-03-02统一文档与 SDK 版本号,增加版本号 API 及修改删除群成员接口签名GuoHuaHui2016-03-07移

2、除添加用户示例代码中无用代码GuoHuaHui2016-03-11移除音APIGuoHuaHuiJ-SDK1. 简介为第消息、Web 应用提供相关 API 调用。通过 SDK 中的相关功能接口实现即时通信、文件传输等功能这是整合了消息接口，音接口和文件接口在一起的 SDK，隐藏了单个 SDK的一些逻辑细节，简化了 SDK 接口个数和使用的复杂度。1.1 缩略词APPKEY：用户为应用申请的码UID：用户为应用申请的用户编号，使用此编号进行登录Secretkey：用户申请时密钥JSDK：Javascript 版本的 SDK2. 接口协议2.1 接口功能描述本 SDK 接口有消息， 于浏览器上的通

3、信开发。订阅取消，音通信，文件传输等功能，用3. 接口说明3.1. 初始化环境初始化一个 et_cloud 类对象。这个类需要通过配置对象提供一些配置参数来初始化。如果参数没有配置将会产生异常。以下示例代码中的参数全是必须参数， 参数的详细说明请参看配置参数说明。示例代码：开发快官网3 / 43J-SDK示例代码 3.1-1初始化 SDK 环境3.2. 配置参数说明3.2.1.参数说明（1） imCallBack参数值是一个回调函数，函数的回调参数是来自 IM 的event，的类型由 IM 决定。类型如下：message、httpsucess、connect、reconnect、close、e

4、rror 样例代码：开发快官网4 / 43var config = imCallBack: onClientEvent, fileCallBack: onFileEvent;etCloud = new et_cloud(config);J-SDK示例代码 3.2-1IM回调（2） onFileEvent参数值是一个 数可以不实现 样例代码如下：回调函数，函数的回调参数是一个音。这个函示例代码 3.2-3文件回调开发快官网5 / 43function onFileEvent(event)function onClientEvent(event) if(event.type = 'mess

5、age')if(event.topic = 'chat')if(!userMapevent from_userid)varurl= ''getUser(event from_userid,url,function(data) if(data)var jsondata = $.parseJSON(data);userMapevent.from_userid = event from_userid; proecssMsg(event);elseproecssMsg(event););elseproecssMsg(event);if(event.topic =

6、 'chat_ex')userMapevent.from_userid = event.from_name; proecssMsg(event);else if(event.topic = 'http')else if(event.topic = 'sfile') console.log(event message.toString();var jsonMsg = $.parseJSON(event message.toString();var url = jsonMsg.url | 'http:/' + jsonMsg.ip +

7、 '/' + jsonMsg fileId;J-SDK3.3. 登录3.3.1.签名示例代码 3.3-13.3.2.输入参数说明表格 3.3-13.3.3.代码示例示例代码 3.3-26 / 43开发快官网var selfUserID = document.getElementById('username_ipt').value; var opt = username: selfUserID,appkey: document.getElementById('appkey_ipt').value, secretkey :"c7147f6f

8、ea0daf6cbd36ed65b037b4c9", balanceSever:"ws:/54:1885"etCloud.etConnect (opt);etCloud.Name = userMapselfUserID | selfUserID;参数名称是否必须类型描述opt是Objectopt = username: selfUserID, appkey: "cd71df", secretkey :"cf7a1", balanceSever:"ws:/ " clean:0usern

9、ame:是用户 ID appkey:是登录是的secretkey:(好友)http 服务的 key balanceSever:负责均衡URL Clean:0 清除离线消息，1 保留离线消息etConnect(opt)J-SDK3.4. 注销3.4.1.签名示例代码 3.4-13.4.2.输入参数说明表格 3.4-13.4.3.代码示例示例代码 3.4-23.5.点对点消息3.5.1.签名示例代码 3.5-13.5.2.输入参数说明开发快官网7 / 43etChatTo(opt,callback)etCloud.etDisconnect ();参数名称是否必须类型描述无etDisconnect(

10、)J-SDK表格 3.5-13.5.3.代码示例示例代码 3.5-23.6.点对点消息 Ex3.6.1.签名示例代码 3.6-13.6.2.输入参数说明开发快官网8 / 43参数名称是否必须类型描述opt是Objectopt= username:414, message: 'hello'etChatToEx(opt,callback)var chat_textarea = document.getElementById('chat_textarea'); var obj1 = username:getOtherName(), message:chat_texta

11、rea.value;etCloud.etChatTo (obj1,function(error) if(error)document.getElementById('panelBody-5').innerHTML+='<div class="chat_time">参数名称是否必须类型描述opt是Objectopt= username:414, message: 'hello'username:接收方的用户名message:消息内容callback是FunctionFunction(error)J-SDK表格 3.6-13.

12、6.3.代码示例示例代码 3.6-23.7.字节数组点对点消息3.7.1.签名示例码 3 7-13.7.2.输入参数说明表格 3.7-1开发快官网9 / 43参数名称是否必须类型描述opt是Objectopt= username:414, message: 0x7,0x00;username:接收方的用户名message:字节数组callback是FunctionFunction(error)etChatToByte(opt,callback)var chat_textarea = document.getElementById('chat_textarea'); var ob

13、j1 = username:getOtherName(), message:chat_textarea.value;etCloud.etChatToEx (obj1,function(error) if(error)document.getElementById('panelBody-5').innerHTML+='<divusername:接收方的用户名message:消息内容callback是FunctionFunction(error)J-SDK3.7.3.代码示例示例代码 3.7-23.8. 订阅用户状态3.8.1.签名示例代码 3 8-13.8.2.输入

14、参数说明表格 3.8-1开发快官网10 / 43参数名称是否必须类型描述opt是Objectopt= uesrid:416,;username:订阅用户方的用户名callback否FunctionFunction(event)etStateSubscribe(opt,callback)var chat_textarea = document.getElementById('chat_textarea'); var obj1 = username:getOtherName(), message:0x7f,0x00,0x04,0x00,0x29,0x00,0x01,0x31,0x3

15、2,0x33,0x34,0x35,0x36,0x37,0x38,0x39,0x30,0x31,0x32,0x33,0x34,0x35,0x36,0x00,0x01,0x02,0x58,0x89,0x3c,0x 06,0xf0,0x0d,0x9c,0x00,0x41,0x00,0x00,0x01,0x37,0x15,0x10,0x10,0x08,0x09,0x01,0x38,0x31,0x31,0xf9,0x7f;etCloud.etChatTo Byte(obj1,function(error) if(error)J-SDK3.8.3.代码示例示例代码 3.8-23.9. 取消订阅用户状态3.

16、9.1.签名示例代码 3.9-13.9.2.输入参数说明表格 3.9-1开发快官网11 / 43参数名称是否必须类型描述opt是Objectopt= userid:414,;username:取消用户方的用户名etStateUnsubscribe(opt)var opt= userid:getOtherName(),;etCloud.etStateSubscribe(opt,function(event) if(event.type = 'message')if(event message = 'friend_offline') document.getElem

17、entById('panelBody-5').innerHTML+='<divclass="chat_time"><span>'+event from_userid+'已下线'+'</span></div>'else if(event message = 'friend_online') document.getElementById('panelBody-5').innerHTML+='<divclass="

18、;chat_time"><span>'+event from_userid+'已上线'+'</span></div>');J-SDK3.9.3.代码示例示例代码 3.9-23.10.获取其他用户状态3.10.1.签名示例代码 3.10-13.10.2. 输入参数说明表格 3.10-1开发快官网12 / 43参数名称是否必须类型描述opt是Objectopt= userid:414, message:坑爹;userid:其他用户方的用户名message:用户昵称etGetOtherUserState(op

19、t)var obj1 = userid:getOtherName(),;etCloud.etStateUnsubscribe(obj1);J-SDK3.10.3. 代码示例示例代码 3.10-23.11.订阅全部好友状态3.11.1.签名示例代码 3.11-13.11.2. 代码示例示例代码 3.11-23.12. 取消订阅全部好友状态3.12.1.签名示例代码 3.12-1开发快官网13 / 43etUnSubscribeAllBuddies()etCloud.etSubscribeAllBuddies();etSubscribeAllBuddies()var obj1 = userid:g

20、etOtherName(),message:坑爹;etCloud.etGetOtherUserState(obj1);J-SDK3.12.2. 代码示例示例代码 3.12-23.13.获取好友列表扩展3.13.1.签名示例代码 3.13-13.13.2. 输入参数说明表格 3.13-13.13.3. 代码示例示例代码 3.13-2开发快官网14 / 43var obj1 = require:1;etCloud.etGetBuddysEx(obj1);参数名称是否必须类型描述opt是Objectopt= require:1;require:0:离线 1:，2:全体好友etGetBuddysEx(

21、opt)etCloud.etUnSubscribeAllBuddies();J-SDK3.14. 发版3.14.1.签名示例代码 3.14-13.14.2. 输入参数说明表格 3.14-13.14.3. 代码示例示例代码 3.14-23.15. 订阅3.15.1.签名示例代码 3.15-13.15.2. 输入参数说明表格 3.15-1开发快官网15 / 43参数名称是否必须类型描述topic是String名称etSubscribe(topic)etCloud. etPublish (opt);参数名称是否必须类型描述opt是objectOpt= topic:”title” message:”h

22、ello”etPublish(opt)J-SDK3.15.3. 代码示例示例代码 3.15-23.16. 取消订阅3.16.1.签名示例代码 3.16-13.16.2. 输入参数说明表格 3.16-13.16.3. 代码示例示例代码 3.16-23.17. 添加用户3.17.1.签名示例代码 3.17-1开发快官网16 / 43etAddUsers(obj,callback)etCloud.etUnsubscribe(topic);参数名称是否必须类型描述topic是String名称etUnsubscribe(topic)etCloud.etSubscribe(topic);J-SDK3.17

23、.2. 输入参数说明表格 3.17-13.17.3. 代码示例示例代码 3.17-2开发快官网17 / 43function etAddUsers()var obj = 'userlist':"username":"","platform_type":1,"name":"打小就很傻","username":"","platform_type":1,"name":"打小就很拽",&q

24、uot;username":"","platform_type":1,"name":"打小就很酷","username":"","platform_type":1,"name":"打小就很帅" etCloud.etAddUsers(obj ,function(json,status)var data = $.parseJSON(data) if(data.ret = 0)/添加用户console.log(d

25、ata.user);/user:"username":"","userid":11,"use rname":"","userid":22);参数名称是否必须类型描述obj是objectobj 含有俩个属性字段，分别为要添加的用户列表(obj.userlist:list)格式为： "username":"","platform_type":1,"name":"打小就很傻",&qu

26、ot;username":"","platform_type":1,"name":"打小就很拽" 其中 username 代表用户名称,platformtype 默认为1,name 为用户昵称callback是Function回掉函数参数是用户 id function(json,status)var data = $.parseJSON(data) if(data.ret = 0)/添加用户console.log(data.user);/user:"username":" &

27、quot;,"userid":11,"username":"","userid":22J-SDK3.17.4. data 格式示例代码 3.17-3 返回数据3.18. 拉取离线消息3.18.1.签名示例代码 3.18-13.18.2. 输入参数说明表格 3.18-1开发快官网18 / 43参数名称是否必须类型描述callback是Functionfunction onClientEvent(event) if(event.type = 'message') if (event.topic = &#

28、39;chat') /收到及时消息appendMsg(event.from_userid + ": "+ convertRecvMsg(event.message.toString();etOfflineMessage(callback)"ret":0,"message":"用户添加","user":"username":"","userid":11,"platformtype":1,"name&q

29、uot;:"","username":"1381238345","userid":22,"platformtype":2,"name":"","username":"","userid":33,"platformtype":7,"name":""J-SDK3.18.3. 代码示例示例代码 3.18-23.19. 添加好友3.19.1.签名

30、示例代码 3.19-13.19.2. 输入参数说明表格 3.19-1开发快官网19 / 43参数名称是否必须类型描述obj是objectobj 含有俩个属性字段，分别为要删除的 用户ID(obj.friendid:string)格式为：'friendid':"1"callback是Function回掉函数参数是用户 id function(json,status)var data = $.parseJSON(data) if(data.ret = 0)/删除用户etAddBuddy(obj,callback)function onClientEvent(ev

31、ent) if(event.type = 'message') if (event.topic = 'chat') /收到及时消息appendMsg(event.from_userid+":"+ convertRecvMsg(event.message.toString();else if(event.topic = 'chat_ex')appendMsg(event.from_name+":"+ convertRecvMsg(event.message.toString();J-SDK3.19.3. 代码

32、示例示例代码 3.19-23.19.4. data 格式示例代码 3.19-3返回数据3.20. 添加好友扩展（推送加好友请求信息）3.20.1.签名示例代码 3.20-1开发快官网20 / 43etAddBuddyEx(obj,callback)"ret":0,"message":"添加好友", "friendinfo":"userid":"""name":"""username":""/删除用

33、户function etAddBuddy()var obj= 'friendid':"1" etCloud.etAddBuddy(obj,function(data,status)var data = $.parseJSON(data) if(data.ret = 0)/添加好友);J-SDK3.20.2. 输入参数说明表格 3.20-13.20.3. 代码示例示例代码 3.20-2开发快官网21 / 43/添加好友function etAddBuddy()var obj= 'friendid':"1",'noti

34、fy':1;etCloud.etAddBuddyEx(obj,function(data,status) var data = $.parseJSON(data) if(data.ret = 0)/添加好友);参数名称是否必须类型描述obj是objectobj 含有俩个属性字段，分别为要删除的 用户ID(obj.friendid:string),是否通知(obj.notify:int /0 不通知,/非 0 通知)格式为：'friendid':"1",'notify':1callback是Function回掉函数参数是用户 id fu

35、nction(json,status)var data = $.parseJSON(data) if(data.ret = 0)/删除用户J-SDK3.20.4. data 格式示例代码 3.20-33.21. 删除好友3.21.1.签名示例代码 3.21-13.21.2. 输入参数说明表格 3.21-1开发快官网22 / 43参数名称是否必须类型描述obj是objectobj 含有俩个属性字段，分别为要删除的 用户ID(obj.friendid:string)格式为：'friendid':"1"callback是Function回掉函数参数是用户 id f

36、unction(json,status)var data = $.parseJSON(data) if(data.ret = 0)/删除用户etDeleteBuddy(obj,callback)"ret":0,"message":"添加好友", "friendinfo":"userid":"""name":"""username":""J-SDK3.21.3. 代码示例示例代码 3.21-23.2

37、1.4. data 格式示例代码 3.21-33.22. 删除好友扩展（推送删好友消息通知）3.22.1.签名示例代码 3.22-1开发快官网23 / 43etDeleteBuddyEx(obj,callback)"ret":0, "message":"删除好友", "friendinfo":"userid":"""name":"""username":""/删除用户function etDele

38、teBuddy()var obj= 'friendid':"1" etCloud.etDeleteBuddy(obj,function(data,status)var data = $.parseJSON(data) if(data.ret = 0)/删除好友);J-SDK3.22.2. 输入参数说明表格 3.22-13.22.3. 代码示例示例代码 3.22-23.22.4. data 格式示例代码 3.22-3开发快官网24 / 43"ret":0, "message":"删除好友", &quo

39、t;friendinfo":"userid":"""name":"""username":""/删除好友function etDeleteBuddyEx()var obj= 'friendid':"1",'notify':1;etCloud.etDeleteBuddyEx(obj,function(data,status) var data = $.parseJSON(data) if(data.ret = 0)/

40、删除好友);参数名称是否必须类型描述obj是objectobj 含有俩个属性字段，分别为要删除的 用户ID(obj.friendid:string),是否通知(obj.notify:int /0 不通知,/非 0 通知)格式为：'friendid':"1",'notify':1callback是Function回掉函数参数是用户 id function(json,status)var data = $.parseJSON(data) if(data.ret = 0)/删除用户J-SDK3.23. 创建群3.23.1.签名示例代码 3.23-1

41、3.23.2. 输入参数说明表格 3.23-13.23.3. 代码示例示例代码 3.23-2开发快官网25 / 43/删除用户function etCreateGroup()var obj= 'groupname':"技术",'other_userid':"1","2"etCloud.etCreateGroup(obj,function(data,status) var data = $.parseJSON(data) if(data.ret = 0)/创建群data.topic /群唯一标识);参数名

42、称是否必须类型描述obj是objectobj 含有俩个属性字段，分别为需要拉进群的用户 ID(obj.other_userid:list)，群名称(obj.groupname:string) 格式为：'groupname':"技术",'other_userid':"1","2"callback是Function回掉函数参数是用户 id function(json,status)var data = $.parseJSON(data) if(data.ret = 0)/创建群data.topic /群唯一

43、标识etCreateGroup(obj,callback)J-SDK3.23.4. data 格式示例代码 3.23-33.24. 获取群列表3.24.1.签名示例代码 3.24-13.24.2. 输入参数说明表格 3.24-1开发快官网26 / 43参数名称是否必须类型描述callback是Function回掉函数参数是用户 id function(json,status)var data = $.parseJSON(data) if(data.ret = 0)/获取群列表data.grouplist = "groupname":" 德","

44、topic":"b3a18210-9aef-250535","groupname":" ASD","topic":"c3118210-9aef-250535","groupna me":"艾","topic":"b3a18210-9aef-251235"etGetGroups(obj,callback)"ret":0,"message":"群创建"

45、, "groupinfo":"topic":"c3118210-9aef-250535","groupname":"德"J-SDK3.24.3. 代码示例示例代码 3.24-23.24.4. data 格式示例代码 3.24-33.25. 用户群3.25.1.签名示例代码 3.25-1开发快官网27 / 43etLogoutGroup(obj,callback)"ret":0,"message":"获取群列表""groupli

46、st":"groupname":"","topic":"b3a18210-9aef-250535","groupname":"","topic":"c3118210-9aef-250535","groupname":"","topic":"b3a18210- 9aef-251235"/删除用户function etGetGroups()var ob

47、j= 'groupname':"技术",'other_userid':"1","2"etCloud.etGetGroups(obj,function(data,status) var data = $.parseJSON(data) if(data.ret = 0)/创建群data.grouplist="groupname":"ad","topic":"b3a18210-9aef-250535","groupnam

48、e":"gj","topic":"c3118210-9aef-250535","groupname":"hgs","topic":"b3a18 210-9aef-251235");J-SDK3.25.2. 输入参数说明表格 3.25-13.25.3. 代码示例示例代码 3.25-23.25.4. data 格式示例代码 3.25-3开发快官网28 / 43"ret":0,"message":"退群

49、", "groupinfo":"topic":"b3a18210-9aef-250535", "groupname":""/删除用户function etLogoutGroup()var obj= topic:"c3118210-9aef-250535"etCloud.etLogoutGroup(obj,function(data,status) var data = $.parseJSON(data) if(data.ret = 0)/);参数名称是否必须类型描述

50、obj是objectobj 含有一个属性字段， 分别为群唯一标识(obj.topic:string)格式为：topic:"c3118210-9aef-250535"callback是Function回掉函数参数是用户 id function(json,status)var data = $.parseJSON(data) if(data.ret = 0)/J-SDK3.26. 群主注销群3.26.1.签名示例代码 3.26-13.26.2. 输入参数说明表格 3.26-13.26.3. 代码示例示例代码 3.26-2开发快官网29 / 43/删除用户function etR

51、eleaseGroup()var obj= topic:"c3118210-9aef-250535"etCloud.etReleaseGroup(obj,function(data,status) var data = $.parseJSON(data) if(data.ret = 0)/注销);参数名称是否必须类型描述obj是objectobj 含有一个属性字段， 分别为群唯一标识(obj.topic:string)格式为：topic:"c3118210-9aef-250535"callback是Function回掉函数参数是用户 id functio

52、n(json,status)var data = $.parseJSON(data) if(data.ret = 0)/注销etReleaseGroup(obj,callback)J-SDK3.26.4. data 格式示例代码 3.26-33.27. 添加群成员3.27.1.签名示例代码 3.27-13.27.2. 输入参数说明表格 3.27-1开发快官网30 / 43参数名称是否必须类型描述obj是objectobj 含有俩个属性字段， 分别为群唯一标识(obj.topic:string), 需 要 添 加 的 用 户 列 表ID(obj.userlist.list)格式为：topic:&

53、quot;c3118210-9aef-250535",'userlist':"3","4"callback是Function回掉函数参数是用户 id function(json,status)var data = $.parseJSON(data) if(data.ret = 0)/添加etAddGroupMember(obj,callback)"ret":0,"message":"注销群", "groupinfo":"topic"

54、;:"b3a18210-9aef-250535", "groupname":"德"J-SDK3.27.3. 代码示例示例代码 3.27-23.27.4. data 格式示例代码 3.27-33.28. 删除群成员3.28.1.签名示例代码 3.28-1开发快官网31 / 43etDeleteGroupMember(obj,callback)"ret":0,"message":"添加""groupname":"""userlis

55、t":"userid":"11","name","","username":"","userid":"21","nickname","","username":""/删除用户function etAddGroupMember()var obj= topic:"c3118210-9aef-250535",'userlist

56、':"3","4"etCloud.etAddGroupMember(obj,function(data,status)var data = $.parseJSON(data) if(data.ret = 0)/添加);J-SDK3.28.2. 输入参数说明表格 3.28-13.28.3. 代码示例示例代码 3.28-2开发快官网32 / 43/删除用户function etDeleteGroupMember ()var obj= topic:"c3118210-9aef-250535",'userlist':&

57、quot;3","4"etCloud. etDeleteGroupMember (obj,function(data,status)var data = $.parseJSON(data) if(data.ret = 0)/删除);参数名称是否必须类型描述obj是objectobj 含有俩个属性字段， 分别为群唯一标识(obj.topic:string), 需 要 添 加 的 用 户 列 表ID(obj.userlist.list)格式为：topic:"c3118210-9aef-250535",'userlist':"

58、;3","4"callback是Function回掉函数参数是用户 id function(json,status)var data = $.parseJSON(data) if(data.ret = 0)/添加J-SDK3.28.4. data 格式示例代码 3.28-33.29. 获取群成员列表3.29.1.签名示例代码 3.29-13.29.2. 输入参数说明表格 3.29-1开发快官网33 / 43参数名称是否必须类型描述obj是objectobj 含有俩个属性字段， 分别为群唯一标识(obj.topic:string)格式为：topic:"c3118210-9aef-250535"callback是Function回掉函数参数是用户 id function(json,status)var data = $.parseJSON(data) if(data.ret = 0)/添加etGetGroupMembers(obj,callback)"ret":0,"message":"删除","groupname":"""userlist":"userid":"