跳到主要内容

基础功能

本文档为融云开发者列出了即时通讯单聊、群聊、超级群和聊天室业务的基础功能。

单聊会话

单聊会话指两个用户一对一聊天。融云不维护用户关系,发送消息时不会验证是否为好友。会话由融云建立并保持,当 App 在后台运行或者 App 进程被杀死后,有新消息时会收到推送通知。

功能描述
离线消息支持离线消息存储,存储时间可设置(1 ~ 7 天),默认存储 7 天。
消息提醒离线状态,单聊中有新消息时,支持 Push 通知。
本地存储接收过的消息存储在移动端本地,提供本地消息搜索功能。
历史消息提供云端消息存储功能,需开通单群聊消息云存储,默认存储时长为 6 个月。
消息删除存储在本地和云端的消息都支持删除功能。可以删除指定消息,也可以删除会话中全部历史消息。
消息搜索支持按关键字或用户搜索本地指定会话的消息内容。
消息阅读回执发送单聊消息后如需要查看消息的阅读状态,可以使用此功能来发送阅读回执请求。
消息撤回消息发送成功后,可以撤回该条消息。IMLib 对撤回时间不做限制;IMKit 默认可撤回时间 2 分钟,时间可配置。
单聊会话免打扰可设置指定单聊会话,收到新消息后是否提醒。默认进行新消息提醒。
单聊黑名单不想接收到某一用户的消息时,可将此用户加入到黑名单中。应用中每个用户都可以设置自己的黑名单列表,请使用 Server API 接口设置黑名单。
单聊白名单对用户相互发送消息有限制的客户,可使用用户白名单功能。将用户加入白名单后,才能收到该用户发送的单聊消息,请使用 Server API 接口设置白名单。 用户白名单服务与用户黑名单服务不能同时使用,融云默认开启用户黑名单服务,如需要开通白名单服务请提交工单申请开通。服务开通 30 分钟后生效,同时黑名单服务不再生效。
发送状态消息在线用户会收到此条消息,离线用户不会再收到此条消息。状态消息不计数、不存储。

群聊会话

群聊会话指两个以上用户一起聊天。群组成员信息由 App 提供并维系,融云负责将消息传达给群成员。

功能描述
离线消息支持离线消息存储,存储时间可设置(1 ~ 7 天),默认存储 7 天。
消息提醒离线状态,群组中有新消息时,支持 Push 通知。
本地存储接收过的消息存储在移动端本地,提供本地消息搜索功能。
历史消息提供云端消息存储功能,需开通单群聊消息云存储,默认存储时长为 6 个月。
消息删除存储在本地和云端的消息都支持删除功能。可以删除指定消息,也可以删除会话中全部历史消息。
消息搜索支持按关键字或用户搜索本地指定会话的消息内容。
群消息阅读回执发送群消息后如需要查看消息的阅读状态,可以使用此功能来发送阅读回执请求。
消息撤回消息发送成功后,可以撤回该条消息。IMLib 对撤回时间不做限制;IMKit 默认可撤回时间 2 分钟,时间可配置。
群聊会话免打扰可设置指定群聊会话,收到新消息后是否提醒,默认进行新消息提醒。
创建群组App 内群组数量没有限制,默认一个群上限为 3000 人。
加入群组每个群最大上限 3000 人,一个用户可加入多个群组,没有限制。默认加入群组后,只能查看加入后群组中产生的消息,如需要查看加入前的消息,则需要开通单群聊消息云存储后,再开通新用户获取加入群组前历史消息
退出群组将用户从群中移除,不再接收该群组的消息。
解散群组将指定群组解散,所有成员都无法再接收该群的消息。
群成员查询获取指定群组中群成员用户 Id。
刷新群组信息支持更新群组名称。
同步用户所属群组在集成融云前 App Server 已有群组数据,可使用此服务进行同步。
群组成员禁言被禁言用户可以接收查看群组中其他用户消息,但不能通过客户端 SDK 发送消息。
群组整体禁言指定群组所有成员不能发送消息,需要某些用户可以发言时,可将此用户加入到群禁言用户白名单中。
群组禁言用户白名单群组被整体禁言后,禁言白名单中用户可以发送群消息。
发送群组消息向群组中所有成员发送消息。
发送群组定向消息向群中指定的一个或多个用户发送消息,群中其他用户无法收到该消息。
发送群组 @消息发送群组中指定群成员需要特别关注的消息。
发送状态消息在线用户会收到此条消息,离线用户不会再收到此条消息。状态消息不计数、不存储。

超级群会话

超级群会话指无成员上限的多人聊天服务,海量消息并发即时到达,支持消息推送服务。群组成员信息由 App 提供并维系,融云负责将消息传达给群成员。

