TaskFlow
DashboardFreewriteWhiteboardsProjectsCRMTasksNotificationsSettingsAgent TowerAPI Docs
OpenClaw Docs
?

User

Member

Caricamento in corso...

Home
Progetti
Task
Notifiche
CRM

    OpenClaw

    Documentation Mirror

    Documentation Overview

    Docs

    Auth credential semantics
    Scheduled tasks
    Hooks
    Automation & tasks
    Standing orders
    Task flow
    Background tasks
    BlueBubbles
    Broadcast groups
    Channel routing
    Discord
    Feishu
    Google Chat
    Group messages
    Groups
    iMessage
    Chat channels
    IRC
    LINE
    Channel location parsing
    Matrix
    Matrix migration
    Matrix push rules for quiet previews
    Mattermost
    Microsoft Teams
    Nextcloud Talk
    Nostr
    Pairing
    QA channel
    QQ bot
    Signal
    Slack
    Synology Chat
    Telegram
    Tlon
    Channel troubleshooting
    Twitch
    WeChat
    WhatsApp
    Yuanbao
    Zalo
    Zalo personal
    CI pipeline
    ACP
    Agent
    Agents
    Approvals
    Backup
    Browser
    Channels
    Clawbot
    `openclaw commitments`
    Completion
    Config
    Configure
    Cron
    Daemon
    Dashboard
    Devices
    Directory
    DNS
    Docs
    Doctor
    Flows (redirect)
    Gateway
    Health
    Hooks
    CLI reference
    Inference CLI
    Logs
    MCP
    Memory
    Message
    Migrate
    Models
    Node
    Nodes
    Onboard
    Pairing
    Plugins
    Proxy
    QR
    Reset
    Sandbox CLI
    Secrets
    Security
    Sessions
    Setup
    Skills
    Status
    System
    `openclaw tasks`
    TUI
    Uninstall
    Update
    Voicecall
    Webhooks
    Wiki
    Active memory
    Agent runtime
    Agent loop
    Agent runtimes
    Agent workspace
    Gateway architecture
    Channel docking
    Inferred commitments
    Compaction
    Context
    Context engine
    Delegate architecture
    Dreaming
    Experimental features
    Features
    Markdown formatting
    Memory overview
    Builtin memory engine
    Honcho memory
    QMD memory engine
    Memory search
    Messages
    Model failover
    Model providers
    Models CLI
    Multi-agent routing
    OAuth
    OpenClaw App SDK
    Presence
    QA overview
    Matrix QA
    Command queue
    Steering queue
    Retry policy
    Session management
    Session pruning
    Session tools
    SOUL.md personality guide
    Streaming and chunking
    System prompt
    Timezones
    TypeBox
    Typing indicators
    Usage tracking
    Date and time
    Node + tsx crash
    Diagnostics flags
    Authentication
    Background exec and process tool
    Bonjour discovery
    Bridge protocol
    CLI backends
    Configuration — agents
    Configuration — channels
    Configuration — tools and custom providers
    Configuration
    Configuration examples
    Configuration reference
    Diagnostics export
    Discovery and transports
    Doctor
    Gateway lock
    Health checks
    Heartbeat
    Gateway runbook
    Local models
    Gateway logging
    Multiple gateways
    Network model
    OpenAI chat completions
    OpenResponses API
    OpenShell
    OpenTelemetry export
    Gateway-owned pairing
    Prometheus metrics
    Gateway protocol
    Remote access
    Remote gateway setup
    Sandbox vs tool policy vs elevated
    Sandboxing
    Secrets management
    Secrets apply plan contract
    Security audit checks
    Security
    Tailscale
    Tools invoke API
    Troubleshooting
    Trusted proxy auth
    Debugging
    Environment variables
    FAQ
    FAQ: first-run setup
    FAQ: models and auth
    GPT-5.5 / Codex agentic parity
    GPT-5.5 / Codex parity maintainer notes
    Help
    Scripts
    Testing
    Testing: live suites
    General troubleshooting
    OpenClaw
    Ansible
    Azure
    Bun (experimental)
    ClawDock
    Release channels
    DigitalOcean
    Docker
    Docker VM runtime
    exe.dev
    Fly.io
    GCP
    Hetzner
    Hostinger
    Install
    Installer internals
    Kubernetes
    macOS VMs
    Migration guide
    Migrating from Claude
    Migrating from Hermes
    Nix
    Node.js
    Northflank
    Oracle Cloud
    Podman
    Railway
    Raspberry Pi
    Render
    Uninstall
    Updating
    Logging
    Network
    Audio and voice notes
    Camera capture
    Image and media support
    Nodes
    Location command
    Media understanding
    Talk mode
    Node troubleshooting
    Voice wake
    Pi integration architecture
    Pi development workflow
    Android app
    Platforms
    iOS app
    Linux app
    Gateway on macOS
    Canvas
    Gateway lifecycle
    macOS dev setup
    Health checks (macOS)
    Menu bar icon
    macOS logging
    Menu bar
    Peekaboo bridge
    macOS permissions
    Remote control
    macOS signing
    Skills (macOS)
    Voice overlay
    Voice wake (macOS)
    WebChat (macOS)
    macOS IPC
    macOS app
    Windows
    Plugin internals
    Plugin architecture internals
    Building plugins
    Plugin bundles
    Codex Computer Use
    Codex harness
    Community plugins
    Plugin compatibility
    Google Meet plugin
    Plugin hooks
    Plugin manifest
    Memory LanceDB
    Memory wiki
    Message presentation
    Agent harness plugins
    Building channel plugins
    Channel turn kernel
    Plugin entry points
    Plugin SDK migration
    Plugin SDK overview
    Building provider plugins
    Plugin runtime helpers
    Plugin setup and config
    Plugin SDK subpaths
    Plugin testing
    Skill workshop plugin
    Voice call plugin
    Webhooks plugin
    Zalo personal plugin
    OpenProse
    Alibaba Model Studio
    Anthropic
    Arcee AI
    Azure Speech
    Amazon Bedrock
    Amazon Bedrock Mantle
    Chutes
    Claude Max API proxy
    Cloudflare AI gateway
    ComfyUI
    Deepgram
    Deepinfra
    DeepSeek
    ElevenLabs
    Fal
    Fireworks
    GitHub Copilot
    GLM (Zhipu)
    Google (Gemini)
    Gradium
    Groq
    Hugging Face (inference)
    Provider directory
    Inferrs
    Inworld
    Kilocode
    LiteLLM
    LM Studio
    MiniMax
    Mistral
    Model provider quickstart
    Moonshot AI
    NVIDIA
    Ollama
    OpenAI
    OpenCode
    OpenCode Go
    OpenRouter
    Perplexity
    Qianfan
    Qwen
    Runway
    SGLang
    StepFun
    Synthetic
    Tencent Cloud (TokenHub)
    Together AI
    Venice AI
    Vercel AI gateway
    vLLM
    Volcengine (Doubao)
    Vydra
    xAI
    Xiaomi MiMo
    Z.AI
    Default AGENTS.md
    Release policy
    API usage and costs
    Credits
    Device model database
    Full release validation
    Memory configuration reference
    OpenClaw App SDK API design
    Prompt caching
    Rich output protocol
    RPC adapters
    SecretRef credential surface
    Session management deep dive
    AGENTS.md template
    BOOT.md template
    BOOTSTRAP.md template
    HEARTBEAT.md template
    IDENTITY template
    SOUL.md template
    TOOLS.md template
    USER template
    Tests
    Token use and costs
    Transcript hygiene
    Onboarding reference
    Contributing to the threat model
    Threat model (MITRE ATLAS)
    Formal verification (security models)
    Network proxy
    Agent bootstrapping
    Docs directory
    Getting started
    Docs hubs
    OpenClaw lore
    Onboarding (macOS app)
    Onboarding overview
    Personal assistant setup
    Setup
    Showcase
    Onboarding (CLI)
    CLI automation
    CLI setup reference
    ACP agents
    ACP agents — setup
    Agent send
    apply_patch tool
    Brave search
    Browser (OpenClaw-managed)
    Browser control API
    Browser troubleshooting
    Browser login
    WSL2 + Windows + remote Chrome CDP troubleshooting
    BTW side questions
    ClawHub
    Code execution
    Creating skills
    Diffs
    DuckDuckGo search
    Elevated mode
    Exa search
    Exec tool
    Exec approvals
    Exec approvals — advanced
    Firecrawl
    Gemini search
    Grok search
    Image generation
    Tools and plugins
    Kimi search
    LLM task
    Lobster
    Tool-loop detection
    Media overview
    MiniMax search
    Multi-agent sandbox and tools
    Music generation
    Ollama web search
    PDF tool
    Perplexity search
    Plugins
    Reactions
    SearXNG search
    Skills
    Skills config
    Slash commands
    Sub-agents
    Tavily
    Thinking levels
    Tokenjuice
    Trajectory bundles
    Text-to-speech
    Video generation
    Web search
    Web fetch
    Linux server
    Control UI
    Dashboard
    Web
    TUI
    WebChat

    OpenAPI Specs

    openapi
    TaskFlow
    docs/openclaw
    Original Docs

    Real-time Synchronized Documentation

    Last sync: 01/05/2026 07:04:36

    Note: This content is mirrored from docs.openclaw.ai and is subject to their terms and conditions.

    OpenClaw Docs

    v2.4.0 Production

    Last synced: Today, 22:00

    Technical reference for the OpenClaw framework. Real-time synchronization with the official documentation engine.

    Use this file to discover all available pages before exploring further.

    Signal

    Status: external CLI integration. Gateway talks to

    text
    signal-cli
    over HTTP JSON-RPC + SSE.

    Prerequisites

    • OpenClaw installed on your server (Linux flow below tested on Ubuntu 24).
    • text
      signal-cli
      available on the host where the gateway runs.
    • A phone number that can receive one verification SMS (for SMS registration path).
    • Browser access for Signal captcha (
      text
      signalcaptchas.org
      ) during registration.

    Quick setup (beginner)

    1. Use a separate Signal number for the bot (recommended).
    2. Install
      text
      signal-cli
      (Java required if you use the JVM build).
    3. Choose one setup path:
      • Path A (QR link):
        text
        signal-cli link -n "OpenClaw"
        and scan with Signal.
      • Path B (SMS register): register a dedicated number with captcha + SMS verification.
    4. Configure OpenClaw and restart the gateway.
    5. Send a first DM and approve pairing (
      text
      openclaw pairing approve signal <CODE>
      ).

    Minimal config:

    json5
    { channels: { signal: { enabled: true, account: "+15551234567", cliPath: "signal-cli", dmPolicy: "pairing", allowFrom: ["+15557654321"], }, }, }

    Field reference:

    FieldDescription
    text
    account
    Bot phone number in E.164 format (
    text
    +15551234567
    )
    text
    cliPath
    Path to
    text
    signal-cli
    (
    text
    signal-cli
    if on
    text
    PATH
    )
    text
    dmPolicy
    DM access policy (
    text
    pairing
    recommended)
    text
    allowFrom
    Phone numbers or
    text
    uuid:<id>
    values allowed to DM

    What it is

    • Signal channel via
      text
      signal-cli
      (not embedded libsignal).
    • Deterministic routing: replies always go back to Signal.
    • DMs share the agent's main session; groups are isolated (
      text
      agent:<agentId>:signal:group:<groupId>
      ).

    Config writes

    By default, Signal is allowed to write config updates triggered by

    text
    /config set|unset
    (requires
    text
    commands.config: true
    ).

    Disable with:

    json5
    { channels: { signal: { configWrites: false } }, }

    The number model (important)

    • The gateway connects to a Signal device (the
      text
      signal-cli
      account).
    • If you run the bot on your personal Signal account, it will ignore your own messages (loop protection).
    • For "I text the bot and it replies," use a separate bot number.

    Setup path A: link existing Signal account (QR)

    1. Install
      text
      signal-cli
      (JVM or native build).
    2. Link a bot account:
      • text
        signal-cli link -n "OpenClaw"
        then scan the QR in Signal.
    3. Configure Signal and start the gateway.

    Example:

    json5
    { channels: { signal: { enabled: true, account: "+15551234567", cliPath: "signal-cli", dmPolicy: "pairing", allowFrom: ["+15557654321"], }, }, }

    Multi-account support: use

    text
    channels.signal.accounts
    with per-account config and optional
    text
    name
    . See
    text
    gateway/configuration
    for the shared pattern.

    Setup path B: register dedicated bot number (SMS, Linux)

    Use this when you want a dedicated bot number instead of linking an existing Signal app account.

    1. Get a number that can receive SMS (or voice verification for landlines).
      • Use a dedicated bot number to avoid account/session conflicts.
    2. Install
      text
      signal-cli
      on the gateway host:
    bash
    VERSION=$(curl -Ls -o /dev/null -w %{url_effective} https://github.com/AsamK/signal-cli/releases/latest | sed -e 's/^.*\/v//') curl -L -O "https://github.com/AsamK/signal-cli/releases/download/v${VERSION}/signal-cli-${VERSION}-Linux-native.tar.gz" sudo tar xf "signal-cli-${VERSION}-Linux-native.tar.gz" -C /opt sudo ln -sf /opt/signal-cli /usr/local/bin/ signal-cli --version

    If you use the JVM build (

    text
    signal-cli-${VERSION}.tar.gz
    ), install JRE 25+ first. Keep
    text
    signal-cli
    updated; upstream notes that old releases can break as Signal server APIs change.

    1. Register and verify the number:
    bash
    signal-cli -a +<BOT_PHONE_NUMBER> register

    If captcha is required:

    1. Open
      text
      https://signalcaptchas.org/registration/generate.html
      .
    2. Complete captcha, copy the
      text
      signalcaptcha://...
      link target from "Open Signal".
    3. Run from the same external IP as the browser session when possible.
    4. Run registration again immediately (captcha tokens expire quickly):
    bash
    signal-cli -a +<BOT_PHONE_NUMBER> register --captcha '<SIGNALCAPTCHA_URL>' signal-cli -a +<BOT_PHONE_NUMBER> verify <VERIFICATION_CODE>
    1. Configure OpenClaw, restart gateway, verify channel:
    bash
    # If you run the gateway as a user systemd service: systemctl --user restart openclaw-gateway.service # Then verify: openclaw doctor openclaw channels status --probe
    1. Pair your DM sender:
      • Send any message to the bot number.
      • Approve code on the server:
        text
        openclaw pairing approve signal <PAIRING_CODE>
        .
      • Save the bot number as a contact on your phone to avoid "Unknown contact".

    warning

    Registering a phone number account with `signal-cli` can de-authenticate the main Signal app session for that number. Prefer a dedicated bot number, or use QR link mode if you need to keep your existing phone app setup.

    Upstream references:

    • text
      signal-cli
      README:
      text
      https://github.com/AsamK/signal-cli
    • Captcha flow:
      text
      https://github.com/AsamK/signal-cli/wiki/Registration-with-captcha
    • Linking flow:
      text
      https://github.com/AsamK/signal-cli/wiki/Linking-other-devices-(Provisioning)

    External daemon mode (httpUrl)

    If you want to manage

    text
    signal-cli
    yourself (slow JVM cold starts, container init, or shared CPUs), run the daemon separately and point OpenClaw at it:

    json5
    { channels: { signal: { httpUrl: "http://127.0.0.1:8080", autoStart: false, }, }, }

    This skips auto-spawn and the startup wait inside OpenClaw. For slow starts when auto-spawning, set

    text
    channels.signal.startupTimeoutMs
    .

    Access control (DMs + groups)

    DMs:

    • Default:
      text
      channels.signal.dmPolicy = "pairing"
      .
    • Unknown senders receive a pairing code; messages are ignored until approved (codes expire after 1 hour).
    • Approve via:
      • text
        openclaw pairing list signal
      • text
        openclaw pairing approve signal <CODE>
    • Pairing is the default token exchange for Signal DMs. Details: Pairing
    • UUID-only senders (from
      text
      sourceUuid
      ) are stored as
      text
      uuid:<id>
      in
      text
      channels.signal.allowFrom
      .

    Groups:

    • text
      channels.signal.groupPolicy = open | allowlist | disabled
      .
    • text
      channels.signal.groupAllowFrom
      controls which groups or senders can trigger group replies when
      text
      allowlist
      is set; entries can be Signal group IDs (raw,
      text
      group:<id>
      , or
      text
      signal:group:<id>
      ), sender phone numbers,
      text
      uuid:<id>
      values, or
      text
      *
      .
    • text
      channels.signal.groups["<group-id>" | "*"]
      can override group behavior with
      text
      requireMention
      ,
      text
      tools
      , and
      text
      toolsBySender
      .
    • Use
      text
      channels.signal.accounts.<id>.groups
      for per-account overrides in multi-account setups.
    • Allowlisting a Signal group through
      text
      groupAllowFrom
      does not disable mention gating by itself. A specifically configured
      text
      channels.signal.groups["<group-id>"]
      entry processes every group message unless
      text
      requireMention=true
      is set.
    • Runtime note: if
      text
      channels.signal
      is completely missing, runtime falls back to
      text
      groupPolicy="allowlist"
      for group checks (even if
      text
      channels.defaults.groupPolicy
      is set).

    How it works (behavior)

    • text
      signal-cli
      runs as a daemon; the gateway reads events via SSE.
    • Inbound messages are normalized into the shared channel envelope.
    • Replies always route back to the same number or group.

    Media + limits

    • Outbound text is chunked to
      text
      channels.signal.textChunkLimit
      (default 4000).
    • Optional newline chunking: set
      text
      channels.signal.chunkMode="newline"
      to split on blank lines (paragraph boundaries) before length chunking.
    • Attachments supported (base64 fetched from
      text
      signal-cli
      ).
    • Voice-note attachments use the
      text
      signal-cli
      filename as a MIME fallback when
      text
      contentType
      is missing, so audio transcription can still classify AAC voice memos.
    • Default media cap:
      text
      channels.signal.mediaMaxMb
      (default 8).
    • Use
      text
      channels.signal.ignoreAttachments
      to skip downloading media.
    • Group history context uses
      text
      channels.signal.historyLimit
      (or
      text
      channels.signal.accounts.*.historyLimit
      ), falling back to
      text
      messages.groupChat.historyLimit
      . Set
      text
      0
      to disable (default 50).

    Typing + read receipts

    • Typing indicators: OpenClaw sends typing signals via
      text
      signal-cli sendTyping
      and refreshes them while a reply is running.
    • Read receipts: when
      text
      channels.signal.sendReadReceipts
      is true, OpenClaw forwards read receipts for allowed DMs.
    • Signal-cli does not expose read receipts for groups.

    Reactions (message tool)

    • Use
      text
      message action=react
      with
      text
      channel=signal
      .
    • Targets: sender E.164 or UUID (use
      text
      uuid:<id>
      from pairing output; bare UUID works too).
    • text
      messageId
      is the Signal timestamp for the message you’re reacting to.
    • Group reactions require
      text
      targetAuthor
      or
      text
      targetAuthorUuid
      .

    Examples:

    text
    message action=react channel=signal target=uuid:123e4567-e89b-12d3-a456-426614174000 messageId=1737630212345 emoji=🔥 message action=react channel=signal target=+15551234567 messageId=1737630212345 emoji=🔥 remove=true message action=react channel=signal target=signal:group:<groupId> targetAuthor=uuid:<sender-uuid> messageId=1737630212345 emoji=✅

    Config:

    • text
      channels.signal.actions.reactions
      : enable/disable reaction actions (default true).
    • text
      channels.signal.reactionLevel
      :
      text
      off | ack | minimal | extensive
      .
      • text
        off
        /
        text
        ack
        disables agent reactions (message tool
        text
        react
        will error).
      • text
        minimal
        /
        text
        extensive
        enables agent reactions and sets the guidance level.
    • Per-account overrides:
      text
      channels.signal.accounts.<id>.actions.reactions
      ,
      text
      channels.signal.accounts.<id>.reactionLevel
      .

    Delivery targets (CLI/cron)

    • DMs:
      text
      signal:+15551234567
      (or plain E.164).
    • UUID DMs:
      text
      uuid:<id>
      (or bare UUID).
    • Groups:
      text
      signal:group:<groupId>
      .
    • Usernames:
      text
      username:<name>
      (if supported by your Signal account).

    Troubleshooting

    Run this ladder first:

    bash
    openclaw status openclaw gateway status openclaw logs --follow openclaw doctor openclaw channels status --probe

    Then confirm DM pairing state if needed:

    bash
    openclaw pairing list signal

    Common failures:

    • Daemon reachable but no replies: verify account/daemon settings (
      text
      httpUrl
      ,
      text
      account
      ) and receive mode.
    • DMs ignored: sender is pending pairing approval.
    • Group messages ignored: group sender/mention gating blocks delivery.
    • Config validation errors after edits: run
      text
      openclaw doctor --fix
      .
    • Signal missing from diagnostics: confirm
      text
      channels.signal.enabled: true
      .

    Extra checks:

    bash
    openclaw pairing list signal pgrep -af signal-cli grep -i "signal" "/tmp/openclaw/openclaw-$(date +%Y-%m-%d).log" | tail -20

    For triage flow: /channels/troubleshooting.

    Security notes

    • text
      signal-cli
      stores account keys locally (typically
      text
      ~/.local/share/signal-cli/data/
      ).
    • Back up Signal account state before server migration or rebuild.
    • Keep
      text
      channels.signal.dmPolicy: "pairing"
      unless you explicitly want broader DM access.
    • SMS verification is only needed for registration or recovery flows, but losing control of the number/account can complicate re-registration.

    Configuration reference (Signal)

    Full configuration: Configuration

    Provider options:

    • text
      channels.signal.enabled
      : enable/disable channel startup.
    • text
      channels.signal.account
      : E.164 for the bot account.
    • text
      channels.signal.cliPath
      : path to
      text
      signal-cli
      .
    • text
      channels.signal.httpUrl
      : full daemon URL (overrides host/port).
    • text
      channels.signal.httpHost
      ,
      text
      channels.signal.httpPort
      : daemon bind (default 127.0.0.1:8080).
    • text
      channels.signal.autoStart
      : auto-spawn daemon (default true if
      text
      httpUrl
      unset).
    • text
      channels.signal.startupTimeoutMs
      : startup wait timeout in ms (cap 120000).
    • text
      channels.signal.receiveMode
      :
      text
      on-start | manual
      .
    • text
      channels.signal.ignoreAttachments
      : skip attachment downloads.
    • text
      channels.signal.ignoreStories
      : ignore stories from the daemon.
    • text
      channels.signal.sendReadReceipts
      : forward read receipts.
    • text
      channels.signal.dmPolicy
      :
      text
      pairing | allowlist | open | disabled
      (default: pairing).
    • text
      channels.signal.allowFrom
      : DM allowlist (E.164 or
      text
      uuid:<id>
      ).
      text
      open
      requires
      text
      "*"
      . Signal has no usernames; use phone/UUID ids.
    • text
      channels.signal.groupPolicy
      :
      text
      open | allowlist | disabled
      (default: allowlist).
    • text
      channels.signal.groupAllowFrom
      : group allowlist; accepts Signal group IDs (raw,
      text
      group:<id>
      , or
      text
      signal:group:<id>
      ), sender E.164 numbers, or
      text
      uuid:<id>
      values.
    • text
      channels.signal.groups
      : per-group overrides keyed by Signal group id (or
      text
      "*"
      ). Supported fields:
      text
      requireMention
      ,
      text
      tools
      ,
      text
      toolsBySender
      .
    • text
      channels.signal.accounts.<id>.groups
      : per-account version of
      text
      channels.signal.groups
      for multi-account setups.
    • text
      channels.signal.historyLimit
      : max group messages to include as context (0 disables).
    • text
      channels.signal.dmHistoryLimit
      : DM history limit in user turns. Per-user overrides:
      text
      channels.signal.dms["<phone_or_uuid>"].historyLimit
      .
    • text
      channels.signal.textChunkLimit
      : outbound chunk size (chars).
    • text
      channels.signal.chunkMode
      :
      text
      length
      (default) or
      text
      newline
      to split on blank lines (paragraph boundaries) before length chunking.
    • text
      channels.signal.mediaMaxMb
      : inbound/outbound media cap (MB).

    Related global options:

    • text
      agents.list[].groupChat.mentionPatterns
      (Signal does not support native mentions).
    • text
      messages.groupChat.mentionPatterns
      (global fallback).
    • text
      messages.responsePrefix
      .

    Related

    • Channels Overview — all supported channels
    • Pairing — DM authentication and pairing flow
    • Groups — group chat behavior and mention gating
    • Channel Routing — session routing for messages
    • Security — access model and hardening

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine