From c026569a35a1f22a8ac9df8db0ae2add5cca6354 Mon Sep 17 00:00:00 2001 From: haoxiuwen Date: Wed, 13 Nov 2024 16:13:39 +0800 Subject: [PATCH] Modify IM Docs --- docs/document/android/message_send_receive.md | 4 ++++ docs/document/applet/message_send_receive.md | 4 ++++ docs/document/flutter/message_send_receive.md | 6 +++++- docs/document/harmonyos/message_send_receive.md | 4 ++++ docs/document/ios/message_send_receive.md | 4 ++++ docs/document/react-native/message_send_receive.md | 4 ++++ docs/document/server-side/message_chatroom.md | 1 + docs/document/server-side/message_group.md | 1 + docs/document/server-side/message_single.md | 1 + docs/document/unity/message_send_receive.md | 4 ++++ docs/document/web/message_send_receive.md | 4 ++++ docs/document/windows/message_send_receive.md | 4 ++++ 12 files changed, 40 insertions(+), 1 deletion(-) diff --git a/docs/document/android/message_send_receive.md b/docs/document/android/message_send_receive.md index afce8f2e2..91baa67e1 100644 --- a/docs/document/android/message_send_receive.md +++ b/docs/document/android/message_send_receive.md @@ -664,3 +664,7 @@ EMClient.getInstance().chatManager().sendMessage(message); message.getStringAttribute("attribute1",null); message.getBooleanAttribute("attribute2", false) ``` + +## 注意事项 + +[内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 \ No newline at end of file diff --git a/docs/document/applet/message_send_receive.md b/docs/document/applet/message_send_receive.md index b1ee99bd2..b501365a4 100644 --- a/docs/document/applet/message_send_receive.md +++ b/docs/document/applet/message_send_receive.md @@ -825,3 +825,7 @@ function sendTextMessage() { }); } ``` + +## 注意事项 + +[内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 diff --git a/docs/document/flutter/message_send_receive.md b/docs/document/flutter/message_send_receive.md index e06e713cb..6f822abb7 100644 --- a/docs/document/flutter/message_send_receive.md +++ b/docs/document/flutter/message_send_receive.md @@ -652,4 +652,8 @@ try { msg.attributes = {'k': 'v'}; EMClient.getInstance.chatManager.sendMessage(msg); } on EMError catch (e) {} -``` \ No newline at end of file +``` + +## 注意事项 + +[内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 \ No newline at end of file diff --git a/docs/document/harmonyos/message_send_receive.md b/docs/document/harmonyos/message_send_receive.md index ac343e542..b296fa1cd 100644 --- a/docs/document/harmonyos/message_send_receive.md +++ b/docs/document/harmonyos/message_send_receive.md @@ -549,3 +549,7 @@ let exts = message.ext(); let attr1 = exts.get("attribute1") as string; let attr2 = exts.get("attribute2") as boolean; ``` + +## 注意事项 + +[内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 diff --git a/docs/document/ios/message_send_receive.md b/docs/document/ios/message_send_receive.md index e52bd5574..044dce7cd 100644 --- a/docs/document/ios/message_send_receive.md +++ b/docs/document/ios/message_send_receive.md @@ -589,3 +589,7 @@ message.chatType = EMChatTypeChat; NSString *value = [message.ext objectForKey:@"attribute"]; } } ``` + +## 注意事项 + +[内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 diff --git a/docs/document/react-native/message_send_receive.md b/docs/document/react-native/message_send_receive.md index fd5b079e2..fc7e281f4 100644 --- a/docs/document/react-native/message_send_receive.md +++ b/docs/document/react-native/message_send_receive.md @@ -535,3 +535,7 @@ msg.attributes = { }; EMClient.getInstance().chatManager().sendMessage(msg, callback).then().catch(); ``` + +## 注意事项 + +[内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 diff --git a/docs/document/server-side/message_chatroom.md b/docs/document/server-side/message_chatroom.md index c8584b566..dcf3cfe41 100644 --- a/docs/document/server-side/message_chatroom.md +++ b/docs/document/server-side/message_chatroom.md @@ -8,6 +8,7 @@ 1. 接口调用过程中，请求体和扩展字段的总长度不能超过 5 KB。 2. 聊天室中发消息时，不会同步给发送方。 3. 通过 RESTful 接口发送的消息默认不写入会话列表，若需要此类消息写入会话列表，需在[环信即时通讯控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)。 +4. [内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 ::: **发送频率**：对于单个 app，该 REST API 存在以下三个限制： diff --git a/docs/document/server-side/message_group.md b/docs/document/server-side/message_group.md index f1346c609..c075e910b 100644 --- a/docs/document/server-side/message_group.md +++ b/docs/document/server-side/message_group.md @@ -10,6 +10,7 @@ 1. 接口调用过程中，请求体和扩展字段的总长度不能超过 5 KB。 2. 群组中发送的消息均同步给发送方。 3. 通过 RESTful 接口发送的消息默认不写入会话列表，若需要此类消息写入会话列表，需在[环信即时通讯控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)。 +4. [内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 ::: **发送频率**：对于单个 app，该 REST API 存在以下三个限制： diff --git a/docs/document/server-side/message_single.md b/docs/document/server-side/message_single.md index 7ee173946..a660c3cf8 100644 --- a/docs/document/server-side/message_single.md +++ b/docs/document/server-side/message_single.md @@ -49,6 +49,7 @@ :::tip 1. 接口调用过程中，请求体和扩展字段的总长度不能超过 5 KB。 2. 通过 RESTful 接口发送的消息默认不写入会话列表，若需要此类消息写入会话列表，需在[环信即时通讯控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)。 +3. [内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 ::: **发送频率**：对于单个 app，该 REST API 存在以下三个限制： diff --git a/docs/document/unity/message_send_receive.md b/docs/document/unity/message_send_receive.md index f7e755eff..fa8726370 100644 --- a/docs/document/unity/message_send_receive.md +++ b/docs/document/unity/message_send_receive.md @@ -643,3 +643,7 @@ if (found) { } ``` +## 注意事项 + +[内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 + diff --git a/docs/document/web/message_send_receive.md b/docs/document/web/message_send_receive.md index 43d773436..1af1023a2 100644 --- a/docs/document/web/message_send_receive.md +++ b/docs/document/web/message_send_receive.md @@ -843,3 +843,7 @@ function sendTextMessage() { }); } ``` + +## 注意事项 + +[内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 diff --git a/docs/document/windows/message_send_receive.md b/docs/document/windows/message_send_receive.md index df97cc13d..1634e3df1 100644 --- a/docs/document/windows/message_send_receive.md +++ b/docs/document/windows/message_send_receive.md @@ -646,3 +646,7 @@ if (found) { } ``` +## 注意事项 + +[内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 +