Actions58
- Lead Management Actions
- User Agent Management Actions
- Campaign Management Actions
- Phone DID Management Actions
- List Management Actions
- Reporting Monitoring Actions
- System Info Actions
- Other Operations Actions
Overview
This node interacts with the VICIdial Non-Agent API, specifically providing functionality to check the status of user groups within the "User Agent Management" resource. The "User Group Status" operation queries the API to retrieve information about specified user groups, returning their current status in a selectable output format.
Common scenarios for this node include:
- Monitoring the status of call center user groups to manage workload distribution.
- Integrating user group status checks into automated workflows for real-time reporting or alerting.
- Extracting user group data for analytics or dashboard visualization.
For example, a workflow could use this node to periodically check if certain user groups are active or idle and trigger notifications if any group is down.
Properties
| Name | Meaning |
|---|---|
| Function | API function name; fixed to "User Group Status" for this operation. |
| User | API username credential used for authentication. |
| Pass | API password credential used for authentication. |
| Source | Description of what originated the API call; default is "n8n". |
| User Groups | Pipe-delimited list of user groups to query (e.g., "group1 |
| Stage | Output format of the response; options: Csv, Tab, Pipe, Json. |
| Header | Whether to include a header row in the output; options: YES or NO. |
Output
The node outputs the API response in the json field of the item. The structure depends on the selected output format (stage property):
- Csv: Comma-separated values string representing user group statuses.
- Tab: Tab-separated values string.
- Pipe: Pipe (
|) separated values string (default). - Json: JSON formatted string representing the user group status data.
If the header option is set to "YES", the output includes a header row describing each column.
No binary data output is indicated by the source code.
Dependencies
- Requires an API key credential consisting of a username and password for authenticating with the VICIdial Non-Agent API.
- Needs the base URL of the VICIdial server configured in credentials.
- The node uses HTTP requests to communicate with the API endpoint
/vicidial.
Troubleshooting
- Authentication errors: If the API user or password is incorrect or missing, the node will fail to authenticate. Verify credentials are correctly set.
- Invalid user groups: Providing non-existent or incorrectly formatted user group names may result in empty or error responses.
- Output format issues: Selecting an unsupported output format or misconfiguring the header option might cause parsing problems downstream.
- Network connectivity: Ensure the n8n instance can reach the VICIdial server URL.
Common error messages likely relate to HTTP 401 Unauthorized (bad credentials), 404 Not Found (wrong endpoint or resource), or malformed query parameters.
Links and References
- VICIdial Official Documentation (for API details)
- n8n Documentation (for general node usage and credential setup)