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

XFEstudio/bilibili-API-collect

update docs

6e033f7
wuziqian211 <65224318+wuziqian211@users.noreply.github.com>
提交于

代码差异

2 个文件 +42 -42
Modified docs/message/msg.md +18 -18
@@ -13,10 +13,10 @@
13 13
14 14 **URL参数:**
15 15
16 | 参数名 | 类型 | 内容 | 必要性 | 备注 |
17 | -------- | ---- | ---- | ------ | -------------------------- |
18 | build | num | 0 | 不必要 | 从新接口发现, 作用尚不明确 |
19 | mobi_app | str | web | 不必要 | 从新接口发现, 作用尚不明确 |
16 | 参数名 | 类型 | 内容 | 必要性 | 备注 |
17 | -------- | ---- | ---------------- | ------ | ------------------------- |
18 | build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
19 | mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
20 20
21 21 **json回复:**
22 22
@@ -31,20 +31,20 @@
31 31
32 32 `data` 对象:
33 33
34 | 字段 | 类型 | 内容 | 备注 |
35 | ------------- | ---- | -------------- | ---------------------- |
36 | at | num | 未读at数 | |
37 | chat | num | 0 | 作用尚不明确 |
38 | coin | num | 未读投币数 | |
39 | danmu | num | 未读弹幕数 | |
40 | favorite | num | 未读收藏数? | |
41 | like | num | 未读点赞数 | |
42 | recv_like | num | 未读点赞数 | |
43 | recv_reply | num | 未读回复数 | |
44 | reply | num | 未读回复数 | |
45 | sys_msg | num | 未读系统通知数 | |
46 | sys_msg_style | num | 1 | 仅新接口, 作用尚不明确 |
47 | up | num | UP主助手信息数 | |
34 | 字段 | 类型 | 内容 | 备注 |
35 | ------------- | ---- | -------------- | -------------------------- |
36 | at | num | 未读at数 | |
37 | chat | num | 0 | 仅旧接口,**作用尚不明确** |
38 | coin | num | 未读投币数 | |
39 | danmu | num | 未读弹幕数 | |
40 | favorite | num | 未读收藏数? | |
41 | like | num | 未读点赞数 | |
42 | recv_like | num | 未读点赞数 | 同 `like` |
43 | recv_reply | num | 未读回复数 | 同 `reply` |
44 | reply | num | 未读回复数 | |
45 | sys_msg | num | 未读系统通知数 | |
46 | sys_msg_style | num | 1 | 仅新接口, **作用尚不明确** |
47 | up | num | UP主助手信息数 | |
48 48
49 49 **示例:**
50 50
Modified docs/message/private_msg.md +24 -24
@@ -9,10 +9,10 @@
9 9 | talker_id | num | 聊天对象的id | `session_type` 为 `1` 时表示用户 mid,为 `2` 时表示粉丝团 id |
10 10 | session_type | num | 聊天对象的类型 | 1:用户<br />2:粉丝团 |
11 11 | at_seqno | num | 最近一次未读at自己的消息的序列号 | 在粉丝团会话中有效,若没有未读的 at 自己的消息则为 `0` |
12 | top_ts | num | 置顶该会话的时间 | 微秒级时间戳;若未置顶该会话则为 `0` |
13 | group_name | str | 粉丝团名称 | 在粉丝团会话中有效 |
14 | group_cover | str | 粉丝团头像 | 在粉丝团会话中有效 |
15 | is_follow | num | 是否已关注对方 | 在用户会话中有效 |
12 | top_ts | num | 置顶该会话的时间 | 微秒级时间戳;若未置顶该会话则为 `0`;用于判断是否置顶了会话 |
13 | group_name | str | 粉丝团名称 | 在粉丝团会话中有效,其他会话中为空字符串 |
14 | group_cover | str | 粉丝团头像 | 在粉丝团会话中有效,其他会话中为空字符串 |
15 | is_follow | num | 是否关注了对方 | 在用户会话中有效,其他会话中为 `0` |
16 16 | is_dnd | num | 是否对会话设置了免打扰 | |
17 17 | ack_seqno | num | 最近一次已读的消息序列号 | 用于快速跳转到首条未读的消息 |
18 18 | ack_ts | num | 最近一次已读时间 | 微秒级时间戳 |
@@ -30,7 +30,7 @@
30 30 | is_trust | num | 是否信任此会话 | 若为 `1`,则表示此会话之前被拦截过,但用户选择信任本会话 |
31 31 | system_msg_type | num | 系统消息类型 | 0:非系统消息<br />1:主播小助手<br />7:UP主小助手<br />8:客服消息 |
32 32 | account_info | obj | 会话信息 | 仅在系统消息中出现 |
33 | live_status | num | 用户是否正在直播 | 在用户会话中有效 |
33 | live_status | num | 用户是否正在直播 | 在用户会话中有效,其他会话中为 `0` |
34 34 | biz_msg_unread_count | num | 未读通知消息数 | |
35 35 | user_label | null | (?) | **作用尚不明确** |
36 36
@@ -79,8 +79,8 @@
79 79 | 2 | Android | |
80 80 | 3 | H5 | |
81 81 | 4 | PC客户端 | |
82 | 5 | 官方自动推送 | 包括:官方向大多数用户自动发送的私信(如:UP主小助手的推广)等 |
83 | 6 | 自动推送/发送 | 包括:特别关注时稿件的自动推送、因成为契约者而自动发送的私信、包月充电回馈私信、官方发送的特定于自己的消息(如:UP主小助手的稿件审核状态通知)等 |
82 | 5 | 推送消息 | 包括:官方向大多数用户自动发送的私信(如:UP主小助手的推广)等 |
83 | 6 | 通知消息 | 包括:特别关注时稿件的自动推送、因成为契约者而自动发送的私信、包月充电回馈私信、官方发送的特定于自己的消息(如:UP主小助手的稿件审核状态通知)等 |
84 84 | 7 | Web | |
85 85 | 8 | 自动回复 - 被关注回复 | B站前端会显示“此条消息为自动回复” |
86 86 | 9 | 自动回复 - 收到消息回复 | B站前端会显示“此条消息为自动回复” |
@@ -103,11 +103,11 @@
103 103
104 104 **URL参数:**
105 105
106 | 参数名 | 类型 | 内容 | 必要性 | 备注 |
107 | ----------- | ---- | ---- | ------ | ---- |
108 | build | num | 0 | 不必要 | ? |
109 | mobi_app | str | web | 不必要 | ? |
110 | unread_type | num | 0 | 不必要 | ? |
106 | 参数名 | 类型 | 内容 | 必要性 | 备注 |
107 | ----------- | ---- | ---------------- | ------ | -------------------------------------------------------------------------- |
108 | unread_type | num | 未读类型 | 非必要 | 0:所有<br />1:仅已关注<br />2:仅未关注<br />3:仅被拦截<br />默认为 `0` |
109 | build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
110 | mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
111 111
112 112 **json回复:**
113 113
@@ -123,20 +123,20 @@
123 123
124 124 `data` 对象:
125 125
126 | 字段 | 类型 | 内容 | 备注 |
127 | ----------------------- | ---- | ---------------------- | ---------------- |
128 | unfollow_unread | num | 未关注用户未读私信数 | |
129 | follow_unread | num | 已关注用户未读私信数 | |
130 | unfollow_push_msg | num | 未读推送消息数 | |
131 | dustbin_push_msg | num | 未读被拦截的推送消息数 | |
132 | dustbin_unread | num | 未读被拦截的私信数 | |
133 | biz_msg_unfollow_unread | num | 未关注用户未读通知数 | |
134 | biz_msg_follow_unread | num | 已关注用户未读通知数 | |
135 | custom_unread | num | 未读客服消息数 | |
126 | 字段 | 类型 | 内容 | 备注 |
127 | ----------------------- | ---- | ------------------------ | ---------------- |
128 | unfollow_unread | num | 未读未关注用户私信数 | |
129 | follow_unread | num | 未读已关注用户私信数 | |
130 | unfollow_push_msg | num | 未读未关注用户推送消息数 | |
131 | dustbin_push_msg | num | 未读被拦截的推送消息数 | |
132 | dustbin_unread | num | 未读被拦截的私信数 | |
133 | biz_msg_unfollow_unread | num | 未读未关注用户通知数 | |
134 | biz_msg_follow_unread | num | 未读已关注用户通知数 | |
135 | custom_unread | num | 未读客服消息数 | |
136 136
137 137 **示例:**
138 138
139 以下信息代表未关注用户未读私信数为`1`条,已关注用户未读私信数为`6`条
139 以下信息代表未读未关注用户私信数为 `1` 条,未读已关注用户私信数为 `6` 条
140 140
141 141 ```shell
142 142 curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/single_unread' \
@@ -204,7 +204,7 @@ curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/single_unread' \
204 204 | --------------------- | ---- | ---------------------------- | ---------------------- |
205 205 | session_list | 有会话时:array<br />无会话时:null | 会话列表 | 按发送时间顺序逆向排序 |
206 206 | has_more | num | 是否有更多会话 | |
207 | anti_distrub_cleaning | bool | 是否开启“一键防骚扰”功能 | |
207 | anti_distrub_cleaning | bool | 是否开启了“一键防骚扰”功能 | |
208 208 | is_address_list_empty | num | (?) | **作用尚不明确** |
209 209 | show_level | bool | 是否在会话列表中显示用户等级 | 目前恒为 `false` |
210 210