mirror of
https://github.com/truewhile/MeBox.git
synced 2026-09-28 03:06:38 +08:00
truewhile
116 lines
3.9 KiB
Markdown
116 lines
3.9 KiB
Markdown
## 添加云下载链接任务
|
|
|
|
### 基本信息
|
|
|
|
| 属性 | 内容 |
|
|
|:-------------|:----------------------------------|
|
|
| 接口名称 | 添加云下载链接任务 |
|
|
| 接口版本 | v1.0 |
|
|
| 接口路径 | /add_task_urls |
|
|
| 请求方法 | POST |
|
|
| 接口状态 | 生产环境 |
|
|
|
|
### 接口说明
|
|
|
|
批量添加云下载链接任务。多个链接使用换行符分隔，支持HTTP(S)、FTP、磁力链和电驴链接。
|
|
|
|
### 接口地址
|
|
|
|
```
|
|
https://proapi.115.com/open/offline/add_task_urls
|
|
```
|
|
|
|
### 请求方式
|
|
|
|
```
|
|
POST
|
|
Content-Type: multipart/form-data
|
|
```
|
|
|
|
### 认证方式
|
|
|
|
```
|
|
Authorization: Bearer access_token
|
|
```
|
|
|
|
### 请求参数
|
|
|
|
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
|
|:-----------|:-------|:-----|:-------|:----------------------------------------|:----------------|
|
|
| urls | string | 是 | - | 云下载链接，多个链接使用换行符分隔 | `<download_url>` |
|
|
| wp_path_id | string | 否 | 0 | 保存目标文件夹ID；不传或传0时保存到根目录 | 0 |
|
|
|
|
### 请求示例
|
|
|
|
```shell
|
|
curl 'https://proapi.115.com/open/offline/add_task_urls' \
|
|
-H 'Authorization: Bearer <access_token>' \
|
|
--form-string 'urls=<download_url>' \
|
|
--form-string 'wp_path_id=0'
|
|
```
|
|
|
|
### 响应字段说明
|
|
|
|
| 字段 | 类型 | 描述 |
|
|
|:-----------------|:---------|:-------------------------------|
|
|
| state | boolean | 操作结果状态 |
|
|
| message | string | 返回信息 |
|
|
| code | int | 错误码 |
|
|
| data | object[] | 各链接任务的添加结果 |
|
|
| data[].state | boolean | 链接任务添加状态 |
|
|
| data[].code | int | 链接任务状态码 |
|
|
| data[].message | string | 链接任务状态描述 |
|
|
| data[].info_hash | string | 链接任务SHA1，仅任务成功时返回 |
|
|
| data[].url | string | 链接任务URL |
|
|
|
|
#### 响应的 code 字段(错误码)说明
|
|
|
|
| 错误码 | 说明 | 解决方案 |
|
|
|:--------|:---------------------------|:-----------------------------|
|
|
| 91006 | 存储空间不足 | 扩充存储空间后重试 |
|
|
| 980004 | 操作失败 | 稍后重试 |
|
|
| 990002 | 参数错误 | 检查必填参数 |
|
|
| 1000011 | 链接数量超过115个 | 将链接拆分为每批不超过115个 |
|
|
| 1000012 | 云下载配额已用完 | 购买配额或获得更多配额后重试 |
|
|
|
|
### 响应示例
|
|
|
|
```json
|
|
{
|
|
"state": true,
|
|
"message": "",
|
|
"code": 0,
|
|
"data": [
|
|
{
|
|
"state": true,
|
|
"code": 0,
|
|
"message": "",
|
|
"info_hash": "",
|
|
"url": ""
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### 业务规则
|
|
|
|
- 服务端按换行符拆分并清理链接，单次最多提交115个链接。
|
|
- 添加任务前会检查当前授权账号的剩余存储空间；空间不足时不扣减云下载配额。
|
|
- 云下载服务返回状态码 `10007` 或 `10010` 时，接口统一返回错误码 `1000012`。
|
|
|
|
### 性能与安全说明
|
|
|
|
- 用户身份由 Bearer access_token 解析，请求参数不能指定115账号。
|
|
- 接口按应用、用户和接口维度执行频率限制。
|
|
- 本接口限制单批链接数量，避免不受控的批量请求。
|
|
|
|
### 注意事项
|
|
|
|
- 任务处理结果以响应中的 `data` 字段为准。
|
|
|
|
### 修改历史
|
|
|
|
| 修改时间 | 修改说明 |
|
|
|:-----------------------------|:-----|
|
|
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|