diff --git a/docs/api/resources.md b/docs/api/resources.md index 84cf7e66..5c107b43 100644 --- a/docs/api/resources.md +++ b/docs/api/resources.md @@ -99,6 +99,7 @@ icon: video-camera | ---- | ------ | -------- | | file | string | 文件路径 | | url | string | 文件 URL | +| md5 | string | 文件md5,get_file的时候用这个较稳定,然后你程序如果是反向ws,可以用这个作为record的等待ident | ## 检查是否可以发送语音 <Badge text="未实现" type="danger" /> @@ -141,9 +142,31 @@ icon: video-camera | ------ | -------- | ------------------------------------------------------------------------------------------------- | | file | string | 转换后的语音文件路径, 如 `/home/somebody/cqhttp/data/record/0B38145AA44505000B38145AA4450500.mp3` | -## 获取文件 <Badge text="未实现" type="danger" /> +## 获取文件 -该接口用于获取文件。 +该接口用于获取语音,哦当然,这个接口目前使用的是base64返回,主要为了照顾使用反向websocket的用户,如果是正向用户或者getpost用户,直接用/res/去拿数据更方便 + +如果你选择压缩,目前文本压缩性能较好,如果是音频或者视频,压缩率只有95.7%左右,大概只能节省5%的带宽,是否使用压缩获取可以自行考虑 + + +### API 端点 + +`/get_file` + +### 参数 + +| 字段 | 类型 | 必须 | 说明 | +| ---------- | ------ | ---- | -------- | +| file | string | 是 | 文件 MD5 | +| file_type | string | 是 | 输出格式,支持base64|gzip,如果获取大文件,可以选择压缩 | + +### 响应 + +| 字段 | 类型 | 说明 | +| ---- | ------ | -------- | +| file | string | 文件路径,和get_record一样 | +| base64String | string | 文件 URL | +| md5 | string | 文件md5 | ## 获取视频 <Badge text="未实现" type="danger" />