docs/cli/channels.md
openclaw channelsManage chat channel accounts and their runtime status on the Gateway.
Related docs:
openclaw channels list
openclaw channels list --all
openclaw channels status
openclaw channels capabilities
openclaw channels capabilities --channel discord --target channel:123
openclaw channels resolve --channel slack "#general" "@jane"
openclaw channels logs --channel all
channels list shows chat channels only: configured accounts by default, with installed, configured, and enabled status tags per account (--json for machine output). Pass --all to also surface bundled channels that have no configured account yet and installable catalog channels that are not yet on disk. Provider auth and model usage live elsewhere: openclaw models auth list for provider auth profiles, openclaw status or openclaw models list for usage/quota.
channels status: --channel <name>, --probe, --timeout <ms> (default 10000), --jsonchannels capabilities: --channel <name>, --account <id> (requires --channel), --target <dest> (requires --channel), --timeout <ms> (default 10000, capped at 30000), --jsonchannels resolve <entries...>: --channel <name>, --account <id>, --kind <auto|user|group> (default auto), --jsonchannels logs: --channel <name|all> (default all), --lines <n> (default 200), --jsonchannels status --probe is the live path: on a reachable gateway it runs per-account
probeAccount and optional auditAccount checks, so output can include transport
state plus probe results such as works, probe failed, audit ok, or audit failed.
If the gateway is unreachable, channels status falls back to config-only summaries
instead of live probe output.
Do not use openclaw sessions, Gateway sessions.list, or the agent
sessions_list tool as a channel socket-health signal. Those surfaces report
stored conversation rows, not provider runtime state. After a Discord provider
restart, a connected but quiet account may be healthy while no Discord session
row appears until the next inbound or outbound conversation event.
openclaw channels add --channel telegram --token <bot-token>
openclaw channels add --channel nostr --private-key "$NOSTR_PRIVATE_KEY"
openclaw channels remove --channel telegram --delete
channels remove only operates on installed/configured channel plugins. Use channels add first for installable catalog channels. Without --delete it asks to disable the account and keeps its config; --delete removes the config entries without prompting.
For runtime-backed channel plugins, channels remove also asks the running Gateway to stop the selected account before it updates config, so disabling or deleting an account does not leave the old listener active until restart.
Non-interactive add flags shared across channels: --account <id>, --name <name>, --token, --token-file, --bot-token, --app-token, --secret, --secret-file, --password, --cli-path, --url, --base-url, --http-url, --auth-dir, and --use-env (env-backed auth, default account only, where supported). Channel-specific flags include:
| Channel | Flags |
|---|---|
| Google Chat | --webhook-path, --webhook-url, --audience-type, --audience |
| iMessage | --cli-path, --db-path, --service, --region |
| Matrix | --homeserver, --user-id, --access-token, --password, --device-name, --initial-sync-limit |
| Nostr | --private-key, --relay-urls |
| Signal | --signal-number, --cli-path, --http-url, --http-host, --http-port |
| Tlon | --ship, --url, --code, --group-channels, --dm-allowlist, --auto-discover-channels |
--auth-dir |
If a channel plugin needs to be installed during a flag-driven add command, OpenClaw uses the channel's default install source without opening the interactive plugin install prompt.
When you run openclaw channels add without flags, the interactive wizard can prompt:
Route these channel accounts to agents now?If you confirm bind now, the wizard asks which agent should own each configured channel account and writes account-scoped routing bindings.
You can also manage the same routing rules later with openclaw agents bindings, openclaw agents bind, and openclaw agents unbind (see agents).
When you add a non-default account to a channel that is still using single-account top-level settings, OpenClaw promotes those top-level values into the channel's account map before writing the new account. Promotion reuses an existing named account when the channel has exactly one, or when defaultAccount points at one; otherwise the values land in channels.<channel>.accounts.default.
Routing behavior stays consistent:
accountId) continue to match the default account.channels add does not auto-create or rewrite bindings in non-interactive mode.If your config was already in a mixed state (named accounts present and top-level single-account values still set), run openclaw doctor --fix to move account-scoped values into the promoted account chosen for that channel.
openclaw channels login --channel whatsapp
openclaw channels logout --channel whatsapp
channels login supports --account <id> and --verbose; channels logout supports --account <id>.channels login and logout can infer the channel when only one configured channel supports that action; with several, pass --channel.channels logout prefers the live Gateway path when reachable, so logout stops any active listener before clearing channel auth state. If a local Gateway is not reachable, it falls back to local auth cleanup; with gateway.mode: "remote" the gateway error fails the command instead.channels login from a terminal on the gateway host. Agent exec blocks this interactive login flow; channel-native agent login tools, such as whatsapp_login, should be used from chat when available.openclaw status --deep for a broad probe.openclaw doctor for guided fixes.openclaw channels status falls back to config-only summaries when the gateway is unreachable. If a supported channel credential is configured via SecretRef but unavailable in the current command path, it reports that account as configured with degraded notes instead of showing it as not configured.Fetch provider capability hints (intents/scopes where available) plus static feature support:
openclaw channels capabilities
openclaw channels capabilities --channel discord --target channel:123
Notes:
--channel is optional; omit it to list every channel (including plugin-provided channels).--account is only valid with --channel.--target accepts channel:<id> or a raw numeric channel id and only applies to Discord. For Discord voice channels, the permission check flags missing ViewChannel, Connect, Speak, SendMessages, and ReadMessageHistory.Probe: unavailable.Resolve channel/user names to IDs using the provider directory:
openclaw channels resolve --channel slack "#general" "@jane"
openclaw channels resolve --channel discord "My Server/#support" "@someone"
openclaw channels resolve --channel matrix "Project Room"
Notes:
--kind user|group|auto to force the target type.channels resolve is read-only. If a selected account is configured via SecretRef but that credential is unavailable in the current command path, the command returns degraded unresolved results with notes instead of aborting the entire run.channels resolve does not install channel plugins. Use channels add --channel <name> before resolving names for an installable catalog channel.