get_phone_type Tool - Contact Center Compliance

The get_phone_type tool returns whether a phone number is registered as residential or business. This is useful for B2B campaigns or compliance scenarios where different rules apply.

When to Use

B2B campaigns that should only target business numbers
Compliance scenarios where residential vs business distinction matters
Lead qualification and routing decisions

Parameters

string

required

10-digit North American phone number to check (e.g., "5039367187").

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

Response

boolean

Whether the API call succeeded.

string

The phone number checked.

string

R - Residential
B - Business
U - Unknown

string

Human-readable description of the type.

boolean

true if the number is residential.

boolean

true if the number is a business line.

string

Machine-readable error code (when failed).

string

Human-readable error description (when failed).

Examples

Request
Residential
Business

{
  "phone": "5039367187"
}

{
  "success": true,
  "phone": "5039367187",
  "type": "R",
  "typeDescription": "Residential phone number",
  "isResidential": true,
  "isBusiness": false
}

{
  "success": true,
  "phone": "5039367187",
  "type": "B",
  "typeDescription": "Business phone number",
  "isResidential": false,
  "isBusiness": true
}

Usage Notes

Some numbers may return U (Unknown) if classification data is not available
Business numbers may have different DNC exemptions depending on your campaign type
Consider combining with scrub_phone_numbers for complete compliance checking

​When to Use

​Parameters

​Response

​Examples

​Usage Notes

When to Use

Parameters

Response

Examples

Usage Notes