bilibili-API-collect/docs/live/redpocket.md

127 lines
3.9 KiB
Markdown
Raw Normal View History

2023-02-22 01:00:06 +08:00
# 直播间人气红包
## 获取指定直播间的红包信息
> https://api.live.bilibili.com/xlive/lottery-interface/v1/lottery/getLotteryInfoWeb
*请求方式GET*
认证方式可选CookieSESSDATA
如果不携带Cookie信息user_status将始终返回2未参与
如果所查询的直播间无红包popularity_red_pocket为null。
**url参数**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------- | ---- | ---------------- | ------ | ---- |
| roomid | str | 直播间id | 必要 | |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ------ | ---------- | ------------- |
| code | num | 返回值 | 0成功 |
| message | str | 错误信息 | 0成功 |
| ttl | num | TimeToLive | 正常为1 |
| data | object | 返回数据 | |
`data`对象:
| 项 | 类型 | 内容 | 备注 |
| ---- | ---- | ----------- | ---- |
| popularity_red_pocket | array | 人气红包信息 | |
| …… | ...... | …… | …… |
`popularity_red_pocket`数组中的对象:
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---------- | ---- |
| lot_id | num | 红包id | |
| sender_uid | num | 红包发送者uid | |
| sender_name | str | 红包发送者昵称 | |
| sender_face | str | 红包发送者头像 | |
| join_requirement | num | 参与条件? | |
| danmu | str | 参与红包时自动发送的弹幕内容 | |
| awards | array | 红包内容 | |
| lot_status | num | 未知 | |
| h5_url | str | 红包界面 | |
| user_status | num | 用户是否已参与 | 1已参与 2未参与 |
| lot_config_id | num | 未知 | |
| total_price | num | 红包总计价格 | |
**示例:**
查询房间号为24146996的直播间红包信息
```shell
curl -G 'https://api.live.bilibili.com/xlive/lottery-interface/v1/lottery/getLotteryInfoWeb?roomid=24146996'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"message": "0",
"ttl": 1,
"data": {
"pk": null,
"guard": null,
"gift": null,
"storm": null,
"silver": null,
"activity_box": {
"ACTIVITY_ID": 0,
"ACTIVITY_PIC": ""
},
"danmu": null,
"anchor": null,
"red_pocket": null,
"popularity_red_pocket": [{
"lot_id": 622474,
"sender_uid": 1651908873,
"sender_name": "九泽糖糖の小蘑菇",
"sender_face": "http://i0.hdslb.com/bfs/face/c932c5c8b1607fe2e1da22b9780af19662dac939.jpg",
"join_requirement": 1,
"danmu": "老板大气!点点红包抽礼物!",
"awards": [{
"gift_id": 31212,
"num": 2,
"gift_name": "打call",
"gift_pic": "https://s1.hdslb.com/bfs/live/f75291a0e267425c41e1ce31b5ffd6bfedc6f0b6.png"
}, {
"gift_id": 31214,
"num": 3,
"gift_name": "牛哇",
"gift_pic": "https://s1.hdslb.com/bfs/live/23475a7a6170e0d94ba52720e23060dc7604b735.png"
}, {
"gift_id": 31216,
"num": 3,
"gift_name": "i了i了",
"gift_pic": "https://s1.hdslb.com/bfs/live/1157a445487b39c0b7368d91b22290c60fa665b2.png"
}],
"start_time": 1645358104,
"end_time": 1645358284,
"last_time": 180,
"remove_time": 1645358299,
"replace_time": 1645358294,
"current_time": 1645358231,
"lot_status": 1,
"h5_url": "https://live.bilibili.com/p/html/live-app-red-envelope/popularity.html?is_live_half_webview=1\u0026hybrid_half_ui=1,5,100p,100p,000000,0,50,0,0,1;2,5,100p,100p,000000,0,50,0,0,1;3,5,100p,100p,000000,0,50,0,0,1;4,5,100p,100p,000000,0,50,0,0,1;5,5,100p,100p,000000,0,50,0,0,1;6,5,100p,100p,000000,0,50,0,0,1;7,5,100p,100p,000000,0,50,0,0,1;8,5,100p,100p,000000,0,50,0,0,1\u0026hybrid_rotate_d=1\u0026hybrid_biz=popularityRedPacket\u0026lotteryId=622474",
"user_status": 1,
"lot_config_id": 3,
"total_price": 1600
}],
"activity_box_info": null
}
}
```
</details>