VICIdial is a leading open-source call center solution that provides robust tools for managing inbound, outbound, and blended call campaigns. One of its most valuable features is the ability to extract detailed call information for analysis, reporting, compliance, and troubleshooting.
The callid_info API in VICIdial allows users to retrieve call details using a unique call ID, making it easier to track conversations, verify interactions, and integrate call data with CRM or reporting systems.
Why Use the callid_info API?
✅ Retrieve complete call details in real-time
✅ Ensure compliance with industry regulations
✅ Verify customer interactions for dispute resolution
✅ Integrate call data with third-party analytics or CRM systems
✅ Monitor agent performance and call outcomes
In this tutorial, we’ll cover:
🔹 How the callid_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 callid_info API efficiently
Let’s get started! 🚀
Understanding the callid_info API Function
The callid_info API enables users to fetch detailed call data for a specific Call ID. This can include:
✔ Call Start and End Time
✔ Agent Handling the Call
✔ Caller’s Phone Number and Lead ID
✔ Call Direction (Inbound/Outbound)
✔ Call Status (Answered, Abandoned, etc.)
✔ Recording File Name (if applicable)
Common Use Cases for callid_info API
🔹 Supervisors retrieving call logs for analysis
🔹 CRM integrations that require real-time call tracking
🔹 Quality assurance teams verifying call outcomes
🔹 Compliance officers checking call records for audits
🔹 Technical teams troubleshooting call routing issues
Step 1: Prerequisites for Using the API
Before using the callid_info API, ensure you have:
✅ VICIdial installed and configured
✅ An API-enabled user account with administrative permissions**
✅ A valid Call ID to retrieve information
✅ 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 callid_infoto the **Allowed API Functions** (or set toALL`)
7️⃣ Click Save Changes
Now, your user is authorized to retrieve call details 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 callid_info API
| Parameter | Description | Example |
|---|---|---|
function |
Specifies the API function (callid_info) |
callid_info |
user |
VICIdial API username | admin |
pass |
VICIdial API password | 1234 |
source |
Identifier for tracking API calls | CallAudit |
call_id |
The unique Call ID to retrieve information | 1000012345 |
Step 3: Sending the API Request
Method 1: Fetching Call Details via a Web Browser
Simply enter the following URL in your browser (replace credentials accordingly):
🔹 Press Enter, and the API response should display detailed call information.
Method 2: Fetching Call Details via cURL (Command Line)
For developers, cURL is a convenient tool for making API requests. Use the following command:
🔹 This will return the detailed call information directly in the terminal.
Method 3: Fetching Call Details via Postman
1️⃣ Open Postman
2️⃣ Set the request type to GET
3️⃣ Enter the API URL
4️⃣ Click Send
5️⃣ View the API response in the output panel
Step 4: Understanding API Responses
If the request is successful, VICIdial returns a response listing detailed call information:
Breaking Down the Response
| Value | Meaning |
|---|---|
1000012345 |
Call ID |
2024-02-15 10:15:00 |
Call Start Time |
2024-02-15 10:18:30 |
Call End Time |
Outbound |
Call Type (Inbound/Outbound) |
agent001 |
Agent Handling the Call |
9876543210 |
Caller’s Phone Number |
Answered |
Call Status (Answered, Abandoned, Busy, etc.) |
rec_1000012345.wav |
Recording File Name (if available) |
Step 5: Handling Errors & Troubleshooting
If something goes wrong, VICIdial will return an error message instead of call details.
Common Errors & Fixes
| 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=callid_info is included |
ERROR: CALL ID NOT FOUND |
Call ID does not exist | Ensure the call_id is correct and exists in VICIdial |
Step 6: Best Practices for Using the callid_info API
✅ Use this API for compliance and dispute resolution
✅ Ensure API users have proper permissions to prevent unauthorized access
✅ Integrate call information with CRM systems for better customer management
✅ Log API calls to track usage and prevent misuse
✅ Regularly archive call data to optimize database performance
Conclusion
The callid_info API function is an essential tool for tracking call details in VICIdial. Whether you’re retrieving call logs for analysis, ensuring compliance, or integrating call data with CRM systems, this API provides quick and accurate access to historical call information.
📌 Key Takeaways
✅ The callid_info API retrieves detailed VICIdial call information
✅ Requires an API-enabled user with appropriate permissions
✅ API requests can be made via browser, cURL, or Postman
✅ Common errors are permission and input-related and can be fixed in Admin settings
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
