tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动(含 UI)
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务(Push)
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们

JavaScript

PDF
聚焦模式
字号
最后更新时间: 2025-12-23 14:31:02

功能描述

SDK 既支持分页续拉消息列表,也支持根据指定的消息 sequence 或消息时间拉取消息列表。
云端存储的历史消息有存储时长的限制:
体验版:免费存储 7 天,不支持延长。
专业版:免费存储 30 天,支持延长。
专业版 Plus:免费存储 90 天,支持延长。
企业版:免费存储 90 天,支持延长。
说明:
延长历史消息存储时长是增值服务,您可以登录 Chat Console 修改相关配置,具体计费说明请参考 增值服务资费
富媒体消息(图片、文件、语音等)对应的文件存储时长,与历史消息存储时长保持一致。

拉取消息列表

getMessageList

分页拉取指定会话的消息列表的接口,当用户进入会话首次渲染消息列表或者用户“下拉查看更多消息”时,需调用该接口。
说明:
1. 该接口可用于"拉取历史消息"(直播群除外)。
2. 直播群默认不存储历史消息,当新用户进入直播间后,只能看到进入直播间后用户发送的消息。为了提升直播间用户粘性,让用户更有参与感,您可在即时通信 Chat 控制台 > 功能配置 > 群组配置 > 直播群新成员查看入群前消息量配置来变更新成员可以查看的最近消息数。该功能仅支持专业版、专业版 Plus 或企业版使用,新入群成员可以通过 MESSAGE_RECEIVED 事件接收入群前 24 小时内最新产生的消息,最多可查看 50 条。
3. 如果您想搜索本地消息,请使用 findMessage,如果您想搜索全量的云端消息,请使用 searchCloudMessages(此功能属于增值服务,需要您购买云端搜索插件,请点击 购买
接口
chat.getMessageList(options);
参数
参数 options Object 类型,包含的属性值如下:
名称
类型
描述
conversationID
String
会话 ID。
会话 ID 组成方式:
C2C${userID}(单聊)
GROUP${groupID}(群聊)
GROUP${topicID}(话题)
@TIM#SYSTEM(系统通知会话)
nextReqMessageID
String | undefined
用于分页续拉的消息 ID。第一次拉取时不要传入 nextReqMessageID,续拉时填入上次调用 getMessageList 接口返回的该字段的值。
返回值
Promise
示例
// 打开某个会话时,第一次拉取消息列表
let promise = chat.getMessageList({conversationID: 'C2Ctest'});
promise.then(function(imResponse) {
const messageList = imResponse.data.messageList; // 消息列表。
const nextReqMessageID = imResponse.data.nextReqMessageID; // 用于续拉,分页续拉时需传入该字段。
const isCompleted = imResponse.data.isCompleted; // 表示是否已经拉完所有消息。
});
// 下拉查看更多消息
let promise = chat.getMessageList({conversationID: 'C2Ctest', nextReqMessageID});
promise.then(function(imResponse) {
const messageList = imResponse.data.messageList; // 消息列表。
const nextReqMessageID = imResponse.data.nextReqMessageID; // 用于续拉,分页续拉时需传入该字段。
const isCompleted = imResponse.data.isCompleted; // 表示是否已经拉完所有消息。
});

getMessageListHopping

根据指定的消息 sequence 或 消息时间拉取会话的消息列表的接口。
接口
chat.getMessageListHopping(options);
参数
参数 options Object 类型,包含的属性值如下:
名称
类型
描述
conversationID
String
会话 ID。
会话 ID 组成方式:
C2C${userID}(单聊)
GROUP${groupID}(群聊)
GROUP${topicID}(话题)v2.19.1 起支持
sequence
Number | undefined
用于拉群组会话漫游消息的起始 sequence。
time
Number | undefined
消息的服务端时间,用于拉 C2C 会话漫游消息的起始时间。
direction
Number
消息拉取方向,默认 0。
0 向上拉,拉更旧的消息
1 向下拉,拉更新的消息
count
Number | undefined
需要拉取的消息数量,默认值和最大值为15,即一次拉取至多返回15条消息。
返回值
Promise
示例
// 根据 sequence 拉群漫游消息,direction 0 向上拉,拉更旧的消息,direction 1 向下拉,拉更新的消息
let promise = chat.getMessageListHopping({
conversationID: 'GROUPtest',
sequence: xxx,
count: 15,
direction: 0
});
promise.then(function(imResponse) {
const { messageList, isCompleted, nextMessageSeq } = imResponse.data;
// messageList - 消息列表
// isCompleted - 拉取完成标识, true 已拉完,false 未拉完,可以通过 nextMessageSeq 的返回值进行续拉
// nextMessageSeq - 续拉起始 sequence,当 isCompleted 返回 true 时,nextMessageSeq 返回空字符串
});
// 根据时间拉 C2C 会话漫游消息,direction 0 向上拉,拉更旧的消息,direction 1 向下拉,拉更新的消息
let promise = chat.getMessageListHopping({
conversationID: 'C2Ctest',
time: xxx,
count: 15,
direction: 0
});
promise.then(function(imResponse) {
const { messageList, isCompleted, nextMessageTime } = imResponse.data;
// messageList - 消息列表
// isCompleted - 拉取完成标识,true 已拉完,false 未拉完,可以通过 nextMessageTime 的返回值进行续拉
// nextMessageTime - 续拉起始时间,当 isCompleted 返回 true 时,nextMessageTime 返回空字符串
});


帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