- News and Announcements
- Product Introduction
- Purchase Guide
- Free Demos
- Download
- Get Started
- Chat Interaction (UI Included)
- Video Call (UI Included)
- Desk
- Quick Start
- Integration Guide
- Configure Channels
- Admin Operation Manual
- Configure Agent to Proactively Contact Chat Users
- Login to Management End
- Third-party extension
- Agent Management
- Agent Role Permission Management
- Online Status and Reasons for Short Break
- Skill Group Management
- Session Service Flow Management
- Satisfaction Evaluation
- Quick Reply
- Session Routing and Reception Settings
- Agent Operation Manual
- AI Chatbot
- More Practices
- How to intergrate TUIChat independently in Uniapp（Vue2 & Vue3）
- How to intergrate TUIChat independently in Web（Vue2 & Vue3）
- AI Chatbot
- End-to-end encrypted chat with Virgil
- Super Large Entertainment and Collaboration Community
- Live Room Setup Guide
- How to integrate Tencent IM with Salesforce
- How to integrate Tencent IM with Zendesk
- How to integrate chat widget to your Shopify online store
- Discord Implementation Guide
- How to Integrate Chat into Games
- Flutter Avchatroom
- No UI Integration
- SDK Integration
- Initialization
- Login and Logout
- Message
- Message Overview
- Sending Message
- Receiving Message
- Historical Message
- Forwarding Message
- Modifying Message
- Message Inserting
- Deleting Message
- Clearing Messages
- Recalling Message
- Online Message
- Read Receipt
- Querying Message
- Group @ Message
- Targeted Group Message
- Notification Muting
- Message Extension
- Message Reaction
- Message Translation
- Message Pinning
- Conversation
- Group
- Community Topic
- User Profile and Relationship Chain
- Offline Push
- Local Search
- Signaling
- Client APIs
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Webhooks
- Webhook Overview
- Webhook Command List
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- Before a Group Is Created
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- Before Group Message Is Sent
- After a Group Message Is Sent
- After a Group Is Full
- After a Group Is Disbanded
- After Group Profile Is Modified
- Callback After Recalling Group Messages
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- Before a Topic Is Created
- After a Topic Is Created
- After a Topic Is Deleted
- Topic Profile Change Webhook
- Webhook Mutual Authentication Configuration Guide
- Chatbot webhooks
- Console Guide
- FAQs
- Security Compliance Certification
- Chat Policies
- Migration
- Error Codes
- Contact Us
- News and Announcements
- Product Introduction
- Purchase Guide
- Free Demos
- Download
- Get Started
- Chat Interaction (UI Included)
- Video Call (UI Included)
- Desk
- Quick Start
- Integration Guide
- Configure Channels
- Admin Operation Manual
- Configure Agent to Proactively Contact Chat Users
- Login to Management End
- Third-party extension
- Agent Management
- Agent Role Permission Management
- Online Status and Reasons for Short Break
- Skill Group Management
- Session Service Flow Management
- Satisfaction Evaluation
- Quick Reply
- Session Routing and Reception Settings
- Agent Operation Manual
- AI Chatbot
- More Practices
- How to intergrate TUIChat independently in Uniapp（Vue2 & Vue3）
- How to intergrate TUIChat independently in Web（Vue2 & Vue3）
- AI Chatbot
- End-to-end encrypted chat with Virgil
- Super Large Entertainment and Collaboration Community
- Live Room Setup Guide
- How to integrate Tencent IM with Salesforce
- How to integrate Tencent IM with Zendesk
- How to integrate chat widget to your Shopify online store
- Discord Implementation Guide
- How to Integrate Chat into Games
- Flutter Avchatroom
- No UI Integration
- SDK Integration
- Initialization
- Login and Logout
- Message
- Message Overview
- Sending Message
- Receiving Message
- Historical Message
- Forwarding Message
- Modifying Message
- Message Inserting
- Deleting Message
- Clearing Messages
- Recalling Message
- Online Message
- Read Receipt
- Querying Message
- Group @ Message
- Targeted Group Message
- Notification Muting
- Message Extension
- Message Reaction
- Message Translation
- Message Pinning
- Conversation
- Group
- Community Topic
- User Profile and Relationship Chain
- Offline Push
- Local Search
- Signaling
- Client APIs
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Webhooks
- Webhook Overview
- Webhook Command List
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- Before a Group Is Created
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- Before Group Message Is Sent
- After a Group Message Is Sent
- After a Group Is Full
- After a Group Is Disbanded
- After Group Profile Is Modified
- Callback After Recalling Group Messages
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- Before a Topic Is Created
- After a Topic Is Created
- After a Topic Is Deleted
- Topic Profile Change Webhook
- Webhook Mutual Authentication Configuration Guide
- Chatbot webhooks
- Console Guide
- FAQs
- Security Compliance Certification
- Chat Policies
- Migration
- Error Codes
- Contact Us
Setting the Unread Message Count of a Member
Last updated: 2024-02-07 17:15:28
Caution
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
Group Type ID | RESTful API Support |
Private | Yes. Same as work group (Work) in the new version. |
Public | Yes. |
ChatRoom | No. Same as meeting group (Meeting) in the new version. |
AVChatRoom | No. |
Community | Yes. |
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.
Parameter | Description |
https | The request protocol is HTTPS, and the request method is POST. |
xxxxxx | The country/region where your SDKAppID is located. China: console.tim.qq.com Singapore: adminapisgp.im.qcloud.com Seoul: adminapikr.im.qcloud.comFrankfurt: adminapiger.im.qcloud.comIndia: adminapiind.im.qcloud.comSilicon Valley: adminapiusa.im.qcloud.comJakarta: adminapiidn.im.qcloud.com |
v4/group_open_http_svc/set_unread_msg_num | Request API |
sdkappid | SDKAppID assigned by the IM console when an app is created |
identifier | |
usersig | Signature generated in the app admin account. For details on how to generate the signature, please see Generating UserSig. |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295 |
contenttype | Request format. The value is always json. |
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
Field | Type | Required | Description |
GroupId | String | Yes | ID of the target group |
Member_Account | String | Yes | Target group member |
UnreadMsgNum | Integer | Yes | Unread message count of the target member |
Sample response packet
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
Response packet fields
Field | Type | Description |
ActionStatus | String | Request result. OK: successful; FAIL: failed. |
ErrorInfo | String | Error information |
ErrorCode | Integer | Error code. 0: successful; other values: failed. |
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:Error Code | Description |
10002 | Internal server error. Try again. |
10003 | Invalid command word. |
10004 | Invalid parameter. Check the error description and troubleshoot the issue. |
10007 | No operation permissions. For example, a common member in a public group tries to remove other users from the group, but only the app admin can do so. |
10010 | The group does not exist or has been deleted. |
10015 | Invalid group ID. Make sure to use the correct group ID. |
Yes
No
Was this page helpful?