DNC Management

Authentication

All API requests must include a universal API key as a bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY_HERE

Info

Your universal API key can be generated in the outboundIQ workspace dashboard. Create a new key of type universal and keep it secret — treat it like a password.

If the key is missing, invalid, inactive, or not a universal-typed key, the server will respond with a 401 or 403.

Base URL

https://api.outboundiq.cloud/dnc

Info

The company associated with the API key determines which dialer the DNC operation is applied to. The workspace must have a dialer configured before these endpoints can be used.

Info

DNC operations are currently supported for Five9 and CallShaper dialers. Requests for workspaces on other dialer types return 400.

Info

Phone numbers are normalized to digits only — formatting characters (spaces, dashes, parens, +) are stripped before the request is sent to the dialer. "561-123-4567", "(561) 123-4567", and "5611234567" are all treated as the same number. A normalized number must contain at least 10 digits.

Endpoints

Add to DNC

• Method: POST
• URL: /add
• Headers:
  • Authorization: Bearer YOUR_API_KEY_HERE
  • Content-Type: application/json

Body Schema:

type AddToDnc = {
  // The phone number to add to the dialer's DNC list
  phone: string;
};

Response:

type DncOperationResult = {
  success: boolean;
  message: string;
};

Check DNC

• Method: POST
• URL: /check
• Headers:
  • Authorization: Bearer YOUR_API_KEY_HERE
  • Content-Type: application/json

Body Schema:

type CheckDnc = {
  // The phone number to look up on the dialer's DNC list
  phone: string;
};

Response:

type DncCheckResult = {
  success: boolean;
  // true if the number is on the dialer's DNC list
  onDnc: boolean;
  message: string;
};

Remove from DNC

• Method: POST
• URL: /remove
• Headers:
  • Authorization: Bearer YOUR_API_KEY_HERE
  • Content-Type: application/json

Body Schema:

type RemoveFromDnc = {
  // The phone number to remove from the dialer's DNC list
  phone: string;
};

Response:

type DncOperationResult = {
  success: boolean;
  message: string;
};

Status Codes

Code	Meaning
200	Operation completed.
400	Invalid phone number, the dialer’s configuration is invalid, or the workspace’s dialer type does not support DNC operations.
401	Missing, invalid, or inactive API key.
403	API key is not a universal-typed key.
404	No dialer is configured for the workspace.
502	The dialer rejected the request or was unreachable. See message.