Matrix

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

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

​

安装

openclaw plugins install @openclaw/matrix

openclaw plugins install ./path/to/local/matrix-plugin

​

设置

1. 在你的 homeserver 上创建一个 Matrix 账号。
2. 使用 homeserver + accessToken，或 homeserver + userId + password 配置 channels.matrix。
3. 重启 Gateway 网关。
4. 与机器人开启私信，或邀请它加入房间（请参阅自动加入 - 只有 autoJoin 允许时，新邀请才会落地）。

​

交互式设置

openclaw channels add
openclaw configure --section channels

​

最小配置

{
  channels: {
    matrix: {
      enabled: true,
      homeserver: "https://matrix.example.org",
      accessToken: "syt_xxx",
      dm: { policy: "pairing" },
    },
  },
}

{
  channels: {
    matrix: {
      enabled: true,
      homeserver: "https://matrix.example.org",
      userId: "@bot:example.org",
      password: "replace-me", // pragma: allowlist secret
      deviceName: "OpenClaw Gateway",
    },
  },
}

​

自动加入

{
  channels: {
    matrix: {
      autoJoin: "allowlist",
      autoJoinAllowlist: ["!ops:example.org", "#support:example.org"],
      groups: {
        "!ops:example.org": { requireMention: true },
      },
    },
  },
}

​

允许列表目标格式

• 私信（dm.allowFrom、groupAllowFrom、groups.<room>.users）：使用 @user:server。默认会忽略显示名称，因为它们可变；只有在你明确需要兼容显示名称条目时，才设置 dangerouslyAllowNameMatching: true。
• 房间允许列表键（groups、旧版 rooms）：使用 !room:server 或 #alias:server。默认会忽略纯房间名称；只有在你明确需要兼容已加入房间名称查找时，才设置 dangerouslyAllowNameMatching: true。
• 邀请允许列表（autoJoinAllowlist）：使用 !room:server、#alias:server 或 *。纯房间名称会被拒绝。

​

账号 ID 规范化

​

缓存凭证

• 默认账号：credentials.json
• 命名账号：credentials-<account>.json

​

环境变量

​

配置示例

{
  channels: {
    matrix: {
      enabled: true,
      homeserver: "https://matrix.example.org",
      accessToken: "syt_xxx",
      encryption: true,

      dm: {
        policy: "pairing",
        sessionScope: "per-room",
        threadReplies: "off",
      },

      groupPolicy: "allowlist",
      groupAllowFrom: ["@admin:example.org"],
      groups: {
        "!roomid:example.org": { requireMention: true },
      },

      autoJoin: "allowlist",
      autoJoinAllowlist: ["!roomid:example.org"],
      threadReplies: "inbound",
      replyToMode: "off",
      streaming: "partial",
    },
  },
}

​

流式预览

{
  channels: {
    matrix: {
      streaming: "partial",
    },
  },
}

{
  channels: {
    matrix: {
      streaming: {
        mode: "partial",
        preview: {
          toolProgress: false,
        },
      },
    },
  },
}

• 如果预览增长到超过 Matrix 的单事件大小限制，OpenClaw 会停止预览流式传输，并回退为仅最终交付。
• 媒体回复始终正常发送附件。如果过期预览无法再安全复用，OpenClaw 会在发送最终媒体回复前将其撤回。
• 当 Matrix 预览流式传输处于活动状态时，默认启用工具进度预览更新。设置 streaming.preview.toolProgress: false 可保留答案文本的预览编辑，但让工具进度走正常交付路径。
• 预览编辑会增加额外的 Matrix API 调用。如果你想要最保守的速率限制配置，请保持 streaming: "off"。

​

审批元数据

​

用于静默最终预览的自托管推送规则

​

机器人到机器人房间

{
  channels: {
    matrix: {
      allowBots: "mentions", // true | "mentions"
      groups: {
        "!roomid:example.org": {
          requireMention: true,
        },
      },
    },
  },
}

• allowBots: true 会接受允许房间和私信中来自其他已配置 Matrix 机器人账号的消息。
• allowBots: "mentions" 只会在这些消息在房间中明确提及此机器人时接受它们。私信仍然允许。
• groups.<room>.allowBots 会覆盖单个房间的账号级设置。
• OpenClaw 仍会忽略来自相同 Matrix 用户 ID 的消息，以避免自我回复循环。
• Matrix 这里不会暴露原生机器人标记；OpenClaw 将“由机器人发出”视为“由此 OpenClaw Gateway 网关上另一个已配置的 Matrix 账号发送”。

