GoEasyIM REST API - 查询历史消息

接口功能

查询历史消息,可以根据私聊双方的userId查询,也可以根据groupId查询.

开通

本特性为高级功能,默认不开通,付费应用,可以在我的应用->查看详情,高级功能里自助开通。

资费

根据每次返回的消息数,每返回10条消息,扣减1条消息数,不满10条,按10条计算。

历史消息保留规则

套餐 保留规则
免费应用 不保留
9.9体验套餐 保留24小时内,每个群聊或者私聊对话的最后30条记录
99体验套餐 保留3天内,每个群聊或者私聊对话的最后100条记录
更大套餐 保留7天时,每个群聊或者私聊对话的最后300条记录

调用说明

URL:

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":{
        "messages":[
            {"senderId":"user1","timestamp":1591848968913,"payload":"{\"title\":\"example Message\",\"content\":\"Hello GoEasy!\"}"},
            {"senderId":"user1","timestamp":1591849002401,"payload":"{\"title\":\"example Message\",\"content\":\"Hello GoEasy IM!\"}"},
            {"senderId":"user1","timestamp":1591849614009,"payload":"Hello GoEasy"},
            {"senderId":"user1","timestamp":1591849657015,"payload":"Hello GoEasy IM"}
        ]
    }
}

失败返回值示例

{
  "code":401, 
  "content":"Unauthorized"
}

results matching ""

    No results matching ""