返回提交历史
Modified
docs/user/relation.md
+82
-60
XFEstudio/bilibili-API-collect
feat(relation): add unread followers
Signed-off-by: 晨叶梦春 <65224318+wuziqian211@users.noreply.github.com>
5c44903
代码差异
1 个文件
+82
-60
@@ -24,8 +24,8 @@
24
24
| vip | obj | 会员信息 | |
25
25
| name_render | 有效时：obj<br />无效时：null | 昵称渲染信息 | |
26
26
| nft_icon | str | （？） | |
27
| rec_reason | str | 推荐该用户的原因 | 一般为空；如：`xxx关注了TA`、`xx粉丝 xx视频` |
28
| track_id | str | 内部记录id | 一般为空；如：`up_rec_0.router-main-2021485-5f84c987cf-dv8fg.1746380060327.607` |
27
| rec_reason | str | 推荐该用户的原因 | 大多数情况下为空；如：`xxx关注了TA`、`xx粉丝 xx视频` |
28
| track_id | str | 内部记录id | 大多数情况下为空；如：`up_rec_0.router-main-2021485-5f84c987cf-dv8fg.1746380060327.607` |
29
29
| follow_time | str | （？） | |
30
30
31
31
`list`中的对象中的`tag`数组：
@@ -89,13 +89,14 @@
89
89
90
90
**url参数：**
91
91
92
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
93
| ---------- | ---- | -------------- | ------------ | ------------------------------------------------------------------- |
94
| vmid | num | 目标用户 mid | 必要 | |
95
| ps | num | 每页项数 | 非必要 | 默认为 50 |
96
| pn | num | 页码 | 非必要 | 默认为 1 |
97
| offset | str | 偏移量 | 非必要 | 此项有效且不为 `rcmd` 时会从此偏移量开始返回粉丝列表，忽略参数 `pn` |
98
| from | str | 请求来源 | 非必要 | 当为 `main` 且目标用户为自己时，粉丝列表按照**智能推荐算法**排序，此时 `$.data.list[]` 中的 `rec_reason` 与 `track_id` 为非空 |
92
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
93
| -------------- | ---- | ---------------------- | ------------ | ------------------------------------------------------------------- |
94
| vmid | num | 目标用户 mid | 必要 | |
95
| ps | num | 每页项数 | 非必要 | 默认为 50 |
96
| pn | num | 页码 | 非必要 | 默认为 1 |
97
| offset | str | 偏移量 | 非必要 | 从上次请求的响应数据中的 `data.offset` 获取<br />此项有效且不为 `rcmd` 时会从此偏移量开始返回粉丝列表，忽略参数 `pn` |
98
| last_access_ts | num | 上次访问粉丝列表的时间 | 非必要 | 秒级时间戳，从[获取自己粉丝列表的未读状态](#获取自己粉丝列表的未读状态)接口获取<br />当按照**智能推荐算法**排序时，会优先展示此时间后关注的粉丝 |
99
| from | str | 请求来源 | 非必要 | 当为 `main` 且目标用户为自己时，粉丝列表按照**智能推荐算法**排序，此时响应数据中的 `data.list` 的成员中的 `rec_reason` 与 `track_id` 为非空 |
99
100
100
101
**json回复：**
101
102
@@ -153,9 +154,7 @@ curl -G 'https://api.bilibili.com/x/relation/fans' \
153
154
"mtime": 1746199088,
154
155
"tag": null,
155
156
"special": 0,
156
"contract_info": {
157
158
},
157
"contract_info": {},
159
158
"uname": "Astlinga_星灵",
160
159
"face": "https://i1.hdslb.com/bfs/face/005264524d05c0b8c132acc3ee88bb839351025b.jpg",
161
160
"sign": "",
@@ -185,9 +184,7 @@ curl -G 'https://api.bilibili.com/x/relation/fans' \
185
184
"nickname_color": "",
186
185
"avatar_subscript_url": ""
187
186
},
188
"name_render": {
189
190
},
187
"name_render": {},
191
188
"nft_icon": "",
192
189
"rec_reason": "",
193
190
"track_id": "",
@@ -199,9 +196,7 @@ curl -G 'https://api.bilibili.com/x/relation/fans' \
199
196
"mtime": 1746098997,
200
197
"tag": null,
201
198
"special": 0,
202
"contract_info": {
203
204
},
199
"contract_info": {},
205
200
"uname": "JSRCode",
206
201
"face": "https://i1.hdslb.com/bfs/face/f6c74700c72d27ae224c5311634b4a3770e3cdcf.jpg",
207
202
"sign": "一个喜欢码代码的高中牲",
@@ -231,9 +226,7 @@ curl -G 'https://api.bilibili.com/x/relation/fans' \
231
226
"nickname_color": "",
232
227
"avatar_subscript_url": ""
233
228
},
234
"name_render": {
235
236
},
229
"name_render": {},
237
230
"nft_icon": "",
238
231
"rec_reason": "",
239
232
"track_id": "",
@@ -325,9 +318,7 @@ curl -G 'https://api.bilibili.com/x/relation/followers' \
325
318
"mtime": 1746199088,
326
319
"tag": null,
327
320
"special": 0,
328
"contract_info": {
329
330
},
321
"contract_info": {},
331
322
"uname": "Astlinga_星灵",
332
323
"face": "https://i1.hdslb.com/bfs/face/005264524d05c0b8c132acc3ee88bb839351025b.jpg",
333
324
"sign": "",
@@ -357,9 +348,7 @@ curl -G 'https://api.bilibili.com/x/relation/followers' \
357
348
"nickname_color": "",
358
349
"avatar_subscript_url": ""
359
350
},
360
"name_render": {
361
362
},
351
"name_render": {},
363
352
"nft_icon": "",
364
353
"rec_reason": "",
365
354
"track_id": "",
@@ -371,9 +360,7 @@ curl -G 'https://api.bilibili.com/x/relation/followers' \
371
360
"mtime": 1746098997,
372
361
"tag": null,
373
362
"special": 0,
374
"contract_info": {
375
376
},
363
"contract_info": {},
377
364
"uname": "JSRCode",
378
365
"face": "https://i1.hdslb.com/bfs/face/f6c74700c72d27ae224c5311634b4a3770e3cdcf.jpg",
379
366
"sign": "一个喜欢码代码的高中牲",
@@ -403,9 +390,7 @@ curl -G 'https://api.bilibili.com/x/relation/followers' \
403
390
"nickname_color": "",
404
391
"avatar_subscript_url": ""
405
392
},
406
"name_render": {
407
408
},
393
"name_render": {},
409
394
"nft_icon": "",
410
395
"rec_reason": "",
411
396
"track_id": "",
@@ -420,6 +405,58 @@ curl -G 'https://api.bilibili.com/x/relation/followers' \
420
405
421
406
</details>
422
407
408
### 获取自己粉丝列表的未读状态
409
410
> <https://api.bilibili.com/x/relation/followers/unread/count>
411
412
*请求方式：GET*
413
414
认证方式：Cookie（SESSDATA）
415
416
调用此接口后会重置未读状态
417
418
**json回复：**
419
420
根对象：
421
422
| 字段 | 类型 | 内容 | 备注 |
423
| ------- | ---- | -------- | ----------------------------- |
424
| code | num | 返回值 | 0：成功<br />-101：账号未登录 |
425
| message | str | 错误信息 | 默认为 0 |
426
| ttl | num | 1 | |
427
| data | obj | 信息本体 | |
428
429
`data`对象：
430
431
| 字段 | 类型 | 内容 | 备注 |
432
| ----- | ---- | -------------------------- | ---------------------------------- |
433
| count | num | 自上次访问后新增的粉丝个数 | |
434
| time | num | 上次访问粉丝列表时间 | 秒级时间戳；当没有新增粉丝时为 `0` |
435
436
**示例：**
437
438
```shell
439
curl 'https://api.bilibili.com/x/relation/followers/unread/count' \
440
-b 'SESSDATA=xxx'
441
```
442
443
<details>
444
<summary>查看响应示例：</summary>
445
446
```json
447
{
448
"code": 0,
449
"message": "0",
450
"ttl": 1,
451
"data": {
452
"count": 55,
453
"time": 1743677191
454
}
455
}
456
```
457
458
</details>
459
423
460
### 查询用户关注明细
424
461
425
462
> <https://api.bilibili.com/x/relation/followings>
@@ -574,7 +611,7 @@ curl -G 'https://api.bilibili.com/x/relation/followings' \
574
611
575
612
*请求方式：GET*
576
613
577
仅可查看前 5 页，对于已设置可见性隐私关注列表的用户，`$.data.list` 为 null，且 `$.data.total` 为0
614
仅可查看前 5 页，对于已设置可见性隐私关注列表的用户，响应数据中的 `data.list` 为 null，且 `data.total` 为0
578
615
579
616
**url参数：**
580
617
@@ -911,9 +948,7 @@ curl -G 'https://api.bilibili.com/x/relation/followings/search' \
911
948
"mid": 53456,
912
949
"attribute": 2,
913
950
"mtime": 1586415053,
914
"tag": [
915
-10
916
],
951
"tag": [-10],
917
952
"special": 1,
918
953
"uname": "Warma",
919
954
"face": "https://i2.hdslb.com/bfs/face/c1bbee6d255f1e7fc434e9930f0f288c8b24293a.jpg",
@@ -1039,9 +1074,7 @@ curl -G 'https://api.bilibili.com/x/relation/same/followings' \
1039
1074
"mid": 517717593,
1040
1075
"attribute": 2,
1041
1076
"mtime": 1592126052,
1042
"tag": [
1043
207542
1044
],
1077
"tag": [207542],
1045
1078
"special": 0,
1046
1079
"uname": "上海爱丽丝幻乐团",
1047
1080
"face": "https://i0.hdslb.com/bfs/face/851a9191cbe93e66304d7577c0f6f83834e52109.jpg",
@@ -1265,9 +1298,7 @@ curl -G 'https://api.bilibili.com/x/relation/friends' \
1265
1298
"mid": 24022863,
1266
1299
"attribute": 6,
1267
1300
"mtime": 1685026230,
1268
"tag": [
1269
-10
1270
],
1301
"tag": [-10],
1271
1302
"special": 1,
1272
1303
"uname": "黄禄轩电脑专用账号",
1273
1304
"face": "https://i0.hdslb.com/bfs/face/a70ec7d2a3822980a915ef4b30371af0cbc79132.jpg",
@@ -1306,9 +1337,7 @@ curl -G 'https://api.bilibili.com/x/relation/friends' \
1306
1337
"mid": 85438718,
1307
1338
"attribute": 6,
1308
1339
"mtime": 1684759843,
1309
"tag": [
1310
194110
1311
],
1340
"tag": [194110],
1312
1341
"special": 0,
1313
1342
"uname": "忘忧北萱草Official",
1314
1343
"face": "https://i2.hdslb.com/bfs/face/68d8cba01aab907dbb2cf2e17074f20947156237.jpg",
@@ -1667,9 +1696,9 @@ curl 'https://api.bilibili.com/x/relation/batch/modify' \
1667
1696
| 字段 | 类型 | 内容 | 备注 |
1668
1697
| --------- | --------------------------------------- | ------------ | -------------------------------------------------------- |
1669
1698
| mid | num | 目标用户 mid | |
1670
| attribute | num | 关系属性 | 0：未关注<br />2：已关注<br />6：已互粉<br />128：已拉黑 |
1699
| attribute | num | 关系属性 | 0：未关注<br />~~1：悄悄关注（已弃用）~~<br />2：已关注<br />6：已互粉<br />128：已拉黑 |
1671
1700
| mtime | num | 关注对方时间 | 时间戳<br />未关注为 0 |
1672
| tag | null默认分组<br />array存在至少一个分组 | 分组 id | |
1701
| tag | 默认分组：null<br />存在至少一个分组：array | 分组 id | |
1673
1702
| special | num | 特别关注标志 | 0：否<br />1：是 |
1674
1703
1675
1704
`tag`数组：
@@ -1706,7 +1735,7 @@ curl 'https://api.bilibili.com/x/relation/batch/modify' \
1706
1735
| ttl | num | 1 | |
1707
1736
| data | obj | 信息本体 | 详见 [关系属性对象](#关系属性对象) |
1708
1737
1709
`data`对象：**示例：**
1738
**示例：**
1710
1739
1711
1740
可得对于`mid=258150656`的用户，在`2018/10/28 0:51:41`时关注，且设为特别关注，并位于为`-10`分组中
1712
1741
@@ -1804,21 +1833,14 @@ curl -G 'https://api.bilibili.com/x/space/acc/relation' \
1804
1833
"mid": 15858903,
1805
1834
"attribute": 6,
1806
1835
"mtime": 1548311059,
1807
"tag": [
1808
-10,
1809
194110,
1810
248468
1811
],
1836
"tag": [-10, 194110, 248468],
1812
1837
"special": 1
1813
1838
},
1814
1839
"be_relation": {
1815
1840
"mid": 293793435,
1816
1841
"attribute": 6,
1817
1842
"mtime": 1548311059,
1818
"tag": [
1819
56502,
1820
-10
1821
],
1843
"tag": [56502, -10],
1822
1844
"special": 1
1823
1845
}
1824
1846
}
@@ -1945,7 +1967,7 @@ curl -G 'https://api.bilibili.com/x/relation/relations' \
1945
1967
1946
1968
| 字段 | 类型 | 内容 | 备注 |
1947
1969
| ----- | ---- | ---------- | ---- |
1948
| tagid | num | 分组 id | -10：特别关注<br />0：默认分组 |
1970
| tagid | num | 分组 id | -10：特别关注<br />0：默认分组 |
1949
1971
| name | str | 分组名称 | |
1950
1972
| count | num | 分组成员数 | |
1951
1973
| tip | str | 提示信息 | |
@@ -2014,7 +2036,7 @@ curl 'https://api.bilibili.com/x/relation/tags' \
2014
2036
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
2015
2037
| ---------- | ---- | -------------- | ------------ | ------------------------------------------------------- |
2016
2038
| access_key | str | APP 登录 Token | APP 方式必要 | |
2017
| tagid | num | 分组 id | 必要 | |
2039
| tagid | num | 分组 id | 必要 | 0：默认分组<br />-10：特别关注<br />-20：所有 |
2018
2040
| order_type | str | 排序方式 | 非必要 | 按照关注顺序排列：留空<br />按照最常访问排列：attention |
2019
2041
| ps | num | 每页项数 | 非必要 | 默认为 20 |
2020
2042
| pn | num | 页数 | 非必要 | 默认为1 |