跳到主要内容

群聊消息回执

用户可以对自己发送的消息发起阅读回执请求,发起后,可以看到有多少人阅读过这条消息。

发起回执请求

发起消息已读回执请求。

方法

sendGroupReadReceiptRequest(
message: RCIMIWMessage,
callback: IRCIMIWSendGroupReadReceiptRequestCallback
): Promise<number>;

参数说明

参数名参数类型描述
messageRCIMIWMessage需要请求已读回执的消息
callbackIRCIMIWSendGroupReadReceiptRequestCallback事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。

返回值

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

代码示例

let callback = {
onGroupReadReceiptRequestSent:(res) => {
//...
}};
let code = await engine.sendGroupReadReceiptRequest(message, callback);

回调方法

  • setOnGroupReadReceiptRequestSentListener

    接口调用结果的监听

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

参数说明

参数名参数类型描述
codenumber接口回调的状态码,0 代表成功,非 0 代表出现异常
messageRCIMIWMessage需要请求已读回执的消息

代码示例

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

监听群聊回执请求

方法

setOnGroupMessageReadReceiptRequestReceivedListener(listener?: ({targetId, messageUId}) => void): void;

参数说明

参数名参数类型描述
targetIdstring会话 ID
messageUIdstring消息的 messageUid

代码示例

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

响应回执请求

收到了回执请求,接收者需要响应该请求,通知对方已阅读此消息。可以一次响应同一会话中的多条消息。

方法

sendGroupReadReceiptResponse(
targetId: string,
channelId: string,
messages: Array<RCIMIWMessage>,
callback: IRCIMIWSendGroupReadReceiptResponseCallback
): Promise<number>;

参数说明

参数名参数类型描述
targetIdstring会话 ID
channelIdstring频道 ID,仅支持超级群使用,其他会话类型传 null 即可。
messagesArray<RCIMIWMessage>会话中需要发送已读回执的消息列表
callbackIRCIMIWSendGroupReadReceiptResponseCallback事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。

返回值

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

示例代码

let callback = {
onGroupReadReceiptResponseSent:(res) => {
//...
}};
let code = await engine.sendGroupReadReceiptResponse(targetId, channelId, messages, callback);

回调方法

  • setOnGroupReadReceiptResponseSentListener

    接口调用结果的监听

setOnGroupReadReceiptResponseSentListener(listener?: ({code, targetId, channelId, messages}) => void): void;

参数说明

参数名参数类型描述
codenumber接口回调的状态码,0 代表成功,非 0 代表出现异常
targetIdstring会话 ID
channelIdstring频道 ID,仅支持超级群使用,其他会话类型传 null 即可。
messagesArray<RCIMIWMessage>会话中需要发送已读回执的消息列表

代码示例

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

监听群聊回执响应

方法

setOnGroupMessageReadReceiptResponseReceivedListener(listener?: ({targetId, messageUId, respondUserIds}) => void): void;

参数说明

参数名参数类型描述
targetIdstring会话 ID
messageUIdstring收到回执响应的消息的 messageUId
respondUserIdsMap<string, number>会话中响应了此消息的用户列表。其中 key: 用户 id ; value: 响应时间。

代码示例

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