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
        GET
      • Porting history
        GET
      • Online presence
        GET
      • KYC user identity
        POST
    • Schemas
      • Spam protection
        • Spam score request
        • Business info
        • Carrier info
        • Complaint (without number)
        • Daily spam reports request
        • Complaint (with phone)

    Quickstart

    Stop Spam Calls
    Score inbound/outbound numbers and auto-block high-risk calls.
    Prevent Porting Fraud
    Detect recent port-out/SIM-swap signals before you trust a number.
    Verify Reachability
    Check HLR and presence (WhatsApp, Telegram, etc.) to route smarter.
    Talk to an expert
    Make your telco spam-free by integrating CallerAPI.

    Who is CallerAPI for?#

    CallerAPI helps carriers, CPaaS platforms, cloud comms/SIP providers, PBX & UCaaS vendors, and consumer apps stop revenue-draining spam, block account takeover, and cut messaging costs with real-time phone intelligence. Use it to decide “Should I trust this number, connect this call, send this message, or ask for more verification?”

    Get an API key#

    Get started → Dashboard → Copy API Key
    Keep it safe; pass it in the x-auth header like this:
    x-auth: YOUR_CALLERAPI_KEY

    Base URL#

    Use https://api.callerapi.com. Requests are routed to the nearest region automatically.

    Make your first request#

    get_callerapi_key.gif
    Or with cURL/code:
    cURL
    Node.js
    Python
    PHP

    Interpret the response#

    All the API responses are returned in JSON format. This would be a response for the previous API call:
    {
      "credits_left": 9691567,
      "credits_monthly": 9999999,
      "credits_spent": 308432,
      "email": "you@company.com",
      "status": "success"
    }
    Modified at 2026-09-18 16:26:34
    Next
    For carriers (MNOs/MVNOs)
    Built with