shkong/OpenShamrock
1
0
Fork 0
mirror of https://github.com/whitechi73/OpenShamrock.git synced 2024-08-14 13:12:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

修正接口文件相关说明，修改支持的QQ版本说明

Browse Source
This commit is contained in:
owo233 2023-11-12 06:53:56 +08:00
parent cbb8f194a8
commit 8df6e20768
No known key found for this signature in database
GPG Key ID: 5D538586B03AFDAB
2 changed files with 92 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
docs/api/file.md
View File

@ -9,54 +9,60 @@ icon: file
## 上传私聊文件
该接口用于上传群文件。
该接口用于上传私聊文件。
终结点: `/upload_private_file`
::: warning 注意
只能上传本地文件, 需要上传 `http` 文件的话请先下载至本地
:::
### API 端点
`/upload_private_file`
### 参数
| 字段 | 类型 | 说明 |
| -------- | ------ | ------------ |
|---------|--------|--------|
| user_id | int64 | 目标 |
| file | string | 本地文件路径 |
| name | string | 储存名称 |
| name | string | 文件名称 |
## 上传群文件
该接口用于上传群文件。
终结点: `/upload_group_file`
::: warning 注意
只能上传本地文件, 需要上传 `http` 文件的话请先下载至本地
:::
### API 端点
`/upload_group_file`
### 参数
| 字段 | 类型 | 说明 |
| -------- | ------ | ------------ |
|----------|--------|--------|
| group_id | int64 | 群号 |
| file | string | 本地文件路径 |
| name | string | 储存名称 |
| name | string | 文件名称 |
::: warning 注意
参数 `folder`在Shamrock不受支持。
:::
### 参数
| 字段 | 类型 | 说明 |
| -------- | ------ | ------------ |
| group_id | int64 | 群号 |
| file | string | 本地文件路径 |
| name | string | 储存名称 |
## 删除群文件
该接口用于删除群文件。
终结点: `/delete_group_file`
### API 端点
`/delete_group_file`
### 参数
| 字段 | 类型 | 说明 |
| -------- | ------ | -------------------------------- |
|----------|--------|--------------------------|
| group_id | int64 | 群号 |
| file_id | string | 文件ID 参考 [File](#file) 对象 |
| busid | int32 | 文件类型 参考 [File](#file) 对象 |
@ -66,18 +72,21 @@ icon: file
:::
## 创建群文件文件夹
该接口用于创建群文件文件夹。
::: warning 注意
仅能在根目录创建文件夹
:::
终结点: `/create_group_file_folder`
### API 端点
`/create_group_file_folder`
### 响应
| 字段 | 类型 | 说明 |
| --------- | ------ | ---------- |
|--------|-------|--------|
| msg_id | int32 | 文件消息id |
::: tip 提示
@ -88,10 +97,12 @@ icon: file
该接口用于删除群文件文件夹。
终结点: `/delete_group_folder`
### API 端点
`/delete_group_folder`
| 字段 | 类型 | 说明 |
| --------- | ------ | ------------------------------------ |
|-----------|--------|-------------------------------|
| group_id | int64 | 群号 |
| folder_id | string | 文件夹ID 参考 [Folder](#folder) 对象 |
@ -103,18 +114,20 @@ icon: file
该接口用于获取群文件系统信息。
终结点: `/get_group_file_system_info`
### API 端点
`/get_group_file_system_info`
### 参数
| 字段 | 类型 | 说明 |
| -------- | ----- | ---- |
|----------|-------|----|
| group_id | int64 | 群号 |
### 响应
| 字段 | 类型 | 说明 |
| ----------- | ----- | ---------- |
|-------------|-------|-------|
| file_count | int32 | 文件总数 |
| limit_count | int32 | 文件上限 |
| used_space | int64 | 已使用空间 |
@ -131,20 +144,20 @@ icon: file
### 参数
| 字段 | 类型 | 说明 |
| -------- | ----- | ---- |
|----------|-------|----|
| group_id | int64 | 群号 |
### 响应
| 字段 | 类型 | 说明 |
| ------- | ----------------------- | ---------- |
|---------|-------------------------|-------|
| files | List<[File](#file)> | 文件列表 |
| folders | List<[Folder](#folder)> | 文件夹列表 |
#### File
| 字段 | 类型 | 说明 |
| -------------- | ------ | ----------------------- |
|----------------|--------|--------------|
| group_id | int32 | 群号 |
| file_id | string | 文件ID |
| file_name | string | 文件名 |
@ -160,7 +173,7 @@ icon: file
#### Folder
| 字段 | 类型 | 说明 |
| ---------------- | ------ | ---------- |
|------------------|--------|-------|
| group_id | int32 | 群号 |
| folder_id | string | 文件夹ID |
| folder_name | string | 文件名 |
@ -180,14 +193,14 @@ icon: file
### 参数
| 字段 | 类型 | 说明 |
| --------- | ------ | ------------------------------------ |
|-----------|--------|-------------------------------|
| group_id | int64 | 群号 |
| folder_id | string | 文件夹ID 参考 [Folder](#folder) 对象 |
### 响应
| 字段 | 类型 | 说明 |
| ------- | -------- | ---------- |
|---------|----------|-------|
| files | File[] | 文件列表 |
| folders | Folder[] | 文件夹列表 |
@ -202,7 +215,7 @@ icon: file
### 参数
| 字段 | 类型 | 说明 |
| -------- | ------ | -------------------------------- |
|----------|--------|--------------------------|
| group_id | int64 | 群号 |
| file_id | string | 文件ID 参考 [File](#file) 对象 |
| busid | int32 | 文件类型 参考 [File](#file) 对象 |
@ -210,25 +223,5 @@ icon: file
### 响应
| 字段 | 类型 | 说明 |
| ---- | ------ | ------------ |
|-----|--------|--------|
| url | string | 文件下载链接 |
## 上传私聊文件 <Badge text="未实现" type="danger" />
该接口用于上传私聊文件。
### API 端点
`/upload_private_file`
### 参数
| 字段 | 类型 | 说明 |
| ------- | ------ | ------------ |
| user_id | int64 | 对方 QQ 号 |
| file | string | 本地文件路径 |
| name | string | 文件名称 |
::: warning 注意
只能上传本地文件, 需要上传 `http` 文件的话请先下载至本地
:::

2
docs/guide/faq.md
View File

@ -6,7 +6,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`
- 未在上述说明中列出的版本可能存在兼容问题。
- 理论上支持上述说明未提到的更高版本，如遇问题请提交issue
### 反检测