VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Overview

This node interacts with the VICIdial Non-Agent API to update an existing list in the List Management resource. It allows users to modify various attributes of a list such as its name, associated campaign, active status, and custom fields. This is useful in scenarios where contact lists need to be maintained dynamically, for example, updating marketing campaign lists or managing call center lead lists.

Practical examples include:

  • Changing the name of a contact list to reflect a new campaign.
  • Activating or deactivating a list based on current marketing needs.
  • Resetting or deleting a list and its leads when starting fresh campaigns.
  • Adding custom fields to a list to capture additional data points.

Properties

Name Meaning
Function API function to call; fixed to "Update List"
User API user credential (username)
Pass API password credential
Source Description of what originated the API call; default is "n8n"
List Id Identifier of the list to update (required)
List Name New name for the list
Campaign Id ID of the campaign associated with the list
Active Whether the list is active; options: "Y" (yes), "N" (no)
Reset List Whether to reset the list; options: "Y", "N"
Delete List Whether to delete the list; options: "Y", "N"
Delete Leads Whether to delete leads in the list; options: "Y", "N"
Custom Fields Add Whether to add custom fields; options: "Y", "N"
Field Label Label for a custom field
Field Name Name/key for a custom field

Output

The node outputs the response from the VICIdial API as JSON. This typically includes confirmation of the update operation and any relevant metadata returned by the API. The output does not handle binary data.

Dependencies

  • Requires an API key credential with username and password for authenticating with the VICIdial Non-Agent API.
  • The base URL for the API is configured via credentials.
  • The node uses query parameters to send all input properties to the API endpoint.

Troubleshooting

  • Authentication errors: Ensure that the API user and password credentials are correct and have sufficient permissions.
  • Invalid List Id: If the specified list ID does not exist, the API will likely return an error. Verify the list ID before updating.
  • Conflicting flags: Setting both "Delete List" and "Reset List" to "Y" might cause unexpected behavior; use these options carefully.
  • Missing required fields: The "List Id" property is mandatory; omitting it will cause the request to fail.
  • API connectivity issues: Check network access and that the base URL in credentials is correct.

Links and References

Discussion