Matrix

Documentation Index

Fetch the complete documentation index at: https://openclaw.zhcndoc.com/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. 重启网关。
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（dm.allowFrom、groupAllowFrom、groups.<room>.users）：使用 @user:server。仅当 homeserver 目录返回恰好一个匹配项时，显示名称才会被解析。
• 房间（groups、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"。

​

审批元数据

​

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

​

Bot-to-bot rooms

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

• allowBots: true 接受来自其他已配置 Matrix 机器人账户的消息，适用于允许的房间和 DM。
• allowBots: "mentions" 仅在这些消息在房间中明显提及了这个机器人时才接受。DM 仍然允许。
• groups.<room>.allowBots 会覆盖单个房间的账户级设置。
• OpenClaw 仍会忽略来自同一个 Matrix 用户 ID 的消息，以避免自我回复循环。
• Matrix 在这里不提供原生 bot 标志；OpenClaw 将“由 bot 发出”视为“由另一个在这个 OpenClaw 网关上配置的 Matrix 账户发送”。

​

加密与验证

​

启用加密

openclaw matrix encryption setup

• --recovery-key <key> 在初始化前应用恢复密钥（优先使用下面文档中描述的 stdin 形式）
• --force-reset-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 报告已通过交叉签名验证
• Signed by owner：由你自己的自签名密钥签名（仅用于诊断）

​

使用恢复密钥验证此设备

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

• Recovery key accepted：Matrix 已接受该密钥用于 secret 存储或设备信任。
• Backup usable：可使用受信任的恢复材料加载房间密钥备份。
• Device verified by owner：此设备拥有完整的 Matrix 交叉签名身份信任。

openclaw matrix verify self

​

初始化或修复交叉签名

openclaw matrix verify bootstrap

• 初始化 secret 存储，尽可能复用现有恢复密钥
• 初始化交叉签名并上传缺失的公钥
• 标记并对当前设备进行交叉签名
• 如果尚不存在服务器端房间密钥备份，则创建一个

• --recovery-key-stdin（配合 printf '%s\n' "$MATRIX_RECOVERY_KEY" | … 使用）或 --recovery-key <key>
• --force-reset-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"（默认）：所有指向同一对端的 DM 房间共享一个会话。
• "per-room"：每个 Matrix DM 房间都有自己的会话键，即使对端相同也一样。

​

回复线程化（threadReplies）

• "off"：回复为顶层消息。进入的线程消息仍保留在父会话上。
• "inbound"：只有当输入消息本身已经在某个线程中时，才在该线程内回复。
• "always"：在由触发消息根节点所根植的线程中回复；从第一次触发开始，该对话会通过一个匹配的、线程作用域的会话进行路由。

​

线程继承与斜杠命令

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

​

ACP 会话绑定

• 在你想继续使用的 Matrix DM、房间或现有线程中运行 /acp spawn codex --bind here。
• 在顶层 Matrix DM 或房间中，当前 DM/房间仍保持为聊天表面，未来消息会路由到新生成的 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 线程。
• 当原生子代理线程生成不应分叉父转录时，将 threadBindings.defaultSpawnContext 设为 "isolated"。

​

反应

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

​

历史上下文

• channels.matrix.historyLimit 控制当某个 Matrix 房间消息触发代理时，会将多少最近的房间消息作为 InboundHistory 包含进来。若未设置，则回退到 messages.groupChat.historyLimit；如果两者都未设置，生效默认值为 0。设为 0 可禁用。
• Matrix 房间历史仅限于房间。DM 仍然使用正常的会话历史。
• Matrix 房间历史仅对待处理消息生效：OpenClaw 会缓存尚未触发回复的房间消息，然后在出现提及或其他触发条件时快照该窗口。
• 当前触发消息不包含在 InboundHistory 中；它会保留在该轮的主入站正文里。
• 对同一个 Matrix 事件的重试会复用原始历史快照，而不是随着后续房间消息继续前移。

​

上下文可见性

• contextVisibility: "all" 为默认值。附加上下文会按接收时的样子保留。
• contextVisibility: "allowlist" 会将附加上下文过滤为仅向当前房间/用户允许名单检查中被允许的发送者可见。
• contextVisibility: "allowlist_quote" 的行为类似 allowlist，但仍会保留一条明确引用的回复。

​

DM 和房间策略

{
  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 DM
• 其次回退到当前已加入的、与该用户对应的任何严格 1:1 DM
• 如果不存在健康的 DM，则创建一个新的直接房间并重写 m.direct

​

Exec 批准

• enabled：通过 Matrix 原生提示传递批准。未设置或为 "auto" 时，一旦至少可以解析出一个批准人，Matrix 就会自动启用。显式设为 false 可禁用。
• approvers：允许批准 exec 请求的 Matrix 用户 ID（@owner:example.org）。可选——若未设置，则回退到 channels.matrix.dm.allowFrom。
• target：提示发送到哪里。"dm"（默认）发送到批准人的 DM；"channel" 发送到发起的 Matrix 房间或 DM；"both" 同时发送到两者。
• agentFilter / sessionFilter：可选允许名单，用于指定哪些代理/会话会触发 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>。
• 只有当顶层 channels.matrix.* 区块的认证完整时（homeserver + accessToken，或 homeserver + userId + password），它才会被视为隐式的 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 和别名，然后回退到为该账户搜索已加入房间的名称。
• 已加入房间的名称查找是尽力而为。如果某个房间名称无法解析为 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：基于 token 的认证所用访问令牌。环境/文件/exec 提供器支持明文和 SecretRef 值（Secrets Management）。
• 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" 策略。
• 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 时，完成的助手块会作为单独的进度消息保留。
• 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：用于投递的可选代理/会话白名单。

​

相关内容

• Channels Overview — 所有支持的频道
• Pairing — DM 认证和配对流程
• Groups — 群聊行为和提及门控
• Channel Routing — 消息的会话路由
• Security — 访问模型和加固