Note：

This document is only for users who are migrating their apps to Tencent Cloud IM.

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 you are migrating your app from another IM system to Tencent Cloud IM, you can use this API to set the unread message count of group members.

API Call Description

Applicable group types

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

Note：

ChatRoom and AVChatroom (audio-video) groups do not support unread message counts. Therefore, you cannot set an unread message count for members of these two group types. If you try to do so, no error will be returned.

Sample request URL

https://xxxxxx/v4/group_open_http_svc/set_unread_msg_num?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 Introduction.

Maximum call frequency

200 calls per second

Sample request packet

This example sets the unread message count of a specified group member.
If the unread message count specified by this API is greater than the current number of messages in the group, the unread message count will be 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 the target member
}

Request packet fields

Sample response packet

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

Response packet 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:

API Debugging Tool

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

Reference

Sending System Messages in a Group (v4/group_open_http_svc/send_group_system_notification)