Starter Deal! First 3 month from only  $9.9 /month!
Starter Deal! First 3 month from only  $9.9 /month!
Grab It Now 
Chat
  • Web
    • TUIKit
      • Overview
      • Installaton
        • TUIKit
          • Vue
          • React
        • TUIChat Only
          • Vue
      • Features
        • Reactions
        • Read Receipt
        • Typing Status
        • User Online Status
      • Themes
        • Setting UI Styles
          • Web
          • Mobile
      • Customization
        • Customize Messages
      • Localization
    • SDK
      • Install Chat SDK
      • Initialize Chat SDK
      • Login and Logout
      • Client APIs
      • Message
        • Overview
        • Send a Message
        • Receive a Message
        • Historical Message
        • Forward Messages
        • Modify a Message
        • Delete Messages
        • Clear History Message
        • Recall a Message
        • Send an Online Message
        • Message Read Receipt
        • Query Messages
        • Targeted Group Message
        • Do not Notify
        • Key-Value Extensions
        • Translation
      • Conversation
        • Overview
        • Conversation List
        • Get Conversations
        • Unread Count
        • Pin Conversations
        • Delete Conversations
        • Mark
        • Conversation Group
      • Group
        • Overview
        • Group Management
        • Group Profile
        • Group Member Management
        • Group Member Profile
        • Custom Group Attribute
        • Group Counter
      • Community Topic
        • Community Management
      • User Profile and Relationship Chain
        • User Profile
        • User Status
        • Friend Management
        • Friend List
        • Block List
  • Android
    • Run Demo
    • UIKit
      • Overview
      • Getting Started
      • Installation
        • TUIKit
        • TUIChat Only
      • Features
        • Reactions
        • Read Receipt
        • User Online Status
        • Search Messages
      • Customization
        • Customize Messages
        • Customize Emojis and Stickers
      • Localization
    • SDK
      • Install Chat SDK
      • Initialize Chat SDK
      • Login and Logout
      • Message
        • Overview
        • Send a Message
        • Receive a Message
        • Retrieve Messages
        • Forward Messages
        • Modify a Message
        • Insert a Message
        • Delete Messages
        • Clear History Messages
        • Recall a Message
        • Send an Online Message
        • Message Read Receipt
        • Query Messages
        • Metions
        • Targeted Group Message
        • Do not Notify
        • Key-Value Extensions
        • Reactions
        • Translation
        • Pin Messages
      • Conversation
        • Overview
        • Conversation List
        • Get Conversations
        • Unread Count
        • Pin Conversations
        • Delete Conversations
        • Draft
        • Mark
        • Conversation Group
      • Group
        • Overview
        • Manage Group
        • Profile
        • Manage Members
        • Member Profile
        • Attribute
        • Counter
      • Community and Topic
        • Manage Community
        • Permission Group
      • User
        • User Profile
        • User Status
        • Manage Friends
        • Friend Group
        • Block Lists
      • Local Search
        • Search Messages
        • Search Friends
        • Search Groups
        • Search Group Members
      • Signaling
      • API Reference
        • Java
  • iOS and macOS
    • Run Demo
    • UIKit
      • Overview
      • Getting Started
      • Installation
        • TUIKit
        • TUIChat Only
      • Features
        • Reactions
        • Read Receipt
        • User Online Status
        • Search Messages
      • Customization
        • Customize Messages
        • Customize Emojis and Stickers
      • Localization
    • SDK
      • Installation
        • iOS
        • macOS
      • Initialize Chat SDK
      • Login and Logout
      • Message
        • Overview
        • Send a Message
        • Receive a Message
        • Retrieve Messages
        • Forward Messages
        • Modify a Message
        • Insert a Message
        • Delete Messages
        • Clear History Messages
        • Recall a Message
        • Send an Online Message
        • Message Read Receipt
        • Query Messages
        • Metions
        • Targeted Group Messages
        • Do not Notify
        • Key-Value Extensions
        • Reactions
        • Translation
        • Pin Messages
      • Conversation
        • Overview
        • Conversation List
        • Get Conversations
        • Unread Count
        • Pin Conversations
        • Delete Conversations
        • Draft
        • Mark
        • Conversation Group
      • Group
        • Overview
        • Manage Group
        • Profile
        • Manage Members
        • Member Profile
        • Attribute
        • Counter
      • Community and Topic
        • Manage Community
        • Permission Group
      • User
        • User Profile
        • User Status
        • Manage Friends
        • Friend Group
        • Block Lists
      • Local Search
        • Search Messages
        • Search Friends
        • Search Groups
        • Search Group Members
      • Signaling
      • API Reference
        • Swift
        • Objective-C
  • Windows
    • SDK
      • Install Chat SDK
      • Initialize Chat SDK
      • Login and Logout
      • Message
        • Overview
        • Send a Message
        • Receive a Message
        • Retrieve Messages
        • Forward Messages
        • Modify a Message
        • Insert a Message
        • Delete Messages
        • Clear History Messages
        • Recall a Message
        • Send an Online Message
        • Message Read Receipt
        • Query Messages
        • Metions
        • Targeted Group Messages
        • Do not Notify
        • Key-Value Extensions
        • Reactions
        • Translation
        • Pin Messages
      • Conversation
        • Overview
        • Conversation List
        • Get Conversations
        • Unread Count
        • Pin Conversations
        • Delete Conversations
        • Draft
        • Mark
        • Conversation Group
      • Group
        • Overview
        • Manage Group
        • Profile
        • Manage Members
        • Member Profile
        • Attribute
        • Counter
      • Community and Topic
        • Manage Community
        • Permission Group
      • User
        • User Profile
        • User Status
        • Manage Friends
        • Friend Group
        • Block Lists
      • Local Search
        • Search Messages
        • Search Friends
        • Search Groups
        • Search Group Members
      • Signaling
      • API Reference
        • C++
        • C
  • Flutter
    • Run Demo
    • UIKIT
      • Overview
      • Installation
        • integrated
      • Features
        • Local Search
        • Offline Push
        • Online Status
        • Typing Status
        • Message Read Receipt
        • Message Reactions
        • Internationalization
        • Adding Custom Messages
        • Emoji & Stickers
      • Customization
        • Modifying UI Themes
        • Setting UI Styles
    • SDK
      • Install Chat SDK
        • Install
      • Initialize Chat SDK
        • Initialize
      • Login And Logout
        • 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
      • Conversation
        • Conversation Overview
        • Conversation List
        • Getting Conversation
        • Conversation Unread Count
        • Pinning Conversation to the Top
        • Deleting Conversation
        • Conversation Draft
        • Conversation Group
      • Group
        • Group Overview
        • Group Management
        • Group Profile
        • Group Member Management
        • Group Member Profile
        • Custom Group Attribute
      • User
        • User Profile
        • Friend Management
        • Friend List
        • Blocklist
      • Offline Push
        • Offline Push
      • Signaling
        • Signaling Management
      • Local Search
        • Searching for Message
        • Searching for Friend
        • Searching Group
        • Searching for Group Member
      • API Reference
        • Client APIs
  • React Native
    • Run Demo
    • SDK
      • 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
      • Group
        • Overview
        • Group Management
        • Group Profile
        • Group Member Management
        • Group Member Profile
        • Custom Group Attribute
        • Community Management
      • User
        • User Profile
        • Friend Management
        • Friend List
        • Blocklist
      • Offline Push
        • Offline Push
      • Local Search
        • Searching for Message
        • Searching for Friend
        • Searching Group
        • Searching for Group Member
      • Signaling
        • Signaling Management
  • Unity(Game Solution)
    • Run Demo
    • SDK
      • SDK Integration
      • Initialization
      • Login and Logout
      • Message
        • Message Overview
        • Sending Message
        • Receiving Message
        • Historical Message
        • Forwarding Message
        • Modifying Message
        • Deleting Message
        • Clearing Messages
        • Recalling Message
        • Online Message
        • Read Receipt
        • Querying Message
        • Group @ Message
        • Targeted Group Message
        • Notification Muting
        • Message Extension
      • Conversation
        • Conversation Overview
        • Conversation List
        • Getting Conversation
        • Conversation Unread Count
        • Pinning Conversation to the Top
        • Deleting Conversation
        • Conversation Draft
        • Conversation Mark
        • Conversation Group
      • Group
        • Group Overview
        • Group Management
        • Group Profile
        • Group Member Management
        • Group Member Profile
        • Custom Group Attribute
        • Group Counter
      • User
        • User Profile
        • User Status
        • Friend Management
        • Friend List
        • Blocklist
  • Unreal Engine(Game Solution)
    • SDK
      • SDK Integration
  • Free Demos
  • Server APIs
    • Generating UserSig
    • RESTful APIs
      • RESTful API Overview
      • RESTful API List
      • Message Related
        • Send Message
          • Sending One-to-One Messages to One User
          • Sending One-to-One Messages to Multiple Users
          • Sending Ordinary Messages in a Group
          • Sending System Messages in a Group
          • Broadcast Message of Audio-Video Group
          • Importing One-to-One Messages
          • Importing Group Messages
        • Historical Message
          • Modifying Historical One-to-one Messages
          • Modifying Historical Group Messages
          • Pulling Historical One-to-one Messages
          • Pulling Historical Group Messages
        • Delete Message
          • Deleting Messages Sent by a Specified User
        • Withdraw Message
          • Recalling One-to-One Messages
          • Recalling Group Messages
        • Read Receipt
          • Marking One-to-One Messages as Read
          • Pulling Group Message Read Receipt Details
          • Pulling Read Receipts for Group Messages
        • Message Extension
          • Pulling the Message Extension of a One-to-One Message
          • Configuring Message Extension for a One-to-One Message
          • Pulling Message Extension of a Group Message
          • Configuring Message Extension for a Group Message
        • Pushing to All Users
          • API for Pushing to All Users
          • Pushing to All Users
          • Setting Application Attribute Names
          • Getting Application Attribute Names
          • Getting User Attributes
          • Setting User Attributes
          • Deleting User Attributes
          • Getting User Tags
          • Adding User Tags
          • Deleting User Tags
          • Deleting All Tags of a User
      • Session Related
        • Conversation List
          • Pulling a conversation list
        • Session Unread Count
          • Setting the Unread Message Count of a Member
          • Querying Unread One-to-One Message Count
        • Delete Session
          • Deleting a conversation
        • Session Grouping Tag
          • Creating Conversation Group Data
          • Updating Conversation Group Data
          • Deleting Conversation Group Data
          • Creating or Updating Conversation Mark Data
          • Searching for Conversation Group Marks
          • Pulling Conversation Group Mark Data
      • Group Related
        • Group Management
          • Getting All Groups in an App
          • Creating a Group
          • Disbanding a Group
          • Getting the Groups a User Has Joined
        • Group Information
          • Getting Group Profiles
          • Modifying the Profile of a Group
          • Importing a Group Profile
        • Group Member Management
          • Adding Group Members
          • Deleting Group Members
          • Banning Group Members
          • Unbanning Group Members
          • Bulk Muting and Unmuting
          • Getting the List of Muted Group Members
          • Changing Group Owner
          • Querying the Roles of Users in a Group
          • Importing Group Members
        • Group Member Information
          • Getting Group Member Profiles
          • Modifying the Profile of a Group Member
        • Group Custom Attributes
          • Getting Group Custom Attributes
          • Modifying Group Custom Attributes
          • Clearing Group Custom Attributes
          • Resetting Group Custom Attributes
          • Deleting Group Custom Attributes
        • Live Group Management
          • Getting the Number of Online Users in an Audio-Video Group
          • Getting the List of Online Members in Audio-Video Group
          • Setting Audio-Video Group Member Marks
          • Getting the List of Banned Group Members.
        • Community Management
          • Creating Topic
          • Deleting Topic
          • Getting Topic Profile
          • Modifying Topic Profile
          • Importing Topic Profiles
        • Group Counter
          • Getting Group Counters
          • Updating Group Counters
          • Deleting Group Counters
      • User Management
        • Account Management
          • Importing a Single Account
          • Importing Multiple Accounts
          • Deleting Accounts
          • Querying Accounts
        • User Information
          • Setting Profiles
          • Pulling Profiles
        • User Status
          • Invalidating Account Login States
          • Querying Account Online Status
        • Friend Management
          • Adding Friends
          • Importing Friends
          • Updating Friends
          • Deleting Friends
          • Deleting All Friends
          • Verifying Friends
          • Pulling Friends
          • Pulling Specified Friends
        • Friend Lists
          • Adding Lists
          • Deleting Lists
          • Pulling Lists
        • Blocklist
          • Blocklisting Users
          • Unblocklisting Users
          • Pulling a Blacklist
          • Verifying Users on a Blocklist
      • Global Mute Management
        • Setting Global Mute
        • Querying Global Mute
      • Operations Management
        • Pulling Operations Data
        • Downloading Recent Messages
        • Getting Server IP Addresses
      • Chatbots
        • Pulling Chatbot Accounts
        • Creating Chatbot Accounts
        • Deleting Chatbot Accounts
    • Webhooks
      • Webhook Overview
      • Webhook Command List
      • Operations Management Callbacks
        • API Overclocking Alarm Callbacks
      • Online Status Webhooks
        • Status Change Webhooks
      • Relationship Chain Webhooks
        • After a Profile Is Updated
        • Before a Friend Is Added
        • Before a Friend Request Is Responded
        • After a Friend Is Added
        • After a Friend Is Deleted
        • After a User Is Added to Blocklist
        • After a User Is Removed from Blocklist
      • One-to-One Message Webhooks
        • Before a One-to-One Message Is Sent
        • After a One-to-One Message Is Sent
        • After a One-to-One message Is Marked as Read
        • After A One-to-One Message Is Recalled
      • 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
        • Callback After Group Member Profile Changed
        • Callback After Group Attribute Changed
        • Callback After Read Receipt
        • Callback After the Group Owner Changed
      • Webhook Mutual Authentication Configuration Guide
        • Apache Mutual Authentication Configuration
        • Nginx Mutual Authentication Configuration
      • Chatbot webhooks
        • Chatbot Passthrough Message Callback
  • Console Guide
    • Creating and Upgrading an Application
    • Basic Configuration
    • Feature Configuration
    • Account Management
    • Group Management
    • Webhook Configuration
  • Product Introduction
    • Message Management
      • One-to-One Message
      • Message Storage
      • Offline Push
      • Group Message
      • Message Formats
    • Account System
      • Login Authentication
      • Online Status Management
    • Group Related
      • Group System
      • Group Management
    • User Profile and Relationship Chain
      • Profile Management
      • Relationship Chain Management
  • Purchase Guide
    • Billing Overview
    • Pricing
  • Error Codes
