Voice Call Plugin

Voice Call (plugin)

通过插件为 OpenClaw 提供语音通话功能。支持呼出通知和具有呼入策略的多轮对话。

当前支持的 provider:

  • twilio(Programmable Voice + Media Streams)
  • telnyx(Call Control v2)
  • plivo(Voice API + XML transfer + GetInput speech)
  • mock(开发/无网络)

快速心智模型:

  • 安装插件
  • 重启 Gateway
  • plugins.entries.voice-call.config 下配置
  • 使用 openclaw voicecall ...voice_call 工具

运行位置(本地 vs 远程)

Voice Call 插件在 Gateway 进程内运行。

如果你使用远程 Gateway,请在运行 Gateway 的机器上安装/配置插件,然后重启 Gateway 以加载它。

安装

选项 A:从 npm 安装(推荐)

openclaw plugins install @openclaw/voice-call

之后重启 Gateway。

选项 B:从本地文件夹安装(开发,不复制)

openclaw plugins install ./extensions/voice-call
cd ./extensions/voice-call && pnpm install

之后重启 Gateway。

配置

plugins.entries.voice-call.config 下设置配置:

{
  plugins: {
    entries: {
      "voice-call": {
        enabled: true,
        config: {
          provider: "twilio", // 或 "telnyx" | "plivo" | "mock"
          fromNumber: "+15550001234",
          toNumber: "+15550005678",

          twilio: {
            accountSid: "ACxxxxxxxx",
            authToken: "...",
          },

          telnyx: {
            apiKey: "...",
            connectionId: "...",
            // 来自 Telnyx Mission Control Portal 的 Telnyx webhook 公钥
            //(Base64 字符串;也可通过 TELNYX_PUBLIC_KEY 设置)
            publicKey: "...",
          },

          plivo: {
            authId: "MAxxxxxxxxxxxxxxxxxxxx",
            authToken: "...",
          },

          // Webhook 服务器
          serve: {
            port: 3334,
            path: "/voice/webhook",
          },

          // Webhook 安全(推荐用于隧道/代理)
          webhookSecurity: {
            allowedHosts: ["voice.example.com"],
            trustedProxyIPs: ["100.64.0.1"],
          },

          // 公开暴露(选择一个)
          // publicUrl: "https://example.ngrok.app/voice/webhook",
          // tunnel: { provider: "ngrok" },
          // tailscale: { mode: "funnel", path: "/voice/webhook" }

          outbound: {
            defaultMode: "notify", // notify | conversation
          },

          streaming: {
            enabled: true,
            streamPath: "/voice/stream",
            preStartTimeoutMs: 5000,
            maxPendingConnections: 32,
            maxPendingConnectionsPerIp: 4,
            maxConnections: 128,
          },
        },
      },
    },
  },
}

注意事项:

  • Twilio/Telnyx 需要可公开访问的 webhook URL。
  • Plivo 需要可公开访问的 webhook URL。
  • mock 是本地开发 provider(无网络调用)。
  • Telnyx 需要 telnyx.publicKey(或 TELNYX_PUBLIC_KEY),除非 skipSignatureVerification 为 true。
  • skipSignatureVerification 仅用于本地测试。
  • 如果你使用 ngrok 免费版,将 publicUrl 设置为确切的 ngrok URL;签名验证始终强制执行。
  • tunnel.allowNgrokFreeTierLoopbackBypass: true 允许 Twilio webhook 使用无效签名仅当 tunnel.provider="ngrok"serve.bind 是环回(ngrok 本地代理)。仅用于本地开发。
  • Ngrok 免费版 URL 可能会更改或添加中间行为;如果 publicUrl 漂移,Twilio 签名将失败。对于生产环境,优先使用稳定域名或 Tailscale funnel。
  • 流媒体安全默认值:
    • streaming.preStartTimeoutMs 关闭从未发送有效 start 帧的 socket。
    • streaming.maxPendingConnections 限制未认证的预启动 socket 总数。
    • streaming.maxPendingConnectionsPerIp 限制每个源 IP 的未认证预启动 socket 数。
    • streaming.maxConnections 限制打开的媒体流 socket 总数(待处理 + 活动)。

陈旧通话回收器

使用 staleCallReaperSeconds 结束从未收到终端 webhook 的通话(例如从未完成的 notify 模式通话)。默认值为 0(禁用)。

