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