CallerAPI Documentation
  1. Spam protection
CallerAPI Documentation
  • Quckstart
  • 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
    • Spam score + HLR
      GET
    • Fetch daily spam reports
      GET
  • Fraud prevention
    • Ported date
      GET
    • Porting history
      GET
    • Online presence
      GET
    • KYC user identity
      POST
  • Data partners
    • Upload spam reports
      POST
    • Upload contacts
      POST
  • Voice
    • Coming soon...
  • SMS
    • Coming soon...
  • SIP Trunking
    • Coming soon...
  • Schemas
    • Spam protection
      • Spam score request
      • Business info
      • Carrier info
      • Complaint (without number)
      • Daily spam reports request
      • Complaint (with phone)
  1. Spam protection

Spam score request

{
    "data": {
        "business_info": {
            "business_name": "string",
            "category": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "industry": "string",
            "verified": true
        },
        "carrier_info": {
            "country": {
                "code": "string",
                "iso": "string",
                "name": "string"
            },
            "network": {
                "carrier": "string",
                "ocn": "string",
                "original": {
                    "carrier": "string",
                    "spid": "string"
                },
                "spid": "string",
                "type": "CAP"
            },
            "number": {
                "landline": true,
                "local_format": "string",
                "lrn": "string",
                "mobile": true,
                "msisdn": "string",
                "ported": true,
                "ported_date": "string",
                "type": "CAP",
                "valid": "string"
            }
        },
        "complaints": [
            {
                "CreatedDate": "2019-08-24T14:15:22Z",
                "ViolationDate": "2019-08-24T14:15:22Z",
                "ConsumerState": "string",
                "Subject": "Advance Fee Loan",
                "RecordedMessageOrRobocall": "Y",
                "Comment": "string"
            }
        ],
        "entity_type": "BUSINESS",
        "is_spam": true,
        "phone": "string",
        "reputation": "string",
        "spam_score": 0,
        "total_complaints": 0
    },
    "status": "success"
}
Built with