返回提交历史
Modified
docs/message/private_msg.md
+151
-147
XFEstudio/bilibili-API-collect
style(private_msg): add session & message category
20ebf79
代码差异
1 个文件
+151
-147
@@ -93,7 +93,9 @@
93
93
| 18 | 系统提示 | 目前仅在 `msg_type` 为 `18` 时使用该代码，如：“对方主动回复或关注你前，最多发送1条消息” |
94
94
| 19 | AI | 如：给[搜索AI助手测试版](https://space.bilibili.com/1400565964/)发送私信时对方的自动回复 |
95
95
96
## 获取未读私信数
96
## 会话相关
97
98
### 获取未读私信数
97
99
98
100
> <https://api.vc.bilibili.com/session_svr/v1/session_svr/single_unread>
99
101
@@ -176,7 +178,7 @@ curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/single_unread' \
176
178
177
179
</details>
178
180
179
## 获取指定类型会话列表
181
### 获取指定类型会话列表
180
182
181
183
> <https://api.vc.bilibili.com/session_svr/v1/session_svr/get_sessions>
182
184
@@ -407,7 +409,7 @@ curl -G 'https://api.vc.bilibili.com/session_svr/v1/session_svr/get_sessions' \
407
409
408
410
</details>
409
411
410
## 获取新会话列表
412
### 获取新会话列表
411
413
412
414
> <https://api.vc.bilibili.com/session_svr/v1/session_svr/new_sessions>
413
415
@@ -620,7 +622,7 @@ curl -G 'https://api.vc.bilibili.com/session_svr/v1/session_svr/new_sessions' \
620
622
621
623
</details>
622
624
623
## 获取会话详细信息
625
### 获取会话详细信息
624
626
625
627
> <https://api.vc.bilibili.com/session_svr/v1/session_svr/session_detail>
626
628
@@ -720,7 +722,145 @@ curl -G 'https://api.vc.bilibili.com/session_svr/v1/session_svr/session_detail'
720
722
721
723
</details>
722
724
723
## 查询私信消息记录
725
### 获取会话限制状态
726
727
> <https://api.vc.bilibili.com/link_setting/v1/link_setting/is_limit>
728
729
*请求方式：GET*
730
731
认证方式：Cookie（SESSDATA）
732
733
仅对用户会话调用本接口
734
735
**url参数：**
736
737
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
738
| ------ | ---- | ----------- | ------ | ---- |
739
| uid | num | 聊天对象mid | 必要 | |
740
| type | num | 1 | 必要 | |
741
742
**json回复：**
743
744
根对象：
745
746
| 字段 | 类型 | 内容 | 备注 |
747
| ------- | ---- | -------- | ------------------------------------------------- |
748
| code | num | 返回值 | 0：成功<br />2：非法参数<br />-101：账号未登录<br />-400：请求错误 |
749
| msg | str | 错误信息 | 默认为0 |
750
| message | str | 错误信息 | 默认为0 |
751
| ttl | num | 1 | |
752
| data | obj | 数据本体 | |
753
754
`data`对象：
755
756
| 字段 | 类型 | 内容 | 备注 |
757
| ------------ | ---- | ------------------------ | ---------------------------- |
758
| is_limit | num | 用户是否被封禁 | |
759
| report_limit | num | 自己是否被限制举报该会话 | 常见于自己被封禁时出现该情况 |
760
761
**示例：**
762
763
获取`uid=123`的限制状态：
764
765
```shell
766
curl -G 'https://api.vc.bilibili.com/link_setting/v1/link_setting/is_limit' \
767
--data-urlencode 'uid=123' \
768
--data-urlencode 'type=1' \
769
-b 'SESSDATA=xxx'
770
```
771
772
<details>
773
<summary>查看响应示例：</summary>
774
775
```json
776
{
777
"code": 0,
778
"msg": "0",
779
"message": "0",
780
"ttl": 1,
781
"data": {
782
"is_limit": 0,
783
"report_limit": 0
784
}
785
}
786
```
787
788
</details>
789
790
### 获取会话推送设置
791
792
> <https://api.vc.bilibili.com/link_setting/v1/link_setting/get_session_ss>
793
794
*请求方式：GET*
795
796
认证方式：Cookie（SESSDATA）
797
798
仅对用户会话调用本接口
799
800
**url参数：**
801
802
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
803
| ---------- | ---- | ---------------- | ------ | ------------- |
804
| talker_uid | num | 聊天对象mid | 必要 | |
805
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
806
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
807
808
**json回复：**
809
810
根对象：
811
812
| 字段 | 类型 | 内容 | 备注 |
813
| ------- | ---- | -------- | ------------------------------------------------- |
814
| code | num | 返回值 | 0：成功<br />2：非法参数<br />-101：账号未登录<br />-400：请求错误 |
815
| msg | str | 错误信息 | 默认为0 |
816
| message | str | 错误信息 | 默认为0 |
817
| ttl | num | 1 | |
818
| data | obj | 数据本体 | |
819
820
`data`对象：
821
822
| 字段 | 类型 | 内容 | 备注 |
823
| ----------------- | ---- | ---------------------- | ----------------------------------- |
824
| follow_status | num | 对方对于自己的关注属性 | 0：未关注<br />~~1：悄悄关注（现已下线）~~<br />2：已关注<br />6：已互粉<br />128：已拉黑 |
825
| special | num | 自己是否特别关注了对方 | |
826
| push_setting | num | 推送设置 | 0：接收推送<br />1：不接收推送 |
827
| show_push_setting | num | 是否显示推送设置 | |
828
829
**示例：**
830
831
获取`talker_uid=123`的推送设置：
832
833
```shell
834
curl -G 'https://api.vc.bilibili.com/link_setting/v1/link_setting/get_session_ss' \
835
--data-urlencode 'talker_uid=123' \
836
--data-urlencode 'build=0' \
837
--data-urlencode 'mobi_app=web' \
838
-b 'SESSDATA=xxx'
839
```
840
841
<details>
842
<summary>查看响应示例：</summary>
843
844
```json
845
{
846
"code": 0,
847
"msg": "0",
848
"message": "0",
849
"ttl": 1,
850
"data": {
851
"follow_status": 6,
852
"special": 1,
853
"push_setting": 0,
854
"show_push_setting": 1
855
}
856
}
857
```
858
859
</details>
860
861
## 私信消息相关
862
863
### 查询私信消息记录
724
864
725
865
> <https://api.vc.bilibili.com/svr_sync/v1/svr_sync/fetch_session_msgs>
726
866
@@ -869,143 +1009,7 @@ curl -G 'https://api.vc.bilibili.com/svr_sync/v1/svr_sync/fetch_session_msgs' \
869
1009
870
1010
</details>
871
1011
872
## 获取会话限制状态
873
874
> <https://api.vc.bilibili.com/link_setting/v1/link_setting/is_limit>
875
876
*请求方式：GET*
877
878
认证方式：Cookie（SESSDATA）
879
880
仅对用户会话调用本接口
881
882
**url参数：**
883
884
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
885
| ------ | ---- | ----------- | ------ | ---- |
886
| uid | num | 聊天对象mid | 必要 | |
887
| type | num | 1 | 必要 | |
888
889
**json回复：**
890
891
根对象：
892
893
| 字段 | 类型 | 内容 | 备注 |
894
| ------- | ---- | -------- | ------------------------------------------------- |
895
| code | num | 返回值 | 0：成功<br />2：非法参数<br />-101：账号未登录<br />-400：请求错误 |
896
| msg | str | 错误信息 | 默认为0 |
897
| message | str | 错误信息 | 默认为0 |
898
| ttl | num | 1 | |
899
| data | obj | 数据本体 | |
900
901
`data`对象：
902
903
| 字段 | 类型 | 内容 | 备注 |
904
| ------------ | ---- | ------------------------ | ---------------------------- |
905
| is_limit | num | 用户是否被封禁 | |
906
| report_limit | num | 自己是否被限制举报该会话 | 常见于自己被封禁时出现该情况 |
907
908
**示例：**
909
910
获取`uid=123`的限制状态：
911
912
```shell
913
curl -G 'https://api.vc.bilibili.com/link_setting/v1/link_setting/is_limit' \
914
--data-urlencode 'uid=123' \
915
--data-urlencode 'type=1' \
916
-b 'SESSDATA=xxx'
917
```
918
919
<details>
920
<summary>查看响应示例：</summary>
921
922
```json
923
{
924
"code": 0,
925
"msg": "0",
926
"message": "0",
927
"ttl": 1,
928
"data": {
929
"is_limit": 0,
930
"report_limit": 0
931
}
932
}
933
```
934
935
</details>
936
937
## 获取会话推送设置
938
939
> <https://api.vc.bilibili.com/link_setting/v1/link_setting/get_session_ss>
940
941
*请求方式：GET*
942
943
认证方式：Cookie（SESSDATA）
944
945
仅对用户会话调用本接口
946
947
**url参数：**
948
949
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
950
| ---------- | ---- | ---------------- | ------ | ------------- |
951
| talker_uid | num | 聊天对象mid | 必要 | |
952
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
953
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
954
955
**json回复：**
956
957
根对象：
958
959
| 字段 | 类型 | 内容 | 备注 |
960
| ------- | ---- | -------- | ------------------------------------------------- |
961
| code | num | 返回值 | 0：成功<br />2：非法参数<br />-101：账号未登录<br />-400：请求错误 |
962
| msg | str | 错误信息 | 默认为0 |
963
| message | str | 错误信息 | 默认为0 |
964
| ttl | num | 1 | |
965
| data | obj | 数据本体 | |
966
967
`data`对象：
968
969
| 字段 | 类型 | 内容 | 备注 |
970
| ----------------- | ---- | ---------------------- | ----------------------------------- |
971
| follow_status | num | 对方对于自己的关注属性 | 0：未关注<br />~~1：悄悄关注（现已下线）~~<br />2：已关注<br />6：已互粉<br />128：已拉黑 |
972
| special | num | 自己是否特别关注了对方 | |
973
| push_setting | num | 推送设置 | 0：接收推送<br />1：不接收推送 |
974
| show_push_setting | num | 是否显示推送设置 | |
975
976
**示例：**
977
978
获取`talker_uid=123`的推送设置：
979
980
```shell
981
curl -G 'https://api.vc.bilibili.com/link_setting/v1/link_setting/get_session_ss' \
982
--data-urlencode 'talker_uid=123' \
983
--data-urlencode 'build=0' \
984
--data-urlencode 'mobi_app=web' \
985
-b 'SESSDATA=xxx'
986
```
987
988
<details>
989
<summary>查看响应示例：</summary>
990
991
```json
992
{
993
"code": 0,
994
"msg": "0",
995
"message": "0",
996
"ttl": 1,
997
"data": {
998
"follow_status": 6,
999
"special": 1,
1000
"push_setting": 0,
1001
"show_push_setting": 1
1002
}
1003
}
1004
```
1005
1006
</details>
1007
1008
## 获取多个视频、番剧、专栏的信息
1012
### 获取多个视频、番剧、专栏的信息
1009
1013
1010
1014
> <https://api.vc.bilibili.com/x/im/feed/infoweb>
1011
1015
@@ -1178,7 +1182,7 @@ curl -G 'https://api.vc.bilibili.com/x/im/feed/infoweb' \
1178
1182
1179
1183
</details>
1180
1184
1181
## 设置私信为已读
1185
### 设置私信为已读
1182
1186
1183
1187
> <https://api.vc.bilibili.com/session_svr/v1/session_svr/update_ack>
1184
1188
@@ -1245,7 +1249,7 @@ curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/update_ack' \
1245
1249
1246
1250
</details>
1247
1251
1248
## 发送私信（web端）
1252
### 发送私信（web端）
1249
1253
1250
1254
> <https://api.vc.bilibili.com/web_im/v1/web_im/send_msg>
1251
1255
@@ -1296,7 +1300,7 @@ dev_id 实质上就是 UUID（版本 4）
1296
1300
<details>
1297
1301
<summary>查看生成 UUID 的代码</summary>
1298
1302
1299
### Python
1303
#### Python
1300
1304
1301
1305
```python
1302
1306
import uuid
@@ -1304,7 +1308,7 @@ import uuid
1304
1308
dev_id = str(uuid.uuid4())
1305
1309
```
1306
1310
1307
### JavaScript
1311
#### JavaScript
1308
1312
1309
1313
以下代码适用于较新版的 JS 引擎（Chrome≥92，Firefox≥95，Safari≥15.4，Node.js≥19.0.0）：
1310
1314
@@ -1321,7 +1325,7 @@ const dev_id = "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (function
1321
1325
}));
1322
1326
```
1323
1327
1324
### Java
1328
#### Java
1325
1329
1326
1330
```java
1327
1331
import java.util.UUID;