跳到主要内容

群组概述

群聊是即时通讯类应用中常见的多人通讯方式，一般包含两个及以上的用户。融云的群组业务支持丰富的群组成员管理、禁言管理等特性，支持离线消息推送和历史消息记录漫游，可用于兴趣群、办公群、客服服务沟通等。IMKit 提供开箱即用的群聊会话 UI 组件。

服务配置​

客户端 SDK 默认支持群组业务，不需要申请开通。部分基础功能与增值服务可以在控制台 IM 服务的服务购买和服务配置页面进行开通和配置。

  • 信息托管服务已默认开通。使用该服务后，可以托管用户、群组和群成员资料，并使用对应的群组管理能力。HarmonyOS IMLib 提供托管群组管理接口，详见群组业务概述（IMLib）。
  • App Key 下可创建的群组数量无限制。单个用户可加入的群组数量无限制。
  • 群组有容量上限，默认群组成员数量上限为 3000 人，可联系客服修改。
  • 默认情况下，App Key 未开通单群聊消息云端存储服务。您可以在控制台开通单群聊消息云端存储服务。如果是生产环境的 App Key，仅 IM 旗舰版、IM 尊享版可开通该服务。
  • 默认情况下，用户只能查看他们加入群组后的群聊消息。开启新用户获取加入群组前历史消息服务后，新入群用户可以获取他们加入群组之前的群聊历史消息。。

客户端 SDK 使用须知​

  • IMKit 默认使用用户信息提供者方式展示用户、群组和群成员信息。该方式下，客户端 SDK 不提供创建、解散、加入、退出等群组管理 API。App 需要在自己的服务端维护群组业务逻辑，并由 App 服务端调用融云服务端 API 完成群组管理操作。
  • 使用信息托管功能后，融云会维护托管的用户、群组和群成员资料，并提供群组管理能力。App 可以通过 HarmonyOS IMLib 托管接口和融云服务端 API 管理托管群组。使用旧版非托管接口创建的群组，需要先调用群组托管导入功能（托管），设置群主和群权限后，才能使用托管群组接口。
  • 如果继续使用用户信息提供者方式，融云只负责将消息传达给群组中的所有用户，不维护群组成员的资料（头像、名称、群成员名片等）。App 需要自行在业务服务器上维护相关数据，并实现 IMKit 的相关接口，向 IMKit 提供数据。参见下方文档：

群组管理功能​

群组管理能力取决于 App 是否使用信息托管功能。未使用信息托管时，群主、群管理员、群公告、邀请入群、群号搜索等业务逻辑需要由 App 自行实现。使用信息托管后，可以使用 HarmonyOS IMLib 托管接口和信息托管群组服务端 API 管理群组。

基础群组 Server API​

下表列出的接口用于维护群组关系和推送所需的基础群组信息，不托管群组资料和群成员资料。

服务端 API功能描述
创建群组、解散群组提供创建者用户 ID、群组 ID、和群名称，向融云服务端申请建群。如解散群组，则群成员关系不复存在。
加入群组、退出群组加入群组后，默认可查看入群以后产生的新消息。退出群组后，不再接收该群的新消息。
刷新群组信息修改在融云推送服务中使用的群组信息。
查询群组成员查询指定群组所有成员的用户 ID 信息。
查询用户所在群组根据用户 ID 查询该用户加入的所有群组，返回群组 ID 及群组名称。融云不存储群组资料信息，群组资料及群成员信息需要开发者在应用服务器自行维护，如应用服务端维护的用户群组关系有缺失时，可通过此接口来核对校验。
同步用户所在群组向融云服务端同步指定用户当前所加入的所有群组，防止应用中的用户群组信息与融云服务端的用户所属群信息不一致。如果在集成融云服务前 App Server 上已有群组及成员数据，第一次连接融云服务器时，可使用此接口向融云同步已有的用户与群组对应关系。
禁言指定群成员在指定的单个群组中或全部群组中，禁言一个或多个用户。被禁言用户可以接收查看群组中其他用户消息，但不能通过客户端 SDK 发送消息。
设置群组全体禁言将群组全体成员禁言。被禁言群组的所有成员均不能发送消息，需要某些用户可以发言时，可将此用户加入到群禁言用户白名单中。
加入群组全体禁言白名单群组被整体禁言后，禁言白名单中用户可以发送群消息。

信息托管群组管理​

使用信息托管功能后，可以使用托管群组管理能力。客户端托管接口请参见群组业务概述（IMLib）。

服务端 API功能描述
创建群组（托管）、解散群组（托管）创建或解散托管群组。创建群组时可设置群名称、群主、群头像、群简介、自定义群扩展信息和群权限。
设置群组资料（托管）、批量获取群组资料（托管）设置或获取托管群组的名称、头像、简介、公告、权限和扩展信息。
加入群组（托管）、退出群组（托管）、踢出群组（托管）管理托管群组中的成员加入、退出和移出。
转让群组（托管）、设置群管理员（托管）、移除群管理员（托管）管理托管群组的群主和群管理员角色。
分页获取群成员信息（托管）、获取指定群成员信息（托管）、设置群成员资料（托管）查询和设置托管群组成员资料。
设置群名称备注名（托管）、设置特别关注群成员（托管）设置用户维度的群名称备注和特别关注群成员。
分页查询应用下群组（托管）、分页查询用户加入的群组（托管）查询 App Key 下的托管群组列表，或查询指定用户加入的托管群组。
将指定用户踢出所有群组（托管）、群组托管导入功能（托管）批量移出指定用户，或将已有非托管群组导入为托管群组。
最后于 更新