VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node integrates with the VICIdial Non-Agent API to manage call lists within a VICIdial system. Specifically, the "Add List" operation under the "List Management" resource allows users to create new call lists by specifying various parameters such as list name, campaign association, and other configuration details.

Common scenarios for this node include:

  • Automating the creation of call lists for outbound campaigns.
  • Dynamically managing call lists based on external triggers or workflows.
  • Integrating VICIdial list management into broader marketing or customer engagement automation.

For example, a user might use this node to add a new list named "Spring Campaign Leads" linked to a specific campaign ID, setting it active and defining custom fields or scripts associated with that list.

Properties

Name Meaning
Function API function name; fixed to "Add List" for this operation.
User API user credential (username) used for authentication.
Pass API password credential used for authentication.
Source Description of what originated the API call; default is "n8n".
List Id Unique identifier for the list being created.
List Name Name of the list to be added.
Campaign Id Identifier of the campaign to which the list belongs.
Active Whether the list is active ("Y") or not ("N").
List Description Optional description of the list.
Outbound Cid Outbound caller ID associated with the list.
Script Script associated with the list, possibly for agent guidance or call flow.
Reset Time Time when the list resets (format depends on API expectations).
Xferconf One First transfer conference configuration parameter.
Xferconf Two Second transfer conference configuration parameter.
Custom Fields Copy Custom fields to copy into the list, allowing additional metadata or attributes.

Output

The node outputs JSON data representing the response from the VICIdial API after attempting to add the list. This typically includes confirmation of success or failure, any error messages, and details about the newly created list if successful.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential (user and password) for authenticating with the VICIdial Non-Agent API.
  • The base URL for the API is configured via credentials and must point to the correct VICIdial server endpoint.
  • The node uses HTTP query parameters to send data to the API.

Troubleshooting

  • Authentication errors: If the API user or password is incorrect, the node will fail to authenticate. Verify credentials are correct and have sufficient permissions.
  • Missing required fields: The API requires certain fields like list_id, list_name, and campaign_id. Omitting these will cause errors.
  • Invalid field values: Fields like active only accept "Y" or "N". Providing invalid options may result in API rejection.
  • API connectivity issues: Ensure the base URL is reachable and the VICIdial server is operational.
  • Unexpected API responses: Check the raw response for error messages returned by the API to diagnose issues.

Links and References

Discussion