跳到主要内容

发送群定向消息

SDK 支持往群聊会话中发送定向消息。定向消息只会发送给指定用户,群聊会话中的其它用户不会收到这条消息。

当前仅支持发送普通消息,不支持发送媒体消息。

开通服务

使用发送群组定向消息功能无需开通服务。注意,如需将群组定向消息存入服务端历史消息记录,需要开通以下服务:

  • 单群聊历史消息云存储服务,可前往控制台 IM 服务管理页面为当前使用的 App Key 开启服务。IM 旗舰版IM 尊享版可开通该服务。具体功能与费用以融云官方价格说明页面及计费说明文档为准。
  • 群定向消息云存储服务,需要提交工单申请开通。

默认情况下,客户端发送与接收的群定向消息默认都不会存入历史消息服务,因此客户端调用获取历史消息的 API 时,从融云服务端返回的结果中不会包含当前用户发送、接收的群组定向消息。

发送群组定向普通消息

在群组中发送普通消息给指定的单个或多个用户。

方法

sendGroupMessageToDesignatedUsers(
message: RCIMIWMessage,
userIds: Array<string>,
callback: RCIMIWSendGroupMessageToDesignatedUsersCallback
): Promise<number>;

参数说明

参数名参数类型描述
messageRCIMIWMessage要发送的消息
userIdsArray<string>群成员集合
callbackRCIMIWSendGroupMessageToDesignatedUsersCallback事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。

返回值

返回值描述
Promise<number>当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考状态码文档。

代码示例

let callback = {
onMessageSaved:(res) => {
//...
},
onMessageSent:(res) => {
//...
}};
let code = await engine.sendGroupMessageToDesignatedUsers(message, userIds, callback);

回调方法

  • setOnGroupMessageToDesignatedUsersAttachedListener

    消息存入数据库的监听

setOnGroupMessageToDesignatedUsersAttachedListener(listener?: ({message}) => void): void;

参数说明

参数名参数类型描述
messageRCIMIWMessage发送的消息内容

代码示例

engine.setOnGroupMessageToDesignatedUsersAttachedListener((res) => {
//...
});
  • setOnGroupMessageToDesignatedUsersSentListener

    消息发送收到结果的回调

setOnGroupMessageToDesignatedUsersSentListener(listener?: ({code, message}) => void): void;

参数说明

参数名参数类型描述
codenumber接口回调的状态码,0 代表成功,非 0 代表出现异常
messageRCIMIWMessage发送的消息内容

代码示例

engine.setOnGroupMessageToDesignatedUsersSentListener((res) => {
//...
});