返回提交历史
Modified
docs/message/settings.md
+127
-1
XFEstudio/bilibili-API-collect
feat(message/settings): set & delete auto reply text
Signed-off-by: 晨叶梦春 <65224318+wuziqian211@users.noreply.github.com>
fecc790
代码差异
1 个文件
+127
-1
@@ -173,7 +173,7 @@ curl 'https://api.vc.bilibili.com/link_setting/v1/link_setting/set' \
173
173
174
174
</details>
175
175
176
## 获取自动回复文本
176
## 获取自动回复文本/关键词回复规则
177
177
178
178
> <https://api.vc.bilibili.com/x/im/auto_reply/get_reply_text>
179
179
@@ -284,6 +284,132 @@ curl -G 'https://api.vc.bilibili.com/x/im/auto_reply/get_reply_text' \
284
284
285
285
</details>
286
286
287
## 修改自动回复文本/关键词回复规则
288
289
> <https://api.vc.bilibili.com/x/im/auto_reply/set_reply_text>
290
291
*请求方式：POST*
292
293
认证方式：Cookie（SESSDATA）
294
295
仅调用本接口不会开启或关闭自动回复功能，请使用 “[修改用户偏好设置](#修改用户偏好设置)” 接口
296
297
**正文参数（application/x-www-form-urlencoded）：**
298
299
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
300
| ---------- | ---- | ------------------------ | ---------------------- | ---------------------------------------------------------------------------- |
301
| type | num | 自动回复类型 | 必要 | 1：被关注回复<br />2：关键词回复<br />3：收到消息回复<br />5：大航海上船回复 |
302
| reply | str | 回复内容 | 必要 | 最多 500 个字符 |
303
| id | str | 规则id | 非必要 | 当类型为 “关键词回复” 时有效<br />为 `0` 或为空时新增回复规则，否则修改 id 对应的回复规则 |
304
| title | str | 规则名称 | 关键词回复必要 | 当类型为 “关键词回复” 时有效，最多 30 个字符 |
305
| key1 | str | 精确匹配关键词 | 关键词回复必要（可选） | 当类型为 “关键词回复” 时有效，`key1` 与 `key2` 须至少填一个参数<br />以中文逗号分隔每一个关键词，最多 20 项 |
306
| key2 | str | 模糊匹配关键词 | 关键词回复必要（可选） | 当类型为 “关键词回复” 时有效，`key1` 与 `key2` 须至少填一个参数<br />以中文逗号分隔每一个关键词，最多 20 项 |
307
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
308
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
309
| csrf_token | str | CSRF Token（位于cookie） | 必要 | |
310
| csrf | str | CSRF Token（位于cookie） | 必要 | |
311
312
**json回复：**
313
314
根对象：
315
316
| 字段 | 类型 | 内容 | 备注 |
317
| ------- | ---- | -------- | ------------------------------------------------------------------------------------- |
318
| code | num | 返回值 | 0：成功<br />-101：账号未登录<br />27011：请求参数错误<br />1500001：自动回复内容太长 |
319
| message | str | 错误信息 | 默认为0 |
320
| ttl | num | 1 | |
321
| data | obj | 信息本体 | 空对象 |
322
323
**示例：**
324
325
修改关键词回复规则 `id=201321`，规则名称为 `谢谢`，精确匹配关键词为 `谢谢，Thank you，感谢`，回复内容为 `嗯嗯，不用谢[tv_微笑]`
326
327
```shell
328
curl 'https://api.vc.bilibili.com/x/im/auto_reply/set_reply_text' \
329
--data-urlencode 'type[]=2' \
330
--data-urlencode 'reply=嗯嗯，不用谢[tv_微笑]' \
331
--data-urlencode 'id=201321' \
332
--data-urlencode 'title=谢谢' \
333
--data-urlencode 'key1=谢谢，Thank you，感谢' \
334
--data-urlencode 'key2=' \
335
--data-urlencode 'build=0' \
336
--data-urlencode 'mobi_app=web' \
337
--data-urlencode 'csrf_token=xxx' \
338
--data-urlencode 'csrf=xxx' \
339
-b 'SESSDATA=xxx'
340
```
341
342
<details>
343
<summary>查看响应示例：</summary>
344
345
```json
346
{
347
"code": 0,
348
"message": "0",
349
"ttl": 1,
350
"data": {}
351
}
352
```
353
354
</details>
355
356
## 删除关键词回复规则
357
358
> <https://api.vc.bilibili.com/x/im/auto_reply/del_reply_text>
359
360
*请求方式：POST*
361
362
认证方式：Cookie（SESSDATA）
363
364
**正文参数（application/x-www-form-urlencoded）：**
365
366
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
367
| ---------- | ---- | ------------------------ | ------ | ------------- |
368
| id | str | 规则id | 必要 | |
369
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
370
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
371
| csrf_token | str | CSRF Token（位于cookie） | 必要 | |
372
| csrf | str | CSRF Token（位于cookie） | 必要 | |
373
374
**json回复：**
375
376
根对象：
377
378
| 字段 | 类型 | 内容 | 备注 |
379
| ------- | ---- | -------- | --------------------------------------------------- |
380
| code | num | 返回值 | 0：成功<br />-101：账号未登录<br />-500：服务器错误 |
381
| message | str | 错误信息 | 默认为0 |
382
| ttl | num | 1 | |
383
| data | obj | 信息本体 | 空对象 |
384
385
**示例：**
386
387
删除关键词回复规则 `id=201321`
388
389
```shell
390
curl 'https://api.vc.bilibili.com/x/im/auto_reply/del_reply_text' \
391
--data-urlencode 'id=201321' \
392
--data-urlencode 'build=0' \
393
--data-urlencode 'mobi_app=web' \
394
--data-urlencode 'csrf_token=xxx' \
395
--data-urlencode 'csrf=xxx' \
396
-b 'SESSDATA=xxx'
397
```
398
399
<details>
400
<summary>查看响应示例：</summary>
401
402
```json
403
{
404
"code": 0,
405
"message": "0",
406
"ttl": 1,
407
"data": {}
408
}
409
```
410
411
</details>
412
287
413
## 获取系统设置
288
414
289
415
> <https://api.vc.bilibili.com/link_setting/v1/link_setting/get_sys_setting>