即时通信 IM 拉取群历史消息 - 服务端 API

背景说明

• 即时通信 IM 的群消息是按 Seq 排序的，按照 server 收到群消息的顺序分配 Seq，先发的群消息 Seq 小，后发的 Seq 大。
• 如果用户想拉取一个群的全量消息，首次拉取时不用填拉取 Seq，Server 会自动返回最新的消息，以后拉取时拉取 Seq 填上次返回的最小 Seq 减1。
• 如果返回消息的 IsPlaceMsg 为1，表示这个 Seq 的消息或者过期、或者存储失败、或者被删除了。

功能说明

App 管理员可以通过该接口拉取群组的历史消息。

接口调用说明

适用的群组类型

即时通信 IM 内置上述群组类型，详情请参阅 群组系统。

说明：

AVChatRoom(直播群) 不支持历史消息存储，所以不支持调用此接口。

请求 URL 示例

https://console.tim.qq.com/v4/group_open_http_svc/group_msg_get_simple?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。

最高调用频率

200次/秒。

请求包示例

• 基础形式
  拉取群组的历史消息，返回群组最新的 ReqMsgNumber 条消息。

  {
   "GroupId": "@TGS#15ERQPAER",    //拉取消息的群 ID
   "ReqMsgNumber": 2      //需要拉取的消息条数
  }

• 按 seq 拉取
  按指定 seq 拉取群组的历史消息；
  返回消息 seq 小于等于 ReqMsgSeq 的 ReqMsgNumber 条消息。

  {
   "GroupId": "@TGS#15ERQPAER",
   "ReqMsgSeq": 7803321,       //请求的消息最大 seq，返回 <=ReqMsgSeq 的消息
   "ReqMsgNumber": 2
  }

请求包字段说明

应答包体示例

{
   "ActionStatus": "OK",
   "ErrorInfo": "",
   "ErrorCode": 0,
   "GroupId": "@TGS#15ERQPAER",
   "IsFinished": 1,
   "RspMsgList": [
       {
           "From_Account": "144115197276518801",
           "IsPlaceMsg": 0,
           "MsgBody": [
               {
                   "MsgContent": {
                       "Data": "\b\u0001\u0010\u0006\u001A\u0006猫瞳",
                       "Desc": "MIF",
                       "Ext": ""
                   },
                   "MsgType": "TIMCustomElem"
               },
               {
                   "MsgContent": {
                       "Data": "",
                       "Index": 15
                   },
                   "MsgType": "TIMFaceElem"
               }
           ],
           "MsgPriority": 1,
           "MsgRandom": 51083293,
           "MsgSeq": 7803321,
           "MsgTimeStamp": 1458721802
       },
       {
           "From_Account": "144115198339527735",
           "IsPlaceMsg": 0,
           "MsgBody": [
               {
                   "MsgContent": {
                       "Data": "\b\u0001\u0010\u0006\u001A\u000F西瓜妹妹。",
                       "Desc": "MIF",
                       "Ext": ""
                   },
                   "MsgType": "TIMCustomElem"
               },
               {
                   "MsgContent": {
                       "Text": "报上来"
                   },
                   "MsgType": "TIMTextElem"
               }
           ],
           "MsgPriority": 1,
           "MsgRandom": 235168582,
           "MsgSeq": 7803320,
           "MsgTimeStamp": 1458721797
       }
   ]
}

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考

设置成员未读消息计数（v4/group_open_http_svc/set_unread_msg_num）