Skip to content

Commit

Permalink
Merge pull request #424 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Modify IM Docs
  • Loading branch information
haoxiuwen authored Sep 12, 2023
2 parents cec255f + 35ce0ce commit 97da8f2
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 5 deletions.
1 change: 1 addition & 0 deletions docs/document/android/group_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
| 最大成员数 | 成员数支持取决于所选择的版本,最高版本支持 8,000 人。 | 成员数支持取决于所选择的版本,最高版本支持 10,000 人。如需提升该上限,请联系商务。 |
| 离线推送消息 | 离线时,会收到推送消息。 | 离线时,不会收到推送消息;成员离线超过 2 分钟会自动退出聊天室。 |
| 离线消息存储 | 支持离线消息存储,每个会话存储 200 条消息。<br/>用户上线时,会收到离线消息。 | 不支持离线消息存储。如果需要用户新加入聊天室时服务器推送最近的历史消息,可以联系商务开通聊天室历史消息推送,每个会话默认支持 10 条消息,最多可调整至 200 条。 |
| 漫游消息存储 | 支持漫游消息存储。你可以从服务器获取指定会话的消息。 | 不支持漫游消息存储。 |
| 消息可靠性 | 群组中发送的所有消息,用户都会收到。 | 当消息量大时,聊天室中超过阈值的消息会被丢弃。消息开始丢弃的阈值为每秒 100 条消息,可以根据需求进行调整。 |