Chat

User Status

Feature Description

Each user has two statuses:
General status. It is preset in the SDK and cannot be modified.
Custom status. It can be customized and modified by users. For example, it can be set to "Listening to music" or "On the call".
The general user status is available in the following three types:
Online (TencentCloudChat.TYPES.USER_STATUS_ONLINE): The current user has logged in and can receive and send messages.
Offline (TencentCloudChat.TYPES.USER_STATUS_OFFLINE): The offline status will not be triggered when the SDK for web is logged in/out. It will be triggered in the application with the IM SDK for React Native.
Not logged in (TencentCloudChat.TYPES.USER_STATUS_UNLOGINED): The user hasn't logged in since registration or has called logout to log out.
Note
1. Some of the following features are supported only by the Premium edition. Make sure that you have purchased it before use.
2. You need to enable user status in the Chat console for some of the following features. Make sure that you have enabled it before use.
3. User status is relevant to the current user but not the device. If an account is logged in on multiple devices at the same time, the status cannot be queried or set by device.




Setting the Custom Status

Call the setSelfStatus API to set a user's own custom status through the customStatus field. Then, notifications of a change in the user's own custom status will be received through the TencentCloudChat.EVENT.USER_STATUS_UPDATED event.
The following describes how to clear the custom status:
1. When calling the setSelfStatus API, you can leave the customStatus field empty to clear the status.
2. A period of time after the account logs out of the SDK for web, the Chat backend will automatically clear the custom status and trigger the status change notification.
Note
1. To call setSelfStatus, you don't need to upgrade to the Premium edition or enable the feature in the console.
2. This API can be called an unlimited number of times.
API
chat.setSelfStatus(options);
Parameter
The options parameter is of the Object type. It contains the following attribute values:
Name
Type
Description
customStatus
String
Custom user status
Returned value
Promise
Sample
// Set `customStatus` to the empty string `''` to clear the user's own custom status
let promise = chat.setSelfStatus({customStatus: 'xxx'});
promise.then(function(imResponse) {
console.log(imResponse.data);
const { userID, statusType, customStatus } = imResponse.data;
// userID - User ID
// statusType - User status. The enumerated values are described as follows:
// TencentCloudChat.TYPES.USER_STATUS_UNKNOWN - Unknown
// TencentCloudChat.TYPES.USER_STATUS_ONLINE - Online
// TencentCloudChat.TYPES.USER_STATUS_OFFLINE - Offline
// TencentCloudChat.TYPES.USER_STATUS_UNLOGINED - Not logged in
// customStatus - Custom user status
}).catch(function(imError) {
console.warn('setSelfStatus error:', imError); // Failed to set the user's own custom status
});

