Files
bilibili-API-collect/note/info.md
2022-02-16 18:58:04 +08:00

314 lines
18 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
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/is_forbid
*请求方式GET*
**url参数**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------ | ---- | -------- | ------ | ---- |
| aid | num | 稿件avid | 必要 | |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | --------------------------- |
| code | num | 返回值 | `0`成功<br />`-400`请求错误 |
| message | str | 错误信息 | 默认为0 |
| ttl | num | 1 | |
| data | obj | 信息本体 | |
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
| -------------------- | ---- | ------------ | ----------------------------------- |
| forbid_note_entrance | bool | 是否禁止笔记 | `true`禁止笔记<br />`false`允许笔记 |
**示例:**
查询视频稿件`av338677252`是否禁止笔记
```shell
curl 'http://api.bilibili.com/x/note/info' \
--data-urlencode 'aid=338677252'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"message": "0",
"ttl": 1,
"data": {
"forbid_note_entrance": false
}
}
```
</details>
## 查询私有笔记内容
> http://api.bilibili.com/x/note/info
*请求方式GET*
认证方式CookieSESSDATA
**url参数**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------- | ---- | ---------- | ----------- | -------- |
| oid | num | 目标id | 必要 | |
| oid_type | num | 目标id类型 | 必要 | `0`视频(oid=avid) |
| note_id | num | 笔记id | 必要 | |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ------------------------------------------------------------ |
| code | num | 返回值 | `0`成功<br />`-400`请求错误<br />`-101`账号未登录<br />`79502`笔记详情未找到<br />`79503`笔记正文未找到 |
| message | str | 错误信息 | 默认为0 |
| ttl | num | 1 | |
| data | obj | 信息本体 | |
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
| ------------ | ----- | ---------------- | -------------- |
| arc | obj | 对应视频稿件信息 | |
| audit_status | num | 0 | 作用暂不明确 |
| cid_count | num | 视频分P数 | |
| content | str | 笔记正文json序列 | 格式见[附表](readme.md#附表-笔记正文序列格式) |
| forbid_note_entrance | bool | | |
| pub_reason | str | 公开笔记相关原因 | |
| pub_status | num | 公开笔记状态 | `1`未公开<br />`2`已公开<br />`4`退回 |
| pub_version | num | | |
| summary | str | 笔记预览文本 | |
| tags | array | 笔记跳转标签列表 | |
| title | str | 笔记标题 | |
`data`中的`arc`对象:
| 字段 | 类型 | 内容 | 备注 |
| -------- | ---- | ---------- | ----------------- |
| oid | num | 目标id | |
| oid_type | num | 目标id类型 | `0`视频(oid=avid) |
| title | str | 视频标题 | |
| pic | str | 视频封面 | |
| status | num | | |
| desc | str | 视频简介 | |
`data`中的`tags`数组:
| 项 | 类型 | 内容 | 备注 |
| ---- | ---- | ----------- | ---------------- |
| 0 | obj | 标签1 | |
| n | obj | 标签n+1 | 按照笔记中位置排列 |
| …… | obj | …… | …… |
`tags`中的对象:
| 字段 | 类型 | 内容 | 备注 |
| -------- | ---- | ----------------- | ------------ |
| cid | num | 视频cid | |
| status | num | 0 | 作用尚不明确 |
| index | num | 在稿件中的分P索引 | |
| seconds | num | 视频进度 | |
| pos | num | 笔记中位置 | |
**示例:**
查询视频`av338677252`中笔记`24508729145690112`的内容
```shell
curl 'http://api.bilibili.com/x/note/info' \
--data-urlencode 'oid=338677252' \
--data-urlencode 'oid_type=0' \
--data-urlencode 'note_id=24508729145690112' \
-b 'SESSDATA=xxx'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"message": "0",
"ttl": 1,
"data": {
"title": "2022哔哩哔哩拜年纪",
"summary": " ...",
"content": "[{"insert":"\n"}]",
"cid_count": 0,
"audit_status": 0,
"pub_status": 0,
"pub_reason": "",
"pub_version": 0,
"forbid_note_entrance": false,
"tags": [],
"arc": {
"oid": 338677252,
"title": "2022哔哩哔哩拜年纪",
"status": 0,
"oid_type": 0,
"pic": "http://i2.hdslb.com/bfs/archive/1e683a5363f35aa0a65419dbf145177099e38f90.jpg",
"desc": ""
}
}
}
```
</details>
## 查询公开笔记内容
> http://api.bilibili.com/x/note/publish/info
*请求方式GET*
**url参数**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------ | ---- | ------------------ | ------ | -------- |
| cvid | num | 笔记对应的专栏cvid | 必要 | 非笔记id |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ---------------------------------------------------------- |
| code | num | 返回值 | `0`成功<br />`-400`请求错误<br />`79514`公开笔记详情未找到 |
| message | str | 错误信息 | 默认为0 |
| ttl | num | 1 | |
| data | obj | 信息本体 | |
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
| -------------------- | ----- | ---------------------- | --------------------------------------------- |
| cvid | num | 公开笔记对应的专栏cvid | |
| note_id | num | 笔记id | |
| title | str | 笔记标题 | |
| summary | str | 笔记预览 | |
| content | str | 笔记正文json序列 | 格式见[附表](readme.md#附表-笔记正文序列格式) |
| cid_count | num | (?) | |
| pub_status | num | 公开状态 | |
| tags | array | | |
| arc | obj | 稿件信息 | |
| author | obj | 作者信息 | |
| forbid_note_entrance | bool | | |
`data`中的`arc`对象:
| 字段 | 类型 | 内容 | 备注 |
| -------- | ---- | ---------- | ----------------- |
| oid | num | 目标id | |
| oid_type | num | 目标id类型 | `0`视频(oid=avid) |
| title | str | 标题 | |
| status | num | (?) | |
| pic | str | 封面url | |
| desc | str | 简介 | |
`data`中的`author`对象:
| 字段 | 类型 | 内容 | 备注 |
| -------- | ---- | ---------- | ---- |
| mid | num | 用户mid | |
| name | str | 昵称 | |
| face | str | 头像url | |
| level | num | 用户等级 | |
| vip_info | obj | 会员信息 | |
| pendant | obj | 头像框信息 | |
**示例:**
查看公开笔记`cv15160286`的信息
```shell
curl 'http://api.bilibili.com/x/note/publish/info' \
--data-urlencode 'cvid=15160286'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"message": "0",
"ttl": 1,
"data": {
"cvid": 15160286,
"note_id": 24114044116402190,
"title": "2022哔哩哔哩拜年纪",
"summary": "我决定再重新做一个系列,叫做影评系列 那么我们这一次是影系列的第n期 我也不知道是多少期,到时候回去统计一下 今天的影评是写2022年哔哩哔哩拜年纪 【...",
"content": "[{"insert":"\nn\n\n2022\n\n\n2022\n\n\n\n\n2233\n2233\n\n\n\n\n\n\n\n便\n\n\n\n\n\n\n\n\n\n[em]e107[/em]\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nb\n\nsvv\n\ncilicili\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nA-SOUL\n\n\nV\n西\n\n\n\n\n\n\n\n?\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n( -) ~\nQ\n"}]",
"cid_count": 0,
"pub_status": 2,
"tags": [],
"arc": {
"oid": 338677252,
"title": "2022哔哩哔哩拜年纪",
"status": 0,
"oid_type": 0,
"pic": "http://i2.hdslb.com/bfs/archive/1e683a5363f35aa0a65419dbf145177099e38f90.jpg",
"desc": ""
},
"author": {
"mid": 523870870,
"name": "夜达星xxxxxxx",
"face": "http://i1.hdslb.com/bfs/face/2cdfd277e63b6bb1f400ed616b5caf0a04196f28.jpg",
"level": 3,
"vip_info": {
"type": 0,
"status": 0,
"due_date": 0,
"vip_pay_type": 0,
"theme_type": 0,
"label": {
"path": "",
"text": "",
"label_theme": "",
"text_color": "",
"bg_style": 0,
"bg_color": "",
"border_color": ""
},
"avatar_subscript": 0,
"nickname_color": "",
"role": 0,
"avatar_subscript_url": ""
},
"pendant": {
"pid": 0,
"name": "",
"image": "",
"expire": 0,
"image_enhance": "",
"image_enhance_frame": ""
}
},
"forbid_note_entrance": false
}
}
```
</details>