Group Type | Support for This RESTful API |
Private | Yes. Same as work groups (Work) in the new version. |
Public | Yes |
ChatRoom | Yes. Same as meeting groups (Meeting) in the new version. |
AVChatRoom | No |
Community | Yes |
https://xxxxxx/v4/group_open_http_svc/import_group_msg?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/group_open_http_svc/import_group_msg | 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. The value is fixed to json . |
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"}}]}]}
Field | Type | Required | Description |
GroupId | String | Yes | ID of the group for which to import messages |
RecentContactFlag | Integer | No | Whether to trigger conversation update. The value 1 means to trigger conversation update. Conversation update is not triggered by default. This field is not supported by audio-video groups (AVChatRoom) and community groups. |
MsgList | Object | Yes | List of the messages to import |
From_Account | String | Yes | Message sender |
SendTime | Integer | Yes | Message sending time |
Random | Integer | No | A 32-bit unsigned integer. If the random numbers of two messages within five minutes are the same, the later message will be discarded as a repeated message. |
MsgBody | Array | Yes | |
MsgType | String | Yes | TIM message object type. Valid values: TIMTextElem (text message), TIMFaceElem (emoji message), TIMLocationElem (location message), TIMCustomElem (custom message) |
MsgContent | Object | Yes | |
TopicId | String | No | ID of the topic to which messages are imported. This field applies only to topic-enabled community groups. |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"ImportMsgResult": [{"MsgSeq": 1,"MsgTime": 1620808101,"Result": 0},{"MsgSeq": 2,"MsgTime": 1620892821,"Result": 0},]}
Field | Type | Description |
ActionStatus | String | Request result. OK : successful; FAIL : failed |
ErrorInfo | String | Error information |
ErrorCode | Integer | Error code. 0 : Successful; other values: Failed |
ImportMsgResult | Array | Message import result |
Result | Integer | Result of each message 0 : The message was imported successfully. 10004 : The sending time of the message is invalid. 80002 : The message content exceeds the limit of 12,000 bytes. Please adjust the message size. |
MsgTime | Integer | Message timestamp |
MsgSeq | Integer | Message sequence number, the unique identifier of a message |
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:Error Code | Description |
10004 | Invalid parameter. Check the error description and troubleshoot the issue. |
10007 | No operation permissions. This error occurs when, for example, a member in a public group tries to remove other users from the group (only the app admin can perform this operation). |
10010 | The group does not exist or has been deleted. |
10015 | The group ID is invalid. Use the correct group ID. |
10020 | The message content is too long. Currently, the maximum message length supported is 12 KB. Please adjust the message length. |
Was this page helpful?