VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Overview

This node allows users to update an existing campaign in a VICIdial system via its Non-Agent API. It is useful for managing call campaigns dynamically, such as changing campaign settings without manual intervention in the VICIdial admin interface. Practical examples include enabling or disabling a campaign, adjusting dialing methods, updating campaign names, or modifying dial timeouts programmatically within an automation workflow.

Properties

Name Meaning
Function The API function to call; fixed to "Update Campaign" for this operation.
User The API user credential used for authentication.
Pass The API password credential used for authentication.
Source Description of what originated the API call; default is "n8n".
Campaign Id The unique identifier of the campaign to update (required).
Campaign Name New name for the campaign (optional).
Active Whether the campaign is active ("Y") or inactive ("N").
Auto Dial Level Numeric value representing the auto dial level setting.
Dial Method Dialing method to use; options: MANUAL, RATIO, INBOUND MAN, ADAPT AVERAGE.
Dial Timeout Number of seconds before a dial attempt times out.
Hopper Level Numeric value controlling hopper level (call queue size).
Reset Hopper Whether to reset the hopper ("Y") or not ("N").
List Order String defining the order of lists to dial from.
Outbound Cid Outbound caller ID to use for calls.
Dial Status Add Additional dial statuses to add.
Dial Status Remove Dial statuses to remove.
Dispo Call Url URL to be called on call disposition events.

Output

The node outputs JSON data reflecting the response from the VICIdial API after attempting to update the campaign. This typically includes success or error messages and any updated campaign details returned by the API. There is no binary output.

Dependencies

  • Requires access to a VICIdial server with the Non-Agent API enabled.
  • Requires credentials with API user and password for authentication.
  • The node uses HTTP requests to communicate with the VICIdial API endpoint configured via credentials (host URL).
  • No additional external libraries beyond those bundled with n8n are required.

Troubleshooting

  • Authentication errors: Ensure that the API user and password credentials are correct and have sufficient permissions.
  • Invalid Campaign ID: Verify that the campaign ID exists in the VICIdial system.
  • Network issues: Confirm that the VICIdial server is reachable from the n8n instance.
  • API errors: Check the API response message for specific error codes or messages indicating invalid parameters or server-side issues.
  • Missing required fields: The campaign ID, user, and pass fields are mandatory; missing these will cause errors.

Links and References

Discussion