114 lines
2.5 KiB
Markdown
114 lines
2.5 KiB
Markdown
# @clawdbot/voice-call
|
|
|
|
Official Voice Call plugin for **Clawdbot**.
|
|
|
|
Providers:
|
|
- **Twilio** (Programmable Voice + Media Streams)
|
|
- **Telnyx** (Call Control v2)
|
|
- **Plivo** (Voice API + XML transfer + GetInput speech)
|
|
- **Mock** (dev/no network)
|
|
|
|
Docs: `https://docs.clawd.bot/plugins/voice-call`
|
|
Plugin system: `https://docs.clawd.bot/plugin`
|
|
|
|
## Install (local dev)
|
|
|
|
### 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)
|
|
|
|
```bash
|
|
mkdir -p ~/.clawdbot/extensions
|
|
cp -R extensions/voice-call ~/.clawdbot/extensions/voice-call
|
|
cd ~/.clawdbot/extensions/voice-call && pnpm install
|
|
```
|
|
|
|
## Config
|
|
|
|
Put under `plugins.entries.voice-call.config`:
|
|
|
|
```json5
|
|
{
|
|
provider: "twilio", // or "telnyx" | "plivo" | "mock"
|
|
fromNumber: "+15550001234",
|
|
toNumber: "+15550005678",
|
|
|
|
twilio: {
|
|
accountSid: "ACxxxxxxxx",
|
|
authToken: "your_token"
|
|
},
|
|
|
|
plivo: {
|
|
authId: "MAxxxxxxxxxxxxxxxxxxxx",
|
|
authToken: "your_token"
|
|
},
|
|
|
|
// 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"
|
|
}
|
|
}
|
|
```
|
|
|
|
Notes:
|
|
- Twilio/Telnyx/Plivo require a **publicly reachable** webhook URL.
|
|
- `mock` is a local dev provider (no network calls).
|
|
|
|
## CLI
|
|
|
|
```bash
|
|
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
|
|
```
|
|
|
|
## Tool
|
|
|
|
Tool name: `voice_call`
|
|
|
|
Actions:
|
|
- `initiate_call` (message, to?, mode?)
|
|
- `continue_call` (callId, message)
|
|
- `speak_to_user` (callId, message)
|
|
- `end_call` (callId)
|
|
- `get_status` (callId)
|
|
|
|
## Gateway RPC
|
|
|
|
- `voicecall.initiate` (to?, message, mode?)
|
|
- `voicecall.continue` (callId, message)
|
|
- `voicecall.speak` (callId, message)
|
|
- `voicecall.end` (callId)
|
|
- `voicecall.status` (callId)
|
|
|
|
## Notes
|
|
|
|
- Uses webhook signature verification for Twilio/Telnyx/Plivo.
|
|
- `responseModel` / `responseSystemPrompt` control AI auto-responses.
|
|
- Media streaming requires `ws` and OpenAI Realtime API key.
|