mirrors/bilibili-API-collect
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
2ecfe2aa82f161ea6c0edbf1c224c21783b38f8e
bilibili-API-collect/docs/message/msg.md
T

259 lines
11 KiB
Markdown
Raw Normal View History

🚀调整项目结构
2023-02-22 01:00:06 +08:00
# 通知消息
feat: 添加消息中心接口相关说明 (#983)
2024-09-20 21:22:06 +08:00
## 获取未读消息数
🚀调整项目结构
2023-02-22 01:00:06 +08:00
style(message): wrap URL with brackets & replace tabs with spaces
2025-05-05 02:58:39 +08:00
> <https://api.bilibili.com/x/msgfeed/unread>
feat & fix: update docs & fix typo in issue template
2025-04-26 02:02:17 +08:00
style(message): wrap URL with brackets & replace tabs with spaces
2025-05-05 02:58:39 +08:00
> <https://api.vc.bilibili.com/x/im/web/msgfeed/unread> (新接口)
🚀调整项目结构
2023-02-22 01:00:06 +08:00
*请求方式：GET*
认证方式：Cookie（SESSDATA）
feat: 添加消息中心接口相关说明 (#983)
2024-09-20 21:22:06 +08:00
本接口不会返回未读的私信数，要获取未读的私信数请参阅[未读私信数](private_msg.md#未读私信数)相关说明
feat: 更新部分接口 (#1056)
2024-07-20 18:38:49 +08:00
**URL参数:**
feat: 添加消息中心接口相关说明 (#983)
2024-09-20 21:22:06 +08:00
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| -------- | ---- | ---------------- | ------ | ------------------------- |
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
feat: 更新部分接口 (#1056)
2024-07-20 18:38:49 +08:00
🚀调整项目结构
2023-02-22 01:00:06 +08:00
**json回复：**
根对象：
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ----------------------------- |
| code | num | 返回值 | 0：成功<br />-101：账号未登录 |
| message | str | 错误信息 | 默认为0 |
| ttl | num | 1 | |
| data | obj | 信息本体 | |
feat: 更新部分接口 (#1056)
2024-07-20 18:38:49 +08:00
`data` 对象：
🚀调整项目结构
2023-02-22 01:00:06 +08:00
fix(message): #1329
2025-07-04 19:13:03 +08:00
| 字段 | 类型 | 内容 | 备注 |
| --------------- | ---- | -------------------- | --------------------------- |
| at | num | 未读at数（旧） | |
| chat | num | 0 | 仅旧接口，**作用尚不明确** |
| coin | num | 未读投币数 | |
| danmu | num | 未读弹幕数 | |
| favorite | num | 未读收藏数 | |
| like | num | 未读点赞数（旧） | |
| recv\_like | num | 未读收到喜欢数（新） | 同 `like` |
| recv\_reply | num | 未读回复与@数（新） | 即 `reply` 与 `at` 的值之和 |
| reply | num | 未读回复数（旧） | |
| sys\_msg | num | 未读系统通知数 | |
| sys\_msg\_style | num | 1 | 仅新接口, **作用尚不明确** |
| up | num | 未读UP主助手信息数 | |
🚀调整项目结构
2023-02-22 01:00:06 +08:00
**示例：**
feat: 添加消息中心接口相关说明 (#983)
2024-09-20 21:22:06 +08:00
以下信息代表了未读点赞数为10，未读回复数为4，未读at消息数为3，未读系统通知数为2，未读UP主助手信息数为1
🚀调整项目结构
2023-02-22 01:00:06 +08:00
```shell
feat: 更新部分接口 (#1056)
2024-07-20 18:38:49 +08:00
curl 'https://api.vc.bilibili.com/x/im/web/msgfeed/unread' \
style(message): wrap URL with brackets & replace tabs with spaces
2025-05-05 02:58:39 +08:00
-b 'SESSDATA=xxx'
🚀调整项目结构
2023-02-22 01:00:06 +08:00
```
<details>
<summary>查看响应示例：</summary>
```json
{
style(message): wrap URL with brackets & replace tabs with spaces
2025-05-05 02:58:39 +08:00
"code": 0,
"message": "0",
"ttl": 1,
"data": {
"at": 3,
"chat": 0,
"coin": 0,
"danmu": 0,
"favorite": 0,
"like": 10,
"recv_like": 10,
"recv_reply": 4,
"reply": 4,
"sys_msg": 2,
"sys_msg_style": 1,
"up": 1
}
🚀调整项目结构
2023-02-22 01:00:06 +08:00
}
```
</details>
feat:新增"回复我的"接口 /x/msgfeed/reply (#1309)
2025-06-22 02:29:20 +08:00
## 获取"回复我的"信息
> <https://api.bilibili.com/x/msgfeed/reply>
*请求方式：GET*
认证方式：Cookie（SESSDATA）
**URL参数:**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------------ | ---- | ---------------- | ------ | ------------- |
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
| id | num | 起始 id | 非必要 | 详情见返回 |
| reply_time | num | 起始时间 | 非必要 | 详情见返回 |
| platform | str | 平台标识 | 非必要 | 可为 `web` 等 |
| web_location | str | 暂时不知道是啥 | 非必要 | |
**json回复：**
根对象：
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ----------------------------- |
| code | num | 返回值 | 0：成功<br />-101：账号未登录 |
| message | str | 错误信息 | 默认为 0 |
| ttl | num | 1 | |
| data | obj | 信息本体 | |
`data` 对象：
| 字段 | 类型 | 内容 | 备注 |
| ------------ | ----- | ----------- | ------------------------------ |
| cursor | obj | 光标 | 下一次查询的指针 |
| items | array | 通知列表 | 数组，每个元素代表一条回复通知 |
| last_view_at | num | unix 时间戳 | 上次查看的时间 |
`cursor` 对象：
| 字段 | 类型 | 内容 | 备注 |
| ------ | ---- | ----------- | ---------------------------------------------- |
| is_end | bool | 是否结束 | `false` 表示还有更多数据 |
| id | num | 通知 id | 最后（旧）一条通知的 id，用作下次查询的起始 id |
| time | num | unix 时间戳 | 最后一条通知的时间 |
`items` 数组中的对象（每条通知）：
| 字段 | 类型 | 内容 | 备注 |
| ---------- | ---- | -------------------- | ---------------------------- |
| id | num | 通知 id | |
| user | obj | **回复者**的用户信息 | |
| item | obj | 通知详情 | |
| counts | num | 通知计数 | 固定为 `1`，可能表示单条通知 |
| is_multi | num | 是否多回复 | 固定为 `0`，可能表示单条回复 |
| reply_time | num | unix 时间戳 | 回复时间 |
`user` 对象（回复者信息）：
| 字段 | 类型 | 内容 | 备注 |
| -------- | ---- | -------------- | ------------------------------ |
| mid | num | 用户 mid | |
| fans | num | 粉丝数 | 固定为 `0`，可能不返回实际数据 |
| nickname | str | 用户昵称 | |
| avatar | str | 头像 URL | |
| mid_link | str | 用户主页链接 | 固定为空字符串 |
| follow | bool | 是否关注该用户 | `false` 表示未关注 |
`item` 对象（通知详情）：
| 字段 | 类型 | 内容 | 备注 |
| -------------------- | ----- | ---------------- | ----------------------------- |
| subject_id | num | 主体 id | |
| root_id | num | 根评论 id | 最顶层的评论 ID |
| source_id | num | 源评论 id | 直接回复的评论 ID |
| target_id | num | 目标评论 id | 被回复的评论 ID |
| type | str | 通知类型 | 固定为 `"reply"`（回复类型） |
| business_id | num | 业务类型 id | `1`=视频评论，`11`=动态评论 |
| business | str | 业务名称 | `"评论"` 或 `"视频"` |
| title | str | 通知标题 | 摘要文本 |
| desc | str | 描述 | 固定为空字符串 |
| image | str | 图片 URL | 固定为空字符串 |
| uri | str | 跳转链接 | web 端跳转链接 |
| native_uri | str | 客户端跳转链接 | 客户端专用跳转链接 |
| detail_title | str | 详细标题 | 固定为空字符串 |
| root_reply_content | str | 根评论内容 | 最顶层评论的文本内容 |
| source_content | str | 源评论内容 | 直接回复的评论内容 |
| target_reply_content | str | 目标评论内容 | 被回复的评论内容 |
| at_details | array | @的用户列表 | 数组，每个元素是被@的用户对象 |
| topic_details | array | 话题详情 | 固定为空数组 |
| hide_reply_button | bool | 是否隐藏回复按钮 | |
| hide_like_button | bool | 是否隐藏点赞按钮 | |
| like_state | num | 点赞状态 | `0`=未点赞 |
| danmu | null | 弹幕信息 | 固定为 `null` |
| message | str | 消息内容 | 固定为空字符串 |
`at_details` 数组中的对象（被@的用户）：
| 字段 | 类型 | 内容 | 备注 |
| -------- | ---- | -------------- | ------------------ |
| mid | num | 用户 mid | |
| fans | num | 粉丝数 | 固定为 `0` |
| nickname | str | 用户昵称 | |
| avatar | str | 头像 URL | |
| mid_link | str | 用户主页链接 | 固定为空字符串 |
| follow | bool | 是否关注该用户 | `false` 表示未关注 |
**示例：**
```shell
curl 'https://api.bilibili.com/x/msgfeed/reply' \
-b 'SESSDATA=xxx'
```
<details>
<summary>查看响应示例：</summary>
```json
{
"code": 0,
"message": "0",
"data": {
"cursor": {
"is_end": true,
"id": 823260581625886,
"time": 1749474709
},
"items": [{
"id": 823260581625886,
"user": {
"mid": 3546910497441845,
"fans": 0,
"nickname": "佘总累了",
"avatar": "https://i2.hdslb.com/bfs/face/e45c62bd47729e07dd01a788988be865ed3d210e.jpg",
"mid_link": "",
"follow": false
},
"item": {
"subject_id": 1073543151725051921,
"root_id": 0,
"source_id": 265141324256,
"target_id": 0,
"type": "dynamic",
"business_id": 17,
"business": "动态",
"title": "我已成为哔哩哔哩第245743680位转正会员，挑战转正答题考试获得60分。",
"desc": "",
"image": "",
"uri": "https://www.bilibili.com/opus/1073543151725051921#reply265141324256",
"native_uri": "bilibili://opus/detail/1073543151725051921?comment_root_id=265141324256&comment_on=1",
"detail_title": "",
"root_reply_content": "",
"source_content": "60",
"target_reply_content": "",
"at_details": [],
"topic_details": [],
"hide_reply_button": false,
"hide_like_button": false,
"like_state": 0,
"danmu": null,
"message": ""
},
"counts": 1,
"is_multi": 0,
"reply_time": 1749474709
}],
"last_view_at": 1749474724
}
}
```
</details>
Reference in New Issue Copy Permalink