Importing One-to-One Messages

API Description

• This API imports one-to-one chat history to IM.
• It can import your messages from other instant messaging platforms to Tencent Cloud IM.
• This API does not trigger a callback.
• This API deduplicates the imported messages based on the From_Account, To_Account, MsgRandom, and MsgTimeStamp fields. When the values of all the four fields match their counterparts, the two messages are considered duplicates, regardless of their contents.
• Imported messages will not be overwritten by the same message from later imports.

API Call Description

Sample request URL

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

Request parameters

The list below contains only the parameters commonly used when calling this API and their descriptions. For more parameters, see RESTful API Overview.

Maximum call frequency

200 calls per second

Sample request

• Importing real-time messages

  {
    "SyncFromOldSystem": 1, // Imports real-time messages and marks them as unread.
    "From_Account": "lumotuwe1", // The account of the message sender
    "To_Account": "lumotuwe2", // The account of the message recipient
    "MsgRandom": 1287657, // A random number assigned to the message.
    "MsgTimeStamp": 1556178721, // UNIX timestamp in seconds
    "MsgBody": [ // Message body. This is a text message.
        {
            "MsgType": "TIMTextElem", // Message element
            "MsgContent": {
                "Text": "hi, beauty"
            }
        }
    ]
  }

• Importing historical messages

  {
    "SyncFromOldSystem": 2, // Imports historical messages and marks them as read.
    "From_Account": "lumotuwe1", // The account of the message sender
    "To_Account": "lumotuwe2", // The account of the message recipient
    "MsgRandom": 1287657, // A random number assigned to the message.
    "MsgTimeStamp": 1556178721, // UNIX timestamp
    "MsgBody": [ // Message body. This is a text message.
        {
            "MsgType": "TIMTextElem", // Message element
            "MsgContent": {
                "Text": "hi, beauty" // Message content.
            }
        }
    ]
  }

Request fields

Sample response

{
   "ActionStatus":"OK",
   "ErrorInfo":"",
   "ErrorCode": 0
}

Response fields

Error Codes

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

The list below contains only error codes specific to this API:

API Debugging Tool

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

See Also

Importing group messages (v4/group_open_http_svc/import_group_msg )