Querying the User Status

Call the getUserStatus API to query the status of the user or another user. The API will return the general status and custom status of the queried user.
Note
1. To allow users to query their own status, you don't need to upgrade to the Premium edition or enable the feature in the console. And in this case, this API can be called an unlimited number of times.
2. To query the status of other user, you need to upgrade to the Premium edition and enable Set user status query and status change notification in the Chat console in advance; otherwise, an error will be reported when getUserStatus is called. In this case, this API can be called 20 times every five seconds, and the statuses of up to 500 users can be queried at a time.
API
chat.getUserStatus(options);
Parameter
The options parameter is of the Object type. It contains the following attribute values:
Name
Type
Description
userIDList
Array
List of the userID values to be queried. Users only need to pass in their own userID to query their own status.
Returned value
Promise
Sample
// Query the user's own status
// When `userIDList` contains only the user's own `userID`
// it indicates to query only the user's own status.
let promise = chat.getUserStatus({userIDList: [`${myUserID}`]});
promise.then(function(imResponse) {
const { successUserList } = imResponse.data;
successUserList.forEach((item) => {
const { userID, statusType, customStatus } = item;
// userID - User ID
// statusType - User status. The enumerated values are described as follows:
// TencentCloudChat.TYPES.USER_STATUS_UNKNOWN - Unknown
// TencentCloudChat.TYPES.USER_STATUS_ONLINE - Online
// TencentCloudChat.TYPES.USER_STATUS_OFFLINE - Offline
// TencentCloudChat.TYPES.USER_STATUS_UNLOGINED - Not logged in
// customStatus - Custom user status
});
}).catch(function(imError) {
console.warn('getUserStatus error:', imError); // Failed to obtain the user status
});
// Query the status of another user
let promise = chat.getUserStatus({userIDList: ['user0', 'user1']});
promise.then(function(imResponse) {
const { successUserList, failureUserList } = imResponse.data;
// List of `userID` values of the users whose statuses were queried successfully
successUserList.forEach((item) => {
const { userID, statusType, customStatus } = item;
// userID - User ID
// statusType - User status. The enumerated values are described as follows:
// TencentCloudChat.TYPES.USER_STATUS_UNKNOWN - Unknown
// TencentCloudChat.TYPES.USER_STATUS_ONLINE - Online
// TencentCloudChat.TYPES.USER_STATUS_OFFLINE - Offline
// TencentCloudChat.TYPES.USER_STATUS_UNLOGINED - Not logged in
// customStatus - Custom user status
});

// List of `userID` values of the users whose statuses failed to be queried
failureUserList.forEach((item) => {
const { userID, code, message } = item;
// userID - `userID` of the user whose status failed to be queried
// code - Error code for the failed query
// message - Error message for the failed query
});
}).catch(function(imError) {
console.warn('getUserStatus error:', imError); // Failed to obtain the user status
});

