更新时间: 2020-04-09
# 单聊会话
指两个用户一对一聊天。融云不维护用户关系，发送消息时不会验证是否为好友。会话由融云建立并保持，当 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 人，一个用户可加入多个群组，没有限制。默认加入群组后，只能查看加入后群组中产生的消息，如需要查看加入前的消息，则需要开通单群聊消息云存储 (opens new window)后，再开通查看加入前群消息功能 (opens new window) |
| 退出群组 | 将用户从群中移除，不再接收该群组的消息。 |
| 解散群组 | 将指定群组解散，所有成员都无法再接收该群的消息。 |
| 群成员查询 | 获取指定群组中群成员用户 Id。 |
| 刷新群组信息 | 支持更新群组名称。 |
| 同步用户所属群组 | 在集成融云前 App Server 已有群组数据，可使用此服务进行同步。 |
| 群组成员禁言 | 被禁言用户可以接收查看群组中其他用户消息，但不能通过客户端 SDK 发送消息。 |
| 群组整体禁言 | 指定群组所有成员不能发送消息，需要某些用户可以发言时，可将此用户加入到群禁言用户白名单中。 |
| 群组禁言用户白名单 | 群组被整体禁言后，禁言白名单中用户可以发送群消息。 |
| 发送群组消息 | 向群组中所有成员发送消息。 |
| 发送群组定向消息 | 向群中指定的一个或多个用户发送消息，群中其他用户无法收到该消息。 |
| 发送群组 @消息 | 发送群组中指定群成员需要特别关注的消息。 |
| 发送状态消息 | 在线用户会收到此条消息，离线用户不会再收到此条消息。状态消息不计数、不存储。 |
# 聊天室会话
聊天室成员不设用户上限，海量消息并发即时到达。IMKit 中用户退出聊天界面即视为离开聊天室，不会再接收到任何聊天室中消息，没有推送通知功能。会话关系由融云负责建立并保持连接，通过 SDK 相关接口，可以让用户加入或者退出聊天室。
| 功能 | 描述 |
|---|---|
| 离线消息 | 不支持离线消息，只有当前在线用户可收到聊天室中消息。 |
| 人数限制 | 聊天室人数无上限。 |
| 消息提醒 | 聊天室消息没有消息提醒。 |
| 本地存储 | 退出聊天室后删除本地聊天室消息，不支持消息搜索功能。 |
| 历史消息 | 提供服务端消息存储功能，需开通聊天室消息云存储，默认存储时长为 2 个月。 |
| 创建聊天室 | App 内的聊天室数量没有限制。 |
| 销毁聊天室 | 将指定聊天室解散，所有成员都无法再接收该聊天室的消息。 |
| 查询聊天室信息 | 查询聊天室基础信息，包括：聊天室 ID、名称、创建时间。 |
| 获取聊天室成员 | 获取聊天室成员信息，包括：用户 ID、加入时间。最多返回 500 个成员信息，支持按加入时间排序。 |
| 指定聊天室禁言 | 用户在指定聊天室中禁言。被禁言用户可以接收查看聊天室消息，但不能发送消息。 |
| 用户聊天室全局禁言 | 用户在应用的所有聊天室中禁言。被禁言用户可以接收查看聊天室消息，但不能发送消息。 |
| 聊天室用户封禁 | 被封禁用户将被踢出指定聊天室，并在设定的时间内不能再进入该聊天室。 |
| 指定聊天室全局禁言 | 对指定聊天室做禁言处理，聊天室中所有用户都不能发送消息。 |
| 聊天室低级别消息 | 可以设置某些指定消息类型的消息为低优先级。当服务器负载高时低优先级的消息优先被丢弃，这样可以让出资源给高优先级的消息，确保重要的消息不被丢弃。 |
| 消息白名单 | 白名单中的消息类型受到保护，在聊天室消息量较大的情况下也不被丢弃。 |
聊天室用户自动退出 ｜ 聊天室用户离线后，从第一条新消息产生开始计时，倒数 30 秒自动退出聊天室；或离线后聊天室中产生 30 条消息时自动退出聊天室。 聊天室用户白名单 | 白名单中用户发送的消息受到保护，在聊天室消息量较大的情况下也不被丢弃。同时用户处于被保护状态，以避免自动退出聊天室。 聊天室保活 | 聊天室保活功能，可以确保聊天室在此状态下不被自动销毁，只能通过调用 API 接口销毁聊天室。 聊天室状态同步 | 聊天室发生状态变化时，将实时同步到开发者的应用服务器。目前支持的同步状态包括：创建、销毁、成员加入、成员退出聊天室。 聊天室属性自定义 | 每个聊天室中，最多允许设置 100 个属性信息，以 Key、Value 的方式存储。聊天室销毁后，聊天室中的自定义属性同时销毁。 消息撤回 | 消息发送成功后，可以撤回该条消息。IMLib 对撤回时间不做限制；IMKit 默认可撤回时间 2 分钟，时间可配置。
# 消息类型
# 内容类消息
| 消息类型 | 描述 |
|---|---|
| 文字消息 | 用来发送文字类消息，其中可以包括表情、超链接（IMKit 中会自动识别），客户端收到消息后存入数据库、计入未读消息数。 |
| 语音消息 | 发送高质量的短语音消息，录制的语音文件存储到融云服务端，语音文件格式为 AAC，时长上限为 60 秒，客户端收到消息后存入数据库、计入未读消息数。 |
| 图片消息 | 用来发送图片类消息，客户端收到消息后存入数据库、计入未读消息数。图片缩略图格式为 JPG，开发者自定义图片消息时，缩略图大小建议不超过 100k。 |
| GIF 图片消息 | 用来发送 GIF 动态图片消息，客户端收到消息后存入数据库、计入未读消息数。 |
| 图文消息 | 用来发送图文消息，包含一个标题，一段文字内容和一张图片，客户端收到消息后存入数据库、计入未读消息数。 |
| 文件消息 | 用来发送文件类消息，客户端收到消息后存入数据库、计入未读消息数。 |
| 位置消息 | 用来发送地理位置消息，客户端收到消息后存入数据库、计入未读消息数。 |
| 小视频消息 | 用来发送小视频消息，支持录制发送及选择本地视频文件发送两种方式。录制时长不超过 10 秒，本地选择视频时长不超过 2 分钟，小视频文件格式为 mp4，客户端收到消息后存入数据库、计入未读消息数。 |
| 合并转发消息 | IMKit 支持将多条消息合并为一条消息进行发送。合并后的消息以 HTML 文件的方式存储到融云服务端，客户端收到消息后存入数据库、计入未读消息数。 |
# 通知类消息
| 消息类型 | 描述 |
|---|---|
| 提示条通知消息 | 用来发送提示条（小灰条）通知。客户端收到消息后存入数据库，不计入未读消息数，此类型消息没有 Push 通知。 |
# 多设备消息同步
默认的情况下，融云仅支持 1 个 Web 端、1 个桌面端、1 个移动端同时在线。开通多设备消息同步功能后，可以支持多个 Web 端同时在线。同时支持 Web 端、桌面端和移动端之间的消息同步。此功能可以在开发者后台 (opens new window)自行开通。
# 全量消息路由
| 功能 | 描述 |
|---|---|
| 全量消息路由 | 支持将单聊、群组、聊天室、客服的消息数据同步到开发者指定的应用服务器。该服务需要开通 IM 商用版 (opens new window)后才能使用。 |
# 消息回调服务
| 功能 | 描述 |
|---|---|
| 消息回调服务 | 根据设置的条件，将符合条件的消息发送到设置的应用服务器地址，不直接发送给目标用户，根据应用服务器返回的响应结果决定是否下发。适用于对接内容审核服务的应用场景。该服务需要在开发者后台 (opens new window)开通后才能使用。 |
# 消息云存储
| 功能 | 描述 |
|---|---|
| 单群聊消息云端存储 | 提供单聊、群聊消息的云端保存服务。客户端可以获取云端历史消息，开通后历史消息默认保存 6 个月。该服务需要开通 IM 商用版 (opens new window)后才能使用。 |
| 聊天室消息云存储 | 提供聊天室消息的云端保存服务。客户端可以获取云端历史消息，开通后历史消息默认保存 2 个月。该服务需要开通 IM 商用版 (opens new window)后才能使用。 |
# 全量用户通知
通过融云开发者后台或调用 Server API 发送全量用户通知。可以给全部用户发送，也能指定部分用户发送，服务每小时只能发送 2 次，每天最多发送 3 次。
全量用户通知服务包括两个功能：一个是不落地通知（Push），一个是落地通知(Broadcast)。
- 不落地通知（Push） 通过远程推送的方式通知用户。
不落地通知产生一条远程推送抵达用户。其中 iOS 使用 APNs（Apple Push Notification service），Android 使用开发者在 SDK 中配置的推送服务，包括融云自研推送、小米、华为、魅族、OPPO、vivo、FCM。
- 落地通知（Broadcast） 通过融云消息的方式通知用户。
落地通知产生一条融云消息抵达用户。用户在线时能即时收到消息；当用户离线时，融云消息会默认生成一条远程推送。
# 在线状态
| 功能 | 描述 |
|---|---|
| 检查在线状态 | 调用 Server API 接口，查看指定用户的在线状态。 |
| 在线状态订阅 | 订阅后融云服务器将用户每一个终端在线、离线或登出后的状态，同步给开发者的应用服务器。该服务需要开通 IM 商用版 (opens new window)后才能使用。 |