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

XFEstudio/bilibili-API-collect

update docs

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

代码差异

2 个文件 +36 -37
Modified docs/message/private_msg.md +24 -24
@@ -12,7 +12,7 @@
12 12 | top_ts | num | 置顶该会话的时间 | 微秒级时间戳;若未置顶该会话则为 `0`;用于判断是否置顶了会话 |
13 13 | group_name | str | 粉丝团名称 | 在粉丝团会话中有效,其他会话中为空字符串 |
14 14 | group_cover | str | 粉丝团头像 | 在粉丝团会话中有效,其他会话中为空字符串 |
15 | is_follow | num | 是否关注了对方 | 在用户会话中有效,其他会话中为 `0` |
15 | is_follow | num | 是否关注了对方 | 在用户会话中有效,系统会话中为 `1`, 其他会话中为 `0` |
16 16 | is_dnd | num | 是否对会话设置了免打扰 | |
17 17 | ack_seqno | num | 最近一次已读的消息序列号 | 用于快速跳转到首条未读的消息 |
18 18 | ack_ts | num | 最近一次已读时间 | 微秒级时间戳 |
@@ -28,7 +28,7 @@
28 28 | is_guardian | num | 自己是否为对方的骑士(?) | 在用户会话中有效<br />0:否<br />2:是(?) |
29 29 | is_intercept | num | 会话是否被拦截 | |
30 30 | is_trust | num | 是否信任此会话 | 若为 `1`,则表示此会话之前被拦截过,但用户选择信任本会话 |
31 | system_msg_type | num | 系统会话类型 | 0:非系统会话<br />1:主播小助手<br />5:系统通知(?)<br />7:UP主小助手<br />8:客服消息 |
31 | system_msg_type | num | 系统会话类型 | 0:非系统会话<br />1:主播小助手<br />5:系统通知(?)<br />7:UP主小助手<br />8:客服消息<br />9:支付小助手 |
32 32 | account_info | obj | 会话信息 | 仅在系统会话中出现 |
33 33 | live_status | num | 用户是否正在直播 | 在用户会话中有效,其他会话中为 `0` |
34 34 | biz_msg_unread_count | num | 未读通知消息数 | |
@@ -90,7 +90,7 @@
90 90 | 13 | 粉丝团系统提示 | 如:粉丝团中的提示信息“欢迎xxx入群” |
91 91 | 16 | 系统 | 目前仅在 `msg_type` 为 `51` 时使用该代码 |
92 92 | 17 | 互相关注 | 互相关注时自动发送的私信“我们已互相关注,开始聊天吧~” |
93 | 18 | 系统提示 | 如:“对方主动回复或关注你前,最多发送1条消息” |
93 | 18 | 系统提示 | 目前仅在 `msg_type` 为 `18` 时使用该代码,如:“对方主动回复或关注你前,最多发送1条消息” |
94 94 | 19 | AI | 如:给[搜索AI助手测试版](https://space.bilibili.com/1400565964/)发送私信时对方的自动回复 |
95 95
96 96 ## 获取未读私信数
@@ -155,20 +155,20 @@ curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/single_unread' \
155 155
156 156 ```json
157 157 {
158 "code": 0,
159 "msg": "0",
160 "message": "0",
161 "ttl": 1,
162 "data": {
163 "unfollow_unread": 1,
164 "follow_unread": 6,
165 "unfollow_push_msg": 0,
166 "dustbin_push_msg": 0,
167 "dustbin_unread": 0,
168 "biz_msg_unfollow_unread": 0,
169 "biz_msg_follow_unread": 0,
170 "custom_unread": 0
171 }
158 "code": 0,
159 "msg": "0",
160 "message": "0",
161 "ttl": 1,
162 "data": {
163 "unfollow_unread": 1,
164 "follow_unread": 6,
165 "unfollow_push_msg": 0,
166 "dustbin_push_msg": 0,
167 "dustbin_unread": 0,
168 "biz_msg_unfollow_unread": 0,
169 "biz_msg_follow_unread": 0,
170 "custom_unread": 0
171 }
172 172 }
173 173 ```
174 174
@@ -395,7 +395,8 @@ curl -G 'https://api.vc.bilibili.com/session_svr/v1/session_svr/get_sessions' \
395 395 "is_address_list_empty": 0,
396 396 "system_msg": {
397 397 "1": 844424930131967,
398 "7": 844424930131966
398 "7": 844424930131966,
399 "9": 844424930131965
399 400 },
400 401 "show_level": true
401 402 }
@@ -1343,7 +1344,7 @@ public class Main {
1343 1344 | msg_content | str | 发送的私信内容 | 一般同请求参数 `msg[content]` 的值,仅当请求参数 `msg[msg_type]` 为 `1` 时有此项 |
1344 1345 | key_hit_infos | obj | 触发的提示 | 仅当请求参数 `msg[msg_type]` 为 `1` 且 `msg[receiver_type]` 为 `1` 时有此项 |
1345 1346
1346 `data`对象中的`e_infos`数组:
1347 `e_infos`数组:
1347 1348
1348 1349 | 项 | 类型 | 内容 | 备注 |
1349 1350 | ---- | ---- | --------- | ---- |
@@ -1351,7 +1352,7 @@ public class Main {
1351 1352 | n | obj | 表情(n+1) | |
1352 1353 | …… | obj | …… | …… |
1353 1354
1354 `data`对象中的`e_infos`数组中的对象:
1355 `e_infos`数组中的对象:
1355 1356
1356 1357 | 字段 | 类型 | 内容 | 备注 |
1357 1358 | ------- | ---- | ----------- | ----------------------------------- |
@@ -1360,7 +1361,7 @@ public class Main {
1360 1361 | size | num | 表情尺寸 | 1:小<br />2:大 |
1361 1362 | gif_url | str | 表情GIF链接 | 仅部分表情存在此项,如小电视表情 |
1362 1363
1363 `data`对象中的`key_hit_infos`对象:
1364 `key_hit_infos`对象:
1364 1365
1365 1366 | 字段 | 类型 | 内容 | 备注 |
1366 1367 | --------- | ----- | ------------ | -------------------------------------- |
@@ -1368,7 +1369,7 @@ public class Main {
1368 1369 | rule_id | num | 触发的规则id | 当触发了提示时有此项,详细信息有待补充 |
1369 1370 | high_text | array | 高亮的文本 | 当触发了提示时有此项 |
1370 1371
1371 `data`对象中的`key_hit_infos`对象中的`high_text`数组:
1372 `high_text`数组:
1372 1373
1373 1374 | 项 | 类型 | 内容 | 备注 |
1374 1375 | ---- | ---- | ------------- | ---------------- |
@@ -1380,8 +1381,7 @@ public class Main {
1380 1381
1381 1382 给目标用户`mid=1`发一条文字私信:
1382 1383
1383 > up主你好,
1384 > 催更[doge]
1384 > up主你好,<br />催更[doge]
1385 1385
1386 1386 ```shell
1387 1387 curl 'https://api.vc.bilibili.com/web_im/v1/web_im/send_msg' \
Modified docs/message/private_msg_content.md +12 -13
@@ -386,7 +386,6 @@
386 386 }
387 387 ```
388 388
389
390 389 ### 图片卡片消息(`msg_type=13`)
391 390
392 391 此类型消息仅可接收,**不可直接发送**
@@ -461,18 +460,18 @@
461 460
462 461 `sub_cards`数组中的对象:
463 462
464 | 字段 | 类型 | 内容 | 备注 |
465 | --------- | ---- | ------------------ | -------------------------------- |
466 | card_id | num | 稿件AV号 | |
467 | card_type | num | 稿件类型 | 一般为 `1` |
468 | jump_url | str | 稿件链接 | |
469 | cover_url | str | 稿件封面url | 此项不实时更新,在发送私信时设置 |
470 | field1 | str | 稿件标题 | 此项不实时更新,在发送私信时设置 |
471 | field2 | str | 稿件发布时间 | 格式:`YYYY-MM-DD` |
472 | field3 | str | 稿件播放量显示文字 | 此项不实时更新,在发送私信时设置 |
473 | icon3 | num | 图标3类型 | 1:播放量 |
474 | field4 | str | 稿件弹幕数显示文字 | 此项不实时更新,在发送私信时设置 |
475 | icon4 | num | 图标4类型 | 3:弹幕数 |
463 | 字段 | 类型 | 内容 | 备注 |
464 | --------- | ---- | ------------ | -------------------------------- |
465 | card_id | num | 稿件AV号 | |
466 | card_type | num | 稿件类型 | 一般为 `1` |
467 | jump_url | str | 稿件链接 | |
468 | cover_url | str | 稿件封面url | 此项不实时更新,在发送私信时设置 |
469 | field1 | str | 稿件标题 | 此项不实时更新,在发送私信时设置 |
470 | field2 | str | 稿件发布时间 | 格式:`YYYY-MM-DD` |
471 | field3 | str | 字段3 | 此项不实时更新,在发送私信时设置 |
472 | icon3 | num | 图标3类型 | 1:播放量<br />3:弹幕数<br />5:收藏量 |
473 | field4 | str | 字段4 | 此项不实时更新,在发送私信时设置 |
474 | icon4 | num | 图标4类型 | 1:播放量<br />3:弹幕数<br />5:收藏量 |
476 475
477 476 **示例:**
478 477