@wenbin_wb/dsh-bridge 2.2.4 → 2.2.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +70 -6
- package/README.zh-CN.md +70 -6
- package/client/client.js +542 -183
- package/client/index.js +475 -165
- package/docs/qq-usage.md +385 -0
- package/lib/bridge-rpc-constants.js +1 -0
- package/lib/bridge-rpc.js +5 -0
- package/lib/index.js +88 -8
- package/lib/platform/conversation-bridge.js +5 -3
- package/lib/qq/index.js +2 -0
- package/lib/tunnel-client.mjs +0 -3
- package/lib/wechat/node.js +42 -16
- package/package.json +3 -2
package/docs/qq-usage.md
ADDED
|
@@ -0,0 +1,385 @@
|
|
|
1
|
+
# QQ Bot 使用指南
|
|
2
|
+
|
|
3
|
+
本文档介绍如何接入 QQ Bot OpenAPI v2,实现私聊、群聊、流式输出、按钮交互、消息引用和富媒体消息。
|
|
4
|
+
|
|
5
|
+
## ✨ v2.1.1 新特性
|
|
6
|
+
|
|
7
|
+
- **🚀 流式消息输出**:长文本自动分段推送(200字符/段),实时看到 AI 输出
|
|
8
|
+
- **💬 消息引用交互**:直接回复机器人消息即可继续对话,无需输入命令
|
|
9
|
+
- **🔘 按钮快捷操作**:无活动会话时自动显示快捷按钮(新建会话/列表/帮助)
|
|
10
|
+
- **⚡ 互动事件支持**:按钮点击自动映射到对应命令
|
|
11
|
+
|
|
12
|
+
## 前置准备
|
|
13
|
+
|
|
14
|
+
### 1. 创建 QQ 机器人
|
|
15
|
+
|
|
16
|
+
访问 [QQ 开放平台](https://q.qq.com/) 创建机器人应用:
|
|
17
|
+
|
|
18
|
+
1. 登录并进入"机器人管理"
|
|
19
|
+
2. 点击"创建机器人",填写基本信息
|
|
20
|
+
3. 创建完成后获取 **AppID** 和 **ClientSecret**(开发设置 → 开发信息)
|
|
21
|
+
4. 配置机器人权限:
|
|
22
|
+
- 私域机器人:可接收私聊和群聊消息
|
|
23
|
+
- 需要开通"发送消息"、"接收消息"等基础权限
|
|
24
|
+
|
|
25
|
+
### 2. 配置事件订阅
|
|
26
|
+
|
|
27
|
+
QQ Bot 使用 WebSocket 接收事件,需要配置 Intents(事件订阅):
|
|
28
|
+
|
|
29
|
+
- **C2C_MESSAGE_CREATE**(私聊消息):`1 << 25`
|
|
30
|
+
- **GROUP_AT_MESSAGE_CREATE**(群聊 @提及):`1 << 25`(与私聊同属 `GROUP_AND_C2C_EVENT`)
|
|
31
|
+
- **INTERACTION_CREATE**(互动事件):`1 << 26`
|
|
32
|
+
|
|
33
|
+
> dsh-bridge 默认已开启以上三个 intents,支持私聊、群聊和按钮交互,无需额外配置。
|
|
34
|
+
|
|
35
|
+
## 快速开始
|
|
36
|
+
|
|
37
|
+
### 1. 启动 dsh-bridge
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# 安装最新版本
|
|
41
|
+
npm install -g @wenbin_wb/dsh-bridge@latest
|
|
42
|
+
|
|
43
|
+
# 启动服务
|
|
44
|
+
dsh web
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
访问 `http://127.0.0.1:3080`,在平台选择器中选择"QQ"。
|
|
48
|
+
|
|
49
|
+
### 2. 配置 QQ Bot 凭证
|
|
50
|
+
|
|
51
|
+
在"未配置"区域填写:
|
|
52
|
+
|
|
53
|
+
- **AppID**:QQ 开放平台应用的 AppID
|
|
54
|
+
- **ClientSecret**:应用的 ClientSecret(密钥不会回传浏览器,留空表示沿用已保存密钥)
|
|
55
|
+
|
|
56
|
+
点击"保存并连接",系统会自动:
|
|
57
|
+
1. 保存凭证到 `$DSH_HOME/dsh-bridge/config.json`
|
|
58
|
+
2. 获取 Access Token(自动刷新,TTL 7200s)
|
|
59
|
+
3. 连接 WebSocket Gateway
|
|
60
|
+
4. 开始接收消息事件
|
|
61
|
+
|
|
62
|
+
### 3. 配置白名单
|
|
63
|
+
|
|
64
|
+
保存凭证后,在"高级设置"中添加允许的用户/群组 ID:
|
|
65
|
+
|
|
66
|
+
- **私聊**:用户的 `user_openid`(形如 `11112222333344445555AAAAAAAAAAAA`)
|
|
67
|
+
- **群聊**:群组的 `group_openid`(形如 `1A2B3C4D5E6F7890ABCDEFABCDEFABCD`)
|
|
68
|
+
|
|
69
|
+
> **如何获取 OpenID**:
|
|
70
|
+
> 1. 先不设置白名单,用户/群组发送消息后查看日志
|
|
71
|
+
> 2. 日志中会显示"未在白名单中,已忽略",复制其中的 OpenID
|
|
72
|
+
> 3. 将 OpenID 添加到白名单并保存
|
|
73
|
+
|
|
74
|
+
### 4. 开始对话
|
|
75
|
+
|
|
76
|
+
#### 私聊场景
|
|
77
|
+
|
|
78
|
+
1. 在 QQ 中搜索并添加你的机器人为好友
|
|
79
|
+
2. 发送任意消息,机器人会回复带按钮的欢迎提示:
|
|
80
|
+
- 🆕 **新建会话**:创建新的 AI 对话
|
|
81
|
+
- 📋 **会话列表**:查看所有可用会话
|
|
82
|
+
- ❓ **帮助**:显示命令帮助
|
|
83
|
+
3. 点击「新建会话」按钮开始对话
|
|
84
|
+
4. 或者直接回复机器人的任何消息,自动创建新会话并继续对话
|
|
85
|
+
|
|
86
|
+
#### 群聊场景
|
|
87
|
+
|
|
88
|
+
1. 将机器人拉入 QQ 群
|
|
89
|
+
2. 在群内 @机器人 并发送消息(例如:`@机器人 你好`)
|
|
90
|
+
3. 机器人会响应并提供快捷按钮
|
|
91
|
+
4. 后续可以:
|
|
92
|
+
- 点击按钮快捷操作
|
|
93
|
+
- 回复机器人的消息继续对话
|
|
94
|
+
- @机器人 发送新消息
|
|
95
|
+
|
|
96
|
+
### 5. 流式输出与输入状态
|
|
97
|
+
|
|
98
|
+
#### 流式输出(单聊全回复流式 Markdown)
|
|
99
|
+
|
|
100
|
+
**单聊中所有 AI 回复统一走流式接口**,手机端实时看到消息逐段增长,且 Markdown 正常渲染:
|
|
101
|
+
|
|
102
|
+
- **流式**:使用官方 `/stream_messages`(下划线)接口 + `replace` 覆盖模式(官方推荐),每片是全量前缀,服务端逐片覆盖 → 一条消息逐渐变长
|
|
103
|
+
- **Markdown**:流式内容用 `content_type: markdown`,手机端正常渲染粗体/代码块/列表等,不再显示原始语法
|
|
104
|
+
- **分段**:按段落边界切分,短消息自动拆两片保证"生成中→生成结束"过渡;每片带递增 `msg_seq` 避免去重
|
|
105
|
+
- **安全转换**:QQ 不支持的表格自动降级为纯文本,`![图片]()` 转成链接,代码块内容原样保留
|
|
106
|
+
- **回退**:流式失败时补发完整内容 replace 收尾,再失败降级「主动 Markdown」,确保消息必达
|
|
107
|
+
- **群聊**:官方不支持群消息流式,群聊回复直接发送 Markdown
|
|
108
|
+
|
|
109
|
+
#### 输入状态指示
|
|
110
|
+
|
|
111
|
+
AI 生成过程中,QQ 会显示机器人的"正在输入"状态:
|
|
112
|
+
|
|
113
|
+
- **实现方式**:普通消息接口 `msg_type: 6` + `input_notify`
|
|
114
|
+
- **参数**:`input_notify: { input_type: 1, input_second: 8 }`(最长 60 秒)
|
|
115
|
+
- **自动管理**:收到用户消息后、发送回复前自动显示"正在输入"
|
|
116
|
+
- **API 文档**:[发送单聊消息](https://bot.q.qq.com/wiki/develop/api-v2/autogen/api/v2_users_user_openid_messages.post.html)
|
|
117
|
+
|
|
118
|
+
### 6. 指令面板与自定义菜单(v2.2.0)
|
|
119
|
+
|
|
120
|
+
连接成功后,dsh-bridge 会自动为你的机器人配置:
|
|
121
|
+
|
|
122
|
+
> **⚠️ 重要提示**(2026-08-20 确认):
|
|
123
|
+
> - **自定义菜单、指令面板、消息按钮是 2026-08-12 刚上线的新功能**([官方变更记录](https://bot.qq.com/wiki/develop/api-v2/changelog.html))
|
|
124
|
+
> - **需要最新版 QQ 客户端**才能显示(手机版 QQ 优先支持新功能,桌面版可能延后)
|
|
125
|
+
> - 若 API 配置成功(`PUT /v2/menu` 返回 version、`GET /v2/panels` 有 records)但客户端不显示,是**正常现象**——更新 QQ 到最新版再试
|
|
126
|
+
> - 功能可能在**灰度期**,未全量开放;无权限时纯文字命令(`/new` `/sessions` `/help`)仍完全可用
|
|
127
|
+
|
|
128
|
+
#### 指令面板(单聊 + 群聊常驻)
|
|
129
|
+
|
|
130
|
+
在单聊窗口和群聊中常驻显示命令面板,点击即可填入命令:
|
|
131
|
+
|
|
132
|
+
| 面板项 | 说明 |
|
|
133
|
+
|--------|------|
|
|
134
|
+
| `/new` | 新建对话 |
|
|
135
|
+
| `/list` | 查看会话列表 |
|
|
136
|
+
| `/resume` | 恢复会话 |
|
|
137
|
+
| `/sessions` | 切换会话 |
|
|
138
|
+
| `/help` | 命令帮助 |
|
|
139
|
+
|
|
140
|
+
面板按 `c2c`(单聊)和 `group`(群聊)两个场景各创建一个全局面板,幂等创建(不会重复)。
|
|
141
|
+
|
|
142
|
+
#### 自定义菜单(单聊底部)
|
|
143
|
+
|
|
144
|
+
单聊窗口底部常驻菜单,点击自动填入命令:
|
|
145
|
+
|
|
146
|
+
- **新建** → 自动填入 `/new`
|
|
147
|
+
- **列表** → 自动填入 `/list`
|
|
148
|
+
- **帮助** → 自动填入 `/help`
|
|
149
|
+
|
|
150
|
+
> 相关 API 文档:
|
|
151
|
+
> - [自定义菜单与指令面板](https://bot.q.qq.com/wiki/develop/api-v2/server-inter/menu-panel/)
|
|
152
|
+
> - [创建指令面板](https://bot.q.qq.com/wiki/develop/api-v2/autogen/api/v2_panels.post.html)
|
|
153
|
+
> - [修改全局自定义菜单](https://bot.q.qq.com/wiki/develop/api-v2/autogen/api/v2_menu.put.html)
|
|
154
|
+
|
|
155
|
+
## 功能特性
|
|
156
|
+
|
|
157
|
+
### 交互方式
|
|
158
|
+
|
|
159
|
+
#### 1. 快捷按钮(推荐)
|
|
160
|
+
|
|
161
|
+
当没有活动会话时,机器人会自动发送带按钮的提示:
|
|
162
|
+
|
|
163
|
+
- **🆕 新建会话**:点击后立即创建新的 AI 对话
|
|
164
|
+
- **📋 会话列表**:查看所有可用会话及其编号
|
|
165
|
+
- **❓ 帮助**:显示所有可用命令
|
|
166
|
+
|
|
167
|
+
按钮点击会触发 `INTERACTION_CREATE` 事件,自动映射到对应命令。
|
|
168
|
+
|
|
169
|
+
#### 2. 消息引用(最便捷)
|
|
170
|
+
|
|
171
|
+
直接回复机器人的任何消息,自动关联到对应会话:
|
|
172
|
+
|
|
173
|
+
1. 机器人发送回复
|
|
174
|
+
2. 你使用 QQ 的"引用回复"功能回复该消息
|
|
175
|
+
3. 如果没有活动会话,自动创建新会话
|
|
176
|
+
4. 你的消息会发送到 AI,无需输入 `/new` 等命令
|
|
177
|
+
|
|
178
|
+
> **提示**:这是最自然的交互方式,就像正常聊天一样。
|
|
179
|
+
|
|
180
|
+
#### 3. 文本命令(兼容性)
|
|
181
|
+
|
|
182
|
+
所有操作都支持传统文本命令:
|
|
183
|
+
|
|
184
|
+
- `/new <提示词>` - 新建会话并开始
|
|
185
|
+
- `/sessions`(或 `/list`)- 列出所有会话(按工作区分组)
|
|
186
|
+
- `/use N`(或 `/resume N`)- 切换到/恢复会话 N
|
|
187
|
+
- `/end` - 结束当前会话(清除活动会话并触发快捷按钮)
|
|
188
|
+
- `/stop` - 停止当前任务
|
|
189
|
+
- `/status` - 查看状态与会话摘要
|
|
190
|
+
- `/workspaces` - 列出可用工作区
|
|
191
|
+
- `/help` - 显示帮助
|
|
192
|
+
|
|
193
|
+
### 支持的消息类型
|
|
194
|
+
|
|
195
|
+
| 类型 | 方法 | 说明 |
|
|
196
|
+
|------|------|------|
|
|
197
|
+
| 文本消息 | `sendText(scope, text)` | 纯文本消息 |
|
|
198
|
+
| 流式消息 | `sendStream(scope, text, opts)` | 长文本自动分段推送(200字符/段) |
|
|
199
|
+
| Markdown | `sendMarkdown(scope, markdown, keyboard)` | 支持 Markdown 格式 + 可选按钮 |
|
|
200
|
+
| 按钮键盘 | `sendKeyboard(scope, text, keyboard)` | 文本 + 按钮组(行内按钮) |
|
|
201
|
+
| 富媒体 | `sendMedia(scope, type, buffer, filename)` | 图片/视频/音频/文件上传 |
|
|
202
|
+
|
|
203
|
+
### 流式消息示例
|
|
204
|
+
|
|
205
|
+
```javascript
|
|
206
|
+
// 发送长文本,自动分段推送
|
|
207
|
+
await gateway.sendStream(
|
|
208
|
+
'u_11112222333344445555AAAAAAAAAAAA', // user_openid
|
|
209
|
+
'这是一段很长的 AI 回复内容...',
|
|
210
|
+
{ msgId: 'parent_msg_id' } // 可选:关联到某条消息
|
|
211
|
+
)
|
|
212
|
+
// 自动分段为 200 字符/段,每段间隔 100ms
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### Markdown 示例
|
|
216
|
+
|
|
217
|
+
```javascript
|
|
218
|
+
await gateway.sendMarkdown(
|
|
219
|
+
'u_11112222333344445555AAAAAAAAAAAA', // user_openid
|
|
220
|
+
'# 标题\n**粗体** *斜体* `代码`\n[链接](https://example.com)',
|
|
221
|
+
{
|
|
222
|
+
content: {
|
|
223
|
+
rows: [
|
|
224
|
+
{
|
|
225
|
+
buttons: [
|
|
226
|
+
{ id: '1', render_data: { label: '选项 A', style: 1 }, action: { type: 2, data: '/cmd_a' } },
|
|
227
|
+
{ id: '2', render_data: { label: '选项 B', style: 0 }, action: { type: 2, data: '/cmd_b' } }
|
|
228
|
+
]
|
|
229
|
+
}
|
|
230
|
+
]
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
)
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
### 按钮交互
|
|
237
|
+
|
|
238
|
+
按钮类型(`action.type`):
|
|
239
|
+
- `0` — 跳转按钮(`action.data` 为 URL)
|
|
240
|
+
- `1` — 回调按钮(触发 `INTERACTION_CREATE` 事件)✅ dsh-bridge 快捷按钮使用此类型
|
|
241
|
+
- `2` — 指令按钮(用户点击后自动发送 `action.data` 作为消息)
|
|
242
|
+
|
|
243
|
+
按钮样式(`render_data.style`):
|
|
244
|
+
- `0` — 灰色线框(次要操作)
|
|
245
|
+
- `1` — 蓝色线框(主要操作)
|
|
246
|
+
|
|
247
|
+
> **按钮结构(v2.2.4 对齐官方)**:`keyboard.content.rows`(含 `content` 包裹层),按钮必填 `render_data.style` / `action.data` / `action.unsupport_tips`。快捷按钮基于 `msg_type=2`(Markdown)挂载。
|
|
248
|
+
|
|
249
|
+
> **v2.2.4 互动事件处理**:仅消息按钮(type=11)与快捷菜单(type=12)需要调用 `PUT /interactions/{id}` 回应;其他类型(消息反馈/清空会话/授权等)无需回应。点击快捷按钮会自动映射到对应命令(如 `/new`、`/list`、`/help`)。
|
|
250
|
+
|
|
251
|
+
### 富媒体上传
|
|
252
|
+
|
|
253
|
+
```javascript
|
|
254
|
+
// 发送图片
|
|
255
|
+
const imageBuffer = fs.readFileSync('image.png')
|
|
256
|
+
await gateway.sendMedia(
|
|
257
|
+
'g_1A2B3C4D5E6F7890ABCDEFABCDEFABCD', // group_openid
|
|
258
|
+
'image', // image | video | audio | file
|
|
259
|
+
imageBuffer,
|
|
260
|
+
'screenshot.png'
|
|
261
|
+
)
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
支持的媒体类型:
|
|
265
|
+
- `image` — 图片(PNG/JPG/GIF,< 10MB)
|
|
266
|
+
- `video` — 视频(MP4,< 50MB)
|
|
267
|
+
- `audio` — 音频(MP3/WAV,< 10MB)
|
|
268
|
+
- `file` — 文件(任意类型,< 20MB)
|
|
269
|
+
|
|
270
|
+
## 高级配置
|
|
271
|
+
|
|
272
|
+
### 会话管理
|
|
273
|
+
|
|
274
|
+
在 UI 的"高级设置"中配置:
|
|
275
|
+
|
|
276
|
+
- **摘要间隔**(`digestIntervalSec`,默认 300s):多久向 Agent 发送一次历史消息摘要
|
|
277
|
+
- ✅ **微信**:生效
|
|
278
|
+
- ✅ **QQ**:生效
|
|
279
|
+
- **审批超时**(`approvalTimeoutSec`,默认 600s):等待用户审批的最长时间
|
|
280
|
+
- ✅ **微信**:生效
|
|
281
|
+
- ✅ **QQ**:生效
|
|
282
|
+
- **每条最大字数**(`maxMessageChars`,默认 2000):单条流式消息最大字符数,超出会拆成多条
|
|
283
|
+
- ✅ **微信**:生效(超出拆分为多条普通文本消息,间隔 `sendChunkDelayMs`)
|
|
284
|
+
- ✅ **QQ**:生效(v2.2.2+ 修复,超出拆分为多片流式消息,每片按此配置切分)
|
|
285
|
+
- **分块延迟**(`sendChunkDelayMs`,默认 1500ms):多条消息之间的延迟,避免刷屏
|
|
286
|
+
- ✅ **微信**:生效(拆分的多条普通文本消息间隔)
|
|
287
|
+
- ✅ **QQ**:生效(v2.2.2+ 修复,流式消息多片间隔)
|
|
288
|
+
|
|
289
|
+
### Token 自动刷新
|
|
290
|
+
|
|
291
|
+
Access Token 有效期为 7200 秒(2 小时),dsh-bridge 会在过期前 5 分钟自动刷新,无需手动处理。
|
|
292
|
+
|
|
293
|
+
### 消息去重
|
|
294
|
+
|
|
295
|
+
WebSocket 可能收到重复消息(如网络抖动、重连),Gateway 使用 `msg_id` 去重(TTL 300s),确保同一消息不会被处理多次。
|
|
296
|
+
|
|
297
|
+
### 断线重连
|
|
298
|
+
|
|
299
|
+
Gateway 实现指数退避重连策略:
|
|
300
|
+
- 初始延迟:1s
|
|
301
|
+
- 最大延迟:60s
|
|
302
|
+
- 每次失败后延迟翻倍(1s → 2s → 4s → 8s → ...)
|
|
303
|
+
- 心跳超时(40s 未收到 `HEARTBEAT_ACK`)自动重连
|
|
304
|
+
|
|
305
|
+
## 故障排查
|
|
306
|
+
|
|
307
|
+
### 1. 连接失败
|
|
308
|
+
|
|
309
|
+
**症状**:UI 显示"未配置"或"已停止"
|
|
310
|
+
|
|
311
|
+
**排查**:
|
|
312
|
+
1. 检查 AppID 和 ClientSecret 是否正确
|
|
313
|
+
2. 查看浏览器控制台 Network 面板,检查 `platformLogin` 请求是否返回错误
|
|
314
|
+
3. 检查 DSH 终端日志,搜索"QQ"关键词
|
|
315
|
+
|
|
316
|
+
### 2. 收不到消息
|
|
317
|
+
|
|
318
|
+
**症状**:用户发送消息后机器人无响应
|
|
319
|
+
|
|
320
|
+
**排查**:
|
|
321
|
+
1. 确认用户/群组 OpenID 已添加到白名单
|
|
322
|
+
2. 群聊消息需要 @机器人 才会触发
|
|
323
|
+
3. 检查机器人权限是否开通"接收消息"
|
|
324
|
+
4. 查看 DSH 终端日志,确认是否收到 `C2C_MESSAGE_CREATE` 或 `GROUP_AT_MESSAGE_CREATE` 事件
|
|
325
|
+
|
|
326
|
+
### 3. 发送消息失败
|
|
327
|
+
|
|
328
|
+
**症状**:DSH Agent 回复后,QQ 不显示消息
|
|
329
|
+
|
|
330
|
+
**排查**:
|
|
331
|
+
1. 检查机器人权限是否开通"发送消息"
|
|
332
|
+
2. 查看终端日志中的 API 请求错误(状态码、错误信息)
|
|
333
|
+
3. 确认消息内容符合 QQ 限制(文本 < 4096 字符,媒体文件大小限制)
|
|
334
|
+
|
|
335
|
+
### 4. Token 过期
|
|
336
|
+
|
|
337
|
+
**症状**:运行一段时间后突然无法发送消息
|
|
338
|
+
|
|
339
|
+
**排查**:
|
|
340
|
+
1. 正常情况下 Token 会自动刷新,如果频繁过期可能是 ClientSecret 错误
|
|
341
|
+
2. 检查终端日志中的"刷新 Access Token"记录
|
|
342
|
+
3. 手动重新保存凭证触发立即刷新
|
|
343
|
+
|
|
344
|
+
## 参考资料
|
|
345
|
+
|
|
346
|
+
- [QQ Bot API v2 官方文档](https://bot.q.qq.com/wiki/develop/api-v2/)
|
|
347
|
+
- [获取访问凭证](https://bot.q.qq.com/wiki/develop/api-v2/dev-prepare/access-token.html)
|
|
348
|
+
- [WebSocket 事件](https://bot.q.qq.com/wiki/develop/api-v2/dev-prepare/event-emit/websocket.html)
|
|
349
|
+
- [消息收发](https://bot.q.qq.com/wiki/develop/api-v2/server-inter/message/overview.html)
|
|
350
|
+
- [流式消息](https://bot.q.qq.com/wiki/develop/api-v2/server-inter/message/send-receive/passive.html#%E6%B6%88%E6%81%AF%E6%B5%81%E5%BC%8F%E6%8E%A8%E9%80%81)
|
|
351
|
+
- [Markdown 消息](https://bot.q.qq.com/wiki/develop/api-v2/server-inter/message/type/markdown.html)
|
|
352
|
+
- [消息按钮](https://bot.q.qq.com/wiki/develop/api-v2/server-inter/message/trans/msg-btn.html)
|
|
353
|
+
- [富媒体消息](https://bot.q.qq.com/wiki/develop/api-v2/server-inter/message/send-receive/rich-media.html)
|
|
354
|
+
|
|
355
|
+
## 版本历史
|
|
356
|
+
|
|
357
|
+
### v2.2.0
|
|
358
|
+
- 🔧 API 域名统一为 `api.bot.qq.com`(官方 2026-08-10 变更)
|
|
359
|
+
- 🔧 修复流式消息:路径 `stream_messages`(下划线)、参数对齐官方、改用 `append` 追加模式
|
|
360
|
+
- 🔧 输入状态改用 `msg_type: 6` + `input_notify`
|
|
361
|
+
- 🔧 键盘消息改用 `msg_type: 0` + `content` + `keyboard`
|
|
362
|
+
- 🔧 修复被动回复 msg_id(用用户消息事件 ID)
|
|
363
|
+
- 🔧 修复群聊 scope 传递 bug
|
|
364
|
+
- ✨ 新增指令面板全套 API,连接后自动创建单聊/群聊命令面板
|
|
365
|
+
- ✨ 新增自定义菜单 API,自动配置单聊底部菜单
|
|
366
|
+
|
|
367
|
+
### v2.1.1
|
|
368
|
+
- ✨ 流式消息输出:长文本自动分段推送
|
|
369
|
+
- ✨ 消息引用:检测 `message_reference`,用户回复消息时自动创建会话
|
|
370
|
+
- ✨ 按钮交互:无活动会话时发送快捷按钮(新建会话/列表/帮助)
|
|
371
|
+
- ✨ 事件增强:启用 `INTERACTION_CREATE` intent,支持按钮点击映射到命令
|
|
372
|
+
|
|
373
|
+
### v2.1.0
|
|
374
|
+
- 🎉 初始版本:QQ Bot OpenAPI v2 完整实现
|
|
375
|
+
- ✨ 私聊、群聊、Markdown、按钮、富媒体
|
|
376
|
+
- ✨ 平台抽象层集成
|
|
377
|
+
- ✨ Web UI 自动适配
|
|
378
|
+
|
|
379
|
+
## 示例项目
|
|
380
|
+
|
|
381
|
+
完整示例代码见仓库:
|
|
382
|
+
- Gateway 实现:`lib/qq/gateway.js`
|
|
383
|
+
- Platform 适配器:`lib/qq/index.js`
|
|
384
|
+
- ConversationBridge 适配:`lib/qq/node.js`
|
|
385
|
+
- 单元测试:`test/qq-service.test.mjs`
|
|
@@ -11,6 +11,7 @@ export const BRIDGE_ENDPOINTS = {
|
|
|
11
11
|
resetCloudflared: 'resetCloudflared',
|
|
12
12
|
saveCustomTunnelConfig: 'saveCustomTunnelConfig',
|
|
13
13
|
checkVersion: 'checkVersion',
|
|
14
|
+
upgradePlugin: 'upgradePlugin',
|
|
14
15
|
// 平台管理器(多 IM 平台统一接口)
|
|
15
16
|
listPlatforms: 'listPlatforms',
|
|
16
17
|
platformLogin: 'platformLogin',
|
package/lib/bridge-rpc.js
CHANGED
|
@@ -123,6 +123,11 @@ export function installBridgeRpc(ctx, { service, wechat, platformManager, logger
|
|
|
123
123
|
return ok(result);
|
|
124
124
|
}
|
|
125
125
|
|
|
126
|
+
if (endpoint === BRIDGE_ENDPOINTS.upgradePlugin) {
|
|
127
|
+
const result = await service.upgradePlugin(payload);
|
|
128
|
+
return ok(result);
|
|
129
|
+
}
|
|
130
|
+
|
|
126
131
|
// ---- 平台管理器(多 IM 平台)----
|
|
127
132
|
|
|
128
133
|
if (endpoint === BRIDGE_ENDPOINTS.listPlatforms) {
|
package/lib/index.js
CHANGED
|
@@ -12,6 +12,7 @@ import { join, dirname } from 'node:path';
|
|
|
12
12
|
import { fileURLToPath } from 'node:url';
|
|
13
13
|
import { readFileSync } from 'node:fs';
|
|
14
14
|
import { readFile, writeFile, mkdir, unlink } from 'node:fs/promises';
|
|
15
|
+
import { exec } from 'node:child_process';
|
|
15
16
|
import QRCode from 'qrcode';
|
|
16
17
|
import { installBridgeRpc } from './bridge-rpc.js';
|
|
17
18
|
import { CustomTunnelClient } from './tunnel-client.mjs';
|
|
@@ -406,24 +407,64 @@ class BridgeService {
|
|
|
406
407
|
this.cloudflaredState = { phase: 'idle', detail: '' };
|
|
407
408
|
}
|
|
408
409
|
|
|
409
|
-
// 检查 npm
|
|
410
|
+
// 检查 npm 上是否有新版本(优先国内高速镜像 npmmirror,降级 npmjs 官方源)
|
|
410
411
|
async checkVersion() {
|
|
411
|
-
|
|
412
|
-
const req = httpsGet(
|
|
412
|
+
const fetchRegistry = (url, timeoutMs = 4000) => new Promise((resolve, reject) => {
|
|
413
|
+
const req = httpsGet(url, { timeout: timeoutMs }, (res) => {
|
|
414
|
+
if (res.statusCode !== 200) return reject(new Error(`HTTP ${res.statusCode}`));
|
|
413
415
|
const chunks = [];
|
|
414
416
|
res.on('data', (c) => chunks.push(c));
|
|
415
417
|
res.on('end', () => {
|
|
416
418
|
try {
|
|
417
419
|
const data = JSON.parse(Buffer.concat(chunks).toString());
|
|
418
|
-
resolve(
|
|
419
|
-
} catch {
|
|
420
|
-
|
|
420
|
+
resolve(data.version ?? null);
|
|
421
|
+
} catch (e) {
|
|
422
|
+
reject(e);
|
|
421
423
|
}
|
|
422
424
|
});
|
|
423
425
|
});
|
|
424
|
-
req.on('error',
|
|
425
|
-
req.on('timeout', () => { req.destroy();
|
|
426
|
+
req.on('error', reject);
|
|
427
|
+
req.on('timeout', () => { req.destroy(); reject(new Error('请求超时')); });
|
|
426
428
|
});
|
|
429
|
+
|
|
430
|
+
try {
|
|
431
|
+
const latest = await fetchRegistry('https://registry.npmmirror.com/@wenbin_wb/dsh-bridge/latest', 3500)
|
|
432
|
+
.catch(() => fetchRegistry('https://registry.npmjs.org/@wenbin_wb/dsh-bridge/latest', 5000));
|
|
433
|
+
return { current: VERSION, latest: latest ?? null };
|
|
434
|
+
} catch (e) {
|
|
435
|
+
return { current: VERSION, latest: null, error: e.message ?? '检查失败' };
|
|
436
|
+
}
|
|
437
|
+
}
|
|
438
|
+
|
|
439
|
+
// 一键直接升级插件(执行 dsh plugin / pnpm / npm 自动升级)
|
|
440
|
+
async upgradePlugin({ version } = {}) {
|
|
441
|
+
const targetVersion = version ? String(version).trim() : 'latest';
|
|
442
|
+
const pkgSpec = `@wenbin_wb/dsh-bridge@${targetVersion}`;
|
|
443
|
+
const commands = [
|
|
444
|
+
`dsh plugin --profile web add ${pkgSpec}`,
|
|
445
|
+
`npx --yes @deepseek-ai/dsh plugin --profile web add ${pkgSpec}`,
|
|
446
|
+
`npm install ${pkgSpec}`,
|
|
447
|
+
];
|
|
448
|
+
|
|
449
|
+
let lastError = null;
|
|
450
|
+
let output = '';
|
|
451
|
+
|
|
452
|
+
for (const cmd of commands) {
|
|
453
|
+
try {
|
|
454
|
+
const res = await new Promise((resolve, reject) => {
|
|
455
|
+
exec(cmd, { timeout: 90000, windowsHide: true }, (err, stdout, stderr) => {
|
|
456
|
+
if (err) return reject(new Error(stderr || err.message));
|
|
457
|
+
resolve({ stdout, stderr });
|
|
458
|
+
});
|
|
459
|
+
});
|
|
460
|
+
output = res.stdout || res.stderr || '升级成功';
|
|
461
|
+
return { ok: true, command: cmd, output, version: targetVersion };
|
|
462
|
+
} catch (err) {
|
|
463
|
+
lastError = err;
|
|
464
|
+
}
|
|
465
|
+
}
|
|
466
|
+
|
|
467
|
+
return { ok: false, error: lastError?.message ?? '升级命令执行失败', version: targetVersion };
|
|
427
468
|
}
|
|
428
469
|
|
|
429
470
|
async dispose() {
|
|
@@ -514,6 +555,45 @@ function apply(ctx, config = {}) {
|
|
|
514
555
|
});
|
|
515
556
|
platformManager.register(qq);
|
|
516
557
|
|
|
558
|
+
// 启动时读取已保存的微信 Bot 配置(凭证 + 白名单 + 活动会话)
|
|
559
|
+
loadConfig().then(async (stored) => {
|
|
560
|
+
if (stored?.wechat) {
|
|
561
|
+
const cfg = stored.wechat;
|
|
562
|
+
wechat.node.config.allowFrom = Array.isArray(cfg.allowFrom) ? cfg.allowFrom : [];
|
|
563
|
+
if (cfg.digestIntervalSec != null) wechat.node.config.digestIntervalSec = Number(cfg.digestIntervalSec);
|
|
564
|
+
if (cfg.approvalTimeoutSec != null) wechat.node.config.approvalTimeoutSec = Number(cfg.approvalTimeoutSec);
|
|
565
|
+
if (cfg.maxMessageChars != null) wechat.node.config.maxMessageChars = Number(cfg.maxMessageChars);
|
|
566
|
+
if (cfg.sendChunkDelayMs != null) wechat.node.config.sendChunkDelayMs = Number(cfg.sendChunkDelayMs);
|
|
567
|
+
|
|
568
|
+
wechat.node._restoringConfig = (async () => {
|
|
569
|
+
try {
|
|
570
|
+
if (cfg.activeSessionId) {
|
|
571
|
+
wechat.node.activeSessionId = cfg.activeSessionId;
|
|
572
|
+
logger.info('dsh-bridge: restored wechat active session: %s', cfg.activeSessionId);
|
|
573
|
+
} else {
|
|
574
|
+
await wechat.node._pickDefaultSession().catch(() => {});
|
|
575
|
+
}
|
|
576
|
+
} finally {
|
|
577
|
+
wechat.node._configRestored = true;
|
|
578
|
+
}
|
|
579
|
+
})();
|
|
580
|
+
|
|
581
|
+
await wechat.node._restoringConfig;
|
|
582
|
+
|
|
583
|
+
if (cfg.token && cfg.accountId) {
|
|
584
|
+
wechat.gateway.setCredentials({
|
|
585
|
+
token: cfg.token,
|
|
586
|
+
accountId: cfg.accountId,
|
|
587
|
+
baseUrl: cfg.baseUrl,
|
|
588
|
+
});
|
|
589
|
+
logger.info('dsh-bridge: loaded saved wechat bot config, starting gateway');
|
|
590
|
+
await wechat.start().catch((err) => {
|
|
591
|
+
logger.error('dsh-bridge: wechat auto-start failed: %s', err?.message ?? err);
|
|
592
|
+
});
|
|
593
|
+
}
|
|
594
|
+
}
|
|
595
|
+
}).catch(() => {});
|
|
596
|
+
|
|
517
597
|
// 启动时读取已保存的 QQ Bot 配置(凭证 + 白名单 + 活动会话)
|
|
518
598
|
loadConfig().then(async (stored) => {
|
|
519
599
|
if (stored?.qq) {
|
|
@@ -792,9 +792,11 @@ async function routeCommand(node, text) {
|
|
|
792
792
|
await node.sendText(helpText())
|
|
793
793
|
return true
|
|
794
794
|
case 'sessions':
|
|
795
|
+
case 'list':
|
|
795
796
|
await node.sendText(await renderSessions(node))
|
|
796
797
|
return true
|
|
797
|
-
case 'use':
|
|
798
|
+
case 'use':
|
|
799
|
+
case 'resume': {
|
|
798
800
|
const index = Number(rest[0])
|
|
799
801
|
const sessions = sessionsInDisplayOrder(await listSessions(node))
|
|
800
802
|
if (!Number.isInteger(index) || index < 1 || index > sessions.length) {
|
|
@@ -962,8 +964,8 @@ function fmtSessionId(id) {
|
|
|
962
964
|
function helpText() {
|
|
963
965
|
return [
|
|
964
966
|
`${BRIDGE_MARK.welcome} 命令`,
|
|
965
|
-
'/sessions
|
|
966
|
-
'/use N
|
|
967
|
+
'/sessions(或 /list)— 列出会话(按工作区分组)',
|
|
968
|
+
'/use N(或 /resume N)— 切换到会话 N',
|
|
967
969
|
'/workspaces — 列出可用工作区',
|
|
968
970
|
'/new <提示词> — 新建会话并开始(当前工作区)',
|
|
969
971
|
'/new <提示词> @路径 — 在指定目录新建会话',
|
package/lib/qq/index.js
CHANGED
|
@@ -141,6 +141,8 @@ export class QqService extends Platform {
|
|
|
141
141
|
approvalTimeoutSec: this.node.config.approvalTimeoutSec,
|
|
142
142
|
maxMessageChars: this.node.config.maxMessageChars,
|
|
143
143
|
sendChunkDelayMs: this.node.config.sendChunkDelayMs,
|
|
144
|
+
appId: this.gateway.config.appId,
|
|
145
|
+
clientSecret: '',
|
|
144
146
|
}
|
|
145
147
|
}
|
|
146
148
|
|
package/lib/tunnel-client.mjs
CHANGED
|
@@ -22,7 +22,6 @@ export class CustomTunnelClient {
|
|
|
22
22
|
this.reconnectAttempts = 0;
|
|
23
23
|
this.reconnectTimer = null;
|
|
24
24
|
this.heartbeatTimer = null;
|
|
25
|
-
this.pendingRequests = new Map();
|
|
26
25
|
this.localWsSockets = new Map(); // wsId -> net.Socket
|
|
27
26
|
}
|
|
28
27
|
|
|
@@ -276,8 +275,6 @@ export class CustomTunnelClient {
|
|
|
276
275
|
if (this.ws) { this.ws.close(); this.ws = null; }
|
|
277
276
|
this.connected = false;
|
|
278
277
|
this.publicUrl = null;
|
|
279
|
-
for (const [, p] of this.pendingRequests) p.reject(new Error('Disconnected'));
|
|
280
|
-
this.pendingRequests.clear();
|
|
281
278
|
this.logger?.info('Tunnel disconnected');
|
|
282
279
|
}
|
|
283
280
|
}
|