Subscribing to the User Status

Call the subscribeUserStatus API to subscribe to the status of the specified user. When the user status (including general status and custom status) subscribed to changes, the status change notification can be received through the TencentCloudChat.EVENT.USER_STATUS_UPDATED event.
Note
1. To use this feature, you need to upgrade to the Premium edition. For more information, see Pricing.
2. To use this feature, you need to enable Set user status query and status change notification in the Chat console in advance; otherwise, an error will be reported when subscribeUserStatus is called.
3. By default, this API can be called 20 times every five seconds, and the statuses of up to 100 users can be subscribed to at a time.
4. To get the changes in the statuses of all of a user's friends, you don't need to call this API, and you can enable automatic notifications of friends' statuses in the Chat console, after which a friend status change notification can be received through the TencentCloudChat.EVENT.USER_STATUS_UPDATED callback.
API
chat.subscribeUserStatus(options);
Parameter
The options parameter is of the Object type. It contains the following attribute values:
Name
Type
Description
userIDList
Array
List of userID values. The number of userID values cannot exceed 100 per request.
Returned value
Promise
Sample
let promise = chat.subscribeUserStatus({userIDList: ['user0', 'user1']});
promise.then(function(imResponse) {
const { failureUserList } = imResponse.data;
// List of `userID` values of the users whose statuses failed to be subscribed to
failureUserList.forEach((item) => {
const { userID, code, message } = item;
// userID - `userID` of the user whose status failed to be queried
// code - Error code for the failed query
// message - Error message for the failed query
});
}).catch(function(imError) {
console.warn('subscribeUserStatus error:', imError); // Failed to subscribe to the user status
});

