Merge pull request #491 from haoxiuwen/doc-v2

Modify Whether to Require Certain Parameters for REST APIs of Sending Attachment Messages
easemob · Nov 9, 2023 · 94d0efa · 94d0efa
2 parents 4a2d98e + d656eae
commit 94d0efa
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 12 deletions.
diff --git a/docs/document/server-side/message_chatroom.md b/docs/document/server-side/message_chatroom.md
@@ -202,7 +202,7 @@ POST https://{host}/{org_name}/{app_name}/messages/chatrooms
 | :--------- | :----- | :------- | :------- |
 | `filename` | String | 是       | 图片名称。          |
 | `secret`   | String | 否       | 图片的访问密钥，即成功上传图片后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取的 `share-secret`。如果图片文件上传时设置了文件访问限制（`restrict-access`），则该字段为必填。 |
-| `size`     | JSON   | 是       | 图片尺寸，单位为像素，包含以下字段：<br/> - `height`：图片高度；<br/> - `width`：图片宽度。   |
+| `size`     | JSON   | 否       | 图片尺寸，单位为像素，包含以下字段：<br/> - `height`：图片高度；<br/> - `width`：图片宽度。   |
 | `url`      | String | 是       | 图片 URL 地址：`https://{host}/{org_name}/{app_name}/chatfiles/{file_uuid}`。其中 `file_uuid` 为文件 ID，成功上传图片文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取。  |
 
 ### HTTP 响应
@@ -294,7 +294,7 @@ POST https://{host}/{org_name}/{app_name}/messages/chatrooms
 | :--------- | :----- | :------- | :---------- |
 | `filename` | String | 是       | 语音文件的名称。    |
 | `secret`   | String | 否       | 语音文件访问密钥，即成功上传语音文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取的 `share-secret`。 如果语音文件上传时设置了文件访问限制（`restrict-access`），则该字段为必填。 |
-| `Length`   | Int    | 是       | 语音时长，单位为秒。         |
+| `Length`   | Int    | 否      | 语音时长，单位为秒。         |
 | `url`      | String | 是       | 语音文件 URL 地址：`https://{host}/{org_name}/{app_name}/chatfiles/{file_uuid}`。`file_uuid` 为文件 ID，成功上传语音文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取。  |
 
 ### HTTP 响应
@@ -381,10 +381,11 @@ POST https://{host}/{org_name}/{app_name}/messages/chatrooms
 
 | 参数           | 类型   | 是否必需 | 描述    |
 | :------------- | :----- | :------- | :---------------- |
+| `filename` | String | 是 | 视频文件名称。|
 | `thumb`        | String | 否       | 视频缩略图 URL 地址：`https://{host}/{org_name}/{app_name}/chatfiles/{file_uuid}`。`file_uuid` 为视频缩略图唯一标识，成功上传缩略图文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取。 |
-| `length`       | Int    | 是       | 视频时长，单位为秒。  |
+| `length`       | Int    | 否       | 视频时长，单位为秒。  |
 | `secret`       | String | 否       | 视频文件访问密钥，即成功上传视频文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取的 `share-secret`。如果视频文件上传时设置了文件访问限制（`restrict-access`），则该字段为必填。        |
-| `file_length`  | Long   | 是       | 视频文件大小，单位为字节。  |
+| `file_length`  | Long   | 否       | 视频文件大小，单位为字节。  |
 | `thumb_secret` | String | 否       | 视频缩略图访问密钥，即成功上传视频文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取的 `share-secret`。如果缩略图文件上传时设置了文件访问限制（`restrict-access`），则该字段为必填。    |
 | `url`          | String | 是       | 视频文件 URL 地址：`https://{host}/{org_name}/{app_name}/chatfiles/{file_uuid}`。其中 `file_uuid` 为文件 ID，成功上传视频文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取。   |
 
