• 功能描述
• 参数说明
• 代码示例

功能描述

聊天消息保存在云端，用户进入聊天室后，可以查看聊天室中以前的消息，历史消息默认保存 2 个月。必须在 IM 商用版 - 增值服务 中开通 聊天室消息云存储 (opens new window)功能。

参数说明

输入参数说明

参数	类型	必填	默认值	说明	最低版本
timestamp	Number	否	0	获取时间戳. 0 为从当前最新时间拉取 时间戳参数名对比 3.X 已修正为 timestamp 单位：毫秒	4.0.0
count	String	否	20	获取条数, 范围 1 - 20	4.0.0
order	Number	否	0	获取顺序，默认为 0， 0 表示升序：获取消息发送时间比传入 sentTime 小 的消息 1 表示倒序：获取消息发送时间比传入 sentTime 大 的消息	4.0.0

参数	类型	必填	默认值	说明	最低版本
timestrap	Number	否	0	获取时间戳. 0 为从当前最新时间拉取 单位：毫秒	3.0.0
count	String	否	20	获取条数, 范围 1 - 20	3.0.0
order	Number	否	0	获取顺序，默认为 0， 0 表示升序：获取消息发送时间比传入 sentTime 小 的消息 1 表示倒序：获取消息发送时间比传入 sentTime 大 的消息	3.0.0

回调参数说明

参数	类型	说明
list	Array	获取的历史消息列表，返回 message 列表
hasMore	Bool	是否还有历史消息可以获取

message 属性说明

字段名	类型	说明
type	Number	会话类型
targetId	String	接收方的 userId
senderUserId	String	发送者 id
content	Object	消息内容
messageType	String	消息标识
messageUId	String	服务端存储的消息 id
messageDirection	Number	消息方向。 发送: 1, 接收: 2
isOffLineMessage	Boolean	是否为离线消息
sentTime	Number	消息在融云服务端的发送时间
receivedTime	Number	消息接收时间. isOffLineMessage 为 true 时, receivedTime 无效
isPersited	Boolean	消息是否存储在服务端
isCounted	Boolean	消息是否计数

代码示例

var chatRoom = im.ChatRoom.get({
  id: 'chatRoom1'
});
var option = {
  timestrap: +new Date(),
  count: 20
};
chatRoom.getMessages(option).then(function(result){
  var list = result.list; // 历史消息列表
  var hasMore = result.hasMore; // 是否还有历史消息可以获取
  console.log('获取聊天室历史消息成功', list, hasMore);
});
已复制