tencent cloud

Overview

• This API is used to import group messages without triggering callbacks or sending notifications.
• When you are migrating your app from another instant messaging system to Tencent Cloud IM, you can use this API to import group message data.

API Calling Description

Applicable group types

Above are the built-in group types of IM. For more information, see Group System.

Note：

Audio-video groups (AVChatRoom) do not support importing group messages. If you attempt to import group messages for an audio-video group, error 10007 will be returned. Therefore, members of an audio-video group cannot view the messages sent before they join the group.

Sample request URL

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

Request parameters

The following table describes only the modified parameters when this API is called. For other parameters, see RESTful API Overview.

Maximum call frequency

200 calls per second

Sample request

A single request can import up to seven group messages.
After messages are imported through this API, the unread message count for all members will become 0. 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 timestamps 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",
  "RecentContactFlag":1,// Means to trigger conversation update (This field is not supported by AVChatRoom groups.)
  "MsgList": [
      {
          "From_Account": "leckie", // Message sender
          "SendTime":1620808101,
          "Random": 8912345, // Random number of the message (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", // Message sender
          "SendTime":1620892821,
          "MsgBody": [ // Message body, which consists of an element array. For details, see the `TIMMessage` message object.
              {
                  "MsgType": "TIMTextElem", // Text
                  "MsgContent":{
                      "Text": "red packet"
                  }
              }
          ]
      }
   ]
}

Request fields

Sample response

{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "ImportMsgResult": [
      {
          "MsgSeq": 1,
          "MsgTime": 1620808101,
          "Result": 0
      },
      {
          "MsgSeq": 2,
          "MsgTime": 1620892821,
          "Result": 0
      },
  ]
}

Response 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), see Error Codes.
The following table describes the error codes specific to this API:

API Debugging Tool

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

References

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