群组是支持多人沟通的即时通讯系统，本文介绍如何使用环信即时通讯 IM SDK 在实时互动 app 中创建和管理群组，并实现群组相关功能。

如需查看消息相关内容，参见 消息管理。

环信即时通讯 IM SDK 提供 、 和 类用于群组管理，支持你通过调用 API 在项目中实现如下功能：

• 创建、解散群组
• 加入、退出群组
• 获取群组详情
• 获取群成员列表
• 获取群组列表
• 屏蔽、解除屏蔽群消息
• 监听群组事件

开始前，请确保满足以下条件：

• 完成 SDK 初始化，详见 快速开始；
• 了解环信即时通讯 IM 的使用限制，详见 使用限制；
• 了解群组和群成员的数量限制，详见 套餐包详情。

本节介绍如何使用环信即时通讯 IM SDK 提供的 API 实现上述功能。

在创建群组前，你需要设置群组类型 () 和进群邀请是否需要对方同意 ()。

1. 私有群不可被搜索到，公开群可以通过 ID 搜索到。目前支持四种群组类型 () ，具体设置如下：

• —— 私有群，只有群主和管理员可以邀请人进群；
• —— 私有群，所有群成员均可以邀请人进群；
• —— 公开群，加入此群除了群主和管理员邀请，只能通过申请加入此群；
• —— 公开群，任何人都可以进群，无需群主和群管理同意。

2. 进群邀请是否需要对方同意 () 的具体设置如下：

• 进群邀请需要用户确认 ( 设置为 )。创建群组并发出邀请后，根据受邀用户的 设置，处理逻辑如下：
  • 用户设置自动接受群组邀请 ( 设置为 )。受邀用户自动进群并收到 回调，群主收到 回调和 回调，其他群成员收到 回调。
  • 用户设置手动确认群组邀请 ( 设置为 )。受邀用户收到 回调，并选择同意或拒绝入群邀请：
    • 用户同意入群邀请后，群主收到 回调和 回调，其他群成员收到 回调；
    • 用户拒绝入群邀请后，群主收到 回调。

1652849255199

• 进群邀请无需用户确认 ( 设置为 )。创建群组并发出邀请后，无视用户的 设置，受邀用户直接进群。用户收到 回调，群主收到每个加入成员的 回调和 回调。

用户可以调用 方法创建群组，并通过 参数设置群组名称、群组描述、群组成员和建群原因。

示例代码如下：

根据 创建群组 时的群组类型 () 设置，加入群组的处理逻辑差别如下：

• 当群组类型为 时，用户可以直接加入群组，无需群主和群管理员同意；加入群组后，其他群成员收到 回调；
• 当群组类型为 时，用户可以申请进群，群主和群管理员收到 回调，并选择同意或拒绝入群申请：
  • 群主和群管理员同意入群申请，申请人收到 回调，其他群成员收到 回调；
  • 群主和群管理员拒绝入群申请，申请人收到 回调。

注意 用户只能申请加入公开群组，私有群组不支持用户申请入群。

用户申请加入群组的步骤如下：

1. 调用 方法从服务器获取公开群列表，查询到想要加入的群组 ID。
2. 调用 方法传入群组 ID，申请加入对应群组。

示例代码如下：

仅群主可以调用 方法解散群组。群组解散时，其他群组成员收到 回调并被踢出群组。

注意：

该操作只有群主才能进行，是危险操作，解散群组后，将删除本地数据库及内存中的群相关信息及群会话。

示例代码如下：

群成员可以调用 方法退出群组，其他成员收到 回调。退出群组后，该用户将不再收到群消息。群主不能调用该接口退出群组，只能调用 DestroyGroup 方法解散群组。

示例代码如下：

群成员可以调用 方法从内存获取群组详情。返回结果包括：群组 ID、群组名称、群组描述、群组基本属性、群主、群组管理员列表，默认不包含群成员。

群成员也可以调用 方法从服务器获取群组详情。返回结果包括：群组 ID、群组名称、群组描述、群主、群组管理员列表以及群成员列表。

示例代码如下：

群成员可以调用 方法从服务器分页获取群成员列表。

示例代码如下：

用户可以调用 方法从服务器获取自己加入和创建的群组列表。示例代码如下：

用户可以调用 方法加载本地群组列表。为了保证数据的正确性，需要先从服务器获取自己加入和创建的群组列表。示例代码如下：

用户还可以调用 方法从服务器分页获取公开群组列表。示例代码如下：

所有群成员均可以调用 方法屏蔽群消息。屏蔽群消息后，该成员不再从指定群组接收群消息。示例代码如下：

群成员可以调用 方法解除屏蔽群消息。示例代码如下：

群成员可以调用 方法并通过 字段检查自己是否屏蔽了群消息。

示例代码如下：

类中提供群组事件的监听接口。开发者可以通过设置此监听，获取群组中的事件，并做出相应处理。如果不再使用该监听，需要移除，防止出现内存泄漏。

示例代码如下：