Key Takeaways
✅ The NON-AGENT API is used for lead, campaign, call, and system management
✅ API calls require authentication and must be made via HTTP GET requests
✅ The API provides real-time monitoring and automation of call center processes
✅ Errors are often permission-related and can be fixed in user settings
VICIdial is one of the most powerful open-source call center solutions available today, offering a wide range of features for inbound and outbound call management. One of its most valuable aspects is the API, which allows developers to automate tasks, integrate third-party applications, and enhance the efficiency of call center operations.
While the Agent API provides functionalities specific to logged-in agents, the NON-AGENT API extends control over call center management, lead handling, campaign configurations, user management, and real-time monitoring.
In this guide, we’ll cover:
✅ What the Vicidial NON-AGENT API is
✅ The difference between the Agent API and NON-AGENT API
✅ How to set up API access in VICIdial
✅ How to construct API requests
✅ Common API functions and their use cases
✅ Error handling and troubleshooting
What is the Vicidial NON-AGENT API?
The Vicidial NON-AGENT API is a REST-based API that allows external applications to manage leads, users, campaigns, and call data without needing an active agent session.
It enables developers to:
✔ Add, update, and retrieve leads in the system
✔ Manage call recordings and monitoring sessions
✔ Extract campaign and agent statistics
✔ Control inbound DID (Direct Inward Dialing) settings
✔ Automate campaign and phone system configurations
This API is particularly useful for administrators, CRM integrations, and reporting tools.
Agent API vs. NON-AGENT API: What’s the Difference?
| Feature | Agent API | NON-AGENT API |
|---|---|---|
| Requires an agent to be logged in | ✅ Yes | ❌ No |
| Controls agent actions (pause, resume, transfer, etc.) | ✅ Yes | ❌ No |
| Lead management (add, update, search leads) | ❌ No | ✅ Yes |
| Campaign and system management | ❌ No | ✅ Yes |
| Call monitoring and statistics | ❌ No | ✅ Yes |
In short, the Agent API is designed for real-time agent control, while the NON-AGENT API is built for administrative and backend functions.
Prerequisites for Using the Vicidial NON-AGENT API
Before using the API, ensure you have the following:
✅ VICIdial installed and configured on your server
✅ Admin credentials with API permissions enabled
✅ Server access to test API requests
✅ A tool for making API calls (Postman, cURL, browser)
How to Enable API Access in VICIdial
To use the NON-AGENT API, your VICIdial user must have API access enabled. Here’s how:
1️⃣ Login to VICIdial Admin Panel
2️⃣ Navigate to Admin > Users
3️⃣ Select the user account that will access the API
4️⃣ Enable the following settings:
- API Access:
1(Enabled) - User Level:
7or higher - Allowed Functions: Specify allowed API calls (
ALLfor full access)
5️⃣ Click Save Changes
Now, your user is ready to make API calls!
How to Construct an API Request
The VICIdial API follows a simple HTTP GET request format.
Base API URL
Replace your-vicidial-server with your actual VICIdial instance.
Required Parameters
Every API request must include:
| Parameter | Description |
|---|---|
function |
The API function you want to execute |
user |
VICIdial API username |
pass |
VICIdial API password |
source |
A string identifying the source of the API call |
Example API Call: Checking VICIdial API Version
To check the version of the NON-AGENT API, use:
Example Response
Most Common NON-AGENT API Functions & Their Use Cases
1️⃣ Lead Management APIs
These functions allow you to add, update, and search leads in VICIdial.
✅ Add a New Lead
✅ Update Lead Information
✅ Search Leads by Phone Number
2️⃣ Call & Recording APIs
These functions allow you to manage recordings, call monitoring, and call logs.
✅ Look Up Call Recordings
✅ Monitor a Live Call (Blind Monitor)
3️⃣ Campaign & List Management APIs
These APIs help administrators control campaigns and lead lists.
✅ Retrieve All Campaigns in VICIdial
✅ Add a New Lead List
Handling API Errors & Troubleshooting
If something goes wrong, VICIdial returns an error message.
Common Errors & Fixes
| Error | Cause | Solution |
|---|---|---|
ERROR: USER DOES NOT HAVE PERMISSION TO USE THIS FUNCTION |
Insufficient API permissions | Ensure user level is 7 or higher |
ERROR: INVALID USERNAME OR PASSWORD |
Wrong credentials | Double-check login details |
ERROR: NO FUNCTION SPECIFIED |
Missing function parameter | Ensure function= is included in the request |
Conclusion
The VICIdial NON-AGENT API is a powerful tool for automating call center management, integrating third-party tools, and improving operational efficiency.
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
