1. Reference
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. Reference

Errors

Organized by what you see, not by cause.

HTTP endpoints#

StatusMeaningWhat to do
400Bad input. The message says which field.Fix the request. It cost nothing.
401Missing or wrong key.Send X-Auth or ?key=.
402Insufficient credits.Top up the account.
404Session not found, or it belongs to another key.Check the session_id and the key.
502Transcription failed on /scan.Retry. Send a transcript instead if it repeats.
503The product is off on this deployment, or the node is at its session limit.Check What this deployment can do. Retry on a new connection.
Every error body is {"status": "error", "message": "..."}.

Socket#

What you seeCause
Upgrade refused with 401Missing or wrong key.
Upgrade refused with 503live_filter is false, or the node is full. Retry on a new connection.
Socket closed with no eventsNo start message within 10 seconds, a binary frame before the start message, or an unsupported encoding or sample_rate.
session.started but no transcript.lineNo audio is arriving, the audio is silent, or the encoding does not match what you declared. Check encoding and sample_rate first.
transcript.line with garbage textWrong encoding or sample_rate, or both parties mixed in one channel.
Session ended early with session.endedCredits ran out, or the session hit its time limit.
session.errorHoneypot only. Speech synthesis failed. The error field carries the message.

Webhook#

What you seeCause
No posts at allThe URL is not HTTPS. HTTP URLs are ignored without an error.
Some posts missingYour endpoint took more than 5 seconds or returned a non-2xx status. There is no retry. Read Get one session.
Signature does not matchYou hashed the parsed JSON instead of the raw body, or you used a different key than the one that opened the session.

Verdicts#

What you seeCause
No verdict events on a callThe call is clean, or every rules-only score stayed below 0.5. Normal.
scam on a legitimate callRead the transcript in Get one session. If the verdict is wrong, contact us with the session_id.
Nothing filed with report=truefrom was missing or not E.164 with a leading +, the category is never filed, or the score did not reach the threshold. See Block a caller.
Modified at 2026-09-18 16:57:11
Previous
Endpoints
Next
Limits and thresholds
Built with