VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node interacts with the VICIdial Non-Agent API to perform user agent management tasks. Specifically, the "Copy User" operation allows you to duplicate an existing user’s configuration under a new agent user ID. This is useful in call center environments where you want to quickly replicate user settings for new agents without manually re-entering all details.

Practical examples include:

  • Creating a new agent profile by copying an existing one to maintain consistent permissions and settings.
  • Automating onboarding of new call center agents by cloning user configurations.
  • Managing user accounts programmatically via API calls within n8n workflows.

Properties

Name Meaning
Function The API function to call; here it is fixed as "Copy User".
User The API username credential used for authentication.
Pass The API password credential used for authentication.
Source A description or identifier indicating what originated the API call (default: "n8n").
Agent User The new agent user ID to which the source user's settings will be copied.
Agent Pass Password for the new agent user.
Agent Full Name Full name of the new agent user.
Source User The existing user ID whose settings are being copied.

Output

The node outputs JSON data representing the response from the VICIdial API after attempting to copy the user. This typically includes success status, any error messages, and details about the newly created user if successful.

No binary data output is involved.

Dependencies

  • Requires access to the VICIdial Non-Agent API endpoint.
  • Needs credentials including API username and password.
  • The base URL for the API must be configured in the node credentials.
  • The node uses HTTP query parameters to send data to the API.

Troubleshooting

  • Authentication errors: Ensure that the provided API username and password are correct and have sufficient permissions.
  • Invalid user IDs: Verify that the source_user exists and that the agent_user does not conflict with existing users.
  • API connectivity issues: Confirm network access to the VICIdial API host and that the base URL is correctly set.
  • Missing required fields: All required properties such as agent_user, agent_pass, agent_full_name, and source_user must be provided; otherwise, the API call will fail.

Common error messages usually relate to authentication failure, invalid parameters, or user conflicts. Checking the API response message can help identify the exact issue.

Links and References

Discussion