Unsubscribing from the User Status

To stop receiving notifications of changes in user statuses, call the unsubscribeUserStatus API to unsubscribe from the user status or clear the subscription list. If you don't want the subscription list to be cleared manually, after the account is logged out, the Chat backend will clear it after a certain period of time by default.
Note
1. To use this feature, you need to upgrade to the Premium edition. For more information, see Pricing.
2. To use this feature, you need to enable Set user status query and status change notification in the Chat console in advance; otherwise, an error will be reported when unsubscribeUserStatus is called.
3. By default, this API can be called 20 times every five seconds, and the statuses of up to 100 users can be unsubscribed from at a time.
API
chat.unsubscribeUserStatus(options);
Parameter
When the options parameter is undefined, it indicates to cancel all the current subscriptions. When it is of the Object type, it contains the following attribute values:
Name
Type
Description
userIDList
Array
List of userID values. The number of userID values cannot exceed 100 per request. When userIDList is an empty array or undefined, it indicates to cancel all the current subscriptions.
Returned value
Promise
Sample
// Unsubscribe from some of the current user statuses
let promise = chat.unsubscribeUserStatus({userIDList: ['user0', 'user1']});
promise.then(function(imResponse) {
const { failureUserList } = imResponse.data;
// List of `userID` values of the users whose statuses failed to be unsubscribed from
failureUserList.forEach((item) => {
const { userID, code, message } = item;
// userID - `userID` of the user whose status failed to be queried
// code - Error code for the failed query
// message - Error message for the failed query
});
}).catch(function(imError) {
console.warn('unsubscribeUserStatus error:', imError); // Failed to unsubscribe from the user status
});
// Unsubscribe from all the current subscribed user statuses
let promise = chat.unsubscribeUserStatus();
promise.then(function(imResponse) {
const { failureUserList } = imResponse.data;
// List of `userID` values of the users whose statuses failed to be unsubscribed from
failureUserList.forEach((item) => {
const { userID, code, message } = item;
// userID - `userID` of the user whose status failed to be queried
// code - Error code for the failed query
// message - Error message for the failed query
});
}).catch(function(imError) {
console.warn('unsubscribeUserStatus error:', imError); // Failed to unsubscribe from the user status
});

