返回提交历史
Modified
README.md
+1
-0
Added
docs/live/silent_user_manage.md
+218
-0
XFEstudio/bilibili-API-collect
新加直播间禁言相关 (#904)
* 新加直播间禁言相关 * 禁言相关添加至目录
968b3e2
代码差异
2 个文件
+219
-0
@@ -234,6 +234,7 @@ B站 API 采用 C/S 结构，大多数接口为 REST API 和 gRPC，少部分接
234
234
- [ ] [直播信息流](docs/live/message_stream.md)
235
235
- [ ] [直播红包](docs/live/redpocket.md)
236
236
- [ ] [直播间用户实用 API](docs/live/user.md)
237
- [x] [直播间禁言相关](docs/live/silent_user_manage.md)
237
238
- [ ] [转正答题](docs/newbie_exam)
238
239
- [x] [查询信息](docs/newbie_exam/info.md)
239
240
- [x] [拉取题目](docs/newbie_exam/fetch.md)
@@ -0,0 +1,218 @@
1
# 直播间禁言相关 API
2
3
## 禁言观众
4
5
> https://api.live.bilibili.com/xlive/web-ucenter/v1/banned/AddSilentUser
6
7
*请求方式：post*
8
9
认证方式：Cookie（SESSDATA）
10
11
鉴权方式：Cookie中`bili_jct`的值正确并与`csrf`相同
12
13
**正文参数（ application/x-www-form-urlencoded ）：**
14
15
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
16
| ---------- | --- | ---------- | --- | ------------------ |
17
| room_id | str | 直播间Id | 必要 | |
18
| tuid | str | 要禁言的uid | 必要 | |
19
| msg | str | 要禁言的弹幕内容 | 非必要 | |
20
| mobile_app | str | web | 必要 | 定值"web"即可 |
21
| csrf_token | str | CSRF Token | 必要 | cookie中的bili_jct字段 |
22
| csrf | str | CSRF Token | 必要 | cookie中的bili_jct字段 |
23
| visit_id | str | 不明 | 非必要 | |
24
25
**json 回复：**
26
27
根对象：
28
29
| 字段 | 类型 | 内容 | 备注 |
30
| ------- | --- | ---- | ------- |
31
| code | num | 返回值 | 0：成功 |
32
| message | str | 错误信息 | 默认为 "0" |
33
| ttl | str | 1 | |
34
| data | obj | 信息本体 | 成功为空 |
35
36
**示例：**
37
38
```shell
39
curl -X POST 'https://api.live.bilibili.com/xlive/web-ucenter/v1/banned/AddSilentUser' \
40
--data-urlencode 'room_id=xxxxxx' \
41
--data-urlencode 'tuid=xxx' \
42
--data-urlencode 'msg=xxxx' \
43
--data-urlencode 'mobile_app=web' \
44
--data-urlencode 'csrf_token=xx' \
45
--data-urlencode 'csrf=xx' \
46
--data-urlencode 'visit_id=' \
47
-H 'Content-Type:application/x-www-form-urlencoded' \
48
-b 'SESSDATA=xxx; bili_jct=xx;'
49
```
50
51
<details>
52
<summary>查看响应示例：</summary>
53
54
```json
55
{"code":0,"message":"0","ttl":1,"data":{}}
56
```
57
58
</details>
59
60
## 查询直播间禁言列表
61
62
> https://api.live.bilibili.com/xlive/web-ucenter/v1/banned/GetSilentUserList
63
64
*请求方式：post*
65
66
认证方式：Cookie（SESSDATA）
67
68
鉴权方式：Cookie中`bili_jct`的值正确并与`csrf`相同
69
70
**正文参数（ application/x-www-form-urlencoded ）：**
71
72
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
73
| ---------- | --- | ---------- | --- | ------------------ |
74
| room_id | str | 直播间Id | 必要 | |
75
| ps1 | str | 列表页码 | 必要 | |
76
| csrf_token | str | CSRF Token | 必要 | cookie中的bili_jct字段 |
77
| csrf | str | CSRF Token | 必要 | cookie中的bili_jct字段 |
78
| visit_id | str | 不明 | 非必要 | |
79
80
**json 回复：**
81
82
根对象：
83
84
| 字段 | 类型 | 内容 | 备注 |
85
| ------- | --- | ---- | ------- |
86
| code | num | 返回值 | 0：成功 |
87
| message | str | 错误信息 | 默认为 "0" |
88
| ttl | str | 1 | |
89
| data | obj | 信息本体 | |
90
91
`data`对象：
92
93
| 字段 | 类型 | 内容 | 备注 |
94
| ---------- | ----- | ------ | ------- |
95
| data | array | 禁言列表 | 数组中为obj |
96
| total | int | 禁言观众数量 | |
97
| total_page | int | 页码总数量 | |
98
99
`data`对象中`data`数组的元素对象：
100
101
| 字段 | 类型 | 内容 | 备注 |
102
| ----------- | --- | ------ | --------- |
103
| tuid | num | 禁言者uid | |
104
| tname | str | 禁言者昵称 | |
105
| uid | num | 发起者uid | |
106
| name | str | 发起者昵称 | |
107
| ctime | str | 禁言时间 | |
108
| id | num | 禁言记录Id | 解除禁言时用到 |
109
| is_anchor | num | 不明 | |
110
| face | str | 禁言者头像 | |
111
| admin_level | num | 发起者权限 | 0:主播，1:房管 |
112
113
**示例：**
114
115
```shell
116
curl -X POST 'https://api.live.bilibili.com/xlive/web-ucenter/v1/banned/GetSilentUserList' \
117
--data-urlencode 'room_id=xxxxxxx' \
118
--data-urlencode 'ps=1' \
119
--data-urlencode 'csrf_token=xxx' \
120
--data-urlencode 'csrf=xxx' \
121
--data-urlencode 'visit_id=' \
122
-H 'Content-Type:application/x-www-form-urlencoded' \
123
-b 'SESSDATA=xxxx; bili_jct=xxx;'
124
```
125
126
<details>
127
<summary>查看响应示例：</summary>
128
129
```json
130
{
131
"code":0,
132
"message":"0",
133
"ttl":1,
134
"data":{
135
"data":[
136
{
137
"tuid":123456,
138
"tname":"xxxxx",
139
"uid":123456,
140
"name":"xxxx",
141
"ctime":"2023-12-15 16:32:46",
142
"id":13493921,
143
"is_anchor":0,
144
"face":"https://i1.hdslb.com/bfs/face/xxxxx.jpg",
145
"admin_level":1
146
},
147
{
148
"tuid":123456,
149
"tname":"xx",
150
"uid":123456,
151
"name":"xxxx",
152
"ctime":"2021-08-23 22:26:06",
153
"id":8018136,
154
"is_anchor":1,
155
"face":"https://i1.hdslb.com/bfs/face/xxxxxx.jpg",
156
"admin_level":0
157
}
158
],
159
"total":2,
160
"total_page":1
161
}
162
}
163
```
164
165
</details>
166
167
## 解除禁言
168
169
> https://api.live.bilibili.com/banned_service/v1/Silent/del_room_block_user
170
171
*请求方式：post*
172
173
认证方式：Cookie（SESSDATA）
174
175
鉴权方式：Cookie中`bili_jct`的值正确并与`csrf`相同
176
177
**正文参数（ application/x-www-form-urlencoded ）：**
178
179
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
180
| ---------- | --- | ---------- | --- | ---------------------- |
181
| roomid | str | 直播间Id | 必要 | 注意该接口名称没有“_” |
182
| id | str | 禁言记录Id | 必要 | GetSilentUserList 接口获取 |
183
| csrf_token | str | CSRF Token | 必要 | cookie中的bili_jct字段 |
184
| csrf | str | CSRF Token | 必要 | cookie中的bili_jct字段 |
185
| visit_id | str | 不明 | 非必要 | |
186
187
**json 回复：**
188
189
根对象：
190
191
| 字段 | 类型 | 内容 | 备注 |
192
| ------- | --- | ---- | ---- |
193
| code | num | 返回值 | 0：成功 |
194
| message | str | 错误信息 | 成功为空 |
195
| ttl | str | 1 | |
196
| data | obj | 信息本体 | 成功为空 |
197
198
**示例：**
199
200
```shell
201
curl -X POST 'https://api.live.bilibili.com/banned_service/v1/Silent/del_room_block_user' \
202
--data-urlencode 'roomid=xxxxxxxxx' \
203
--data-urlencode 'id=xxxxx' \
204
--data-urlencode 'csrf_token=xxx' \
205
--data-urlencode 'csrf=xxx' \
206
--data-urlencode 'visit_id=' \
207
-H 'Content-Type:application/x-www-form-urlencoded' \
208
-b 'SESSDATA=xxxxxx; bili_jct=xxx;'
209
```
210
211
<details>
212
<summary>查看响应示例：</summary>
213
214
```json
215
{"code":0,"msg":"","message":"","data":[]}
216
```
217
218
</details>