DNC Management API

The DNC Management API provides comprehensive Do Not Call list management, enabling organizations to maintain compliance with regulatory requirements and respect customer preferences for communication.

Get DNC Records

GET /Advanced Dialer/api/DNC/getdncrows

Retrieves all Do Not Call records from the system.

Example Request

curl --request GET \
     --url 'https://api.talkdeskapp.com/Advanced Dialer/api/DNC/getdncrows' \
     --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY'

Response Example

{
  "statusCode": 0,
  "message": null,
  "payload": [
    {
      "id": 1,
      "telephone": "+1-555-123-4567",
      "expires": "2025-12-31T23:59:59Z",
      "flags": "Customer Request",
      "scope": "Global",
      "scopeId": "ALL",
      "source": "Web Portal",
      "info": "Customer opted out via website"
    }
  ]
}

Add DNC Record

POST /Advanced Dialer/api/DNC/insertdncrow

Adds a new telephone number to the Do Not Call list.

Request Body

Field	Type	Description
`telephone`	string	The phone number to be blocked.
`expires`	string	Expiration timestamp for the DNC status.
`flags`	string	Description of the DNC category.
`scope`	string	Level of block (e.g., Global, Campaign).
`scopeId`	string	Identifier for the scope (e.g., Campaign ID).

Example Request

curl --request POST \
     --url 'https://api.talkdeskapp.com/Advanced Dialer/api/DNC/insertdncrow' \
     --header 'Content-Type: application/json' \
     --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY' \
     --data '{
  "telephone": "+1-555-333-7890",
  "expires": "2025-06-30T23:59:59Z",
  "flags": "Temporary Block",
  "scope": "Campaign",
  "scopeId": "SUMMER_2025",
  "source": "API",
  "info": "Customer requested 6-month pause"
}'

Search DNC Records

POST /Advanced Dialer/api/DNC/searchdncrows

Searches for DNC records using specific criteria.

Request Body

{
  "telephone": "+1-555-123-4567",
  "scope": "Global",
  "expiryCheck": 1
}

Response Example

{
  "statusCode": 0,
  "message": null,
  "payload": [
    {
      "id": 1,
      "telephone": "+1-555-123-4567",
      "expires": "2025-12-31T23:59:59Z",
      "flags": "Customer Request",
      "scope": "Global",
      "source": "Web Portal"
    }
  ]
}