Status Change Notification

Depending on the user type, status changes can be divided into three types:
1. Change in a user's own status.
2. Change in a friend's status.
3. Change in a non-friend user's status.
The SDK will deliver the TencentCloudChat.EVENT.USER_STATUS_UPDATED event to notify a status change of any of the three types.
Although all the status notifications are returned in the TencentCloudChat.EVENT.USER_STATUS_UPDATED callback, they are triggered in different ways for different user types.

Notification of a change in a user's own status

If you have registered the TencentCloudChat.EVENT.USER_STATUS_UPDATED event listener, when a user's own status changes, the SDK will deliver the TencentCloudChat.EVENT.USER_STATUS_UPDATED event, where the user can get the latest own status.

Notification of a change in a friend's status

1. If you have enabled automatic notifications of friends' statuses in the Chat console, when the status of a user's friend changes, the SDK will deliver the TencentCloudChat.EVENT.USER_STATUS_UPDATED event, where the latest status of the friend can be obtained.
2. If you don't enable automatic notifications of friends' statuses and want to get friends' status changes, you need to call subscribeUserStatus to subscribe to friends' statuses. When a friend's status changes, the SDK will deliver the TencentCloudChat.EVENT.USER_STATUS_UPDATED callback.
3. If you neither enable automatic notifications of friends' statuses nor call subscribeUserStatus to subscribe to friends' statuses, changes in friends' statuses cannot be obtained.

