internal_dnc Tool - Contact Center Compliance

The internal_dnc tool manages your organization’s private Do Not Call list. Use it to add numbers when contacts request no further calls, or remove numbers when appropriate.

Parameters

string[]

required

Phone numbers in 10-digit North American format (e.g., "8663625478").

string

required

Action to perform:

add - Add numbers to Internal DNC list
remove - Remove numbers from Internal DNC list
status - Check if numbers are on the list

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

string

Project ID to scope the Internal DNC list. Useful for multi-client or multi-campaign setups.

Response

boolean

Whether the API call succeeded.

array

Array of results for each phone number.

Show results object

string

The phone number processed.

string

Result: added, removed, already_exists, not_found, or on_list/not_on_list for status checks.

string

Machine-readable error code (when failed).

string

Human-readable error description (when failed).

Error Codes

Code	Description
`MISSING_API_KEY`	No API key provided in header or parameter
`INVALID_API_KEY`	The API key is invalid or unauthorized
`API_ERROR`	DNCScrub API returned an error
`MISSING_INPUT`	Required parameters are missing
`INVALID_PHONE`	One or more phone numbers are invalid

Examples

Add Request
Add Response
Remove Request
Status Request

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

{
  "success": true,
  "results": [
    { "phone": "5039367187", "status": "added" },
    { "phone": "7075276405", "status": "already_exists" }
  ]
}

{
  "phoneNumbers": ["5039367187"],
  "action": "remove"
}

{
  "phoneNumbers": ["5039367187"],
  "action": "status"
}

Usage Notes

Adding a number that already exists has no effect (idempotent)
Removing a number that doesn’t exist has no effect
Use projId to maintain separate Internal DNC lists per project or client
Phone numbers must be exactly 10 digits without formatting

​Parameters

​Response

​Error Codes

​Examples

​Usage Notes

Parameters

Response

Error Codes

Examples

Usage Notes