bilibili-API-collect/note/action.md
矿井小帕的血小板 dba7650e97
完善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>
2021-02-03 00:26:27 +08:00

132 lines
4.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 笔记操作
- [保存视频笔记](#保存视频笔记)
- [删除视频笔记](#删除视频笔记)
---
## 保存视频笔记
> http://api.bilibili.com/x/note/add
*请求方式POST*
认证方式CookieSESSDATA
**正文参数( application/x-www-form-urlencoded **
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------- | ---- | ------------------------ | ------ | ------------------------------------------------------------ |
| aid | num | 目标稿件avID | 必要 | |
| note_id | num | 笔记ID | 非必要 | 创建时无需此项 |
| title | str | 笔记标题 | 必要 | |
| summary | str | 笔记预览文本 | 必要 | |
| content | str | 笔记正文json序列 | 必要 | 格式见[附表](readme.md#附表-笔记正文序列格式) |
| tags | str | 笔记跳转标签列表 | 非必要 | |
| cls | num | 1 | 非必要 | 作用尚不明确 |
| from | str | 提交类型 | 非必要 | auto自动提交<br />save手动提交<br />close关闭时自动提交 |
| csrf | str | CSRF Token位于cookie | 必要 | |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ------------------------------------------------------------ |
| code | num | 返回值 | 0成功 <br />-101账号未登录<br />-111csrf校验失败<br />-400请求错误<br />79508该稿件已存在笔记无法新增 |
| message | str | 错误信息 | 默认为0 |
| ttl | num | 1 | |
| data | obj | 数据本体 | |
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | ------------ | ---- |
| note_id | num | 笔记ID | |
**示例:**
保存内容为加粗的STRONG的笔记`3809605586518023`于`av970322090`
```shell
curl 'http://api.bilibili.com/x/note/add' \
--data-urlencode 'aid=970322090' \
--data-urlencode 'note_id=3809605586518023'
--data-urlencode 'title=周刊哔哩哔哩排行榜#543'
--data-urlencode 'summary=STRONG'
--data-urlencode 'content=[{"attributes":{"bold":true},"insert":"STRONG"},{"insert":"\n"}]'
--data-urlencode 'tags='
--data-urlencode 'cls=1'
--data-urlencode 'from=save'
--data-urlencode 'csrf=xxx'
-b 'SESSDATA=xxx'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"message": "0",
"ttl": 1,
"data": {
"note_id": 3809605586518023
}
}
```
</details>
## 删除视频笔记
> http://api.bilibili.com/x/note/del
*请求方式POST*
认证方式CookieSESSDATA
**正文参数( application/x-www-form-urlencoded **
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------- | ---- | ------------------------ | ------ | ---- |
| aid | num | 目标稿件avID | 必要 | |
| note_id | num | 笔记ID | 非必要 | |
| csrf | str | CSRF Token位于cookie | 必要 | |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ------------------------------------------------------------ |
| code | num | 返回值 | 0成功 <br />-101账号未登录<br />-111csrf校验失败<br />-400请求错误 |
| message | str | 错误信息 | 默认为0 |
| ttl | num | 1 | |
**示例:**
删除稿件`av457253380`下的笔记`4075968478576647`
```shell
curl 'http://api.bilibili.com/x/note/del' \
--data-urlencode 'aid=457253380' \
--data-urlencode 'note_id=4075968478576647' \
--data-urlencode 'csrf=xxx'
-b 'SESSDATA=xxx'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"message": "0",
"ttl": 1
}
```
</details>