1. Quickstart
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
    • Upload contacts
  • 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. Quickstart

What you get

One socket gives you a live verdict on every call.
verdict.score     0.93
verdict.level     "scam"
verdict.category  "Calls pretending to be government, businesses, or family and friends"
You decide what to do with it. The filter never touches the call.

What you get#

FieldMeaning
score0 to 1. The probability that the caller is a scammer.
levelclean, suspicious, likely_scam, or scam.
categoryOne exact CallerAPI complaint subject, or none.
tacticsThe manipulation techniques the caller used.
signalsShort pieces of evidence. Above a score of 0.6 they quote the caller.
summaryTwo sentences at most.
intelCallback numbers, names, payment rails, remote tools, and other facts the caller exposed.
With report=true, a final level of scam files the caller's number and every callback number as a complaint. That block applies across CallerAPI. See Block a caller.

What it does not do#

It does not answer the call and it does not speak. The honeypot does that.
It does not change the call. You decide what to do with a verdict. See What to do with a verdict.
It does not need your audio when you already run speech recognition. See Send text instead of audio.
It does not prove fraud. A verdict is a probability. scam means a score of 0.85 or more.

The four steps#

1.
Before you start. Check the key, the credits, and the deployment. Two minutes.
2.
Test with a recording. Prove the protocol with a WAV file before you touch the switch. Ten minutes.
3.
Connect your switch, or use a Twilio or Telnyx number.
4.
What to do with a verdict. Decide one action per level, then roll out over 30 days.

Rules that apply everywhere#

Send phone numbers in E.164 format. A plus sign, the country code, then the number. +15559990000 is correct. (555) 999-0000 is not. A number without a leading + is never filed.
Send the caller's audio only. Do not mix both parties into one channel. The verdict is about the caller.
Act on level, not on score. The levels are stable. The score moves.
Modified at 2026-09-18 16:56:37
Previous
Get started
Next
Before you start
Built with