Importing Group Messages

Feature Description

• This API is used to import group messages without triggering callbacks or delivering notifications.
• When your app needs to be migrated to Instant Messaging (IM) from another instant messaging system, you can use this API to import existing group message data.

API Calling Description

Applicable group types

IM provides the preceding five built-in group types. For details, see Group Systems.

AVChatRoom and BChatRoom groups do not support importing group messages. If you attempt to import group messages for these groups, error 10007 returns. This feature is not provided for both types of groups because they normally do not require historical messages.

Request URL example

https://console.tim.qq.com/v4/group_open_http_svc/import_group_msg?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 called. For details on other parameters, see RESTful API Overview.

Maximum calling frequency

The maximum calling frequency is 200 times per second.

Request packet example

Imports group messages in batches. A single request can import up to 20 messages.
After messages are imported through this API, the unread message count for all members will be 0. If you want to retain the unread message count, you need to import group members or set the unread message count for members after importing all messages.
The messages must be imported in ascending order by timestamp, and the timestamp of imported messages must be earlier than the current time and later than the group creation time and the creation time of the latest message in the group. Otherwise, the import will fail.

{
    "GroupId": "@TGS#2C5SZEAEF",
    "MsgList": [
        {
            "From_Account": "leckie", // Specified message sender
            "SendTime":1448357837,
            "Random": 8912345, // Message random number (optional)
            "MsgBody": [ // Message body, which consists of an element array. For details, see the TIMMessage message object.
                {
                    "MsgType": "TIMTextElem", // Text
                    "MsgContent": {
                        "Text": "red packet"
                    }
                },
                {
                    "MsgType": "TIMFaceElem", // Emoji
                    "MsgContent": {
                        "Index": 6,
                        "Data": "abc\u0000\u0001"
                    }
                }
            ]
        },
        {
            "From_Account": "peter", // Specified message sender
            "SendTime":1448357837,
            "MsgBody": [ // Message body, which consists of an element array. For details, see the TIMMessage message object.
                {
                    "MsgType": "TIMTextElem", // Text
                    "MsgContent": {
                        "Text": "red packet"
                    }
                }
            ]
        }

    ]
}

Request packet fields

Response packet example

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "ImportMsgResult": [
        {
            "Result": 0,
            "MsgSeq": 1,
            "MsgTime": 1449454106
        },
        {
            "Result": 0,
            "MsgSeq": 2,
            "MsgTime": 1449454116
        },
        {
            "Result": 0,
            "MsgSeq": 3,
            "MsgTime": 1449454106
        },
        {
            "Result": 0,
            "MsgSeq": 4,
            "MsgTime": 1449454116
        }
    ]
}

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 online commissioning tool for RESTful APIs to commission this API.

References

• Setting unread message counts for members (v4/group_open_http_svc/set_unread_msg_num)