please select
  • UIKit
  • SDK
  • Server APIs
Chat/
SDK/
Unity（Game Solution）/
Conversation/
SDK
  • Run Demo
  • 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
  • Changelog
  • Guideline for Beginners
  • 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
Docs Overview/
Chat/
SDK/
Unity（Game Solution）/
Conversation/
Conversation Group/

Conversation Group

Overview

In some cases, you may need to group conversations, for example, into a "Product experience" or "R&D" group, which can be implemented through the following API.
Note
To use this feature, you need to purchase the Premium edition.
This feature is supported only on the enhanced edition on native SDK 6.5 or later.

Conversation Group

Creating a conversation group

Call the ConvCreateConversationGroup (details) API to create a conversation group.
Note
Up to 20 conversation groups can be created. After this limit is exceeded, the 51010 error will be reported. Groups that are no longer used should be promptly deleted.
Attribute
Definition
Description
groupName
Conversation group name
It must be greater than 0 in length and can contain up to 32 bytes; otherwise, the 51011 error will be reported.
conversationIDList
List of conversation IDs
It cannot be empty.
Sample code:
    // Create a conversation group
    TIMResult res = TencentIMSDK.ConvCreateConversationGroup("groupName", new List<string> {
      conv_id
    }, (int code, string desc, List<ConversationOperationResult> results, string user_data)=>{
      // Async result of the conversation group creation
    });

Deleting a conversation group

Call the ConvDeleteConversationGroup (details) API to delete a conversation group.
Note
If the target conversation group doesn't exist, the 51009 error will be reported.
Sample code:
    // Delete the conversation group
    TIMResult res = TencentIMSDK.ConvDeleteConversationGroup("groupName", (int code, string desc, string result, string user_data)=>{
      // Async result of the conversation group deletion
    });

Renaming a conversation group

Call the ConvRenameConversationGroup (details) API to rename a conversation group.
Sample code:
    // Rename a conversation group
    TIMResult res = TencentIMSDK.ConvRenameConversationGroup("oldGroupName", "newGroupName", (int code, string desc, string result, string user_data)=>{
      // Async result of the conversation group renaming
    });

Getting the list of conversation groups

Call the ConvGetConversationGroupList (details) API to get the list of conversation groups.
Sample code:
    // Get the list of conversation groups
    TIMResult res = TencentIMSDK.ConvGetConversationGroupList((int code, string desc, List<string> results, string user_data)=>{
      // Async result of the conversation group list getting
    });
To get the list of conversations under a group, you can call the ConvGetConversationListByFilter (details) API.
Sample code:
    // Get the conversation list
    ConversationListFilter filter = new ConversationListFilter
    {
        conversation_list_filter_conv_type: TIMConvType.kTIMConv_C2C,// Conversation type
        conversation_list_filter_mark_type: TIMConversationMarkType.kTIMConversationMarkTypeStar,// Conversation mark type
        conversation_list_filter_conversation_group: "groupName"// Named of the group whose data is to be pulled
    };
    ulong next_seq = 0; // Pulling cursor
    uint count = 10; // Pulling count
    // Advanced API for getting the conversation list
    TIMResult res = TencentIMSDK.ConvGetConversationListByFilter(filter, next_seq, count, (int code, string desc, ConversationListResult result, string user_data)=>{
      // Async result of the conversation list getting
      if (code == 0) {
        // Pulled successfully
        bool isFinished = result.conversation_list_result_is_finished; // Whether pulling is completed
        next_seq = result.conversation_list_result_next_seq; // Cursor for subsequent paged pulling
        var conversationList = result.conversation_list_result_conv_list; // List of messages pulled this time
        // If more conversations need to be pulled, use the returned `nextSeq` to continue pulling until `isFinished` is `true`.
      }
    });

Adding a conversation to a group

After a group is created, you can call the ConvAddConversationsToGroup (details) API to add a conversation to the group.
Sample code:
    // Add a conversation to a conversation group
    TIMResult res = TencentIMSDK.ConvAddConversationsToGroup("groupName", new List<string> {
      conv_id
    }, (int code, string desc, List<ConversationOperationResult> results, string user_data)=>{
      // Async result of adding a conversation to a conversation group
    });

Deleting a conversation from a group

Call the ConvDeleteConversationsFromGroup (details) API to delete a conversation from a group.
Sample code:
    // Delete a conversation from a conversation group
    TIMResult res = TencentIMSDK.ConvDeleteConversationsFromGroup("groupName", new List<string> {
      conv_id
    }, (int code, string desc, List<ConversationOperationResult> results, string user_data)=>{
      // Async result of deleting a conversation from a conversation group
    });

Listening for the notification of a conversation group change

Call the SetConvEventCallback (details) API to listen for conversation group change notifications.
Sample code:
    // Set the conversation listener
    TencentIMSDK.SetConvEventCallback((TIMConvEvent conv_event, List<ConvInfo> conv_list, string user_data)=>{
      // Process the callback logic
    });