admin/bilibili-API-collect
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
wuziqian211
2024-07-30 23:42:16 +08:00
parent 9fd1007072
commit 81527857da
3 changed files with 34 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/message/msg.md
View File

@@ -35,9 +35,9 @@
| ------------- | ---- | ------------------ | -------------------------- | | ------------- | ---- | ------------------ | -------------------------- |
| at | num | 未读at数 | | | at | num | 未读at数 | |
| chat | num | 0 | 仅旧接口，**作用尚不明确** | | chat | num | 0 | 仅旧接口，**作用尚不明确** |
| coin | num | 未读投币数 | 目前恒为 `0` | | coin | num | 未读投币数 | |
| danmu | num | 未读弹幕数 | 目前恒为 `0` | | danmu | num | 未读弹幕数 | |
| favorite | num | 未读收藏数 | 目前恒为 `0` | | favorite | num | 未读收藏数 | |
| like | num | 未读点赞数 | | | like | num | 未读点赞数 | |
| recv_like | num | 未读点赞数 | 同 `like` | | recv_like | num | 未读点赞数 | 同 `like` |
| recv_reply | num | 未读回复数 | 同 `reply` | | recv_reply | num | 未读回复数 | 同 `reply` |

26
docs/message/private_msg.md
View File

@@ -24,11 +24,11 @@
| status | num | 会话状态 | 详细信息有待补充 | | status | num | 会话状态 | 详细信息有待补充 |
| max_seqno | num | 最近一条消息的序列号 | | | max_seqno | num | 最近一条消息的序列号 | |
| new_push_msg | num | 是否有新推送的消息 | | | new_push_msg | num | 是否有新推送的消息 | |
| setting | num | 推送设置 | 0：接收推送<br />1：不接收推送 | | setting | num | 推送设置 | 0：接收推送<br />1：不接收推送<br />2：（？） |
| is_guardian | num | （？） | 在用户会话中有效<br />**作用尚不明确** | | is_guardian | num | 自己是否为对方的骑士（？） | 在用户会话中有效<br />0：否<br />2：是（？） |
| is_intercept | num | 会话是否被拦截 | | | is_intercept | num | 会话是否被拦截 | |
| is_trust | num | 是否信任此会话 | 若为 `1`，则表示此会话之前被拦截过，但用户选择信任本会话 | | is_trust | num | 是否信任此会话 | 若为 `1`，则表示此会话之前被拦截过，但用户选择信任本会话 |
| system_msg_type | num | 系统会话类型 | 0：非系统会话<br />1：主播小助手<br />7：UP主小助手<br />8：客服消息 | | system_msg_type | num | 系统会话类型 | 0：非系统会话<br />1：主播小助手<br />5：系统通知（？）<br />7：UP主小助手<br />8：客服消息 |
| account_info | obj | 会话信息 | 仅在系统会话中出现 | | account_info | obj | 会话信息 | 仅在系统会话中出现 |
| live_status | num | 用户是否正在直播 | 在用户会话中有效，其他会话中为 `0` | | live_status | num | 用户是否正在直播 | 在用户会话中有效，其他会话中为 `0` |
| biz_msg_unread_count | num | 未读通知消息数 | | | biz_msg_unread_count | num | 未读通知消息数 | |
@@ -79,8 +79,8 @@
| 2 | Android | | | 2 | Android | |
| 3 | H5 | | | 3 | H5 | |
| 4 | PC客户端 | | | 4 | PC客户端 | |
| 5 | 推送消息 | 包括：官方向大多数用户自动发送的私信（如：UP主小助手的推广）等 | | 5 | 官方推送消息 | 包括：官方向大多数用户自动发送的私信（如：UP主小助手的推广）等 |
| 6 | 通知消息 | 包括：特别关注时稿件的自动推送、因成为契约者而自动发送的私信、包月充电回馈私信、官方发送的特定于自己的消息（如：UP主小助手的稿件审核状态通知）等 | | 6 | 推送/通知消息 | 包括：特别关注时稿件的自动推送、因成为契约者而自动发送的私信、包月充电回馈私信、官方发送的特定于自己的消息（如：UP主小助手的稿件审核状态通知）等 |
| 7 | Web | | | 7 | Web | |
| 8 | 自动回复 - 被关注回复 | B站前端会显示“此条消息为自动回复” | | 8 | 自动回复 - 被关注回复 | B站前端会显示“此条消息为自动回复” |
| 9 | 自动回复 - 收到消息回复 | B站前端会显示“此条消息为自动回复” | | 9 | 自动回复 - 收到消息回复 | B站前端会显示“此条消息为自动回复” |
@@ -103,12 +103,13 @@
**URL参数:** **URL参数:**
| 参数名 | 类型 | 内容 | 必要性 | 备注 | | 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------------ | ---- | -------------------- | ------ | -------------------------------------------------------------------------- | | ------------------ | ---- | -------------------------- | ------ | -------------------------------------------------------------------------- |
| unread_type | num | 未读类型 | 非必要 | 0：所有<br />1：仅已关注<br />2：仅未关注<br />3：仅被拦截 (须同时设置参数 `show_dustbin=1`)<br />默认为 `0` | | unread_type | num | 未读类型 | 非必要 | 0：所有<br />1：仅已关注<br />2：仅未关注<br />3：仅被拦截 (须同时设置参数 `show_dustbin=1`)<br />默认为 `0` |
| show_dustbin | num | 是否返回被拦截私信数 | 非必要 | 0：否<br />1：是 | | show_unfollow_list | num | 是否返回未关注人推送消息数 | 非必要 | 0：否<br />1：是 |
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` | | show_dustbin | num | 是否返回被拦截私信数 | 非必要 | 0：否<br />1：是 |
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 | | build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
**json回复：** **json回复：**
@@ -142,6 +143,7 @@
```shell ```shell
curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/single_unread' \ curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/single_unread' \
--data-urlencode 'unread_type=0' \ --data-urlencode 'unread_type=0' \
--data-urlencode 'show_unfollow_list=1' \
--data-urlencode 'show_dustbin=1' \ --data-urlencode 'show_dustbin=1' \
--data-urlencode 'build=0' \ --data-urlencode 'build=0' \
--data-urlencode 'mobi_app=web' \ --data-urlencode 'mobi_app=web' \
@@ -184,7 +186,7 @@ curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/single_unread' \
| 参数名 | 类型 | 内容 | 必要性 | 备注 | | 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------------- | ---- | -------------------- | ------ | ------------------------- | | ------------- | ---- | -------------------- | ------ | ------------------------- |
| session_type | num | 会话类型 | 必要 | 1：所有<br />2：未关注人<br />3：粉丝团<br />7：系统消息（？） | | session_type | num | 会话类型 | 必要 | 1：未被折叠<br />2：未关注人<br />3：粉丝团<br />4：所有<br />5：被拦截<br />7：系统消息（？） |
| group_fold | num | 是否折叠粉丝团消息 | 非必要 | 0：否<br />1：是 | | group_fold | num | 是否折叠粉丝团消息 | 非必要 | 0：否<br />1：是 |
| unfollow_fold | num | 是否折叠未关注人消息 | 非必要 | 0：否<br />1：是 | | unfollow_fold | num | 是否折叠未关注人消息 | 非必要 | 0：否<br />1：是 |
| sort_rule | num | 排序方式 | 非必要 | 1、2：按会话时间逆向排序<br />3：按已读时间逆向排序<br />其他：用户按会话时间逆向排序，粉丝团按加群时间正向排序（？） | | sort_rule | num | 排序方式 | 非必要 | 1、2：按会话时间逆向排序<br />3：按已读时间逆向排序<br />其他：用户按会话时间逆向排序，粉丝团按加群时间正向排序（？） |

25
docs/message/private_msg_content.md
View File

@@ -560,14 +560,23 @@
根对象： 根对象：
| 字段 | 类型 | 内容 | 备注 | | 字段 | 类型 | 内容 | 备注 |
| ------------------ | ---- | -------------------- | ---------------- | | ------------------- | ---- | -------------------- | ---------------- |
| content_ | str | 消息内容 | | | content | obj | 富文本内容 | |
| showLike_ | num | 是否显示点赞按钮 | | | show_like | bool | 是否显示点赞按钮 | |
| showChange_ | num | 是否显示修改内容按钮 | | | show_change | bool | 是否显示修改内容按钮 | |
| gptSessionId_ | num | GPT 会话 id | | | gpt_session_id | num | GPT 会话 id | |
| gptBindQuery_ | num | （？） | **作用尚不明确** | | gpt_bind_query | str | （？） | **作用尚不明确** |
| sessionClosedLine_ | num | （？） | **作用尚不明确** | | session_closed_line | str | （？） | **作用尚不明确** |
| voice_url | str | 语音 url（？） | |
| sub_type | num | 子类型（？） | |
| voice_time | num | 语音时长（？） | |
`content`对象：
| 字段 | 类型 | 内容 | 备注 |
| ---------- | ----- | -------- | ---------------- |
| paragraphs | array | 段落列表 | 详细信息有待补充 |
**示例：** **示例：**