update APIdoc 【历史记录】

@@ -2,8 +2,8 @@

2 2

3 3 <img src="/imgs/history.png" width="25" height="20"/>

4 4

5 - [获取历史记录列表（视频、直播、专栏）](#获取历史记录列表视频、直播、专栏)

6 - [获取全部视频历史记录（旧）](#获取全部视频历史记录旧)

5 - [获取历史记录列表_web端](#获取历史记录列表_web端)

6 - [获取视频观看历史记录_web端旧版](#获取视频观看历史记录_旧版)

7 7 - [删除历史记录](#删除历史记录)

8 8 - [清空历史记录](#清空历史记录)

9 9 - [停用历史记录](#停用历史记录)

@@ -11,22 +11,24 @@

11 11

12 12 ---

13 13

14 ## 获取历史记录列表（视频、直播、专栏）

14 ## 获取历史记录列表_web端

15 15

16 16 >http://api.bilibili.com/x/web-interface/history/cursor

17 17

18 18 *请求方式：GET*

19 19

20 认证方式：Cookie（SESSDATA）

20 认证方式：Cookie (SESSDATA)

21

22

注：`max`、`business`、`view_at`参数用于历史记录列表的IFS (无限滚动)，其用法类似链表的next指针

21 23

22 24 **url参数：**

23 25

24

| 参数名   | 类型 | 内容                   | 必要性 | 备注                                                         |

25 | -------- | ---- | ---------------------- | ------ | ------------------------------------------------------------ |

26

| max      | num  | 历史记录截止目标id     | 非必要 | 默认为0<br />稿件：稿件avid<br />番剧（影视）：剧集ssid<br />直播：直播间id<br />文集：文集rlid<br />文章：文章cvid |

27

| business | num  | 历史记录截止目标id类型 | 非必要 | 默认为空<br />archive：稿件<br />pgc：番剧（影视）<br />live：直播<br />article-list：文集<br />article：文章 |

28

| view_at  | num  | 历史记录截止时间       | 非必要 | 时间戳<br />默认为0<br />0为当前时间                         |

29

| ps       | num  | 每页项数               | 非必要 | 默认为20，最大30                                                     |

26

| 参数名   | 类型 | 内容                     | 必要性 | 备注                                                         |

27 | -------- | ---- | ------------------------ | ------ | ------------------------------------------------------------ |

28

| max      | num  | 历史记录截止目标 id      | 非必要 | 默认为 0<br />稿件：稿件 avid<br />剧集 (番剧 / 影视)：剧集 ssid<br />直播：直播间 id<br />文集：文集 rlid<br />文章：文章 cvid |

29

| business | num  | 历史记录截止目标业务类型 | 非必要 | 默认为空<br />archive：稿件<br />pgc：剧集 (番剧 / 影视)<br />live：直播<br />article-list：文集<br />article：文章 |

30

| view_at  | num  | 历史记录截止时间         | 非必要 | 时间戳<br />默认为 0<br />0 为当前时间                       |

31

| ps       | num  | 每页项数                 | 非必要 | 默认为 20，最大 30                                           |

30 32

31 33 **json回复：**

32 34

@@ -35,7 +37,7 @@

35 37 | 字段 | 类型 | 内容 | 备注 |

36 38 | ------- | ----- | ------------ | ------------------------------------------------- |

37 39 | code | num | 返回值 | 0：成功<br />-101：账号未登录<br />-400：请求错误 |

38 | message | str | 错误信息 | 默认为0 |

40 | message | str | 错误信息 | 默认为 0 |

39 41 | ttl | num | 1 | |

41 43

@@ -49,20 +51,20 @@

49 51

50 52 `data`中的`cursor`对象：

51 53

52 | 字段 | 类型 | 内容 | 备注 |

53 | -------- | ---- | ------------------ | ------------------ |

54 | max | num | 最后一项目标id | **详细内容见参数** |

55 | view_at | num | 最后一项时间节点 | 时间戳 |

56 | business | str | 最后一项目标id类型 | **详细内容见参数** |

57 | ps | num | 每页项数 | |

54 | 字段 | 类型 | 内容 | 备注 |

55 | -------- | ---- | ---------------- | -------------- |

56 | max | num | 最后一项目标 id | **见请求参数** |

57 | view_at | num | 最后一项时间节点 | 时间戳 |

58 | business | str | 最后一项业务类型 | **见请求参数** |

59 | ps | num | 每页项数 | |

58 60

59 61 `data`中的`tab`数组：

60 62

61 | 项 | 类型 | 内容 | 备注 |

62 | ---- | ---- | ----------------- | ---- |

63 | 0 | obj | 历史记录筛选类型1 | |

64 | 1 | obj | 历史记录筛选类型2 | |

65 | 2 | obj | 历史记录筛选类型3 | |

63 | 项 | 类型 | 内容 | 备注 |

64 | ---- | ---- | ------------------ | ---- |

65 | 0 | obj | 历史记录筛选类型 1 | |

66 | 1 | obj | 历史记录筛选类型 2 | |

67 | 2 | obj | 历史记录筛选类型 3 | |

66 68

67 69 `tab`数组中的对象：

68 70

@@ -73,60 +75,60 @@

73 75

74 76 `data`中的`list`数组：

75 77

76 | 项 | 类型 | 内容 | 备注 |

77 | ---- | ---- | --------------- | ---------------- |

78 | 0 | obj | 历史记录1 | |

79 | n | obj | 历史记录（n+1） | 按照查看顺序排列 |

80 | …… | obj | | |

78 | 项 | 类型 | 内容 | 备注 |

79 | ---- | ---- | -------------- | ---------------- |

80 | 0 | obj | 历史记录 1 | |

81 | n | obj | 历史记录 (n+1) | 按照查看顺序排列 |

82 | …… | obj | | |

81 83

82 84 `list`数组中的对象：

83 85

84

| 字段        | 类型                            | 内容                 | 备注                                     |

85 | ----------- | ------------------------------- | -------------------- | ---------------------------------------- |

86 | title | str | 条目标题 | |

87 | long_title | str | 条目副标题 | |

88

| cover       | str                             | 条目封面图url        | 用于专栏以外的条目                       |

89

| covers      | 有效时：array<br />无效时：null | 条目封面图组         | 仅用于专栏                               |

90

| uri         | str                             | 重定向url            | 仅用于剧集和直播                         |

91

| history     | obj                             | 条目详细信息         |                                          |

92

| videos      | num                             | 视频分P数目          | 仅用于稿件视频                           |

93 | author_name | str | UP主昵称 | |

94 | author_face | str | UP主头像url | |

95 | author_mid | num | UP主mid | |

96

| view_at     | num                             | 查看时间             | 时间戳                                   |

97

| progress    | num                             | 视频观看进度         | 单位为秒<br />用于稿件视频或剧集         |

98

| badge       | str                             | 条目备注标识         | 用于稿件视频或剧集                       |

99

| show_title  | str                             | 分P标题              | 用于稿件视频或剧集                       |

100

| duration    | num                             | 视频总时长           | 用于稿件视频或剧集                       |

101

| current     | str                             | 空                   | **作用尚不明确**                         |

102

| total       | num                             | 总计分集数           | 仅用于剧集                               |

103

| new_desc    | str                             | 最新一话/最新一P标识 | 用于稿件视频或剧集                       |

104

| is_finish   | num                             | 是否已完结           | 仅用于剧集<br />0：未完结<br />1：已完结 |

105

| is_fav      | num                             | 是否收藏             | 0：未收藏<br />1：已收藏                 |

106

| kid         | num                             | 条目目标id           | **详细内容见参数**                       |

107

| tag_name    | str                             | 子分区名             | 用于稿件视频和直播                       |

108

| live_status | num                             | 直播状态             | 仅用于直播<br />0：未开播<br />1：已开播 |

86

| 字段        | 类型                            | 内容                     | 备注                                     |

87 | ----------- | ------------------------------- | ------------------------ | ---------------------------------------- |

88

| title       | str                             | 条目标题                 |                                          |

89

| long_title  | str                             | 条目副标题               |                                          |

90

| cover       | str                             | 条目封面图 url           | 用于专栏以外的条目                       |

91

| covers      | 有效时：array<br />无效时：null | 条目封面图组             | 仅用于专栏                               |

92

| uri         | str                             | 重定向 url               | 仅用于剧集和直播                         |

93

| history     | obj                             | 条目详细信息             |                                          |

94

| videos      | num                             | 视频分 P 数目            | 仅用于稿件视频                           |

95

| author_name | str                             | UP 主昵称                |                                          |

96

| author_face | str                             | UP 主头像 url            |                                          |

97 | author_mid | num | UP 主 mid | |

98

| view_at     | num                             | 查看时间                 | 时间戳                                   |

99

| progress    | num                             | 视频观看进度             | 单位为秒<br />用于稿件视频或剧集         |

100

| badge       | str                             | 角标文案                 | 稿件视频 / 剧集 / 笔记                   |

101

| show_title  | str                             | 分 P 标题                | 用于稿件视频或剧集                       |

102

| duration    | num                             | 视频总时长               | 用于稿件视频或剧集                       |

103 | current | str | (?) | |

104

| total       | num                             | 总计分集数               | 仅用于剧集                               |

105

| new_desc    | str                             | 最新一话 / 最新一 P 标识 | 用于稿件视频或剧集                       |

106

| is_finish   | num                             | 是否已完结               | 仅用于剧集<br />0：未完结<br />1：已完结 |

107

| is_fav      | num                             | 是否收藏                 | 0：未收藏<br />1：已收藏                 |

108

| kid         | num                             | 条目目标 id              | **详细内容见参数**                       |

109

| tag_name    | str                             | 子分区名                 | 用于稿件视频和直播                       |

110

| live_status | num                             | 直播状态                 | 仅用于直播<br />0：未开播<br />1：已开播 |

109 111

110 112 `list`数组中的对象中的`covers`数组：

111 113

112 | 项 | 类型 | 内容 | 备注 |

113 | ---- | ---- | --------------- | ---- |

114 | 0 | str | 封面图片1 | |

115 | n | str | 封面图片（n+1） | |

116 | …… | str | …… | |

114 | 项 | 类型 | 内容 | 备注 |

115 | ---- | ---- | -------------- | ---- |

116 | 0 | str | 封面图片 1 | |

117 | n | str | 封面图片 (n+1) | |

118 | …… | str | …… | |

117 119

118 120 `list`数组中的对象中的`history`对象：

119 121

120 | 字段 | 类型 | 内容 | 备注 |

121 | -------- | ---- | ------------------- | ------------------------------------------------------------ |

122

| oid      | num  | 目标id              | 稿件视频&剧集（当`business=archive`或`business=pgc`时）：稿件avid<br />直播（当`business=live`时）：直播间id<br />文章（当`business=article`时）：文章cvid<br />文集（当`business=article-list`时）：文集rlid |

123 | epid | num | 剧集epid | 仅用于剧集 |

124 | bvid | str | 稿件bvid | 仅用于稿件视频 |

125 | page | num | 观看到的视频分P数 | 仅用于稿件视频 |

126

| cid      | num  | 观看到的对象id      | 稿件视频&剧集（当`business=archive`或`business=pgc`时）：视频cid<br />文集（当`business=article-list`时）：文章cvid |

127 | part | str | 观看到的视频分P标题 | 仅用于稿件视频 |

128 | business | str | 条目类型 | **详细内容见参数** |

129

| dt       | num  | 查看平台代码        | 1 3 5 7：手机端<br />2：web端<br />4 6：pad端<br />33：TV端<br />0：其他 |

122 | 字段 | 类型 | 内容 | 备注 |

123 | -------- | ---- | --------------------- | ------------------------------------------------------------ |

124

| oid      | num  | 目标id                | 稿件视频&剧集（当`business=archive`或`business=pgc`时）：稿件avid<br />直播（当`business=live`时）：直播间id<br />文章（当`business=article`时）：文章cvid<br />文集（当`business=article-list`时）：文集rlid |

125 | epid | num | 剧集epid | 仅用于剧集 |

126 | bvid | str | 稿件bvid | 仅用于稿件视频 |

127

| page     | num  | 观看到的视频分P数     | 仅用于稿件视频                                               |

128

| cid      | num  | 观看到的对象id        | 稿件视频&剧集（当`business=archive`或`business=pgc`时）：视频cid<br />文集（当`business=article-list`时）：文章cvid |

129

| part     | str  | 观看到的视频分 P 标题 | 仅用于稿件视频                                               |

130 | business | str | 业务类型 | **见请求参数** |

131

| dt       | num  | 记录查看的平台代码    | 1 3 5 7：手机端<br />2：web端<br />4 6：pad端<br />33：TV端<br />0：其他 |

130 132

131 133 **示例：**

132 134

@@ -349,13 +351,13 @@ curl -G 'http://api.bilibili.com/x/web-interface/history/cursor' \

349 351

350 352 </details>

351 353

352 ## 获取全部视频历史记录（旧）

354 ## 获取视频观看历史记录_web端旧版

353 355

354 356 > http://api.bilibili.com/x/v2/history

355 357

356 358 *请求方式：GET*

357 359

358 认证方式：Cookie（SESSDATA）

360 认证方式：Cookie (SESSDATA)

359 361

360 362 **url参数：**

361 363

@@ -665,14 +667,14 @@ curl -G 'http://api.bilibili.com/x/v2/history' \

665 667

666 668 *请求方式：POST*

667 669

668 认证方式：Cookie（SESSDATA）

670 认证方式：Cookie (SESSDATA)

669 671

670 672 **正文参数（ application/x-www-form-urlencoded ）：**

671 673

672

| 参数名 | 类型 | 内容                     | 必要性 | 备注                                                         |

673 | ------ | ---- | ------------------------ | ------ | ------------------------------------------------------------ |

674

| kid    | str  | 删除的目标记录           | 必要   | 视频：archive\_{稿件avid}<br />直播：live_{直播间id}<br />专栏：article\_{专栏cvid}<br />剧集：pgc\_{剧集ssid}<br />文集：article-list\_{文集rlid} |

675

| csrf   | str  | CSRF Token（位于cookie） | 必要   |                                                              |

674

| 参数名 | 类型 | 内容                                                | 必要性 | 备注                                                         |

675

| ------ | ---- | --------------------------------------------------- | ------ | ------------------------------------------------------------ |

676

| kid    | str  | 删除的目标记录，格式为`{业务类型}_{目标id}`详见备注 | 必要   | 视频：archive\_{稿件avid}<br />直播：live_{直播间id}<br />专栏：article\_{专栏cvid}<br />剧集：pgc\_{剧集ssid}<br />文集：article-list\_{文集rlid} |

677

| csrf   | str  | CSRF Token（位于cookie）                            | 必要   |                                                              |

676 678

677 679 **json回复：**

678 680

@@ -714,7 +716,7 @@ curl 'http://api.bilibili.com/x/v2/history/delete' \

714 716

715 717 *请求方式：POST*

716 718

717 认证方式：Cookie（SESSDATA）

719 认证方式：Cookie (SESSDATA)

718 720

719 721 **正文参数（ application/x-www-form-urlencoded ）：**

720 722

@@ -761,7 +763,7 @@ curl 'http://api.bilibili.com/x/v2/history/clear' \

761 763

762 764 *请求方式：POST*

763 765

764 认证方式：Cookie（SESSDATA）

766 认证方式：Cookie (SESSDATA)

765 767

766 768 该操作不会影响原有历史记录

767 769

@@ -812,7 +814,7 @@ curl 'http://api.bilibili.com/x/v2/history/shadow/set' \

812 814

813 815 *请求方式：GET*

814 816

815 认证方式：Cookie（SESSDATA）

817 认证方式：Cookie (SESSDATA)

816 818

817 819 **json回复：**

818 820

bilibili-API-collect

update APIdoc 【历史记录】

代码差异