Skip to content

Commit

Permalink
modify RESTful API
Browse files Browse the repository at this point in the history
  • Loading branch information
haoxiuwen committed Dec 9, 2024
1 parent 54cb92e commit 605ae53
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/document/server-side/message_download.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,9 +196,9 @@ GET https://{host}/{org_name}/{app_name}/chatfiles/{file_uuid}
以下载图片为例:

```bash
# 将 <YourAppToken> 替换为你在服务端生成的 App Token
# 将 <YourToken> 替换为你的用户 token 或在服务端生成的 App Token

curl -X GET -H 'Accept: application/octet-stream' -H 'Authorization: Bearer <YourAppToken>' -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 <YourToken>' -H 'share-secret: f0Vr-uyyEeiHpHmsu53XXXXXXXXZYgyLkdfsZ4xo2Z0cSBnB' 'https://XXXX/XXXX/XXXX/chatfiles/7f456bf0-XXXX-XXXX-b630-777db304f26c'-o /Users/test/easemob/image/image.JPG
```

:::notice
Expand Down Expand Up @@ -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 || 是否下载缩略图:<ul><li> `true`:是,下载缩略图。</li><li>`false`:否,下载原文件。</li></ul> <Container type="notice" title="注意">若该参数为空,下载原文件。</Container> |
| `thumbnail` | Bool || 是否下载缩略图:<ul><li> `true`:是,下载缩略图。</li><li>(默认)`false`:否,下载原文件。</li></ul> <Container type="notice" title="注意">若该参数为空,下载原文件。</Container> |
| `share-secret` | String || 缩略图访问密钥。若上传图片时限制了访问(`restrict-access` 设置为 `true`),下载缩略图时则需要该访问密钥。成功上传图片后,从 [文件上传](#上传文件) 的响应 body 中获取该密钥。 |

### HTTP 响应
Expand Down
2 changes: 1 addition & 1 deletion docs/document/server-side/message_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ POST https://{host}/{org_name}/{app_name}/messages/chatgroups/import
| `type` | String || 消息类型:<br/> - `txt`:文本消息;<br/> - `img`:图片消息;<br/> - `audio`:语音消息;<br/> - `video`:视频消息;<br/> - `file`:文件消息;<br/> - `loc`:位置消息;<br/> - `cmd`:透传消息;<br/> - `custom`:自定义消息。 |
| `body` | JSON || 消息内容。 |
| `ext` | JSON || 消息支持扩展字段,可添加自定义信息。例如,请求中的 "key1": "value1"。 |
| `is_ack_read` | Bool || 是否设置会话已读。<br/> - `true`:是;<br/> - `false`:否。 <br/>调用该接口导入消息后会生成对应的会话,若该字段为 `true`,则会话为已读状态,为 `false` 表示会话为未读状态。 |
| `is_ack_read` | Bool || 是否设置消息是否已读。<br/> - `true`:是;<br/> - `false`:否。 |
| `msg_timestamp` | Long || 要导入的消息的时间戳,单位为毫秒。若不传该参数,环信服务器会将导入的消息的时间戳设置为当前时间。 |
| `need_download` | Bool || 是否需要下载附件并上传到服务器。<br/> - `true`:是。这种情况下,需确保附件地址可直接访问,没有访问权限的限制。<br/> - (默认)`false`:否。 |

Expand Down

0 comments on commit 605ae53

Please sign in to comment.