完善note下所有api，包括列表以及内容查询 (#142)
* 增加笔记列表（note/list.md） 链接加了，但是现在是打×的，如果确认没问题就改成√ * Update list.md * note最后一环施工 note\info.md (55%) user\relation.md 纠错 * 更新 note\action.md (补充) note\info.md (65%) * 修改纠错 感谢线程（bushi）程序撕裂者 @ProgramRipper * 更新info.md 更新note\info.md (75%) * note最后更新 note\info.md 完成 note系列存疑： http://api.bilibili.com/x/note/is_gray * 修改【视频笔记】相关api * 漏写了一个对号，加上(QAQ) Co-authored-by: SocialSisterYi <45892418+SocialSisterYi@users.noreply.github.com>
This commit is contained in:
矿井小帕的血小板
195
note/info.md
Normal file
195
note/info.md
Normal file
@@ -0,0 +1,195 @@
|
||||
# 笔记详细信息
|
||||
|
||||
- [查询视频笔记](#查询视频笔记)
|
||||
- [查询笔记内容](#查询笔记内容)
|
||||
|
||||
---
|
||||
|
||||
## 查询视频笔记
|
||||
|
||||
> http://api.bilibili.com/x/note/list/archive
|
||||
|
||||
*请求方式：GET*
|
||||
|
||||
认证方式：Cookie（SESSDATA）
|
||||
|
||||
**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*
|
||||
|
||||
认证方式：Cookie（SESSDATA）
|
||||
|
||||
**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>
|
||||
Reference in New Issue
Block a user