产品概述

更新时间: 2024/06/13 15:41:43

IM 即时通讯 V10 是基于 V9 SDK 的升级版本,它不仅兼容 V9 SDK 的接口和功能,提供了一整套即时通讯技术解决方案,包括客户端 IM 组件、客户端 IM 基础库、全平台 SDK 以及服务端 API 等,还支持云端会话、会话分组、IM 圈组融合登录、聊天室独立登录等功能。

架构介绍

更新圈组后的IM架构图.png

  • 应用与应用服务器之间进行业务信息交互,包括自身的账号体系,用户数据等,云信不维护开发者应用的相关数据。
  • 应用服务器与云信服务器之间进行身份验证,并发起请求,然后将云信服务器返回的信息保存在开发者应用服务器的数据库。
  • 开发者可根据自身的业务情况选择在应用加载或需要使用 IM 服务时进行授权,建立长连接。
  • 应用发送消息等操作时需要通过云信服务器转发给其他终端设备。
  • 应用客户端、应用服务器、云信服务器、云信 SDK 之间是不断交互的,例如:开发者应用需要处理 SDK 的回调,开发者应用服务器需要处理云信服务器的回调或消息抄送等。
  • 使用云信 IM 服务时,应用的用户帐号和云信的 IM 账号(accountId)是彼此独立的,accountId 只用于 IM 功能的登录鉴权,和应用本身的用户信息没有关系。建议开发者分别维护自有账号体系和云信账号体系,并建立对应关系,以提高数据安全性和操作灵活性。

功能列表

多端登录

支持多端登录如下策略:

  • 只允许一端登录,Windows、Web、Android、iOS 彼此互踢
  • 桌面PC 与 Web 端互踢、移动 Android 和 iOS 端互踢、桌面与移动端可同时登录
  • 各端均可以同时登录在线

如需修改多端登录互踢策略,请参考 多端登录与互踢,在 网易云信用户控制台进行配置。

消息类型

消息类型 备注
文本消息 消息内容为普通文本
图片消息 消息内容为图片 URL 地址、尺寸、图片大小等信息
语音消息 消息内容为语音文件的 URL 地址、时长、大小、格式等信息;
视频消息 消息内容为视频文件的 URL 地址、时长、大小、格式等信息
文件消息 消息内容为文件的 URL 地址、大小、格式等信息,格式不限
地理位置消息 消息内容为地理位置标题、经度、纬度信息
通知消息 主要用于群事件的通知和聊天室事件的通知,没有推送和通知栏提醒
提示消息 通知消息的简化,没有推送和通知栏提醒
自定义消息 开发者自定义的消息类型,例如红包消息、石头剪子布等形式的消息
系统通知消息 包含内置的系统通知消息和开发者自定义系统通知消息

消息功能

消息功能
说明
离线消息 不在线时其他人发来的消息。在下次登录时,会自动将离线期间暂存的离线消息自动下发到客户端 SDK
漫游消息 在新设备登录时,将服务器记录的漫游消息同步下来
多端同步 多客户端同时在线时,消息实时下发到多端
历史消息 支持本地历史消息和云端历史消息
消息撤回 撤回投递成功的消息,默认撤回 2 分钟内的消息,可撤回的时长可在用户控制台进行配置
撤回操作仅支持单聊和群聊消息,不支持聊天室消息的撤回
已读回执 查看点对点会话中对方的已读未读状态
消息转发 将消息转发给其他用户或群组
@某人 通过消息扩展字段实现。当发送群消息@某人的时候,可以通过扩展字段带上被@的帐号列表发送出去
群成员收到群消息时,查看扩展字段的@帐号列表里有没有自己,如果有,则界面上做被@的提醒
正在输入 通过自定义系统通知实现,可参考:自定义系统通知收发
消息推送 支持苹果 APNS、谷歌FCM、小米推送、华为推送、OPPO推送、VIVO推送等厂商推送
第三方回调 发送方消息发出后,可以配置通过第三方服务器鉴权校验,校验通过后方进行投递,否则消息不投递

以上增值功能收费请参考:资费说明

NOS 云存储

功能 功能描述
存储空间 服务端提供一定的存储空间,支持扩展(增值功能)
上传下载加速 智能选择最近的 NOS 边缘节点实现上传下载双向全网加速
文件快传 上传重复的大文件上传将不再需要重复传输
获取图片信息 获取图片基本信息,如图片类型、图片宽度和高度等
图片裁剪 从指定位置对图片进行裁剪,从而生成子图片
图片缩略 按照图像像素对图片进行等比例缩略
高斯模糊 使用高斯噪声对图片进行模糊化
图片旋转 按照给定角度对图片进行旋转

以上增值功能收费请参考:资费说明

用户资料托管

功能 功能描述
获取本地用户资料 支持批量获取
获取服务器用户资料 支持批量获取,一般在本地用户资料不存在时调用
编辑用户资料 更新当前登录用户本人资料

