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 retrieve a list of virtual machines (VMs) managed by the system. The "Vm List" operation under the "List Management" resource allows users to query and obtain VM information in various output formats.
Typical use cases include:
- Fetching an updated list of VMs for monitoring or reporting purposes.
- Integrating VM data into workflows that require dynamic VM selection or processing.
- Automating VM inventory management within contact center environments using VICIdial.
For example, a user might configure this node to pull the current VM list in text format and then parse it downstream to trigger alerts if certain VMs are offline.
Properties
| Name | Meaning |
|---|---|
| Function | API function name; fixed to "vm_list" 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; defaults to "n8n". |
| Format | Output format of the VM list; options are: "Text", "Link", or "Selectframe". |
| Comments | Optional comments or notes sent along with the API request. |
Output
The node outputs JSON data representing the response from the VICIdial API's VM list endpoint. The exact structure depends on the selected output format but generally includes details about each VM such as identifiers, status, and possibly URLs or frames if "link" or "selectframe" formats are chosen.
If binary data were involved, it would typically represent downloadable content or media related to the VM list, but this node focuses on textual or link-based output.
Dependencies
- Requires an API key credential (username and password) for authenticating with the VICIdial Non-Agent API.
- Needs the base URL of the VICIdial server configured in credentials.
- Depends on the
@devlikeapro/n8n-openapi-nodepackage for building properties and handling OpenAPI specifications.
Troubleshooting
- Authentication errors: Ensure the provided API username and password are correct and have sufficient permissions.
- Connection issues: Verify the base URL is reachable and the VICIdial server is operational.
- Invalid output format: Confirm the "Format" property is set to one of the supported options ("text", "link", "selectframe").
- Empty or malformed responses: Check if the API user has access to VM data and that the VICIdial API is returning valid data.