chore(sync): mirror docs from openclaw/openclaw@3120401f53
This commit is contained in:
openclaw-docs-sync[bot]
parent
576b2eda31
commit
7da03b4cab
@ -1,5 +1,5 @@
|
||||
{
|
||||
"repository": "openclaw/openclaw",
|
||||
"sha": "dc859584a352026af00c68d23bbb256d9d4f20cb",
|
||||
"syncedAt": "2026-04-27T14:45:11.330Z"
|
||||
"sha": "3120401f53e789caf565e60ba29cb9751829b1b6",
|
||||
"syncedAt": "2026-04-27T15:05:42.252Z"
|
||||
}
|
||||
|
||||
416
docs/channels/yuanbao.md
Normal file
416
docs/channels/yuanbao.md
Normal file
@ -0,0 +1,416 @@
|
||||
---
|
||||
summary: "YuanBao bot overview, features, and configuration"
|
||||
read_when:
|
||||
- You want to connect a YuanBao bot
|
||||
- You are configuring the YuanBao channel
|
||||
title: YuanBao
|
||||
---
|
||||
|
||||
# YuanBao
|
||||
|
||||
YuanBao is Tencent's AI assistant platform that supports bot integration via instant messaging. Bots can interact with users through direct messages and group chats.
|
||||
|
||||
**Status:** production-ready for bot DMs + group chats. WebSocket is the only supported connection mode.
|
||||
|
||||
---
|
||||
|
||||
## Quick start
|
||||
|
||||
> **Requires OpenClaw 2026.4.10 or above.** Run `openclaw --version` to check. Upgrade with `openclaw update`.
|
||||
|
||||
<Steps>
|
||||
<Step title="Add the YuanBao channel with your credentials">
|
||||
```bash
|
||||
openclaw channels add --channel yuanbao --token "appKey:appSecret"
|
||||
```
|
||||
The `--token` value uses colon-separated `appKey:appSecret` format. You can obtain these from the YuanBao APP by creating a robot in your application settings.
|
||||
</Step>
|
||||
|
||||
<Step title="After setup completes, restart the gateway to apply the changes">
|
||||
```bash
|
||||
openclaw gateway restart
|
||||
```
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
### Interactive setup (alternative)
|
||||
|
||||
You can also use the interactive wizard:
|
||||
|
||||
```bash
|
||||
openclaw channels login --channel yuanbao
|
||||
```
|
||||
|
||||
Follow the prompts to enter your App ID and App Secret.
|
||||
|
||||
---
|
||||
|
||||
## Access control
|
||||
|
||||
### Direct messages
|
||||
|
||||
Configure `dmPolicy` to control who can DM the bot:
|
||||
|
||||
- `"pairing"` — unknown users receive a pairing code; approve via CLI
|
||||
- `"allowlist"` — only users listed in `allowFrom` can chat
|
||||
- `"open"` — allow all users (default)
|
||||
- `"disabled"` — disable all DMs
|
||||
|
||||
**Approve a pairing request:**
|
||||
|
||||
```bash
|
||||
openclaw pairing list yuanbao
|
||||
openclaw pairing approve yuanbao <CODE>
|
||||
```
|
||||
|
||||
### Group chats
|
||||
|
||||
**Mention requirement** (`channels.yuanbao.requireMention`):
|
||||
|
||||
- `true` — require @mention (default)
|
||||
- `false` — respond without @mention
|
||||
|
||||
Replying to the bot's message in a group chat is treated as an implicit mention.
|
||||
|
||||
---
|
||||
|
||||
## Configuration examples
|
||||
|
||||
### Basic setup with open DM policy
|
||||
|
||||
```json5
|
||||
{
|
||||
channels: {
|
||||
yuanbao: {
|
||||
appKey: "your_app_key",
|
||||
appSecret: "your_app_secret",
|
||||
dm: {
|
||||
policy: "open",
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
### Restrict DMs to specific users
|
||||
|
||||
```json5
|
||||
{
|
||||
channels: {
|
||||
yuanbao: {
|
||||
appKey: "your_app_key",
|
||||
appSecret: "your_app_secret",
|
||||
dm: {
|
||||
policy: "allowlist",
|
||||
allowFrom: ["user_id_1", "user_id_2"],
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
### Disable @mention requirement in groups
|
||||
|
||||
```json5
|
||||
{
|
||||
channels: {
|
||||
yuanbao: {
|
||||
requireMention: false,
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
### Optimize outbound message delivery
|
||||
|
||||
```json5
|
||||
{
|
||||
channels: {
|
||||
yuanbao: {
|
||||
// Send each chunk immediately without buffering
|
||||
outboundQueueStrategy: "immediate",
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
### Tune merge-text strategy
|
||||
|
||||
```json5
|
||||
{
|
||||
channels: {
|
||||
yuanbao: {
|
||||
outboundQueueStrategy: "merge-text",
|
||||
minChars: 2800, // buffer until this many chars
|
||||
maxChars: 3000, // force split above this limit
|
||||
idleMs: 5000, // auto-flush after idle timeout (ms)
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common commands
|
||||
|
||||
| Command | Description |
|
||||
| ---------- | --------------------------- |
|
||||
| `/help` | Show available commands |
|
||||
| `/status` | Show bot status |
|
||||
| `/new` | Start a new session |
|
||||
| `/stop` | Stop the current run |
|
||||
| `/restart` | Restart OpenClaw |
|
||||
| `/compact` | Compact the session context |
|
||||
|
||||
> YuanBao supports native slash-command menus. Commands are synced to the platform automatically when the gateway starts.
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Bot does not respond in group chats
|
||||
|
||||
1. Ensure the bot is added to the group
|
||||
2. Ensure you @mention the bot (required by default)
|
||||
3. Check logs: `openclaw logs --follow`
|
||||
|
||||
### Bot does not receive messages
|
||||
|
||||
1. Ensure the bot is created and approved in YuanBao APP
|
||||
2. Ensure `appKey` and `appSecret` are correctly configured
|
||||
3. Ensure the gateway is running: `openclaw gateway status`
|
||||
4. Check logs: `openclaw logs --follow`
|
||||
|
||||
### Bot sends empty or fallback replies
|
||||
|
||||
1. Check if the AI model is returning valid content
|
||||
2. The default fallback reply is: "暂时无法解答，你可以换个问题问问我哦"
|
||||
3. Customize it via `channels.yuanbao.fallbackReply`
|
||||
|
||||
### App Secret leaked
|
||||
|
||||
1. Reset the App Secret in YuanBao APP
|
||||
2. Update the value in your config
|
||||
3. Restart the gateway: `openclaw gateway restart`
|
||||
|
||||
---
|
||||
|
||||
## Advanced configuration
|
||||
|
||||
### Multiple accounts
|
||||
|
||||
```json5
|
||||
{
|
||||
channels: {
|
||||
yuanbao: {
|
||||
defaultAccount: "main",
|
||||
accounts: {
|
||||
main: {
|
||||
appKey: "key_xxx",
|
||||
appSecret: "secret_xxx",
|
||||
name: "Primary bot",
|
||||
},
|
||||
backup: {
|
||||
appKey: "key_yyy",
|
||||
appSecret: "secret_yyy",
|
||||
name: "Backup bot",
|
||||
enabled: false,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
`defaultAccount` controls which account is used when outbound APIs do not specify an `accountId`.
|
||||
|
||||
### Message limits
|
||||
|
||||
- `maxChars` — single message max character count (default: `3000` chars)
|
||||
- `mediaMaxMb` — media upload/download limit (default: `20` MB)
|
||||
- `overflowPolicy` — behavior when message exceeds limit: `"split"` (default) or `"stop"`
|
||||
|
||||
### Streaming
|
||||
|
||||
YuanBao supports block-level streaming output. When enabled, the bot sends text in chunks as it generates.
|
||||
|
||||
```json5
|
||||
{
|
||||
channels: {
|
||||
yuanbao: {
|
||||
disableBlockStreaming: false, // block streaming enabled (default)
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
Set `disableBlockStreaming: true` to send the complete reply in one message.
|
||||
|
||||
### Group chat history context
|
||||
|
||||
Control how many historical messages are included in the AI context for group chats:
|
||||
|
||||
```json5
|
||||
{
|
||||
channels: {
|
||||
yuanbao: {
|
||||
historyLimit: 100, // default: 100, set 0 to disable
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
### Reply-to mode
|
||||
|
||||
Control how the bot quotes messages when replying in group chats:
|
||||
|
||||
```json5
|
||||
{
|
||||
channels: {
|
||||
yuanbao: {
|
||||
replyToMode: "first", // "off" | "first" | "all" (default: "first")
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
| Value | Behavior |
|
||||
| --------- | -------------------------------------------------------- |
|
||||
| `"off"` | No quote reply |
|
||||
| `"first"` | Quote only the first reply per inbound message (default) |
|
||||
| `"all"` | Quote every reply |
|
||||
|
||||
### Markdown hint injection
|
||||
|
||||
By default, the bot injects instructions in the system prompt to prevent the AI model from wrapping the entire reply in markdown code blocks.
|
||||
|
||||
```json5
|
||||
{
|
||||
channels: {
|
||||
yuanbao: {
|
||||
markdownHintEnabled: true, // default: true
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
### Debug mode
|
||||
|
||||
Enable unsanitized log output for specific bot IDs:
|
||||
|
||||
```json5
|
||||
{
|
||||
channels: {
|
||||
yuanbao: {
|
||||
debugBotIds: ["bot_user_id_1", "bot_user_id_2"],
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
### Multi-agent routing
|
||||
|
||||
Use `bindings` to route YuanBao DMs or groups to different agents.
|
||||
|
||||
```json5
|
||||
{
|
||||
agents: {
|
||||
list: [
|
||||
{ id: "main" },
|
||||
{ id: "agent-a", workspace: "/home/user/agent-a" },
|
||||
{ id: "agent-b", workspace: "/home/user/agent-b" },
|
||||
],
|
||||
},
|
||||
bindings: [
|
||||
{
|
||||
agentId: "agent-a",
|
||||
match: {
|
||||
channel: "yuanbao",
|
||||
peer: { kind: "direct", id: "user_xxx" },
|
||||
},
|
||||
},
|
||||
{
|
||||
agentId: "agent-b",
|
||||
match: {
|
||||
channel: "yuanbao",
|
||||
peer: { kind: "group", id: "group_zzz" },
|
||||
},
|
||||
},
|
||||
],
|
||||
}
|
||||
```
|
||||
|
||||
Routing fields:
|
||||
|
||||
- `match.channel`: `"yuanbao"`
|
||||
- `match.peer.kind`: `"direct"` (DM) or `"group"` (group chat)
|
||||
- `match.peer.id`: user ID or group code
|
||||
|
||||
---
|
||||
|
||||
## Configuration reference
|
||||
|
||||
Full configuration: [Gateway configuration](/gateway/configuration)
|
||||
|
||||
| Setting | Description | Default |
|
||||
| ------------------------------------------ | ------------------------------------------------- | -------------------------------------- |
|
||||
| `channels.yuanbao.enabled` | Enable/disable the channel | `true` |
|
||||
| `channels.yuanbao.defaultAccount` | Default account for outbound routing | `default` |
|
||||
| `channels.yuanbao.accounts.<id>.appKey` | App Key (used for signing and ticket generation) | — |
|
||||
| `channels.yuanbao.accounts.<id>.appSecret` | App Secret (used for signing) | — |
|
||||
| `channels.yuanbao.accounts.<id>.token` | Pre-signed token (skips automatic ticket signing) | — |
|
||||
| `channels.yuanbao.accounts.<id>.name` | Account display name | — |
|
||||
| `channels.yuanbao.accounts.<id>.enabled` | Enable/disable a specific account | `true` |
|
||||
| `channels.yuanbao.dm.policy` | DM policy | `open` |
|
||||
| `channels.yuanbao.dm.allowFrom` | DM allowlist (user ID list) | — |
|
||||
| `channels.yuanbao.requireMention` | Require @mention in groups | `true` |
|
||||
| `channels.yuanbao.overflowPolicy` | Long message handling (`split` or `stop`) | `split` |
|
||||
| `channels.yuanbao.replyToMode` | Group reply-to strategy (`off`, `first`, `all`) | `first` |
|
||||
| `channels.yuanbao.outboundQueueStrategy` | Outbound strategy (`merge-text` or `immediate`) | `merge-text` |
|
||||
| `channels.yuanbao.minChars` | Merge-text: min chars to trigger send | `2800` |
|
||||
| `channels.yuanbao.maxChars` | Merge-text: max chars per message | `3000` |
|
||||
| `channels.yuanbao.idleMs` | Merge-text: idle timeout before auto-flush (ms) | `5000` |
|
||||
| `channels.yuanbao.mediaMaxMb` | Media size limit (MB) | `20` |
|
||||
| `channels.yuanbao.historyLimit` | Group chat history context entries | `100` |
|
||||
| `channels.yuanbao.disableBlockStreaming` | Disable block-level streaming output | `false` |
|
||||
| `channels.yuanbao.fallbackReply` | Fallback reply when AI returns no content | `暂时无法解答，你可以换个问题问问我哦` |
|
||||
| `channels.yuanbao.markdownHintEnabled` | Inject markdown anti-wrapping instructions | `true` |
|
||||
| `channels.yuanbao.debugBotIds` | Debug whitelist bot IDs (unsanitized logs) | `[]` |
|
||||
|
||||
---
|
||||
|
||||
## Supported message types
|
||||
|
||||
### Receive
|
||||
|
||||
- ✅ Text
|
||||
- ✅ Images
|
||||
- ✅ Files
|
||||
- ✅ Audio / Voice
|
||||
- ✅ Video
|
||||
- ✅ Stickers / Custom emoji
|
||||
- ✅ Custom elements (link cards, etc.)
|
||||
|
||||
### Send
|
||||
|
||||
- ✅ Text (with markdown support)
|
||||
- ✅ Images
|
||||
- ✅ Files
|
||||
- ✅ Audio
|
||||
- ✅ Video
|
||||
- ✅ Stickers
|
||||
|
||||
### Threads and replies
|
||||
|
||||
- ✅ Quote replies (configurable via `replyToMode`)
|
||||
- ❌ Thread replies (not supported by platform)
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Channels Overview](/channels) — all supported channels
|
||||
- [Pairing](/channels/pairing) — DM authentication and pairing flow
|
||||
- [Groups](/channels/groups) — group chat behavior and mention gating
|
||||
- [Channel Routing](/channels/channel-routing) — session routing for messages
|
||||
- [Security](/gateway/security) — access model and hardening
|
||||
@ -130,6 +130,20 @@ formatting, built-in access control, and document/meeting/messaging skills.
|
||||
openclaw plugins install @wecom/wecom-openclaw-plugin
|
||||
```
|
||||
|
||||
### Yuanbao
|
||||
|
||||
Yuanbao channel plugin for OpenClaw by the Tencent Yuanbao team. Powered by
|
||||
WebSocket persistent connections, it supports direct messages & group chats,
|
||||
streaming replies, proactive messaging, image/file/audio/video processing,
|
||||
Markdown formatting, built-in access control, and slash-command menus.
|
||||
|
||||
- **npm:** `openclaw-plugin-yuanbao`
|
||||
- **repo:** [github.com/yb-claw/openclaw-plugin-yuanbao](https://github.com/yb-claw/openclaw-plugin-yuanbao)
|
||||
|
||||
```bash
|
||||
openclaw plugins install openclaw-plugin-yuanbao
|
||||
```
|
||||
|
||||
## Submit your plugin
|
||||
|
||||
We welcome community plugins that are useful, documented, and safe to operate.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user