返回提交历史
Modified
docs/message/private_msg.md
+169
-100
XFEstudio/bilibili-API-collect
Update private_msg.md
58c7650
代码差异
1 个文件
+169
-100
@@ -159,106 +159,6 @@ curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/single_unread' \
159
159
160
160
</details>
161
161
162
## 会话详细信息
163
164
> https://api.vc.bilibili.com/session_svr/v1/session_svr/session_detail
165
166
*请求方式：GET*
167
168
认证方式：Cookie（SESSDATA）
169
170
若从未与该会话聊过天，则返回 1000004 `入口节点已存在` 错误
171
172
**url参数：**
173
174
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
175
| ------------ | ---- | ---------------- | ------ | ------------------------------------------------------ |
176
| talker_id | num | 聊天对象的id | 必要 | `session_type` 为 `1` 时表示用户 mid，为 `2` 时表示粉丝团 id |
177
| session_type | num | 聊天对象的类型 | 必要 | 1：用户<br />2：粉丝团 |
178
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
179
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
180
181
**json回复：**
182
183
根对象：
184
185
| 字段 | 类型 | 内容 | 备注 |
186
| ------- | ---- | -------- | ------------------------------------------------------------------------------ |
187
| code | num | 返回值 | 0：成功<br />-101：账号未登录<br />-400：请求错误<br />1000004：入口节点已存在 |
188
| msg | str | 错误信息 | 默认为0 |
189
| message | str | 错误信息 | 默认为0 |
190
| ttl | num | 1 | |
191
| data | obj | 数据本体 | 详见[会话对象](#会话对象) |
192
193
**示例：**
194
195
获取会话`talker_id=293793435&session_type=1`的详细信息：
196
197
```shell
198
curl -G 'https://api.vc.bilibili.com/session_svr/v1/session_svr/session_detail' \
199
--data-urlencode 'talker_id=293793435' \
200
--data-urlencode 'session_type=1' \
201
--data-urlencode 'build=0' \
202
--data-urlencode 'mobi_app=web' \
203
-b 'SESSDATA=xxx'
204
```
205
206
<details>
207
<summary>查看响应示例：</summary>
208
209
```json
210
{
211
"code": 0,
212
"msg": "0",
213
"message": "0",
214
"ttl": 1,
215
"data": {
216
"talker_id": 293793435,
217
"session_type": 1,
218
"at_seqno": 0,
219
"top_ts": 0,
220
"group_name": "",
221
"group_cover": "",
222
"is_follow": 1,
223
"is_dnd": 0,
224
"ack_seqno": 1236306587877408,
225
"ack_ts": 1709536984481314,
226
"session_ts": 1709385615744065,
227
"unread_count": 0,
228
"last_msg": {
229
"sender_uid": 293793435,
230
"receiver_type": 1,
231
"receiver_id": 425503913,
232
"msg_type": 11,
233
"content": "{\"title\":\"OHHHHHH家人们，我分数终于破w了！紫框了这下确实不好意思说自己是只打红谱的萌新了\",\"times\":14,\"cover\":\"http://i0.hdslb.com/bfs/archive/8821c03ab27a0bcf2bf32af814e758ab17a1e27e.png\",\"rid\":1951316064,\"type_\":8,\"desc\":\"OHHHHHH家人们，我分数终于破w了！紫框了这下确实不好意思说自己是只打红谱的萌新了\",\"bvid\":\"BV1zC411p7JN\",\"view\":452,\"danmaku\":0,\"pub_date\":1709385603,\"attach_msg\":null}",
234
"msg_seqno": 1236306587877408,
235
"timestamp": 1709385615,
236
"at_uids": null,
237
"msg_key": 7341755312943193481,
238
"msg_status": 0,
239
"notify_code": "",
240
"new_face_version": 1,
241
"msg_source": 6
242
},
243
"group_type": 0,
244
"can_fold": 0,
245
"status": 0,
246
"max_seqno": 1236306587877408,
247
"new_push_msg": 0,
248
"setting": 0,
249
"is_guardian": 0,
250
"is_intercept": 0,
251
"is_trust": 0,
252
"system_msg_type": 0,
253
"live_status": 0,
254
"biz_msg_unread_count": 0,
255
"user_label": null
256
}
257
}
258
```
259
260
</details>
261
262
162
## 新会话列表
263
163
264
164
> https://api.vc.bilibili.com/session_svr/v1/session_svr/new_sessions
@@ -472,6 +372,106 @@ curl -G 'https://api.vc.bilibili.com/session_svr/v1/session_svr/new_sessions' \
472
372
473
373
</details>
474
374
375
## 会话详细信息
376
377
> https://api.vc.bilibili.com/session_svr/v1/session_svr/session_detail
378
379
*请求方式：GET*
380
381
认证方式：Cookie（SESSDATA）
382
383
若从未与该会话聊过天，则返回 1000004 `入口节点已存在` 错误
384
385
**url参数：**
386
387
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
388
| ------------ | ---- | ---------------- | ------ | ------------------------------------------------------ |
389
| talker_id | num | 聊天对象的id | 必要 | `session_type` 为 `1` 时表示用户 mid，为 `2` 时表示粉丝团 id |
390
| session_type | num | 聊天对象的类型 | 必要 | 1：用户<br />2：粉丝团 |
391
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
392
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
393
394
**json回复：**
395
396
根对象：
397
398
| 字段 | 类型 | 内容 | 备注 |
399
| ------- | ---- | -------- | ------------------------------------------------------------------------------ |
400
| code | num | 返回值 | 0：成功<br />-101：账号未登录<br />-400：请求错误<br />1000004：入口节点已存在 |
401
| msg | str | 错误信息 | 默认为0 |
402
| message | str | 错误信息 | 默认为0 |
403
| ttl | num | 1 | |
404
| data | obj | 数据本体 | 详见[会话对象](#会话对象) |
405
406
**示例：**
407
408
获取会话`talker_id=293793435&session_type=1`的详细信息：
409
410
```shell
411
curl -G 'https://api.vc.bilibili.com/session_svr/v1/session_svr/session_detail' \
412
--data-urlencode 'talker_id=293793435' \
413
--data-urlencode 'session_type=1' \
414
--data-urlencode 'build=0' \
415
--data-urlencode 'mobi_app=web' \
416
-b 'SESSDATA=xxx'
417
```
418
419
<details>
420
<summary>查看响应示例：</summary>
421
422
```json
423
{
424
"code": 0,
425
"msg": "0",
426
"message": "0",
427
"ttl": 1,
428
"data": {
429
"talker_id": 293793435,
430
"session_type": 1,
431
"at_seqno": 0,
432
"top_ts": 0,
433
"group_name": "",
434
"group_cover": "",
435
"is_follow": 1,
436
"is_dnd": 0,
437
"ack_seqno": 1236306587877408,
438
"ack_ts": 1709536984481314,
439
"session_ts": 1709385615744065,
440
"unread_count": 0,
441
"last_msg": {
442
"sender_uid": 293793435,
443
"receiver_type": 1,
444
"receiver_id": 425503913,
445
"msg_type": 11,
446
"content": "{\"title\":\"OHHHHHH家人们，我分数终于破w了！紫框了这下确实不好意思说自己是只打红谱的萌新了\",\"times\":14,\"cover\":\"http://i0.hdslb.com/bfs/archive/8821c03ab27a0bcf2bf32af814e758ab17a1e27e.png\",\"rid\":1951316064,\"type_\":8,\"desc\":\"OHHHHHH家人们，我分数终于破w了！紫框了这下确实不好意思说自己是只打红谱的萌新了\",\"bvid\":\"BV1zC411p7JN\",\"view\":452,\"danmaku\":0,\"pub_date\":1709385603,\"attach_msg\":null}",
447
"msg_seqno": 1236306587877408,
448
"timestamp": 1709385615,
449
"at_uids": null,
450
"msg_key": 7341755312943193481,
451
"msg_status": 0,
452
"notify_code": "",
453
"new_face_version": 1,
454
"msg_source": 6
455
},
456
"group_type": 0,
457
"can_fold": 0,
458
"status": 0,
459
"max_seqno": 1236306587877408,
460
"new_push_msg": 0,
461
"setting": 0,
462
"is_guardian": 0,
463
"is_intercept": 0,
464
"is_trust": 0,
465
"system_msg_type": 0,
466
"live_status": 0,
467
"biz_msg_unread_count": 0,
468
"user_label": null
469
}
470
}
471
```
472
473
</details>
474
475
475
## 私信消息记录
476
476
477
477
> https://api.vc.bilibili.com/svr_sync/v1/svr_sync/fetch_session_msgs
@@ -480,6 +480,8 @@ curl -G 'https://api.vc.bilibili.com/session_svr/v1/session_svr/new_sessions' \
480
480
481
481
认证方式：Cookie（SESSDATA）
482
482
483
仅调用该接口不会设置私信为已读，详见[设置私信为已读](#设置私信为已读)
484
483
485
此接口有设计缺陷，可以获取已经撤回的私信内容
484
486
485
487
**url参数：**
@@ -619,6 +621,71 @@ curl -G 'https://api.vc.bilibili.com/svr_sync/v1/svr_sync/fetch_session_msgs' \
619
621
620
622
</details>
621
623
624
## 设置私信为已读
625
626
> https://api.vc.bilibili.com/session_svr/v1/session_svr/update_ack
627
628
*请求方式：POST*
629
630
认证方式：Cookie（SESSDATA）
631
632
将指定消息及以前的消息设置为已读
633
634
**正文参数（application/x-www-form-urlencoded）：**
635
636
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
637
| ------------ | ---- | ------------------------ | ------ | ---------------------------------------------------- |
638
| talker_id | num | 聊天对象的id | 必要 | `session_type` 为 `1` 时表示用户 mid，为 `2` 时表示粉丝团 id |
639
| session_type | num | 聊天对象的类型 | 必要 | 1：用户<br />2：粉丝团 |
640
| ack_seqno | num | 设置为已读的消息序列号 | 必要 | |
641
| csrf_token | str | CSRF Token（位于cookie） | 必要 | |
642
| csrf | str | CSRF Token（位于cookie） | 必要 | |
643
| build | num | 客户端内部版本号 | 非必要 | 默认为 `0` |
644
| mobi_app | str | 平台标识 | 非必要 | 可为 `web` 等 |
645
646
**json回复：**
647
648
根对象：
649
650
| 字段 | 类型 | 内容 | 备注 |
651
| ------- | ---- | -------- | ------------------------------------------------- |
652
| code | num | 返回值 | 0：成功<br />-101：账号未登录<br />-400：请求错误 |
653
| msg | str | 错误信息 | 成功时为0 |
654
| message | str | 错误信息 | 成功时为0 |
655
| ttl | num | | 默认为1 |
656
| data | 有效时：obj<br />无效时：不存在该项 | 信息本体 | |
657
658
`data`对象：
659
660
一个不含任何项目的对象，即 `{}`
661
662
**示例：**
663
664
将`talker_id=293793435`、`session_type=1`的`ack_seqno=1236306587877408`消息及之前的消息设置为已读
665
666
```shell
667
curl 'ttps://api.vc.bilibili.com/session_svr/v1/session_svr/update_ack' \
668
--data-urlencode 'talker_id=293793435' \
669
--data-urlencode 'session_type=1' \
670
--data-urlencode 'ack_seqno=1236306587877408' \
671
--data-urlencode 'csrf=xxx' \
672
--data-urlencode 'csrf_token=xxx' \
673
-b 'SESSDATA=xxx'
674
```
675
676
<details>
677
<summary>查看响应示例：</summary>
678
679
```json
680
{
681
"code": 0,
682
"msg": "0",
683
"message": "0",
684
"ttl": 1,
685
"data": {}
686
}
687
```
688
622
689
## 发送私信（web端）
623
690
624
691
> https://api.vc.bilibili.com/web_im/v1/web_im/send_msg
@@ -627,6 +694,8 @@ curl -G 'https://api.vc.bilibili.com/svr_sync/v1/svr_sync/fetch_session_msgs' \
627
694
628
695
认证方式：Cookie（SESSDATA）
629
696
697
调用该接口同时会将该会话的最近一条私信设置为已读
698
630
699
**正文参数（application/x-www-form-urlencoded）：**
631
700
632
701
| 参数名 | 类型 | 内容 | 必要性 | 备注 |