​

加密和验证

​

启用加密

openclaw matrix encryption setup

• --recovery-key <key> 在引导前应用恢复密钥（优先使用下面记录的 stdin 形式）
• --force-reset-cross-signing 丢弃当前 cross-signing 身份并创建新身份（仅在有意这样做时使用）

openclaw matrix account add \
  --homeserver https://matrix.example.org \
  --access-token syt_xxx \
  --enable-e2ee

{
  channels: {
    matrix: {
      enabled: true,
      homeserver: "https://matrix.example.org",
      accessToken: "syt_xxx",
      encryption: true,
      dm: { policy: "pairing" },
    },
  },
}

​

状态和信任信号

openclaw matrix verify status
openclaw matrix verify status --include-recovery-key --json

• Locally trusted：仅受此客户端信任
• Cross-signing verified：SDK 报告已通过 cross-signing 验证
• Signed by owner：由你自己的 self-signing 密钥签名（仅用于诊断）

​

使用恢复密钥验证此设备

printf '%s\n' "$MATRIX_RECOVERY_KEY" | openclaw matrix verify device --recovery-key-stdin

• Recovery key accepted：Matrix 已接受该密钥，用于 secret storage 或设备信任。
• Backup usable：可以使用受信任的恢复材料加载房间密钥备份。
• Device verified by owner：此设备具有完整的 Matrix cross-signing 身份信任。

openclaw matrix verify self

​

引导或修复 cross-signing

openclaw matrix verify bootstrap

• 引导 secret storage，并在可能时复用现有恢复密钥
• 引导 cross-signing 并上传缺失的公钥
• 标记并 cross-sign 当前设备
• 如果还不存在服务端房间密钥备份，则创建一个

• --recovery-key-stdin（配合 printf '%s\n' "$MATRIX_RECOVERY_KEY" | …）或 --recovery-key <key>
• --force-reset-cross-signing 用于丢弃当前 cross-signing 身份（仅在有意这样做时使用）

​

房间密钥备份

openclaw matrix verify backup status
printf '%s\n' "$MATRIX_RECOVERY_KEY" | openclaw matrix verify backup restore --recovery-key-stdin

openclaw matrix verify backup reset --yes

​

列出、请求和响应验证

openclaw matrix verify list

openclaw matrix verify request --own-user
openclaw matrix verify request --user-id @ops:example.org --device-id ABCDEF

​

多账户注意事项

openclaw matrix account add \
  --account assistant \
  --homeserver https://matrix.example.org \
  --user-id '@assistant:example.org' \
  --password '<password>' \
  --device-name OpenClaw-Gateway

openclaw matrix account add \
  --account assistant \
  --homeserver https://matrix.example.org \
  --access-token '<token>'

openclaw matrix devices list
openclaw matrix devices prune-stale

​

个人资料管理

openclaw matrix profile set --name "OpenClaw Assistant"
openclaw matrix profile set --avatar-url https://cdn.example.org/avatar.png

​

线程

​

会话路由（sessionScope）

• "per-user"（默认）：与同一路由对端相关的所有私信房间共享一个会话。
• "per-room"：每个 Matrix 私信房间都有自己的会话键，即使对端相同也是如此。

​

回复线程化（threadReplies）

• "off"：回复位于顶层。入站线程消息保留在父会话中。
• "inbound"：仅当入站消息已经在线程中时，才在线程内回复。
• "always"：在线程内回复，线程根为触发消息；从首次触发开始，该对话会通过匹配的线程作用域会话进行路由。

​

线程继承和斜杠命令

• 入站线程消息会把线程根消息作为额外智能体上下文包含进来。
• 消息工具发送在目标为同一房间（或同一私信用户目标）时，会自动继承当前 Matrix 线程，除非提供了显式的 threadId。
• 只有当前会话元数据能证明同一 Matrix 账号上的同一私信对端时，才会复用私信用户目标；否则 OpenClaw 会回退到正常的用户作用域路由。
• /focus、/unfocus、/agents、/session idle、/session max-age 和绑定线程的 /acp spawn 都可在 Matrix 房间和私信中使用。
• 当 threadBindings.spawnSessions 启用时，顶层 /focus 会创建一个新的 Matrix 线程，并将其绑定到目标会话。
• 在现有 Matrix 线程中运行 /focus 或 /acp spawn --thread here 会就地绑定该线程。

​

ACP 对话绑定

