体育万博app下载_manbetx客户端网页版_bet万博网站

1.初始化

方法
RL_YTX.init(appId,webserver,lvsServer,sig)
参数说明
参数名
必选
说明
appid
应用appid,第三方注册时分配
webServer 对应serverIp和
file serverIp
(私有云)WebSocket服务器地址 格式为 ip:port
lvsServer
(私有云)WebSocket服务器地址 格式为 ip:port
fileSig (sdk中固定)
(私有云)fileSig规则 MD5(公司ID+公司密码) 
返回值

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 //错误码
返回值

4.IM消息监听

方法

RL_YTX. onMsgReceiveListener(callback)

参数说明
参数名
必选
说明
callback

通知回调function callback(obj){

obj.msgId; //消息msgId

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

 5:位置消息  6:压缩文件7非压缩文件 11群组发送@消息 12 状态消息

//状态消息时obj.msgDomain0 无输入状态  1 正在输入  2 正在录音

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

obj.msgSender;  //发送者

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

obj.msgDomain;  //扩展信息(长度有限制,2048个字符)

obj.msgFileName; //消息文件名

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

obj.msgFileUrlThum; //视频消息的缩略图url

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

obj.senderNickName; //发送者昵称(可为空)

obj.mcmEvent;//是否MCM消息

 0普通消息 1 start消息

2 end消息 53 发送mcm消息

obj.msgFileSize;//附件大小

返回值

5.指令(群组通知)消息监听

方法

RL_YTX. onMCMMsgReceiveListener(callback)

参数说明
参数名
必选
说明
callback

通知回调function callback(obj){

obj.msgId; //消息msgId

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. onConnectStateChangeLisenter(callback)
参数说明
参数名
必选
说明
callback

通知回调function callback(obj){

obj.code;//变更状态 1 断开连接 2 重练中 3 重练成功 4 被踢下线 
5 断开连接,需重新登录
(connector和websocket断开,前面的三个是
物理联系断开)

obj.msg;//消息提示}

返回值

7.获取个人信息

方法
RL_YTX. getMyInfo(callback, onError)
参数说明
参数名
必选
说明
callback

成功回调function callback(obj){obj.version; //个人信息版本号
obj.nickName; //昵称

obj.sex; //性别 1男(默认) 2女

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

onError

失败回调function onError(obj){

obj. code //错误码

obj.msg //错误描述}

返回值

8.设置个人信息

方法

RL_YTX.uploadPersonInfo(uploadPersonInfoBuilder,callback, onError)

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

成功回调function callback(obj){

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

onError

失败回调function onError(obj){

obj. code //错误码

obj.msg //错误描述}

返回值

9.发消息

方法
RL_YTX.sendMsg(MsgBuilder, callback, onError)
参数说明
参数名
必选
说明

MsgBuilder

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

callback

成功回调function callback(obj){obj.msgId; //
客户传入消息msgId(已废弃)

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

onError

成功回调function callback(obj){

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

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

progress

发送附件时的上传进度回调
function progress(sended,,total,msgClientNo){
sended;//已发送字节数

  total;//总字节数msgClientNo;// SDK生成的
发送者消息id}

返回值

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

10.创建群组

方法

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 //错误描述}

返回值

11.解散群组

方法
RL_YTX. dismissGroup(DismissGroupBuilder, callback, onError)
参数说明
参数名
必选
说明

DismissGroupBuilder

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

成功回调function callback(){}

onError

失败回调function onError(obj){

obj. code //错误码

obj.msg //错误描述}

返回值

12.邀请用户加入群组

方法
RL_YTX. inviteJoinGroup(InviteJoinGroupBuilder, callback, onError)
参数说明
参数名
必选
说明
InviteJoinGroupBuilder
RL_YTX. InviteJoinGroupBuilder对象 参考附录中
发送请求参数说明
callback
邀请成功回调function callback(){}
onError
邀请失败回调function onError(obj){obj. code //错误码
obj.msg //错误描述}
返回值

13.处理群组邀请

方法
RL_YTX. confirmInviteJoinGroup(ConfirmInviteJoinGroupBuilder, callback, onError)
参数说明
参数名
必选
说明
ConfirmInviteJoinGroupBuilder
RL_YTX. ConfirmInviteJoinGroupBuilder对象 参考附录中发送请求参数说明
callback
处理成功回调function callback(){}
onError
处理失败回调function onError(obj){obj. code //错误码obj.msg //错误描述}
返回值

14.申请加入群组

方法
RL_YTX. joinGroup(JoinGroupBuilder, callback, onError)
参数说明
参数名
必选
说明
JoinGroupBuilder
RL_YTX. JoinGroupBuilder对象 参考附录中发送请求参数说明
callback
成功回调function callback(){}
onError
失败回调function onError(obj){obj. code //错误码obj.msg //错误描述}
返回值

15.处理加入申请

方法
RL_YTX. confirmJoinGroup(ConfirmJoinGroupBuilder, callback, onError)
参数说明
参数名
必选
说明
ConfirmJoinGroupBuilder
RL_YTX. ConfirmJoinGroupBuilder对象 参考附录中发送请求参数说明
callback
成功回调function callback(){}
onError
失败回调function onError(obj){obj. code //错误码obj.msg //错误描述}
返回值

16.退出群组

方法
RL_YTX. quitGroup(QuitGroupBuilder, callback, onError)
参数说明
参数名
必选
说明
QuitGroupBuilder
RL_YTX. QuitGroupBuilder对象 参考附录中发送请求参数说明
callback
成功回调function callback(){}
onError
失败回调function onError(obj){obj. code //错误码obj.msg //错误描述}
返回值

17.修改群组成员角色

方法
RL_YTX.setGroupMemberRole(SetGroupMemberRoleBuilder, callback, onError)
参数说明
参数名
必选
说明
RL_YTX.SetGroupMemberRoleBuilder
SetGroupMemberRoleBuilder.setGroupId
//当前群组
IDSetGroupMemberRoleBuilder.setMemberId
//当前成员IDSetGroupMemberRoleBuilder.setRole
//设置角色id:1转让群主  2 设为管理员
3  取消管理员资格
callback
成功回调function callback(){}
onError
失败回调function onError(obj){obj. code //错误码obj.msg //错误描述}
返回值

18.踢出群组成员

方法
RL_YTX. deleteGroupMember(DeleteGroupMemberBuilder, callback, onError)
参数说明
参数名
必选
说明
DeleteGroupMemberBuilder
RL_YTX. DeleteGroupMemberBuilder对象 参考附录中发送请求参数说明
callback
成功回调function callback(){}
onError
失败回调function onError(obj){obj. code //错误码obj.msg //错误描述}
返回值

19.分页获取群组列表(登陆成功后调用)

方法
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 //错误描述}
返回值

20.分页获取群组成员

方法
RL_YTX. getGroupMemberList(GetGroupMemberListBuilder, callback, onError)
参数说明
参数名
必选
说明
GetGroupMemberListBuilder
RL_YTX. GetGroupMemberListBuilder对象
参考附录中发送请求参数说明
callback

成功回调function callback(obj){

for(var i in obj){

 var member = obj[i];//群组成员列表

cmember.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 //错误描述}
返回值

21.群组成员禁言

方法
RL_YTX. forbidMemberSpeak(ForbidMemberSpeakBuilder, callback, onError)
参数说明
参数名
必选
说明
ForbidMemberSpeakBuilder
RL_YTX. ForbidMemberSpeakBuilder对象
参考附录中发送请求参数说明
callback
成功回调function callback(){}
onError
失败回调function onError(obj){
obj. code //错误码obj.msg //错误描述}
返回值

22.获取群组成员名片

方法
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 //错误描述}
返回值

23.修改群组成员名片

方法
RL_YTX. modifyMemberCard (ModifyMemberCardBuilder, callback, onError)
参数说明
参数名
必选
说明
ModifyMemberCardBuilder
RL_YTX. ModifyMemberCardBuilder对象
参考附录中发送请求参数说明
callback
成功回调function callback(){}
onError
失败回调function onError(obj){
obj. code /错误码
obj.msg //错误描述}
返回值

24.搜索群组

方法
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 //错误描述}
返回值

25.获取群组详情

方法
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.target  //群组类型,1是讨论组 2是群组

obj.groupDomain; //扩展信息

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

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

onError

失败回调function onError(obj){

obj. code //错误码

obj.msg //错误描述}

返回值

26.修改群组详情

方法
RL_YTX. modifyGroup(ModifyGroupBuilder, callback, onError)
参数说明
参数名
必选
说明
ModifyGroupBuilder
RL_YTX. ModifyGroupBuilder对象 参考附录中发送请求参数说明
callback
成功回调function callback(){}
onError
失败回调function onError(obj){obj. code //错误码obj.msg //错误描述}
返回值

27.群组消息推送设置(免打扰)

方法
RL_YTX.setGroupMessageRule(SetGroupMessageRuleBuilder, callback, onError)
参数说明
参数名
必选
说明
SetGroupMessageRuleBuilder
RL_YTX. SetGroupMessageRuleBuilder对象
参考附录中发送请求参数说明
callback
成功回调function callback(){}
onError
失败回调function onError(obj){
obj. code //错误码
obj.msg //错误描述}
返回值

28.解压缩GZIP附件url

方法
RL_YTX.setGroupMessageRule(SetGroupMessageRuleBuilder, callback, onError)
参数说明
参数名
必选
说明
SetGroupMessageRuleBuilder
RL_YTX. SetGroupMessageRuleBuilder对象 参考附录中发送请求参数说明
callback
成功回调function callback(){}
onError
失败回调function onError(obj){obj. code //错误码obj.msg //错误描述}
返回值

29.获取用户在线状态

方法
RL_YTX. getUserState(GetUserStateBuilder, callback, onError)
参数说明
参数名
必选
说明
GetUserStateBuilder
getUserStateBuilder.setNewUserstate(true);
getUserStateBuilder.setUseracc(contact_you);
callback

成功回调

function callback(obj){

obj[i].useracc;//用户账号

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

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

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

}

onError
失败回调function onError(obj){
obj. code //错误码
obj.msg //错误描述}
返回值

30.删除消息

方法
RL_YTX.deleteReadMsg(DeleteReadMsgBuilder, callback, onError)
参数说明
参数名
必选
说明
 
DeleteReadMsgBuilder
RL_YTX. DeleteReadMsgBuilder对象 参考附录中发送请求参数说明
callback
成功回调function callback(){}
onError
失败回调function onError(obj){obj. code //错误码obj.msg //错误描述}
返回值

31.(阅后即焚)立即删除消息通知

方法
RL_YTX.onMsgNotifyReceiveListener(callback)
参数说明
参数名
必选
说明
callback
成功回调function callback(obj){
obj.msgType;//消息类型
obj.sender;//删除操作者
obj.msgId;//消息id
obj.dateCreated;//创建时间}
返回值

32.消息撤回

方法
RL_YTX. msgBack (MsgBackBuilder,callback,onError)
参数说明
参数名

必选

说明
MsgBackBuilder

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

操作状态码 200表示成功
onError

失败回调function onError(obj){

obj. code //错误码

obj.msg //错误描述}

返回值

33.消息已读

方法
RL_YTX. msgBack (MsgReadBuilder,callbacsk,onError)
参数说明
参数名
必选
参数名
MsgReadBuilder
RL_YTX.MsgReadBuilder对象 参考附录中发送
请求参数说明
callback
操作状态码 200表示成功,其他为失败
onError
失败回调function onError(obj){
obj. code //错误码
obj.msg //错误描述}
返回值

34.日志关闭

方法
RL_YTX.setLogClose()
返回值

35.设置音视频展示标签

方法
RL_YTX.setCallView(view,localView)
参数说明
参数名
必选
说明
view
对方视频展示的HTML标签
localView
本地视频展示的HTML标签
备注
发起或接受音视频消息前需要调用该接口

36.发送音视频请求

方法
RL_YTX.makeCall(MakeCallBuilder, callback, onError)
参数说明
参数名
必选
说明
MakeCallBuilder
RL_YTX.MakeCallBuilder对象 参考附录中发送请求参数说明
callback
成功回调function callback(){}
onError
失败回调function onError(obj){obj. code //错误码obj.msg //错误描述}
返回值

37.接收音视频请求

方法
RL_YTX.accetpCall(AcceptCallBuilder, callback, onError)
参数说明
参数名
必选
说明
AcceptCallBuilder
RL_YTX.AcceptCallBuilder对象 参考附录中发送请求参数说明
callback
成功回调function callback(){}
onError
失败回调function onError(obj){obj. code //错误码obj.msg //错误描述}
返回值

38.拒绝音视频请求

方法
RL_YTX.rejectCall(RejectCallBuilder, callback, onError)
参数说明
参数名
必选
说明
RejectCallBuilder
RL_YTX.RejectCallBuilder对象 参考附录中发送请求参数说明
callback
成功回调function callback(){}
onError
失败回调function onError(obj){obj. code //错误码}
返回值

39.取消音视频

方法
RL_YTX.releaseCall(ReleaseCallBuilder, callback, onError)
参数说明
参数名
必选
说明
ReleaseCallBuilder
RL_YTX.ReleaseCallBuilder对象 参考附录中发送请求参数说明
callback
成功回调function callback(){}
1) onError
失败回调function onError(obj){obj. code //错误码obj.msg //错误描述}
返回值

40.音视频消息通知

方法
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有新的呼叫

  obj.reason;//失败原因

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

41.准备拍照

方法
RL_YTX.photo.apply(obj, onCanPlay, onError)
参数说明
参数名
必选
说明
obj
Object对象,obj.tag DOM对象,表示预览图片的video标签
onCanPlay
媒体流准备就绪,可以进行拍照的通知回调function onCanPlay(){}
onError
失败回调function onError(obj){  obj.code; //错误码  obj.msg; //错误信息}

42.拍照

方法
RL_YTX.photo.make()
返回值
参数名
必选
说明
obj
obj.code
操作状态码 200表示成功,其他为失败
 
obj.blob
拍照成功返回的blob对象
 
obj.msg
操作失败的错误信息

43.取消拍照

方法
RL_YTX.photo. cancel()
返回值
参数名
必选
说明
obj
obj.code
操作状态码 200表示成功,其他为失败

44.录制视频

方法
RL_YTX. VideoRecord (stream,isVideo)
参数说明
参数名
必选
说明
stream
录制本地或者远端视频,录制本地视频参数为”local”,远端视频为”remote”
isVideo
是否录制视频,默认为false,即录制音频,true为录制视频。
return
录制本地或者远端视频,录制本地视频参数为”local”,远端视频为”remote”
返回值

如果不支持录制则返回{err: 174012, msg:"do not support record"};

如果支持,返回值为一个record对象,

对象有start开始录制、stop(callback)停止录制、pause暂停录制、resume继续录制

45.切换摄像头

方法
RL_YTX. exchangeCamera (cameraId,callback,onerror)
参数说明
参数名
必选
说明
cameraId
摄像头id,可通过RL_YTX.getDevices获取
callback
成功回调
return
 
失败回调function onError(obj){obj. code //错误码obj.msg //错误描述}
返回值

46.设置摄像头/麦克风

方法
RL_YTX. deployVideoVoice (enable , type)
参数说明
参数名
必选
说明
enable
true为开启,false为关闭
type
设备类型,”video”为摄像头,”audio”为麦克风
返回值
void

47.附录

1) 发送请求参数说明所有的请求对象中,若无特殊说明,均有两种初新建方式。第一种为在初始化对象时对此参数直接赋值,第二种为在初始化一个空对象后,使用setField的方式进行赋值obj.setField方式可以将第一种新建对象的属性值覆盖例:MsgBuilder: RL_YTX. MsgBuilder含有6个属性:id(客户端消息id 必选)text:文本内容 必选file:附件对象 必选type:发送消息类型 必选receiver:接受者 必选domain:自定义字段  可选可使用

1:varbuilder = new RL_YTX.MsgBuilder(id, text,file,type, receiver, domain);

 2:var builder = new RL_YTX.MsgBuilder();

         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:voip帐号密码登录
当为voip登录方式时,pwd为必选字段,且sig字段可不传
userName
用户账号或voip账号
pwd
Voip密码
sig
登录sig值,由页面请求第三方
服务器生成,格式:
MD5(appid+userName+
timestamp+
apptoken),
timestamp格式:yyyyMMddHHmmss
timestamp
登录时间戳 yyyyMMddHHmmss格式,
和sig中的时间戳一致
RL_YTX. MsgBuilder
id
(废弃,兼容老版本)
text和file属性最少有一个有值
text
发送消息内容
file
发送图片或附件时的文件对象
type
发送消息类型 1文本消息
2 语音消息 3 视频消息 4 图片消息
5 位置消息 6 压缩文件消息
7非压缩文件消息 11群组@消息
12状态消息
receiver
消息接收者
domain
自定义属性
fileName
文件名称
RL_YTX.CreateGroup
Builder
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.Dismiss
GroupBuilder
groupId
群组id
RL_YTX.InviteJoin
GroupBuilder
groupId
群组id
members参数必须为数组
declared
邀请理由
members
邀请成员
confirm
是否需要邀请者确认
1 不需要 2 需要 默认为2
RL_YTX.ConfirmInvite
JoinGroupBuilder
invitor
邀请者
groupId
群组id
confirm
是否同意邀请 1 不同意 2同意 默认为1
RL_YTX.Quit
GroupBuilder
groupid
群组id
RL_YTX.GetGroup
ListBuilder
groupId
起始群组id
pageSize
群组分页大小默认50
target
群组模式 -1 全部 1讨论 2群组
RL_YTX.GetGroup
MemberListBuilder
groupId
群组id
memberId
起始群组成员id
pageSize
成员分页大小 默认50
RL_YTX.JoinGroup
Builder
groupId
群组id
declared
申请理由
RL_YTX.Confirm
JoinGroupBuilder
groupId
群组id
memberId
申请者id
confirm
是否同意1不同意 2同意
RL_YTX.GetGroup
DetailBuilder
groupId
群组id
RL_YTX.Search
GroupsBuilder
searchType
搜索类型
1群组id精确查找
2群组名称模糊搜索
keywords
搜索关键字
RL_YTX.DeleteGroup
MemberBuilder
groupId
群组id
memberId
成员id
RL_YTX.ForbidMember
SpeakBuilder
groupId
群组id
memberId
成员id
forbidState
禁言状态 1正常 2禁言 默认为2
RL_YTX.SetGroup
MessageRuleBuilder
groupId
群组id
isNotice
是否免打扰 1提醒 2免打扰
isApplePush
苹果设备离线是否离线推送
1 推送 2 不推送
RL_YTX.QueryGroup
MemberCardBuilder
memberId
成员id
belong
群组id
RL_YTX.Modify
MemberCardBuilder*
member
成员id
belong
群组id
display
修改后的昵称
phone
修改后的手机号
mail
修改后的邮箱
remark
修改后的备注
RL_YTX.Modify
GroupBuilder
groupId
群组id
groupName
群组名称
type
群组类型 1: 同学 2: 朋友 3: 同事
province
群组省份
city
群组城市
declared
群组公告
permission
群组权限
1:默认可直接加入
2:需要身份验证
3:私有群组(不能主动加入,仅能管理员邀请)
groupDomain
自定义字段
RL_YTX.AttachMsg
Builder
id
客户端消息id
file
需要发送的附件,为HTML5中的File对象,
获取方式可参考附录中:
发送附件时file对象获取
type
附件类型。
2语音消息 3 视频消息
4图片消息 5 位置消息
6文件消息
receiver
消息接收者
domain
自定义属性
sendType
发送类型 1 IM消息 2多渠道消息 默认为1
RL_YTX. DeskMessage
StartBuilder
osUnityAccount
客服号
userData
自定义字段
RL_YTX. Desk
MessageBuilder
content
发送内容
content和file对象最少有一个有值
file
需要发送的附件,为HTML5中的
File对象,获取方式可参考附录中:
发送附件时file对象获取
type
附件类型。
2语音消息
3 视频消息
4图片消息
5 位置消息
6文件消息
userData
用户自定义属性
osUnityAccount
客服号
msgId
(废弃,兼容老版本)
fileName
文件名称
RL_YTX. DeskMessage
StopBuilder
osUnityAccount
客服号
userData
自定义字段
RL_YTX.Upload
PersonInfoBuilder
nickName
用户昵称
sex
用户性别 1:男 2:女 默认为1
birth
用户生日 yyyy-MM-dd格式
Sign
用户签名,最大100个汉字
RL_YTX.GetUser
StateBuilder
useracc
查询用户账号;查询单个可以传
字符串或数组,多个必须是数组
newUserstate
是否是多个用户状态
RL_YTX.MakeCallBuilder
called
被叫账号或手机号
callType
呼叫类型
0 音频
1 音视频
2 落地电话
tel
落地电话透传显示的号码
nickname
落地电话透传显示的昵称
RL_YTX.Accept
CallBuilder
voipCallId
请求的callId
caller
请求主叫号码
voipCallId
请求的callId
caller
请求主叫号码
RL_YTX.ReleaseCallBuilder
voipCallId
请求的callId
caller
请求主叫号码
called
请求被叫号码
DeleteReadMsgBuilder
msgid
消息接受者收到的msgid
GetRecent
ContactListBuilder
time
获取当前时间和指定时间之间的数据,默认7天
limit
获取联系人数量,默认50 最大100
RL_YTX.GetHistory
MessageBuilder
talker
消息交互者,群组消息时为群组id
pageSize
获取消息数量,默认为10,最大为50
operator
操作者在msgId对应的消息中所处的身份 1 消息接受者 2 消息发送者
msgId
消息msgId
order
排序方式
RL_YTX.MCMMessage
Builder
content
文本内容,该参数和file参数必须二选一
file
附件内容,该参数和content参数必须二选一
msgType
消息的类型
userData
用户的自定义参数
account
当前客服的账号
msgId
消息的id
fileName
附件的名称
chanType
0及时消息、1微信、2邮件、3短信、4传真
mailTitle
邮件标题;type值为2时有效
RL_YTX.MCMDataBuilder
ccpCustomData
和用户账号一起推送过来的ccpCustomData属性,是mcm平台自定义数据
RL_YTX.SetGroup
MemberRoleBuilder
groupId
群组或讨论组的id
memberId
被修改的成员的id
role
角色:1创建者 2管理员 3成员
RL_YTX.Msg
OperationBuilder
version
要执行操作的消息ID
type
空:阅后即焚,1:消息撤回,2:消息送达,3:消息已读
version
此msgid是精简的消息版本号
msgId
此msgid是完整的消息版本号,是sendMsg后返回的msgId,
msgId
此msgid是完整的消息版本号,是sendMsg后返回的msgId,
RL_YTX. MsgBackBuilder
msgId
此msgid是完整的消息版本号,是sendMsg后返回的msgId,

2) 发送附件时file对象获取Html:<html>

<body>

 <input type=”file” id=”_file” />

</body></html>JS:varfile = 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有值

           10 群主或管理员修改群组信息是,群组其他成员接收此类型消息,

                 admin字段有值ext可能有值

           11 群组成员名片被修改时,修改者之外的群组用户接收此类型消息,

                 member,memberName有值,ext可能有值

                 如果是群主或管理员修改成员名片admin有值

       12 讨论组管理员变更时,操作者之外的其他成员收到该类型消息

13 群组管理员变更时,操作者之外的其他成员收到该类型消息

 

 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'(用户备注)}