XFE Git
XFE Studio Git
Git 首页 全局搜索
XFE 主站 文档 NuGet
公开
关注 0 Fork 0 Star 0
返回提交历史

XFEstudio/bilibili-API-collect

update docs

2c9960f
wuziqian211 <65224318+wuziqian211@users.noreply.github.com>
提交于

代码差异

2 个文件 +55 -14
Modified docs/message/private_msg.md +3 -1
@@ -694,6 +694,8 @@ curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/update_ack' \
694 694
695 695 认证方式:Cookie(SESSDATA)
696 696
697 **仅支持发送 `msg[msg_type]` 为 `1`、`2` 或 `5` 的私信**
698
697 699 调用该接口同时会将该会话的最近一条私信设置为已读
698 700
699 701 **正文参数(application/x-www-form-urlencoded):**
@@ -703,7 +705,7 @@ curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/update_ack' \
703 705 | msg[sender_uid] | num | 发送者mid | 必要 | 必须为自己的 mid |
704 706 | msg[receiver_id] | num | 接收者id | 必要 | `msg[receiver_type]` 为 `1` 时表示用户 mid,为 `2` 时表示粉丝团 id |
705 707 | msg[receiver_type] | num | 接收者类型 | 必要 | 1:用户<br />2:粉丝团 |
706 | msg[msg_type] | num | 消息类型 | 必要 | 详见[私信消息类型、内容说明](private_msg_content.md) |
708 | msg[msg_type] | num | 消息类型 | 必要 | 详见[私信消息类型、内容说明](private_msg_content.md)<br />**此接口仅支持传入 `1`、`2` 或 `5`** |
707 709 | msg[msg_status] | num | 消息状态 | 非必要 | 恒为 `0` |
708 710 | msg[dev_id] | str | dev_id | 必要 | 实质上即 UUID(版本 4),**生成方式在下面** |
709 711 | msg[timestamp] | num | 当前时间戳(秒) | 必要 | |
Modified docs/message/private_msg_content.md +52 -13
@@ -60,7 +60,9 @@
60 60
61 61 内容为目标私信的 `msg_key`
62 62
63 请确保目标私信存在、在撤回有效期(120 秒)里,且与发送的私信在同一会话内;成功发送此私信后,目标私信的 `msg_status` 会变成 `1`(在前端会显示目标消息被撤回)
63 请确保目标私信存在、在撤回有效期(120 秒)里,且与发送的私信在同一会话内,只能撤回自己发送的私信
64
65 成功发送此私信后,目标私信的 `msg_status` 会变成 `1`(在前端会显示目标私信被撤回)
64 66
65 67 **示例:**
66 68
@@ -108,6 +110,23 @@
108 110 }
109 111 ```
110 112
113 ### ~~系统撤回消息(`msg_type=8`)~~
114
115 ~~此消息类型由于存在安全问题,已被弃用~~
116
117 <details>
118 <summary>查看此消息类型说明</summary>
119
120 此类型消息在接收时的 `msg_type` 的值为 `5`(而不是 `8`)且 `sys_cancel` 的值为 `true`,**仅在用户会话中有效;目前已不可直接发送**
121
122 内容为目标私信的 `msg_key`
123
124 请确保目标私信存在,且与发送的私信在同一会话内,只能撤回自己发送的私信;**不限制目标私信的发送时间**
125
126 成功发送此私信后,目标私信的 `msg_status` 会变成 `2`(在前端会直接隐藏目标私信,且后端也不会返回目标私信的任何信息)
127
128 </details>
129
111 130 ### 小程序消息(`msg_type=9`)
112 131
113 132 由于 B 站并没有对外公开小程序,此消息类型不常用
@@ -144,7 +163,7 @@
144 163
145 164 ### 通知消息(`msg_type=10`)
146 165
147 此类型消息仅可接收,不可直接发送
166 此类型消息仅可接收,**不可直接发送**
148 167
149 168 **按钮显示逻辑说明:**
150 169
@@ -265,7 +284,7 @@
265 284
266 285 ### 视频推送消息(`msg_type=11`)
267 286
268 此类型消息仅可接收,不可直接发送;有小概率会出现即使视频存在,也只会出现 `rid`、`type` 和 `attach_msg` 三项的现象
287 此类型消息仅可接收,**不可直接发送**;有小概率会出现即使视频存在,也只会出现 `rid`、`type`(值为 `11`,注意其名称后面没有下划线)和 `attach_msg` 三项的现象
269 288
270 289 根对象:
271 290
@@ -312,7 +331,7 @@
312 331
313 332 ### 专栏推送消息(`msg_type=12`)
314 333
315 此类型消息仅可接收,不可直接发送;有小概率会出现即使专栏存在,也只会出现 `rid`、`type` 和 `attach_msg` 三项的现象
334 此类型消息仅可接收,**不可直接发送**;有小概率会出现即使专栏存在,也只会出现 `rid`、`type`(值为 `12`)和 `attach_msg` 三项的现象
316 335
317 336 根对象:
318 337
@@ -362,7 +381,7 @@
362 381
363 382 ### 图片卡片消息(`msg_type=13`)
364 383
365 此类型消息仅可接收,不可直接发送
384 此类型消息仅可接收,**不可直接发送**
366 385
367 386 根对象:
368 387
@@ -414,15 +433,15 @@
414 433
415 434 ### 被关注时的自动推送消息(`msg_type=16`)
416 435
417 一般仅在开启了 B 站的 “被关注回复” 功能与勾选 “被关注后,向关注我的人推送我的往期作品” 选项(仅部分用户会显示此选项)时才会发送此类型消息,紧接在自动发送的文字消息其后
436 一般仅在开启了 B 站的 “被关注回复” 功能与勾选 “被关注后,向关注我的人推送我的往期作品” 选项(仅部分用户会显示此选项)时才会发送此类型消息,紧接在自动发送的文字消息后面
418 437
419 438 根对象:
420 439
421 | 字段 | 类型 | 内容 | 备注 |
422 | ------------- | ----- | ---------------- | ------------------------------------ |
423 | main_title | str | 主标题 | 一般为 `更多宝藏内容` |
424 | reply_content | str | 自动回复文字内容 | 仅显示在聊天列表,在私信内容中不显示 |
425 | sub_cards | array | 推送的作品列表 | 一般为3个 |
440 | 字段 | 类型 | 内容 | 备注 |
441 | ------------- | ----- | ---------------- | -------------------------------------------- |
442 | main_title | str | 主标题 | 一般为 `更多宝藏内容` |
443 | reply_content | str | 自动回复文字内容 | 仅在聊天列表中的消息概要中显示此内容,在私信内容中不显示 |
444 | sub_cards | array | 推送的作品列表 | 一般为3个 |
426 445
427 446 `sub_cards`数组:
428 447
@@ -492,7 +511,7 @@
492 511
493 512 ### 系统提示消息(`msg_type=18`)
494 513
495 此类型消息仅可接收,不可直接发送;由系统自动发送,但仅自己可见
514 此类型消息仅可接收,**不可直接发送**;由系统自动发送,但仅自己可见
496 515
497 516 根对象:
498 517
@@ -515,6 +534,7 @@
515 534 | text | str | 提示文字 | |
516 535 | color_day | str | 浅色模式下的提示文字颜色 | HEX颜色代码 |
517 536 | color_nig | str | 深色模式下的提示文字颜色 | HEX颜色代码 |
537 | jump_url | str | 点击提示跳转到的url | (非必要) |
518 538
519 539 **示例:**
520 540
@@ -526,6 +546,25 @@
526 546 }
527 547 ```
528 548
549 ### AI 消息(`msg_type=19`)
550
551 此消息类型尚未得到广泛使用
552
553 根对象:
554
555 | 字段 | 类型 | 内容 | 备注 |
556 | ------------------ | ---- | -------------------- | ---------------- |
557 | content_ | str | 消息内容 | |
558 | showLike_ | num | 是否显示点赞按钮 | |
559 | showChange_ | num | 是否显示修改内容按钮 | |
560 | gptSessionId_ | num | GPT 会话 id | |
561 | gptBindQuery_ | num | (?) | **作用尚不明确** |
562 | sessionClosedLine_ | num | (?) | **作用尚不明确** |
563
564 **示例:**
565
566 由于 B 站尚未公开此消息类型,暂无示例
567
529 568 ## 粉丝团消息类型
530 569
531 570 以下消息类型仅常见于粉丝团中的系统消息(`receiver_type` 为 `2` 且 `sender_uid` 为 `0`)
@@ -542,7 +581,7 @@
542 581
543 582 ### 成员入群消息(`msg_type=306`)
544 583
545 以上6种消息类型均为以下数据类型结构
584 以上 6 种类型的消息均为以下数据类型结构
546 585
547 586 根对象:
548 587