Adding Contacts to the DNC List via API

Adding Contacts to the DNC List via API

Overview

Taalk provides API endpoints that allow you to add contacts to the Do Not Call (DNC) list, ensuring compliance with customer preferences and regulatory requirements. You can add contacts to the DNC list at two levels:

• Company-Level DNC List: Blocks outbound calls to the number across all campaigns within your organization.
• Campaign-Level DNC List: Blocks outbound calls to the number for a specific campaign only.

For background on Taalk’s automated DNC detection and manual DNC management, refer to the following Knowledge Base articles:

• Taalk Agent DNC Auto Detection
• Custom Campaign DNC

Adding a Phone Number to the Company-Level DNC List

Adding a contact to the Company-Level DNC list ensures that no outbound calls are made to this number from any of your Taalk campaigns. However, inbound calls from the number will still be answered by Taalk’s AI Agents.

API Request

curl --location --request PATCH 'https://lets.taalk.ai/api/dnc/local' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_api_token>' \
--data '{
  "7047058647": true
}'

Request Details

• Endpoint: PATCH https://lets.taalk.ai/api/dnc/local
• Headers:
  • Content-Type: application/json
  • Authorization: Bearer <your_api_token> (replace <your_api_token> with your actual API token)
• Request Body:

  {
    "7047058647": true
  }
  

  • Replace 7047058647 with the phone number you want to add to the DNC list.
  • Setting the value to true flags the number as DNC.

Response

A successful request will return a confirmation message indicating that the number has been added to the Company-Level DNC list.

Adding a Phone Number to the Campaign-Level DNC List

This option restricts outbound calls to a specific phone number within a particular campaign. The number will still be reachable through other campaigns unless explicitly added to their DNC lists.

API Request

curl --location --request PATCH \
'https://api.taalk.ai/api/campaign2s/6791043299aeedfec27f85d5/contacts/7047058647' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_api_token>' \
--data '{
  "dnc": true
}'

Request Details

• Endpoint: PATCH https://api.taalk.ai/api/campaign2s/{campaign_id}/contacts/{phone_number}
  • Replace {campaign_id} with your specific campaign ID (e.g., 6791043299aeedfec27f85d5).
  • Replace {phone_number} with the contact number you want to mark as DNC (e.g., 7047058647).
• Headers:
  • Content-Type: application/json
  • Authorization: Bearer <your_api_token>
• Request Body:

  {
    "dnc": true
  }
  

  • Setting "dnc": true flags the number as DNC for the specified campaign.

Response

A successful request will return a confirmation indicating that the number has been added to the Campaign-Level DNC list.

Important Notes

• Inbound Calls: DNC restrictions apply only to outbound calls. If a DNC-marked number calls back, Taalk Agents will still answer the call.
• Compliance: Regularly updating your DNC lists helps ensure compliance with customer preferences and legal regulations.
• API Authentication: Ensure that you use valid API tokens for authorization. Unauthorized requests will be rejected.

For more details on DNC management, refer to the Taalk Knowledge Base.