VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node integrates with the VICIdial Non-Agent API to manage user agents within a VICIdial system. Specifically, the "Add User" operation allows you to add a new agent user to the system by providing detailed user credentials and settings.

Common scenarios for this node include automating the onboarding of call center agents, synchronizing user data from external HR or CRM systems into VICIdial, or programmatically managing agent accounts without manual intervention.

For example, when a new agent is hired, an automation workflow can trigger this node to create their VICIdial user account with appropriate permissions, login credentials, and group assignments.

Properties

Name Meaning
Function API function name; fixed to "Add User" for this operation
User API username credential used for authentication
Pass API password credential used for authentication
Source Description of what originated the API call (default: "n8n")
Agent User The unique ID for the agent user being added
Agent Pass Password for the agent user
Agent User Level Numeric level indicating the agent's permission or role
Agent Full Name Full name of the agent
Agent User Group Group to which the agent belongs
Phone Login Optional phone login identifier
Phone Pass Optional phone password
Hotkeys Active Flag (0 or 1) indicating if hotkeys are active for the agent
Voicemail Id Identifier for the agent's voicemail
Email Email address of the agent
Wrapup Seconds Override Number of seconds to override default wrap-up time after calls
Agent Choose Ingroups Flag (0 or 1) indicating if the agent can choose in-groups
In Groups Pipe-delimited string listing in-groups the agent belongs to

Output

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

No binary data output is involved in this operation.

Dependencies

  • Requires access to a VICIdial instance with its Non-Agent API enabled.
  • Needs an API key credential (username and password) with sufficient permissions to add users.
  • The node configuration must include the base URL of the VICIdial server.
  • The node uses HTTP query parameters to send data to the API endpoint.

Troubleshooting

  • Authentication errors: Ensure that the provided API username and password are correct and have permissions to add users.
  • Missing required fields: All required properties such as agent_user, agent_pass, agent_user_level, etc., must be provided; otherwise, the API will reject the request.
  • Invalid user level or group: Verify that the agent_user_level and agent_user_group values correspond to valid entries in your VICIdial system.
  • Network issues: Confirm that the VICIdial server URL is reachable from the n8n environment.
  • API errors: Check the API response message for specific error codes or messages returned by VICIdial to diagnose issues.

Links and References

Discussion