114 lines
2.5 KiB
Markdown
Raw Normal View History

2026-01-12 01:16:39 +00:00
# @clawdbot/voice-call
2026-01-11 12:11:12 +00:00
2026-01-12 01:16:39 +00:00
Official Voice Call plugin for **Clawdbot**.
2026-01-12 21:40:22 +00:00
Providers:
- **Twilio** (Programmable Voice + Media Streams)
- **Telnyx** (Call Control v2)
2026-01-13 17:16:02 +05:30
- **Plivo** (Voice API + XML transfer + GetInput speech)
2026-01-12 21:40:22 +00:00
- **Mock** (dev/no network)
2026-01-12 01:16:39 +00:00
Docs: `https://docs.clawd.bot/plugins/voice-call`
2026-01-12 01:27:05 +00:00
Plugin system: `https://docs.clawd.bot/plugin`
2026-01-11 12:11:12 +00:00
## Install (local dev)
2026-01-12 01:16:39 +00:00
### Option A: install via Clawdbot (recommended)
```bash
clawdbot plugins install @clawdbot/voice-call
```
Restart the Gateway afterwards.
### Option B: copy into your global extensions folder (dev)
2026-01-11 12:11:12 +00:00
```bash
mkdir -p ~/.clawdbot/extensions
cp -R extensions/voice-call ~/.clawdbot/extensions/voice-call
cd ~/.clawdbot/extensions/voice-call && pnpm install
```
2026-01-11 23:23:14 +00:00
## Config
Put under `plugins.entries.voice-call.config`:
```json5
{
2026-01-13 17:16:02 +05:30
provider: "twilio", // or "telnyx" | "plivo" | "mock"
2026-01-12 21:40:22 +00:00
fromNumber: "+15550001234",
toNumber: "+15550005678",
2026-01-11 23:23:14 +00:00
twilio: {
accountSid: "ACxxxxxxxx",
2026-01-12 21:40:22 +00:00
authToken: "your_token"
},
2026-01-13 17:16:02 +05:30
plivo: {
authId: "MAxxxxxxxxxxxxxxxxxxxx",
authToken: "your_token"
},
2026-01-12 21:40:22 +00:00
// Webhook server
serve: {
port: 3334,
path: "/voice/webhook"
},
// Public exposure (pick one):
// publicUrl: "https://example.ngrok.app/voice/webhook",
// tunnel: { provider: "ngrok" },
// tailscale: { mode: "funnel", path: "/voice/webhook" }
outbound: {
defaultMode: "notify" // or "conversation"
},
streaming: {
enabled: true,
streamPath: "/voice/stream"
2026-01-11 23:23:14 +00:00
}
}
```
2026-01-12 21:40:22 +00:00
Notes:
2026-01-13 17:16:02 +05:30
- Twilio/Telnyx/Plivo require a **publicly reachable** webhook URL.
2026-01-12 21:40:22 +00:00
- `mock` is a local dev provider (no network calls).
2026-01-11 12:11:12 +00:00
## CLI
```bash
2026-01-12 21:40:22 +00:00
clawdbot voicecall call --to "+15555550123" --message "Hello from Clawdbot"
clawdbot voicecall continue --call-id <id> --message "Any questions?"
clawdbot voicecall speak --call-id <id> --message "One moment"
clawdbot voicecall end --call-id <id>
clawdbot voicecall status --call-id <id>
clawdbot voicecall tail
clawdbot voicecall expose --mode funnel
2026-01-11 12:11:12 +00:00
```
## Tool
Tool name: `voice_call`
2026-01-12 21:40:22 +00:00
Actions:
- `initiate_call` (message, to?, mode?)
- `continue_call` (callId, message)
- `speak_to_user` (callId, message)
- `end_call` (callId)
- `get_status` (callId)
2026-01-11 12:11:12 +00:00
## Gateway RPC
2026-01-12 21:40:22 +00:00
- `voicecall.initiate` (to?, message, mode?)
- `voicecall.continue` (callId, message)
- `voicecall.speak` (callId, message)
- `voicecall.end` (callId)
- `voicecall.status` (callId)
2026-01-11 12:11:12 +00:00
## Notes
2026-01-13 17:16:02 +05:30
- Uses webhook signature verification for Twilio/Telnyx/Plivo.
2026-01-12 21:40:22 +00:00
- `responseModel` / `responseSystemPrompt` control AI auto-responses.
- Media streaming requires `ws` and OpenAI Realtime API key.