openclaw/docs/channels/channel-routing.md

140 lines
4.8 KiB
Markdown
Raw Permalink Normal View History

2026-01-06 18:25:52 +00:00
---
summary: "Routing rules per channel (WhatsApp, Telegram, Discord, Slack) and shared context"
2026-01-06 18:25:52 +00:00
read_when:
- Changing channel routing or inbox behavior
title: "Channel Routing"
2026-01-06 18:25:52 +00:00
---
2026-01-31 21:13:13 +09:00
# Channels & routing
2026-01-06 18:25:52 +00:00
2026-01-30 03:15:10 +01:00
OpenClaw routes replies **back to the channel where a message came from**. The
model does not choose a channel; routing is deterministic and controlled by the
2026-01-08 23:06:56 +01:00
host configuration.
## Key terms
- **Channel**: `whatsapp`, `telegram`, `discord`, `slack`, `signal`, `imessage`, `webchat`.
- **AccountId**: perchannel account instance (when supported).
- Optional channel default account: `channels.<channel>.defaultAccount` chooses
which account is used when an outbound path does not specify `accountId`.
- In multi-account setups, set an explicit default (`defaultAccount` or `accounts.default`) when two or more accounts are configured. Without it, fallback routing may pick the first normalized account ID.
2026-01-08 23:06:56 +01:00
- **AgentId**: an isolated workspace + session store (“brain”).
- **SessionKey**: the bucket key used to store context and control concurrency.
2026-01-08 23:06:56 +01:00
## Session key shapes (examples)
Direct messages collapse to the agents **main** session:
- `agent:<agentId>:<mainKey>` (default: `agent:main:main`)
Groups and channels remain isolated per channel:
2026-01-08 23:06:56 +01:00
- Groups: `agent:<agentId>:<channel>:group:<id>`
- Channels/rooms: `agent:<agentId>:<channel>:channel:<id>`
2026-01-08 23:06:56 +01:00
Threads:
- Slack/Discord threads append `:thread:<threadId>` to the base key.
- Telegram forum topics embed `:topic:<topicId>` in the group key.
Examples:
- `agent:main:telegram:group:-1001234567890:topic:42`
- `agent:main:discord:channel:123456:thread:987654`
## Main DM route pinning
When `session.dmScope` is `main`, direct messages may share one main session.
To prevent the sessions `lastRoute` from being overwritten by non-owner DMs,
OpenClaw infers a pinned owner from `allowFrom` when all of these are true:
- `allowFrom` has exactly one non-wildcard entry.
- The entry can be normalized to a concrete sender ID for that channel.
- The inbound DM sender does not match that pinned owner.
In that mismatch case, OpenClaw still records inbound session metadata, but it
skips updating the main session `lastRoute`.
2026-01-08 23:06:56 +01:00
## Routing rules (how an agent is chosen)
Routing picks **one agent** for each inbound message:
1. **Exact peer match** (`bindings` with `peer.kind` + `peer.id`).
2. **Parent peer match** (thread inheritance).
3. **Guild + roles match** (Discord) via `guildId` + `roles`.
4. **Guild match** (Discord) via `guildId`.
5. **Team match** (Slack) via `teamId`.
6. **Account match** (`accountId` on the channel).
7. **Channel match** (any account on that channel, `accountId: "*"`).
8. **Default agent** (`agents.list[].default`, else first list entry, fallback to `main`).
When a binding includes multiple match fields (`peer`, `guildId`, `teamId`, `roles`), **all provided fields must match** for that binding to apply.
2026-01-08 23:06:56 +01:00
The matched agent determines which workspace and session store are used.
2026-01-09 21:29:07 +01:00
## Broadcast groups (run multiple agents)
2026-01-30 03:15:10 +01:00
Broadcast groups let you run **multiple agents** for the same peer **when OpenClaw would normally reply** (for example: in WhatsApp groups, after mention/activation gating).
2026-01-09 21:29:07 +01:00
Config:
```json5
{
broadcast: {
strategy: "parallel",
"120363403215116621@g.us": ["alfred", "baerbel"],
2026-01-31 21:13:13 +09:00
"+15555550123": ["support", "logger"],
},
2026-01-09 21:29:07 +01:00
}
```
See: [Broadcast Groups](/channels/broadcast-groups).
2026-01-09 21:29:07 +01:00
2026-01-08 23:06:56 +01:00
## Config overview
- `agents.list`: named agent definitions (workspace, model, etc.).
- `bindings`: map inbound channels/accounts/peers to agents.
2026-01-08 23:06:56 +01:00
Example:
```json5
{
agents: {
2026-01-31 21:13:13 +09:00
list: [{ id: "support", name: "Support", workspace: "~/.openclaw/workspace-support" }],
},
bindings: [
{ match: { channel: "slack", teamId: "T123" }, agentId: "support" },
2026-01-31 21:13:13 +09:00
{ match: { channel: "telegram", peer: { kind: "group", id: "-100123" } }, agentId: "support" },
],
2026-01-08 23:06:56 +01:00
}
```
## Session storage
2026-01-30 03:15:10 +01:00
Session stores live under the state directory (default `~/.openclaw`):
2026-01-08 23:06:56 +01:00
2026-01-30 03:15:10 +01:00
- `~/.openclaw/agents/<agentId>/sessions/sessions.json`
2026-01-08 23:06:56 +01:00
- JSONL transcripts live alongside the store
You can override the store path via `session.store` and `{agentId}` templating.
Gateway and ACP session discovery also scans disk-backed agent stores under the
default `agents/` root and under templated `session.store` roots. Discovered
stores must stay inside that resolved agent root and use a regular
`sessions.json` file. Symlinks and out-of-root paths are ignored.
2026-01-08 23:06:56 +01:00
## WebChat behavior
WebChat attaches to the **selected agent** and defaults to the agents main
session. Because of this, WebChat lets you see crosschannel context for that
2026-01-08 23:06:56 +01:00
agent in one place.
## Reply context
Inbound replies include:
2026-01-31 21:13:13 +09:00
2026-01-08 23:06:56 +01:00
- `ReplyToId`, `ReplyToBody`, and `ReplyToSender` when available.
- Quoted context is appended to `Body` as a `[Replying to ...]` block.
This is consistent across channels.