For call center administrators and managers, monitoring available campaigns in VICIdial is essential for tracking outbound and inbound operations, managing agent assignments, and optimizing dialing strategies. VICIdial provides a powerful API function called campaigns_list API, which allows administrators to retrieve a list of active, paused, and inactive campaigns dynamically.
Instead of manually checking the VICIdial admin panel, this API enables real-time campaign monitoring, external reporting integration, and automation of campaign management tasks.
Why Use the campaigns_list API?
✅ Retrieve a list of available campaigns dynamically
✅ Monitor active, paused, and inactive campaigns in real time
✅ Integrate campaign data with external CRMs and reporting tools
✅ Automate campaign tracking without accessing the VICIdial UI
✅ Optimize call center operations by analyzing campaign availability
In this tutorial, we will cover:
🔹 How the campaigns_list 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 campaigns_list API efficiently
Let’s get started! 🚀
Understanding the campaigns_list API Function
The campaigns_list API allows administrators to retrieve a list of all campaigns configured in VICIdial along with their current status. This helps supervisors, managers, and developers track campaign availability in real time.
What Information Does the campaigns_list API Provide?
✔ Campaign ID – Unique identifier for the campaign
✔ Campaign Name – The name assigned to the campaign
✔ Active Status – Whether the campaign is active (Y), inactive (N), or paused (P)
✔ Dial Method – Dialing strategy used (MANUAL, PREDICTIVE, AUTO, etc.)
✔ Auto Dial Level – The dialing ratio used for predictive campaigns
✔ Drop Percentage Limit – The maximum allowable call drop percentage
✔ Call Routing Details – Determines how calls are managed within the campaign
Common Use Cases for campaigns_list API
🔹 Supervisors tracking real-time campaign availability
🔹 Automating reporting of active and inactive campaigns
🔹 Call center managers monitoring dialing strategies
🔹 Integrating VICIdial campaigns with external CRM dashboards
🔹 Developers retrieving campaign data for analytics and automation
Step 1: Prerequisites for Using the API
Before using the campaigns_list API, ensure you have:
✅ VICIdial installed and configured
✅ An API-enabled user account with administrative permissions**
✅ 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 campaigns_listto the **Allowed API Functions** (or set toALL`)
7️⃣ Click Save Changes
Now, your user is authorized to retrieve a list of available campaigns 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 campaigns_list API
| Parameter | Description | Example |
|---|---|---|
function |
Specifies the API function (campaigns_list) |
campaigns_list |
user |
VICIdial API username | admin |
pass |
VICIdial API password | 1234 |
source |
Identifier for tracking API calls | CampaignListRequest |
Step 3: Sending the API Request
Method 1: Viewing Campaigns via a Web Browser
Simply enter the following URL in your browser (replace credentials accordingly):
🔹 Press Enter, and the API should return a list of available campaigns.
Method 2: Viewing Campaigns via cURL (Command Line)
For developers, cURL is a convenient tool for making API requests. Use the following command:
🔹 This will return a list of campaigns along with their status and details.
Method 3: Viewing Campaigns 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 a list of available campaigns
Step 4: Understanding API Responses
If the request is successful, VICIdial returns a response listing all available campaigns:
Breaking Down the Response
| Response Value | Meaning |
|---|---|
CAMP001 |
Campaign ID |
Outbound Sales |
Campaign Name |
Y |
Active status (Y = Active, N = Inactive, P = Paused) |
PREDICTIVE |
Dialing strategy |
3.0 |
Auto-dial level |
3.0 |
Drop percentage limit |
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: NO FUNCTION SPECIFIED |
Missing function parameter | Ensure function=campaigns_list is included |
Step 6: Best Practices for Using the campaigns_list API
✅ Use this API to monitor campaign status in real-time
✅ Integrate campaign data into CRM dashboards for tracking
✅ Ensure API access is restricted to authorized users
✅ Automate reporting to track campaign performance
✅ Regularly review campaign activity for optimization
Conclusion
The campaigns_list API function is an essential tool for retrieving real-time campaign data in VICIdial. Whether you’re monitoring active campaigns, integrating campaign details with external systems, or optimizing call center operations, this API provides quick and accurate insights into campaign availability.
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
