docs: update qq bot channel docs

This commit is contained in:
Peter Steinberger
2026-03-31 17:55:41 +01:00
parent 7672e48c19
commit cebe697082
2 changed files with 49 additions and 16 deletions

View File

@@ -25,7 +25,7 @@ Text is supported everywhere; media and reactions vary by channel.
- [Microsoft Teams](/channels/msteams) — Bot Framework; enterprise support (plugin, installed separately).
- [Nextcloud Talk](/channels/nextcloud-talk) — Self-hosted chat via Nextcloud Talk (plugin, installed separately).
- [Nostr](/channels/nostr) — Decentralized DMs via NIP-04 (plugin, installed separately).
- [QQ Bot](/channels/qqbot) — QQ Bot API; private chat, group chat, and rich media (plugin, installed separately).
- [QQ Bot](/channels/qqbot) — QQ Bot API; private chat, group chat, and rich media.
- [Signal](/channels/signal) — signal-cli; privacy-focused.
- [Slack](/channels/slack) — Bolt SDK; workspace apps.
- [Synology Chat](/channels/synology-chat) — Synology NAS Chat via outgoing+incoming webhooks (plugin, installed separately).

View File

@@ -1,5 +1,5 @@
---
summary: "QQ Bot channel plugin setup, config, and usage"
summary: "QQ Bot setup, config, and usage"
read_when:
- You want to connect OpenClaw to QQ
- You need QQ Bot credential setup
@@ -7,28 +7,19 @@ read_when:
title: QQ Bot
---
# QQ Bot (plugin)
# QQ Bot
QQ Bot connects to OpenClaw via the official QQ Bot API (WebSocket gateway). The
plugin supports C2C private chat, group @messages, and guild channel messages with
rich media (images, voice, video, files).
Status: supported via plugin. Direct messages, group chats, guild channels, and
Status: bundled channel plugin. Direct messages, group chats, guild channels, and
media are supported. Reactions and threads are not supported.
## Plugin required
## Bundled with OpenClaw
Install the QQ Bot plugin:
```bash
openclaw plugins install @openclaw/qqbot
```
Local checkout (when running from a git repo):
```bash
openclaw plugins install ./extensions/qqbot
```
Current OpenClaw installs bundle QQ Bot. You do not need a separate
`openclaw plugins install` step for normal setup.
## Setup
@@ -48,6 +39,13 @@ openclaw channels add --channel qqbot --token "AppID:AppSecret"
5. Restart the Gateway.
Interactive setup paths:
```bash
openclaw channels add
openclaw configure --section channels
```
## Configure
Minimal config:
@@ -64,6 +62,32 @@ Minimal config:
}
```
Default-account env vars:
- `QQBOT_APP_ID`
- `QQBOT_CLIENT_SECRET`
File-backed AppSecret:
```json5
{
channels: {
qqbot: {
enabled: true,
appId: "YOUR_APP_ID",
clientSecretFile: "/path/to/qqbot-secret.txt",
},
},
}
```
Notes:
- Env fallback applies to the default QQ Bot account only.
- `openclaw channels add --channel qqbot --token-file ...` provides the
AppSecret only; the AppID must already be set in config or `QQBOT_APP_ID`.
- `clientSecret` also accepts SecretRef input, not just a plaintext string.
### Multi-account setup
Run multiple QQ bots under a single OpenClaw instance:
@@ -125,6 +149,13 @@ STT and TTS support two-level configuration with priority fallback:
Set `enabled: false` on either to disable.
Outbound audio upload/transcode behavior can also be tuned with
`channels.qqbot.audioFormatPolicy`:
- `sttDirectFormats`
- `uploadDirectFormats`
- `transcodeEnabled`
## Target formats
| Format | Description |
@@ -155,6 +186,8 @@ Append `?` to any command for usage help (for example `/bot-upgrade ?`).
- **Bot replies "gone to Mars":** credentials not configured or Gateway not started.
- **No inbound messages:** verify `appId` and `clientSecret` are correct, and the
bot is enabled on the QQ Open Platform.
- **Setup with `--token-file` still shows unconfigured:** `--token-file` only sets
the AppSecret. You still need `appId` in config or `QQBOT_APP_ID`.
- **Proactive messages not arriving:** QQ may intercept bot-initiated messages if
the user hasn't interacted recently.
- **Voice not transcribed:** ensure STT is configured and the provider is reachable.