• 在你想继续使用的 Matrix 私信、房间或现有线程中运行 /acp spawn codex --bind here。
• 在顶层 Matrix 私信或房间中，当前私信/房间会保持为聊天界面，未来消息会路由到生成的 ACP 会话。
• 在现有 Matrix 线程中，--bind here 会就地绑定当前线程。
• /new 和 /reset 会就地重置同一个已绑定的 ACP 会话。
• /acp close 会关闭 ACP 会话并移除绑定。

• --bind here 不会创建子 Matrix 线程。
• threadBindings.spawnSessions 控制 /acp spawn --thread auto|here，这时 OpenClaw 需要创建或绑定子 Matrix 线程。

​

线程绑定配置

• threadBindings.enabled
• threadBindings.idleHours
• threadBindings.maxAgeHours
• threadBindings.spawnSessions
• threadBindings.defaultSpawnContext

• 设置 threadBindings.spawnSessions: false 可阻止顶层 /focus 和 /acp spawn --thread auto|here 创建/绑定 Matrix 线程。
• 当原生子智能体线程生成不应 fork 父级转录内容时，设置 threadBindings.defaultSpawnContext: "isolated"。

​

反应

• react 向 Matrix 事件添加反应。
• reactions 列出 Matrix 事件的当前反应摘要。
• emoji="" 移除该事件上机器人的自身反应。
• remove: true 只移除机器人指定的 emoji 反应。

​

历史上下文

• channels.matrix.historyLimit 控制当 Matrix 房间消息触发智能体时，作为 InboundHistory 包含的最近房间消息数量。会回退到 messages.groupChat.historyLimit；如果两者都未设置，有效默认值为 0。设置为 0 可禁用。
• Matrix 房间历史仅限房间。私信继续使用正常会话历史。
• Matrix 房间历史仅限待处理消息：OpenClaw 会缓冲尚未触发回复的房间消息，然后在提及或其他触发到达时快照该窗口。
• 当前触发消息不会包含在 InboundHistory 中；它会保留在该轮次的主入站正文中。
• 同一 Matrix 事件的重试会复用原始历史快照，而不是向前漂移到更新的房间消息。

​

上下文可见性

• contextVisibility: "all" 是默认值。补充上下文会按接收时保留。
• contextVisibility: "allowlist" 会过滤补充上下文，只发送通过活跃房间/用户 allowlist 检查的发送者内容。
• contextVisibility: "allowlist_quote" 的行为类似 allowlist，但仍保留一条显式引用回复。

​

私信和房间策略

{
  channels: {
    matrix: {
      dm: {
        policy: "allowlist",
        allowFrom: ["@admin:example.org"],
        threadReplies: "off",
      },
      groupPolicy: "allowlist",
      groupAllowFrom: ["@admin:example.org"],
      groups: {
        "!roomid:example.org": { requireMention: true },
      },
    },
  },
}

{
  channels: {
    matrix: {
      dm: { enabled: false },
      groupPolicy: "allowlist",
      groupAllowFrom: ["@admin:example.org"],
    },
  },
}

openclaw pairing list matrix
openclaw pairing approve matrix <CODE>

​

直接房间修复

openclaw matrix direct inspect --user-id @alice:example.org

openclaw matrix direct repair --user-id @alice:example.org

• 优先选择已经映射在 m.direct 中的严格 1:1 私信
• 回退到与该用户当前已加入的任何严格 1:1 私信
• 如果不存在健康的私信，则创建新的直接房间并重写 m.direct

​

Exec 批准

• enabled：通过 Matrix 原生提示传递批准。未设置或为 "auto" 时，只要至少能解析出一个批准者，Matrix 就会自动启用。设置为 false 可显式禁用。
• approvers：允许批准 exec 请求的 Matrix 用户 ID（@owner:example.org）。可选，回退到 channels.matrix.dm.allowFrom。
• target：提示发送位置。"dm"（默认）发送到批准者私信；"channel" 发送到发起的 Matrix 房间或私信；"both" 同时发送到两者。
• agentFilter / sessionFilter：可选 allowlist，用于指定哪些智能体/会话触发 Matrix 投递。

• Exec 批准使用 execApprovals.approvers，回退到 dm.allowFrom。
• 插件批准只通过 dm.allowFrom 授权。

• ✅ 允许一次
• ❌ 拒绝
• ♾️ 始终允许（当有效 exec 策略允许时）

​

斜杠命令

​

多账号

