标题

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.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

confirm

否

是否同意邀请

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

否

(废弃，兼容老版本)

fileName

否

文件名称

RL_YTX. DeskMessageStopBuilder

osUnityAccount

是

客服号

userData

否

自定义字段

RL_YTX.UploadPersonInfoBuilder

nickName

是

用户昵称

sex

否

用户性别

1:男 2:女 默认为1

birth

否

用户生日

yyyy-MM-dd格式

Sign

否

用户签名，

最大100个汉字

RL_YTX.GetUserStateBuilder

useracc

是

查询用户账号；

查询单个可以传字符串或数组，多个必须是数组

newUserstate

是

是否是多个用户状态

RL_YTX.MakeCallBuilder

called

是

被叫账号或手机号

callType

是

呼叫类型

 0 音频

1 音视频

2 落地电话

tel

否

落地电话透传显示的号码

nickname

否

落地电话透传显示的昵称

RL_YTX.AcceptCallBuilder

voipCallId

是

请求的callId

caller

是

请求主叫号码

RL_YTX.RejectCallBuilder

voipCallId

是

请求的callId

caller

是

请求主叫号码

RL_YTX.ReleaseCallBuilder

voipCallId

是

请求的callId

caller

是

请求主叫号码

called

是

请求被叫号码

DeleteReadMsgBuilder

msgid

是

消息接受者收到的msgid

GetRecentContactListBuilder

time

否

获取当前时间和指定时间之间的数据，默认7天

limit

否

获取联系人数量，

默认50 最大100

RL_YTX.GetHistoryMessageBuilder

talker

是

消息交互者，

群组消息时为群组id

pageSize

否

获取消息数量，

默认为10，最大为50

operator

是

操作者在msgId对应的

消息中所处的身份

1消息接受者

2消息发送者

msgId

是

消息msgId

order

否

排序方式

RL_YTX.MCMMessageBuilder

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.MsgOperationBuilder

version

是

要执行操作的消息ID

type

是

空：阅后即焚，

1：消息撤回，

2：消息送达，

3：消息已读

RL_YTX. MsgReadBuilder

version

是

此msgid是精简的

消息版本号

RL_YTX. MsgBackBuilder

msgId

是

此msgid是完整的

消息版本号，是sendMsg

后返回的msgId,

如805588CEEFAB1C55B248DC4ACE7F875A|14