MsgSeq
, MsgRandom
, and MsgTimeStamp
fields. When the values of all these three fields match their counterparts, the two messages are considered duplicates, regardless of their contents. In addition, if the MsgSeq
, MsgRandom
, and MsgTimeStamp
fields of the two messages matches each other, but from_account
and to_account
are opposite, the two messages are also considered duplicates.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
.https://xxxxxx/v4/openim/importmsg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Parameter | Description |
xxxxxx | Domain name corresponding to the country/region where your SDKAppID is located. China: console.tim.qq.com Singapore: adminapisgp.im.qcloud.com Seoul: adminapikr.im.qcloud.com Frankfurt: adminapiger.im.qcloud.com Silicon Valley: adminapiusa.im.qcloud.com Jakarta: adminapiidn.im.qcloud.com |
v4/openim/importmsg | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format, which should always be json . |
{"SyncFromOldSystem": 5, // Imports real-time messages, marks them as unread and pushes them to the client."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"}
{"SyncFromOldSystem": 2, // Imports historical messages, marks them as read and does not push them to the client."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"}
Field | Type | Required | Description |
SyncFromOldSystem | Integer | Yes | Valid values: 2 and 5 . 2 : Imports historical messages, marks them as read and does not push them to the client.5 : Imports real-time messages, marks them as unread and pushes them to the client. |
From_Account | String | Yes | UserID of the sender, which is used to specify the message sender |
To_Account | String | Yes | UserID of the recipient |
MsgSeq | Integer | No | Sequence number (32-bit unsigned integer) of the message. The backend will use this field to remove duplicate messages and sort messages in the same second. For details, see Feature Description. If this field is left empty, the backend will enter a random number. |
MsgRandom | Integer | Yes | Random number (32-bit unsigned integer) of the message. It is used by the backend for removing duplicate message within a second. Make sure a random number is entered. |
MsgTimeStamp | Integer | Yes | UNIX timestamp in seconds. It marks the time when the message was sent and is used to remove duplicate messages. For details, see Feature Description. |
MsgBody | Array | Yes | Message body. For details on formats, please see Message Formats. (Note: a message can contain multiple message elements, in which case MsgBody is an array.) |
MsgType | String | Yes | TIM message object type. Valid values: TIMTextElem (text message) TIMLocationElem (location message) TIMFaceElem (emoji message) TIMCustomElem (custom message) TIMSoundElem (voice message) TIMImageElem (image message)TIMFileElem (file message)TIMVideoFileElem (video message) |
MsgContent | Object | Yes | Different message object types ( MsgType ) have different formats (MsgContent ). For details, see Message Formats. |
CloudCustomData | String | No | Custom message data. It is saved in the cloud and will be sent to the peer end. Such data can be pulled after the app is uninstalled and reinstalled. |
{"ActionStatus" : "OK","ErrorInfo" : "","ErrorCode" : 0}
Field | Type | Description |
ActionStatus | String | Request result. OK : Successful; FAIL : Failed |
ErrorCode | Integer | Error code. 0 : successful; other values: failed |
ErrorInfo | String | Error information |
ErrorCode
and ErrorInfo
respectively.
For public error codes (60000 to 79999), see Error Codes.Error Code | Description |
90001 | Failed to parse the JSON request. Make sure the format is valid. |
90002 | The MsgBody in the JSON request does not meet message format requirements or MsgBody is not an array. For more information, see the Message Element TIMMsgElement section in Message Formats. |
90003 | The To_Account field is missing in the JSON request or it is not a string. |
90005 | The MsgRandom field is missing in the JSON request or it is not an integer. |
90006 | The MsgTimeStamp field is missing in the JSON request or it is not an integer. |
90007 | The MsgBody field in the JSON request is not an array. Change it to an array. |
90008 | The From_Account field is missing in the JSON request or it is not an integer. |
90009 | The request requires app admin permissions. |
90010 | The JSON request does not meet message format requirements. For more information, see the Message Element TIMMsgElement section in Message Formats. |
90011 | The number of recipients exceeded 500. Try to reduce the number of accounts in To_Account. |
90012 | The account specified in To_Account does not exist or is not registered. Make sure the account has been imported to Chat and is correct. |
90026 | The offline retention time of the message is incorrect. Messages cannot be retained offline for more than 7 days. |
90030 | The SyncFromOldSystem field is missing in the JSON request or it is not an integer. |
90048 | The requested account does not exist. |
90992 | Internal service error. Try again. If this error code is returned for all requests and third-party callback is enabled, make sure the app server returns the callback results to the Chat backend normally. |
91000 | Internal service error. Try again. |
93000 | The JSON packet exceeds the maximum size of 12 KB. |
Was this page helpful?