获取某个channel上发送的历史消息,您可以根据具体的参数来指定返回符合您期望的历史消息。
参数 | 必填 | 说明 |
---|---|---|
channel | 必填 | 要查询的channel |
start | 可选 | 要查询时间范围起始时间的毫秒数,默认为0,查询范围为从该channel上产生的第一条消息开始 |
end | 可选 | 要查询时间范围起始时间的毫秒数,默认为当前时间,查询范围为该channel上截止当前此刻的所有消息 |
limit | 可选 | 默认10,最大值为30 |
2021年11月起,PubSub消息历史查询功能从高级功能调整为普通功能,所有应用均默认开通,可直接调用,无需单独开通。
套餐 | 保留规则 |
---|---|
免费应用 | 免费保留1天内每个channel的最后30条消息 |
付费应用 | 免费保留5天内每个channel的最后100条消息 |
每调用1次,扣减1条消息数。
goeasy.pubsub.history({
channel: 'my_channel', //必需项
start: 1561347527648, //可选项,开始时间,默认为0,即从第一条消息开始查
end: 1561347706447, //可选项,结束时间,默认为当前时间
limit: 10, //可选项,返回的消息条数,默认为10条,最多30条
onSuccess: function (response) {
console.log("收到历史消息: "+ JSON.stringify(response));
/**
response示例:
{
"code":200,
"content":{
"messages":[
{"time":1561347527649,"content":"my 001"}
{"time":1561347596077,"content":"my 002"}
{"time":1561347622613,"content":"my 003"}
{"time":1561347691826,"content":"my 004"}
{"time":1561347706447,"content":"my 005"}
]
}
}
**/
},
onFailed: function (error) { //获取失败
console.log("Failed to obtain history, code:"+error.code+ ",error:"+error.content);
}
});
Request:
URL: http(s)://<REST HOST>/v2/pubsub/history?appkey={appkey}&channel={channel}&start={start}&end={end}&limit={limit}
Method: GET
参数:
appkey //必需项,您的rest appkey
channel //必需项
start //可选项,开始时间,默认为0,即从第一条消息开始查
end //可选项,结束时间,默认为当前时间
limit //可选项,返回的消息条数,默认为10条,最多30条
Response JSON:
//response 示例:
{
"code":200,
"content":{
"messages":[
{"time":1561347527649,"content":"my 001"}
{"time":1561347596077,"content":"my 002"}
{"time":1561347622613,"content":"my 003"}
{"time":1561347691826,"content":"my 004"}
{"time":1561347706447,"content":"my 005"}
]
}
}