mirror of
https://github.com/whitechi73/OpenShamrock.git
synced 2024-08-14 05:12:17 +00:00
Compare commits
13 Commits
195feb01e4
...
docs
Author | SHA1 | Date | |
---|---|---|---|
208169c2a2 | |||
019d1c7977 | |||
af9f1d5aae | |||
cb9176cca0 | |||
6384694edd | |||
4a11f64cf5 | |||
6a3ce47d8c | |||
d07e8c6ee0 | |||
77a1bf17d4 | |||
1a63e8d94d | |||
0d08dfbac7 | |||
23dfb4d5d6 | |||
3810464dd3 |
@ -14,7 +14,8 @@ export default defineUserConfig({
|
|||||||
name: 'viewport',
|
name: 'viewport',
|
||||||
content: 'width=device-width,initial-scale=1,user-scalable=no'
|
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,
|
theme,
|
||||||
plugins: [
|
plugins: [
|
||||||
|
@ -24,9 +24,13 @@ icon: file
|
|||||||
| 字段 | 类型 | 说明 |
|
| 字段 | 类型 | 说明 |
|
||||||
| ------- | ------ | ------------ |
|
| ------- | ------ | ------------ |
|
||||||
| user_id | int64 | 目标 |
|
| user_id | int64 | 目标 |
|
||||||
| file | string | 本地文件路径 |
|
| file | string | `本地文件路径` 或 `文件base64` 或 `文件url` |
|
||||||
| name | string | 文件名称 |
|
| name | string | 文件名称 |
|
||||||
|
|
||||||
|
::: warning 注意
|
||||||
|
本地文件路径为绝对路径,文件base64为`base64://`开头,文件url则应该是正确的http请求地址。
|
||||||
|
:::
|
||||||
|
|
||||||
### 响应
|
### 响应
|
||||||
|
|
||||||
::: tabs
|
::: tabs
|
||||||
@ -77,8 +81,12 @@ icon: file
|
|||||||
| 字段 | 类型 | 说明 |
|
| 字段 | 类型 | 说明 |
|
||||||
| -------- | ------ | ------------ |
|
| -------- | ------ | ------------ |
|
||||||
| group_id | int64 | 群号 |
|
| group_id | int64 | 群号 |
|
||||||
| file | string | 本地文件路径 |
|
| file | string | `本地文件路径` 或 `文件base64` 或 `文件url` |
|
||||||
| name | string | 文件名称 |
|
| name | string | 文件名称 |
|
||||||
|
|
||||||
|
::: warning 注意
|
||||||
|
本地文件路径为绝对路径,文件base64为`base64://`开头,文件url则应该是正确的http请求地址。
|
||||||
|
:::
|
||||||
|
|
||||||
### 响应
|
### 响应
|
||||||
|
|
||||||
|
@ -99,6 +99,7 @@ icon: video-camera
|
|||||||
| ---- | ------ | -------- |
|
| ---- | ------ | -------- |
|
||||||
| file | string | 文件路径 |
|
| file | string | 文件路径 |
|
||||||
| url | string | 文件 URL |
|
| url | string | 文件 URL |
|
||||||
|
| md5 | string | 文件md5,get_file的时候用这个较稳定,然后你程序如果是反向ws,可以用这个作为record的等待ident |
|
||||||
|
|
||||||
## 检查是否可以发送语音 <Badge text="未实现" type="danger" />
|
## 检查是否可以发送语音 <Badge text="未实现" type="danger" />
|
||||||
|
|
||||||
@ -141,9 +142,31 @@ icon: video-camera
|
|||||||
| ------ | -------- | ------------------------------------------------------------------------------------------------- |
|
| ------ | -------- | ------------------------------------------------------------------------------------------------- |
|
||||||
| file | string | 转换后的语音文件路径, 如 `/home/somebody/cqhttp/data/record/0B38145AA44505000B38145AA4450500.mp3` |
|
| 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" />
|
## 获取视频 <Badge text="未实现" type="danger" />
|
||||||
|
|
||||||
|
@ -21,12 +21,16 @@ icon: feather-alt
|
|||||||
|
|
||||||
是否正常执行切换账号请求的响应。
|
是否正常执行切换账号请求的响应。
|
||||||
|
|
||||||
## 上传文件到缓存目录
|
## 上传文件到缓存目录 (HTTP)
|
||||||
|
|
||||||
### API 端点
|
### API 端点
|
||||||
|
|
||||||
`/upload_file`
|
`/upload_file`
|
||||||
|
|
||||||
|
::: warning 注意
|
||||||
|
该接口仅仅为HTTP POST提供,WebSocket请使用另外一个。
|
||||||
|
:::
|
||||||
|
|
||||||
### 参数
|
### 参数
|
||||||
|
|
||||||
以**file**格式上传文件,不要使用**binary**。
|
以**file**格式上传文件,不要使用**binary**。
|
||||||
@ -39,6 +43,33 @@ icon: feather-alt
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 上传文件到缓存目录 (WebSocket + HTTP)
|
||||||
|
|
||||||
|
### API 端点
|
||||||
|
|
||||||
|
`/upload_file_to_shamrock`
|
||||||
|
|
||||||
|
::: warning 注意
|
||||||
|
该接口仅仅为WebSocket提供。
|
||||||
|
:::
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 作用 |
|
||||||
|
|------|-------|-------|
|
||||||
|
| md5 | string | 文件`hex格式`的md5值,32长度的字符串,整个文件的`md5` |
|
||||||
|
| offset | uint64 | 文件分段上传偏移,默认值为0,从头上传 |
|
||||||
|
| chunk | string | 文件分段上传数据块(base64),无需开头`base64://` |
|
||||||
|
| file_size | uint64 | 总文件大小 |
|
||||||
|
|
||||||
|
### 响应数据
|
||||||
|
|
||||||
|
| 名称 | 类型 | 作用 |
|
||||||
|
|------|-------|-------|
|
||||||
|
| file_size | uint64 | 总文件大小 |
|
||||||
|
| finish | bool | 是否完成上传 |
|
||||||
|
| path | string | 该文件在安卓系统(shamrock环境)的路径 |
|
||||||
|
|
||||||
## 让Shamrock下载文件到缓存目录
|
## 让Shamrock下载文件到缓存目录
|
||||||
|
|
||||||
用法二选一:
|
用法二选一:
|
||||||
@ -61,6 +92,7 @@ url和base64至少一个不能为空
|
|||||||
| ---------- | ------------------- | ---- | -------------- | ------- |
|
| ---------- | ------------------- | ---- | -------------- | ------- |
|
||||||
| url | string | 否 | 下载地址 | |
|
| url | string | 否 | 下载地址 | |
|
||||||
| name | string | 否 | 文件名称 | 文件md5 |
|
| name | string | 否 | 文件名称 | 文件md5 |
|
||||||
|
| root | string | 否 | 保存文件的根目录,注意请确保QQ可以访问 | Shamrock缓存目录 |
|
||||||
| base64 | string | 否 | 文件base64内容 | |
|
| base64 | string | 否 | 文件base64内容 | |
|
||||||
| thread_cnt | int32 | 否 | 下载的线程数量 | |
|
| thread_cnt | int32 | 否 | 下载的线程数量 | |
|
||||||
| headers | `string` or `array` | 否 | 请求头 | |
|
| headers | `string` or `array` | 否 | 请求头 | |
|
||||||
|
@ -54,9 +54,9 @@ icon: users
|
|||||||
|
|
||||||
| 字段 | 类型 | 必须 | 说明 |
|
| 字段 | 类型 | 必须 | 说明 |
|
||||||
| ---- | ------ | ---- | ------ |
|
| ---- | ------ | ---- | ------ |
|
||||||
| time | int32 | 是 | 点赞次数 |
|
| times | int32 | 是 | 点赞次数 |
|
||||||
| user_id | int64 | 是 | 点赞的目标用户 |
|
| user_id | int64 | 是 | 点赞的目标用户 |
|
||||||
|
|
||||||
### 响应
|
### 响应
|
||||||
|
|
||||||
该接口将返回处理结果,其中 `data` 字段无数据。
|
该接口将返回处理结果,其中 `data` 字段无数据。
|
||||||
|
@ -63,10 +63,12 @@ icon: cog
|
|||||||
heartbeat_interval: 15000 // 设置为null则默认15000毫秒作为心跳间隔,0则为无心跳
|
heartbeat_interval: 15000 // 设置为null则默认15000毫秒作为心跳间隔,0则为无心跳
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
'allow-temp-session': false // 是否允许临时消息
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> 2024-3:allow-temp-session已经在后续版本中去除,未来需要在你自己的接收端对消息来源进行拦截或处理
|
||||||
|
|
||||||
|
|
||||||
| 参数名称 | 类型 | 作用 | 例子 |
|
| 参数名称 | 类型 | 作用 | 例子 |
|
||||||
| --------------- | -------- | -------------------------------------------------------------------------------- | ----------- |
|
| --------------- | -------- | -------------------------------------------------------------------------------- | ----------- |
|
||||||
| `default_token` | `string` | 默认 `token` ,**HTTP接口/主被动WS** 如果未单独定义 `token` ,则使用默认 `token` | `aaa123456` |
|
| `default_token` | `string` | 默认 `token` ,**HTTP接口/主被动WS** 如果未单独定义 `token` ,则使用默认 `token` | `aaa123456` |
|
||||||
|
@ -5,7 +5,7 @@ icon: question-circle
|
|||||||
|
|
||||||
### 支持的QQ版本
|
### 支持的QQ版本
|
||||||
|
|
||||||
- 版本 `8.9.68`,`8.9.70`,`8.9.73`,`8.9.75`,`8.9.78`,`8.9.80`,`8.9.81`,`8.9.83`
|
- 版本 `8.9.68`,`8.9.70`,`8.9.73`,`8.9.75`,`8.9.78`,`8.9.80`,`8.9.81`,`8.9.83`, `9.0.15`, `9.0.8`
|
||||||
- 理论上支持上述说明未提到的更高版本,如遇问题请提交 `issue`
|
- 理论上支持上述说明未提到的更高版本,如遇问题请提交 `issue`
|
||||||
|
|
||||||
### 反检测
|
### 反检测
|
||||||
|
@ -17,7 +17,7 @@ icon: layer-group
|
|||||||
|
|
||||||
| 字段 | 类型 | 收 | 发 | 必填 | 说明 |
|
| 字段 | 类型 | 收 | 发 | 必填 | 说明 |
|
||||||
| ---- | ----- | --- | --- | ---- | ------ |
|
| ---- | ----- | --- | --- | ---- | ------ |
|
||||||
| id | int64 | ✓ | ✓ | 是 | 消息ID |
|
| id | `int64` or `string` | ✓ | ✓ | 是 | 消息ID |
|
||||||
|
|
||||||
## XML 消息 <Badge text="未实现" type="danger" />
|
## XML 消息 <Badge text="未实现" type="danger" />
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user