Background

• IM group messages are sorted by seq, and seq is allocated according to the order in which group messages are received by the server. The seq is greater for group messages sent earlier and smaller for group messages sent later.
• To pull all the messages of a group, you do not need to enter the seq for the initial pull. Instead, the server automatically returns the latest messages. For subsequent pulls, enter the previously returned smallest seq minus 1.
• If the value of IsPlaceMsg in the returned message is 1, it indicates that the message with this seq has expired, failed to be stored, or been deleted.

Feature Description

This API allows the app administrator to pull the historical messages of a group.

API Call Description

Applicable group types

Above are the IM built-in groups. For more information, please see Group System.

Note：

Audio-video groups (AVChatRoom) do not support this API because the historical messages of this type of group cannot be stored.

Sample request URL

https://xxxxxx/v4/group_open_http_svc/group_msg_get_simple?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table only describes the modified parameters when this API is called. For more information on other parameters, please see RESTful API Introduction.

Maximum call frequency

200 calls per second

Sample request packets

• Basic request
  Pulls the historical messages of a group. The most recent ReqMsgNumber group messages will be returned.

  {
   "GroupId": "@TGS#15ERQPAER",    // The ID of the group of which messages are to be pulled
   "ReqMsgNumber": 2      // The number of messages to be pulled
  }
  

• Pulling by seq
  Pulls the historical messages of a group based on the specified seq.
  The seq of the returned messages is less than or equal to the ReqMsgNumber of ReqMsgSeq.

  {
   "GroupId": "@TGS#15ERQPAER",
   "ReqMsgSeq": 7803321,       // The maximum seq of the requested messages. The messages with a seq less than or equal to `ReqMsgSeq` will be returned.
   "ReqMsgNumber": 2
  }
  

Request packet fields

Sample response packet

{
   "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 MaoTong",
                       "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 Watermelon Girl",
                       "Desc": "MIF",
                       "Ext": ""
                   },
                   "MsgType": "TIMCustomElem"
               },
               {
                   "MsgContent": {
                       "Text": "Report"
                   },
                   "MsgType": "TIMTextElem"
               }
           ],
           "MsgPriority": 1,
           "MsgRandom": 235168582,
           "MsgSeq": 7803320,
           "MsgTimeStamp": 1458721797
       }
   ]
}

Response packet fields

Error Codes

The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ErrorCode and ErrorInfo respectively.
For public error codes (60000 to 79999), please see Error Codes.
The following table describes the error codes specific to this API:

API Debugging Tool

Use the RESTful API online debugging tool to debug this API.

Reference

Setting the Unread Message Count of a Member (v4/group_open_http_svc/set_unread_msg_num)