diff --git a/docs/message/msg.md b/docs/message/msg.md index 7b31265..993b516 100644 --- a/docs/message/msg.md +++ b/docs/message/msg.md @@ -13,10 +13,10 @@ **URL参数:** -| 参数名 | 类型 | 内容 | 必要性 | 备注 | -| -------- | ---- | ---- | ------ | -------------------------- | -| build | num | 0 | 不必要 | 从新接口发现, 作用尚不明确 | -| mobi_app | str | web | 不必要 | 从新接口发现, 作用尚不明确 | +| 参数名 | 类型 | 内容 | 必要性 | 备注 | +| -------- | ---- | ---------------- | ------ | ------------------------- | +| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` | +| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 | **json回复:** @@ -31,20 +31,20 @@ `data` 对象: -| 字段 | 类型 | 内容 | 备注 | -| ------------- | ---- | -------------- | ---------------------- | -| at | num | 未读at数 | | -| chat | num | 0 | 作用尚不明确 | -| coin | num | 未读投币数 | | -| danmu | num | 未读弹幕数 | | -| favorite | num | 未读收藏数? | | -| like | num | 未读点赞数 | | -| recv_like | num | 未读点赞数 | | -| recv_reply | num | 未读回复数 | | -| reply | num | 未读回复数 | | -| sys_msg | num | 未读系统通知数 | | -| sys_msg_style | num | 1 | 仅新接口, 作用尚不明确 | -| up | num | UP主助手信息数 | | +| 字段 | 类型 | 内容 | 备注 | +| ------------- | ---- | -------------- | -------------------------- | +| at | num | 未读at数 | | +| chat | num | 0 | 仅旧接口,**作用尚不明确** | +| coin | num | 未读投币数 | | +| danmu | num | 未读弹幕数 | | +| favorite | num | 未读收藏数? | | +| like | num | 未读点赞数 | | +| recv_like | num | 未读点赞数 | 同 `like` | +| recv_reply | num | 未读回复数 | 同 `reply` | +| reply | num | 未读回复数 | | +| sys_msg | num | 未读系统通知数 | | +| sys_msg_style | num | 1 | 仅新接口, **作用尚不明确** | +| up | num | UP主助手信息数 | | **示例:** diff --git a/docs/message/private_msg.md b/docs/message/private_msg.md index 8d75aba..a6b5389 100644 --- a/docs/message/private_msg.md +++ b/docs/message/private_msg.md @@ -9,10 +9,10 @@ | talker_id | num | 聊天对象的id | `session_type` 为 `1` 时表示用户 mid,为 `2` 时表示粉丝团 id | | session_type | num | 聊天对象的类型 | 1:用户
2:粉丝团 | | at_seqno | num | 最近一次未读at自己的消息的序列号 | 在粉丝团会话中有效,若没有未读的 at 自己的消息则为 `0` | -| top_ts | num | 置顶该会话的时间 | 微秒级时间戳;若未置顶该会话则为 `0` | -| group_name | str | 粉丝团名称 | 在粉丝团会话中有效 | -| group_cover | str | 粉丝团头像 | 在粉丝团会话中有效 | -| is_follow | num | 是否已关注对方 | 在用户会话中有效 | +| top_ts | num | 置顶该会话的时间 | 微秒级时间戳;若未置顶该会话则为 `0`;用于判断是否置顶了会话 | +| group_name | str | 粉丝团名称 | 在粉丝团会话中有效,其他会话中为空字符串 | +| group_cover | str | 粉丝团头像 | 在粉丝团会话中有效,其他会话中为空字符串 | +| is_follow | num | 是否关注了对方 | 在用户会话中有效,其他会话中为 `0` | | is_dnd | num | 是否对会话设置了免打扰 | | | ack_seqno | num | 最近一次已读的消息序列号 | 用于快速跳转到首条未读的消息 | | ack_ts | num | 最近一次已读时间 | 微秒级时间戳 | @@ -30,7 +30,7 @@ | is_trust | num | 是否信任此会话 | 若为 `1`,则表示此会话之前被拦截过,但用户选择信任本会话 | | system_msg_type | num | 系统消息类型 | 0:非系统消息
1:主播小助手
7:UP主小助手
8:客服消息 | | account_info | obj | 会话信息 | 仅在系统消息中出现 | -| live_status | num | 用户是否正在直播 | 在用户会话中有效 | +| live_status | num | 用户是否正在直播 | 在用户会话中有效,其他会话中为 `0` | | biz_msg_unread_count | num | 未读通知消息数 | | | user_label | null | (?) | **作用尚不明确** | @@ -79,8 +79,8 @@ | 2 | Android | | | 3 | H5 | | | 4 | PC客户端 | | -| 5 | 官方自动推送 | 包括:官方向大多数用户自动发送的私信(如:UP主小助手的推广)等 | -| 6 | 自动推送/发送 | 包括:特别关注时稿件的自动推送、因成为契约者而自动发送的私信、包月充电回馈私信、官方发送的特定于自己的消息(如:UP主小助手的稿件审核状态通知)等 | +| 5 | 推送消息 | 包括:官方向大多数用户自动发送的私信(如:UP主小助手的推广)等 | +| 6 | 通知消息 | 包括:特别关注时稿件的自动推送、因成为契约者而自动发送的私信、包月充电回馈私信、官方发送的特定于自己的消息(如:UP主小助手的稿件审核状态通知)等 | | 7 | Web | | | 8 | 自动回复 - 被关注回复 | B站前端会显示“此条消息为自动回复” | | 9 | 自动回复 - 收到消息回复 | B站前端会显示“此条消息为自动回复” | @@ -103,11 +103,11 @@ **URL参数:** -| 参数名 | 类型 | 内容 | 必要性 | 备注 | -| ----------- | ---- | ---- | ------ | ---- | -| build | num | 0 | 不必要 | ? | -| mobi_app | str | web | 不必要 | ? | -| unread_type | num | 0 | 不必要 | ? | +| 参数名 | 类型 | 内容 | 必要性 | 备注 | +| ----------- | ---- | ---------------- | ------ | -------------------------------------------------------------------------- | +| unread_type | num | 未读类型 | 非必要 | 0:所有
1:仅已关注
2:仅未关注
3:仅被拦截
默认为 `0` | +| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` | +| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 | **json回复:** @@ -123,20 +123,20 @@ `data` 对象: -| 字段 | 类型 | 内容 | 备注 | -| ----------------------- | ---- | ---------------------- | ---------------- | -| unfollow_unread | num | 未关注用户未读私信数 | | -| follow_unread | num | 已关注用户未读私信数 | | -| unfollow_push_msg | num | 未读推送消息数 | | -| dustbin_push_msg | num | 未读被拦截的推送消息数 | | -| dustbin_unread | num | 未读被拦截的私信数 | | -| biz_msg_unfollow_unread | num | 未关注用户未读通知数 | | -| biz_msg_follow_unread | num | 已关注用户未读通知数 | | -| custom_unread | num | 未读客服消息数 | | +| 字段 | 类型 | 内容 | 备注 | +| ----------------------- | ---- | ------------------------ | ---------------- | +| unfollow_unread | num | 未读未关注用户私信数 | | +| follow_unread | num | 未读已关注用户私信数 | | +| unfollow_push_msg | num | 未读未关注用户推送消息数 | | +| dustbin_push_msg | num | 未读被拦截的推送消息数 | | +| dustbin_unread | num | 未读被拦截的私信数 | | +| biz_msg_unfollow_unread | num | 未读未关注用户通知数 | | +| biz_msg_follow_unread | num | 未读已关注用户通知数 | | +| custom_unread | num | 未读客服消息数 | | **示例:** -以下信息代表未关注用户未读私信数为`1`条,已关注用户未读私信数为`6`条 +以下信息代表未读未关注用户私信数为 `1` 条,未读已关注用户私信数为 `6` 条 ```shell 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' \ | --------------------- | ---- | ---------------------------- | ---------------------- | | session_list | 有会话时:array
无会话时:null | 会话列表 | 按发送时间顺序逆向排序 | | has_more | num | 是否有更多会话 | | -| anti_distrub_cleaning | bool | 是否开启“一键防骚扰”功能 | | +| anti_distrub_cleaning | bool | 是否开启了“一键防骚扰”功能 | | | is_address_list_empty | num | (?) | **作用尚不明确** | | show_level | bool | 是否在会话列表中显示用户等级 | 目前恒为 `false` |