VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node interacts with the VICIdial Non-Agent API to update alternative URLs associated with campaigns. It is useful in scenarios where you need to programmatically modify URL configurations for different campaign entry points, such as disposition pages or start pages, without manually accessing the VICIdial interface. For example, you might use this node to update tracking URLs or redirect addresses dynamically based on campaign changes or marketing strategies.

Properties

Name Meaning
Function The API function to call; here it is fixed to "Update Alt Url".
User API user credential for authentication.
Pass API password credential for authentication.
Source Description of what originated the API call (default: "n8n").
Campaign Id Identifier of the campaign to which the alt URL belongs.
Entry Type Type of entry point; currently only "Campaign" is supported.
Url Type Type of URL being updated; options include "Dispo", "Start", "Addlead", and "Noagent".
Alt Url Id Identifier of the alternative URL to update.
Active Whether the URL is active ("Y") or not ("N").
Url Rank Ranking or priority of the URL (string).
Url Statuses Statuses associated with the URL (string).
Url Description Description or notes about the URL (string).
Url Address The actual URL address to be set or updated.

Output

The node outputs the response from the VICIdial API call in the json field of the output data. This typically contains confirmation or details about the updated alternative URL. There is no indication that binary data is returned by 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 defaults to the /vicidial path on the host.
  • The node uses HTTP query parameters to send data to the API endpoint.

Troubleshooting

  • Authentication errors: Ensure that the provided API user and password are correct and have sufficient permissions.
  • Invalid campaign or alt URL IDs: Verify that the campaign ID and alt URL ID exist and are correctly specified.
  • Incorrect URL types or statuses: Use only the allowed options for URL type and active status to avoid API rejections.
  • Empty required fields: Required properties like Campaign Id, Alt Url Id, User, and Pass must be provided; missing these will cause errors.
  • API connectivity issues: Confirm that the base URL and network access to the VICIdial API server are properly configured.

Links and References

Discussion