mirror of
https://github.com/truewhile/MeBox.git
synced 2026-09-28 03:06:38 +08:00
truewhile
137 lines
4.6 KiB
Markdown
137 lines
4.6 KiB
Markdown
## 获取用户云下载任务列表
|
|
|
|
### 基本信息
|
|
|
|
| 属性 | 内容 |
|
|
|:-------------|:----------------------------------|
|
|
| 接口名称 | 获取用户云下载任务列表 |
|
|
| 接口版本 | v1.0 |
|
|
| 接口路径 | /get_task_list |
|
|
| 请求方法 | GET |
|
|
| 接口状态 | 生产环境 |
|
|
|
|
### 接口说明
|
|
|
|
分页获取当前授权用户的云下载任务列表。
|
|
|
|
### 接口地址
|
|
|
|
```
|
|
https://proapi.115.com/open/offline/get_task_list
|
|
```
|
|
|
|
### 请求方式
|
|
|
|
```
|
|
GET
|
|
```
|
|
|
|
### 认证方式
|
|
|
|
```
|
|
Authorization: Bearer access_token
|
|
```
|
|
|
|
### 请求参数
|
|
|
|
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
|
|:-------|:-----|:-----|:-------|:---------|:----------|
|
|
| page | int | 否 | 1 | 页码 | 1 |
|
|
|
|
### 请求示例
|
|
|
|
```shell
|
|
curl -G 'https://proapi.115.com/open/offline/get_task_list' \
|
|
-H 'Authorization: Bearer <access_token>' \
|
|
--data-urlencode 'page=1'
|
|
```
|
|
|
|
### 响应字段说明
|
|
|
|
| 字段 | 类型 | 描述 |
|
|
|:----------------------------|:---------|:--------------------------------------|
|
|
| state | boolean | 状态，true表示成功 |
|
|
| message | string | 返回信息 |
|
|
| code | int | 错误码 |
|
|
| data | object | 分页任务数据 |
|
|
| data.page | int | 当前页码 |
|
|
| data.page_count | int | 总页数 |
|
|
| data.count | int | 任务总数 |
|
|
| data.tasks | object[] | 云下载任务列表 |
|
|
| data.tasks[].info_hash | string | 任务SHA1 |
|
|
| data.tasks[].add_time | int | 任务添加时间戳 |
|
|
| data.tasks[].percentDone | int | 任务下载进度 |
|
|
| data.tasks[].size | int | 任务总大小，单位为字节 |
|
|
| data.tasks[].name | string | 任务名称 |
|
|
| data.tasks[].last_update | int | 任务最后更新时间戳 |
|
|
| data.tasks[].file_id | string | 任务源文件或文件夹ID |
|
|
| data.tasks[].delete_file_id | string | 删除任务并删除源文件时需传递的文件或文件夹ID |
|
|
| data.tasks[].status | int | 任务状态，见下方枚举表格 |
|
|
| data.tasks[].url | string | 链接任务URL |
|
|
| data.tasks[].wp_path_id | string | 任务源文件所在父文件夹ID |
|
|
| data.tasks[].def2 | int | 视频清晰度，见下方枚举表格 |
|
|
| data.tasks[].play_long | int | 视频时长 |
|
|
| data.tasks[].can_appeal | int | 是否可以申诉 |
|
|
|
|
#### 响应的 data.tasks[].status 字段枚举
|
|
|
|
| 值 | 说明 | 备注 |
|
|
|:---|:---------|:-----|
|
|
| -1 | 下载失败 | - |
|
|
| 0 | 分配中 | - |
|
|
| 1 | 下载中 | - |
|
|
| 2 | 下载成功 | - |
|
|
|
|
#### 响应的 data.tasks[].def2 字段枚举
|
|
|
|
| 值 | 说明 | 备注 |
|
|
|:----|:------|:-----|
|
|
| 1 | 标清 | - |
|
|
| 2 | 高清 | - |
|
|
| 3 | 超清 | - |
|
|
| 4 | 1080P | - |
|
|
| 5 | 4K | - |
|
|
| 100 | 原画 | - |
|
|
|
|
#### 响应的 code 字段(错误码)说明
|
|
|
|
| 错误码 | 说明 | 解决方案 |
|
|
|:-------|:---------|:---------------|
|
|
| 990002 | 参数错误 | 检查授权信息 |
|
|
|
|
### 响应示例
|
|
|
|
```json
|
|
{
|
|
"state": true,
|
|
"message": "",
|
|
"code": 0,
|
|
"data": {
|
|
"page": 1,
|
|
"page_count": 0,
|
|
"count": 0,
|
|
"tasks": []
|
|
}
|
|
}
|
|
```
|
|
|
|
### 业务规则
|
|
|
|
- 未传 `page` 或参数值为空时，默认查询第1页。
|
|
|
|
### 性能与安全说明
|
|
|
|
- 用户身份由 Bearer access_token 解析，请求参数不能指定115账号。
|
|
- 接口按应用、用户和接口维度执行频率限制。
|
|
- 任务列表按 `page` 分页，实际返回数量以响应为准。
|
|
|
|
### 注意事项
|
|
|
|
- 云下载任务状态和字段以响应中的 `data` 字段为准。
|
|
|
|
### 修改历史
|
|
|
|
| 修改时间 | 修改说明 |
|
|
|:-----------------------------|:-----|
|
|
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|