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
  • Business Caller ID
    • Get started
    • Quickstart
      • Announce a call
      • Verify at INVITE
      • What you get
    • Verdicts
      • Show the name and logo
      • Read a verdict
    • REST
      • Verify the calling number
      • Fetch the logo
      • Announce a call
  • DID monitoring
    • Get started
    • Reference
      • Statuses and labels
      • Webhooks
      • Billing and limits
      • Errors
    • REST
      • Submit numbers
      • List number status
      • Read one number
      • Remove a number
      • Read the check schedule
      • Set the check schedule
      • Save the webhook URL
      • Read the webhook
      • Delete the webhook
      • Send a test event
      • Rotate the webhook secret
    • Number flagged
    • Number cleared
  • Signer reputation by SPC
    GET
  • Signers ranked by score
    GET
  • Schemas
    • Spam protection
      • Spam score request
      • Business info
      • Carrier info
      • Complaint (without number)
      • Daily spam reports request
      • Complaint (with phone)
    • Signer
    • SubmitResponse
    • Monitoring
    • Number
    • NumberListResponse
    • OneNumberResponse
    • ScheduleResponse
    • WebhookWriteResponse
    • WebhookReadResponse
    • FlaggedEvent
    • ClearedEvent
    • EventData
    • Error
    • AuthError
    • ScheduleRequest
    • WebhookRequest
    • RemovedResponse
    • WebhookTestResponse
  1. Reference

Statuses and labels

Each monitored number has one status and one label. The status is for your code. The label is a short text for a person. Both come from the last check of the number.

Statuses#

statuslabelMeaningWhat to do
pendingWaiting for first checkCallerAPI stored the number. The first check did not run yet.Wait. The first pass checks about 80 numbers a minute.
cleanNo flagsThe last check found no spam or scam flag.Nothing.
flaggedSpam or scam riskThe last check found a spam or scam flag on the number.Examine the calls from this number.
unknownCheck failed, retryingThe last check did not finish.Wait. The number gets a new check in the next pass.
The label for flagged is always "Spam or scam risk". The API does not tell you which kind of flag it found.
Use the status field in your code. Do not parse the label. A label can change. A status value does not change.

Times on each number#

FieldMeaning
last_checked_atWhen the last check finished. null before the first check.
status_changed_atWhen the number last became flagged, or became clean after a flag. null if this did not occur.
next_check_atWhen the next scheduled pass starts. null when scheduled checks are off or paused.
All times are RFC 3339 in UTC.

When the status changes#

FromToWebhook event
pending, clean, or unknownflaggednumber.flagged
flaggedcleannumber.cleared
pendingcleanNone
Any statusunknownNone
unknowncleanNone
A number that goes from flagged to unknown and then to clean does not send number.cleared. Send GET /api/did-monitoring/v1/numbers to get the current status of all numbers. Use status=flagged to get only the flagged numbers.

Monitoring state#

The submit and schedule responses have a state. It tells you if scheduled checks run.
stateMeaning
scheduledScheduled checks are on. The next pass waits for its time.
checkingA pass runs now.
pausedChecks stopped. The account has no credits left, or the schedule uses more credits than the plan includes. See the Billing and limits page.
offScheduled checks are off. New numbers still get their first check.
Modified at 2026-10-29 10:43:45
Previous
Get started
Next
Webhooks
Built with