Merge pull request #312 from tobycroft/patch-2

Update configuration.md

docs/.vuepress/config.ts

@@ -14,7 +14,8 @@ export default defineUserConfig({
         name: 'viewport',
         content: 'width=device-width,initial-scale=1,user-scalable=no'
       }
-    ]
+    ],
+    ['script', { async: true, src: 'https://umami.zhenxin.me/script.js', 'data-website-id': 'a3220f2d-2267-4b95-b4aa-a5964cda0a0d' }]
   ],
   theme,
   plugins: [

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" />
 

docs/api/shamrock.md

@@ -92,6 +92,7 @@ url和base64至少一个不能为空
 | ---------- | ------------------- | ---- | -------------- | ------- |
 | url        | string              | 否   | 下载地址       |         |
 | name       | string              | 否   | 文件名称       | 文件md5 |
+| root       | string              | 否   | 保存文件的根目录，注意请确保QQ可以访问       | Shamrock缓存目录 |
 | base64     | string              | 否   | 文件base64内容 |         |
 | thread_cnt | int32               | 否   | 下载的线程数量 |         |
 | headers    | `string` or `array` | 否   | 请求头         |         |

docs/api/user.md

@@ -54,9 +54,9 @@ icon: users
 
 | 字段 | 类型   | 必须 | 说明   |
 | ---- | ------ | ---- | ------ |
-| time | int32 | 是 | 点赞次数 |
+| times | int32 | 是 | 点赞次数 |
 | user_id | int64 | 是 | 点赞的目标用户 |
 
 ### 响应
 
-该接口将返回处理结果，其中 `data` 字段无数据。
+该接口将返回处理结果，其中 `data` 字段无数据。

docs/guide/configuration.md

@@ -63,10 +63,12 @@ icon: cog
       heartbeat_interval: 15000 // 设置为null则默认15000毫秒作为心跳间隔，0则为无心跳
     }
   ],
-  'allow-temp-session': false // 是否允许临时消息
 }
 ```
 
+> 2024-3：allow-temp-session已经在后续版本中去除，未来需要在你自己的接收端对消息来源进行拦截或处理
+
+
 | 参数名称        | 类型     | 作用                                                                             | 例子        |
 | --------------- | -------- | -------------------------------------------------------------------------------- | ----------- |
 | `default_token` | `string` | 默认 `token` ，**HTTP接口/主被动WS** 如果未单独定义 `token` ，则使用默认 `token` | `aaa123456` |