推荐范围:

  • 生产环境: notify 风格流程使用 120300 秒。
  • 将此值保持高于 maxDurationSeconds,以便正常通话可以完成。一个好的起点是 maxDurationSeconds + 30–60 秒。

示例:

{
  plugins: {
    entries: {
      "voice-call": {
        config: {
          maxDurationSeconds: 300,
          staleCallReaperSeconds: 360,
        },
      },
    },
  },
}

Webhook 安全

当代理或隧道位于 Gateway 前面时,插件会重构公共 URL 以进行签名验证。这些选项控制信任哪些转发头。

webhookSecurity.allowedHosts 允许来自转发头的主机。

webhookSecurity.trustForwardingHeaders 在没有 allowlist 的情况下信任转发头。

webhookSecurity.trustedProxyIPs 仅当请求远程 IP 匹配列表时才信任转发头。

Twilio 和 Plivo 启用了 webhook 重放保护。重放的有效 webhook 请求会被确认但跳过副作用。

Twilio 对话轮次在 <Gather> 回调中包含每轮令牌,因此陈旧/重放的语音回调无法满足更新的待处理转录轮次。

使用稳定公共主机的示例:

{
  plugins: {
    entries: {
      "voice-call": {
        config: {
          publicUrl: "https://voice.example.com/voice/webhook",
          webhookSecurity: {
            allowedHosts: ["voice.example.com"],
          },
        },
      },
    },
  },
}

通话的 TTS

Voice Call 使用核心 messages.tts 配置(OpenAI 或 ElevenLabs)进行通话中的流式语音。你可以在插件配置下使用相同形状覆盖它——它与 messages.tts 深度合并。

{
  tts: {
    provider: "elevenlabs",
    elevenlabs: {
      voiceId: "pMsXgVXv3BLzUgSXRplE",
      modelId: "eleven_multilingual_v2",
    },
  },
}

注意事项:

  • Edge TTS 被忽略用于语音通话(电话音频需要 PCM;Edge 输出不可靠)。
  • 当 Twilio 媒体流启用时使用核心 TTS;否则通话回退到 provider 原生语音。

更多示例

仅使用核心 TTS(无覆盖):

{
  messages: {
    tts: {
      provider: "openai",
      openai: { voice: "alloy" },
    },
  },
}

仅为通话覆盖到 ElevenLabs(在其他地方保持核心默认):

{
  plugins: {
    entries: {
      "voice-call": {
        config: {
          tts: {
            provider: "elevenlabs",
            elevenlabs: {
              apiKey: "elevenlabs_key",
              voiceId: "pMsXgVXv3BLzUgSXRplE",
              modelId: "eleven_multilingual_v2",
            },
          },
        },
      },
    },
  },
}

仅为通话覆盖 OpenAI 模型(深度合并示例):

{
  plugins: {
    entries: {
      "voice-call": {
        config: {
          tts: {
            openai: {
              model: "gpt-4o-mini-tts",
              voice: "marin",
            },
          },
        },
      },
    },
  },
}

呼入通话

呼入策略默认为 disabled。要启用呼入通话,设置:

{
  inboundPolicy: "allowlist",
  allowFrom: ["+15550001234"],
  inboundGreeting: "Hello! How can I help?",
}

自动响应使用 agent 系统。使用以下选项调整:

  • responseModel
  • responseSystemPrompt
  • responseTimeoutMs

CLI

openclaw voicecall call --to "+15555550123" --message "Hello from OpenClaw"
openclaw voicecall continue --call-id <id> --message "Any questions?"
openclaw voicecall speak --call-id <id> --message "One moment"
openclaw voicecall end --call-id <id>
openclaw voicecall status --call-id <id>
openclaw voicecall tail
openclaw voicecall expose --mode funnel

Agent 工具

工具名称:voice_call

操作:

  • initiate_call(message, to?, mode?)
  • continue_call(callId, message)
  • speak_to_user(callId, message)
  • end_call(callId)
  • get_status(callId)

此仓库在 skills/voice-call/SKILL.md 中提供了匹配的技能文档。

Gateway RPC

  • voicecall.initiateto?, message, mode?
  • voicecall.continuecallId, message
  • voicecall.speakcallId, message
  • voicecall.endcallId
  • voicecall.statuscallId