Change in a non-friend user's status

To get the change in a non-friend user's status, you can only call subscribeUserStatus to subscribe to the status. When the user's status changes, the TencentCloudChat.EVENT.USER_STATUS_UPDATED callback will be triggered, where the user can get the latest status of the non-friend user.
Sample
let onUserStatusUpdated = function(event) {
console.log(event.data);
const userStatusList = event.data;
userStatusList.forEach((item) => {
const { userID, statusType, customStatus } = item;
// userID - User ID
// statusType - User status. The enumerated values are described as follows:
// TencentCloudChat.TYPES.USER_STATUS_UNKNOWN - Unknown
// TencentCloudChat.TYPES.USER_STATUS_ONLINE - Online
// TencentCloudChat.TYPES.USER_STATUS_OFFLINE - Offline
// TencentCloudChat.TYPES.USER_STATUS_UNLOGINED - Not logged in
// customStatus - Custom user status
})
};
chat.on(TencentCloudChat.EVENT.USER_STATUS_UPDATED, onUserStatusUpdated);

Multi-client and multi-instance sync of status change notifications

If you have enabled multi-client login or multi-instance login on the same platform (for more information, see Feature Configuration), an account can be logged in on different clients. When the status of the user logged in on one of the clients changes, the Chat backend will send the status change notification to other logged-in devices.

FAQs

What should I do if error code 72001 is reported when I call the subscribe/unsubscribe API?

Error code 72001 indicates that the feature is not enabled in the console. You need to log in to the Chat console and enable the feature.