From 1c877cca7fa93d910b8fa9e0d62cbc996e0920fd Mon Sep 17 00:00:00 2001 From: haoxiuwen Date: Mon, 20 Nov 2023 18:48:13 +0800 Subject: [PATCH] modify --- docs/document/android/group_overview.md | 2 +- docs/document/android/message_overview.md | 16 ++++++++-------- docs/document/server-side/message_chatroom.md | 2 +- docs/document/server-side/message_group.md | 2 +- docs/document/server-side/message_single.md | 2 +- docs/document/web/message_overview.md | 16 ++++++++-------- docs/product/enable_and_configure_IM.md | 2 +- docs/product/limitation.md | 14 +++++++------- docs/product/product_dynamics.md | 2 +- docs/product/security_best_practices.md | 2 +- 10 files changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/document/android/group_overview.md b/docs/document/android/group_overview.md index 4ba6e8af2..6d4889391 100644 --- a/docs/document/android/group_overview.md +++ b/docs/document/android/group_overview.md @@ -81,4 +81,4 @@ ### 群组人数限制 -群成员的数量根据不同的套餐版本而不同，免费版 100 人/群，专业版 300 人/群， 旗舰版 3,000 人/群，尊享版 8,000 人/群。 +群成员的数量根据不同的套餐版本而不同，详见[产品价格](/pricing.html#套餐包功能详情)。 diff --git a/docs/document/android/message_overview.md b/docs/document/android/message_overview.md index 5cc7a54e2..712e72d1f 100644 --- a/docs/document/android/message_overview.md +++ b/docs/document/android/message_overview.md @@ -12,15 +12,15 @@ | 类型
| 描述 | | :------------- | :----------------------------------------------------------- | -| 文本消息 | 文本消息的内容是文本，包含超链接和表情符号等。表情消息基于文本消息实现。
文本消息大小限制为 3 KB。 | -| 图片消息 | 图片消息是附件消息，需要先将图片上传至消息服务器。接收方收到图片时自动下载图片缩略图。
图片不能超过 10 MB，图片消息大小限制为 3 KB。 | -| 语音消息 | 语音消息是附件消息，需要先将语音上传至消息服务器。接收方收到语音时自动下载语音。
音频文件不能超过 10 MB，音频消息大小限制为 3 KB。 | -| 视频消息 | 视频消息是附件消息，需要先将视频上传至消息服务器。接收方收到视频时自动下载视频缩略图，点击下载视频消息。对于 Web 端，视频消息没有缩略图。
视频文件不能超过 10 MB，视频消息大小限制为 3 KB。 | -| 文件消息 | 文件消息是附件消息，需要先将文件上传至消息服务器。
附件大小不能超过 10 MB，文件消息大小限制为 3 KB。 | +| 文本消息 | 文本消息的内容是文本，包含超链接和表情符号等。表情消息基于文本消息实现。
文本消息大小限制为 5 KB。 | +| 图片消息 | 图片消息是附件消息，需要先将图片上传至消息服务器。接收方收到图片时自动下载图片缩略图。
图片不能超过 10 MB，图片消息大小限制为 5 KB。 | +| 语音消息 | 语音消息是附件消息，需要先将语音上传至消息服务器。接收方收到语音时自动下载语音。
音频文件不能超过 10 MB，音频消息大小限制为 5 KB。 | +| 视频消息 | 视频消息是附件消息，需要先将视频上传至消息服务器。接收方收到视频时自动下载视频缩略图，点击下载视频消息。对于 Web 端，视频消息没有缩略图。
视频文件不能超过 10 MB，视频消息大小限制为 5 KB。 | +| 文件消息 | 文件消息是附件消息，需要先将文件上传至消息服务器。
附件大小不能超过 10 MB，文件消息大小限制为 5 KB。 | | 位置消息 | 位置消息需要第三方的地图服务提供经纬度信息。接收方接收到位置消息，通过经纬度信息可以在第三方的地图服务中显示位置。 | -| 透传消息 | 透传消息可视为命令消息。通过发送这条命令给对方，通知对方要执行的操作，对方收到消息后系统可以自定义处理。透传消息不会在 UI 上展示。
消息大小限制为 3 KB。
你可以使用透传消息更新头像和昵称以及进行状态同步等。
透传消息不会存入本地数据库。 | +| 透传消息 | 透传消息可视为命令消息。通过发送这条命令给对方，通知对方要执行的操作，对方收到消息后系统可以自定义处理。透传消息不会在 UI 上展示。
消息大小限制为 5 KB。
你可以使用透传消息更新头像和昵称以及进行状态同步等。
透传消息不会存入本地数据库。 | | 消息自定义扩展 | 当基础的消息类型不满足需求时，可以使用消息自定义扩展增强基础消息类型。
使用扩展后，消息大小不能超过原类型消息的大小。
典型的用例是发送引用较早文本或图像消息的消息。 | -| 自定义消息 | 开发者自定义的消息类型。自定义消息支持设置类型名称，开发者可以添加多种自定义消息。
自定义消息大小限制为 3 KB。
自定义消息的使用场景：红包消息、模板消息等。 | +| 自定义消息 | 开发者自定义的消息类型。自定义消息支持设置类型名称，开发者可以添加多种自定义消息。
自定义消息大小限制为 5 KB。
自定义消息的使用场景：红包消息、模板消息等。 | ### 消息功能 @@ -59,7 +59,7 @@ Web 和小程序端无本地消息存储。 环信即时通讯 IM 在消息服务器保存历史消息，方便用户在新设备上获取历史消息。 -历史消息存储时间与套餐版本相关：专业版 7 天，旗舰版 90 天， 尊享版 180 天。 +历史消息存储时间与套餐版本相关，详见[产品价格](/pricing.html#套餐包功能详情)。 | 功能 | 描述 | 适用的平台/框架| | :---------- | :----------- |:----------------------------------- | diff --git a/docs/document/server-side/message_chatroom.md b/docs/document/server-side/message_chatroom.md index a48aee62f..fea4b46bd 100644 --- a/docs/document/server-side/message_chatroom.md +++ b/docs/document/server-side/message_chatroom.md @@ -6,7 +6,7 @@ 聊天室场景下，发送各类型的消息调用需调用同一 RESTful API，不同类型的消息只是请求体中的 body 字段内容存在差异，发送方式与单聊类似，详见[发送单聊消息](message_single.html)。 :::notice -接口调用过程中，请求体若超过 5 KB 会导致 413 错误，需要拆成几个较小的请求体重试。同时，请求体和扩展字段的总长度不能超过 3 KB。 +接口调用过程中，请求体和扩展字段的总长度不能超过 5 KB。 ::: **发送频率**：通过 RESTful API 单个应用每秒最多可向聊天室发送 100 条消息，每次最多可向 10 个聊天室发送消息。例如，一次向 10 个聊天室发送消息，视为 10 条消息。 diff --git a/docs/document/server-side/message_group.md b/docs/document/server-side/message_group.md index b25d85a48..cb3d452b0 100644 --- a/docs/document/server-side/message_group.md +++ b/docs/document/server-side/message_group.md @@ -7,7 +7,7 @@ 群组聊天场景下，发送各类型的消息调用需调用同一 RESTful API，不同类型的消息只是请求体中的 body 字段内容存在差异，发送方式与单聊类似，详见[发送单聊消息](message_single.html)。 :::notice -接口调用过程中，请求体若超过 5 KB 会导致 413 错误，需要拆成几个较小的请求体重试。同时，请求体和扩展字段的总长度不能超过 3 KB。 +接口调用过程中，请求体和扩展字段的总长度不能超过 5 KB。 ::: **发送频率**：通过 RESTful API 单个应用每秒最多可发送 20 条消息，每次最多可向 3 个群组发送。例如，一次向 3 个群组发送消息，视为 3 条消息。 diff --git a/docs/document/server-side/message_single.md b/docs/document/server-side/message_single.md index 67fdbd98e..f9a8d81bc 100644 --- a/docs/document/server-side/message_single.md +++ b/docs/document/server-side/message_single.md @@ -47,7 +47,7 @@ 单聊场景下，发送各类型的消息调用需调用同一 RESTful API，不同类型的消息只是请求体中的 body 字段内容存在差异。 :::notice -在接口调用过程中，请求体若超过 5 KB 会导致 413 错误，需要拆成几个较小的请求体重试。同时，请求体和扩展字段的总长度不能超过 3 KB。 +接口调用过程中，请求体和扩展字段的总长度不能超过 5 KB。 ::: **发送频率**：通过 RESTful API 单个应用每分钟最多可发送 6000 条消息，每次最多可向 600 人发送。例如，一次向 600 人发消息，视为 600 条消息。 diff --git a/docs/document/web/message_overview.md b/docs/document/web/message_overview.md index 212331d86..ff4436c7b 100644 --- a/docs/document/web/message_overview.md +++ b/docs/document/web/message_overview.md @@ -14,15 +14,15 @@ | 类型
| 描述 | | :------------- | :----------------------------------------------------------- | -| 文本消息 | 文本消息的内容是文本，可以包含超链接、emoji 表情符号等。表情消息是基于文本消息实现的。
文本消息大小限制为 3 KB。 | -| 图片消息 | 图片消息是附件消息，需要先将图片上传至消息服务器。接收方收到图片时自动下载图片缩略图。
图片消息大小限制为 10 MB。 | -| 语音消息 | 语音消息是附件消息，需要先将语音上传至消息服务器。接收方收到语音时自动下载语音。
语音消息大小限制为 10 MB。 | -| 视频消息 | 视频消息是附件消息，需要先将视频上传至消息服务器。接收方收到视频时自动下载视频缩略图，点击下载视频消息。
视频消息大小限制为 10 MB。 | -| 文件消息 | 文件消息是附件消息，需要先将文件上传至消息服务器。接收方收到文件时自动下载文件。
文件消息大小限制为 10 MB。 | +| 文本消息 | 文本消息的内容是文本，可以包含超链接、emoji 表情符号等。表情消息是基于文本消息实现的。
文本消息大小限制为 5 KB。 | +| 图片消息 | 图片消息是附件消息，需要先将图片上传至消息服务器。接收方收到图片时自动下载图片缩略图。
图片不能超过 10 MB，图片消息大小限制为 5 KB。 | +| 语音消息 | 语音消息是附件消息，需要先将语音上传至消息服务器。接收方收到语音时自动下载语音。
音频文件不能超过 10 MB，音频消息大小限制为 5 KB。 | +| 视频消息 | 视频消息是附件消息，需要先将视频上传至消息服务器。接收方收到视频时自动下载视频缩略图，点击下载视频消息。
视频文件不能超过 10 MB，视频消息大小限制为 5 KB。 | +| 文件消息 | 文件消息是附件消息，需要先将文件上传至消息服务器。接收方收到文件时自动下载文件。
附件大小不能超过 10 MB，文件消息大小限制为 5 KB。 | | 位置消息 | 位置消息需要第三方的地图服务提供经纬度信息。接收方接收到位置消息，通过经纬度信息可以在第三方的地图服务中显示位置。 | -| 透传消息 | 透传消息可视为命令消息，通过发送这条命令给对方，通知对方要执行的操作，对方收到消息后系统可以自定义处理。透传消息不会在 UI 上展示。
消息大小显示为 3 KB。
透传消息的使用场景：头像、昵称的更新、状态同步等。
透传消息不会存入本地数据库。 | +| 透传消息 | 透传消息可视为命令消息，通过发送这条命令给对方，通知对方要执行的操作，对方收到消息后系统可以自定义处理。透传消息不会在 UI 上展示。
消息大小限制为 5 KB。
透传消息的使用场景：头像、昵称的更新、状态同步等。
透传消息不会存入本地数据库。 | | 消息自定义扩展 | 当基础的消息类型不满足需求时，可以使用消息自定义扩展增强基础消息类型。
使用扩展后，消息大小不能超过原类型消息的大小。
消息自定义扩展的使用场景：消息中需要携带被回复的消息内容和图文消息等。 | -| 自定义消息 | 开发者自定义的消息类型。自定义消息支持设置类型名称，开发者可以添加多种自定义消息。
自定义消息大小限制为 3 KB。
自定义消息的使用场景：红包消息、模板消息等。 | +| 自定义消息 | 开发者自定义的消息类型。自定义消息支持设置类型名称，开发者可以添加多种自定义消息。
自定义消息大小限制为 5 KB。
自定义消息的使用场景：红包消息、模板消息等。 | ### 消息功能 @@ -33,7 +33,7 @@ Web 端暂无相关功能。 #### 从服务器获取消息 环信即时通讯 IM 在消息服务器保存历史消息，方便用户在新设备上获取历史消息。 -历史消息存储时间与套餐版本相关：专业版 7 天，旗舰版版 90 天， 尊享版 180 天。 +历史消息存储时间与套餐版本相关，详见[产品价格](/pricing.html#套餐包功能详情)。 | 功能 | 描述 | | :------------------------- | :----------------------------------- | diff --git a/docs/product/enable_and_configure_IM.md b/docs/product/enable_and_configure_IM.md index 0c15b2a78..39fe29ce8 100644 --- a/docs/product/enable_and_configure_IM.md +++ b/docs/product/enable_and_configure_IM.md @@ -51,7 +51,7 @@ | 参数项 | 描述 | | :----------------------- | :-------------------------------------------- | | 选择要开通服务的 Appkey | 请确认 App Key 是否选择正确，购买后无法修改。 | -| 请选择服务版本 | 服务版本的选择如下：
- 当 App Key 为免费版时，可购买专业版、旗舰版或尊享版，不可单独购买增值服务。
- 当 App Key 为专业版时，可购买旗舰版、尊享版或单独购买增值服务。
- 当 App Key 为旗舰版时，可购买尊享版或单独购买增值服务。
- 当 App Key 为尊享版时，仅支持单独购买增值服务。| +| 请选择服务版本 | 服务版本的选择如下：
- 当 App Key 为免费版时，可购买专业版或旗舰版，不可单独购买增值服务。
- 当 App Key 为专业版时，可购买旗舰版或单独购买增值服务。| | 可选增值服务 | 请根据实际需求选择增值功能：
- 单个群成员数上限和单个用户可加入群组数上限：不支持叠加购买；以单个群成员数上限举例说明，如果旗舰版购买了 8000 人/群的增值服务，则表示单个群成员上限配置提升至 8000 人/群。
- 消息云存储时长和 REST API 接口调用频率上限：支持可叠加购买，即支持多倍购买；以消息云存储时长举例说明，如购买时选择了 10 份，则表示消息云存储时长延长 300 天（30 天*10）。 | :::notice diff --git a/docs/product/limitation.md b/docs/product/limitation.md index 3632005de..b043b8054 100644 --- a/docs/product/limitation.md +++ b/docs/product/limitation.md @@ -61,13 +61,13 @@ | 消息类型 | 消息长度限制 | | :------------- | :----------------------------------- | -| 文本消息 | 3 KB | -| 图片消息 | 图片不能超过 10 MB，图片消息大小限制为 3 KB。 | -| 语音消息 | 音频文件不能超过 10 MB，语音消息大小限制为 3 KB。 | -| 视频消息 | 视频文件不能超过 10 MB，视频消息大小限制为 3 KB。 | -| 文件消息 | 附件大小不能超过 10 MB，文件消息大小限制为 3 KB。 | -| 透传消息 | 3 KB | -| 自定义消息 | 3 KB | +| 文本消息 | 5 KB | +| 图片消息 | 图片不能超过 10 MB，图片消息大小限制为 5 KB。 | +| 语音消息 | 音频文件不能超过 10 MB，语音消息大小限制为 5 KB。 | +| 视频消息 | 视频文件不能超过 10 MB，视频消息大小限制为 5 KB。 | +| 文件消息 | 附件大小不能超过 10 MB，文件消息大小限制为 5 KB。 | +| 透传消息 | 5 KB | +| 自定义消息 | 5 KB | ## 用户属性大小限制 diff --git a/docs/product/product_dynamics.md b/docs/product/product_dynamics.md index f7d663efd..e5073e03a 100644 --- a/docs/product/product_dynamics.md +++ b/docs/product/product_dynamics.md @@ -5,6 +5,6 @@ | 动态名称 | 动态描述 | 发布时间 | 相关文档 | | :----- | :------- | :---------------- | :---------------- | -| SDK 4.2.0 开发版发布 | **新增特性**：
- 客户端支持[好友备注功能](/document/android/releasenote.html)。
- 客户端新增消息属性用于判断消息是否为聊天室全局广播消息。
- 移动端新增 API 用于[从服务器获取当前用户已加入的群组数量](/document/android/group_manage.html#查询当前用户已加入的群组数量)。
- 移动端的申请入群被拒绝的回调中添加申请者和拒绝者的用户 ID。
- 移动端新增错误码 706，表示聊天室所有者不允许离开聊天室。若初始化时，将是否允许聊天室所有者离开聊天室的参数设置为否时，聊天室所有者在移动端调用离开聊天室的方法时会提示该错误。
- 移动端在 `EMOptions` 类中新增属性用于在初始化时配置获取会话列表时是否返回空会话。
**优化**
- 客户端统一 Agora Token 和 EaseMob Token 登录方式，新增 EaseMob Token 即将过期及已过期的回调。
- 移动端优化发消息时重试的逻辑。
- 移动端优化数据库升级逻辑。| 2023-11-17 |
- [Android 4.2.1 更新日志](/document/android/releasenote.html)
- [iOS 4.2.1 更新日志](/document/ios/releasenote.html)
- [Web 4.3.0 更新日志](/document/web/releasenote.html)。 | +| SDK 4.2.0 开发版发布 | **新增特性**：
- 客户端支持[好友备注功能](/document/android/releasenote.html)。
- 客户端支持聊天室全局广播消息，可根据消息属性判断。
- 移动端可以[从服务器获取当前用户已加入的群组数量](/document/android/group_manage.html#查询当前用户已加入的群组数量)。
- 移动端在申请入群被拒绝时，返回的回调中增加了申请者和拒绝者。
- 移动端在初始化时可配置获取会话列表时是否返回空会话。
**优化**
- 客户端统一 Agora Token 和 EaseMob Token 登录方式，新增 EaseMob Token 即将过期及已过期的回调。
- 移动端优化发消息时重试的逻辑。
- 移动端优化数据库升级逻辑。| 2023-11-17 |
- [Android 4.2.1 更新日志](/document/android/releasenote.html)
- [iOS 4.2.1 更新日志](/document/ios/releasenote.html)
- [Web 4.3.0 更新日志](/document/web/releasenote.html)。 | | REST API | 支持[通过 REST API 向 app 下的所有活跃聊天室发送全局广播消息](/document/server-side/message_chatroom.html#发送聊天室全局广播消息) 。活跃聊天室指聊天室至少存在一个成员，而且至少发送过一条消息。| 2023-11-17 | 详见[发送聊天室广播消息](/document/server-side/message_chatroom.html#发送聊天室全局广播消息)。 | | IM Demo | 好友详情页面可添加和修改好友备注。 | 2023-11-17 |
- [Android 4.2.1 Demo](https://www.easemob.com/download/demo)
- [iOS 4.2.0 Demo](https://www.easemob.com/download/demo) | \ No newline at end of file diff --git a/docs/product/security_best_practices.md b/docs/product/security_best_practices.md index 6be1b23b1..8e1a6ee0e 100644 --- a/docs/product/security_best_practices.md +++ b/docs/product/security_best_practices.md @@ -38,7 +38,7 @@ | 数据类型 | 数据分类 | 存储时间 | |:-----------------------------------------|:---------|:--------------------------------------------------------------------------------------| | Console 注册数据 | 客户信息 | 直至客户删除账号或服务停用 6 个月。 | -| 消息（包括历史消息、漫游消息、离线消息） | 用户信息 | 根据消息云存储时长进行保存。
专业版 7 天、旗舰版 90 天、尊享版 180 天。 | +| 消息（包括历史消息、漫游消息、离线消息） | 用户信息 | 消息的云存储时长与套餐版本相关，详见[产品价格](/pricing.html#套餐包功能详情)。 | | 消息附件 | 用户信息 | 7 天。 | | 消息回调 | 用户信息 | 3 天。 | | 用户资料托管 | 用户信息 | 直到客户删除或服务停用 6 个月。 |