scrub_phone_numbers Tool - Contact Center Compliance

The scrub_phone_numbers tool checks phone numbers against federal, state, and your internal DNC lists, returning compliance status and phone metadata.

Parameters

string[]

required

Phone numbers in 10-digit North American format. Supports single or batch requests.

API key. Only required if not provided via the x-dncscrub-api-key HTTP header.

number

Campaign ID for usage tracking and campaign-specific settings.

string

Project ID for usage tracking and project-specific settings.

Response

boolean

Whether the API call succeeded.

array

Array of scrub results, one per phone number.

Show result object

string

The phone number checked.

string

C - Clean (OK to call)
D - Do Not Call

string

Why the number is blocked (if resultCode is D). Examples: National (USA), State (California), Litigator, Internal DNC.

string

State/province abbreviation (e.g., CA, NY).

string

Country code (e.g., US, CA).

string

Phone line type: Wireless, Landline, VoIP, or Unknown.

boolean

true if the number is wireless or VoIP.

string

Timezone code for the phone number’s location.

string

Carrier name when available.

string

EBR exemption type if one exists (S, I, or P).

string

Machine-readable error code (when failed).

string

Human-readable error description (when failed).

Result Codes

Code	Meaning	Action
`C`	Clean	OK to call (subject to time-of-day rules)
`D`	Do Not Call	Do not contact this number

Examples

Request
Response
Clean Number

{
  "phoneNumbers": ["5039367187", "7075276405"]
}

{
  "success": true,
  "results": [
    {
      "phone": "5039367187",
      "resultCode": "D",
      "reason": "Litigator",
      "region": "OR",
      "country": "US",
      "lineType": "Wireless",
      "isWireless": true,
      "timezone": "America/Los_Angeles",
      "carrier": "Verizon Wireless"
    },
    {
      "phone": "7075276405",
      "resultCode": "D",
      "reason": "National (USA)",
      "region": "CA",
      "country": "US",
      "lineType": "Landline",
      "isWireless": false,
      "timezone": "America/Los_Angeles",
      "carrier": "AT&T California"
    }
  ]
}

{
  "success": true,
  "results": [
    {
      "phone": "8005551234",
      "resultCode": "C",
      "reason": "",
      "region": "TX",
      "country": "US",
      "lineType": "Landline",
      "isWireless": false,
      "timezone": "America/Chicago",
      "carrier": "AT&T Texas"
    }
  ]
}

Usage Notes

Batch multiple numbers in a single request for better performance
Results include rich metadata (carrier, timezone, line type) useful for routing decisions
The isWireless flag is critical for TCPA compliance—wireless numbers have additional consent requirements
Use campaignId or projId to apply campaign-specific DNC settings

​Parameters

​Response

​Result Codes

​Examples

​Usage Notes

Parameters

Response

Result Codes

Examples

Usage Notes