Copy Page
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
Spam score + HLR
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
RemovedResponse
Copy Page
{
"status"
:
"success"
,
"data"
:
{
"removed"
:
true
}
}