From 8df6e20768f110085153df6ec0e615a9652a335c Mon Sep 17 00:00:00 2001 From: owo233 Date: Sun, 12 Nov 2023 06:53:56 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=AD=A3=E6=8E=A5=E5=8F=A3`=E6=96=87?= =?UTF-8?q?=E4=BB=B6=E7=9B=B8=E5=85=B3`=E8=AF=B4=E6=98=8E=EF=BC=8C?= =?UTF-8?q?=E4=BF=AE=E6=94=B9`=E6=94=AF=E6=8C=81=E7=9A=84QQ=E7=89=88?= =?UTF-8?q?=E6=9C=AC`=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/file.md | 189 ++++++++++++++++++++++------------------------ docs/guide/faq.md | 2 +- 2 files changed, 92 insertions(+), 99 deletions(-) diff --git a/docs/api/file.md b/docs/api/file.md index 68779c0..46012aa 100644 --- a/docs/api/file.md +++ b/docs/api/file.md @@ -9,56 +9,62 @@ icon: file ## 上传私聊文件 -该接口用于上传群文件。 +该接口用于上传私聊文件。 -终结点: `/upload_private_file` +::: warning 注意 +只能上传本地文件, 需要上传 `http` 文件的话请先下载至本地 +::: + +### API 端点 + +`/upload_private_file` ### 参数 -| 字段 | 类型 | 说明 | -| -------- | ------ | ------------ | -| user_id | int64 | 目标 | -| file | string | 本地文件路径 | -| name | string | 储存名称 | +| 字段 | 类型 | 说明 | +|---------|--------|--------| +| user_id | int64 | 目标 | +| file | string | 本地文件路径 | +| name | string | 文件名称 | ## 上传群文件 该接口用于上传群文件。 -终结点: `/upload_group_file` +::: warning 注意 +只能上传本地文件, 需要上传 `http` 文件的话请先下载至本地 +::: + +### API 端点 + +`/upload_group_file` ### 参数 -| 字段 | 类型 | 说明 | -| -------- | ------ | ------------ | -| group_id | int64 | 群号 | +| 字段 | 类型 | 说明 | +|----------|--------|--------| +| 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) 对象 | +| 字段 | 类型 | 说明 | +|----------|--------|--------------------------| +| group_id | int64 | 群号 | +| file_id | string | 文件ID 参考 [File](#file) 对象 | | busid | int32 | 文件类型 参考 [File](#file) 对象 | ::: tip 提示 @@ -66,19 +72,22 @@ icon: file ::: ## 创建群文件文件夹 + 该接口用于创建群文件文件夹。 ::: warning 注意 仅能在根目录创建文件夹 ::: -终结点: `/create_group_file_folder` +### API 端点 + +`/create_group_file_folder` ### 响应 -| 字段 | 类型 | 说明 | -| --------- | ------ | ---------- | -| msg_id | int32 | 文件消息id | +| 字段 | 类型 | 说明 | +|--------|-------|--------| +| msg_id | int32 | 文件消息id | ::: tip 提示 该 API 无响应数据 @@ -88,11 +97,13 @@ icon: file 该接口用于删除群文件文件夹。 -终结点: `/delete_group_folder` +### API 端点 -| 字段 | 类型 | 说明 | -| --------- | ------ | ------------------------------------ | -| group_id | int64 | 群号 | +`/delete_group_folder` + +| 字段 | 类型 | 说明 | +|-----------|--------|-------------------------------| +| group_id | int64 | 群号 | | folder_id | string | 文件夹ID 参考 [Folder](#folder) 对象 | ::: tip 提示 @@ -103,22 +114,24 @@ icon: file 该接口用于获取群文件系统信息。 -终结点: `/get_group_file_system_info` +### API 端点 + +`/get_group_file_system_info` ### 参数 -| 字段 | 类型 | 说明 | -| -------- | ----- | ---- | +| 字段 | 类型 | 说明 | +|----------|-------|----| | group_id | int64 | 群号 | ### 响应 -| 字段 | 类型 | 说明 | -| ----------- | ----- | ---------- | -| file_count | int32 | 文件总数 | -| limit_count | int32 | 文件上限 | +| 字段 | 类型 | 说明 | +|-------------|-------|-------| +| file_count | int32 | 文件总数 | +| limit_count | int32 | 文件上限 | | used_space | int64 | 已使用空间 | -| total_space | int64 | 空间上限 | +| total_space | int64 | 空间上限 | ## 获取群根目录文件列表 @@ -130,42 +143,42 @@ icon: file ### 参数 -| 字段 | 类型 | 说明 | -| -------- | ----- | ---- | +| 字段 | 类型 | 说明 | +|----------|-------|----| | group_id | int64 | 群号 | ### 响应 -| 字段 | 类型 | 说明 | -| ------- | ----------------------- | ---------- | -| files | List<[File](#file)> | 文件列表 | +| 字段 | 类型 | 说明 | +|---------|-------------------------|-------| +| files | List<[File](#file)> | 文件列表 | | folders | List<[Folder](#folder)> | 文件夹列表 | #### File -| 字段 | 类型 | 说明 | -| -------------- | ------ | ----------------------- | -| group_id | int32 | 群号 | -| file_id | string | 文件ID | -| file_name | string | 文件名 | -| busid | int32 | 文件类型 | -| file_size | int64 | 文件大小 | -| upload_time | int64 | 上传时间 | +| 字段 | 类型 | 说明 | +|----------------|--------|--------------| +| group_id | int32 | 群号 | +| file_id | string | 文件ID | +| file_name | string | 文件名 | +| busid | int32 | 文件类型 | +| file_size | int64 | 文件大小 | +| upload_time | int64 | 上传时间 | | dead_time | int64 | 过期时间，永久文件恒为0 | -| modify_time | int64 | 最后修改时间 | -| download_times | int32 | 下载次数 | -| uploader | int64 | 上传者ID | -| uploader_name | string | 上传者名字 | +| modify_time | int64 | 最后修改时间 | +| download_times | int32 | 下载次数 | +| uploader | int64 | 上传者ID | +| uploader_name | string | 上传者名字 | #### Folder -| 字段 | 类型 | 说明 | -| ---------------- | ------ | ---------- | -| group_id | int32 | 群号 | -| folder_id | string | 文件夹ID | -| folder_name | string | 文件名 | -| create_time | int64 | 创建时间 | -| creator | int64 | 创建者 | +| 字段 | 类型 | 说明 | +|------------------|--------|-------| +| group_id | int32 | 群号 | +| folder_id | string | 文件夹ID | +| folder_name | string | 文件名 | +| create_time | int64 | 创建时间 | +| creator | int64 | 创建者 | | creator_name | string | 创建者名字 | | total_file_count | int32 | 子文件数量 | @@ -179,16 +192,16 @@ icon: file ### 参数 -| 字段 | 类型 | 说明 | -| --------- | ------ | ------------------------------------ | -| group_id | int64 | 群号 | +| 字段 | 类型 | 说明 | +|-----------|--------|-------------------------------| +| group_id | int64 | 群号 | | folder_id | string | 文件夹ID 参考 [Folder](#folder) 对象 | ### 响应 -| 字段 | 类型 | 说明 | -| ------- | -------- | ---------- | -| files | File[] | 文件列表 | +| 字段 | 类型 | 说明 | +|---------|----------|-------| +| files | File[] | 文件列表 | | folders | Folder[] | 文件夹列表 | ## 获取群文件资源链接 @@ -201,34 +214,14 @@ icon: file ### 参数 -| 字段 | 类型 | 说明 | -| -------- | ------ | -------------------------------- | -| group_id | int64 | 群号 | -| file_id | string | 文件ID 参考 [File](#file) 对象 | +| 字段 | 类型 | 说明 | +|----------|--------|--------------------------| +| group_id | int64 | 群号 | +| file_id | string | 文件ID 参考 [File](#file) 对象 | | busid | int32 | 文件类型 参考 [File](#file) 对象 | ### 响应 -| 字段 | 类型 | 说明 | -| ---- | ------ | ------------ | -| url | string | 文件下载链接 | - -## 上传私聊文件 - -该接口用于上传私聊文件。 - -### API 端点 - -`/upload_private_file` - -### 参数 - -| 字段 | 类型 | 说明 | -| ------- | ------ | ------------ | -| user_id | int64 | 对方 QQ 号 | -| file | string | 本地文件路径 | -| name | string | 文件名称 | - -::: warning 注意 -只能上传本地文件, 需要上传 `http` 文件的话请先下载至本地 -::: +| 字段 | 类型 | 说明 | +|-----|--------|--------| +| url | string | 文件下载链接 | diff --git a/docs/guide/faq.md b/docs/guide/faq.md index 0d557c7..607393e 100644 --- a/docs/guide/faq.md +++ b/docs/guide/faq.md @@ -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 ### 反检测