### 群组成员角色
Expand Down
2 changes: 1 addition & 1 deletion docs/document/server-side/chatroom.md
Original file line number Diff line number Diff line change
Expand Up @@ -946,7 +946,7 @@ PUT https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user/{u

| 参数 | 类型 | 是否必需 | 描述 |
| :----------- | :----- | :------- | :----------------------- |
| `metaData` | JSON || 聊天室的自定义属性,存储为键值对(key-value)集合,即 Map<String,String>。该集合中最多可包含 10 个键值对,在每个键值对中,key 为属性名称,最多可包含 128 个字符;value 为属性值,不能超过 4086 个字符。每个聊天室最多可有 100 个自定义属性,每个应用的聊天室自定义属性总大小为 10 GB。<br/> key 支持以下字符集:<br/> • 26 个小写英文字母 a-z;<br/> • 26 个大写英文字母 A-Z;<br/> • 10 个数字 0-9;<br/> • “\_”, “-”, “.”。 |
| `metaData` | JSON || 聊天室的自定义属性,存储为键值对(key-value)集合,即 Map<String,String>。该集合中最多可包含 10 个键值对,在每个键值对中,key 为属性名称,最多可包含 128 个字符;value 为属性值,不能超过 4096 个字符。每个聊天室最多可有 100 个自定义属性,每个应用的聊天室自定义属性总大小为 10 GB。<br/> key 支持以下字符集:<br/> • 26 个小写英文字母 a-z;<br/> • 26 个大写英文字母 A-Z;<br/> • 10 个数字 0-9;<br/> • “\_”, “-”, “.”。 |
| `autoDelete` | String || 当前成员退出聊天室时是否自动删除该自定义属性。 <br/> • (默认)'DELETE':是; <br/> • 'NO_DELETE':否。 |

#### HTTP 响应
Expand Down
2 changes: 1 addition & 1 deletion docs/document/server-side/message_chatroom.md
Original file line number Diff line number Diff line change
Expand Up @@ -824,7 +824,7 @@ POST https://{host}/{org_name}/{app_name}/messages/chatrooms/users
| `body` | JSON || 消息内容。body 包含的字段见下表说明。 |
| `sync_device` | Bool || 消息发送成功后,是否将消息同步到发送方。<br/> - `true`:是;<br/> - (默认)`false`:否。 |
| `ext` | JSON || 消息支持扩展字段,可添加自定义信息。不能对该参数传入 `null`。同时,推送通知也支持自定义扩展字段,详见 [APNs 自定义显示](/document/ios/push.html#自定义显示)[Android 推送字段说明](/document/android/push.html#自定义显示)|
| `users` | Array | 是 接收消息的聊天室成员的用户 ID 数组。每次最多可传 20 个用户 ID。
| `users` | Array || 接收消息的聊天室成员的用户 ID 数组。每次最多可传 20 个用户 ID。 |

请求体中的 `body` 字段说明详见下表。

Expand Down
3 changes: 2 additions & 1 deletion docs/document/server-side/message_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -831,7 +831,8 @@ POST https://{host}/{org_name}/{app_name}/messages/chatgroups/users
| `sync_device` | Bool || 消息发送成功后,是否将消息同步到发送方。<br/> - `true`:是;<br/> - (默认)`false`:否。 |
| `ext` | JSON || 消息支持扩展字段,可添加自定义信息。不能对该参数传入 `null`。同时,推送通知也支持自定义扩展字段,详见 [APNs 自定义显示](/document/ios/push.html#自定义显示)[Android 推送字段说明](/document/android/push.html#自定义显示)|
| `ext.em_ignore_notification` | Bool || 是否发送静默消息:<br/> - `true`:是;<br/> - (默认)`false`:否。<br/> 发送静默消息指用户离线时,环信即时通讯 IM 服务不会通过第三方厂商的消息推送服务向该用户的设备推送消息通知。因此,用户不会收到消息推送通知。当用户再次上线时,会收到离线期间的所有消息。发送静默消息和免打扰模式下均为不推送消息,区别在于发送静默消息为发送方设置不推送消息,而免打扰模式为接收方设置在指定时间段内不接收推送通知。|
| `users` | Array | 是 |接收消息的群成员的用户 ID 数组。每次最多可传 20 个用户 ID。|
| `users` | Array || 接收消息的群成员的用户 ID 数组。每次最多可传 20 个用户 ID。 |


请求体中的 `body` 字段说明详见下表。

Expand Down
2 changes: 1 addition & 1 deletion docs/private/im/uc_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

| 安装包名称 | 适配环境要求 | 下载安装包 | 下载部署手册 |
| :------------------------------------- | :-------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 环信私有化即时通讯服务安装包(单机版) | 操作系统:Linux、ubuntu 20 及以上、centos 7 及以上 CPU 架构:X86(优先推荐)、ARM | [立即下载](https://zim-private.oss-cn-beijing.aliyuncs.com/zim/ZIM-23.1.5.x86_64-license/ZIM-23.1.5.x86_64.all.tar) | [立即下载](https://zim-private.oss-cn-beijing.aliyuncs.com/zim/ZIM-23.1.5.x86_64-license/%E7%8E%AF%E4%BF%A1%E7%A7%81%E6%9C%89%E5%8C%96IM%E9%83%A8%E7%BD%B2%E6%96%87%E6%A1%A320230516.pdf) |
| 环信私有化即时通讯服务安装包(单机版) | 操作系统:Linux、ubuntu 20 及以上、centos 7 及以上 CPU 架构:X86(优先推荐)、ARM | [立即下载](https://zim-private.oss-cn-beijing.aliyuncs.com/zim/ZIM-23.1.5.x86_64-license/20230912/ZIM-23.1.5.x86_64.all.tar) | [立即下载](https://zim-private.oss-cn-beijing.aliyuncs.com/zim/ZIM-23.1.5.x86_64-license/%E7%8E%AF%E4%BF%A1%E7%A7%81%E6%9C%89%E5%8C%96IM%E9%83%A8%E7%BD%B2%E6%96%87%E6%A1%A320230516.pdf) |

### 2.2 申请授权

Expand Down
2 changes: 1 addition & 1 deletion docs/product/uc_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

| 安装包名称 | 适配环境要求 | 下载安装包 | 下载部署手册 |
| :------------ | :----- | :------- | :------------------------------------------- |
| 环信私有化即时通讯服务安装包(单机版) | 操作系统:Linux、ubuntu 20 及以上、centos 7 及以上 CPU 架构:X86(优先推荐)、ARM | [立即下载](https://zim-private.oss-cn-beijing.aliyuncs.com/zim/ZIM-23.1.5.x86_64-license/ZIM-23.1.5.x86_64.all.tar) | [立即下载](https://zim-private.oss-cn-beijing.aliyuncs.com/zim/ZIM-23.1.5.x86_64-license/%E7%8E%AF%E4%BF%A1%E7%A7%81%E6%9C%89%E5%8C%96IM%E9%83%A8%E7%BD%B2%E6%96%87%E6%A1%A320230516.pdf) |
| 环信私有化即时通讯服务安装包(单机版) | 操作系统:Linux、ubuntu 20 及以上、centos 7 及以上 CPU 架构:X86(优先推荐)、ARM | [立即下载](https://zim-private.oss-cn-beijing.aliyuncs.com/zim/ZIM-23.1.5.x86_64-license/20230912/ZIM-23.1.5.x86_64.all.tar) | [立即下载](https://zim-private.oss-cn-beijing.aliyuncs.com/zim/ZIM-23.1.5.x86_64-license/%E7%8E%AF%E4%BF%A1%E7%A7%81%E6%9C%89%E5%8C%96IM%E9%83%A8%E7%BD%B2%E6%96%87%E6%A1%A320230516.pdf) |

### 2.2 申请授权

Expand Down

0 comments on commit 97da8f2

Please sign in to comment.