Feature Description

• This API is used by app admins to set the unread message count of a group member. When this API is called, no callback is triggered and no notification is sent.
• When the app needs to be migrated from another IM system to Tencent Cloud IM, this API is used to set the unread message count of group members.

API Calling Description

Applicable group types

These are the 4 built-in group types in IM. For detailed information, see the Group System.

ChatRooms and AVChatrooms do not support unread message counts. Therefore, you cannot set an unread message count for members of these two group types. However, no error will be returned if you try.

Sample request URL

https://console.tim.qq.com/v4/group_open_http_svc/set_unread_msg_num?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 calling frequency

The maximum calling frequency is 200 calls per second.

Sample request packet

In the following example, the unread message count of a specified group member is set.
If the unread message count specified by this API is greater than the current number of messages in the group, the unread message count is set to the current number of messages in the group.

{
    "GroupId": "@TGS#2CLUZEAEJ", // Target group (required)
    "Member_Account": "bob", // Target group member (required)
    "UnreadMsgNum":5          // Unread message count of this member
}

Request packet fields

Sample response packet body

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

Response packet 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 packet fields such as ErrorCode and ErrorInfo.
For public error codes (60000 to 79999), see Error Codes.
The list below contains error codes specific to this API:

API Debugging Tool

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

Reference

Sending system messages in a group (v4/group_open_http_svc/send_group_system_notification)