2.8 KiB
2.8 KiB
Softphone Quick Start Guide
Setup (5 minutes)
1. Configure Twilio
- Create a Twilio account at https://www.twilio.com
- Get your credentials:
- Account SID (starts with AC...)
- Auth Token
- Purchase a phone number
- Configure webhook URLs in Twilio Console:
- Voice webhook:
https://your-domain.com/api/voice/twiml/inbound - Status callback:
https://your-domain.com/api/voice/webhook/status
- Voice webhook:
2. Configure OpenAI (Optional for AI features)
- Get OpenAI API key from https://platform.openai.com
- Ensure you have access to Realtime API (beta feature)
3. Add Credentials to Platform
- Log into your tenant
- Navigate to Settings → Integrations
- Fill in Twilio section:
- Account SID
- Auth Token
- Phone Number (format: +1234567890)
- Fill in OpenAI section (optional):
- API Key
- Model:
gpt-4o-realtime-preview(default) - Voice:
alloy(default)
- Click Save Configuration
Using the Softphone
Make a Call
- Click Softphone button in sidebar (phone icon)
- Enter phone number in E.164 format:
+1234567890 - Click Call or press Enter
- Wait for connection
- During call:
- Click hash icon for DTMF keypad
- Click microphone to mute/unmute
- Click red phone to hang up
Receive a Call
- Softphone automatically connects when logged in
- Incoming call notification appears with ringtone
- Click Accept (green button) or Reject (red button)
- If accepted, call controls appear
AI Features (if OpenAI configured)
- Real-time Transcript: See what's being said live
- AI Suggestions: Get contextual tips during calls
- Smart Actions: AI can search contacts, create tasks automatically
Quick Tips
- ✅ Phone number format:
+1234567890(include country code) - ✅ Close dialog: Click outside or press Escape
- ✅ Incoming calls work even if dialog is closed
- ✅ Recent calls appear for quick redial
- ❌ Don't forget to save credentials before testing
- ❌ Webhook URLs must be publicly accessible (not localhost)
Troubleshooting
| Issue | Solution |
|---|---|
| "Not connected" | Check credentials in Settings → Integrations |
| Can't make calls | Verify Twilio Account SID and Auth Token |
| Can't receive calls | Check Twilio webhook configuration |
| No AI features | Add OpenAI API key in settings |
| WebSocket errors | Check browser console, verify backend URL |
Testing with Twilio Test Credentials
For development, Twilio provides test credentials:
- Use Twilio test numbers
- No actual calls are made
- Simulate call flows in development
Next Steps
- 📞 Make your first test call
- 🎤 Try the AI transcription feature
- 📊 View call history in Softphone dialog
- ⚙️ Configure call routing (advanced)
Need help? Check /docs/SOFTPHONE_IMPLEMENTATION.md for detailed documentation.