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

Billing and limits

Credits#

Each check of one number uses 1 credit. DID monitoring uses the same credits as the rest of the CallerAPI API.
ActionCredits
One check of one number1
A check with the result unknown1
Submit numbers0
Read results, the schedule, or the webhook0
Webhook deliveries and test events0
Remove a number0
CallerAPI takes the credit before the check runs. A check that ends as unknown also uses 1 credit.

Credit estimate#

The number of checks in a month is the number of numbers multiplied by the checks for each number. The default schedule is one check a day. This gives about 30.4 checks a month for each number.
NumbersScheduleCredits in a month (about)
100Every 24 hours3,040
100Every 12 hours6,080
1,000Every 24 hours30,400
GET /api/did-monitoring/v1/schedule and PUT /api/did-monitoring/v1/schedule return estimate. It gives the checks in a month for your numbers and your schedule, and the credits that your plan includes.
If the estimate is more than the credits that your plan includes, CallerAPI saves the schedule as paused. Then estimate.over_plan is true and state is paused. Choose a longer interval, fewer days, or fewer numbers.

When credits run out#

1.
CallerAPI pauses the checks for the account.
2.
CallerAPI sends an email to the account email address.
3.
state is paused and next_check_at is null.
4.
When the account has credits again, the checks start again. You do not need to do anything.
New numbers do not get a first check while checks are paused for credits.

Limits#

LimitValue
Monitored numbersAt most the number of credits that your plan includes each month
Numbers in one submit request100,000
Webhook URLs1 for each account. Not available on the Free plan.
Write requests (POST, PUT, DELETE)60 a minute for each account
Page size for GET /numbersDefault 50, maximum 100
First pass for new numbersAbout 80 numbers a minute
Check scheduleEvery 15 minutes to every 24 hours
Set times of day1 to 24

Monitored numbers#

The number of monitored numbers cannot be more than the credits that your plan includes each month. For example, a plan with 5,000 credits each month can monitor at most 5,000 numbers. A submit request that goes over this limit returns 403. It does not add any of the numbers.
To monitor more numbers, change to a larger plan, or remove numbers that you do not need.

Write requests#

POST, PUT, and DELETE requests to DID monitoring are limited to 60 a minute for each account. Over this limit, the response is 429. Wait one minute and send the request again. GET requests do not count toward this limit.

Check schedule#

New accounts check each number one time a day, every day, in UTC. Scheduled checks are on by default.
You can choose one of these:
modeFieldsValues
intervalinterval_minutes15, 30, 60, 120, 180, 240, 360, 480, 720, or 1440
timestimes1 to 24 times of day, like "09:00"
You can also set these fields:
FieldMeaning
enabledfalse stops scheduled checks. New numbers still get their first check.
timezoneAn IANA time zone, like America/New_York. The default is UTC.
weekdaysDays to check. 1 is Monday and 7 is Sunday. The default is all days.
start, endThe hours to check in, like "08:00" and "18:00". The default is all day.
Send only the fields that you want to change. The other fields keep their saved values.
Modified at 2026-10-29 10:43:45
Previous
Webhooks
Next
Errors
Built with