群组业务概述
群聊是即时通讯类应用中常见的多人通讯方式,一般包含两个及以上的用户。融云的群组业务支持丰富的群组成员管理、禁言管理等特性,支持离线消息推送和历史消息记录漫游,可用于兴趣群、办公群、客服服务沟通等。
群组业务要点如下:
- 即时通讯服务只负责将消息传达给群组中的所有用户,默认不维护群组成员的资料(头像、名称、群成员名片等)。如需将群组及群成员资料托管在融云,可使用已默认开通的用户信息托管服务。
- 未使用信息托管时,创建、解散、加入、退出群组等管理操作必须由 App 服务器请求融云服务端 API 实现。使用信息托管后,可以使用小程序 IMLib 托管接口和融云服务端 API 管理托管群组。详见下方群组管理功能。
- App Key 下可创建的群组数量没有限制,单个群组默认成员上限为 3000 人。如需修改群组成员上限,可咨询融云商务。
- 单个用户可加入的群组数量无限制。
- 从控制台 IM 服务的服务购买页面为 App Key 开启单群聊消息云端存储服务后,可使用融云提供的消息存储服务,实现消息历史记录漫游。IM 旗舰版或IM 尊享版可开通该服务。具体功能与费用以融云官方价格说明页面及计费说明文档为准。
服务配置
客户端 SDK 默认支持群组业务,不需要申请开通。
群组业务的部分基础功能与增值服务可以在控制台 IM 服务的服务购买和[服务配置]页面进行开通和配置。
客户端 SDK 使用须知
提示
- 仅 IMKit 提供开箱即用的群聊会话 UI 组件。IMLib 不提供开箱即用的群聊会话 UI 组件。
- 未使用信息托管时,客户端不提供群组管理的 API。群组管理需要由 App 服务端调用相应的融云服务 端 API(Server API)接口完成。
- 使用信息托管功能后,小程序 IMLib 提供托管群组管理 API。使用旧版非托管接口创建的群组,需要先调用群组托管导入功能(托管),设置群主和群权限后,才能使用托管群组接口。
群组管理功能
群组管理能力取决于 App 是否使用信息托管功能。未使用信息托管时,群主、群管理员、群公告、邀请入群、群号搜索等业务逻辑需要由 App 自行实现。使用信息托管后,可以使用小程序 IMLib 托管接口和信息托管群组服务端 API 管理群组。
提示
使用信息托管服务进行群组管理操作时,群成员会收到对应的操作状态通知回调。通知使用消息方式实现,会计入群消息的分发和下行数据统计。
基础群组 Server API
下表列出的接口用于维护群组关系和推送所需的基础群组信息,不托管群组资料和群成员资料。
| 功能分类 | 功能描述 | 融云服务端 API |
|---|---|---|
| 创建、解散群组 | 提供创建者用户 ID、群组 ID、和群名称,向融云服务端申请建群。如解散群组,则群成员关系不复存在。 | 创建群组、解散群组 |
| 加入、退出群组 | 加入群组后,默认可查看入群以后产生的新消息。退出群组后,不再接收该群的新消息。 | 加入群组、退出群组 |
| 修改融云服务端的群组信息 | 修改在融云推送服务中使用的群组信息。 | 刷新群组信息 |
| 查询群组成员 | 查询指定群组所有成员的用户 ID 信息。 | 查询群组成员 |
| 查询用户所在群组 | 根据用户 ID 查询该用户加入的所有群组,返回群组 ID 及群组名称。融云不存储群组资料信息,群组资料及群成员信息需要开发者在应用服务器自行维护,如应用服务端维护的用 户群组关系有缺失时,可通过此接口来核对校验。 | 查询用户所在群组 |
| 同步用户所在群组 | 向融云服务端同步指定用户当前所加入的所有群组,防止应用中的用户群组信息与融云服务端的用户所属群信息不一致。如果在集成融云服务前 App Server 上已有群组及成员数据,第一次连接融云服务器时,可使用此接口向融云同步已有的用户与群组对应关系。 | 同步用户所在群组 |
| 群组单人禁言 | 在指定的单个群组中或全部群组中,禁言一个或多个用户。被禁言用户可以接收查看群组中其他用户消息,但不能通过客户端 SDK 发送消息。 | 单人禁言 |
| 群组全体禁言 | 将群组全体成员禁言。被禁言群组的所有成员均不能发送消息,需要某些用户可以发言时,可将此用户加入到群禁言用户白名单中。 | 全体禁言 |
| 群组禁言用户白名单 | 群组被整体禁言后,禁言白名单中用户可以发送群消息。 | 全体成员禁言白名单 |