mirror of
https://github.com/whitechi73/OpenShamrock.git
synced 2024-08-14 05:12:17 +00:00
Compare commits
17 Commits
c28b57ff98
...
docs
| Author | SHA1 | Date | |
|---|---|---|---|
| 208169c2a2 | |||
| 019d1c7977 | |||
| af9f1d5aae | |||
| cb9176cca0 | |||
| 6384694edd | |||
| 4a11f64cf5 | |||
| 6a3ce47d8c | |||
| d07e8c6ee0 | |||
| 77a1bf17d4 | |||
| 1a63e8d94d | |||
| 0d08dfbac7 | |||
| 23dfb4d5d6 | |||
| 3810464dd3 | |||
| 195feb01e4 | |||
| 34e14ef237 | |||
| fa7aa21362 | |||
| 51b7d381cb |
@ -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: [
|
||||
|
||||
@ -24,9 +24,13 @@ icon: file
|
||||
| 字段 | 类型 | 说明 |
|
||||
| ------- | ------ | ------------ |
|
||||
| user_id | int64 | 目标 |
|
||||
| file | string | 本地文件路径 |
|
||||
| file | string | `本地文件路径` 或 `文件base64` 或 `文件url` |
|
||||
| name | string | 文件名称 |
|
||||
|
||||
::: warning 注意
|
||||
本地文件路径为绝对路径，文件base64为`base64://`开头，文件url则应该是正确的http请求地址。
|
||||
:::
|
||||
|
||||
### 响应
|
||||
|
||||
::: tabs
|
||||
@ -77,9 +81,13 @@ icon: file
|
||||
| 字段 | 类型 | 说明 |
|
||||
| -------- | ------ | ------------ |
|
||||
| group_id | int64 | 群号 |
|
||||
| file | string | 本地文件路径 |
|
||||
| file | string | `本地文件路径` 或 `文件base64` 或 `文件url` |
|
||||
| name | string | 文件名称 |
|
||||
|
||||
::: warning 注意
|
||||
本地文件路径为绝对路径，文件base64为`base64://`开头，文件url则应该是正确的http请求地址。
|
||||
:::
|
||||
|
||||
### 响应
|
||||
|
||||
::: tabs
|
||||
|
||||
@ -337,7 +337,9 @@ data 的响应内容为 json 数组，每个元素内容如下：
|
||||
|
||||
### API 端点
|
||||
|
||||
`/group_touch`
|
||||
`/group_touch` - 用于HTTP
|
||||
|
||||
`/poke` - 用于主动WebSocket与被动WebSocket
|
||||
|
||||
### 参数
|
||||
|
||||
|
||||
@ -240,3 +240,153 @@ icon: feather-alt
|
||||
| pic | string | 是 | 图片base64 |
|
||||
| sender | int64 | 是 | QQ |
|
||||
| troop | int64 | 是 | 图片发送到的群聊 |
|
||||
|
||||
## 获取 Cookie
|
||||
|
||||
### API 端点
|
||||
|
||||
`get_cookies`
|
||||
|
||||
### 参数
|
||||
|
||||
| 字段 | 类型 | 必须 | 说明 |
|
||||
| ---- | ------ | ---- | ------ |
|
||||
| domain | string | 否 | 域名 |
|
||||
|
||||
### 响应
|
||||
|
||||
::: tabs
|
||||
|
||||
@tab 响应字段
|
||||
|
||||
| 字段 | 类型 | 说明 |
|
||||
| ------- | ----- | ------------ |
|
||||
| cookies | string | 指定域名下的 Cookie |
|
||||
|
||||
@tab 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"retcode": 0,
|
||||
"data": {
|
||||
"cookies": "uin=o1234567890; skey=***; p_uin=o1234567890; p_skey=; pt4_token="
|
||||
},
|
||||
"echo": ""
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
## 获取 CSRF 令牌
|
||||
|
||||
### API 端点
|
||||
|
||||
`get_csrf_token`
|
||||
|
||||
### 参数
|
||||
|
||||
| 字段 | 类型 | 必须 | 说明 |
|
||||
| ---- | ------ | ---- | ------ |
|
||||
| domain | string | 否 | 域名 |
|
||||
|
||||
### 响应
|
||||
|
||||
::: tabs
|
||||
|
||||
@tab 响应字段
|
||||
|
||||
| 字段 | 类型 | 说明 |
|
||||
| ------- | ----- | ------------ |
|
||||
| token | string | 指定域名下的 CSRF 令牌 |
|
||||
|
||||
@tab 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"retcode": 0,
|
||||
"data": {
|
||||
"token": "***"
|
||||
},
|
||||
"echo": ""
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
## 获取Cookie
|
||||
|
||||
### API 端点
|
||||
|
||||
`get_cookies`
|
||||
|
||||
### 参数
|
||||
|
||||
| 字段 | 类型 | 必须 | 说明 |
|
||||
| ---- | ------ | ---- | ------ |
|
||||
| domain | string | 否 | 域名 |
|
||||
|
||||
### 响应
|
||||
|
||||
::: tabs
|
||||
|
||||
@tab 响应字段
|
||||
|
||||
| 字段 | 类型 | 说明 |
|
||||
| ------- | ----- | ------------ |
|
||||
| cookies | string | 指定域名下的 Cookie |
|
||||
|
||||
@tab 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"retcode": 0,
|
||||
"data": {
|
||||
"cookies": "uin=o1234567890; skey=***; p_uin=o1234567890; p_skey=; pt4_token="
|
||||
},
|
||||
"echo": ""
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
## 获取 Cookie 与 CSRF 令牌
|
||||
|
||||
### API 端点
|
||||
|
||||
`get_credentials`
|
||||
|
||||
### 参数
|
||||
|
||||
| 字段 | 类型 | 必须 | 说明 |
|
||||
| ---- | ------ | ---- | ------ |
|
||||
| domain | string | 否 | 域名 |
|
||||
|
||||
### 响应
|
||||
|
||||
::: tabs
|
||||
|
||||
@tab 响应字段
|
||||
|
||||
| 字段 | 类型 | 说明 |
|
||||
| ------- | ----- | ------------ |
|
||||
| cookies | string | 指定域名下的 Cookie |
|
||||
| token | string | 指定域名下的 CSRF 令牌 |
|
||||
|
||||
@tab 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"retcode": 0,
|
||||
"data": {
|
||||
"token": "***",
|
||||
"cookies": "uin=o1234567890; skey=***; p_uin=o1234567890; p_skey=***; pt4_token=***"
|
||||
},
|
||||
"echo": ""
|
||||
}
|
||||
```
|
||||
|
||||
:::
|
||||
@ -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" />
|
||||
|
||||
|
||||
@ -21,12 +21,16 @@ icon: feather-alt
|
||||
|
||||
是否正常执行切换账号请求的响应。
|
||||
|
||||
## 上传文件到缓存目录
|
||||
## 上传文件到缓存目录 （HTTP）
|
||||
|
||||
### API 端点
|
||||
|
||||
`/upload_file`
|
||||
|
||||
::: warning 注意
|
||||
该接口仅仅为HTTP POST提供，WebSocket请使用另外一个。
|
||||
:::
|
||||
|
||||
### 参数
|
||||
|
||||
以**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下载文件到缓存目录
|
||||
|
||||
用法二选一：
|
||||
@ -61,6 +92,7 @@ url和base64至少一个不能为空
|
||||
| ---------- | ------------------- | ---- | -------------- | ------- |
|
||||
| url | string | 否 | 下载地址 | |
|
||||
| name | string | 否 | 文件名称 | 文件md5 |
|
||||
| root | string | 否 | 保存文件的根目录，注意请确保QQ可以访问 | Shamrock缓存目录 |
|
||||
| base64 | string | 否 | 文件base64内容 | |
|
||||
| thread_cnt | int32 | 否 | 下载的线程数量 | |
|
||||
| headers | `string` or `array` | 否 | 请求头 | |
|
||||
@ -94,6 +126,25 @@ url和base64至少一个不能为空
|
||||
>
|
||||
> 调用后会阻塞直到下载完成后才会返回数据，请注意下载大文件时的超时
|
||||
|
||||
## 清除缓存
|
||||
|
||||
### API 端点
|
||||
|
||||
`clean_cache`
|
||||
|
||||
### 参数
|
||||
|
||||
该接口没有参数
|
||||
|
||||
### 响应
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"retcode": 0
|
||||
}
|
||||
```
|
||||
|
||||
## 获取手机电池信息
|
||||
|
||||
### API 端点
|
||||
@ -175,3 +226,127 @@ url和base64至少一个不能为空
|
||||
### 响应
|
||||
|
||||
无响应
|
||||
|
||||
## 获取所有支持的动作
|
||||
|
||||
### API 端点
|
||||
|
||||
`/get_supported_actions`
|
||||
|
||||
### 响应
|
||||
|
||||
{
|
||||
"status": "ok",
|
||||
"retcode": 0,
|
||||
"data": [
|
||||
"set_group_ban",
|
||||
"clean_cache",
|
||||
"clear_msgs",
|
||||
"create_group_file_folder",
|
||||
"delete_essence_message",
|
||||
"delete_essence_msg",
|
||||
"delete_group_file",
|
||||
"delete_group_folder",
|
||||
"delete_msg",
|
||||
"delete_message",
|
||||
"download_file",
|
||||
"fav.add_image_msg",
|
||||
"fav.add_text_msg",
|
||||
"fav.get_item_content",
|
||||
"fav.get_item_list",
|
||||
"get_csrf_token",
|
||||
"get_cookie",
|
||||
"get_cookies",
|
||||
"get_credentials",
|
||||
"get_device_battery",
|
||||
"get_essence_message_list",
|
||||
"get_essence_msg_list",
|
||||
"get_forward_msg",
|
||||
"get_friend_list",
|
||||
"get_friend_system_msg",
|
||||
"get_group_file_system_info",
|
||||
"get_group_file_url",
|
||||
"get_group_msg_history",
|
||||
"get_group_notice",
|
||||
"_get_group_notice",
|
||||
"get_group_at_all_remain",
|
||||
"get_group_root_files",
|
||||
"get_group_files_by_folder",
|
||||
"get_group_system_msg",
|
||||
"get_guild_list",
|
||||
"get_guild_service_profile",
|
||||
"get_history_msg",
|
||||
"get_http_cookies",
|
||||
"get_image",
|
||||
"get_latest_events",
|
||||
"get_login_info",
|
||||
"get_model_show",
|
||||
"_get_model_show",
|
||||
"get_msg",
|
||||
"get_message",
|
||||
"get_not_joined_group_info",
|
||||
"_get_online_clients",
|
||||
"get_profile_card",
|
||||
"get_user_info",
|
||||
"get_prohibited_member_list",
|
||||
"get_record",
|
||||
"get_self_info",
|
||||
"status",
|
||||
"get_status",
|
||||
"_get_stranger_info",
|
||||
"get_stranger_info",
|
||||
"get_supported_actions",
|
||||
"get_troop_honor_info",
|
||||
"get_group_honor_info",
|
||||
"get_group_info",
|
||||
"get_group_list",
|
||||
"get_group_member_info",
|
||||
"get_group_member_list",
|
||||
"get_uid",
|
||||
"get_uin_by_uid",
|
||||
"get_version",
|
||||
"get_version_info",
|
||||
"get_weather",
|
||||
"get_weather_city_code",
|
||||
"poke",
|
||||
"is_blacklist_uin",
|
||||
"kick_group_member",
|
||||
"set_group_kick",
|
||||
"set_group_leave",
|
||||
"leave_group",
|
||||
"set_group_card",
|
||||
"set_group_name",
|
||||
".handle_quick_operation_async",
|
||||
"rename_group_folder",
|
||||
"restart_me",
|
||||
"sanc_qrcode",
|
||||
"send_forward_msg",
|
||||
"send_group_forward_msg",
|
||||
"send_group_msg",
|
||||
"send_group_message",
|
||||
"send_group_announcement",
|
||||
"send_group_notice",
|
||||
"send_group_sign",
|
||||
"send_like",
|
||||
"send_message",
|
||||
"send_msg",
|
||||
"send_private_forward_msg",
|
||||
"send_private_message",
|
||||
"send_private_msg",
|
||||
"set_essence_message",
|
||||
"set_essence_msg",
|
||||
"set_friend_add_request",
|
||||
"set_group_add_request",
|
||||
"set_group_admin",
|
||||
"set_group_comment_face",
|
||||
"set_group_special_title",
|
||||
"set_group_whole_ban",
|
||||
"_set_model_show",
|
||||
"set_qq_profile",
|
||||
"switch_account",
|
||||
"test",
|
||||
"upload_group_file",
|
||||
"upload_private_file"
|
||||
],
|
||||
"echo": ""
|
||||
}
|
||||
@ -42,3 +42,21 @@ icon: users
|
||||
### 响应
|
||||
|
||||
该接口将返回处理结果，其中 `data` 字段无数据。
|
||||
|
||||
|
||||
## 点赞资料卡
|
||||
|
||||
### API 端点
|
||||
|
||||
`send_like`
|
||||
|
||||
### 参数
|
||||
|
||||
| 字段 | 类型 | 必须 | 说明 |
|
||||
| ---- | ------ | ---- | ------ |
|
||||
| times | int32 | 是 | 点赞次数 |
|
||||
| user_id | int64 | 是 | 点赞的目标用户 |
|
||||
|
||||
### 响应
|
||||
|
||||
该接口将返回处理结果，其中 `data` 字段无数据。
|
||||
|
||||
@ -11,11 +11,12 @@ icon: comment
|
||||
## 消息事件
|
||||
|
||||
| 字段 | 类型 | 说明 |
|
||||
| ------------ | ------ | -------------------------------------- |
|
||||
| ------------ | ------ | ---------------------------------------- |
|
||||
| message_type | string | 消息类型 |
|
||||
| sub_type | string | 消息子类型 |
|
||||
| message_id | int64 | 消息 ID |
|
||||
| user_id | int64 | 发送者 QQ 号 |
|
||||
| user_id | int64 | 发送者 QQ 号（在频道中，则为发送者的Tiny ID）|
|
||||
| tiny_id | int64 | 发送者的Tiny ID（频道） |
|
||||
| message | object | 消息内容 |
|
||||
| raw_message | string | CQ 码格式消息 |
|
||||
| font | int32 | 字体 |
|
||||
|
||||
@ -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` |
|
||||
|
||||
@ -5,7 +5,7 @@ icon: question-circle
|
||||
|
||||
### 支持的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`
|
||||
|
||||
### 反检测
|
||||
|
||||
@ -17,7 +17,7 @@ icon: layer-group
|
||||
|
||||
| 字段 | 类型 | 收 | 发 | 必填 | 说明 |
|
||||
| ---- | ----- | --- | --- | ---- | ------ |
|
||||
| id | int64 | ✓ | ✓ | 是 | 消息ID |
|
||||
| id | `int64` or `string` | ✓ | ✓ | 是 | 消息ID |
|
||||
|
||||
## XML 消息 <Badge text="未实现" type="danger" />
|
||||
|
||||
|
||||
Reference in New Issue
Block a user