已读回执

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

平台调用风格

异步风格：Promise<RcResult<T>>（{ code, data?, msg? }）；业务错误通过 res.code !== 0 判断，不抛异常。

接口一览

操作	语义	传输	返回
`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 个在本平台绑定中声明了方法签名。

跨端方法名

操作	Android	Web	Electron	macOS	Flutter	Native (C ABI)	iOS
`sendReadReceipt`	`sendReadReceipt`	`sendReadReceipt`	`sendReadReceipt`	`sendReadReceipt`	`sendReadReceipt`	`im_client_send_read_receipt`	`func`
`getMessageReadCount`	`getMessageReadCount`	`getMessageReadCount`	`getMessageReadCount`	`getMessageReadCount`	`getMessageReadCount`	—	`func`
`getMessageReadUsers`	`getMessageReadUsers`	`getMessageReadUsers`	`getMessageReadUsers`	`getMessageReadUsers`	`getMessageReadUsers`	—	`func`

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

sendReadReceipt

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

sendReadReceipt(conversationType, targetId, messageIds)

WS 长连接since 1.0.0

参数

参数	类型	说明
`conversationType`	`ConversationType`	必填；会话类型枚举（ConversationType）
`targetId`	`string`	必填；目标会话 ID：单聊为对方 userId，群聊为 groupId，聊天室为 chatroomId
`messageIds`	`string[]`	必填；消息 ID 列表

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

示例

const res = await client.sendReadReceipt(ConversationType.PRIVATE, 'user2', ['m_10001']);
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;

错误码

错误码	名称	分类	HTTP	可重试	说明
`1001`	`INVALID_PARAMETER`	客户端 / 参数 / 权限	400	否	参数错误
`1003`	`FORBIDDEN`	客户端 / 参数 / 权限	403	否	无权限
`1004`	`USER_NOT_FOUND`	客户端 / 参数 / 权限	404	否	用户不存在
`3001`	`SDK_NOT_CONNECTED`	SDK 本地	0	是	长连接未就绪

getMessageReadCount

查询消息已读人数。

getMessageReadCount(messageId)

REST（客户端）since 1.0.0

参数

参数	类型	说明
`messageId`	`string`	必填；消息 ID（服务端生成）

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

示例

const res = await client.getMessageReadCount('m_10001');
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;

错误码

错误码	名称	分类	HTTP	可重试	说明
`1001`	`INVALID_PARAMETER`	客户端 / 参数 / 权限	400	否	参数错误
`1003`	`FORBIDDEN`	客户端 / 参数 / 权限	403	否	无权限
`1004`	`USER_NOT_FOUND`	客户端 / 参数 / 权限	404	否	用户不存在

getMessageReadUsers

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

getMessageReadUsers(messageId, options?)

REST（客户端）since 1.0.0

参数

参数	类型	说明
`messageId`	`string`	必填；消息 ID（服务端生成）
`options`	`{offset?:uint32, limit?:uint32}`	可选；选项对象（字段见类型列）：{ offset?:uint32, limit?:uint32 }

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

示例

const res = await client.getMessageReadUsers('m_10001');
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;

错误码

错误码	名称	分类	HTTP	可重试	说明
`1001`	`INVALID_PARAMETER`	客户端 / 参数 / 权限	400	否	参数错误
`1003`	`FORBIDDEN`	客户端 / 参数 / 权限	403	否	无权限
`1004`	`USER_NOT_FOUND`	客户端 / 参数 / 权限	404	否	用户不存在

已读回执

接口一览​

跨端方法名​

sendReadReceipt​

getMessageReadCount​

getMessageReadUsers​

相关文档​

接口一览

跨端方法名

sendReadReceipt

getMessageReadCount

getMessageReadUsers

相关文档