跳转到主要内容

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.

通过 IRC 连接支持 Twitch 聊天。OpenClaw 以 Twitch 用户（机器人账号）身份连接，用于在频道中接收和发送消息。

​
内置插件

Twitch 在当前 OpenClaw 版本中作为内置插件提供，因此普通打包构建不需要单独安装。
如果你使用的是较旧构建，或是排除了 Twitch 的自定义安装，请直接安装 npm 包： 
openclaw plugins install @openclaw/twitch
使用裸包名可跟随当前官方发布标签。仅在需要可复现安装时才固定精确版本。 详情：插件

​
快速设置（初学者）

1

确保插件可用

当前打包的 OpenClaw 版本已内置该插件。较旧/自定义安装可以使用上面的命令手动添加。
2

创建 Twitch 机器人账号

为机器人创建一个专用 Twitch 账号（或使用现有账号）。
3

生成凭证

使用 Twitch Token Generator：
  • 选择 Bot Token
  • 确认已选择 chat:read 和 chat:write 作用域
  • 复制 Client ID 和 Access Token
4

查找你的 Twitch 用户 ID

使用 https://www.streamweasels.com/tools/convert-twitch-username-to-user-id/ 将用户名转换为 Twitch 用户 ID。
5

配置令牌

  • 环境变量：OPENCLAW_TWITCH_ACCESS_TOKEN=...（仅默认账号）
  • 或配置：channels.twitch.accessToken
如果两者都已设置，配置优先（环境变量回退仅适用于默认账号）。
6

启动 Gateway 网关

使用已配置的渠道启动 Gateway 网关。
添加访问控制（allowFrom 或 allowedRoles），防止未经授权的用户触发机器人。requireMention 默认值为 true。
最小配置： 
{
  channels: {
    twitch: {
      enabled: true,
      username: "openclaw", // Bot's Twitch account
      accessToken: "oauth:abc123...", // OAuth Access Token (or use OPENCLAW_TWITCH_ACCESS_TOKEN env var)
      clientId: "xyz789...", // Client ID from Token Generator
      channel: "vevisk", // Which Twitch channel's chat to join (required)
      allowFrom: ["123456789"], // (recommended) Your Twitch user ID only - get it from https://www.streamweasels.com/tools/convert-twitch-username-to-user-id/
    },
  },
}

​
它是什么

  • 一个由 Gateway 网关拥有的 Twitch 渠道。
  • 确定性路由：回复始终返回 Twitch。
  • 每个账号都会映射到一个隔离的会话键 agent:<agentId>:twitch:<accountName>。
  • username 是机器人的账号（用于认证），channel 是要加入的聊天室。

​
设置（详细）

​
生成凭证

使用 Twitch Token Generator：
  • 选择 Bot Token
  • 确认已选择 chat:read 和 chat:write 作用域
  • 复制 Client ID 和 Access Token
不需要手动注册应用。令牌会在数小时后过期。

​
配置机器人

OPENCLAW_TWITCH_ACCESS_TOKEN=oauth:abc123...
如果环境变量和配置都已设置，配置优先。

​
访问控制（推荐）

{
  channels: {
    twitch: {
      allowFrom: ["123456789"], // (recommended) Your Twitch user ID only
    },
  },
}
优先使用 allowFrom 作为硬性允许列表。如果你想要基于角色的访问，请改用 allowedRoles。 可用角色： "moderator"、"owner"、"vip"、"subscriber"、"all"。
为什么使用用户 ID？ 用户名可以更改，可能导致冒充。用户 ID 是永久的。查找你的 Twitch 用户 ID：https://www.streamweasels.com/tools/convert-twitch-username-to-user-id/（将你的 Twitch 用户名转换为 ID）

​
令牌刷新（可选）

来自 Twitch Token Generator 的令牌无法自动刷新，请在过期后重新生成。 若要自动刷新令牌，请在 Twitch Developer Console 创建你自己的 Twitch 应用，并添加到配置： 
{
  channels: {
    twitch: {
      clientSecret: "your_client_secret",
      refreshToken: "your_refresh_token",
    },
  },
}
机器人会在过期前自动刷新令牌，并记录刷新事件。

​
多账号支持

