已读回执

单聊与群聊支持已读回执：接收方上报已读，发送方查询已读人数与已读用户列表。

平台调用风格

异步风格：Future<RcResult<T>>；错误码在 res.code，不使用异常表达业务失败。

接口一览​

操作语义传输返回
sendReadReceipt上报已读回执；服务端记录唯一读者并推送给消息发送者。WS 长连接{messageIds:string[], readCounts?:map<string,uint32>, totalMembers?:uint32}
getMessageReadCount查询消息已读人数。REST（客户端）{messageId:string, readCount:uint32, totalMembers:uint32}
getMessageReadUsers查询已读用户明细（分页）。REST（客户端）{messageId:string, readCount:uint32, totalMembers:uint32, readers:UserProfile[]}

本页 3 个操作，其中 3 个在本平台绑定中声明了方法签名。

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
sendReadReceiptsendReadReceiptsendReadReceiptsendReadReceiptsendReadReceiptsendReadReceiptim_client_send_read_receiptfunc
getMessageReadCountgetMessageReadCountgetMessageReadCountgetMessageReadCountgetMessageReadCountgetMessageReadCount—func
getMessageReadUsersgetMessageReadUsersgetMessageReadUsersgetMessageReadUsersgetMessageReadUsersgetMessageReadUsers—func

方法名在 GA 平台之间保持一致（规则 A）；Native C ABI 只覆盖部分操作，其余操作以 — 标注。

sendReadReceipt​

上报已读回执；服务端记录唯一读者并推送给消息发送者。

sendReadReceipt(int conversationType, String targetId, List<String> messageIds)
WS 长连接since 1.0.0
参数
参数类型说明
conversationTypeConversationType必填；会话类型枚举（ConversationType）
targetIdstring必填；目标会话 ID：单聊为对方 userId，群聊为 groupId，聊天室为 chatroomId
messageIdsstring[]必填；消息 ID 列表
返回

{messageIds:string[], readCounts?:map<string,uint32>, totalMembers?:uint32} 成功返回的数据；失败时按错误码处理

示例
Dart
final res = await engine.sendReadReceipt(1, 'user2', ['m_10001']);
if (res.code != 0) throw Exception(res.msg);
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1004USER_NOT_FOUND客户端 / 参数 / 权限404否用户不存在
3001SDK_NOT_CONNECTEDSDK 本地0是长连接未就绪

getMessageReadCount​

查询消息已读人数。

getMessageReadCount(String messageId)
REST（客户端）since 1.0.0
参数
参数类型说明
messageIdstring必填；消息 ID（服务端生成）
返回

{messageId:string, readCount:uint32, totalMembers:uint32} 已读人数与群成员总数

示例
Dart
final res = await engine.getMessageReadCount('m_10001');
if (res.code != 0) throw Exception(res.msg);
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1004USER_NOT_FOUND客户端 / 参数 / 权限404否用户不存在

getMessageReadUsers​

查询已读用户明细（分页）。

getMessageReadUsers(String messageId, {int offset, int limit})
REST（客户端）since 1.0.0
参数
参数类型说明
messageIdstring必填；消息 ID（服务端生成）
options{offset?:uint32, limit?:uint32}可选；选项对象（字段见类型列）：{ offset?:uint32, limit?:uint32 }
返回

{messageId:string, readCount:uint32, totalMembers:uint32, readers:UserProfile[]} 已读用户明细（分页）

示例
Dart
final res = await engine.getMessageReadUsers('m_10001');
if (res.code != 0) throw Exception(res.msg);
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1004USER_NOT_FOUND客户端 / 参数 / 权限404否用户不存在

相关文档​