Skip to content

Commit 1f3025d

Browse files
authored
Merge pull request #1292 from haoxiuwen/doc-v2
Modify Message Chatroom Product Doc
2 parents 85a40f6 + 87d9bb9 commit 1f3025d

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

docs/product/message_chatroom.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,22 @@
99

1010
## 消息类型
1111

12-
| 类型<div style="width: 120px;"></div> | 描述 |
12+
| 类型<div style="width: 120px;"></div> | 描述 |
1313
| :------------- | :----------------------------------------------------------- |
14-
| 文本消息 | 文本消息的内容是文本,包含超链接和表情符号等。表情消息基于文本消息实现。<br/> 文本消息大小限制为 5 KB。 |
15-
| 位置消息 | 位置消息需要第三方的地图服务提供经纬度信息。接收方接收到位置消息,通过经纬度信息可以在第三方的地图服务中显示位置。 |
16-
| 透传消息 | 透传消息可视为命令消息。通过发送这条命令给对方,通知对方要执行的操作,对方收到消息后系统可以自定义处理。透传消息不会在 UI 上展示。<br/>消息大小限制为 5 KB。<br> 你可以使用透传消息更新头像和昵称以及进行状态同步等。<br/> 透传消息不会存入本地数据库。 |
17-
| 图片消息 | 图片消息是附件消息,需要先将图片上传至消息服务器。接收方收到图片时自动下载图片缩略图。<br/> 图片默认不能超过 10 MB,图片消息大小限制为 5 KB。 |
18-
| 语音消息 | 语音消息是附件消息,需要先将语音上传至消息服务器。接收方收到语音时自动下载语音。<br/> 音频文件默认不能超过 10 MB,音频消息大小限制为 5 KB。 |
19-
| 视频消息 | 视频消息是附件消息,需要先将视频上传至消息服务器。接收方收到视频时自动下载视频缩略图,点击下载视频消息。对于 Web 端,视频消息没有缩略图。<br/> 视频文件默认不能超过 10 MB,视频消息大小限制为 5 KB。 |
20-
| 文件消息 | 文件消息是附件消息,需要先将文件上传至消息服务器。<br/> 附件大小不能超过 10 MB,文件消息大小限制为 5 KB。 |
21-
| 自定义消息 | 开发者自定义的消息类型。自定义消息支持设置类型名称,开发者可以添加多种自定义消息。<br/>自定义消息大小限制为 5 KB。<br/>自定义消息的使用场景:红包消息、模板消息等。 |
14+
| 文本消息 | 文本消息的内容是文本,包含超链接和表情符号等。表情消息基于文本消息实现。<br/> 文本消息大小限制为 5 KB。 |
15+
| 位置消息 | 位置消息需要第三方的地图服务提供经纬度信息。接收方接收到位置消息,通过经纬度信息可以在第三方的地图服务中显示位置。 |
16+
| 透传消息 | 透传消息可视为命令消息。通过发送这条命令给对方,通知对方要执行的操作,对方收到消息后系统可以自定义处理。<br/> - 透传消息不会在 UI 上展示。<br/> - 消息大小限制为 5 KB。<br> - 你可以使用透传消息更新头像和昵称以及进行状态同步等。<br/> 透传消息不会存入本地数据库。 |
17+
| 图片消息 | 图片消息是附件消息,需要先将图片上传至消息服务器。接收方收到图片时自动下载图片缩略图。<br/> 图片默认不能超过 10 MB,图片消息大小限制为 5 KB。 |
18+
| 语音消息 | 语音消息是附件消息,需要先将语音上传至消息服务器。接收方收到语音时自动下载语音。<br/> 音频文件默认不能超过 10 MB,音频消息大小限制为 5 KB。 |
19+
| 视频消息 | 视频消息是附件消息,需要先将视频上传至消息服务器。接收方收到视频时自动下载视频缩略图,点击下载视频消息。<br/> - 对于 Web 端,视频消息没有缩略图。<br/> - 视频文件默认不能超过 10 MB,视频消息大小限制为 5 KB。 |
20+
| 文件消息 | 文件消息是附件消息,需要先将文件上传至消息服务器。<br/> 附件大小不能超过 10 MB,文件消息大小限制为 5 KB。 |
21+
| 自定义消息 | 开发者自定义的消息类型。自定义消息支持设置类型名称,开发者可以添加多种自定义消息。<br/> - 自定义消息大小限制为 5 KB。<br/> - 自定义消息的使用场景:红包消息、模板消息等。 |
2222

