From 605ae53ba86b08c5458c74ead7d01dcd8dbb0dd3 Mon Sep 17 00:00:00 2001 From: haoxiuwen Date: Mon, 9 Dec 2024 18:39:17 +0800 Subject: [PATCH] modify RESTful API --- docs/document/server-side/message_download.md | 6 +++--- docs/document/server-side/message_import.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/document/server-side/message_download.md b/docs/document/server-side/message_download.md index d2dbd83ed..912d7ed7e 100644 --- a/docs/document/server-side/message_download.md +++ b/docs/document/server-side/message_download.md @@ -196,9 +196,9 @@ GET https://{host}/{org_name}/{app_name}/chatfiles/{file_uuid} 以下载图片为例： ```bash -# 将 替换为你在服务端生成的 App Token +# 将 替换为你的用户 token 或在服务端生成的 App Token -curl -X GET -H 'Accept: application/octet-stream' -H 'Authorization: Bearer ' -H 'share-secret: f0Vr-uyyEeiHpHmsu53XXXXXXXXZYgyLkdfsZ4xo2Z0cSBnB' 'https://XXXX/XXXX/XXXX/chatfiles/7f456bf0-XXXX-XXXX-b630-777db304f26c'-o /Users/test/easemob/image/image.JPG +curl -X GET -H 'Accept: application/octet-stream' -H 'Authorization: Bearer ' -H 'share-secret: f0Vr-uyyEeiHpHmsu53XXXXXXXXZYgyLkdfsZ4xo2Z0cSBnB' 'https://XXXX/XXXX/XXXX/chatfiles/7f456bf0-XXXX-XXXX-b630-777db304f26c'-o /Users/test/easemob/image/image.JPG ``` :::notice @@ -248,7 +248,7 @@ GET https://{host}/{org_name}/{app_name}/chatfiles/{file_uuid} | :-------------- | :----- | :--------------------- | :------------------ | | `Accept` | String | 否 | 内容类型。请填 `application/octet-stream`，表示下载二进制数据流格式的文件。 | | `Authorization` | String | 否 | App 管理员的鉴权 token，格式为 `Bearer YourAppToken`，其中 `Bearer` 为固定字符，后面为英文空格和获取到的 app token。 | -| `thumbnail` | Bool | 否 | 是否下载缩略图：
  • `true`：是，下载缩略图。
  • `false`：否，下载原文件。
若该参数为空，下载原文件。 | +| `thumbnail` | Bool | 否 | 是否下载缩略图：
  • `true`：是，下载缩略图。
  • （默认）`false`：否，下载原文件。
若该参数为空，下载原文件。 | | `share-secret` | String | 否 | 缩略图访问密钥。若上传图片时限制了访问（`restrict-access` 设置为 `true`），下载缩略图时则需要该访问密钥。成功上传图片后，从 [文件上传](#上传文件) 的响应 body 中获取该密钥。 | ### HTTP 响应 diff --git a/docs/document/server-side/message_import.md b/docs/document/server-side/message_import.md index 292358129..2283e1ab1 100644 --- a/docs/document/server-side/message_import.md +++ b/docs/document/server-side/message_import.md @@ -202,7 +202,7 @@ POST https://{host}/{org_name}/{app_name}/messages/chatgroups/import | `type` | String | 是 | 消息类型：
- `txt`：文本消息；
- `img`：图片消息；
- `audio`：语音消息；
- `video`：视频消息；
- `file`：文件消息；
- `loc`：位置消息；
- `cmd`：透传消息；
- `custom`：自定义消息。 | | `body` | JSON | 是 | 消息内容。 | | `ext` | JSON | 否 | 消息支持扩展字段，可添加自定义信息。例如，请求中的 "key1": "value1"。 | -| `is_ack_read` | Bool | 否 | 是否设置会话已读。
- `true`：是；
- `false`：否。
调用该接口导入消息后会生成对应的会话，若该字段为 `true`，则会话为已读状态，为 `false` 表示会话为未读状态。 | +| `is_ack_read` | Bool | 否 | 是否设置消息是否已读。
- `true`：是；
- `false`：否。 | | `msg_timestamp` | Long | 否 | 要导入的消息的时间戳，单位为毫秒。若不传该参数，环信服务器会将导入的消息的时间戳设置为当前时间。 | | `need_download` | Bool | 否 | 是否需要下载附件并上传到服务器。
- `true`：是。这种情况下，需确保附件地址可直接访问，没有访问权限的限制。
- （默认）`false`：否。 |