mirror of
https://github.com/truewhile/MeBox.git
synced 2026-09-28 11:16:37 +08:00
优化，添加115接口文档
This commit is contained in:
truewhile
@@ -0,0 +1,88 @@
|
||||
## 提交视频转码
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:--------------------------------|
|
||||
| 接口名称 | 提交视频转码 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /video_push |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
按 VIP 等级或消耗枫币提交视频加速转码。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/video/video_push
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----------|:-------|:---|:----|:----------------------------------------|:-----------------|
|
||||
| pick_code | string | 是 | - | 视频文件提取码 | b53gu6z3hvqji8wrm |
|
||||
| op | string | 是 | - | 加速转码方式，`vip_push`：按 VIP 等级加速；`pay_push`：消耗枫币加速 | vip_push |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/video/video_push' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
-F 'pick_code=b53gu6z3hvqji8wrm' \
|
||||
-F 'op=vip_push'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:------|:---------|:----------------------|
|
||||
| state | boolean | 操作结果状态，true：成功；false：失败 |
|
||||
| message | string | 返回信息，成功时为空字符串 |
|
||||
| code | int | 错误码 |
|
||||
| data | object[] | 响应数据，成功时为空数组 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": []
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- 仅支持为当前授权用户所属的视频文件提交加速转码。
|
||||
- 已完成转码的视频无需重复提交。
|
||||
- 两种加速转码方式均要求当前用户具备 VIP 权益；`pay_push` 在枫币余额不足时提交失败。
|
||||
- 提交成功后，系统通知转码服务重新计算排队信息，并在 3 小时内记录已加速状态。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 通过 `Authorization` 请求头传递，请将请求示例中的占位符替换为实际访问令牌。
|
||||
- 请勿对同一视频重复提交加速转码。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -0,0 +1,125 @@
|
||||
## 获取视频在线播放地址
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:--------------------------------|
|
||||
| 接口名称 | 获取视频在线播放地址 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /play |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
获取指定视频的在线播放地址、清晰度、音轨及文件基础信息。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/video/play
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----------|:-------|:---|:----|:----------|:-----------------|
|
||||
| pick_code | string | 是 | - | 视频文件提取码 | b53gu6z3hvqji8wrm |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl -G 'https://proapi.115.com/open/video/play' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
--data-urlencode 'pick_code=b53gu6z3hvqji8wrm'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:---------------------------------|:---------|:----------------------------------------|
|
||||
| state | boolean | 操作结果状态，true：成功；false：失败 |
|
||||
| message | string | 返回信息，成功时为空字符串 |
|
||||
| code | int | 错误码 |
|
||||
| data | object | 视频播放及文件数据 |
|
||||
| data.file_id | string | 文件ID |
|
||||
| data.parent_id | string | 文件父目录ID |
|
||||
| data.file_name | string | 文件名称 |
|
||||
| data.file_size | string | 文件大小，单位为字节 |
|
||||
| data.file_sha1 | string | 文件哈希值 |
|
||||
| data.file_type | string | 文件类型 |
|
||||
| data.is_private | string | 文件是否加密隐藏，0：否；1：是 |
|
||||
| data.play_long | string | 视频时长 |
|
||||
| data.user_def | int | 记忆的清晰度，1：标清；2：高清；3：超清；4：1080P；5：4K；100：原画 |
|
||||
| data.user_rotate | int | 记忆的视频旋转角度，取值为 0、90、180、270 |
|
||||
| data.user_turn | int | 视频翻转方向，0：不翻转；1：水平翻转；2：垂直翻转 |
|
||||
| data.multitrack_list | object | 多音轨列表，键为音轨序号 |
|
||||
| data.multitrack_list.*.title | string | 音轨标题 |
|
||||
| data.multitrack_list.*.is_selected | string | 音轨是否为上次选中，1：是 |
|
||||
| data.multitrack_list.*.sync_time | string | 音轨同步时间 |
|
||||
| data.definition_list | object | 清晰度列表，键为清晰度值，值为清晰度名称 |
|
||||
| data.definition_list_new | object | 新版清晰度列表，键为清晰度值，值为清晰度名称 |
|
||||
| data.video_url | object[] | 各清晰度的播放地址信息 |
|
||||
| data.video_url[].url | string | 播放地址 |
|
||||
| data.video_url[].height | int | 视频高度 |
|
||||
| data.video_url[].width | int | 视频宽度 |
|
||||
| data.video_url[].definition | int | 视频清晰度 |
|
||||
| data.video_url[].title | string | 视频清晰度名称 |
|
||||
| data.video_url[].definition_n | int | 新版视频清晰度 |
|
||||
| data.video_push_state | boolean | 视频尚未完成转码时是否已提交加速转码，仅对应失败响应返回 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"file_id": "",
|
||||
"parent_id": "",
|
||||
"file_name": "",
|
||||
"file_size": "0",
|
||||
"file_sha1": "",
|
||||
"file_type": "",
|
||||
"is_private": "0",
|
||||
"play_long": "0",
|
||||
"user_def": 0,
|
||||
"user_rotate": 0,
|
||||
"user_turn": 0,
|
||||
"multitrack_list": {},
|
||||
"definition_list": {},
|
||||
"definition_list_new": {},
|
||||
"video_url": []
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- 切换音轨时，在返回的播放地址后增加整型参数 `audio_track`，参数值取 `multitrack_list` 对应的键；音轨下标从 `0` 开始。
|
||||
- 年费VIP以下用户不支持播放 4K 视频；选择 4K 清晰度时会返回引导升级的视频地址。
|
||||
- 接口不返回下载地址字段 `down_url`。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 通过 `Authorization` 请求头传递，请将请求示例中的占位符替换为实际访问令牌。
|
||||
- 播放地址具有时效性，请勿缓存或向无关方披露。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -0,0 +1,96 @@
|
||||
## 获取视频播放进度
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:--------------------------------|
|
||||
| 接口名称 | 获取视频播放进度 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /history |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
获取指定视频已记录的播放进度。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/video/history
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----------|:-------|:---|:----|:----------|:-----------------|
|
||||
| pick_code | string | 是 | - | 视频文件提取码 | b53gu6z3hvqji8wrm |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl -G 'https://proapi.115.com/open/video/history' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
--data-urlencode 'pick_code=b53gu6z3hvqji8wrm'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:-------------|:--------|:-----------------------------|
|
||||
| state | boolean | 操作结果状态，true：成功；false：失败 |
|
||||
| message | string | 返回信息，成功时为空字符串 |
|
||||
| code | int | 错误码 |
|
||||
| data | object | 播放进度数据；没有记录时为空数组 |
|
||||
| data.add_time | int | 记录添加时间，Unix 时间戳 |
|
||||
| data.file_id | string | 文件ID |
|
||||
| data.file_name | string | 文件名称 |
|
||||
| data.hash | string | 文件哈希值 |
|
||||
| data.pick_code | string | 文件提取码 |
|
||||
| data.time | int | 已播放时长，单位为秒 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"add_time": 0,
|
||||
"file_id": "",
|
||||
"file_name": "",
|
||||
"hash": "",
|
||||
"pick_code": "b53gu6z3hvqji8wrm",
|
||||
"time": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- 接口只返回当前 `pick_code` 对应的单条播放进度记录。
|
||||
- 视频是否播放完毕可通过文件列表中的 `played_end` 字段查看，`1` 表示已播放完毕。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 通过 `Authorization` 请求头传递，请将请求示例中的占位符替换为实际访问令牌。
|
||||
- `pick_code` 对应的文件不存在或不在有效文件区域时，接口返回失败。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -0,0 +1,119 @@
|
||||
## 视频字幕列表
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:--------------------------------|
|
||||
| 接口名称 | 视频字幕列表 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /subtitle |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
获取指定视频的自动载入字幕和可用字幕列表。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/video/subtitle
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----------|:-------|:---|:----|:----------|:-----------------|
|
||||
| pick_code | string | 是 | - | 视频文件提取码 | b53gu6z3hvqji8wrm |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl -G 'https://proapi.115.com/open/video/subtitle' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
--data-urlencode 'pick_code=b53gu6z3hvqji8wrm'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:----------------------------|:---------|:----------------------------|
|
||||
| state | boolean | 操作结果状态，true：成功；false：失败 |
|
||||
| message | string | 返回信息，成功时为空字符串 |
|
||||
| code | int | 错误码 |
|
||||
| data | object | 响应数据 |
|
||||
| data.autoload | object | 默认自动载入的字幕；无可用字幕时为空数组 |
|
||||
| data.autoload.sid | string | 字幕标识 |
|
||||
| data.autoload.language | string | 字幕语言 |
|
||||
| data.autoload.title | string | 字幕标题 |
|
||||
| data.autoload.url | string | 字幕文件地址 |
|
||||
| data.autoload.type | string | 字幕文件类型 |
|
||||
| data.autoload.key | string | 内置字幕键，仅内置字幕返回 |
|
||||
| data.autoload.sha1 | string | 字幕文件哈希值 |
|
||||
| data.autoload.file_id | string | 外挂或内嵌字幕文件ID |
|
||||
| data.autoload.file_name | string | 外挂或内嵌字幕文件名 |
|
||||
| data.autoload.pick_code | string | 外挂或内嵌字幕文件提取码 |
|
||||
| data.autoload.caption_map_id | string | 内嵌字幕映射ID |
|
||||
| data.autoload.is_caption_map | int | 是否为内嵌字幕，0：否；1：是 |
|
||||
| data.autoload.sync_time | float | 字幕同步时间 |
|
||||
| data.autoload.from | int | 记忆字幕来源标识 |
|
||||
| data.autoload.user_sub | int | 是否为用户记忆字幕，1：是 |
|
||||
| data.list | object[] | 字幕列表 |
|
||||
| data.list[].sid | string | 字幕标识 |
|
||||
| data.list[].language | string | 字幕语言 |
|
||||
| data.list[].title | string | 字幕标题 |
|
||||
| data.list[].url | string | 字幕文件地址 |
|
||||
| data.list[].type | string | 字幕文件类型 |
|
||||
| data.list[].key | string | 内置字幕键，仅内置字幕返回 |
|
||||
| data.list[].sha1 | string | 字幕文件哈希值 |
|
||||
| data.list[].file_id | string | 外挂或内嵌字幕文件ID |
|
||||
| data.list[].file_name | string | 外挂或内嵌字幕文件名 |
|
||||
| data.list[].pick_code | string | 外挂或内嵌字幕文件提取码 |
|
||||
| data.list[].caption_map_id | string | 内嵌字幕映射ID |
|
||||
| data.list[].is_caption_map | int | 是否为内嵌字幕，0：否；1：是 |
|
||||
| data.list[].sync_time | float | 字幕同步时间 |
|
||||
| data.list[].from | int | 记忆字幕来源标识 |
|
||||
| data.list[].user_sub | int | 是否为用户记忆字幕，1：是 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"autoload": [],
|
||||
"list": []
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- 用户记忆字幕不在列表中时会被前置；其余字幕按同目录同名外挂字幕、内嵌字幕、内置字幕、其他外挂字幕的顺序组合。
|
||||
- 存在用户记忆字幕时优先将其作为自动载入字幕；否则依次选择内嵌字幕、同名外挂字幕或内置字幕。
|
||||
- 字幕项来源不同，部分来源专属字段可能不返回。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 通过 `Authorization` 请求头传递，请将请求示例中的占位符替换为实际访问令牌。
|
||||
- 字幕文件地址具有时效性，请以本次接口返回值为准。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -0,0 +1,89 @@
|
||||
## 记忆视频播放进度
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:--------------------------------|
|
||||
| 接口名称 | 记忆视频播放进度 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /history |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
记录指定视频的播放进度及是否播放完毕。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/video/history
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----------|:-------|:---|:----|:-------------------|:-----------------|
|
||||
| pick_code | string | 是 | - | 视频文件提取码 | b53gu6z3hvqji8wrm |
|
||||
| time | int | 否 | 0 | 视频播放进度，单位为秒 | 10 |
|
||||
| watch_end | int | 否 | 0 | 是否播放完毕，0：否；1：是 | 0 |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/video/history' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
-F 'pick_code=b53gu6z3hvqji8wrm' \
|
||||
-F 'time=10' \
|
||||
-F 'watch_end=0'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:------|:---------|:----------------------|
|
||||
| state | boolean | 操作结果状态，true：成功；false：失败 |
|
||||
| message | string | 返回信息，成功时为空字符串 |
|
||||
| code | int | 错误码 |
|
||||
| data | object[] | 响应数据，成功时为空数组 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": []
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- `time` 和 `watch_end` 均不传时，两个参数均按 `0` 处理，即播放进度为 0 秒且未播放完毕。
|
||||
- 非本人文件不写入播放进度，但接口按操作成功返回。
|
||||
- 同一视频未播放完毕的进度在 5 秒内重复上报时不重复持久化；标记为播放完毕时会立即持久化。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 通过 `Authorization` 请求头传递，请将请求示例中的占位符替换为实际访问令牌。
|
||||
- `pick_code` 必须属于当前授权用户可记录播放进度的视频文件。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
Reference in New Issue
Block a user