即时通讯 IM 主要功能
大约 12 分钟
产品介绍
即时通讯 IM 支持消息管理、用户管理功能和离线推送功能。
多平台支持
即时通讯 IM 支持 Android、iOS、Web 等平台，而且各平台之间可互通。下表为即时通讯支持的各平台版本：
提示
SDK V5.0.0 目前已全面支持 Android、iOS、Web 及小程序端，更多平台版本将于近期正式发布，敬请关注后续更新。
| 平台 | SDK 支持的版本 | Demo | 源码 | 单群聊 UIKit | 聊天室 UIKit |
|---|---|---|---|---|---|
| Android | Android 5.0 或以上版本（API 级别 21 或以上） | 支持 | - | 支持 | 支持 |
| iOS | iOS 10.0 或以上版本 | 支持 | - | 支持 | 支持 |
| Web | - Internet Explorer 9 或以上 - FireFox 10 或以上 - Chrome 54 或以上 Safari 6 或以上 - Edge 12 或以上 - Opera 58 或以上 - iOS Safari 7 或以上 - Android Browser 4.4 (KitKat) 或以上 | 支持 | - | 支持 | 支持 |
| 小程序 | 支持 | 支持 | - | - | - |
| uni-app | 支持 | - | - | 支持 | - |
| HarmonyOS | HarmonyOS NEXT（API 级别 12 或以上） | 支持 | - | 支持 | - |
| Flutter | Flutter 2.10 | 支持 | - | 支持 | 支持 |
| React Native | React Native 0.63.4 或以上版本 | 支持 | - | 支持 | 支持 |
| Unity | Unity 2017 或以上版本 | 支持 | - | - | - |
| Windows | Windows 10 或以上版本 | 支持 | - | - | - |
| Electron | 支持 | - | - | - | - |
| Linux | 支持 | - | - | - | - |
账号功能
通过调用 RESTful API，可进行如下用户账号操作：
| 功能 | 描述 |
|---|---|
| 注册用户 | 单次请求最多可注册 60 个用户 ID。 |
| 获取用户详情 | 用户名称、创建时间以及推送设置等。 |
| 删除用户账号 | 删除某个 App 下指定数量的用户账号。 |
| 修改用户密码 | 修改用户的登录密码，不需要提供原密码。 |
| 封禁/解禁用户 | 禁用用户，使其立即下线并无法登录进入即时通讯 IM，直到被解禁后才能恢复登录。 |
| 强制用户下线 | 将用户状态改为离线，用户需要重新登录才能正常使用。 |
| 获取用户在线状态 | 查看单个用户是在线还是离线状态。 |
| 获取指定账号的在线登录设备列表 | 获取指定账号的在线登录设备列表。 |
单端/多端登录
| 功能 | 描述 |
|---|---|
| 单平台登录 | Android、iPhone、iPad、HarmonyOS、Windows、Mac、Web 仅可有1种平台在线。 |
| 多平台登录 | 每端默认最多支持 4 个设备同时在线。 |
使用多端登录前，你需要在 声网控制台 的 即时通讯 IM > 功能配置 > 用户与登陆 页面开启 多端多设备 功能。开通该功能后可以设置各端设备的数量。
消息类型
| 类型 | 描述 |
|---|---|
| 文本消息 | 文本消息的内容是文本，包含超链接和表情符号等。 |
| 位置消息 | 消息内容为经纬度信息。 |
| 图片消息 | 消息内容为图片大小和 URL 地址等。 图片默认不能超过 10 MB。 |
| 语音消息 | 语音消息需要提供时长（单位为秒）和语音文件路径。 音频文件默认不能超过 10 MB。 |
| 视频消息 | 视频消息需要提供时长（单位为秒）、视频文件路径以及缩略图路径等信息。 视频文件默认不能超过 10 MB。 |
| 文件消息 | 文件消息需要提供文件 URL 地址和文件名等信息 附件大小不能超过 10 MB。 |
| 透传消息 | 通过发送命令给对方，通知对方要执行的操作，对方收到消息后系统可以自定义处理。 透传消息不会在 UI 上展示，也不存入本地数据库。 |
| 自定义消息 | 自定义消息类型，例如，红包消息、模板消息等。 |
| 合并消息 | 将多条消息合并成一条消息。一条合并消息最多包含 300 个原始消息。 |
| 流式消息 | 将一条完整消息拆分为多个分片，并按顺序逐步发送和接收的消息传输方式。 |
提示
- 各类消息大小不能超过 5 KB。
- 支持消息扩展字段，传递自定义内容，例如，消息中需要携带被回复的消息内容或者是图文消息等场景。
消息功能
| 功能 | 描述 |
|---|---|
| 发送和接收消息 | 发送和接收各类消息，包括文本、图片、音频、视频、文件消息、位置消息、透传消息、自定义消息以及合并消息。 |
| 发送和接收流式消息 | 发送和接收流式消息。可通过服务端接口发送流式消息、SDK 只支持接收流式消息。 |
| 本地存储 | 接收的消息存储在本地。 |
| 历史消息 | IM 服务器可存储消息。消息存储时间与你的产品套餐包相关，详见 产品套餐包功能对比。 |
| 离线消息推送 | - 用户离线时，可向消息接收方发送推送通知。 - 支持离线消息存储，默认为 7 天。 |
| 多端同步 | 多端多设备消息同步，同时收到消息。 |
| 消息搜索 | 按照关键字搜索服务端会话和本地会话中的各类消息。 |
| 消息撤回 | 撤回发送成功的消息。默认可撤回发出 2 分钟内的消息。你可以在联系声网设置消息撤回时长，该时长不超过 7 天。 |
| 消息回执 | 消息送达回执和消息已读回执。 |
| 编辑消息 | 编辑发送成功的消息。 |
| 表情回复 | 对消息添加、删除表情。 |
| 定向消息 | 指向群组或聊天室的单个或多个指定的成员发送消息，其他成员不会收到该消息。 |
| 全局广播 | 向 app 所有用户或聊天室发送广播消息。 |
| 删除消息 | 单向删除服务端和本地的历史消息、清除聊天记录。 |
| 置顶消息 | 置顶、取消置顶消息和获取置顶消息。 |
| 转发消息 | 将当前会话中发送成功或接收到的消息转发至其他会话。 |
| 只投在线用户 | 只将消息投递给在线用户。 |
| 消息扩展 | 当内置消息字段无法满足业务需求时，你可以通过消息扩展字段携带自定义业务数据，例如被回复消息信息、图文消息展示数据或业务标识等。 |
| 导入和插入消息 | 在本地导入和插入消息。 |
| 更新消息 | 修改本地消息的状态或内容。 |
| 正在输入 | 可通过透传消息实现。 |
会话相关
| 功能 | 描述 |
|---|---|
| 会话列表 | 从服务器或本地获取会话列表。 |
| 会话免打扰 | 可设置指定群聊会话，收到新消息后是否提醒。 |
| 会话未读数 | 获取和清零群聊会话的未读消息数。 |
| 会话置顶 | 将群聊会话固定在会话列表的顶部。 |
| 会话标记 | 对群聊会话添加标记。 |
| 会话删除 | 删除群聊会话。 |
用户属性
| 功能 | 描述 |
|---|---|
| 设置用户属性 | 设置用户昵称、头像、邮箱、电话等。 |
| 获取用户属性 | 获取指定一个或多个用户的全部用户属性。 |
| 获取 app 下用户属性总大小（仅服务端） | 获取该 app 下所有用户的属性数据大小，单位为字节。 |
| 订阅非好友用户的属性变更 | 订阅后，指定非好友用户的属性发生变化时，应用可以及时收到通知。 |
| 删除用户属性 | 删除单个用户的所有属性。 |
用户关系
即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要联系声网商务开启好友关系检查。
| 功能 | 描述 |
|---|---|
| 添加好友 | 发送、接收和处理好友请求。 |
| 移除好友 | 移除好友。 |
| 同意/拒绝好友申请 | 收到好友请求后，可接受或拒绝。 |
| 移除好友 | 移除好友。 |
| 设置好友备注 | 设置单个好友的备注。 |
| 获取好友列表 | 设置登录后自动同步好友列表后，SDK 通过自动同步获取最新好友数据。 |
| 添加用户到黑名单 | 将用户添加至黑名单。可以将任何用户加入黑名单，不论该用户与你是否是好友关系。 |
| 将好友移除黑名单 | 将用户从黑名单移除，用户发送消息等行为将恢复。 |
| 获取黑名单列表 | 从服务端和本地获取黑名单列表。 |
群组和聊天室
| 功能 | 群组 | 聊天室 |
|---|---|---|
| 使用场景 | 类似于 Signal，Skype 里的群聊，所有加入的用户拥有固定的关系 | 成员间没有固定关系，离开即退出 |
| 分类 | 分为公开群和私有群，创建群组时可设置入群是否需获得群主和群管理员的同意 | 没有公开和私有之分，所有用户均可自由加入或退出 |
| 群组数/聊天室数上限 | - 测试版：100 - 专业版：无限制 - 旗舰版：无限制 | -测试版：不支持 - 专业版：无限制 - 旗舰版：无限制 |
| 成员数上限 | -测试版：100 人/群 - 专业版：300人/群（可调*） - 旗舰版：3000人/群（可调*） | - 测试版：100 - 专业版：不限制 - 旗舰版：不限制 |
| 成员列表 | 所有成员均可见 | 所有成员均可见 |
| 创建 | 所有 app 用户都可以创建群组 | 仅聊天室超级管理员可在客户端创建 |
| 解散 | 群主 | 聊天室所有者 |
| 申请加入 | 支持 | 支持 |
| 加群审批 | 支持 | 支持 |
| 邀请加入 | 支持 | 不支持 |
| 群主/所有者退出 | 不支持 | 支持 |
| 设置管理员 | 支持 | 支持 |
| 移除成员 | - 群主 - 群管理员 | - 聊天室所有者 - 聊天室管理员 |
| 成员禁言 | 支持 | 支持 |
| 白名单 | 支持 | 支持 |
| 黑名单 | 支持 | 支持 |
| 成员变更通知 | 邀请进群/申请进群/踢人/退群，默认下发通知 | 主动离开和被踢，默认下发通知 |
| 角色变更通知 | 添加/移除群管理员，群主变更，默认下发通知 | 添加/移除聊天室管理员，聊天室所有者变更，默认下发通知 |
| 群/聊天室属性变更通知 | 群组名称、描述和公告变更时，默认下发通知 | 聊天室名称、描述和公告以及自定义属性变更时，默认下发通知 |
| 群/聊天室成员状态变更通知 | 成员被禁言和添加至黑名单或白名单、群管理员变更，默认下发通知 | 成员被禁言和添加至黑名单或白名单、聊天室管理员变更，默认下发通知 |
| 消息功能 | - 支持消息发送、消息漫游、修改、撤回、置顶、回执、表情回复、翻译、合并、转发、只投在线用户等特性。 - 支持定向消息（仅向某个或某些成员发消息）。 | - 支持群组消息的大部分功能（包括定向消息）。 - 要使用消息漫游，需升级 SDK 到指定版本并联系商务开通。 - 不支持消息表情回复、离线消息。 |
| 历史消息存储 | 支持 | 支持 |
| 查看漫游消息 | 默认开通 | 联系商务开通 |
| 是否支持查看加入前漫游消息 | 支持 | 支持（联系商务开通） |
| 消息未读计数 | 支持 | 不支持 |
| 默认消息接收 | 接收在线推送消息，支持离线推送 | 只接收在线消息，不支持离线推送 |
| 离线消息存储 | 支持 | 不支持 |
| 消息可靠性 | 群组中发送的所有消息，用户都会收到 | 当消息量大时，聊天室中超过阈值（每秒 100 条）的消息会被丢弃 |
数据统计
| 功能 | 描述 |
|---|---|
| 用户数据 | 用户数量统计，包括注册用户总数、今日活跃用户数、今日新增用户数 |
| 群组数据 | 群组统计，包括群组总数、活跃群组数、新增群组数、解散群组数 |
| 聊天室数据 | 聊天室统计，包括聊天室总数、活跃聊天室数、新增聊天室数、解散聊天室数、聊天室同时在线人数 |
| Server 数据 | Server 统计，包括 Server 总数、今日活跃 Server 数、今日新增 Server 数、Channel 总数,、今日新增 Channel 数 |
| 消息量统计 | 消息统计包含单聊、群聊、聊天室场景下各类消息量的总数统计和趋势分析。 |
实时查询
| 功能 | 描述 |
|---|---|
| 请求质量概览 | 提供质量数据的阶段性分析，帮助你掌握用量变化趋势、跟踪产品质量情况。 |
| 热点数据查询 | 提供最小以分钟粒度的TOP 50 的活跃用户、活跃群组、活跃聊天室信息。 |
| IM 消息投递查询 | 可以查询最近三天的消息投递情况。 |
| IM 用户连接状态 | 通过用户 ID 查询最近三天的历史连接状态。 |
| IM 用户设备日志 | 查询用户设备端的日志，或将设备端的日志上传到 IM 日志服务器。 |
| 聊天室消息速率 | 可根据聊天室 ID 查询聊天室内每分钟的消息上下行数量。 |
增值服务
实时音视频
| 功能 | 描述 |
|---|---|
| 一对一音视频通话 | 支持一对一语音和视频通话。 |
| 群组音视频通话 | 支持群组语音和视频通话。 |
| 离线推送来电通知 | 支持通过离线推送接收通话邀请。 |
| 来电通知与悬浮窗 | 支持来电通知栏和悬浮窗展示。 |
消息翻译
| 功能 | 描述 |
|---|---|
| 文本消息翻译 | 仅支持文本消息翻译。 |
| 指定源语言翻译 | 支持传入源语言代码进行翻译。 |
| 多目标语言翻译 | 支持一次翻译为多个目标语言。 |
| 翻译结果返回 | 返回各目标语言对应的翻译结果。 |