bilibili-API-collect/note/info.md

195 lines
5.9 KiB
Markdown
Raw Normal View History

# 笔记详细信息
- [查询视频笔记](#查询视频笔记)
- [查询笔记内容](#查询笔记内容)
---
## 查询视频笔记
> http://api.bilibili.com/x/note/list/archive
*请求方式GET*
认证方式CookieSESSDATA
**url参数**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------- | ---- | ------------ | ----------- | -------- |
| aid | num | 稿件avid | 必要(可选) | avid与bvid任选一个 |
| bvid | str | 稿件bvid | 必要(可选) | avid与bvid任选一个 |
| csrf | str | CSRF Token位于cookie | 非必要 | |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | --------------------------------------------------- |
| code | num | 返回值 | 0成功<br />-400请求错误<br />-101账号未登录 |
| message | str | 错误信息 | 默认为0 |
| ttl | num | 1 | |
| data | obj | 信息本体 | |
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ----- | -------- | -------------------------------------------------- |
| noteIds | array | 笔记列表 | 无笔记则无此项<br />可能后续会允许视频添加多个笔记 |
`data`中的`noteIds`数组:
| 项 | 类型 | 内容 | 备注 |
| ---- | ---- | ----------- | ---------------- |
| 0 | num | 笔记id | |
**示例:**
查询视频`av970322090`/`BV1op4y167Uo`的笔记id
avid方式
```shell
curl 'http://api.bilibili.com/x/note/list/archive' \
--data-urlencode 'aid=970322090' \
-b 'SESSDATA=xxx'
```
bvid方式
```shell
curl 'http://api.bilibili.com/x/note/list/archive' \
--data-urlencode 'bvid=BV1op4y167Uo' \
-b 'SESSDATA=xxx'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code":0,
"message":"0",
"ttl":1,
"data":{
"noteIds":[
3809605586518023
]
}
}
```
</details>
## 查询笔记内容
> http://api.bilibili.com/x/note/info
*请求方式GET*
认证方式CookieSESSDATA
**url参数**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------- | ---- | ---------- | ----------- | -------- |
| aid | num | 稿件avid | 必要(可选)| avid与bvid任选一个不与笔记所属稿件avid相同不影响返回 |
| bvid | str | 稿件bvid | 必要(可选)| avid与bvid任选一个不与笔记所属稿件bvid相同不影响返回 |
| note_id | num | 笔记id | 必要 | |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | --------------------------------------------------- |
| code | num | 返回值 | 0成功<br />-400请求错误<br />-101账号未登录<br />79502笔记详情未找到|
| message | str | 错误信息 | 默认为0 |
| ttl | num | 1 | |
| data | obj | 信息本体 | |
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
| ------------ | ----- | ---------------- | -------------- |
| title | str | 笔记标题 | |
| summary | str | 笔记预览文本 | |
| content | str | 笔记正文json序列 | 格式见[附表](readme.md#附表-笔记正文序列格式) |
| tags | array | 笔记跳转标签列表 | |
| cid_count | num | 视频分P数 | |
| audit_status | num | 0 | 作用暂不明确 |
| aid | num | 稿件avid | |
`data`中的`tags`数组:
| 项 | 类型 | 内容 | 备注 |
| ---- | ---- | ----------- | ---------------- |
| 0 | obj | 标签1 | |
| n | obj | 标签n+1 | 按照笔记中位置排列 |
| …… | obj | …… | …… |
`tags`中的对象:
| 字段 | 类型 | 内容 | 备注 |
| -------- | ---- | ----------------- | ------------ |
| cid | num | 视频cid | |
| status | num | 0 | 作用尚不明确 |
| index | num | 在稿件中的分P索引 | |
| seconds | num | 视频进度 | |
| pos | num | 笔记中位置 | |
**示例:**
查询视频`av583785685`/`BV1kz4y1X7XP`中笔记`7165769906913287`的内容
avid方式
```shell
curl 'http://api.bilibili.com/x/note/info' \
--data-urlencode 'aid=583785685' \
--data-urlencode 'note_id=7165769906913287' \
-b 'SESSDATA=xxx'
```
bvid方式
```shell
curl 'http://api.bilibili.com/x/note/info' \
--data-urlencode 'bvid=BV1kz4y1X7XP' \
--data-urlencode 'note_id=7165769906913287' \
-b 'SESSDATA=xxx'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code":0,
"message":"0",
"ttl":1,
"data":{
"title":"【cmd】访问api 命令行也能上B站",
"summary":"项目介绍 才324个star哦7月4日没事了 二维码登录流程介绍 正式开",
"content":"{
"insert":{
"tag":{
"cid":209620774,
"status":0,
"index":1,
"seconds":5,
"cidCount":1,
"key":"1611921905204",
"title":"【cmd】访问api 命令行也能上B站_x264"
}
}
}..."
"cid_count":1,
"audit_status":0,
"aid":583785685
}
}
```
</details>