群聊模块

Group.send(message)

message 参数的属性说明:

参数 类型 必填 说明 最低版本
senderId string 发送人 Id 3.0.0
targetId string 群组 Id 3.0.0
objectName string 消息类型, 分为两类: 内置消息类型自定义消息类型 3.0.0
content object 消息内容 3.0.0
pushContent string push 内容, 分为两类 内置消息 Push自定义消息 Push 3.0.0
pushData object iOS 平台为 Push 通知时附加到 payload 中,Android 客户端收到推送消息时对应字段名为 pushData 3.0.0
count string 针对 iOS 平台,Push 时用来控制未读消息显示数 3.0.0
isPersisted string 是否在融云服务器存储, 0: 不存储, 1: 存储, 默认: 1 3.0.0
isIncludeSender string 发送者自己是否接收此条消息, 0: 不接收, 1: 接收, 默认: 0 3.0.0
请求成功
{
    "code": 200
}

Group.sendDirection(message)

群定向消息功能,向群中指定的一个或多个用户发送消息,群中其他用户无法收到该消息,当 targetId 为一个群组时此参数有效。

message 参数的属性说明:

参数 类型 必填 说明 最低版本
senderId string 发送人 Id 3.0.0
targetId string 群组 Id 3.0.0
toUserId String[] 向群中指定的一个或多个用户发送消息,群中其他用户无法收到该消息 3.0.0
objectName string 消息类型, 分为两类: 内置消息类型自定义消息类型 3.0.0
content object 消息内容 3.0.0
pushContent string push 内容, 分为两类 内置消息 Push自定义消息 Push 3.0.0
pushData object iOS 平台为 Push 通知时附加到 payload 中,Android 客户端收到推送消息时对应字段名为 pushData 3.0.0
count string 针对 iOS 平台,Push 时用来控制未读消息显示数 3.0.0
isPersisted string 是否在融云服务器存储, 0: 不存储, 1: 存储, 默认: 1 3.0.0
isIncludeSender string 发送者自己是否接收此条消息, 0: 不接收, 1: 接收, 默认: 0 3.0.0
请求成功
{
    "code": 200
}

Group.sendMention(message)

发送 @ 消息

message 参数的属性说明:

参数 类型 必填 说明 最低版本
senderId string 发送人 Id 3.0.0
targetId string 群组 Id 3.0.0
objectName string 消息类型, 分为两类: 内置消息类型自定义消息类型 3.0.0
content object 消息内容, 需要包含 mentionedInfo 3.0.0
pushContent string push 内容, 分为两类 内置消息 Push自定义消息 Push 3.0.0
pushData object iOS 平台为 Push 通知时附加到 payload 中,Android 客户端收到推送消息时对应字段名为 pushData 3.0.0
count string 针对 iOS 平台,Push 时用来控制未读消息显示数 3.0.0
isPersisted string 是否在融云服务器存储, 0: 不存储, 1: 存储, 默认: 1 3.0.0
isIncludeSender string 发送者自己是否接收此条消息, 0: 不接收, 1: 接收, 默认: 0 3.0.0

mentionedInfo 说明:

参数 类型 说明
type number @ 功能类型,1 表示 @ 所有人、2 表示 @ 指定用户
userIds array 被 @ 人列表 type 为 2 时必填,type 为 1 时可以为空
pushContent string 自定义 @ 消息 push 内容
请求成功
{
    "code": 200
}

Group.recall(message)

撤回已发送的群聊消息,撤回时间无限制,只允许撤回用户自己发送的消息

message 参数的属性说明:

参数 类型 必填 说明 最低版本
senderId string 发送人 Id 3.0.0
targetId string 群组 Id 3.0.0
uId string 消息的唯一标识,各端 SDK 发送消息成功后会返回 uId 3.0.0
sentTime object 消息的发送时间,各端 SDK 发送消息成功后会返回 sentTime 3.0.0
{
    "code": 200
}

results matching ""

    No results matching ""