As call centers scale and expand across multiple locations, managing data across multiple VICIdial clusters becomes crucial. Many organizations operate distributed VICIdial servers, often in different regions, to handle high call volumes efficiently. However, tracking call data across multiple VICIdial clusters can be challenging when using separate databases.
The ccc_lead_info API in VICIdial (Cross-Cluster Call Lead Information API) allows administrators to retrieve lead and call details across different VICIdial clusters, making it a powerful tool for managing distributed call center operations.
Instead of manually searching across separate VICIdial servers, this API enables real-time retrieval of lead data from interconnected systems, streamlining call tracking, customer interactions, and reporting.
Why Use the ccc_lead_info API?
✅ Retrieve call and lead details from multiple VICIdial clusters
✅ Improve customer experience by accessing cross-cluster call history
✅ Reduce delays in fetching call data across distributed locations
✅ Enhance reporting and analytics with centralized data access
✅ Integrate with CRMs, reporting tools, and third-party platforms
In this tutorial, we will cover:
🔹 How the ccc_lead_info 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 ccc_lead_info API efficiently
Let’s get started! 🚀
Understanding the ccc_lead_info API Function
The ccc_lead_info API allows administrators to retrieve detailed lead information across multiple VICIdial clusters. It provides call history, customer details, and campaign-related data, centralizing lead information in multi-server environments.
What Information Does the ccc_lead_info API Provide?
✔ Lead ID – The unique identifier assigned to a lead
✔ Phone Number – The phone number associated with the lead
✔ Campaign ID – The campaign in which the lead was processed
✔ Call Status – The disposition/status of the last call
✔ Call Date & Time – The timestamp of the last call attempt
✔ Cluster Source – The VICIdial cluster/server where the call occurred
Common Use Cases for ccc_lead_info API
🔹 Tracking customer interactions across multiple VICIdial clusters
🔹 Retrieving lead details in real-time without searching manually
🔹 Integrating call data into CRM, analytics, or workforce management tools
🔹 Ensuring call agents have full call history regardless of cluster location
🔹 Simplifying reporting and cross-cluster data synchronization
Step 1: Prerequisites for Using the API
Before using the ccc_lead_info API, ensure you have:
✅ VICIdial installed and configured across multiple clusters
✅ An API-enabled user account with administrative permissions**
✅ A valid lead ID or phone number to retrieve data
✅ 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 ccc_lead_infoto the **Allowed API Functions** (or set toALL`)
7️⃣ Click Save Changes
Now, your user is authorized to retrieve cross-cluster lead information 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 ccc_lead_info API
| Parameter | Description | Example |
|---|---|---|
function |
Specifies the API function (ccc_lead_info) |
ccc_lead_info |
user |
VICIdial API username | admin |
pass |
VICIdial API password | 1234 |
source |
Identifier for tracking API calls | LeadLookup |
lead_id |
(Optional) The unique lead ID to fetch details | 123456 |
phone_number |
(Optional) Retrieve data using a phone number | 18005551234 |
Step 3: Sending the API Request
Method 1: Retrieving Cross-Cluster Lead Info via a Web Browser
Simply enter the following URL in your browser (replace credentials accordingly):
🔹 Press Enter, and the API should return lead and call details from all connected VICIdial clusters.
Method 2: Retrieving Lead Info via cURL (Command Line)
For developers, cURL is a convenient tool for making API requests. Use the following command:
🔹 This will return detailed lead and call history information for the specified phone number across clusters.
Method 3: Retrieving Lead Info 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 lead’s cross-cluster call details
Step 4: Understanding API Responses
If the request is successful, VICIdial returns a response listing lead and call details from all connected clusters:
Breaking Down the Response
| Response Value | Meaning |
|---|---|
123456 |
Lead ID |
18005551234 |
Phone number associated with the lead |
SALES_CAMPAIGN |
The campaign this lead belongs to |
ANSWERED |
The last call status (disposition) |
2024-02-15 14:30:00 |
The timestamp of the last call attempt |
ClusterA |
The VICIdial cluster where the call occurred |
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: LEAD ID OR PHONE NUMBER NOT FOUND |
No matching data in clusters | Ensure lead_id or phone_number exists |
ERROR: NO FUNCTION SPECIFIED |
Missing function parameter | Ensure function=ccc_lead_info is included |
Step 6: Best Practices for Using the ccc_lead_info API
✅ Use this API to unify cross-cluster call tracking
✅ Ensure all VICIdial clusters are correctly linked for data retrieval
✅ Restrict API access to authorized users for security
✅ Integrate with CRM systems for a seamless agent experience
✅ Monitor API logs to detect performance or permission issues
Conclusion
The ccc_lead_info API function is a powerful tool for retrieving call and lead information across multiple VICIdial clusters dynamically. It enables real-time call tracking, centralized reporting, and enhanced agent performance in distributed call center environments.
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