功能描述
创建超级群App 内超级群数量没有限制,超级群无人数上限。
加入超级群每个超级群无成员上限,一个用户可加入 100 个超级群。默认加入群组后,只能查看加入后群组中产生的消息,如需要查看加入前的消息,则需要开通新用户获取加入超级群前历史消息。
退出超级群将用户从群中移除,不再接收该群组的消息。
解散超级群将指定超级群解散,所有成员都无法再接收该群的消息。
群频道每个超级群下,最多可以创建 50 个群频道,每个频道共用所属群的成员关系,成员可随意在不同群频道中发送消息,但不同频道间的消息相互隔离。
刷新群组信息支持更新群组名称。
群组成员禁言被禁言用户可以接收查看群组中其他用户消息,但不能通过客户端 SDK 发送消息。
群组整体禁言指定群组所有成员不能发送消息,需要某些用户可以发言时,可将此用户加入到群禁言用户白名单中。
群组禁言用户白名单群组被整体禁言后,禁言白名单中用户可以发送群消息。
消息提醒离线状态,群组中有新消息时,支持 Push 通知,可对通知的类型灵活设置,如只对 @消息进行推送通知。
本地存储接收过的消息存储在移动端本地。
历史消息默认提供 7 天的历史消息云存储服务,如需要存储更长时间,可在控制台开通超级群消息云存储服务。
消息删除存储在本地和云端的消息都支持按时间进行删除。
消息撤回消息发送成功后,可以撤回该条消息。IMLib 对撤回时间不做限制;IMKit 默认可撤回时间 2 分钟,时间可配置。
消息修改对已经发送出去的消息提供内容修改能力。
超级群免打扰可设置指定超级群,收到新消息后是否提醒,默认进行新消息提醒。
发送群组消息向群组中所有成员发送消息。
发送群组 @消息发送群组中指定群成员需要特别关注的消息。

聊天室会话

聊天室成员不设用户上限,海量消息并发即时到达。用户退出聊天界面即视为离开聊天室,不会再接收到任何聊天室中消息,没有推送通知功能。会话关系由融云负责建立并保持连接,通过 SDK 相关接口,可以让用户加入或者退出聊天室。

功能描述
离线消息不支持离线消息,只有当前在线用户可收到聊天室中消息。
人数限制聊天室人数无上限。
消息提醒聊天室消息没有消息提醒。
本地存储退出聊天室后删除本地聊天室消息,不支持消息搜索功能。
历史消息提供云端消息存储功能,需开通聊天室消息云存储,默认存储时长为 2 个月。
创建聊天室App 内的聊天室数量没有限制。
销毁聊天室将指定聊天室解散,所有成员都无法再接收该聊天室的消息。
查询聊天室信息查询聊天室基础信息,包括:聊天室 ID、名称、创建时间。
获取聊天室成员获取聊天室成员信息,包括:用户 ID、加入时间。最多返回 500 个成员信息,支持按加入时间排序。
指定聊天室禁言用户在指定聊天室中禁言。被禁言用户可以接收查看聊天室消息,但不能发送消息。
用户聊天室全局禁言用户在应用的所有聊天室中禁言。被禁言用户可以接收查看聊天室消息,但不能发送消息。
聊天室用户封禁被封禁用户将被踢出指定聊天室,并在设定的时间内不能再进入该聊天室。
指定聊天室全局禁言对指定聊天室做禁言处理,聊天室中所有用户都不能发送消息。
聊天室低级别消息可以设置某些指定消息类型的消息为低优先级。当服务器负载高时低优先级的消息优先被丢弃,这样可以让出资源给高优先级的消息,确保重要的消息不被丢弃。
消息白名单白名单中的消息类型受到保护,在聊天室消息量较大的情况下也不被丢弃。
聊天室用户自动退出聊天室用户离线后,从第一条新消息产生开始计时,倒数 30 秒自动退出聊天室;或离线后聊天室中产生 30 条消息时自动退出聊天室。
聊天室用户白名单白名单中用户发送的消息受到保护,在聊天室消息量较大的情况下也不被丢弃。同时用户处于被保护状态,以避免自动退出聊天室。
聊天室保活聊天室保活功能,可以确保聊天室在此状态下不被自动销毁,只能通过调用 API 接口销毁聊天室。
聊天室状态同步聊天室发生状态变化时,将实时同步到开发者的应用服务器。目前支持的同步状态包括:创建、销毁、成员加入、成员退出聊天室。
聊天室属性自定义每个聊天室中,最多允许设置 100 个属性信息,以 Key、Value 的方式存储。聊天室销毁后,聊天室中的自定义属性同时销毁。
消息撤回消息发送成功后,可以撤回该条消息。IMLib 对撤回时间不做限制;IMKit 默认可撤回时间 2 分钟,时间可配置。