优化，添加115接口文档

2026-10-14 00:56:37 +08:00 · 2026-09-05 14:32:58 +08:00
parent d00b14df55
commit 0e9fb2c937
57 changed files with 5682 additions and 76 deletions
@@ -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 | 创建文档 |