用户关系托管

功能 功能描述
添加好友 支持 直接添加为好友和发起好友验证请求
通过/拒绝好友请求 收到请求加好友请求的系统通知后,可以通过或者拒绝
删除好友 删除好友后,将自动解除双方的好友关系。删除好友后,双方依然可以聊天
好友列表 配合用户资料托管,可以根据帐号来获取对应的用户资料来构建自己的通讯录
加入黑名单 将用户加入黑名单后,将不再收到对方发来的任何消息或者请求
移出黑名单 将用户移出黑名单
黑名单列表 获取黑名单列表
判断用户是否被拉进黑名单 判断用户是否在自己的黑名单内

IM 支持配置非好友关系是否允许发送消息

  • 配置路径:云信控制台 > 选择应用 > IM 即时通讯 > 功能配置 > 单聊消息配置 > 非好友关系是否允许发送消息。
  • 配置该选项只影响客户端 SDK,服务端 API 发消息不受该限制。
  • 若配置非好友不允许发消息,客户端 SDK 向非好友发消息会返回 403。

群组功能

功能 高级群
群容量 IM 各套餐包下的阈值不同,支持在一定范围内进行扩展
创建 创建高级群形式的群组
群资料属性 群名,群头像,群简介,群公告,群扩展字段,
申请加入群组的验证模式,群邀请模式,群被邀请模式,
群资料修改模式,群资料扩展字段修改模式
邀请入群 支持配置:仅管理员可邀请 、 所有人可邀请
被邀请人同意模式 支持配置: 需要被邀请人同意 不需要被邀请人同意
申请入群 支持
入群验证 支持配置:需要管理员同意、不需要管理员同意、不允许任何人加入
群成员类型 群主、管理员、普通成员
管理员设置 群主可以增减管理员
群组资料修改权限 支持配置: 仅管理员可修改、所有人可修改
修改群成员昵称 群主可以修改所有人的群昵称
管理员只能修改普通成员的群昵称
修改自己的群昵称 支持
消息类型支持 同基础消息类型
消息提醒 接收提醒、只接收管理员消息提醒、不接收提醒
历史消息 支持云端历史消息
离线消息 支持群组离线消息
消息漫游 支持群组漫游消息
指定成员强制推送 支持
群消息已读回执 支持查看某一条群消息已读未读详情(增值服务)
踢人 群主和管理员可以踢人,且管理员不能踢群主和其他管理员
主动退群 除群主外,其他用户均可以主动退群。
群主需先将群转让给其他群成员才可以进行退群操作
禁言 管理员对普通成员禁言、解除禁言
转让群 群主可以将群的拥有者权限转给群内的其他成员,转移后,
被转让者变为新的群主,原群主变为普通成员
群主还可以选择在转让的同时,直接退出该群
解散群 群主可以解散群

以上增值功能收费请参考:资费说明

聊天室功能

功能 功能描述
聊天室容量 支持聊天人数无上限
新建聊天室 新建一个新的聊天室,目前仅支持从服务端创建
查询聊天室信息 包括创建者、在线人数、名称、公告、直播地址、扩展字段、是否发送更新通知时间、通知事件扩展字段
更新聊天室信息 包括创建者、在线人数、名称、公告、直播地址、扩展字段、是否发送更新通知时间、通知事件扩展字段
修改聊天室开/关状态 修改聊天室开/关闭状态,目前仅支持从服务端修改
聊天室消息类型 支持文本、图片、语音、视频、文件、地理位置、通知消息、提示消息、自定义
聊天室消息历史 可查询最近10天的聊天室历史记录,发消息时可设置是否存云端历史记录
聊天室角色 聊天室角色分为固定成员和非固定成员两大类。固定成员包括创建者、管理员、普通成员,非固定成员包括普通游客和匿名游客
聊天室黑名单 被拉黑后,将无法再进入聊天室
聊天室禁言 禁言用户可以在聊天室内,但无法发送消息
聊天室临时禁言 聊天室支持设置临时禁言时长,禁言时长时间到了,自动取消禁言
聊天室全员禁言 设置聊天室整体禁言状态,仅创建者和管理员能发言
踢出聊天室 仅管理员可以踢,如目标是管理员仅创建者可以踢
修改自己的聊天室成员信息 目前只支持聊天室昵称,头像和扩展字段的更新
同时进入多个聊天室 支持同一帐号同时进入多个聊天室,会建立多个连接
多端同时进入一个聊天室 支持同一帐号在多端同时进入同一个聊天室
聊天室机器人 往聊天室内批量添加、删除机器人,每次最多 100 个帐号
聊天室队列 针对直播连麦场景使用

如需修改聊天室多端同时进入一个聊天室策略,请参考 配置聊天室登录策略,在 网易云信用户控制台 进行配置。

圈组

