Maintaining an accurate Do-Not-Call (DNC) list is critical for call center compliance, customer relationship management, and legal adherence to telemarketing laws. In certain cases, businesses may need to remove a phone number from the DNC list, such as when a customer requests to be contacted again or when a number was mistakenly added.
VICIdial, a leading open-source call center solution, offers the delete_dnc_phone API, which allows administrators to remove phone numbers from the system-wide DNC list dynamically. This ensures that agents can legally dial numbers that are no longer restricted, improving campaign efficiency and contact success rates.
Why Use the delete_dnc_phone API?
✅ Allows customers to rejoin call lists after opting back in
✅ Corrects mistakes when numbers are wrongly added to the DNC list
✅ Enables real-time updates for contact permissions
✅ Integrates with CRM systems for automated DNC management
✅ Improves call connection rates by ensuring valid contact numbers are dialable
In this tutorial, we will cover:
🔹 How the delete_dnc_phone API works
🔹 How to configure and authenticate API access
🔹 How to construct and send API requests
🔹 Examples using a browser, cURL, and Postman
🔹 How to interpret API responses and troubleshoot errors
🔹 Best practices for using the delete_dnc_phone API efficiently
Let’s get started! 🚀
Understanding the delete_dnc_phone API Function
The delete_dnc_phone API allows administrators to remove a phone number from VICIdial’s system-wide Do-Not-Call (DNC) list, making it available for dialing again.
What Information Does the delete_dnc_phone API Require?
✔ Phone Number – The number that needs to be removed from the DNC list
✔ Campaign ID – (Optional) If the DNC restriction applies to a specific campaign
✔ Source – A custom identifier for tracking API calls
Common Use Cases for delete_dnc_phone API
🔹 Customers requesting to be contacted again after opting out
🔹 Fixing errors when numbers are mistakenly added to the DNC list
🔹 Automating DNC list updates via CRM integrations
🔹 Re-engaging previously opted-out customers for special offers
🔹 Updating phone status for numbers cleared for marketing contact
Step 1: Prerequisites for Using the API
Before using the delete_dnc_phone API, ensure you have:
✅ VICIdial installed and configured
✅ An API-enabled user account with administrative permissions**
✅ A valid phone number to remove from the DNC list
✅ VICIdial server access credentials
How to Enable API Access in VICIdial
1️⃣ Log in to the VICIdial Admin Panel
2️⃣ Navigate to Admin > Users
3️⃣ Select the user who will access the API
4️⃣ Set API Access to 1 (Enabled)
5️⃣ Set User Level to 8 or higher** (Admin-level access) 6️⃣ Add delete_dnc_phoneto the **Allowed API Functions** (or set toALL`)
7️⃣ Click Save Changes
Now, your user is authorized to remove phone numbers from the DNC list dynamically using the API.
Step 2: Constructing the API Request
The VICIdial API uses HTTP GET requests, meaning you can access it via a browser, cURL, or API tools like Postman.
Base API URL
🔹 Replace your-vicidial-server with your actual VICIdial instance.
Required Parameters for delete_dnc_phone API
| Parameter | Description | Example |
|---|---|---|
function |
Specifies the API function (delete_dnc_phone) |
delete_dnc_phone |
user |
VICIdial API username | admin |
pass |
VICIdial API password | 1234 |
source |
Identifier for tracking API calls | DNCRemoval |
phone_number |
The phone number to remove from the DNC list | 18005551234 |
campaign_id |
(Optional) Campaign ID for campaign-specific DNC removal | SALES_CAMPAIGN |
Step 3: Sending the API Request
Method 1: Removing a Number from the DNC List via a Web Browser
Simply enter the following URL in your browser (replace credentials accordingly):
🔹 Press Enter, and the API should remove the phone number from the system-wide DNC list.
Method 2: Removing a Number from the DNC List via cURL (Command Line)
For developers, cURL is a convenient tool for making API requests. Use the following command:
🔹 This will return a confirmation message indicating the phone number has been removed from the DNC list.
Method 3: Removing a Number from the DNC List via Postman
1️⃣ Open Postman
2️⃣ Set the request type to GET
3️⃣ Enter the API URL
4️⃣ Click Send
5️⃣ The response should display the confirmation message for the DNC removal
Step 4: Understanding API Responses
If the request is successful, VICIdial returns a response confirming the phone number has been removed from the DNC list:
Breaking Down the Response
| Response Value | Meaning |
|---|---|
SUCCESS |
The request was processed successfully |
18005551234 |
The phone number removed from the DNC list |
Removed from DNC List |
Confirmation message |
Step 5: Handling Errors & Troubleshooting
| Error Message | Cause | Solution |
|---|---|---|
ERROR: USER DOES NOT HAVE PERMISSION TO USE THIS FUNCTION |
Insufficient API permissions | Ensure user level is 8+ and API Access is enabled |
ERROR: INVALID USERNAME OR PASSWORD |
Wrong credentials | Verify API username and password |
ERROR: PHONE NUMBER NOT FOUND |
The specified phone number is not on the DNC list | Ensure phone_number is correct |
ERROR: NO FUNCTION SPECIFIED |
Missing function parameter | Ensure function=delete_dnc_phone is included |
Step 6: Best Practices for Using the delete_dnc_phone API
✅ Ensure proper consent is obtained before removing a number from DNC
✅ Log all DNC removals for compliance tracking
✅ Restrict API access to authorized users to prevent misuse
✅ Verify customer intent before reactivating a number for calls
✅ Integrate the API with CRM systems for automated DNC list management
Conclusion
The delete_dnc_phone API function is an essential tool for removing phone numbers from the Do-Not-Call list dynamically in VICIdial. Whether you’re correcting errors, reactivating opted-in customers, or automating DNC list updates, this API provides a fast and efficient way to manage contact permissions.
Feel free to contact us or simply start a live chat to get connected to one of our team members. Here is our contact information.
Calling from US: +1 954-990-0053
Email: office@callix.ai
