Skip to content

Quick-Start.md

Latest commit

 

History

History
161 lines (123 loc) · 3.9 KB

Quick-Start.md

File metadata and controls

161 lines (123 loc) · 3.9 KB
Raw

Quick Start Guide

Get SIPSentinel up and running in minutes.

⚡ Prerequisites

You'll need accounts with these services:

  • Twilio - Phone numbers and webhooks
  • VAPI - AI voice agents
  • OpenRouter - LLM for scam detection
  • AWS - Storage and transcription

🚀 Installation

1. Clone Repository

git clone https://github.com/michael-bey/SIPSentinel.git
cd SIPSentinel
npm install

2. Interactive Setup

npm run setup

The setup wizard will:

  • Create your .env file
  • Guide you through service configuration
  • Validate your setup
  • Create AI agent templates

3. Start the System

npm start

Access the dashboard at: http://localhost:3000

🧪 Quick Test

Test Scam Detection

curl -X POST http://localhost:3000/test-detection \
     -H "Content-Type: application/json" \
     -d '{"message": "URGENT: Your Coinbase account compromised. Call 1-800-555-0123"}'

Test Agent Call

curl "http://localhost:3000/test-call?phone=+1234567890&scamType=crypto_exchange"

Simulate Full Scam Response

curl "http://localhost:3000/simulate-scam?phone=+1234567890&type=crypto_exchange"

🌐 Deploy to Production

Vercel (Recommended)

npm install -g vercel
vercel --prod

Netlify

npm install -g netlify-cli
netlify deploy --prod

🔧 Configure Webhooks

In your Twilio Console, set these webhook URLs:

Voice URL: https://your-domain.com/voice
SMS URL: https://your-domain.com/sms
Recording Status: https://your-domain.com/recording-status
Transcription: https://your-domain.com/transcription

📱 Test with Real Calls

  1. Call your Twilio number
  2. Leave a scam-like voicemail: 
    "Hello, this is Coinbase security. Your account has been compromised. 
Please call us back immediately at 1-800-555-0123."
  3. Watch the dashboard for scam detection
  4. Observe the AI agent callback

🔔 Set Up Notifications (Optional)

Slack

  1. Create webhook at api.slack.com/messaging/webhooks
  2. Add to .env: 
    SLACK_WEBHOOK_URL=https://hooks.slack.com/services/YOUR/SLACK/WEBHOOK

Telegram

  1. Create bot with @BotFather
  2. Add to .env: 
    TELEGRAM_BOT_TOKEN=your_bot_token
TELEGRAM_CHAT_ID=your_chat_id

🛠️ Troubleshooting

Common Issues

Environment variables not set:

npm run validate

Webhooks not working:

  • Check Twilio Console webhook URLs
  • Verify deployment is publicly accessible
  • Test webhook endpoints manually

No agents found:

npm run create-agents --all

Scam detection not working:

  • Verify OpenRouter API key
  • Check account credits
  • Test with known scam phrases

📚 Next Steps

  1. Explore the Dashboard - Monitor scam detections and agent conversations
  2. Customize Agents - Modify agent templates for your use case
  3. Set Up Monitoring - Configure Slack/Telegram notifications
  4. Review Analytics - Track success metrics and performance
  5. Scale Up - Add more phone numbers and optimize for volume

🔗 Useful Links

💡 Tips for Success

  1. Start Small - Test with one scam type first
  2. Monitor Costs - Keep track of API usage across services
  3. Iterate Agents - Improve agent responses based on performance
  4. Security First - Never commit API keys to git
  5. Scale Gradually - Add features and capacity incrementally

Need help? Check the Troubleshooting Guide or create an issue on GitHub.