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 to retrieve detailed information about a specific list within the List Management resource. The "List Info" operation fetches metadata and statistics related to a given list, such as counts of leads and dialable entries, formatted in various output styles.
Typical use cases include:
- Monitoring campaign lists by retrieving up-to-date list details.
- Integrating VICIdial list data into workflows for reporting or decision-making.
- Automating checks on list statuses before launching dialing campaigns.
For example, a user might configure this node to get the current lead counts and dialable counts of a list identified by its List ID, then use that data downstream to adjust campaign parameters dynamically.
Properties
| Name | Meaning |
|---|---|
| Function | API function name; fixed to "List Info" 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". |
| List Id | Identifier of the list to retrieve information about. |
| Leads Counts | Whether to include counts of leads in the response; options: "Y" (yes), "N" (no). |
| Dialable Count | Whether to include count of dialable leads; options: "Y" (yes), "N" (no). |
| Stage | Output format of the response; options: "csv", "tab", "pipe", "json". |
| Header | Whether to include a header row in the output; options: "YES", "NO". |
Output
The node outputs JSON data representing the list information retrieved from the VICIdial API. The structure depends on the selected output format (stage property) but is parsed and returned as JSON objects within the node's output.
If the output format is set to JSON, the data will be structured as JSON objects directly reflecting the list info fields. For other formats like CSV, tab-delimited, or pipe-delimited, the raw string data is returned, optionally including headers based on the header property.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential consisting of a username and password for authenticating with the VICIdial Non-Agent API.
- The node expects the base URL of the VICIdial API to be configured in the credentials.
- No additional external dependencies are required beyond the VICIdial API access.
Troubleshooting
- Authentication errors: Ensure the provided API username and password are correct and have sufficient permissions.
- Invalid List ID: Verify that the List ID exists and is accessible by the authenticated user.
- Incorrect output format: If parsing issues occur, check the
stageandheaderproperties to ensure the output format matches expected downstream processing. - Network issues: Confirm connectivity to the VICIdial API endpoint and that the base URL is correctly configured in credentials.
Common error messages may relate to authentication failure, missing required parameters (like List ID), or invalid API responses. Resolving these typically involves verifying credentials, input parameters, and network connectivity.
Links and References
- VICIdial Official Documentation (for API details)
- n8n Documentation on Creating Custom Nodes
- General API Authentication Best Practices