新增批量查询直播间API (#228)
* Update info.md * Update info.md * Update info.md * Update info.md * Update info.md * Update info.md * add user api under live folder * Update info.md
This commit is contained in:
parent
b94e389845
commit
3390ec73bd
111
live/info.md
111
live/info.md
@ -310,3 +310,114 @@ curl -G 'http://api.live.bilibili.com/live_user/v1/Master/info' \
|
|||||||
```
|
```
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
## 批量查询直播间状态
|
||||||
|
|
||||||
|
> https://api.live.bilibili.com/room/v1/Room/get_status_info_by_uids
|
||||||
|
|
||||||
|
*请求方式:POST*
|
||||||
|
|
||||||
|
认证方式:无,请不要在标头中添加cookie。
|
||||||
|
|
||||||
|
|
||||||
|
**正文参数:**
|
||||||
|
|
||||||
|
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
|
||||||
|
| ---------- | ---- | ------------------------ | -------------- | ------------------------------------------------------------ |
|
||||||
|
| uids | array | 要查询的主播mid | 必要 | |
|
||||||
|
|
||||||
|
|
||||||
|
**json回复:**
|
||||||
|
|
||||||
|
根对象:
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| ------- | ---- | -------- | ------------------------------------------------------------ |
|
||||||
|
| code | num | 返回值 | 0:成功<br />-111:csrf校验失败 |
|
||||||
|
| message | str | 错误信息 | 默认为success |
|
||||||
|
| msg | str | 错误信息 | 默认为success |
|
||||||
|
| ttl | num | 1 | |
|
||||||
|
| data | obj | 信息本体 | |
|
||||||
|
|
||||||
|
`data`对象:
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| -------- | ---- | -------- | ------------ |
|
||||||
|
| uid | str | 直播间信息 | 实际字段为主播mid |
|
||||||
|
|
||||||
|
`uid`对象:
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| -------- | ---- | -------- | ------------ |
|
||||||
|
| area | num | 直播间分区id | |
|
||||||
|
| area_name | str | 直播间分区名 | |
|
||||||
|
| area_v2_id | num | 直播间新版分区id | |
|
||||||
|
| area_v2_name | str | 直播间新版分区名 | |
|
||||||
|
| area_v2_parent_id | num | 直播间父分区id | |
|
||||||
|
| area_v2_parent_name | str | 直播间父分区名 | |
|
||||||
|
| broadcast_type | num | 直播类型 | 0:普通直播,1:手机直播 |
|
||||||
|
| cover_from_user | str | 直播间封面url | |
|
||||||
|
| face | str | 主播头像url | |
|
||||||
|
| hidden_till | str | 直播间隐藏信息 | |
|
||||||
|
| keyframe | str | 直播间关键帧url | |
|
||||||
|
| live_status | num | 直播间开播状态 | 0:未开播,1:正在直播,2:轮播中 |
|
||||||
|
| live_time | num | 直播持续时长 | |
|
||||||
|
| lock_till | str | 直播间封禁信息 | |
|
||||||
|
| online | num | 直播间在线人数 | |
|
||||||
|
| room_id | num | 直播间房间号 | 直播间实际房间号 |
|
||||||
|
| short_id | num | 直播间房间号 | 直播间短房间号,常见于签约主播 |
|
||||||
|
| tag_name | str | 直播间标签 | |
|
||||||
|
| tags | str | 直播间自定标签 | |
|
||||||
|
| title | str | 直播间标题 | |
|
||||||
|
| uid | num | 主播mid | |
|
||||||
|
| uname | str | 主播用户名 | |
|
||||||
|
|
||||||
|
**示例:**
|
||||||
|
|
||||||
|
查询用户`mid=194484313`的直播间信息
|
||||||
|
|
||||||
|
```shell
|
||||||
|
curl https://api.live.bilibili.com/room/v1/Room/get_status_info_by_uids \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d "{\"uids\": [194484313]}"
|
||||||
|
```
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>查看响应示例:</summary>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 0,
|
||||||
|
"msg": "success",
|
||||||
|
"message": "success",
|
||||||
|
"data": {
|
||||||
|
"194484313": {
|
||||||
|
"title": "中元节可爱鬼来喽!",
|
||||||
|
"room_id": 6154037,
|
||||||
|
"uid": 194484313,
|
||||||
|
"online": 955261,
|
||||||
|
"live_time": 0,
|
||||||
|
"live_status": 2,
|
||||||
|
"short_id": 732,
|
||||||
|
"area": 1,
|
||||||
|
"area_name": "单机联机",
|
||||||
|
"area_v2_id": 236,
|
||||||
|
"area_v2_name": "主机游戏",
|
||||||
|
"area_v2_parent_name": "单机游戏",
|
||||||
|
"area_v2_parent_id": 6,
|
||||||
|
"uname": "Asaki大人",
|
||||||
|
"face": "https://i1.hdslb.com/bfs/face/e8f57fd6992f7d2ef6e6bcee957fb6cf6bca3d80.jpg",
|
||||||
|
"tag_name": "以撒,minecraft,饥荒,彩虹六号,东方",
|
||||||
|
"tags": "",
|
||||||
|
"cover_from_user": "https://i0.hdslb.com/bfs/live/new_room_cover/0a0a8eb5bd7fb64a036b55c748f02ad79a210ec9.jpg",
|
||||||
|
"keyframe": "https://i0.hdslb.com/bfs/live-key-frame/keyframe0823020500000615403721k8sp.jpg",
|
||||||
|
"lock_till": "0000-00-00 00:00:00",
|
||||||
|
"hidden_till": "0000-00-00 00:00:00",
|
||||||
|
"broadcast_type": 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|||||||
304
live/user.md
Normal file
304
live/user.md
Normal file
@ -0,0 +1,304 @@
|
|||||||
|
# 直播间用户实用API
|
||||||
|
|
||||||
|
- [直播间用户实用API](#直播间用户实用api)
|
||||||
|
- [获取用户持有的粉丝勋章信息](#获取用户持有的粉丝勋章信息)
|
||||||
|
- [佩戴勋章](#佩戴勋章)
|
||||||
|
- [直播签到](#直播签到)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 获取用户持有的粉丝勋章信息
|
||||||
|
|
||||||
|
> https://api.live.bilibili.com/fans_medal/v5/live_fans_medal/iApiMedal
|
||||||
|
|
||||||
|
*请求方式:GET*
|
||||||
|
|
||||||
|
认证方式:Cookie(SESSDATA)或APP
|
||||||
|
|
||||||
|
**url参数:**
|
||||||
|
|
||||||
|
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
|
||||||
|
| ------ | ---- | ----------- | ------ | ---- |
|
||||||
|
| page | num | 返回结果页数 | 非必要 | 返回结果单页最大为10 |
|
||||||
|
|
||||||
|
**json回复:**
|
||||||
|
|
||||||
|
根对象:
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| ------- | ---- | -------- | --------------------------- |
|
||||||
|
| code | num | 返回值 | 0:成功<br>-400:请求错误 |
|
||||||
|
| message | str | 错误信息 | 默认为空("") |
|
||||||
|
| msg | str | 错误信息 | 默认为空("") |
|
||||||
|
| data | obj | 信息本体 | |
|
||||||
|
|
||||||
|
`data`对象:
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| -------------- | ---- | ---------------- | ------------------------ |
|
||||||
|
| medalCount | num | 勋章数量 | |
|
||||||
|
| count | num | 勋章数量 | |
|
||||||
|
| fansMedalList | array | 粉丝勋章信息本体 | |
|
||||||
|
| name | str | 用户名 | |
|
||||||
|
| pageinfo | obj | 页码信息 | |
|
||||||
|
|
||||||
|
`fansMedalList 数组内`对象:
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| -------------- | ---- | ---------------- | ------------------------ |
|
||||||
|
| uid | num | 发起请求的用户mid | |
|
||||||
|
| target_id | num | up主mid | |
|
||||||
|
| medal_id | num | 粉丝勋章id | |
|
||||||
|
| score | num | | |
|
||||||
|
| level | num | 勋章等级 | |
|
||||||
|
| intimacy | num | 当前已得亲密度 | |
|
||||||
|
| status | num | | |
|
||||||
|
| source | num | | |
|
||||||
|
| receive_channel | num | 获得方式 | 2:投币获得<br>3000:b坷拉 |
|
||||||
|
| is_receive | num | 勋章数量 | |
|
||||||
|
| master_status | num | | |
|
||||||
|
| receive_time | str | 勋章获取时间 | |
|
||||||
|
| today_intimacy | num | 本日亲密度 | |
|
||||||
|
| last_wear_time | num | 上次佩戴时间 | |
|
||||||
|
| is_lighted | num | 是否点亮 | 0:未点亮<br>1:点亮 |
|
||||||
|
| medal_level | num | 勋章等级 | |
|
||||||
|
| next_intimacy | num | 升级所需经验 | |
|
||||||
|
| day_limit | num | 日经验上限(原力值)| |
|
||||||
|
| medal_name | str | 勋章名 | |
|
||||||
|
| master_available | num | | |
|
||||||
|
| guard_type | num | 加成状态 | |
|
||||||
|
| lpl_status | num | | |
|
||||||
|
| can_delete | bool | 可否删除 | |
|
||||||
|
| target_name | str | up主用户名 | |
|
||||||
|
| target_face | str | up主头像 | |
|
||||||
|
| live_stream_status | num | 当前直播间放松状态 | |
|
||||||
|
| icon_code | num | | |
|
||||||
|
| icon_text | str | | |
|
||||||
|
| rank | str | | |
|
||||||
|
| medal_color | num | 勋章颜色信息 | 颜色数值为10进制的16进制值(下同) |
|
||||||
|
| medal_color_start | num | 勋章起始颜色 | 从右往左渐变(20级+勋章) |
|
||||||
|
| medal_color_end | num | 勋章结束颜色 | 从右往左渐变(20级+勋章) |
|
||||||
|
| guard_level | num | | |
|
||||||
|
| medal_color_border | num | 勋章颜色信息 | |
|
||||||
|
| today_feed | num | 本日亲密度 | |
|
||||||
|
| todayFeed | num | 同上 | |
|
||||||
|
| dayLimit | num | 日经验上限(原力值) | |
|
||||||
|
| uname | str | up主用户名 | |
|
||||||
|
| color | num | 勋章颜色 | |
|
||||||
|
| medalName | str | 勋章内容 | |
|
||||||
|
| guard_medal_title | str | 加成状态 | |
|
||||||
|
| anchorInfo | obj | up信息 | |
|
||||||
|
| roomid | num | 直播间房间号 | |
|
||||||
|
|
||||||
|
`pageinfo`对象:
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| -------------- | ---- | ---------------- | ------------------------ |
|
||||||
|
| totalpages | num | 页码总长度 | |
|
||||||
|
| curPage | num | 当前返回的页码 | 0:未轮播<br>1:轮播 |
|
||||||
|
|
||||||
|
`anchorInfo`对象:
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| -------------- | ---- | ---------------- | ------------------------ |
|
||||||
|
| uid | num | up主mid | |
|
||||||
|
| uname | str | up主用户名 | |
|
||||||
|
| gender | num | 性别 | 0:女<br>1:男<br/>-1:保密 |
|
||||||
|
| face | str | up主头像 | |
|
||||||
|
| silence | num | up主禁言状态 | |
|
||||||
|
| masterVip | num | 会员类型 | |
|
||||||
|
| masterRank | num | 10000 | |
|
||||||
|
| masterLevel | num | up主主站等级 | |
|
||||||
|
| masterHeadpic | str | up主头像框 | |
|
||||||
|
| masterVerify | num | | |
|
||||||
|
| mobileVerified | num | 当前返回的页码 | |
|
||||||
|
| identification | num | 当前返回的页码 | |
|
||||||
|
| official | obj | 认证信息 | |
|
||||||
|
| rank | num | 当前返回的页码 | |
|
||||||
|
| platform_user_level | num | up主主站等级 | |
|
||||||
|
| vip_type | num | 会员类型 | |
|
||||||
|
| mobile_verify | num | | |
|
||||||
|
| official_verify | obj | 认证信息 | |
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>查看响应示例:</summary>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 0,
|
||||||
|
"msg": "",
|
||||||
|
"message": "",
|
||||||
|
"data": {
|
||||||
|
"medalCount": 20,
|
||||||
|
"count": 19,
|
||||||
|
"fansMedalList": [
|
||||||
|
{
|
||||||
|
"uid": 3831650,
|
||||||
|
"target_id": 3821157,
|
||||||
|
"medal_id": 283582,
|
||||||
|
"score": 16031,
|
||||||
|
"level": 11,
|
||||||
|
"intimacy": 1130,
|
||||||
|
"status": 0,
|
||||||
|
"source": 1,
|
||||||
|
"receive_channel": 3000,
|
||||||
|
"is_receive": 1,
|
||||||
|
"master_status": 1,
|
||||||
|
"receive_time": "2021-07-24 23:06:03",
|
||||||
|
"today_intimacy": 252,
|
||||||
|
"last_wear_time": 1630386090,
|
||||||
|
"is_lighted": 1,
|
||||||
|
"medal_level": 11,
|
||||||
|
"next_intimacy": 10000,
|
||||||
|
"day_limit": 1500,
|
||||||
|
"medal_name": "秧歌星",
|
||||||
|
"master_available": 1,
|
||||||
|
"guard_type": 0,
|
||||||
|
"lpl_status": 0,
|
||||||
|
"can_delete": true,
|
||||||
|
"target_name": "东爱璃Lovely",
|
||||||
|
"target_face": "https://i0.hdslb.com/bfs/face/fecabd8cb7cc129fd3bdbc4b71cffec91d342bdd.jpg",
|
||||||
|
"live_stream_status": 0,
|
||||||
|
"icon_code": 0,
|
||||||
|
"icon_text": "",
|
||||||
|
"rank": "",
|
||||||
|
"medal_color": 9272486,
|
||||||
|
"medal_color_start": 9272486,
|
||||||
|
"medal_color_end": 9272486,
|
||||||
|
"guard_level": 0,
|
||||||
|
"medal_color_border": 9272486,
|
||||||
|
"today_feed": 252,
|
||||||
|
"todayFeed": 252,
|
||||||
|
"dayLimit": 1500,
|
||||||
|
"uname": "东爱璃Lovely",
|
||||||
|
"color": 9272486,
|
||||||
|
"medalName": "秧歌星",
|
||||||
|
"guard_medal_title": "未开启加成",
|
||||||
|
"anchorInfo": {
|
||||||
|
"uid": 3821157,
|
||||||
|
"uname": "东爱璃Lovely",
|
||||||
|
"gender": -1,
|
||||||
|
"face": "https://i0.hdslb.com/bfs/face/fecabd8cb7cc129fd3bdbc4b71cffec91d342bdd.jpg",
|
||||||
|
"silence": 0,
|
||||||
|
"masterVip": 2,
|
||||||
|
"masterRank": 10000,
|
||||||
|
"masterLevel": 6,
|
||||||
|
"masterHeadpic": "https://i0.hdslb.com/bfs/garb/ebe4ac76f95ccb9146fdba2db2723f182ec3276b.png",
|
||||||
|
"masterVerify": 0,
|
||||||
|
"mobileVerified": 1,
|
||||||
|
"identification": 1,
|
||||||
|
"official": {
|
||||||
|
"role": 7,
|
||||||
|
"title": "bilibili 直播高能主播",
|
||||||
|
"desc": ""
|
||||||
|
},
|
||||||
|
"rank": 10000,
|
||||||
|
"platform_user_level": 6,
|
||||||
|
"vip_type": 2,
|
||||||
|
"mobile_verify": 0,
|
||||||
|
"official_verify": {
|
||||||
|
"role": 7,
|
||||||
|
"title": "bilibili 直播高能主播",
|
||||||
|
"desc": "",
|
||||||
|
"type": -1
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"roomid": 21692711
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "藍地球",
|
||||||
|
"pageinfo": {
|
||||||
|
"totalpages": 2,
|
||||||
|
"curPage": 2
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
## 佩戴勋章
|
||||||
|
|
||||||
|
> https://api.live.bilibili.com/xlive/web-room/v1/fansMedal/wear
|
||||||
|
|
||||||
|
*请求方式:POST*
|
||||||
|
|
||||||
|
**表单参数:**
|
||||||
|
|
||||||
|
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
|
||||||
|
| ---------- | ---- | -------------------- | ---- | ---- |
|
||||||
|
| medal_id | num | 勋章id | 必要 | |
|
||||||
|
| csrf | num | cookie中bili_jct字段 | 必要 | |
|
||||||
|
| csrf_token | num | 同上 | 必要 | |
|
||||||
|
|
||||||
|
**json回复:**
|
||||||
|
|
||||||
|
根对象:
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| ------- | ---- | -------- | --------------------------- |
|
||||||
|
| code | num | 返回值 | 0:成功 |
|
||||||
|
| ttl | str | 1 | |
|
||||||
|
| message | str | 错误信息 | 默认为佩戴成功 |
|
||||||
|
| data | obj | 信息本体 | 默认为无 |
|
||||||
|
|
||||||
|
**示例:**
|
||||||
|
|
||||||
|
佩戴勋章id为1的勋章
|
||||||
|
|
||||||
|
```JavaScript
|
||||||
|
var madelForm = new FormData();
|
||||||
|
madelForm.append("medal_id", 1);
|
||||||
|
madelForm.append("csrf", bili_jct);
|
||||||
|
madelForm.append("csrf_token", bili_jct);
|
||||||
|
$.ajax({
|
||||||
|
url: "https://api.live.bilibili.com/xlive/web-room/v1/fansMedal/wear",
|
||||||
|
type: "POST",
|
||||||
|
data: madelForm,
|
||||||
|
dataType: "JSON",
|
||||||
|
processData: false,
|
||||||
|
contentType: false,
|
||||||
|
cache: false,
|
||||||
|
xhrFields: {
|
||||||
|
withCredentials: true
|
||||||
|
},
|
||||||
|
success: function (){
|
||||||
|
|
||||||
|
}
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>查看响应示例:</summary>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 0,
|
||||||
|
"message": "佩戴成功",
|
||||||
|
"ttl": 1,
|
||||||
|
"data": {}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
## 直播签到
|
||||||
|
|
||||||
|
> https://api.live.bilibili.com/xlive/web-ucenter/v1/sign/DoSign
|
||||||
|
|
||||||
|
*请求方式:GET*
|
||||||
|
|
||||||
|
认证方式:Cookie(SESSDATA)或APP
|
||||||
|
|
||||||
|
**json回复:**
|
||||||
|
|
||||||
|
根对象:
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| ------- | ---- | -------- | ---------------------- |
|
||||||
|
| code | num | 返回值 | 0:成功<br>1:参数错误 |
|
||||||
|
| ttl | str | 1 | |
|
||||||
|
| message | str | 错误信息 | 默认为当日签到奖励内容 |
|
||||||
|
| data | obj | 信息本体 | 默认为空 |
|
||||||
|
|
||||||
|
|
||||||
Loading…
Reference in New Issue
Block a user