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

Endpoints

Base URL: https://api.callerapi.com/api/voice
Socket URL: wss://api.callerapi.com/api/voice
Auth: X-Auth: YOUR_KEY header, or ?key=YOUR_KEY on the URL. Every JSON response has "status": "success" or "status": "error" with a message.

REST#

MethodPathPurposeCost
GET/capabilitiesWhat this deployment can do and what it chargesfree
GET/categoriesThe category list with descriptionsfree
GET/personasThe honeypot castfree
POST/scanScore a transcript or a recording2 credits plus 1 per started minute of audio
GET/sessionsYour recent sessionsfree
GET/sessions/{id}One session with verdict and intelfree
POST/filter/twimlTwilio voice URL for a screened numberfilter rate
GET/filter/twimlPreview the TwiML in a browserfree
POST/filter/texmlTelnyx voice URL for a screened numberfilter rate
POST/honeypot/twimlTwilio voice URL for a honeypot numberhoneypot rate
POST/honeypot/texmlTelnyx voice URL for a honeypot numberhoneypot rate
Each endpoint page has the request fields, the response schema, and examples.

WebSocket#

PathPurposeCost
/filter/streamLive filter socket. Listens and scores. Never sends audio.3 credits per started minute
/honeypot/streamLive honeypot socket. Listens and speaks.8 credits per started minute
Both are in the WebSocket folder of this section. The protocol walkthrough is on Connect your switch and Audio, events, and limits.
Both sockets also accept Twilio and Telnyx Media Streams. The first text frame decides the protocol. On those protocols, events go to the webhook only.
Modified at 2026-09-18 16:57:08
Previous
Audio, events, and limits
Next
Errors
Built with