WEB IM SDK接口说明

本文档主要为开发人员使用,介绍IM相关H5的接口,如无特别说明,所有方法的返回值均为object对象。

1、初始化SDK

方法

RL_YTX.init(appId,webserver,lvsServer,sig)

参数说明

参数名

必选

说明

appId

应用appid,第三方注册时分配

webServer

(私有云)WebSocket服务器地址 格式为 ip:port

lvsServer

(私有云)附件下载服务器地址 格式为 ip:port

fileSig

(私有云)fileSig规则 MD5(公司ID+公司密码)

返回值

obj

obj.code

调用结果

obj.msg

消息提示

obj.unsupport

不支持功能,数组类型,以错误码形式返回

2、登陆

方法

RL_YTX.login(LoginBuilder, callback, onError)

参数说明

参数名

必选

说明

LoginBuilder

RL_YTX. LoginBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(obj){

obj.authState; //Kick Off 是否被踢下线 可为空

obj.kickoffText; //Kick Off 被踢下线的提示信息 可为空

obj.connectorId; //鉴权成功后,返回连接器编号

obj.version; //服务器消息最大版本号

obj.pversion; //个人资料版本号

obj.softVersion; //软件最新版本号

obj.historyver; //离线消息开始版本号

obj.authToken; //精简认证Token

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

3、登出

方法

RL_YTX.logout(callback, onError)

参数说明

参数名

必选

说明

callback

成功回调

function callback(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

4、IM消息监听

方法

RL_YTX. onMsgReceiveListener(callback)

参数说明

参数名

必选

说明

callback

通知回调

function callback(obj){

obj.version; //消息版本号

obj.msgType; //消息类型1:文本消息 2:语音消息 3:视频消息 4:图片消息 5:位置消息 6:压缩文件 7:非压缩文件 11:群组发送@消息 12:状态消息

obj.msgContent; //文本消息内容

obj.msgSender; //发送者

obj.msgReceiver; //接收者群组Im消息时,接收者为群组id

obj.msgDomain; //扩展信息

obj.msgFileName; //消息文件名

obj.msgFileUrl; //消息下载地址

obj.msgDateCreated; //服务器接收消息时间

obj.senderNickName; //发送者昵称

obj.mcmEvent;//是否MCM消息 0普通消息 1 start消息 2 end消息 53 发送mcm消息

obj.msgFileSize;//附件大小

obj.isAtMsg;//群组@类型消息 true/false

}

返回值

5、多渠道消息监听

方法

RL_YTX. onDeskMsgReceiveListener(callback)

参数说明

参数名

必选

说明

callback

通知回调

function callback(obj){

obj.version; //消息版本号

obj.msgType; //消息类型1:文本消息 2:语音消息 3:视频消息 4:图片消息 5:位置消息 6:文件

obj.msgContent; //文本消息内容

obj.msgSender; //发送者

obj.msgReceiver; //接收者群组Im消息时,接收者为群组id

obj.msgDomain; //扩展信息

obj.msgFileName; //消息文件名

obj.msgFileUrl; //消息下载地址

obj.msgDateCreated; //服务器接收消息时间

obj.senderNickName; //发送者昵称

obj.mcmEvent; // mcm消息类型 1 start消息 2 end消息 3发送mcm消息

obj.msgFileSize;//附件大小

}

返回值

6、指令(群组通知)消息监听

方法

RL_YTX. onNoticeReceiveListener(callback)

参数说明

参数名

必选

说明

callback

通知回调,具体说明请参考 附录中的群组通知参数说明

function callback(obj){

obj.auditType;//1申请加入群组,2邀请加入群组, 3直接加入群组,4解散群组,5退出群组,6踢出群组,7确认申请加入,8确认邀请加入,10管理员修改群组信息, 11用户修改群组成员名片)

obj.groupId; //群组id

obj.groupName; //群组名称

obj.declared; //操作描述

obj.member; //成员账号

obj.admin; //管理员账号

obj.adminName; //管理员昵称

obj.memberName; //成员昵称

obj.confirm; //操作(1:拒绝2:同意 注意:管理员邀请时1为同意)

obj.version; //消息版本号

obj.serviceNo; //服务号

obj.ext; //扩展字段

}

返回值

7、连接状态变更

方法

RL_YTX. onConnectStateChangeLisenter(callback)

参数说明

参数名

必选

说明

callback

通知回调

function callback(obj){

obj.code;//变更状态 1 断开连接 2 重练中 3 重练成功 4 被踢下线 5 用户被后台踢掉(比如请求太频繁,后台把连接断了)

obj.msg;//消息提示

}

返回值

8、获取个人消息

方法

RL_YTX. getMyInfo(callback, onError)

参数说明

参数名

必选

说明

callback

成功回调

function callback(){

obj.version; //个人信息版本号

obj.nickName; //昵称

obj.sex; //性别 1男 2女

obj.birth; //生日 格式 2015-12-31

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

9、设置个人信息

方法

RL_YTX. uploadPersonInfo(uploadPersonInfoBuilder,callback, onError)

参数说明

参数名

必选

说明

UploadPersonInfoBuilder

RL_YTX.UploadPersonInfoBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(obj){

obj.version; //个人信息版本号

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

10、发送消息

方法

RL_YTX.sendMsg(MsgBuilder, callback, onError)

参数说明

参数名

必选

说明

MsgBuilder

RL_YTX. MsgBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(obj){

obj.msgId; //客户传入消息msgId(已废弃)

obj.msgClientNo // SDK生成的发送者消息id

}

onError

失败回调

function onError(obj){

obj.code //错误码

obj.msgId //客户传入消息msgId

obj.msgClientNo // SDK生成的发送者消息id

}

progress

发送附件时的上传进度回调

function progress(sended,,total,msgClientNo){

sended;//已发送字节数

total;//总字节数

msgClientNo;// SDK生成的发送者消息id

}

返回值

11、创建群组

方法

RL_YTX. createGroup(CreateGroupBuilder, callback, onError)

参数说明

参数名

必选

说明

CreateGroupBuilder

RL_YTX. CreateGroupBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(obj){

obj.data;//群组groupId

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

12、解散群组

方法

RL_YTX. dismissGroup(DismissGroupBuilder, callback, onError)

参数说明

参数名

必选

说明

DismissGroupBuilder

RL_YTX. DismissGroupBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

13、邀请用户加入群组

方法

RL_YTX. inviteJoinGroup(InviteJoinGroupBuilder, callback, onError)

参数说明

参数名

必选

说明

InviteJoinGroupBuilder

RL_YTX. InviteJoinGroupBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

邀请失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

14、处理群组邀请

方法

RL_YTX. confirmInviteJoinGroup(ConfirmInviteJoinGroupBuilder, callback, onError)

参数说明

参数名

必选

说明

ConfirmInviteJoinGroupBuilder

RL_YTX. ConfirmInviteJoinGroupBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

处理失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

15、申请加入群组

方法

RL_YTX. joinGroup(JoinGroupBuilder, callback, onError)

参数说明

参数名

必选

说明

JoinGroupBuilder

RL_YTX. JoinGroupBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

申请失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

16、处理加入申请

方法

RL_YTX. confirmJoinGroup(ConfirmJoinGroupBuilder, callback, onError)

参数说明

参数名

必选

说明

ConfirmJoinGroupBuilder

RL_YTX. ConfirmJoinGroupBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

处理失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

17、退出群组

方法

RL_YTX. quitGroup(QuitGroupBuilder, callback, onError)

参数说明

参数名

必选

说明

QuitGroupBuilder

RL_YTX. QuitGroupBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

18、修改群组成员角色

方法

RL_YTX.setGroupMemberRole(SetGroupMemberRoleBuilder, callback, onError)

参数说明

参数名

必选

说明

SetGroupMemberRoleBuilder

RL_YTX.SetGroupMemberRoleBuilder对象 参考附录中发送请求参数说明

callback

成功回调function callback(){}

onError

失败回调

失败回调function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

19、踢出群组成员

方法

RL_YTX. deleteGroupMember(DeleteGroupMemberBuilder, callback, onError)

参数说明

参数名

必选

说明

DeleteGroupMemberBuilder

RL_YTX. DeleteGroupMemberBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

20、分页获取群组列表

方法

RL_YTX. getGroupList(GetGroupListBuilder, callback, onError)

参数说明

参数名

必选

说明

GetGroupListBuilder

RL_YTX. GetGroupListBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(obj){

for(var i in obj){//群组列表数组

var simple = obj[i];

simple.groupId; //群组id

simple.name; //群组名称

simple.owner;//群组创建者

simple.permission;//群组权限 1:默认可直接加入 2:需要身份验证 3:私有群组(不能主动加入,仅能管理员邀请)

simple.isNotice; //是否提醒 1:提醒;2:不提醒

simple.memberCount;//群组人数

simple.scope;//群组规模 1:临时组(上限100人) 2普通组(上限300人)3:普通组(上限500人) 4:付费普通组 (上限1000人) 5:付费VIP组(上限2000人)

simple.dateCreated;//群组创建时间

simple.target;//群组模式 1讨论组 2 普通群组

}

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

21、分页获取群组成员

方法

RL_YTX. getGroupMemberList(GetGroupMemberListBuilder, callback, onError)

参数说明

参数名

必选

说明

GetGroupMemberListBuilder

RL_YTX. GetGroupMemberListBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(obj){

for(var i in obj){//群组成员列表

var member = obj[i];

member.member;//成员id

member.nickName;//昵称

member.speakState;//禁言状态 1:不禁言 2:禁言

member.role;//角色 1:创建者 2:管理员 3:成员

member.sex;//性别 1:男 2:女

}

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

22、群组成员禁言

方法

RL_YTX. forbidMemberSpeak(ForbidMemberSpeakBuilder, callback, onError)

参数说明

参数名

必选

说明

ForbidMemberSpeakBuilder

RL_YTX. ForbidMemberSpeakBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

23、获取群组成员名片

方法

RL_YTX. queryGroupMemberCard(QueryGroupMemberCardBuilder, callback, onError)

参数说明

参数名

必选

说明

QueryGroupMemberCardBuilder

RL_YTX.QueryGroupMemberCardBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(obj){

obj.member; //成员id

obj.groupid; //群组id

obj.display; //成员昵称

obj.phone; //成员手机号

obj.mail; //成员邮箱

obj.remark; //成员备注

obj.speakState; //成员禁言状态 1:未禁言 2:禁言

obj.role; //成员角色 1:创建者 2:管理员 3:成员

obj.sex; //成员性别 1:男 2:女

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

24、修改群组成员名片

方法

RL_YTX. modifyMemberCard (ModifyMemberCardBuilder, callback, onError)

参数说明

参数名

必选

说明

ModifyMemberCardBuilder

RL_YTX. ModifyMemberCardBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

25、搜索群组

方法

RL_YTX. searchGroups(SearchGroupsBuilder, callback, onError)

参数说明

参数名

必选

说明

SearchGroupsBuilder

RL_YTX. SearchGroupsBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(obj){

for(var i in obj){//群组列表

var simple = obj[i];

simple.groupId; //群组id

simple.name; //群组名称

simple.owner;//群组创建者

simple.declared;//群组公告

simple.isNotice; //是否提醒 1:提醒;2:不提醒

simple.memberCount;//群组人数

simple.scope;//群组规模 1:临时组(上限100人) 2普通组(上限300人)3:普通组(上限500人) 4: 付费普通组 (上限1000人) 5:付费VIP组(上限2000人)

}

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

26、获取群组详情

方法

RL_YTX. getGroupDetail(GetGroupDetailBuilder, callback, onError)

参数说明

参数名

必选

说明

GetGroupDetailBuilder

RL_YTX. GetGroupDetailBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(obj){

obj.creator; //创建者

obj.groupName; //群组名称

obj.type; //群组类型

obj.province; //省份

obj.city; //城市

obj.scope; //群组大小

obj.declared; //群组公告

obj.dateCreated; //创建时间

obj.numbers; //群组人数

obj.isNotice; //是否免打扰

obj.permission; //群组权限 1:默认可直接加入 2:需要身份验证 3:私有群组(不能主动加入,仅能管理员邀请)

obj.groupDomain; //扩展信息

obj.isApplePush; //是否苹果离线推送

obj.target;//群组模式 1讨论组 2普通群组

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

27、修改群组信息

方法

RL_YTX. modifyGroup(ModifyGroupBuilder, callback, onError)

参数说明

参数名

必选

说明

ModifyGroupBuilder

RL_YTX. ModifyGroupBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

28、群组消息推送设置

方法

RL_YTX. setGroupMessageRule(SetGroupMessageRuleBuilder, callback, onError)

参数说明

参数名

必选

说明

SetGroupMessageRuleBuilder

RL_YTX. SetGroupMessageRuleBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

29、获取解压缩后的附件

方法

RL_YTX.getFileSource(url, callback, onError)

参数说明

参数名

必选

说明

url

压缩附件的服务器的位置

callback

成功回调function callback(obj){

Obj.url //解压缩或的附件的路径

}

onError

失败回调失败回调function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

30、获取用户在线状态

方法

RL_YTX. getUserState(GetUserStateBuilder, callback, onError)

参数说明

参数名

必选

说明

GetUserStateBuilder

RL_YTX. GetUserStateBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(obj){

obj.useracc;//用户账号

obj.state;//在线状态 1:在线 2:离线 当用户为离线状态时,obj.state,obj.network和obj.device为undefined

obj.network;//被查询人员的网络状态 1:WIFI 2:4G 3:3G 4:2G 5:INTERNET 6:other

obj.device;//终端类型 1:Android 2:iPhone 10:iPad 11:Android Pad 20:PC 21:H5

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

32、阅后即焚

方法

RL_YTX.deleteReadMsg(DeleteReadMsgBuilder, callback, onError)

参数说明

参数名

必选

说明

DeleteReadMsgBuilder

RL_YTX. DeleteReadMsgBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

33、阅后即焚操作通知

方法

RL_YTX.onMsgNotifyReceiveListener(callback)

参数说明

参数名

必选

说明

callback

成功回调

function callback(obj){

obj.msgType;//消息类型

obj.sender;//删除操作者

obj.msgId;//消息id

obj.dateCreated;//创建时间

}

返回值

34、设置音视频展示标签

方法

RL_YTX.setCallView(view,localView)

参数说明

参数名

必选

说明

view

对方视频展示的HTML标签

localView

本地视频展示的HTML标签

备注

发起或接受音视频消息前需要调用该接口

35、发送音视频请求

方法

RL_YTX.makeCall(MakeCallBuilder, callback, onError)

参数说明

参数名

必选

说明

MakeCallBuilder

RL_YTX.MakeCallBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

36、接收音视频请求

方法

RL_YTX.accetpCall(AcceptCallBuilder, callback, onError)

参数说明

参数名

必选

说明

AcceptCallBuilder

RL_YTX.AcceptCallBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

37、拒绝音视频请求

方法

RL_YTX.rejectCall(RejectCallBuilder, callback, onError)

参数说明

参数名

必选

说明

RejectCallBuilder

RL_YTX.RejectCallBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

38、取消音视频

方法

RL_YTX.releaseCall(ReleaseCallBuilder, callback, onError)

参数说明

参数名

必选

说明

ReleaseCallBuilder

RL_YTX. ReleaseCallBuilder对象 参考附录中发送请求参数说明

callback

成功回调

function callback(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

39、音视频消息通知

方法

RL_YTX.onCallMsgListener(callback)

参数说明

参数名

必选

说明

callback

function(obj){

obj.callId;

obj.caller;

obj.called;

obj.callType;//0 音频 1 视频

obj.userdata;//自定义参数

obj.state;//1 对方振铃 2 呼叫中 3 被叫接受 4 呼叫失败 5 结束通话 6有新的呼叫 7(被叫)已经建立音视频连接

obj.reason;//失败原因

obj.code;//状态码 200为成功,其他表示因本地原因无法接受音视频请求(例如不支持音视频),具体原因请参照错误码

}

40、准备拍照

方法

RL_YTX.photo.apply(obj, onCanPlay, onError)

参数说明

参数名

必选

说明

obj

Object对象,obj.tag DOM对象,表示预览图片的video标签

onCanPlay

媒体流准备就绪,可以进行拍照的通知回调

function onCanPlay(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

41、拍照

方法

RL_YTX.photo.make()

参数说明j

参数名

必选

说明

ob

obj.code

操作状态码 200表示成功,其他为失败

obj.blob

拍照成功返回的blob对象

obj.msg

操作失败的错误信息

42、取消拍照

方法

RL_YTX.photo. cancel()

参数说明j

参数名

必选

说明

ob

obj.code

操作状态码 200表示成功,其他为失败

43、准备录音

方法

RL_YTX.audio.apply(obj, onCanPlay, onError)

参数说明

参数名

必选

说明

obj

Object对象,obj.tag DOM对象,表示预览录音的audio标签

onCanPlay

媒体流准备就绪,可以进行录音的通知回调

function onCanPlay(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

44、录音

方法

RL_YTX.audio.make()

参数说明j

参数名

必选

说明

ob

obj.code

操作状态码 200表示成功,其他为失败

obj.blob

录音成功返回的blob对象

obj.msg

操作失败的错误信息

45、取消录音

方法

RL_YTX.audio.cancel()

参数说明j

参数名

必选

说明

ob

obj.code

操作状态码 200表示成功,其他为失败

46、消息撤回

方法

RL_YTX. msgBack (MsgBackBuilder,callback,onError)

参数说明

参数名

必选

说明

MsgBackBuilder

RL_YTX.MsgBackBuilder对象 参考附录中发送请求参数说明

callback

操作状态码 200表示成功

function onCanPlay(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

47、消息已读

方法

RL_YTX. msgRead (MsgReadBuilder,callbacsk,onError)

参数说明

参数名

必选

说明

MsgReadBuilder

RL_YTX.MsgReadBuilder对象 参考附录中发送请求参数说明

callback

操作状态码 200表示成功,其他为失败

function onCanPlay(){

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

48、日志关闭

方法

RL_YTX.setLogClose()

返回值

49、进入聊天室

方法

RL_YTX.enterChatroom(EnterChatroomBuilder,callback,onerror)

参数说明

参数名

必选

说明

EnterChatroomBuilder

RL_YTX. EnterChatroomBuilder对象 参考附录中发送请求参数说明

callback

登录成功回调function callback(obj){

obj.allSilence; //是否全员禁言

obj.creator; //房主ID

obj.enterTime; //加入时间

obj.keepSilence; //是否被禁言

obj. notice; //提示信息

obj.onlineCount; //在线总人数

obj.roomExt; //房间拓展字段。需自行base64解密

obj.url//直播地址

obj.roomNickname; //房间名称

obj.userRole //用户角色(1 创建者 2 管理员 3 普通用户)

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

50、退出聊天室

方法

RL_YTX.exitChatroom(exitChatroomBuilder,callback,onerror);

参数说明

参数名

必选

说明

ExitChatroomBuilder

RL_YTX.ExitChatroomBuilder对象 参考附录中发送请求参数说明

callback

登录成功回调function callback(obj){

obj.code//错误代码。200为成功

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

51、获取聊天室信息

方法

RL_YTX.fetchChatroomInfo(fetchChatroomInfoBuilder,callback,onerror);

参数说明

参数名

必选

说明

FetchChatroomInfoBuilder

RL_YTX.FetchChatroomInfoBuilder对象 参考附录中发送请求参数说明

callback

登录成功回调function callback(obj){

obj.allSilence; //是否全员禁言

obj.creator; //房主ID

obj.notice; //提示信息

obj.onlineCount; //在线总人数

obj.roomExt; //房间拓展字段。需自行base64解密

obj.roomNickname; //房间名称

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

52、修改聊天室信息

方法

RL_YTX.updateChatroomInfo(updateChatroomInfoBuilder,callback,onerror);

参数说明

参数名

必选

说明

UpdateChatroomInfoBuilder

RL_YTX. UpdateChatroomInfoBuilder对象 参考附录中发送请求参数说明

callback

登录成功回调function callback(obj){

obj.code//错误代码。200为成功

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

53、获取聊天室成员

方法

RL_YTX.fetchChatroomMembers(fetchChatroomMembersBuilder,callback,onerror);

参数说明

参数名

必选

说明

FetchChatroomMembersBuilder

RL_YTX.FetchChatroomMembersBuilder对象 参考附录中发送请求参数说明

callback

登录成功回调function callback(obj){

[arr.enterTime //加入时间

arr.infoExt//扩展字段

arr.muteDuration//禁言时长

arr.nickName//个人昵称

arr.state// 1.禁言 2.取消禁言 3.拉黑 4.取消拉黑 默认0

arr.userId //用户id]

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

54、聊天室角色管理

方法

RL_YTX.updateChatRoomMemberRole(UpdateChatRoomMemberRoleBuilder,callback,onerror);

参数说明

参数名

必选

说明

UpdateChatRoomMemberRoleBuilder

RL_YTX. UpdateChatRoomMemberRoleBuilder对象 参考附录中发送请求参数说明

callback

登录成功回调function callback(obj){

obj.code//错误代码。200为成功

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

55、踢出成员

方法

RL_YTX.kickMember(kickMemberBuilder,callback,onerror);

参数说明

参数名

必选

说明

kickMember

RL_YTX. kickMember对象 参考附录中发送请求参数说明

callback

登录成功回调function callback(obj){

obj.code//错误代码。200为成功

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

56、聊天室全员禁言/解除禁言

方法

RL_YTX.AllMuteMode(allMuteBuilder,callbak,onerror)

参数说明

参数名

必选

说明

AllMuteMode

RL_YTX.AllMuteMode对象 参考附录中发送请求参数说明

callback

登录成功回调function callback(obj){

obj.code//错误代码。200为成功

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

57、拉黑成员

方法

RL_YTX.defriendMember(defriendMemberBuilder,callback,onerror)

参数说明

参数名

必选

说明

DefriendMemberBuilder

RL_YTX. DefriendMemberBuilder对象 参考附录中发送请求参数说明

callback

登录成功回调function callback(obj){

obj.code//错误代码。200为成功

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

58、禁言成员

方法

RL_YTX.forbidChatRoomMember(forbidChatRoomMemberBuilder,callback,onerror)

参数说明

参数名

必选

说明

ForbidChatRoomMemberBuilder

RL_YTX. ForbidChatRoomMemberBuilder对象 参考附录中发送请求参数说明

callback

登录成功回调function callback(obj){

obj.code//错误代码。200为成功

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

59、修改个人信息

方法

RL_YTX.updateMyChatroomMemberInfo(updateMyChatroomMemberInfoBuilder,callback,onerror);

参数说明

参数名

必选

说明

UpdateMyChatroomMemberInfoBuilder

RL_YTX. UpdateMyChatroomMemberInfoBuilder对象 参考附录中发送请求参数说明

callback

登录成功回调function callback(obj){

obj.code//错误代码。200为成功

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

60、消息置顶

方法

RL_YTX.setTopContact(setTopContactBuilder,callback,onError)

参数说明

参数名

必选

说明

GetRecentContactListBuilder

RL_YTX. GetRecentContactListBuilder对象 参考附录中发送请求参数说明

callback

登录成功回调function callback(obj){

obj.code//错误代码。200为成功

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

61、获取置顶列表

方法

RL_YTX. getTopContact (callback,onError)

参数说明

参数名

必选

说明

callback

成功回调function callback(arr){ //返回值为置顶联系人账号数组

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

63、播放AMR音频文件

方法

RL_YTX.getAudioSource(msgFileUrl,callback,onError)

参数说明

参数名

必选

说明

msgFileUrl

服务器推送的amr文件url

callback

登录成功回调function callback(obj){

//返回值为可播放的amr音频地址

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

64、聊天室通知消息

方法

RL_YTX. onCharRoomEventLinstener (callback)

参数说明

参数名

必选

说明

callback

登录成功回调function callback(obj){

if(obj.type === 1){//有用户加入

}else if(obj.type === 2){//修改聊天室通知

}else if(obj.type === 3){//设置角色通知

}else if(obj.type === 4){//有用户被踢出

}else if(obj.type === 5){//有用户退出

}else if(obj.type === 6 ){// 全员禁言

}else if(obj.type === 7){//聊天室全员取消禁言

}else if(obj.type === 8){//单人禁言

}else if(obj.type === 9){//成员取消禁言

}else if(obj.type === 10){//拉入黑名单

}else if (obj.type === 11){//成员取消拉黑

}else if(obj.type === 12){//聊天室关闭

}else if(obj.type === 14){//修改聊天室信息

}

}

onError

失败回调

function onError(obj){

obj. code //错误码

obj.msg //错误描述

}

返回值

61、附录

(1)发送请求参数说明

所有的请求对象中,若无特殊说明,均有两种初新建方式。
第一种为在初始化对象时对此参数直接赋值,
第二种为在初始化一个空对象后,使用setField的方式进行赋值
obj.setField方式可以将第一种新建对象的属性值覆盖
例:
MsgBuilder: RL_YTX. MsgBuilder含有6个属性:
id(客户端消息id 必选)
text:文本内容 必选
file:附件对象 必选
type:发送消息类型 必选
receiver:接受者 必选
domain:自定义字段 可选
可使用
1: var builder = new RL_YTX.TextMsgBuilder(id, text,file,type, receiver, domain);
2: var builder = new RL_YTX.TextMsgBuilder();
builder. setId (id); //设置消息ID
builder. setText (text);//设置文本内容
builder.setFile(file);发送附件时的附件对象
builder.setType(type);发送消息类型
builder. setReceiver(id);//设置接收者
builder. setDomain (id);//设置自定义字段
两种方式进行赋值
如无特殊说明,所有对象的set方法采用驼峰命名法。例如属性名为_id,则set方法为setId

对象

属性值

备注

属性名

必选

说明

RL_YTX. LoginBuilder

type

1:完整帐号登录 2:精简认证 3:通讯帐号密码登录

当为通讯账号登录方式时,pwd为必选字段,且sig字段可不传

userName

用户账号或通讯账号

pwd

通讯密码

sig

登录sig值,由页面请求第三方服务器生成

timestamp

登录时间戳 yyyyMMddHHmmss格式

RL_YTX. MsgBuilder

id

客户端消息id

text和file属性最少有一个有值

text

发送消息内容

file

发送图片或附件时的文件对象

type

发送消息类型 1文本消息 2 语音消息 3 视频消息 4 图片消息 5 位置消息 6 压缩文件消息 7 非压缩文件消息 11 群组@消息 12 状态消息

receiver

消息接收者

domain

自定义属性

fileName

文件名称

RL_YTX.CreateGroupBuilder

groupName

群组名称

groupType

1: 同学 2: 朋友 3: 同事 默认1

province

群组省份

city

群组城市

scope

群组人数范围 1 100人 2 300人 3 500人 4 1000人 5 2000人 默认为1

declared

群组描述

permission

群组权限 必选 1:默认可直接加入 2:需要身份验证 3:私有群组(不能主动加入,仅能管理员邀请) 默认为1

mode

创建者退出,群组是否解散 必选 1: 不解散 2: 解散 默认1

groupDomain

扩展信息

target

1 讨论组 2 普通群组 默认为2

RL_YTX.DismissGroupBuilder

groupId

群组id

RL_YTX.InviteJoinGroupBuilder

groupId

群组id

members参数必须为数组

declared

邀请理由

members

邀请成员

confirm

是否需要邀请者确认 1 不需要 2 需要 默认为2

RL_YTX.ConfirmInviteJoinGroupBuilder

invitor

邀请者

groupId

群组id

confir

是否同意邀请 1 不同意 2同意 默认为1

RL_YTX.QuitGroupBuilder

groupid

群组id

RL_YTX.GetGroupListBuilder

groupId

起始群组id

pageSize

群组分页大小默认50

target

群组模式 -1 全部 1讨论 2群组

RL_YTX.GetGroupMemberListBuilder

groupId

群组id

memberId

起始群组成员id

pageSize

成员分页大小 默认50

RL_YTX.JoinGroupBuilder

groupId

群组id

declared

申请理由

RL_YTX.ConfirmJoinGroupBuilder

groupId

群组id

memberId

申请者id

confirm

是否同意1不同意 2同意

RL_YTX.GetGroupDetailBuilder

groupId

群组id

RL_YTX.SearchGroupsBuilder

searchType

搜索类型 1群组id精确查找 2群组名称模糊搜索

keywords

搜索关键字

RL_YTX.DeleteGroupMemberBuilder

groupId

群组id

memberId

成员id

RL_YTX.ForbidMemberSpeakBuilder

groupId

群组id

memberId

成员id

forbidState

禁言状态 1正常 2禁言 默认为2

RL_YTX.SetGroupMessageRuleBuilder

groupId

群组id

isNotice

是否免打扰 1提醒 2免打扰

isApplePush

苹果设备离线是否离线推送 1 推送 2 不推送

RL_YTX.QueryGroupMemberCardBuilder

memberId

成员id

belong

群组id

RL_YTX.ModifyMemberCardBuilder

member

成语id

belong

群组id

display

修改后的昵称

phone

修改后的手机号

mail

修改后的邮箱

remark

修改后的备注

RL_YTX.ModifyGroupBuilder

groupId

群组id

groupName

群组名称

type

群组类型 1: 同学 2: 朋友 3: 同事

province

群组省份

city

群组城市

scope

群组规模 1:临时组(上限100人) 2普通组(上限300人)3:普通组(上限500人) 4:付费普通组 (上限1000人) 5:付费VIP组(上限2000人)

declared

群组公告

permission

群组权限 1:默认可直接加入 2:需要身份验证 3:私有群组(不能主动加入,仅能管理员邀请)

groupDomain

自定义字段

RL_YTX.AttachMsgBuilder

id

客户端消息id

file

需要发送的附件,为HTML5中的File对象,获取方式可参考附录中:发送附件时file对象获取

type

附件类型。2语音消息 3 视频消息 4图片消息 5 位置消息 6文件消息

receiver

消息接收者

domain

自定义属性

sendType

发送类型 1 IM消息 2多渠道消息 默认为1

RL_YTX. DeskMessageStartBuilder

osUnityAccount

客服号

userData

自定义字段

RL_YTX. DeskMessageBuilder

content

发送内容

content和file对象最少有一个有值

file

需要发送的附件,为HTML5中的File对象,获取方式可参考附录中:发送附件时file对象获取

type

附件类型。2语音消息 3 视频消息 4图片消息 5 位置消息 6文件消息

userData

用户自定义属性

osUnityAccount

客服号

msgId

用户自定义消息id(已废弃)

fileName

文件名称

RL_YTX. DeskMessageStopBuilder

osUnityAccount

客服号

userData

自定义字段

RL_YTX.UploadPersonInfoBuilder

nickName

用户昵称


sex

用户性别 1:男 2:女 默认为1

birth

用户生日 yyyy-MM-dd格式

Sign

用户签名,最大100个汉字

RL_YTX.GetUserStateBuilder

useracc

查询用户账号


DeleteReadMsgBuilder

msgid

消息接受者收到的msgid


RL_YTX.MakeCallBuilder

called

被叫账号或手机号


callType

呼叫类型 0 音频 1 音视频


nickname

网络电话显示的昵称


RL_YTX.AcceptCallBuilder

voipCallId

请求的callId


caller

请求主叫号码


RL_YTX.RejectCallBuilder

voipCallId

请求的callId


caller

请求主叫号码


RL_YTX.ReleaseCallBuilder

voipCallId

请求的callId


caller

请求主叫号码


called

请求被叫号码


RL_YTX.EnterChatroomBuilder

roomId

聊天室ID,用于加入聊天室


nickName

加入聊天室携带的昵称


infoExt

加入聊天室携带的拓展字段


needNotify

是否需要通知,(1、不通知,2、通知。默认为2)


notifyExt

通知拓展字段


RL_YTX.ExitChatroomBuilder

roomId

聊天室ID

text和file属性最少有一个有值

needNotify

是否需要通知,(1、不通知,2、通知。默认为2)

notifyExt

通知拓展字段。

RL_YTX.FetchChatroomInfoBuilder

roomId

聊天室ID


RL_YTX. UpdateChatroomInfoBuilder

roomId

聊天室ID

roomName,announcement,roomExt,allMuteMode最少有一个有值

roomName

修改房间名称

announcemen

修改房间公告

roomExt

房间信息扩展字段

allMuteMode

是否全员禁言 1 不是 2 是

needNotify

是否需要通知, 1 不通知 2 通知 (默认2)

notifyExt

通知信息扩展字段

RL_YTX. UpdateMyChatroomMemberInfoBuilder

roomId

聊天室ID

nickName和infoExt至少要设置一个

nickName

个人昵称

infoExt

个人信息扩展字段

RL_YTX. UpdateChatRoomMemberRoleBuilder

roomId

聊天室ID,用于加入聊天室


userId

用户id


type

角色类型 1 创建者 2 管理员 3 普通成员


needNotify

是否需要通知,(1、不通知,2、通知。默认为2)


notifyExt

通知拓展字段


RL_YTX. KickMemberBuilder

roomId

聊天室ID,用于加入聊天室


userIds

用户数组id[“id1”,”id2”] 仅管理员可以踢人;如userId是管理员仅创建者可以踢.


needNotify

是否需要通知,(1、不通知,2、通知。默认为2)


notifyExt

通知拓展字段


RL_YTX. AllMuteMode

roomId

聊天室ID,用于加入聊天室


allMuteMode

是否全员禁言 1 不是 2 是


needNotify

是否需要通知,(1、不通知,2、通知。默认为2)


notifyExt

通知拓展字段


RL_YTX. DefriendMemberBuilder

roomId

聊天室ID,用于加入聊天室


userIds

用户数组id 仅管理员可以拉黑;如userId是管理员仅创建者可以拉黑.


state

1拉黑 2取消拉黑 默认2


needNotify

是否需要通知,(1、不通知,2、通知。默认为2)


notifyExt

通知拓展字段


RL_YTX. ForbidChatRoomMemberBuilder

roomId

聊天室ID,用于加入聊天室


userIds

用户数组id 仅管理员可以禁言;如userId是管理员仅创建者可以禁言.


state

1禁言 2取消禁言(默认2)


muteDuration

单位:秒


needNotify

是否需要通知,(1、不通知,2、通知。默认为2)


notifyExt

通知拓展字段


(2)发送附件时file对象获取

Html:
<html>
  <body>
     <input type=”file” id=”_file” />
  </body>
</html>
JS:
var file = document.getElementById("_file").files[0];

                    

(3)群组通知参数说明

在下发群组通知时,有些参数是无值的,用户需要进行判空操作,当为空时,用户需要自己进行处理提示信息
groupId,groupName 必有值
auditType :
1 用户申请加入需要验证的群组时,群主或管理员接收此类型消息,
member,memberName有值declare可能有值
2 群主或管理员邀请用户直接加入群组时,被邀请者接收此类型消息,
admin,adminName ,confrim有值declare可能有值
此时 confrim为1表示用户直接加入群组,2表示需用户处理该请求
3 用户加入不需要验证的群组,群组成员接收此类型消息,
member,memberName有值
4 群主或管理员解散群组时,群组成员接收此类型消息,admin有值
5 用户退出群组时,群组成员接收此类型消息,member,memberName有值
6 群主或管理员踢出用户时,群组成员接收此类型消息,member有值
7 群主或管理员同意用户申请加入群组操作时,群组成员接收此类型消息,
member,memberName,confirm有值
8 用户同意群组邀请,或管理员邀请用户加入群组(不需要被邀请者确认)时,
群组内其他成员接收此类型消息,
member,memberName,confirm有值
9 群主或管理员修改群组信息时,群组其他成员接收此类型消息,
admin字段有值ext可能有值
10 群组成员名片被修改时,修改者之外的群组用户接收此类型消息,
member,memberName有值,ext可能有值
如果是管理员修改成员名片admin有值
11 讨论组管理员变更时,操作者之外的其他成员收到该类型消息
12 群组管理员变更时,操作者之外的其他成员收到该类型消息
ext字段说明:
json格式字符串,修改群组信息或成员名片后的最新字段,变更了哪些字段,返回哪些字段,群组名和用户名由外层的groupName,memberName标识
{
groupDeclared:declared,(群公告)
groupType:1,(群组type类型)
groupProvince:bj,(群组省份)
groupCity:bj,(群组城市)
groupScope:2,(群组scope)
groupPermission:1,(群组权限)
email:19274829@qq.com,(用户邮箱)
phone:18210234584,(用户手机号)
remark:'test'(用户备注)
}