{
  channels: {
    matrix: {
      enabled: true,
      defaultAccount: "assistant",
      dm: { policy: "pairing" },
      accounts: {
        assistant: {
          homeserver: "https://matrix.example.org",
          accessToken: "syt_assistant_xxx",
          encryption: true,
        },
        alerts: {
          homeserver: "https://matrix.example.org",
          accessToken: "syt_alerts_xxx",
          dm: {
            policy: "allowlist",
            allowFrom: ["@ops:example.org"],
            threadReplies: "off",
          },
        },
      },
    },
  },
}

• 顶层 channels.matrix 值会作为命名账号的默认值，除非账号覆盖它们。
• 使用 groups.<room>.account 将继承的房间条目限定到特定账号。没有 account 的条目会在账号之间共享；当默认账号在顶层配置时，account: "default" 仍然可用。

• 设置 defaultAccount 可选择隐式路由、探测和 CLI 命令优先使用的命名账号。
• 如果你有多个账号，并且其中一个字面上命名为 default，即使未设置 defaultAccount，OpenClaw 也会隐式使用它。
• 如果你有多个命名账号且未选择默认账号，CLI 命令会拒绝猜测，请设置 defaultAccount 或传递 --account <id>。
• 只有当其认证完整（homeserver + accessToken，或 homeserver + userId + password）时，顶层 channels.matrix.* 块才会被视为隐式 default 账号。只要缓存凭据覆盖认证，命名账号仍可通过 homeserver + userId 发现。

• 当 OpenClaw 在修复或设置期间将单账号配置提升为多账号时，如果已有命名账号或 defaultAccount 已指向某个账号，它会保留该账号。只有 Matrix 认证/引导键会移动到提升后的账号；共享投递策略键会留在顶层。

​

私有/LAN homeserver

{
  channels: {
    matrix: {
      homeserver: "http://matrix-synapse:8008",
      network: {
        dangerouslyAllowPrivateNetwork: true,
      },
      accessToken: "syt_internal_xxx",
    },
  },
}

openclaw matrix account add \
  --account ops \
  --homeserver http://matrix-synapse:8008 \
  --allow-private-network \
  --access-token syt_ops_xxx

​

代理 Matrix 流量

{
  channels: {
    matrix: {
      homeserver: "https://matrix.example.org",
      accessToken: "syt_bot_xxx",
      proxy: "http://127.0.0.1:7890",
    },
  },
}

​

目标解析

• 用户：@user:server、user:@user:server 或 matrix:user:@user:server
• 房间：!room:server、room:!room:server 或 matrix:room:!room:server
• 别名：#alias:server、channel:#alias:server 或 matrix:channel:#alias:server

• 用户查找会查询该 homeserver 上的 Matrix 用户目录。
• 房间查找会直接接受显式房间 ID 和别名。已加入房间的名称查找是尽力而为的，并且仅在设置了 dangerouslyAllowNameMatching: true 时适用于运行时房间允许列表。
• 如果房间名称无法解析为 ID 或别名，运行时允许列表解析会忽略它。

​

配置参考

​

账号和连接

• enabled：启用或禁用该渠道。
• name：账号的可选显示标签。
• defaultAccount：配置多个 Matrix 账号时首选的账号 ID。
• accounts：具名的逐账号覆盖。顶层 channels.matrix 值会作为默认值继承。
• homeserver：homeserver URL，例如 https://matrix.example.org。
• network.dangerouslyAllowPrivateNetwork：允许此账号连接到 localhost、LAN/Tailscale IP 或内部主机名。
• proxy：Matrix 流量的可选 HTTP(S) 代理 URL。支持逐账号覆盖。
• userId：完整的 Matrix 用户 ID（@bot:example.org）。
• accessToken：基于令牌认证的访问令牌。支持跨 env/file/exec 提供商的明文值和 SecretRef 值（密钥管理）。
• password：基于密码登录的密码。支持明文值和 SecretRef 值。
• deviceId：显式 Matrix 设备 ID。
• deviceName：密码登录时使用的设备显示名称。
• avatarUrl：用于资料同步和 profile set 更新的已存储自头像 URL。
• initialSyncLimit：启动同步期间获取的最大事件数。

​

加密

• encryption：启用 E2EE。默认值：false。
• startupVerification："if-unverified"（E2EE 开启时的默认值）或 "off"。当此设备未验证时，启动时自动请求自验证。
• startupVerificationCooldownHours：下一次自动启动请求之前的冷却时间。默认值：24。

​

访问和策略

