Feature Description

• This API imports one-to-one chat history to IM.
• It imports your messages from other instant messaging platforms to Tencent Cloud IM.
• It does not trigger a callback.
• It deduplicates the imported messages based on the From_Account, To_Account, MsgSeq, MsgRandom, and MsgTimeStamp fields. When the values of all the five fields match their counterparts, the two messages are considered duplicates, regardless of their contents.
• Imported messages will not be overwritten by the same messages from later imports.
• For one-to-one messages, the MsgSeq field is specified by the user when the message is sent. Its value can be repeated. It is not generated by the backend and not globally unique. For group chat messages, the value of the MsgSeq field is generated by the backend, and each group maintains its respective MsgSeq which increases strictly from 1. For one-to-one messages, the historical messages of the same conversation are sorted by timestamp first, and then the historical messages of the same second are sorted by MsgSeq.

API Calling Description

Sample request URL

https://xxxxxx/v4/openim/importmsg?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 Overview.

Maximum call frequency

200 calls per second

Sample requests

• Importing real-time messages

  {
   "SyncFromOldSystem": 1, // Imports real-time messages and marks them as unread
   "From_Account": "lumotuwe1", // Account of the sender
   "To_Account": "lumotuwe2", // Account of the recipient
   "MsgSeq": 827092, // Sequence number of the message
   "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", // Text message element
           "MsgContent": {
               "Text": "hi, beauty"
           }
       }
   ],
   "CloudCustomData": "your cloud custom data"
  }
  

• Importing historical messages

  {
   "SyncFromOldSystem": 2, // Imports historical messages and marks them as read
   "From_Account": "lumotuwe1", // Account of the sender
   "To_Account": "lumotuwe2", // Account of the recipient
   "MsgSeq": 827092, // Sequence number of the message
   "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", // Text message element
           "MsgContent": {
               "Text": "hi, beauty" // Message content
           }
       }
   ],
   "CloudCustomData": "your cloud custom data"
  }
  

Request fields

Sample response

{
 "ActionStatus" : "OK",
 "ErrorInfo" : "",
 "ErrorCode" : 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), please see Error Codes.

The following table describes the error codes specific to this API:

Debugging Tool

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

References
Importing Group Messages (v4/group_open_http_svc/import_group_msg)