群组业务概述
群聊是即时通讯 (IM)类应用中常见的多人通讯方式。融云群组业务支持丰富的功能,包括群组成员管理、禁言管理,离线消息推送及历史消息记录漫游,适用于兴趣群、办公群、客服服务沟通等多种场景。
在融云控制台创建应用后,默认支持群组业务,不需要申请开通。在默认情况下,融云不维护群组成员的资料(头像、名称、群成员名片等)只负责将消息传达给群组中的所有用户。对于创建、解散、加入、退出群组等群组管理操作,必须由 App 服务器请求融云服务端 API 实现,融云客户端 SDK 不提供相应方法。如果您希望将群组及群成员资料信息托管在融云,请开启用户信息托管。
每个 App Key 下可创建的群组数量没有限制,单个群组成员上限为 3000 人,且单个用户可加入的群组数量不受限制。若需要实现历史记录漫游功能,可通过控制台 IM 服务的服务购买页面为 App Key 开启单群聊消息云端存储服务,使用即时通讯服务提供的消息存储服务。该服务适用于 IM 旗舰版或IM 尊享版,具体功能与费请参阅官方价格说明页面及计费说明文档。
信息托管服务
信息托管功能是指将应用中的用户信息托管到融云服务器,由融云提供客户端和服务端的接口,帮助开发者管理和维护用户 资料信息。该功能已默认开通,开发者可通过融云提供的 API 设置和更新用户的资料信息。用户信息托管后,应用可以进一步使用融云提供的群组管理、群成员管理以及好友关系管理等 API,简化社交功能的开发和维护,提升应用的管理能力与用户体验。
信息托管服务已默认开通,您可以直接使用托管服务中提供的群组管理功能,进行群组资料的管理和维护。融云信息托管服务中提供全新群组管理能力,支持通过服务端 API 和客户端 SDK 进行群组管理。
群组管理功能
- 未开启用户信息托管的群组
- 开启用户信息托管的群组
下表列出了即时通讯服务端提供的非托管能力的群组基础管理接口。
如果未开启信息托管服务,群组业务逻辑(如群主、群管理员、群公告、邀请入群、群号搜索等)均需在您的应用侧自行实现。
| 功能分类 | 功能描述 | 即时通讯服务端 API |
|---|---|---|
| 创建、解散群组 | 提供创建者用户 ID、群组 ID、和群名称,向融云 IM 服务端申请建群。如解散群组,则群成员关系不复存在。 | 创建群组、解散群组 |
| 加入、退出群组 | 加入群组后,默认可查看入群以后产生的新消息。退出群组后,不再接收该群的新消息。 | 加入群组、退出群组 |
| 修改即时通讯服务端的群组信息 | 修改在即时通讯的推送服务中使用的群组信息。 | 刷新群组信息 |
| 查询群组成员 | 查询指定群组所有成员的用户 ID 信息。 | 查询群组成员 |
| 查询用户所在群组 | 根据用户 ID 查询该用户加入的所有群组,返回群组 ID 及群组名称。由于融云 IM 服务端不存储群组资料信息,您的应用服务器需要自行维护群组资料 及群成员信息。当您的应用服务器维护的用户群组关系有缺失时,可通过此接口来核对校验。 | 查询用户所在群组 |
| 同步用户所在群组 | 向融云 IM 服务端同步指定用户当前所加入的所有群组,防止应用中的用户群组信息与融云 IM 服务端的用户所属群信息不一致。如果在集成融云服务前,您的应用服务器上已有群组及成员数据,第一次连接融云服务时,可使用此接口向融云 IM 服务端同步已有的用户与群组对应关系。 | 同步用户所在群组 |
| 群组单人禁言 | 在指定的单个群组中或全部群组中,禁言一个或多个用户。被禁言用户可以接收并查看群组中其他用户的消息,但不能通过客户端 SDK 发送消息。 | 单人禁言 |
| 群组全体禁言 | 将群组全体成员禁言。被禁言群组的所有成员均不能发送消息,需要某些用户可以发言时,可将此用户加入到群禁言用户白名单中。 | 全体禁言 |
| 群组禁言用户白名单 | 群组被整体禁言后,禁言白名单中用户可以发送群消息。 | 全体成员禁言白名单 |
下表列出了信息托管服务中支持的群组托管功能接口。
- 使用信息托管服务,在进行群组管理操作时(如创建、主动加入、邀请加入、踢出、退出、解散、添加管理员、移除管理员、转移群主等),群成员会收到相应的操作状态通知回调。此通知使用消息方式实现,因此会计入群消息的分发和下行数据统计。
- 对于通过非托管功能创建的群组,如果需要使用群组托管能力,必须先调用"导入群托管数据"接口,设置群组所有者(群主)及群组的默认权限后才能使用。
| 功能分类 | 功能描述 | 即时通讯服务端 API |
|---|---|---|
| 创建群组 | 创建一个群组,默认群主为创建者。 | 创建群组-托管 |
| 解散群组 | 将指定群组解散,只有角色为群主的用户可以进行解散操作,解散后群成员关系不复存在。 | 解散群组-托管 |
| 设置群组资料 | 提供修改群组的名称、头像、简介等内置信息及自定义的群组资料信息。 | 设置群组资料-托管 |
| 批量获取群组资料 | 获取指定多个群组的资料信息。 | 批量获取群组资料-托管 |
| 踢出群组 | 指定用户踢出群组,只有具有踢出权限的用户可以进行此操作。 | 踢出群组-托管 |
| 转让群组 | 将群主角色转让给群组中其他成员,转让后可选择是否在群组中或退出群组。 | 转让群组-托管 |
| 加入群组 | 用户加入指定群组,用户加入的群组数没有上限限制。 | 加入群组-托管 |
| 退出群组 | 用户退出指定群组,退出后不再接收该群的新消息。 | 退出群组-托管 |
| 将指定用户踢出所有群组 | 将指定用户从所有不是群主角色的群组中踢出,该用户所有群主 角色的群需要先转让群主后才能退出群组。 | 将指定用户踢出所有群组-托管 |
| 设置群管理员 | 设置指定一个群的成员为群管理员。 | 设置群管理员-托管 |
| 移除群管理员 | 移除管理员权限,将群管理员角色设置为普通群成员。 | 移除群管理员-托管 |
| 分页获取群成员信息 | 分页方式获取指定一个群组的成员信息。 | 分页获取群成员信息-托管 |
| 获取指定群成员信息 | 获取一个群组中指定多个成员的资料信息。 | 获取指定群成员信息-托管 |
| 设置群成员资料 | 设置一个群成员的备注名及自定义附加信息。 | 设置群成员资料-托管 |
| 设置群名称备注名 | 设置用户所在指定群组的群名称备注名,设置后该备注名只对设置用户有效,其他群成员不可见。 | 设置群名称备注名-托管 |
| 设置特别关注群成员 | 特别关注指定群成员后,该成员发送的消息不受免打扰的影响。 | 设置特别关注群成员-托管 |
| 分页查询应用下群组 | 分页方式获取指定 AppKey 下的群组列表。 | 分页查询应用下群组-托管 |
| 分页查询用户加入的群组 | 分页方式获取用户加入的所有群组列表。 | 分页查询用户加入的群组-托管 |
| 群组托管导入功能 | 针对不是使用群托管功能创建的群组,需要先通过此接口设置群主及群权限后,才能调用群托管相关功能。 | 群组托管导入功能-托管 |
群聊消息功能
群聊消息功能与单聊业务类似,共用部分 API 及配置。
是否开启用户托管不影响群聊消息功能。
| 功能 | 描述 | 客户端 API | 即时通讯服务端 API |
|---|---|---|---|
| 发送消息 | 可发送普通消息与媒体消息,例如文本、图片、GIF 等。支持在发送消息时添加 @ 信息。 | 支持 | 发送群聊消息 |
| 发送群聊定向消息 | 可发送普通消息与媒体消息给群组中的指定的一个或多个成员,其他成员不会收到该消息。 | 支持 | 发送群聊定向消息 |
| 接收消息 | 监听并实时接收消息,或在客户端上线时接收离线消息。 | 支持 | 不提供该 API |
| 群聊消息已读回执 | 发送群消息后如需要查看消息的阅读状态,需要先发送回执请求,在通过接受者的响应获取已读数据。 | 支持 | 不提供 该 API |
| 离线消息 | 支持离线消息存储,存储时间可设置(1 ~ 7 天),默认存储 7 天内的所有群消息,支持调整存储时长与存储的群消息数量。 | 支持 | 不提供该 API |
| 离线消息推送 | 离线状态下,群组中有新消息时,支持 Push 通知。 | 支持 | 不提供该 API |
| 撤回消息 | 消息发送成功后可撤回该条消息。 | 支持 | 撤回消息 |
| 本地搜索消息 | 消息存储在本地(移动端),支持按关键字或用户搜索本地指定会话的消息内容。 | 支持 | 不提供该 API |
| 获取历史消息 | 从本地数据库或远端获取历史消息。注意,从远端获取历史消息需要开通单群聊消息云端存储服务,默认存储时长为 6 个月。 | 支持 | 不提供该 API |
| 获取历史消息日志 | 即时通讯服务端可以保存 APP 内所有会话的历史消息记录,历史消息记录以日志文件方式提供,并已经过压缩。您可以使用服务端 API 获取、删除指定 App 的历史消息日志 | 不提供该 API | 获取历史消息日志 |