圈组是网易云信 IM 即时通讯服务的新能力,可用来帮助您构建“类discord即时通讯社群”。圈组与单聊、群聊、聊天室一起构成 IM 的四大能力模块。

详情请参考 圈组功能

消息抄送

抄送类型 类型说明
会话消息抄送 会话类型的消息,目前包括单聊消息,群聊消息,群组操作,好友操作
登录事件抄送 用户登录事件的消息
登出事件抄送 用户登出事件的消息
聊天室消息抄送 聊天室中聊天的消息
实时音视频/白板通话消息抄送 汇报实时音视频通话时长、白板事件时长的消息
音视频/白板文件存储信息抄送 表示音视频/白板存储文件的大小、下载地址等消息
单聊消息撤回抄送 表示单聊消息撤回抄送
群聊消息撤回抄送 表示群聊消息撤回抄送
主播或管理员进出聊天室事件抄送 汇报主播或管理员进出聊天室事件消息
专线电话通话结束回调抄送 汇报专线电话通话结束回调抄送的消息
短信回执抄送 汇报短信回执抄送的消息
易盾反垃圾异步抄送 用于音频、视频反垃圾的异步结果抄送

事件订阅

功能 备注
在线状态事件发布 发布一个事件,目前仅内置支持了在线状态事件
在线状态事件订阅 订阅指定帐号的指定类型的事件,需要制定订阅有效期
查询事件订阅 提供查询本账号和指定账号存在的订阅关系接口

用户控制台

您可以在 网易云信用户控制台 上完成开发过程中所需要的一些配置,配置完成后,立即生效。

功能 备注
API 调试 服务端 API 接口调试
帐号管理 创建帐号、禁用帐号、帐号基本信息设置
多端登录配置 配置应用帐号多端登录及互踢策略
聊天室多端配置 配置同一个帐号是否允许在多端同时进入同一个聊天室
消息撤回时长配置 配置消息发送出去后多久可以撤回,默认 120 秒
消息漫游配置 配置是否需要开启消息漫游功能
消息抄送配置 配置消息抄送地址及类型
推送证书配置 配置 APNS、iOS PushKit、小米推送、华为推送证书
标识管理 配置 iOS Bundle Identifier 和 Android Package Name

指南针平台数据统计

网易云信用户控制台除了提供基本的管理功能外,还向开发者提供了各类维度的数据统计。登录 网易云信用户控制台,点击左侧导航中的指南针,单击IM 即时通讯,选择对应的应用即可查看该应用下的相关统计数据。

质量指标 说明
登录成功率 登录情况模块提供了关于用户登录IM和聊天室服务的成功率的数据指标。可以选择不同维度了解用户登录的分布情况,如地域,客户端类型和SDK版本。支持以表格形式查看数据或下载数据到本地。
登录错误码 登录错误码视图用饼状图和表格的方式展示了各类登录错误码的分布情况。你可以根据错误码数据为分析应用的潜在问题提供依据。
消息发送 消息发送模块展示了 IM 即时通讯系统中单聊和群聊会话中的消息发送情况。用户可以查看单聊和群聊的消息发送成功率等指标。指标具体含义详见 质量指标说明。支持以表格形式查看数据或下载数据到本地。
定位发送失败问题 指南针默认提供七日数据曲线图,您可以选择单击曲线波谷查看发送失败的统计数据。在弹出的错误原因明细窗口可以显示当日发送失败的各类错误码情况。
消息推送 消息推送模块提供了关于各厂商平台推送成功率的指标,包括消息推送数和推送成功数。
特定平台的推送情况 以苹果推送为例,在推送板块单击苹果推送成功率标签,可以过滤其他厂商的推送情况,只展示苹果推送曲线,单击曲线波谷定位推送失败数据。
消息到达 消息到达模块展示了消息在接收端的到达情况。您可以查看单聊消息的当日到达率、消息未送达原因等指标,了解消息在接收端的接收情况,为消息传递的优化提供依据。
定位未到达情况 单击曲线图中的波谷数据点,指南针会弹出未送达原因明细对话框,列明了不同错误类型及消息数等详细信息。
消息延时 消息延时模块提供了关于消息传输的延时情况。用户可以查看单聊、群聊和聊天室消息传输的平均延时等指标。通过分析延时数据,您可以发现潜在的问题和瓶颈,并进行相应的优化和改进。
文件上传下载 文件上传下载模块展示了IM即时通讯中的文件传输情况。用户可以查看文件上传下载成功率和速率趋势,评估文件传输的稳定性和可用性。
此文档是否对你有帮助?
有帮助
去反馈
  • 架构介绍
  • 功能列表
  • 多端登录
  • 消息类型
  • 消息功能
  • NOS 云存储
  • 用户资料托管
  • 用户关系托管
  • 群组功能
  • 聊天室功能
  • 圈组
  • 消息抄送
  • 事件订阅
  • 用户控制台
  • 指南针平台数据统计