历史消息

按会话分页拉取云端历史消息,支持向前/向后翻页与本地缓存命中。

平台调用风格

异步风格:Promise<RcResult<T>>({ code, data?, msg? });业务错误通过 res.code !== 0 判断,不抛异常。

接口一览​

操作语义传输返回
getHistoryMessages历史消息分页(beforeSeq 向前翻页);limit 默认 20 上限 100。rev23:channelId 过滤超级群频道消息(仅返回该频道消息)。REST(客户端){messages:Message[], hasMore:bool}

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

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
getHistoryMessagesgetHistoryMessagesgetHistoryMessagesgetHistoryMessagesgetHistoryMessagesgetHistoryMessagesim_client_historyfunc

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

getHistoryMessages​

历史消息分页(beforeSeq 向前翻页);limit 默认 20 上限 100。rev23:channelId 过滤超级群频道消息(仅返回该频道消息)。

getHistoryMessages(conversationType, targetId, options?)
REST(客户端)since 1.0.0
参数
参数类型说明
conversationTypeConversationType必填;会话类型枚举(ConversationType)
targetIdstring必填;目标会话 ID:单聊为对方 userId,群聊为 groupId,聊天室为 chatroomId
options{limit?:uint32, beforeSeq?:uint64, channelId?:string}可选;选项对象(字段见类型列):{ limit?:uint32, beforeSeq?:uint64, channelId?:string }
返回

{messages:Message[], hasMore:bool} 历史消息页与是否还有更早数据

示例
JavaScript
const res = await client.getHistoryMessages(ConversationType.PRIVATE, 'user2');
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

相关文档​