- Release Notes
- Product Introduction
- Purchase Guide
- Download
- Get Started
- Quick Integration Solution (Including UI Library) (Recommended)
- Self-implementing Integration Solution
- Client APIs
- SDK APIs (New)
- SDK APIs (Legacy)
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Account Management
- One-to-One Messages
- Profile Management
- Pushing to All Users
- Relationship Chain Management
- Recent Contacts
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Bulk Muting and Unmuting
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Deleting Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Getting Custom Group Attributes
- Modifying Custom Group Attributes
- Clearing Custom Group Attributes
- Resetting Custom Group Attributes
- Global Mute Management
- Operations Management
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callbacks After Recalling Group Messages
- Callback Mutual Authentication Configuration Guide
- Use Cases
- Console Guide
- FAQs
- Security Compliance Certification
- IM Policy
- Smooth Migration Solutions
- Error Codes
- Contact Us
- Release Notes
- Product Introduction
- Purchase Guide
- Download
- Get Started
- Quick Integration Solution (Including UI Library) (Recommended)
- Self-implementing Integration Solution
- Client APIs
- SDK APIs (New)
- SDK APIs (Legacy)
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Account Management
- One-to-One Messages
- Profile Management
- Pushing to All Users
- Relationship Chain Management
- Recent Contacts
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Bulk Muting and Unmuting
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Deleting Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Getting Custom Group Attributes
- Modifying Custom Group Attributes
- Clearing Custom Group Attributes
- Resetting Custom Group Attributes
- Global Mute Management
- Operations Management
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callbacks After Recalling Group Messages
- Callback Mutual Authentication Configuration Guide
- Use Cases
- Console Guide
- FAQs
- Security Compliance Certification
- IM Policy
- Smooth Migration Solutions
- Error Codes
- Contact Us
Based on common use cases, IM provides the following default group types: work group (Work), public group (Public), meeting group (Meeting), audio-video group (AVChatRoom), and Community group (Community). For more information, see Group Types.
You can perform the following operations on groups:
| Group Operation | Description | Remarks |
|---|---|---|
| Create a group | This operation creates a new group. You can specify the group type, name, and a list of users to add to the group. After the group is created, the group ID is returned, which is the unique identifier of the group and can be used to perform other group operations such as message sending and receiving. | The daily limit of net group consumption is 10,000 per app. |
| Transfer a group | This operation transfers a group and changes the group owner to another user. | The app admin can transfer a group through the RESTful API. The other role that can transfer a group is the group owner. |
| Disband a group | This operation disbands a group that has been created on the app. When the group is disbanded, all group members receive a system message stating that the group has been disbanded. | The app admin can call the RESTful API to disband any group. The permission to disband a group on an app varies depending on the member role: For a public group (Public), meeting group (Meeting), audio-video group (AVChatRoom), or community group (Community), only the group owner can disband the group. For a work group (Work), no one in the group can disband the group. |
Note：
- When you create a group, IM assigns a default group ID that begins with @TGS#. You can also manually specify a group ID. For more information, see Custom Group IDs.
- After the group is created, a system message about the group creation is sent to the group owner‘s device to ensure synchronization across multiple devices (once a group is created on one device, all devices instantly perceive the created group.)
Group Profile Management
The group profile includes properties that are specific to a single group, such as the group name, introduction, announcement, and group owner, as well as custom group fields.
| Group Profile Management | Description | Remarks |
|---|---|---|
| Get the group profile | Pull basic group information. If you want to pull custom information, configure APIs for the custom fields that you want to pull. | Group members obtain the group profile: Group members can obtain the group profile. Non-members obtain the group profile: Non-members can only obtain the group profile if it is made public. Obtain the personal profile in the group: Users can obtain their own profiles in all groups, or in a single group. Obtain the profile of a group member: In an audio-video group (AVChatRoom), only some members’ profiles are available, including the group owner, admins, and some group members. |
| Modify the group profile | You can modify the group name, introduction, announcement, profile photo, group name card, grouping joining options, group-level custom fields, in-group roles of members, member-level custom fields, and group message receiving options. | Currently, you can configure callbacks for group name, introduction, announcement, and profile photo URL changes for the app in the console. To enable callbacks for changes in other group information, including group-level custom fields, please submit a ticket. |
Group Member/Group Management
Group member management involves two aspects:
- Obtain and modify user profile in the group. This information can be obtained and set only by users themselves, for example, message receiving options.
- Obtain and modify other group members’ profile, including the role, joining time, time of last message, group name card, and member-level custom information.
| Group Member Management | Description | Remarks |
|---|---|---|
| Obtain group member information | Obtain user profile or other group members’ information | Available information includes the role, joining time, time of last message, group name card, and member-level custom information. |
| Modify a group member’s profile | The group owner, admins, and members can modify group member profiles. | |
| Invite to a group | Invite non-members to a group. | |
| Apply to join a group | A user proactively applies to join a group through the IM SDK. | ApplyJoinOption field in the group profile. |
| Delete a group member | The group owner or a group admin removes a group member from the group | When a group member is removed from the group by the group owner or a group admin, the deleted member receives a system message stating the removal, and other members in the group also receive an event message about the removal. |
| Leave a group | A group member initiates the leave operation | When a group member leaves the group, the leaving member receives a system message stating that he/she has left the group, and other members in the group also receive an event message about the member leaving the group. |
| Obtain the list of groups a user has joined | Pull the list of groups that the current user has joined. The returned result contains only part of the basic information. | To obtain detailed group information, use the group members obtain the group profile feature. |
| List of pending group messages | A group’s pending message includes all group operations that require approval. | You can pull the list of pending group messages, report pending read messages, and process pending group messages (approve or reject). |
</ul style="margin:0;"></ul style="margin:0;"></ul style="margin:0;">
Yes
No
Was this page helpful?