VICIdial is a powerful open-source call center solution that allows administrators to manage agents, supervisors, and system users efficiently. Keeping track of user details, roles, permissions, login credentials, and assigned campaigns is essential for workforce management, access control, and auditing.
The user_details API in VICIdial allows administrators to fetch complete information about a specific user, including login credentials, user level, assigned user groups, phone login, and more. This API is particularly useful for user management, CRM integrations, security auditing, and troubleshooting user issues.
Why Use the user_details API?
✅ Retrieve full user details for administrative and security purposes
✅ Ensure correct user permissions and access levels
✅ Integrate VICIdial user data with external HR or CRM systems
✅ Automate user verification and management processes
✅ Troubleshoot login issues and incorrect user settings
In this tutorial, we will cover:
🔹 How the user_details 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 user_details API efficiently
Let’s get started! 🚀
Understanding the user_details API Function
The user_details API allows administrators to retrieve comprehensive details of a VICIdial user, including:
✔ User ID and Full Name
✔ User Level and Access Permissions
✔ Assigned User Group and Campaigns
✔ Phone Login Credentials
✔ User Status (Active/Inactive)
✔ API Access Information
Common Use Cases for user_details API
🔹 HR teams verifying agent login credentials and user groups
🔹 Call center administrators troubleshooting user issues
🔹 CRM integrations needing VICIdial user details for automation
🔹 Security teams checking access levels and permissions
Step 1: Prerequisites for Using the API
Before using the user_details API, ensure you have:
✅ VICIdial installed and configured
✅ An API-enabled user account with administrative permissions
✅ A valid user ID to retrieve details
✅ 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 user_detailsto the **Allowed API Functions** (or set toALL`)
7️⃣ Click Save Changes
Now, your user is authorized to retrieve detailed user information 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 user_details API
| Parameter | Description | Example |
|---|---|---|
function |
Specifies the API function (user_details) |
user_details |
user |
VICIdial API username | admin |
pass |
VICIdial API password | 1234 |
source |
Identifier for tracking API calls | CRM_UserInfo |
user_id |
The user ID of the account to retrieve | agent001 |
Step 3: Sending the API Request
Method 1: Fetching User Details via a Web Browser
Simply enter the following URL in your browser (replace credentials accordingly):
🔹 Press Enter, and the API response should display the detailed user information.
Method 2: Fetching User 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 user information directly in the terminal.
Method 3: Fetching User 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 user information:
Breaking Down the Response
| Value | Meaning |
|---|---|
agent001 |
User ID |
John Doe |
Full Name |
7 |
User Level (Agent: 1-6, Manager: 7, Admin: 9) |
MANAGERS |
Assigned User Group |
Y |
Active Status (Y = Active, N = Inactive) |
8001 |
Phone Login Extension |
abc123 |
Phone Login Password |
2024-02-15 10:30:00 |
Last Login Timestamp |
Step 5: Handling Errors & Troubleshooting
If something goes wrong, VICIdial will return an error message instead of user 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=user_details is included |
ERROR: USER NOT FOUND |
The user ID does not exist | Verify that the user_id exists in VICIdial |
Step 6: Best Practices for Using the user_details API
✅ Use this API for automated user audits and verification
✅ Limit API access to prevent unauthorized data retrieval
✅ Ensure API logs track usage for security audits
✅ Regularly update user permissions to maintain security
✅ Integrate API responses with HR and CRM systems
Conclusion
The user_details API function is an essential tool for tracking detailed user information in VICIdial. Whether you’re managing agent accounts, troubleshooting login issues, or integrating user details with external systems, this API provides quick and reliable access to critical user data.
📌 Key Takeaways
✅ The user_details API retrieves detailed VICIdial user 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
