Merge pull request #1003 from haoxiuwen/doc-v2

Modify IM Doc
easemob · Oct 24, 2024 · 11531f9 · 11531f9
2 parents 6c36eb9 + 980ceb1
commit 11531f9
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 7 deletions.
diff --git a/docs/document/server-side/callback_configurations.md b/docs/document/server-side/callback_configurations.md
@@ -188,7 +188,7 @@ payload 示例：
 | 参数          | 类型 | 描述                                                         |
 | :------------ | :------- | :----------------------------------------------------------- |
 | `customEvent` | String   | 用户自定义的事件类型，必须是 string，值必须满足正则表达式。 [a-zA-Z0-9-_/.]{1,32}，最短 1 个字符 最长 32 个字符。 |
-| `customExts`/`v2:customExts`  | Array/Json     | 用户自定义的事件属性。该参数为可选，不需要可以不传。<br/> - `customExts` 为旧版参数，数组类型，最多可包含 16 个元素。<br/> - `v2:customExts` 为新版参数，Map<String,String> 类型，最多可以包含 16 个元素。推荐使用该新版参数。 |
+| `customExts`/`v2:customExts`  | Array/JSON     | 用户自定义的事件属性。该参数为可选，不需要可以不传。<br/> - `customExts` 为旧版参数，数组类型，最多可包含 16 个元素。<br/> - `v2:customExts` 为新版参数，Map<String,String> 类型，最多可以包含 16 个元素。推荐使用该新版参数。 |
 | `from`        | String   | 表示消息发送者;无此字段 Server 会默认设置为 “from”:“admin”，有 from 字段但值为空串 (“”) 时请求失败。 |
 | `ext`         | Json     | 扩展属性，支持 app 自定义内容。可以没有这个字段；但是如果有，值不能是 “ext:null” 这种形式，否则会发生错误。 |
 

diff --git a/docs/document/server-side/message_historical.md b/docs/document/server-side/message_historical.md
@@ -122,10 +122,12 @@ curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToke
 | `msg_id`    | String | 消息 ID。       |
 | `timestamp` | Long   | 消息发送完成的 UNIX 时间戳，单位为毫秒，UTC 时间。         |
 | `direction` | String | 消息方向，值为 `outgoing`，即当前用户发送的消息。 |
-| `from`      | String | 消息发送方的用户 ID。       |
-| `to`        | String | 消息接收方。<br/> - 单聊为接收方用户 ID；<br/> - 群聊为群组 ID；<br/> - 聊天室聊天为聊天室 ID。  |
+| `to` | String | 内部字段，开发者可忽略。 |
+| `from` | String | 内部字段，开发者可忽略。 |
 | `chat_type` | String | 会话类型：<br/> - `chat`: 单聊；<br/> - `groupchat`: 群聊；<br/> - `chatroom`: 聊天室。 |
 | `payload`   | JSON   | 消息的具体内容。例如，消息扩展信息等。   |
+| `payload.from`      | String | 消息发送方的用户 ID。       |
+| `payload.to`        | String | 消息接收方：<br/> - 单聊为接收方用户 ID；<br/> - 群聊为群组 ID；<br/> - 聊天室聊天为聊天室 ID。  |
 
 历史消息记录为 JSON 类型，示例如下：
 
@@ -146,8 +148,8 @@ curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToke
       "ext":
       {
         "key1": "value1",              ...        },
-        "from":"XXXX",
-        "to":"XXXX"
+      "from":"XXXX",
+      "to":"XXXX"
   }
 }
 ```
@@ -339,7 +341,7 @@ curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToke
 
 | 参数          | 类型   | 描述                                             |
 | :------------ | :----- | :----------------------------------------------- |
-| `customExts`  | JSON   | 自定义扩展属性。你可以自行设置扩展属性中的字段。 |
+| `customExts`/`v2:customExts`  | Array/JSON     | 用户自定义的事件属性。该参数为可选，不需要可以不传。<br/> - `customExts` 为旧版参数，数组类型，最多可包含 16 个元素。<br/> - `v2:customExts` 为新版参数，Map<String,String> 类型，最多可以包含 16 个元素。推荐使用该新版参数。 |
 | `customEvent` | String | 自定义事件类型。                                 |
 | `type`        | String | 消息类型。自定义消息为 `custom`。                |
 

diff --git a/docs/document/windows/message_send_receive.md b/docs/document/windows/message_send_receive.md
@@ -20,7 +20,7 @@
 
 ## 技术原理
 
-环信即时通讯 IM Unity SDK 通过 `IChatManager` 和 `Message` 类实现消息的发送和接收。
+环信即时通讯 IM SDK 通过 `IChatManager` 和 `Message` 类实现消息的发送和接收。
 
 其中，发送和接收消息的逻辑如下：