• groupPolicy："open"、"allowlist" 或 "disabled"。默认值："allowlist"。
• groupAllowFrom：房间流量的用户 ID 允许列表。
• dm.enabled：当为 false 时，忽略所有私信。默认值：true。
• dm.policy："pairing"（默认）、"allowlist"、"open" 或 "disabled"。在机器人已加入并将房间分类为私信之后应用；不会影响邀请处理。
• dm.allowFrom：私信流量的用户 ID 允许列表。
• dm.sessionScope："per-user"（默认）或 "per-room"。
• dm.threadReplies：仅私信用的回复线程覆盖（"off"、"inbound"、"always"）。
• allowBots：接受来自其他已配置 Matrix 机器人账号的消息（true 或 "mentions"）。
• allowlistOnly：当为 true 时，会强制所有活动私信策略（除了 "disabled"）和 "open" 群组策略改为 "allowlist"。不会更改 "disabled" 策略。
• dangerouslyAllowNameMatching：当为 true 时，允许对用户允许列表条目执行 Matrix 显示名称目录查找，并对房间允许列表键执行已加入房间名称查找。优先使用完整的 @user:server ID 以及房间 ID 或别名。
• autoJoin："always"、"allowlist" 或 "off"。默认值："off"。适用于每个 Matrix 邀请，包括私信式邀请。
• autoJoinAllowlist：当 autoJoin 为 "allowlist" 时允许的房间/别名。别名条目会针对 homeserver 解析，而不是针对受邀房间声明的状态解析。
• contextVisibility：补充上下文可见性（默认 "all"、"allowlist"、"allowlist_quote"）。

​

回复行为

• replyToMode："off"、"first"、"all" 或 "batched"。
• threadReplies："off"、"inbound" 或 "always"。
• threadBindings：线程绑定会话路由和生命周期的逐渠道覆盖。
• streaming："off"（默认）、"partial"、"quiet"，或对象形式 { mode, preview: { toolProgress } }。true ↔ "partial"，false ↔ "off"。
• blockStreaming：当为 true 时，已完成的 assistant 块会保留为单独的进度消息。
• markdown：出站文本的可选 Markdown 渲染配置。
• responsePrefix：追加到出站回复前的可选字符串。
• textChunkLimit：当 chunkMode: "length" 时，出站分块的字符大小。默认值：4000。
• chunkMode："length"（默认，按字符数拆分）或 "newline"（按行边界拆分）。
• historyLimit：当房间消息触发智能体时，作为 InboundHistory 包含的最近房间消息数量。回退到 messages.groupChat.historyLimit；有效默认值为 0（禁用）。
• mediaMaxMb：出站发送和入站处理的媒体大小上限，单位为 MB。

​

表情回应设置

• ackReaction：此渠道/账号的确认表情回应覆盖。
• ackReactionScope：范围覆盖（默认 "group-mentions"、"group-all"、"direct"、"all"、"none"、"off"）。
• reactionNotifications：入站表情回应通知模式（默认 "own"、"off"）。

​

工具和逐房间覆盖

• actions：逐操作工具门控（messages、reactions、pins、profile、memberInfo、channelInfo、verification）。
• groups：逐房间策略映射。解析后，会话身份使用稳定的房间 ID。（rooms 是旧版别名。）
  • groups.<room>.account：将一个继承的房间条目限制到特定账号。
  • groups.<room>.allowBots：渠道级设置的逐房间覆盖（true 或 "mentions"）。
  • groups.<room>.users：逐房间发送者允许列表。
  • groups.<room>.tools：逐房间工具允许/拒绝覆盖。
  • groups.<room>.autoReply：逐房间提及门控覆盖。true 会禁用该房间的提及要求；false 会强制重新开启。
  • groups.<room>.skills：逐房间技能过滤器。
  • groups.<room>.systemPrompt：逐房间系统提示片段。

​

Exec 审批设置

• execApprovals.enabled：通过 Matrix 原生提示投递 exec 审批。
• execApprovals.approvers：允许审批的 Matrix 用户 ID。回退到 dm.allowFrom。
• execApprovals.target："dm"（默认）、"channel" 或 "both"。
• execApprovals.agentFilter / execApprovals.sessionFilter：用于投递的可选智能体/会话允许列表。

​

相关内容

• 渠道概览 - 所有支持的渠道
• 配对 - 私信认证和配对流程
• 群组 - 群组聊天行为和提及门控
• 频道路由 - 消息的会话路由
• 安全 - 访问模型和加固