1. Voice firewall
CallerAPI Documentation
  • Quickstart
  • Use cases
    • For carriers (MNOs/MVNOs)
    • CPaaS platforms
    • Cloud communications providers
    • SIP trunking providers
    • PBX/Cloud PBX
    • UCaaS vendors
  • Account
    • Balance and email
      GET
  • Spam protection
    • Voice firewall
      • Get started
      • Quickstart
        • What you get
        • Before you start
        • Test with a recording
        • Connect your switch
        • Switch notes
        • Twilio and Telnyx
        • Send text instead of audio
      • Verdicts
        • Read a verdict
        • What to do with a verdict
        • Block a caller
        • Events and webhooks
      • Honeypot
        • Hand a call over
        • Audio, events, and limits
      • Reference
        • Endpoints
        • Errors
        • Limits and thresholds
        • Production checklist
      • REST
        • What this deployment can do
        • List the verdict categories
        • List the honeypot personas
        • Score a transcript or a recording
        • List your recent sessions
        • Get one session with verdict and intel
        • Twilio voice URL for a screened number
        • Preview the Twilio TwiML
        • Telnyx voice URL for a screened number
        • Twilio voice URL for a honeypot number
        • Telnyx voice URL for a honeypot number
      • WebSocket
        • Live scam filter stream
        • Honeypot stream
    • Daily spam reports
      • Webhook
        • Subscribe to daily reports
        • Unsubscribe from daily reports
        • List webhook subscriptions
        • Manual dispatch of reports
        • Test webhook
      • REST
        • Fetch daily spam reports
    • 15 days spam CSV snapshot
      GET
    • Spam score + HLR
      GET
  • Mobile SDK
    • Get started
    • Quickstart
      • What you get
      • Get your keys
      • Android
      • iOS
      • Flutter
      • React Native
      • Check it works
    • Call screening
      • What each platform can do
      • Android call screening
      • iOS prerequisites
      • iOS add the extension
      • iOS test on device
    • Reference
      • Methods
      • Errors
      • Limits and billing
      • Troubleshooting
  • Data partners
    • Partner tems & docs
    • Upload spam reports
      POST
    • Upload contacts
      POST
  • Fraud prevention
    • Ported date
    • Porting history
    • Online presence
    • KYC user identity
  • Schemas
    • Spam protection
      • Spam score request
      • Business info
      • Carrier info
      • Complaint (without number)
      • Daily spam reports request
      • Complaint (with phone)
  1. Voice firewall

Get started

The voice firewall listens to a live call and tells you, while the call is up, how likely the caller is a scammer. It transcribes the caller, scores the call as it runs, and sends you an event each time the score changes. When the call ends it runs one full analysis on the whole transcript and stores the result.
You bring the call. The filter works with a switch, a PBX, an SBC, a media server, or a Twilio or Telnyx number. You do not install anything.

Pick your path#

There are three things you can do. They take different amounts of time.

Path 1: score a transcript or a recording#

One HTTP request. Send text or audio and get a verdict back. About 5 minutes. Use it to test your key and to score calls after the fact.
Go to Score a transcript or a recording.

Path 2: score live calls from your switch#

Your switch streams the caller's audio to a WebSocket and gets verdict events while the call is up. About one hour on FreeSWITCH. Half a day with a bridge on Asterisk or Kamailio. About 10 minutes on a Twilio or Telnyx number.
Go to What you get.

Path 3: hand scam calls to a persona#

The honeypot answers the call as a vulnerable-sounding person, keeps the scammer busy, records what they reveal, and files the number. One setting on the CallerAPI SIP firewall, or one INVITE from your switch.
Go to Hand a call over.

What you need before any path#

1.
Your API key from the dashboard. It is the same key as the rest of the CallerAPI API.
2.
Credits on the account. See Limits and thresholds for prices.
3.
For path 2, a component that can open a WebSocket and stream audio. Before you start lists what to check.

Where to go when something breaks#

Errors lists what you see and what causes it. Read it before you open a support ticket.
Modified at 2026-09-18 16:57:32
Previous
Balance and email
Next
What you get
Built with