返回提交历史
Modified
docs/message/private_msg.md
+249
-8
Modified
docs/message/settings.md
+8
-8
XFEstudio/bilibili-API-collect
feat(message): add details
Signed-off-by: 晨叶梦春 <65224318+wuziqian211@users.noreply.github.com>
8d316f4
代码差异
2 个文件
+257
-16
@@ -6,7 +6,7 @@
6
6
7
7
| 字段 | 类型 | 内容 | 备注 |
8
8
| -------------------- | ---- | -------------------------------- | --------------------------------------------------- |
9
| talker_id | num | 聊天对象的id | `session_type` 为 `1` 时表示用户 mid，为 `2` 时表示粉丝团 id |
9
| talker_id | num | 聊天对象的id | `session_type` 为 `1` 时表示 mid，为 `2` 时表示粉丝团 id |
10
10
| session_type | num | 聊天对象的类型 | 1：用户<br />2：粉丝团 |
11
11
| at_seqno | num | 最近一次未读at自己的消息的序列号 | 在粉丝团会话中有效，若没有未读的 at 自己的消息则为 `0` |
12
12
| top_ts | num | 置顶该会话的时间 | 微秒级时间戳；若未置顶该会话则为 `0`；用于判断是否置顶了会话 |
@@ -730,7 +730,7 @@ curl -G 'https://api.vc.bilibili.com/session_svr/v1/session_svr/session_detail'
730
730
731
731
认证方式：Cookie（SESSDATA）
732
732
733
仅对用户会话调用本接口
733
仅支持用户会话
734
734
735
735
**url参数：**
736
736
@@ -795,7 +795,7 @@ curl -G 'https://api.vc.bilibili.com/link_setting/v1/link_setting/is_limit' \
795
795
796
796
认证方式：Cookie（SESSDATA）
797
797
798
仅对用户会话调用本接口
798
仅支持用户会话
799
799
800
800
**url参数：**
801
801
@@ -858,6 +858,251 @@ curl -G 'https://api.vc.bilibili.com/link_setting/v1/link_setting/get_session_ss
858
858
859
859
</details>
860
860
861
### 修改会话置顶状态
862
863
> <https://api.vc.bilibili.com/session_svr/v1/session_svr/set_top>
864
865
*请求方式：POST*
866
867
认证方式：Cookie（SESSDATA）
868
869
**正文参数（application/x-www-form-urlencoded）：**
870
871
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
872
| ------------ | ---- | ------------------------ | ------ | ---------------------------------------------------- |
873
| talker_id | num | 聊天对象的id | 必要 | `session_type` 为 `1` 时表示用户 mid，为 `2` 时表示粉丝团 id |
874
| session_type | num | 聊天对象的类型 | 必要 | 1：用户<br />2：粉丝团 |
875
| op_type | num | 操作类型 | 必要 | 0：置顶<br />1：取消置顶 |
876
| csrf_token | str | CSRF Token（位于cookie） | 必要 | |
877
| csrf | str | CSRF Token（位于cookie） | 必要 | |
878
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
879
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
880
881
**json回复：**
882
883
根对象：
884
885
| 字段 | 类型 | 内容 | 备注 |
886
| ------- | ---- | -------- | ------------------------------------------------- |
887
| code | num | 返回值 | 0：成功<br />-101：账号未登录<br />-400：请求错误 |
888
| msg | str | 错误信息 | 成功时为0 |
889
| message | str | 错误信息 | 成功时为0 |
890
| ttl | num | | 默认为1 |
891
| data | 有效时：obj<br />无效时：不存在该项 | 信息本体 | 空对象 |
892
893
**示例：**
894
895
置顶会话`talker_id=293793435&session_type=1`
896
897
```shell
898
curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/set_top' \
899
--data-urlencode 'talker_id=2' \
900
--data-urlencode 'session_type=1' \
901
--data-urlencode 'op_type=0' \
902
--data-urlencode 'csrf=xxx' \
903
--data-urlencode 'csrf_token=xxx' \
904
-b 'SESSDATA=xxx'
905
```
906
907
<details>
908
<summary>查看响应示例：</summary>
909
910
```json
911
{
912
"code": 0,
913
"msg": "0",
914
"message": "0",
915
"ttl": 1,
916
"data": {}
917
}
918
```
919
920
</details>
921
922
### 移除指定会话
923
924
> <https://api.vc.bilibili.com/session_svr/v1/session_svr/remove_session>
925
926
*请求方式：POST*
927
928
认证方式：Cookie（SESSDATA）
929
930
将指定会话从会话列表中移除，不会删除聊天记录
931
932
**正文参数（application/x-www-form-urlencoded）：**
933
934
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
935
| ------------ | ---- | ------------------------ | ------ | ---------------------------------------------------- |
936
| talker_id | num | 聊天对象的id | 必要 | `session_type` 为 `1` 时表示用户 mid，为 `2` 时表示粉丝团 id |
937
| session_type | num | 聊天对象的类型 | 必要 | 1：用户<br />2：粉丝团 |
938
| csrf_token | str | CSRF Token（位于cookie） | 必要 | |
939
| csrf | str | CSRF Token（位于cookie） | 必要 | |
940
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
941
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
942
943
**json回复：**
944
945
根对象：
946
947
| 字段 | 类型 | 内容 | 备注 |
948
| ------- | ---- | -------- | ------------------------------------------------- |
949
| code | num | 返回值 | 0：成功<br />-101：账号未登录<br />-400：请求错误 |
950
| msg | str | 错误信息 | 成功时为0 |
951
| message | str | 错误信息 | 成功时为0 |
952
| ttl | num | | 默认为1 |
953
| data | 有效时：obj<br />无效时：不存在该项 | 信息本体 | 空对象 |
954
955
**示例：**
956
957
移除会话`talker_id=2&session_type=1`
958
959
```shell
960
curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/remove_session' \
961
--data-urlencode 'talker_id=2' \
962
--data-urlencode 'session_type=1' \
963
--data-urlencode 'csrf=xxx' \
964
--data-urlencode 'csrf_token=xxx' \
965
-b 'SESSDATA=xxx'
966
```
967
968
<details>
969
<summary>查看响应示例：</summary>
970
971
```json
972
{
973
"code": 0,
974
"msg": "0",
975
"message": "0",
976
"ttl": 1,
977
"data": {}
978
}
979
```
980
981
</details>
982
983
### 修改会话免打扰状态
984
985
> <https://api.vc.bilibili.com/link_setting/v1/link_setting/set_msg_dnd>
986
987
*请求方式：POST*
988
989
认证方式：Cookie（SESSDATA）
990
991
**正文参数（application/x-www-form-urlencoded）：**
992
993
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
994
| ------------ | ---- | ------------------------ | ------------ | -------------------------------- |
995
| uid | num | 自己的mid | 非必要 | |
996
| setting | num | 免打扰设置 | 必要 | 0：取消免打扰<br />1：开启免打扰 |
997
| dnd_uid | num | 用户mid | 必要（可选） | 当聊天对象为用户时有效 |
998
| dnd_group_id | num | 粉丝团id | 必要（可选） | 当聊天对象为粉丝团时有效 |
999
| csrf_token | str | CSRF Token（位于cookie） | 必要 | |
1000
| csrf | str | CSRF Token（位于cookie） | 必要 | |
1001
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
1002
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
1003
1004
**json回复：**
1005
1006
根对象：
1007
1008
| 字段 | 类型 | 内容 | 备注 |
1009
| ------- | ---- | -------- | ------------------------------------------------- |
1010
| code | num | 返回值 | 0：成功<br />-101：账号未登录<br />-400：请求错误 |
1011
| msg | str | 错误信息 | 成功时为0 |
1012
| message | str | 错误信息 | 成功时为0 |
1013
| ttl | num | | 默认为1 |
1014
| data | 有效时：obj<br />无效时：不存在该项 | 信息本体 | 空对象 |
1015
1016
**示例：**
1017
1018
对会话`dnd_uid=2`开启免打扰
1019
1020
```shell
1021
curl 'https://api.vc.bilibili.com/link_setting/v1/link_setting/set_msg_dnd' \
1022
--data-urlencode 'uid=425503913' \
1023
--data-urlencode 'setting=1' \
1024
--data-urlencode 'dnd_uid=2' \
1025
--data-urlencode 'csrf=xxx' \
1026
--data-urlencode 'csrf_token=xxx' \
1027
-b 'SESSDATA=xxx'
1028
```
1029
1030
<details>
1031
<summary>查看响应示例：</summary>
1032
1033
```json
1034
{
1035
"code": 0,
1036
"msg": "0",
1037
"message": "0",
1038
"ttl": 1,
1039
"data": {}
1040
}
1041
```
1042
1043
</details>
1044
1045
### 修改会话推送设置
1046
1047
> <https://api.vc.bilibili.com/link_setting/v1/link_setting/set_push_ss>
1048
1049
*请求方式：POST*
1050
1051
认证方式：Cookie（SESSDATA）
1052
1053
仅支持用户会话
1054
1055
**正文参数（application/x-www-form-urlencoded）：**
1056
1057
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
1058
| ---------- | ---- | ------------------------ | ------ | ------------------------------ |
1059
| talker_uid | num | 聊天对象mid | 必要 | |
1060
| setting | num | 推送设置 | 必要 | 0：接收推送<br />1：不接收推送 |
1061
| csrf_token | str | CSRF Token（位于cookie） | 必要 | |
1062
| csrf | str | CSRF Token（位于cookie） | 必要 | |
1063
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
1064
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
1065
1066
**json回复：**
1067
1068
根对象：
1069
1070
| 字段 | 类型 | 内容 | 备注 |
1071
| ------- | ---- | -------- | ------------------------------------------------- |
1072
| code | num | 返回值 | 0：成功<br />-101：账号未登录<br />-400：请求错误 |
1073
| msg | str | 错误信息 | 成功时为0 |
1074
| message | str | 错误信息 | 成功时为0 |
1075
| ttl | num | | 默认为1 |
1076
| data | 有效时：obj<br />无效时：不存在该项 | 信息本体 | 空对象 |
1077
1078
**示例：**
1079
1080
修改`talker_uid=2`的推送设置为不接收推送
1081
1082
```shell
1083
curl 'https://api.vc.bilibili.com/link_setting/v1/link_setting/set_push_ss' \
1084
--data-urlencode 'talker_uid=2' \
1085
--data-urlencode 'setting=1' \
1086
--data-urlencode 'csrf=xxx' \
1087
--data-urlencode 'csrf_token=xxx' \
1088
-b 'SESSDATA=xxx'
1089
```
1090
1091
<details>
1092
<summary>查看响应示例：</summary>
1093
1094
```json
1095
{
1096
"code": 0,
1097
"msg": "0",
1098
"message": "0",
1099
"ttl": 1,
1100
"data": {}
1101
}
1102
```
1103
1104
</details>
1105
861
1106
## 私信消息相关
862
1107
863
1108
### 查询私信消息记录
@@ -1214,11 +1459,7 @@ curl -G 'https://api.vc.bilibili.com/x/im/feed/infoweb' \
1214
1459
| msg | str | 错误信息 | 成功时为0 |
1215
1460
| message | str | 错误信息 | 成功时为0 |
1216
1461
| ttl | num | | 默认为1 |
1217
| data | 有效时：obj<br />无效时：不存在该项 | 信息本体 | |
1218
1219
`data`对象：
1220
1221
一个不含任何项目的对象，即 `{}`
1462
| data | 有效时：obj<br />无效时：不存在该项 | 信息本体 | 空对象 |
1222
1463
1223
1464
**示例：**
1224
1465
@@ -268,13 +268,13 @@ curl -G 'https://api.vc.bilibili.com/x/im/link_setting/get_block_words' \
268
268
269
269
**正文参数（application/x-www-form-urlencoded）：**
270
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） | 必要 | |
271
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
272
| ---------- | ---- | ------------------------ | ------ | -------------- |
273
| content | str | 屏蔽词内容 | 必要 | 最多 20 个字符 |
274
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
275
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
276
| csrf_token | str | CSRF Token（位于cookie） | 必要 | |
277
| csrf | str | CSRF Token（位于cookie） | 必要 | |
278
278
279
279
**json回复：**
280
280
@@ -282,7 +282,7 @@ curl -G 'https://api.vc.bilibili.com/x/im/link_setting/get_block_words' \
282
282
283
283
| 字段 | 类型 | 内容 | 备注 |
284
284
| ------- | ---- | -------- | ------------------------------------------------------------------------------------- |
285
| code | num | 返回值 | 0：成功<br />-101：账号未登录<br />-400：请求错误<br />19004：添加失败，屏蔽词限制最多20个字 |
285
| code | num | 返回值 | 0：成功<br />-101：账号未登录<br />-400：请求错误<br />1900004：添加失败，屏蔽词限制最多20个字<br />1900005：添加失败，最多可以添加200个屏蔽词<br />1900006：添加失败，屏蔽词重复<br />1900007：添加失败，屏蔽词不支持空格 |
286
286
| msg | str | 错误信息 | 默认为0 |
287
287
| message | str | 错误信息 | 默认为0 |
288
288
| ttl | num | 1 | |