使用 channels.twitch.accounts 配置每个账号的令牌。共享模式请参阅配置。 示例（一个机器人账号加入两个频道）： 
{
  channels: {
    twitch: {
      accounts: {
        channel1: {
          username: "openclaw",
          accessToken: "oauth:abc123...",
          clientId: "xyz789...",
          channel: "vevisk",
        },
        channel2: {
          username: "openclaw",
          accessToken: "oauth:def456...",
          clientId: "uvw012...",
          channel: "secondchannel",
        },
      },
    },
  },
}
每个账号都需要自己的令牌（每个频道一个令牌）。

​
访问控制

{
  channels: {
    twitch: {
      accounts: {
        default: {
          allowFrom: ["123456789", "987654321"],
        },
      },
    },
  },
}

​
故障排除

首先运行诊断命令： 
openclaw doctor
openclaw channels status --probe
  • 检查访问控制： 确保你的用户 ID 位于 allowFrom 中，或临时移除 allowFrom 并设置 allowedRoles: ["all"] 进行测试。
  • 检查机器人是否在频道中： 机器人必须加入 channel 中指定的频道。
“连接失败”或认证错误：
  • 确认 accessToken 是 OAuth 访问令牌值（通常以 oauth: 前缀开头）
  • 检查令牌是否具有 chat:read 和 chat:write 作用域
  • 如果使用令牌刷新，请确认已设置 clientSecret 和 refreshToken
检查日志中的刷新事件：
Using env token source for mybot
Access token refreshed for user 123456 (expires in 14400s)
如果你看到 “token refresh disabled (no refresh token)”：
  • 确保已提供 clientSecret
  • 确保已提供 refreshToken

​
配置

​
账号配置

​
username
string
机器人用户名。
​
accessToken
string
具有 chat:read 和 chat:write 的 OAuth 访问令牌。
​
clientId
string
Twitch Client ID（来自 Token Generator 或你的应用）。
​
channel
string
必填
要加入的频道。
​
enabled
boolean
默认值:"true"
启用此账号。
​
clientSecret
string
可选：用于自动刷新令牌。
​
refreshToken
string
可选：用于自动刷新令牌。
​
expiresIn
number
令牌有效期（秒）。
​
obtainmentTimestamp
number
令牌获取时间戳。
​
allowFrom
string[]
用户 ID 允许列表。
​
allowedRoles
Array<"moderator" | "owner" | "vip" | "subscriber" | "all">
基于角色的访问控制。
​
requireMention
boolean
默认值:"true"
要求 @mention。

​
提供商选项

  • channels.twitch.enabled - 启用/禁用渠道启动
  • channels.twitch.username - 机器人用户名（简化的单账号配置）
  • channels.twitch.accessToken - OAuth 访问令牌（简化的单账号配置）
  • channels.twitch.clientId - Twitch Client ID（简化的单账号配置）
  • channels.twitch.channel - 要加入的频道（简化的单账号配置）
  • channels.twitch.accounts.<accountName> - 多账号配置（上方所有账号字段）
完整示例： 
{
  channels: {
    twitch: {
      enabled: true,
      username: "openclaw",
      accessToken: "oauth:abc123...",
      clientId: "xyz789...",
      channel: "vevisk",
      clientSecret: "secret123...",
      refreshToken: "refresh456...",
      allowFrom: ["123456789"],
      allowedRoles: ["moderator", "vip"],
      accounts: {
        default: {
          username: "mybot",
          accessToken: "oauth:abc123...",
          clientId: "xyz789...",
          channel: "your_channel",
          enabled: true,
          clientSecret: "secret123...",
          refreshToken: "refresh456...",
          expiresIn: 14400,
          obtainmentTimestamp: 1706092800000,
          allowFrom: ["123456789", "987654321"],
          allowedRoles: ["moderator"],
        },
      },
    },
  },
}

​
工具动作

智能体可以调用 twitch 并使用 action：
  • send - 向频道发送消息
示例： 
{
  action: "twitch",
  params: {
    message: "Hello Twitch!",
    to: "#mychannel",
  },
}

​
安全与运维

  • 像对待密码一样对待令牌 — 切勿将令牌提交到 git。
  • 使用自动令牌刷新 适用于长期运行的机器人。
  • 使用用户 ID 允许列表 而不是用户名来进行访问控制。
  • 监控日志 以查看令牌刷新事件和连接状态。
  • 最小化令牌作用域 — 仅请求 chat:read 和 chat:write。
  • 如果卡住：确认没有其他进程占用该会话后，重启 Gateway 网关。

​
限制

  • 每条消息 500 个字符（会在词边界自动分块）。
  • Markdown 会在分块前被移除。
  • 无速率限制（使用 Twitch 内置速率限制）。

​
相关