2323
:::tip
24+
2425
1. 默认情况下,消息附件,例如图片、音频、视频和其他文件不能超过 10 MB,可存储 7 天。若要提升其中一个上限,请联系商务。
2526
2. 当基础的消息类型不满足需求时,可以使用消息自定义扩展增强基础消息类型,典型的用例是发送引用较早文本或图像消息的消息。使用扩展后,消息大小不能超过原类型消息的大小。
27+
2628
:::
2729

2830
## 聊天室消息能力
@@ -43,11 +45,11 @@
4345

4446
## 聊天室消息发送控制
4547

46-
| 聊天室消息发送控制 | 描述 |
48+
| 聊天室消息发送控制 | 描述 |
4749
| :--------- | :----- |
4850
| 消息发送优先级 | 你可以设置聊天室的消息优先级:高、普通和低三种级别。在聊天室内消息并发量较大或消息发送频率过高的情况下,服务器首先丢弃低优先级消息,优先送达高优先级的消息。 |
4951
| 消息优先发送(聊天室白名单)| 聊天室白名单中的成员在聊天室中发送的消息为高优先级,会优先送达,但不保证必达。当负载较高时,服务器会优先丢弃低优先级的消息。即便如此若负载仍很高,服务器也会丢弃高优先级消息。 |
50-
| 禁止发送消息 | - **黑名单**:成员加入黑名单后,会被移出聊天室,无法再收发消息。<br/> - **禁言**:成员被加入禁言列表后,将无法在聊天室内发送消息,即使其被加入白名单也不能发消息,但可以正常接收消息。**全员禁言**开启后,除了在白名单中的成员,其他成员不能发消息。<br/> - **全局禁言 (RESTful API)**:用户被全局禁言后,无法发送单聊消息、或在无法在所有群组或聊天室中发送消息。聊天室白名单中的成员被全局禁言后,仍无法在所有单聊、群组或聊天室中发消息。|
52+
| 禁止发送消息 | - **黑名单**:成员加入黑名单后,会被移出聊天室,无法再收发消息。<br/> - **禁言**:成员被加入禁言列表后,将无法在聊天室内发送消息,即使其被加入白名单也不能发消息,但可以正常接收消息。**全员禁言** 开启后,除了在白名单中的成员,其他成员不能发消息。<br/> - **全局禁言 (RESTful API)**:用户被全局禁言后,无法发送单聊消息、或在无法在所有群组或聊天室中发送消息。聊天室白名单中的成员被全局禁言后,仍无法在所有单聊、群组或聊天室中发消息。|
5153
|对消息放行或拦截|- **发送前回调**:环信 IM 服务器会在发送消息之前,向你的应用服务器发送请求,你可以根据业务需求配置规则决定下发或拦截消息。<br/> - **内容审核**:基于内容审核结果对消息进行处理,包括拦截、替换敏感信息和放行消息。该服务只对文本、图片、音频和视频消息有效。 |
5254

5355
## 聊天室消息频率控制
@@ -56,7 +58,7 @@
5658

5759
对于单个 app,发送聊天室消息 RESTful API 存在以下限制(你可以联系环信商务上调限制):
5860

59-
<table>
61+
<table>
6062
<tbody>
6163
<tr>
6264
<td width="110">
@@ -80,7 +82,7 @@
8082
<p>每秒限调 100 次。</p>
8183
</td>
8284
<td>
83-
<p>第 101 次调用时会报 429 错误 &ldquo;This request has reached api limit&rdquo;。</p>
85+
<p>第 101 次调用时会报 429 错误This request has reached api limit。</p>
8486
</td>
8587
<td rowspan="2">
8688
<p>两个限制均<strong>可调</strong>。若上调其中一个,另一个自动等比例提升。</p>
@@ -92,10 +94,10 @@
9294
<p>100 条/秒</p>
9395
</td>
9496
<td>
95-
<p>每秒限发100 条消息。</p>
97+
<p>每秒限发 100 条消息。</p>
9698
</td>
9799
<td>
98-
<p>例如,你每次向 10 个聊天室发送消息,即发送了 10 条消息,你每秒最多可调用 10 次该接口。第 11 次调用时,则报 403 错误,即 " message send reach limit"。</p>
100+
<p>例如,你每次向 10 个聊天室发送消息,即发送了 10 条消息,你每秒最多可调用 10 次该接口。第 11 次调用时,则报 403 错误,即 "message send reach limit"。</p>
99101
</td>
100102
</tr>
101103
<tr>
@@ -121,7 +123,7 @@
121123

122124
## 消息格式
123125

124-
关于各类型消息格式以及离线推送的消息扩展字段,详见[消息格式文档](product_message_format.html)
126+
关于各类型消息格式以及离线推送的消息扩展字段,详见 [消息格式文档](product_message_format.html)
125127

126128

127129

0 commit comments

Comments
 (0)