查询历史消息,可以根据私聊双方的userId查询,也可以根据groupId查询.
本特性为高级功能,默认不开通,付费应用,可以在我的应用->查看详情,高级功能里自助开通。
根据每次返回的消息数,每返回10条消息,扣减1条消息数,不满10条,按10条计算。
套餐 | 保留规则 |
---|---|
免费应用 | 不保留 |
9.9体验套餐 | 保留24小时内,每个群聊或者私聊对话的最后30条记录 |
99体验套餐 | 保留3天内,每个群聊或者私聊对话的最后100条记录 |
更大套餐 | 保留7天时,每个群聊或者私聊对话的最后300条记录 |
GET http://{rest-host}/im/v1/history
参数 | 类型 | 必须 | 描述 |
---|---|---|---|
rest-host | String | 是 | 根据您创建应用的区域选择 杭州:rest-hangzhou.goeasy.io 新加坡:暂不支持IM,敬请期待 |
appkey | String | 是 | common key 或者 rest key |
userAId | String | 否 | 私聊双方其中一方的userId,必须与userBId成对传入,不区分发送方和接收方,不得与groupId同时存在 |
userBId | String | 否 | 私聊双方其中一方的userId,必须与userAId成对传入,不区分发送方和接收方,不得与groupId同时存在 |
groupId | String | 否 | 群聊的groupId,不得与userAId/userBId同时存在 |
limit | String | 否 | 每次返回的消息消息总数,默认为10条,最大不超过100条 |
lasttimestamp | long | 否 | 查询发送时间小于(不包含)该时间的历史消息,可用于分页和分批拉取聊天记录,默认为当前时间 |
curl -X GET "http://rest-hangzhou.goeasy.io/im/v1/history?appkey=BC-xxxxx&userAId=user1&userBId=user2&limit=5&lasttimestamp="
{
"code": 200,
"content": [
{
"type": "text", "messageId": "8f0e27a0c7e111eab347b726da4416bd",
"timestamp": 1594958217087, "senderId": "3bb179af-bcc5-4fe0-9dac-c05688484649",
"payload": {"text": "Hello, GoEasyIM"}
},
{
"type": "audio", "messageId": "312c8900c7e211ea9744b7abe1fd7831",
"timestamp": 1594958490234, "senderId": "fdee46b0-4b01-4590-bdba-6586d7617f95",
"payload": {
"name": "20200717120129175.m4a", "contentType": "audio/m4a",
"url": "https://goeasy-hangzhou.oss-cn-hangzhou.aliyuncs.com/goeasy-im/20200717120129175.m4a",
"duration": 2.46, "size": 15220,
}
},
{
"type": "image", "messageId": "9498cf40c7d711eab228bf40d56471fe",
"timestamp": 1594953936702, "senderId": "3bb179af-bcc5-4fe0-9dac-c05688484649",
"payload": {
"name": "04531220.jpg", "contentType": "image/jpeg",
"url": "https://goeasy-hangzhou.oss-cn-hangzhou.aliyuncs.com/goeasy-im/04531220.jpg",
"width": 1758, "height": 765, "size": 62988,
}
},
{
"type": "video", "messageId": "373e36c0c7df11eab228bf40d56471fe",
"senderId": "3bb179af-bcc5-4fe0-9dac-c05688484649", "timestamp": 1594957262738,
"payload": {
"video": {
"name": "1593738719905558_20200717114010716.mp4", "contentType": "video/mp4",
"url": "https://goeasy-im.oss-cn-hangzhou.aliyuncs.com/goeasy-im/1593738719905558_20200717114010716.mp4",
"duration": 46.766667, "width": 544, "height": 960, "size": 7404683
},
"thumbnail": {
"width": 544, "height": 960, "contentType": "image/jpg",
"url": "https://goeasy-im.oss-cn-hangzhou.aliyuncs.com/goeasy-im/1593738719905558_20200717114010716.mp4?x-oss-process=video/snapshot,t_0000,f_jpg,w_544,m_fast"
}
},
}
]
}
{
"code":401,
"content":"Unauthorized"
}