From 44003bc689d678b3e3ebc0686add8383c0616830 Mon Sep 17 00:00:00 2001
From: wuziqian211 <65224318+wuziqian211@users.noreply.github.com>
Date: Thu, 27 Jun 2024 02:33:26 +0800
Subject: [PATCH] update docs
---
docs/message/private_msg.md | 14 +++++++-------
docs/message/private_msg_content.md | 30 ++++++++++++++---------------
2 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/docs/message/private_msg.md b/docs/message/private_msg.md
index 337257f..1d22777 100644
--- a/docs/message/private_msg.md
+++ b/docs/message/private_msg.md
@@ -8,7 +8,7 @@
| -------------------- | ---- | -------------------------------- | --------------------------------------------------- |
| talker_id | num | 聊天对象的id | `session_type` 为 `1` 时表示用户 mid，为 `2` 时表示粉丝团 id |
| session_type | num | 聊天对象的类型 | 1：用户
2：粉丝团 |
-| at_seqno | num | 最近一次未读at自己的消息的序列号 | 在粉丝团会话中有效，若没有未读的at自己的消息则为 `0` |
+| at_seqno | num | 最近一次未读at自己的消息的序列号 | 在粉丝团会话中有效，若没有未读的 at 自己的消息则为 `0` |
| top_ts | num | 置顶该会话的时间 | 微秒级时间戳；若未置顶该会话则为 `0` |
| group_name | str | 粉丝团名称 | 在粉丝团会话中有效 |
| group_cover | str | 粉丝团头像 | 在粉丝团会话中有效 |
@@ -18,16 +18,16 @@
| ack_ts | num | 最近一次已读时间 | 微秒级时间戳 |
| session_ts | num | 会话时间 | 微秒级时间戳 |
| unread_count | num | 未读消息数 | |
-| last_msg | obj | 最近的一条消息 | 详见[私信主体对象](#私信主体对象) |
-| group_type | num | 粉丝团类型 | 在粉丝团时有效
0：应援团
2：官方群 |
-| can_fold | num | （？） | **作用尚不明确** |
+| last_msg | 有效时：obj
无效时：null | 最近的一条消息 | 详见[私信主体对象](#私信主体对象) |
+| group_type | num | 粉丝团类型 | 在粉丝团时有效
0：应援团
2：官方群（如：ID 为 10 的粉丝团） |
+| can_fold | num | 会话是否可被折叠入未关注人消息 | 在用户会话中有效 |
| status | num | 会话状态 | 详细信息有待补充 |
| max_seqno | num | 最近一条消息的序列号 | |
| new_push_msg | num | 是否有新推送的消息 | |
-| setting | num | （？） | **作用尚不明确** |
-| is_guardian | num | （？） | **作用尚不明确** |
+| setting | num | 推送设置 | 0：接收推送
1：不接收推送
2：（？） |
+| is_guardian | num | （？） | 在用户会话中有效
**作用尚不明确** |
| is_intercept | num | 会话是否被拦截 | |
-| is_trust | num | 是否已设置不拦截此会话 | 若为 `1`，则表示此会话之前被拦截过，但用户选择信任本会话 |
+| is_trust | num | 是否信任此会话 | 若为 `1`，则表示此会话之前被拦截过，但用户选择信任本会话 |
| system_msg_type | num | 系统消息类型 | 0：非系统消息
1：主播小助手
7：UP主小助手
8：客服消息 |
| account_info | obj | 会话信息 | 仅在系统消息中出现 |
| live_status | num | 用户是否正在直播 | 在用户会话中有效 |
diff --git a/docs/message/private_msg_content.md b/docs/message/private_msg_content.md
index 2da6b01..c188a03 100644
--- a/docs/message/private_msg_content.md
+++ b/docs/message/private_msg_content.md
@@ -441,30 +441,30 @@
| ------------- | ----- | ---------------- | -------------------------------------------- |
| main_title | str | 主标题 | 一般为 `更多宝藏内容` |
| reply_content | str | 自动回复文字内容 | 仅在聊天列表中的消息概要中显示此内容，在私信内容中不显示 |
-| sub_cards | array | 推送的作品列表 | 一般为3个 |
+| sub_cards | array | 推送的稿件列表 | 一般为3个 |
`sub_cards`数组：
| 项 | 类型 | 内容 | 备注 |
| ---- | ---- | --------- | ---- |
-| 0 | obj | 作品1 | |
-| n | obj | 作品(n+1) | |
+| 0 | obj | 稿件1 | |
+| n | obj | 稿件(n+1) | |
| …… | obj | …… | …… |
`sub_cards`数组中的对象：
-| 字段 | 类型 | 内容 | 备注 |
-| --------- | ---- | ------------ | -------------------------------------------------------------- |
-| card_id | num | 作品id | 当作品为视频时：表示AV号
当作品为专栏时：表示CV号 |
-| card_type | num | 作品类型 | 1：视频 |
-| jump_url | str | 作品链接 | |
-| cover_url | str | 作品封面url | |
-| field1 | str | 作品标题 | |
-| field2 | str | 作品发布时间 | 格式：`YYYY-MM-DD` |
-| field3 | str | 字段3 | 当作品为视频时：表示作品播放量
当作品为专栏时：表示阅读量 |
-| icon3 | num | 图标3类型 | 1：播放量 |
-| field4 | str | 字段4 | 当作品为视频时：表示作品弹幕数
当作品为专栏时：表示评论数 |
-| icon4 | num | 图标4类型 | 3：弹幕数 |
+| 字段 | 类型 | 内容 | 备注 |
+| --------- | ---- | ------------ | -------------------------------- |
+| card_id | num | 稿件AV号 | |
+| card_type | num | 稿件类型 | 一般为 `1` |
+| jump_url | str | 稿件链接 | |
+| cover_url | str | 稿件封面url | 此项不实时更新，在发送私信时设置 |
+| field1 | str | 稿件标题 | 此项不实时更新，在发送私信时设置 |
+| field2 | str | 稿件发布时间 | 格式：`YYYY-MM-DD` |
+| field3 | str | 稿件播放量 | 此项不实时更新，在发送私信时设置 |
+| icon3 | num | 图标3类型 | 1：播放量 |
+| field4 | str | 稿件弹幕数 | 此项不实时更新，在发送私信时设置 |
+| icon4 | num | 图标4类型 | 3：弹幕数 |
**示例：**