返回提交历史
Modified
docs/message/settings.md
+199
-0
XFEstudio/bilibili-API-collect
feat(message/settings): get & add & del black words
Signed-off-by: 晨叶梦春 <65224318+wuziqian211@users.noreply.github.com>
6e817b9
代码差异
1 个文件
+199
-0
@@ -173,6 +173,205 @@ curl 'https://api.vc.bilibili.com/link_setting/v1/link_setting/set' \
173
173
174
174
</details>
175
175
176
## 获取消息屏蔽词
177
178
> <https://api.vc.bilibili.com/x/im/link_setting/get_block_words>
179
180
*请求方式：GET*
181
182
认证方式：Cookie（SESSDATA）
183
184
**url参数：**
185
186
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
187
| -------- | ---- | ---------------- | ------ | ------------- |
188
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
189
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
190
191
**json回复：**
192
193
根对象：
194
195
| 字段 | 类型 | 内容 | 备注 |
196
| ------- | ---- | -------- | ----------------------------- |
197
| code | num | 返回值 | 0：成功<br />-101：账号未登录 |
198
| msg | str | 错误信息 | 默认为0 |
199
| message | str | 错误信息 | 默认为0 |
200
| ttl | num | 1 | |
201
| data | obj | 信息本体 | |
202
203
`data` 对象：
204
205
| 字段 | 类型 | 内容 | 备注 |
206
| --------------- | ------------------------------- | ------------------ | ---------------- |
207
| words | 有效时：array<br />无效时：null | 消息屏蔽词列表 | |
208
| message | str | （？） | **作用尚不明确** |
209
| max_word_length | num | 单个屏蔽词最大长度 | 目前为 `20` |
210
| max_words_size | num | 屏蔽词最大数量 | 目前为 `200` |
211
212
`data` 中的 `words` 数组：
213
214
| 项 | 类型 | 内容 | 备注 |
215
| ---- | ---- | ----------- | ---- |
216
| 0 | obj | 屏蔽词1 | |
217
| n | obj | 屏蔽词(n+1) | |
218
| …… | obj | …… | …… |
219
220
`words` 数组中的对象：
221
222
| 字段 | 类型 | 内容 | 备注 |
223
| ------- | ---- | -------------- | ---------- |
224
| content | str | 屏蔽词内容 | |
225
| ctime | num | 屏蔽词添加时间 | 秒级时间戳 |
226
227
**示例：**
228
229
```shell
230
curl -G 'https://api.vc.bilibili.com/x/im/link_setting/get_block_words' \
231
--data-urlencode 'build=0' \
232
--data-urlencode 'mobi_app=web' \
233
-b 'SESSDATA=xxx'
234
```
235
236
<details>
237
<summary>查看响应示例：</summary>
238
239
```json
240
{
241
"code": 0,
242
"msg": "0",
243
"message": "0",
244
"ttl": 1,
245
"data": {
246
"words": [
247
{
248
"content": "屏蔽词",
249
"ctime": 1746422088
250
}
251
],
252
"message": "",
253
"max_word_length": 20,
254
"max_words_size": 200
255
}
256
}
257
```
258
259
</details>
260
261
## 添加消息屏蔽词
262
263
> <https://api.vc.bilibili.com/x/im/link_setting/add_block_word>
264
265
*请求方式：POST*
266
267
认证方式：Cookie（SESSDATA）
268
269
**正文参数（application/x-www-form-urlencoded）：**
270
271
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
272
| ---------- | ---- | ------------------------ | ------ | ------------- |
273
| content | str | 屏蔽词内容 | 必要 | |
274
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
275
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
276
| csrf_token | str | CSRF Token（位于cookie） | 必要 | |
277
| csrf | str | CSRF Token（位于cookie） | 必要 | |
278
279
**json回复：**
280
281
根对象：
282
283
| 字段 | 类型 | 内容 | 备注 |
284
| ------- | ---- | -------- | ------------------------------------------------------------------------------------- |
285
| code | num | 返回值 | 0：成功<br />-101：账号未登录<br />-400：请求错误<br />19004：添加失败，屏蔽词限制最多20个字 |
286
| msg | str | 错误信息 | 默认为0 |
287
| message | str | 错误信息 | 默认为0 |
288
| ttl | num | 1 | |
289
| data | obj | 信息本体 | 空对象 |
290
291
**示例：**
292
293
```shell
294
curl 'https://api.vc.bilibili.com/x/im/link_setting/add_block_word' \
295
--data-urlencode 'content=屏蔽词' \
296
--data-urlencode 'build=0' \
297
--data-urlencode 'mobi_app=web' \
298
--data-urlencode 'csrf_token=xxx' \
299
--data-urlencode 'csrf=xxx' \
300
-b 'SESSDATA=xxx'
301
```
302
303
<details>
304
<summary>查看响应示例：</summary>
305
306
```json
307
{
308
"code": 0,
309
"msg": "0",
310
"message": "0",
311
"ttl": 1,
312
"data": {}
313
}
314
```
315
316
</details>
317
318
## 删除消息屏蔽词
319
320
> <https://api.vc.bilibili.com/x/im/link_setting/del_block_word>
321
322
*请求方式：POST*
323
324
认证方式：Cookie（SESSDATA）
325
326
**正文参数（application/x-www-form-urlencoded）：**
327
328
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
329
| ---------- | ---- | ------------------------ | ------ | ------------- |
330
| content | str | 屏蔽词内容 | 必要 | |
331
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
332
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
333
| csrf_token | str | CSRF Token（位于cookie） | 必要 | |
334
| csrf | str | CSRF Token（位于cookie） | 必要 | |
335
336
**json回复：**
337
338
根对象：
339
340
| 字段 | 类型 | 内容 | 备注 |
341
| ------- | ---- | -------- | ------------------------------------------------- |
342
| code | num | 返回值 | 0：成功<br />-101：账号未登录<br />-400：请求错误 |
343
| msg | str | 错误信息 | 默认为0 |
344
| message | str | 错误信息 | 默认为0 |
345
| ttl | num | 1 | |
346
| data | obj | 信息本体 | 空对象 |
347
348
**示例：**
349
350
```shell
351
curl 'https://api.vc.bilibili.com/x/im/link_setting/del_block_word' \
352
--data-urlencode 'content=屏蔽词' \
353
--data-urlencode 'build=0' \
354
--data-urlencode 'mobi_app=web' \
355
--data-urlencode 'csrf_token=xxx' \
356
--data-urlencode 'csrf=xxx' \
357
-b 'SESSDATA=xxx'
358
```
359
360
<details>
361
<summary>查看响应示例：</summary>
362
363
```json
364
{
365
"code": 0,
366
"msg": "0",
367
"message": "0",
368
"ttl": 1,
369
"data": {}
370
}
371
```
372
373
</details>
374
176
375
## 获取自动回复文本/关键词回复规则
177
376
178
377
> <https://api.vc.bilibili.com/x/im/auto_reply/get_reply_text>