云信获取云端历史记录
nimGetHistoryMsgs
该接口用于获取一段时间内的历史消息, 由参数beginTime和endTime来控制时间范围。
参数说明
| 属性 | 类型 | 默认值 | 是否必填 | 描述 |
|---|---|---|---|---|
scene | string | p2p | 是 | p2p (点对点消息) team (群消息) superTeam (超大群群消息) |
to | string | `` | 是 | 帐号或者群id |
beginTime | number | 0 | 否 | 表示查询开始时间(默认值0表示不限制开始时间) |
endTime | number | 否 | endTime: endTime表示结束时间(默认值为服务器当前时间),可以传入13位的UTC时间戳(对应毫秒)。 | |
lastMsgId | string | 否 | 以某条消息为起点进行查询,与beginTime或endTime时间参数搭配使用,时间参数二选一取决于reverse参数。查询时,时间参数设置为该条消息的time,lastMsgId设置为该条消息的idServer,查询结果不包含该条消息 | |
limit | number | 15 | 否 | 本次查询的消息数量限制, 最多100条, 默认100条 |
reverse | boolean | false | 否 | 默认false表示从endTime开始往前查找历史消息; true表示从beginTime开始往后查找历史消息 |
asc | boolean | false | 否 | 表示对查询结果按照时间进行排序的方式: 如果asc和reverse设置相同(都为true,或者都为false),查询结果按照时间戳从大到小;如果asc和reverse设置不同,查询结果按照时间戳从小到大。 |
当reverse为false时, 后续查询的endTime对应上次查询的最后一条消息的time字段
当reverse为true时, 后续查询的beginTime对应上次查询的最后一条消息的time字段
示例代码
dsBridge.call('nimGetHistoryMsgs', {
scene: 'p2p',
to: '',
limit: 20
}, function(res) { console.log(res) })
返回结果示例
{
"code":1,
"data": {
msgs: []
},
"msg":"success"
}