feat: 更新包月充电、获取用户信息、用户关系相关说明 (#981)

* Update charge_list.md

* Update charge_msg.md

* Update relation.md

* Update relation.md

* update

* Update monthly.md

* Update monthly.md

* update

* Update charge_list.md

* Update relation.md

* Update monthly.md

* Update README.md

* Update charge_list.md

* update

* Update relation.md

* Update relation.md

* Update relation.md

* Update info.md

* update
This commit is contained in:
wuziqian211
2024-03-10 18:53:43 +08:00
committed by GitHub
parent 4645c1ef9a
commit f9ee5c3b99
7 changed files with 450 additions and 367 deletions

View File

@@ -6,25 +6,27 @@
### 关系列表对象
| 字段 | 类型 | 内容 | 备注 |
| --------------- | ------------------------------------------- | --------------- | ------------------------------------------------------------ |
| mid | num | 用户 mid | |
| attribute | num | 关注属性 | 0未关注<br />1已关注<br />2已关注<br />6已互粉<br />128已拉黑 |
| mtime | num | 关注对方时间 | 时间戳<br />互关后刷新 |
| tag | 默认分组null<br />存在至少一个分组array | 分组 id | |
| special | num | 特别关注标志 | 0<br />1是 |
| contract_info | obj | | |
| uname | str | 用户昵称 | |
| face | str | 用户头像url | |
| face_nft | num | 是否为 NFT 头像 | 0非 NFT 头像<br />1NFT 头像 |
| sign | str | 用户签名 | |
| official_verify | obj | 认证信息 | |
| vip | obj | 会员信息 | |
| nft_icon | str | | |
| rec_reason | str | | |
| track_id | str | | |
以下说明中的 “目标用户” 指被查询的用户,“对方” 指返回的关系列表中的用户。
数组`list`中的对象中的`tag`数组:
| 字段 | 类型 | 内容 | 备注 |
| --------------- | ------------------------------------------- | -------------------------- | ------------------------------------------------------------ |
| mid | num | 用户 mid | |
| attribute | num | 对方对于**自己**的关系属性 | 0未关注<br />1悄悄关注现已下线<br />2已关注<br />6已互粉<br />128已拉黑 |
| mtime | num | 对方关注目标用户时间 | 秒级时间戳<br />互关后刷新 |
| tag | 默认分组null<br />存在至少一个分组array | 目标用户将对方分组到的 id | |
| special | num | 目标用户特别关注对方标识 | 0<br />1是 |
| contract_info | obj | 契约计划相关信息 | |
| uname | str | 用户昵称 | |
| face | str | 用户头像url | |
| face_nft | num | 是否为 NFT 头像 | 0非 NFT 头像<br />1NFT 头像 |
| sign | str | 用户签名 | |
| official_verify | obj | 认证信息 | |
| vip | obj | 会员信息 | |
| nft_icon | str | | |
| rec_reason | str | | |
| track_id | str | | |
`list`中的对象中的`tag`数组:
| 项 | 类型 | 内容 | 备注 |
| ---- | ---- | ------------------------ | ---- |
@@ -32,11 +34,21 @@
| n | num | 位于分组n+1的分组 id | |
| …… | num | …… | …… |
`list`中的对象中的`contract_info`对象:
| 字段 | 类型 | 内容 | 备注 |
| ------------- | ---- | ------------------------------ | ----------------------------------------------------------- |
| is_contract | bool | 目标用户是否为对方的契约者 | 仅当为 `true` 时才有此项 |
| is_contractor | bool | 对方是否为目标用户的契约者 | 仅当为 `true` 时才有此项 |
| ts | num | 对方成为目标用户的契约者的时间 | 秒级时间戳,仅当 `is_contractor` 项的值为 `true` 时才有此项 |
| user_attr | num | 对方作为目标用户的契约者的属性 | 1老粉<br />否则为原始粉丝<br />仅当有特殊属性时才有此项 |
`list`中的对象中的`official_verify`对象:
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ------------ | ------------------- |
| type | num | 用户认证类型 | -1<br />1认证 |
| type | num | 用户认证类型 | -1<br />0UP 主认证<br />1机构认证 |
| desc | str | 用户认证信息 | 无为空 |
`list`中的对象中的`vip`对象:
@@ -66,7 +78,9 @@
认证方式CookieSESSDATA或 APP
登录可看当前用户前 1000 名,其他用户可查看前 250 名(网页端请求时`ps`为 20所以直接查看只能看到前 100 名)
本接口只有登录、标头 `referer``bilibili.com` 下的子域名、UA 不含 `python` 时才会返回列表
**本接口仅可返回前 1000 名粉丝**,若继续往后查询则返回空列表
**url参数**
@@ -75,7 +89,7 @@
| access_key | str | APP 登录 Token | APP 方式必要 | |
| vmid | num | 目标用户 mid | 必要 | |
| ps | num | 每页项数 | 非必要 | 默认为 50 |
| pn | num | 页码 | 非必要 | 默认为 1<br />其他用户仅可查看前 5 页 |
| pn | num | 页码 | 非必要 | 默认为 1<br />仅可查看前 1000 名粉丝 |
**json回复**
@@ -83,7 +97,7 @@
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ----------------------------------------------------- |
| code | num | 返回值 | 0成功<br />-400请求错误<br />22007访问超过 5 页 |
| code | num | 返回值 | 0成功<br />-101账号未登录<br />-352请求被拦截<br />-400请求错误<br />22007访问超过 5 页 |
| message | str | 错误信息 | 默认为 0 |
| ttl | num | 1 | |
| data | obj | 信息本体 | |
@@ -192,7 +206,9 @@ curl -G 'https://api.bilibili.com/x/relation/followers' \
认证方式CookieSESSDATA或 APP
登录可看当前用户全部其他用户仅可查看前5页
本接口只有登录、标头 `referer``bilibili.com` 下的子域名、UA 不含 `python` 时才会返回列表
登录可看当前用户全部,其他用户仅可查看前 100 个,访问超过 100 个时返回空列表(但 `code` 值为 `0`
**url参数**
@@ -200,20 +216,20 @@ curl -G 'https://api.bilibili.com/x/relation/followers' \
| ---------- | ---- | -------------- | ------------ | ------------------------------------------------------- |
| access_key | str | APP 登录 Token | APP 方式必要 | |
| vmid | num | 目标用户 mid | 必要 | |
| order_type | str | 排序方式 | 非必要 | 按照关注顺序排列:留空<br />按照最常访问排列attention |
| order_type | str | 排序方式 | 非必要 | 当目标用户为自己时有效<br />按照关注顺序排列:留空<br />按照最常访问排列attention |
| ps | num | 每页项数 | 非必要 | 默认为 50 |
| pn | num | 页码 | 非必要 | 默认为 1<br />其他用户仅可查看前 5 页 |
| pn | num | 页码 | 非必要 | 默认为 1<br />其他用户仅可查看前 100 个 |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ------------------------------------------------------------ |
| code | num | 返回值 | 0成功<br />-400请求错误<br />22007访问超过 5 页<br />22115用户已设置隐私无法查看 |
| message | str | 错误信息 | 默认为 0 |
| ttl | num | 1 | |
| data | obj | 信息本体 | |
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ---------------------------------------------------------------- |
| code | num | 返回值 | 0成功<br />-101账号未登录<br />-352请求被拦截<br />-400请求错误<br />22115用户已设置隐私无法查看 |
| message | str | 错误信息 | 默认为 0 |
| ttl | num | 1 | |
| data | obj | 信息本体 | |
`data`对象:
@@ -318,7 +334,7 @@ curl -G 'https://api.bilibili.com/x/relation/followings' \
*请求方式GET*
仅可查看前 5 页,可以获取已设置可见性隐私关注列表
仅可查看前 5 页,对于已设置可见性隐私关注列表的用户,`$.data.list` 为 null`$.data.total` 为0
**url参数**
@@ -384,7 +400,7 @@ curl -G 'https://api.bilibili.com/x/relation/followings' \
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ------------ | ------------------- |
| type | num | 用户认证类型 | -1<br />1认证 |
| type | num | 用户认证类型 | -1<br />0UP主认证<br />1机构认证 |
| desc | str | 用户认证信息 | 无为空 |
`list`中的对象中的`vip`对象:
@@ -485,6 +501,96 @@ curl -G 'https://app.biliapi.net/x/v2/relation/followings' \
</details>
## 查询用户关注明细3
<img src="../../assets/img/relation.svg" width="100" height="100" />
> https://line3-h5-mobile-api.biligame.com/game/center/h5/user/relationship/following_list
*请求方式GET*
对于设置了可见性隐私关注列表的用户会返回空列表
**url参数**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------ | ---- | ------------ | ----------- | -------- |
| vmid | num | 目标用户mid | 必要 | |
| ps | num | 每页项数 | 非必要 | 默认为20 |
| pn | num | 页码 | 非必要 | 默认为1 |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ---------- | ---- | ---------- | --------------------------- |
| code | num | 返回值 | 0成功<br />-400请求错误 |
| message | str | 错误信息 | 成功时无此项 |
| data | obj | 信息本体 | 失败时无此项 |
| ts | num | 当前时间戳 | 单位为毫秒 |
| request_id | str | 请求id | |
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
| ---------- | ----- | -------- | ------------ |
| list | array | 明细列表 | |
`data`中的`list`数组:
| 项 | 类型 | 内容 | 备注 |
| ---- | ---- | --------- | ---------------- |
| 0 | obj | 关注1 | |
| n | obj | 关注(n+1) | 按照关注顺序排列 |
| …… | obj | …… | …… |
数组`list`中的对象:
| 字段 | 类型 | 内容 | 备注 |
| --------------- | ---- | ----------- | --------------------------------------- |
| mid | str | 用户mid | |
| attribute | num | 关注属性 | 0未关注<br />2已关注<br />6已互粉 |
| uname | str | 用户昵称 | |
| face | str | 用户头像url | |
**示例:**
获取用户`mid=293793435`的关注明细
```shell
curl -G 'https://line3-h5-mobile-api.biligame.com/game/center/h5/user/relationship/following_list' \
--data-urlencode 'vmid=293793435' \
--data-urlencode 'ps=2' \
--data-urlencode 'pn=1'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"data": {
"list": [{
"mid": "14082",
"attribute": 2,
"uname": "山新",
"face": "https://i0.hdslb.com/bfs/face/74c82caee6d9eb623e56161ea8ed6d68afabfeae.jpg"
}, {
"mid": "420831218",
"attribute": 2,
"uname": "支付宝Alipay",
"face": "https://i2.hdslb.com/bfs/face/aaf18aeb2d9822e28a590bd8d878572ca8c59e04.jpg"
}]
},
"ts": 1677410818395,
"request_id": "d9d541b9f2d24e21821e2d6d2d16c17d"
}
```
</details>
### 搜索关注明细
> https://api.bilibili.com/x/relation/followings/search
@@ -1700,12 +1806,14 @@ curl 'https://api.bilibili.com/x/relation/tags' \
| track_id | str | | |
`data`对象中的`official_verify`
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ------------ | ---- |
| type | num | 0 | |
| desc | str | 官方认证内容 | |
`data`对象中的`live`
| 字段 | 类型 | 内容 | 备注 |
| ----------- | ---- | -------- | -------------------- |
| live_status | num | 0或1 | 0未开播1已直播 |