From 2c9960f18898ca93408b1ed3b11a66338e453569 Mon Sep 17 00:00:00 2001
From: wuziqian211 <65224318+wuziqian211@users.noreply.github.com>
Date: Tue, 28 May 2024 23:47:04 +0800
Subject: [PATCH] update docs
---
docs/message/private_msg.md | 4 +-
docs/message/private_msg_content.md | 65 +++++++++++++++++++++++------
2 files changed, 55 insertions(+), 14 deletions(-)
diff --git a/docs/message/private_msg.md b/docs/message/private_msg.md
index f0fc851..bcecace 100644
--- a/docs/message/private_msg.md
+++ b/docs/message/private_msg.md
@@ -694,6 +694,8 @@ curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/update_ack' \
认证方式：Cookie（SESSDATA）
+**仅支持发送 `msg[msg_type]` 为 `1`、`2` 或 `5` 的私信**
+
调用该接口同时会将该会话的最近一条私信设置为已读
**正文参数（application/x-www-form-urlencoded）：**
@@ -703,7 +705,7 @@ curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/update_ack' \
| msg[sender_uid] | num | 发送者mid | 必要 | 必须为自己的 mid |
| msg[receiver_id] | num | 接收者id | 必要 | `msg[receiver_type]` 为 `1` 时表示用户 mid，为 `2` 时表示粉丝团 id |
| msg[receiver_type] | num | 接收者类型 | 必要 | 1：用户
2：粉丝团 |
-| msg[msg_type] | num | 消息类型 | 必要 | 详见[私信消息类型、内容说明](private_msg_content.md) |
+| msg[msg_type] | num | 消息类型 | 必要 | 详见[私信消息类型、内容说明](private_msg_content.md)
**此接口仅支持传入 `1`、`2` 或 `5`** |
| msg[msg_status] | num | 消息状态 | 非必要 | 恒为 `0` |
| msg[dev_id] | str | dev_id | 必要 | 实质上即 UUID（版本 4），**生成方式在下面** |
| msg[timestamp] | num | 当前时间戳（秒） | 必要 | |
diff --git a/docs/message/private_msg_content.md b/docs/message/private_msg_content.md
index 0966a28..4dcbbe3 100644
--- a/docs/message/private_msg_content.md
+++ b/docs/message/private_msg_content.md
@@ -60,7 +60,9 @@
内容为目标私信的 `msg_key`
-请确保目标私信存在、在撤回有效期（120 秒）里，且与发送的私信在同一会话内；成功发送此私信后，目标私信的 `msg_status` 会变成 `1`（在前端会显示目标消息被撤回）
+请确保目标私信存在、在撤回有效期（120 秒）里，且与发送的私信在同一会话内，只能撤回自己发送的私信
+
+成功发送此私信后，目标私信的 `msg_status` 会变成 `1`（在前端会显示目标私信被撤回）
**示例：**
@@ -108,6 +110,23 @@
}
```
+### ~~系统撤回消息（`msg_type=8`）~~
+
+~~此消息类型由于存在安全问题，已被弃用~~
+
+
+查看此消息类型说明
+
+此类型消息在接收时的 `msg_type` 的值为 `5`（而不是 `8`）且 `sys_cancel` 的值为 `true`，**仅在用户会话中有效；目前已不可直接发送**
+
+内容为目标私信的 `msg_key`
+
+请确保目标私信存在，且与发送的私信在同一会话内，只能撤回自己发送的私信；**不限制目标私信的发送时间**
+
+成功发送此私信后，目标私信的 `msg_status` 会变成 `2`（在前端会直接隐藏目标私信，且后端也不会返回目标私信的任何信息）
+
+
+
### 小程序消息（`msg_type=9`）
由于 B 站并没有对外公开小程序，此消息类型不常用
@@ -144,7 +163,7 @@
### 通知消息（`msg_type=10`）
-此类型消息仅可接收，不可直接发送
+此类型消息仅可接收，**不可直接发送**
**按钮显示逻辑说明：**
@@ -265,7 +284,7 @@
### 视频推送消息（`msg_type=11`）
-此类型消息仅可接收，不可直接发送；有小概率会出现即使视频存在，也只会出现 `rid`、`type` 和 `attach_msg` 三项的现象
+此类型消息仅可接收，**不可直接发送**；有小概率会出现即使视频存在，也只会出现 `rid`、`type`（值为 `11`，注意其名称后面没有下划线）和 `attach_msg` 三项的现象
根对象：
@@ -312,7 +331,7 @@
### 专栏推送消息（`msg_type=12`）
-此类型消息仅可接收，不可直接发送；有小概率会出现即使专栏存在，也只会出现 `rid`、`type` 和 `attach_msg` 三项的现象
+此类型消息仅可接收，**不可直接发送**；有小概率会出现即使专栏存在，也只会出现 `rid`、`type`（值为 `12`）和 `attach_msg` 三项的现象
根对象：
@@ -362,7 +381,7 @@
### 图片卡片消息（`msg_type=13`）
-此类型消息仅可接收，不可直接发送
+此类型消息仅可接收，**不可直接发送**
根对象：
@@ -414,15 +433,15 @@
### 被关注时的自动推送消息（`msg_type=16`）
-一般仅在开启了 B 站的 “被关注回复” 功能与勾选 “被关注后，向关注我的人推送我的往期作品” 选项（仅部分用户会显示此选项）时才会发送此类型消息，紧接在自动发送的文字消息其后
+一般仅在开启了 B 站的 “被关注回复” 功能与勾选 “被关注后，向关注我的人推送我的往期作品” 选项（仅部分用户会显示此选项）时才会发送此类型消息，紧接在自动发送的文字消息后面
根对象：
-| 字段 | 类型 | 内容 | 备注 |
-| ------------- | ----- | ---------------- | ------------------------------------ |
-| main_title | str | 主标题 | 一般为 `更多宝藏内容` |
-| reply_content | str | 自动回复文字内容 | 仅显示在聊天列表，在私信内容中不显示 |
-| sub_cards | array | 推送的作品列表 | 一般为3个 |
+| 字段 | 类型 | 内容 | 备注 |
+| ------------- | ----- | ---------------- | -------------------------------------------- |
+| main_title | str | 主标题 | 一般为 `更多宝藏内容` |
+| reply_content | str | 自动回复文字内容 | 仅在聊天列表中的消息概要中显示此内容，在私信内容中不显示 |
+| sub_cards | array | 推送的作品列表 | 一般为3个 |
`sub_cards`数组：
@@ -492,7 +511,7 @@
### 系统提示消息（`msg_type=18`）
-此类型消息仅可接收，不可直接发送；由系统自动发送，但仅自己可见
+此类型消息仅可接收，**不可直接发送**；由系统自动发送，但仅自己可见
根对象：
@@ -515,6 +534,7 @@
| text | str | 提示文字 | |
| color_day | str | 浅色模式下的提示文字颜色 | HEX颜色代码 |
| color_nig | str | 深色模式下的提示文字颜色 | HEX颜色代码 |
+| jump_url | str | 点击提示跳转到的url | （非必要） |
**示例：**
@@ -526,6 +546,25 @@
}
```
+### AI 消息（`msg_type=19`）
+
+此消息类型尚未得到广泛使用
+
+根对象：
+
+| 字段 | 类型 | 内容 | 备注 |
+| ------------------ | ---- | -------------------- | ---------------- |
+| content_ | str | 消息内容 | |
+| showLike_ | num | 是否显示点赞按钮 | |
+| showChange_ | num | 是否显示修改内容按钮 | |
+| gptSessionId_ | num | GPT 会话 id | |
+| gptBindQuery_ | num | （？） | **作用尚不明确** |
+| sessionClosedLine_ | num | （？） | **作用尚不明确** |
+
+**示例：**
+
+由于 B 站尚未公开此消息类型，暂无示例
+
## 粉丝团消息类型
以下消息类型仅常见于粉丝团中的系统消息（`receiver_type` 为 `2` 且 `sender_uid` 为 `0`）
@@ -542,7 +581,7 @@
### 成员入群消息（`msg_type=306`）
-以上6种消息类型均为以下数据类型结构
+以上 6 种类型的消息均为以下数据类型结构
根对象：