Pulling Roaming Group Messages

Background

• IM group messages are sorted by Seq, and Seq is allocated according to group messages received by the server. The value of Seq is greater for group messages sent earlier and smaller for group messages sent later.
• To pull the full messages of a group, you do not need to specify the pull Seq during the initial pull. Instead, the server automatically returns the latest message. For subsequent pulls, enter the previously returned smallest Seq value minus 1 for the pull Seq.
• 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 was deleted.

Feature Description

The app admin can pull roaming messages of a group through this API.

API Invocation Description

Applicable group types

IM supports the preceding five group types. For details on these types, see Group Systems.

Roaming messages do not exist for AVChatRoom and BChatRoom chat rooms.

Request URL example

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

Request parameters

The following table lists and describes only the parameters to be modified when this API is invoked. For details on other parameters, see RESTful API Overview.

Maximum invocation frequency

The maximum invocation frequency is 200 times per second.

Request packet examples

• Basic format
  Pull roaming messages of a group. This returns the most recent ReqMsgNumber group messages.

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

• Pulling by Seq
  Pull the roaming messages of a group based on the specified Seq.
  The Seq of the returned message is less than or equal to ReqMsgNumber of ReqMsgSeq.

  {
    "GroupId": "@TGS#15ERQPAER",
    "ReqMsgSeq": 7803321,       // Indicates the maximum Seq of the request message. Messages with a Seq less than or equal to ReqMsgSeq will be returned.
    "ReqMsgNumber": 2
  }

Request packet fields

Response packet example

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "GroupId": "@TGS#15ERQPAER",
    "IsFinished": 1,
    "RspMsgList": [
        {
            "From_Account": "144115197276518801",
            "IsPlaceMsg": 0,
            "MsgBody": [
                {
                    "MsgContent": {
                        "Data": "\b\u0001\u0010\u0006\u001A\u0006MaoTong",
                        "Desc": "MIF",
                        "Ext": ""
                    },
                    "MsgType": "TIMCustomElem"
                },
                {
                    "MsgContent": {
                        "Data": "",
                        "Index": 15
                    },
                    "MsgType": "TIMFaceElem"
                }
            ],
            "MsgRandom": 51083293,
            "MsgSeq": 7803321,
            "MsgTimeStamp": 1458721802
        },
        {
            "From_Account": "144115198339527735",
            "IsPlaceMsg": 0,
            "MsgBody": [
                {
                    "MsgContent": {
                        "Data": "\b\u0001\u0010\u0006\u001A\u000FWatermelon Girl.",
                        "Desc": "MIF",
                        "Ext": ""
                    },
                    "MsgType": "TIMCustomElem"
                },
                {
                    "MsgContent": {
                        "Text": "Escalate"
                    },
                    "MsgType": "TIMTextElem",
                }
            ],
            "MsgRandom": 235168582,
            "MsgSeq": 7803320,
            "MsgTimeStamp": 1458721797
        }
    ]
}

Response packet fields

Error Codes

Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response packet represent the actual error code and error information, respectively.
For common error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API.

API Commissioning Tool

Use the RESTful online commissioning tool for APIs to commission this API.

References

Setting the count of unread messages for members (v4/group_open_http_svc/set_unread_msg_num)