@@ -417,6 +418,7 @@ curl -X POST -i 'https://XXXX/XXXX/XXXX/messages/chatrooms' \
   "to": ["185145305923585"],
   "type": "video",
   "body": {
+    "filename" : "test.avi"
     "thumb" : "https://XXXX/XXXX/XXXX/chatfiles/67279b20-7f69-11e4-8eee-21d3334b3a97",
     "length" : 0,"secret":"VfXXXXNb_",
     "file_length" : 58103,

diff --git a/docs/document/server-side/message_group.md b/docs/document/server-side/message_group.md
@@ -207,7 +207,7 @@ POST https://{host}/{org_name}/{app_name}/messages/chatgroups
 | :--------- | :----- | :------- | :------- |
 | `filename` | String | 是       | 图片名称。          |
 | `secret`   | String | 否       | 图片的访问密钥，即成功上传图片后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取的 `share-secret`。如果图片文件上传时设置了文件访问限制（`restrict-access`），则该字段为必填。 |
-| `size`     | JSON   | 是       | 图片尺寸，单位为像素，包含以下字段：<br/> - `height`：图片高度；<br/> - `width`：图片宽度。   |
+| `size`     | JSON   | 否      | 图片尺寸，单位为像素，包含以下字段：<br/> - `height`：图片高度；<br/> - `width`：图片宽度。   |
 | `url`      | String | 是       | 图片 URL 地址：`https://{host}/{org_name}/{app_name}/chatfiles/{file_uuid}`。其中 `file_uuid` 为文件 ID，成功上传图片文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取。  |
 
 ### HTTP 响应
@@ -299,7 +299,7 @@ POST https://{host}/{org_name}/{app_name}/messages/chatgroups
 | :--------- | :----- | :------- | :---------- |
 | `filename` | String | 是       | 语音文件的名称。    |
 | `secret`   | String | 否       | 语音文件访问密钥，即成功上传语音文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取的 `share-secret`。 如果语音文件上传时设置了文件访问限制（`restrict-access`），则该字段为必填。 |
-| `Length`   | Int    | 是       | 语音时长，单位为秒。         |
+| `Length`   | Int    | 否      | 语音时长，单位为秒。         |
 | `url`      | String | 是       | 语音文件 URL 地址：`https://{host}/{org_name}/{app_name}/chatfiles/{file_uuid}`。`file_uuid` 为文件 ID，成功上传语音文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取。  |
 
 ### HTTP 响应
@@ -385,10 +385,11 @@ POST https://{host}/{org_name}/{app_name}/messages/chatgroups
 
 | 参数           | 类型   | 是否必需 | 描述    |
 | :------------- | :----- | :------- | :---------------- |
+| `filename` | String | 是 | 视频文件名称。|
 | `thumb`        | String | 否       | 视频缩略图 URL 地址：`https://{host}/{org_name}/{app_name}/chatfiles/{file_uuid}`。`file_uuid` 为视频缩略图唯一标识，成功上传缩略图文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取。 |
-| `length`       | Int    | 是       | 视频时长，单位为秒。  |
+| `length`       | Int    | 否      | 视频时长，单位为秒。  |
 | `secret`       | String | 否       | 视频文件访问密钥，即成功上传视频文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取的 `share-secret`。如果视频文件上传时设置了文件访问限制（`restrict-access`），则该字段为必填。        |
-| `file_length`  | Long   | 是       | 视频文件大小，单位为字节。  |
+| `file_length`  | Long   | 否      | 视频文件大小，单位为字节。  |
 | `thumb_secret` | String | 否       | 视频缩略图访问密钥，即成功上传视频文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取的 `share-secret`。如果缩略图文件上传时设置了文件访问限制（`restrict-access`），则该字段为必填。    |
 | `url`          | String | 是       | 视频文件 URL 地址：`https://{host}/{org_name}/{app_name}/chatfiles/{file_uuid}`。其中 `file_uuid` 为文件 ID，成功上传视频文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取。   |
 
@@ -422,6 +423,7 @@ curl -X POST -i 'https://XXXX/XXXX/XXXX/messages/chatgroups' \
     "to": ["184524748161025"],
     "type": "video",
     "body": {
+        "filename" : "test.avi"
         "thumb" : "https://XXXX/XXXX/XXXX/chatfiles/67279b20-7f69-11e4-8eee-21d3334b3a97",
         "length" : 0,
         "secret":"VfXXXXNb_",

diff --git a/docs/document/server-side/message_single.md b/docs/document/server-side/message_single.md
@@ -243,7 +243,7 @@ POST https://{host}/{org_name}/{app_name}/messages/users
 | :--------- | :----- | :------- | :------- |
 | `filename` | String | 是       | 图片名称。          |
 | `secret`   | String | 否       | 图片的访问密钥，即成功上传图片后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取的 `share-secret`。如果图片文件上传时设置了文件访问限制（`restrict-access`），则该字段为必填。 |
-| `size`     | JSON   | 是       | 图片尺寸，单位为像素，包含以下字段：<br/> - `height`：图片高度；<br/> - `width`：图片宽度。   |
+| `size`     | JSON   | 否       | 图片尺寸，单位为像素，包含以下字段：<br/> - `height`：图片高度；<br/> - `width`：图片宽度。   |
 | `url`      | String | 是       | 图片 URL 地址：`https://{host}/{org_name}/{app_name}/chatfiles/{file_uuid}`。其中 `file_uuid` 为文件 ID，成功上传图片文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取。  |
 
 ### HTTP 响应
@@ -335,7 +335,7 @@ POST https://{host}/{org_name}/{app_name}/messages/users
 | :--------- | :----- | :------- | :---------- |
 | `filename` | String | 是       | 语音文件的名称。    |
 | `secret`   | String | 否       | 语音文件访问密钥，即成功上传语音文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取的 `share-secret`。 如果语音文件上传时设置了文件访问限制（`restrict-access`），则该字段为必填。 |
-| `Length`   | Int    | 是       | 语音时长，单位为秒。         |
+| `Length`   | Int    | 否       | 语音时长，单位为秒。         |
 | `url`      | String | 是       | 语音文件 URL 地址：`https://{host}/{org_name}/{app_name}/chatfiles/{file_uuid}`。`file_uuid` 为文件 ID，成功上传语音文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取。  |
 
 ### HTTP 响应
@@ -422,10 +422,11 @@ POST https://{host}/{org_name}/{app_name}/messages/users
 
 | 参数           | 类型   | 是否必需 | 描述    |
 | :------------- | :----- | :------- | :---------------- |
+| `filename` | String | 是       | 文件名称。   |
 | `thumb`        | String | 否       | 视频缩略图 URL 地址：`https://{host}/{org_name}/{app_name}/chatfiles/{file_uuid}`。`file_uuid` 为视频缩略图唯一标识，成功上传缩略图文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取。 |
-| `length`       | Int    | 是       | 视频时长，单位为秒。  |
+| `length`       | Int    | 否       | 视频时长，单位为秒。  |
 | `secret`       | String | 否       | 视频文件访问密钥，即成功上传视频文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取的 `share-secret`。如果视频文件上传时设置了文件访问限制（`restrict-access`），则该字段为必填。        |
-| `file_length`  | Long   | 是       | 视频文件大小，单位为字节。  |
+| `file_length`  | Long   | 否      | 视频文件大小，单位为字节。  |
 | `thumb_secret` | String | 否       | 视频缩略图访问密钥，即成功上传视频文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取的 `share-secret`。如果缩略图文件上传时设置了文件访问限制（`restrict-access`），则该字段为必填。    |
 | `url`          | String | 是       | 视频文件 URL 地址：`https://{host}/{org_name}/{app_name}/chatfiles/{file_uuid}`。其中 `file_uuid` 为文件 ID，成功上传视频文件后，从 [文件上传](message_download.html#上传文件) 的响应 body 中获取。   |
 
@@ -459,6 +460,7 @@ curl -X POST -i 'https://XXXX/XXXX/XXXX/messages/users' \
   "to": ["user2"],
   "type": "video",
   "body": {
+    "filename" : "test.avi"
     "thumb" : "https://XXXX/XXXX/XXXX/chatfiles/67279b20-7f69-11e4-8eee-21d3334b3a97",
     "length" : 0,
     "secret":"VfXXXXNb_",