Skip to content

Commit 01a1b65

Browse files
authored
Merge pull request #1419 from haoxiuwen/doc-v2
Modify Console Docs
2 parents ef220fa + da30b8d commit 01a1b65

11 files changed

+24
-22
lines changed

docs/product/console/account_register.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
1. 打开 [环信控制台](https://console.easemob.com/user/register) 登录页面。
1010
2. 输入你的手机号码,然后单击 **获取验证码**,将下方的滑块拖动到最右边。
1111
3. 填入短信验证码后,阅读并勾选同意通讯云服务条款和通讯云隐私政策。
12-
4. 单击 **注册**
12+
4. 单击 **注册**
1313

1414
![img](/images/console/account_registration_phone_code.png)
1515

docs/product/console/basic_conversation_group_chatroom.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
群组总数取决于订阅的套餐版本:
88

99
- 免费版:支持 100 个群组。若要提升上限,点击 **升级** 升级为专业版或旗舰版。
10-
- 专业版/旗舰版:不限制群组数,但峰值群组和聊天室总数每月不能超过 100,000 个
10+
- 专业版/旗舰版:无限制
1111

1212
注意:解散后的群组不计数。
1313

@@ -27,7 +27,8 @@
2727
单个群成员数上限取决于订阅的套餐版本:
2828

2929
- 免费版:每个用户最多可加入 100 个群。若要提升上限,点击 **升级** 升级为专业版或旗舰版。
30-
- 专业版/旗舰版:每个用户最多可加入 600/3000 个群。若要提升上限,点击 **升级** 单独付费。
30+
- 专业版:每个用户最多可加入 600 个群。若要提升上限,点击 **升级** 单独付费。
31+
- 旗舰版:每个用户最多可加入 100000 个群。
3132

3233
![img](/images/console/basic_group_per_user.png)
3334

@@ -36,7 +37,7 @@
3637
聊天室总数上限取决于订阅的套餐版本:
3738

3839
- 免费版:支持 100 个聊天室。若要提升上限,点击 **升级** 升级为专业版或旗舰版。
39-
- 专业版/旗舰版:不限制聊天室数,但峰值群组和聊天室总数每月不能超过 100,000 个
40+
- 专业版/旗舰版:无限制
4041

4142
注意:解散后的聊天室不计数。
4243

@@ -48,7 +49,7 @@
4849
你可以根据当前的套餐包版本开通该服务:
4950

5051
- 免费版:点击 **立即升级** 升级至专业版或旗舰版。
51-
- 专业版:点击 **立即购买** 单独开通服务
52+
- 专业版:点击 **立即购买** 单独购买和开通服务
5253
- 旗舰版:点击 **免费开通** 开通服务。
5354

5455
![img](/images/console/basic_thread.png)

docs/product/console/basic_message.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
你可以根据当前的套餐包版本开通该服务:
3434

3535
- 免费版:点击 **立即升级** 升级到专业版或旗舰版,然后开通该功能。
36-
- 专业版:点击 **立即购买** 单独购买该功能
36+
- 专业版:点击 **立即购买** 单独购买和开通服务
3737
- 旗舰版:点击 **免费开通** 开通该功能。
3838

3939
![img](/images/console/basic_message_receipt_group.png)
@@ -85,7 +85,8 @@
8585

8686
你可以根据当前的套餐包版本开通该服务:
8787

88-
- 免费版/专业版:点击 **立即升级** 升级至旗舰版。
88+
- 免费版/专业版:点击 **立即升级** 升级至专业版或旗舰版。
89+
- 专业版:点击 **立即购买** 单独购买和开通服务。
8990
- 旗舰版:点击 **免费开通** 开通该服务。
9091

9192
![img](/images/console/basic_message_reaction.png)

docs/product/console/basic_other.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@
7373
- 免费版:点击 **立即升级** 升级至专业版或旗舰版。
7474
- 专业版/旗舰版:点击 **立即购买** 单独开通服务。
7575

76-
功能开通后,你可以对群组和聊天室中的消息和操作进行实时管理审核,详见 [群组审核管理](operation_group.html#群组审核管理)[聊天室审核管理](opeartion_chatroom.html#聊天室审核管理) 文档。
76+
功能开通后,你可以对群组和聊天室中的消息和操作进行实时管理审核,详见 [群组审核管理](operation_group.html#群组审核管理)[聊天室审核管理](operation_chatroom.html#聊天室审核管理) 文档。
7777

7878
![img](/images/console/basic_other_message_moderation.png)
7979

docs/product/console/basic_user.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
你可以根据套餐版本开通该服务:
7373

7474
- 免费版:点击 **立即升级** 升级至专业版或旗舰版。
75-
- 专业版:点击 **立即购买** 单独开通服务
75+
- 专业版:点击 **立即购买** 单独购买和开通服务
7676
- 旗舰版:点击 **免费开通** 开通服务。
7777

7878
![img](/images/console/basic_user_mute.png)

docs/product/console/moderation_history.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[开通内容审核服务](purchase_value_added.html#内容审核) 后,若使用了文本、图片或音视频内容审核,你可以查看审核记录定位和解决问题,例如,发现某条消息经过审核后的下发结果不符合业务预期。
44

5-
本文以文本审核服务为例,介绍若发现某条消息经过审核后的下发结果不符合业务预期,如何通过查看**历史记录**页面定位和解决问题。
5+
本文以文本审核服务为例,介绍若发现某条消息经过审核后的下发结果不符合业务预期,如何通过查看 **历史记录** 页面定位和解决问题。
66

77
## 1. 进入历史记录页面
88

@@ -16,15 +16,15 @@
1616

1717
| 字段 | 描述 |
1818
| :----------- | :----------------------------------------------------------- |
19-
| 发送方ID | 内容发送方的环信用户 ID。规则测试页发起的审核,发送方的用户ID默认为 **test**|
20-
| 接收方ID | 内容接收方的环信用户 ID |
19+
| 发送方ID | 内容发送方的环信用户 ID。规则测试页发起的审核,发送方的用户 ID 默认为 **test**|
20+
| 接收方ID | 内容接收方的环信用户 ID |
2121
| 会话类型 | 消息内容的会话类型:单聊、群聊、聊天室。 |
2222
| 消息内容 | 审核的内容。对于文本消息,显示具体文本内容;对于图片和音视频消息,显示文件链接,点击链接即可查看具体内容。 |
2323
| 消息发送时间 | 内容的发送时间。如果是一条消息,则表示消息的发送时间;如果是规则测试页内容,则表示点击立即审核的时间。 |
2424
| 规则名称 | 按该条规则配置的策略进行审核处理。 |
2525
| 消息处置结果 | 消息内容的下发处理结果:通过、拦截、撤回、替换***|
2626
| 审核结果 | 消息内容的审核结果。如果成功返回结果,存在通过/拒绝/疑似3种情况;如果指定时间内未返回结果,则记为调用失败。 |
27-
| 风险类型 | 当审核结果为“拒绝”时,表示发现违规内容,同时会返回风险类型(违规原因)。 |
27+
| 风险类型 | **审核结果****拒绝** 时,表示发现违规内容,同时会返回风险类型(违规原因)。 |
2828
| 风险详情 | 风险的详细情况。 |
2929

3030
## 2. 查看审核结果

docs/product/console/moderation_keyword.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@
3030
| 字段 | 描述 |
3131
| :------------------- | :----------------------------------------------------------- |
3232
| 名单名称 | 关键词名单的名称,不能超过 32 个字符。 |
33-
| 命中处置 | 对命中关键词的消息的处理:<br/> - 通过:下发消息。<br/> - 替换为***:将消息内容中命中的关键词替换为 `***` 后再下发消息。<br/>- 拦截:不下发消息。 |
33+
| 命中处置 | 对命中关键词的消息的处理:<br/> - **通过**:下发消息。<br/> - `替换为***`:将消息内容中命中的关键词替换为 `***` 后再下发消息。<br/>- **拦截**:不下发消息。 |
3434
| 生效范围 | 关键词审核规则的应用范围,包括:<br/> - **全部**:所有会话,包含单聊、群聊和聊天室会话。<br/> - **单聊**<br/> - **群聊**<br/> - **聊天室** <br/> - 群组/聊天室标签。详见 [标签管理](moderation_user_tag.html)|
35-
| 匹配方式 | <br/> - 包含匹配:模糊匹配,即消息内容中包含关键词内容即为命中。例如,关键词为“加我微信”,若消息内容中包含“加我微信88888**88” 即命中关键词。 <br/> - 相等匹配:精确匹配。|
35+
| 匹配方式 | <br/> - **包含匹配**:模糊匹配,即消息内容中包含关键词内容即为命中。例如,关键词为“加我微信”,若消息内容中包含“加我微信88888**88” 即命中关键词。 <br/> - **相等匹配**:精确匹配。|
3636
| 关键词 | 该规则中的关键词。每个关键词的长度不能超过 128 个字符,一次最多可添加 200 个词条,每行一个词条。 |
3737

3838
关键词创建成功后会显示在名单列表中,默认为开启状态。若不需要使用该名单,可以在**状态**栏中将其关闭。

docs/product/console/moderation_rule_config.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@
3131

3232
| 参数选项 | 描述 |
3333
| :------------------- | :----------------------------------------------------------- |
34-
| 审核结果为拒绝 | 表示发现违规内容,建议拦截。支持 3 种处置策略:<br/> - 拦截:即不会下发消息。<br/> - 通过:即下发消息。如果处于测试阶段,模型还没有调整至完全符合业务预期时,可选择该设置,即审核结果不会对消息产生影响;如果审核效果测试符合预期后,建议选择 **拦截**`替换为***`,即可对违规消息进行合理处置。<br/> - 替换为 `***`:表示会把敏感词替换为 `***` 后再下发消息。说明:如果是智能语义识别出违规,不会返回违规敏感词,因此这种情况无法实现替换 *** 时,会按拦截处理。 |
35-
| 审核结果为疑似 | 表示可能存在违规内容,通常这部分内容如果有人工审核,建议人工再次审核。支持 2 种处置策略:<br/> - 拦截:不会下发消息。<br/> - 通过:下发消息。 |
36-
| 审核服务调用失败 | 表示审核服务没有在一定时间内返回审核结果,即认为调用失败;例如文本审核接口超时时间为 200 毫秒,若该时间内未返回审核结果,则视为异常。通常认定为异常会有3种原因,一是没有调用权限,二是返回时间超时,三是服务出现异常。支持2种处置策略:<br/> - 拦截:不会下发消息。<br/> - 通过:下发消息。 |
34+
| 审核结果为拒绝 | 表示发现违规内容,建议拦截。支持 3 种处置策略:<br/> - **拦截**:即不会下发消息。<br/> - **通过**:即下发消息。如果处于测试阶段,模型还没有调整至完全符合业务预期时,可选择该设置,即审核结果不会对消息产生影响;如果审核效果测试符合预期后,建议选择 **拦截**`替换为***`,即可对违规消息进行合理处置。<br/> - `替换为 ***`:表示会把敏感词替换为 `***` 后再下发消息。说明:如果是智能语义识别出违规,不会返回违规敏感词,因此这种情况无法实现替换 *** 时,会按拦截处理。 |
35+
| 审核结果为疑似 | 表示可能存在违规内容,通常这部分内容如果有人工审核,建议人工再次审核。支持 2 种处置策略:<br/> - **拦截**:不会下发消息。<br/> - **通过**:下发消息。 |
36+
| 审核服务调用失败 | 表示审核服务没有在一定时间内返回审核结果,即认为调用失败;例如文本审核接口超时时间为 200 毫秒,若该时间内未返回审核结果,则视为异常。通常认定为异常会有3种原因,一是没有调用权限,二是返回时间超时,三是服务出现异常。支持2种处置策略:<br/> - **拦截**:不会下发消息。<br/> - **通过**:下发消息。 |
3737
| 审核结果为通过 | 表示未发现违规内容,默认下发消息,无需设置。 |
38-
| 消息拦截后客户端是否报错 | <br/> - (报错):发送方会感知,上报 508 错误码(如下图示例)。应用可根据错误码展示提示信息。<br/> - (不报错):发送方无感知(即不会出现感叹号提示);如果应用内违规内容较多,建议选择 ****,以避免违规用户感知到被拦截后频繁尝试变体违规内容。 |
38+
| 消息拦截后客户端是否报错 | <br/> - ****(报错):发送方会感知,上报 508 错误码(如下图示例)。应用可根据错误码展示提示信息。<br/> - ****(不报错):发送方无感知(即不会出现感叹号提示);如果应用内违规内容较多,建议选择 ****,以避免违规用户感知到被拦截后频繁尝试变体违规内容。 |
3939

4040
![img](/images/moderation/moderation_rule_config_04.png)
4141

docs/product/console/operation_message_statistics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
- **离线消息总数**:用户离线时,服务器端的离线消息数量。服务端发送一条消息时检测到接收方不在线,离线消息数+1。
1010
- **消息分发总数**:下行消息数 + 离线消息数
1111

12-
## app 消息统计
12+
## App 消息统计
1313

1414
**消息量统计** 页面,选择 **全部** 页签,设置数据统计时间,包括 **近7天****当前月** 或自定义时间,查看 app 的消息统计数据,包括上行消息总数、下行消息总数、 离线消息总数和消息分发总数。各项数据的含义如下:
1515

docs/product/console/push_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## 开通服务
88

9-
推送模板是离线推送服务的高级功能,使用前应先开通该功能,详见 [开通文档](basic_message.html#离线推送高级功能)
9+
推送模板是离线推送服务的高级功能,使用前应先开通该功能,详见 [开通文档](basic_message.html#设置离线推送模板)
1010

1111
## 使用默认推送模板
1212

0 commit comments

Comments
 (0)