VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Overview

This node allows updating user information within a User Agent Management system via an API. It is designed to modify various attributes of an agent user, such as credentials, user level, group memberships, and status flags. This node is useful in scenarios where automated workflows need to maintain or synchronize user data in a call center or agent management platform.

Practical examples include:

  • Automatically updating agent user details when onboarding new employees.
  • Changing user access levels or groups based on role changes.
  • Resetting passwords or activating/deactivating users programmatically.

Properties

Name Meaning
Function API function name; fixed to "Update User" for this operation.
User API user credential identifier (from credentials).
Pass API password credential (from credentials).
Source Description of what originated the API call; default is "n8n".
Agent User The unique ID of the agent user to update.
Agent Pass Password for the agent user.
Agent User Level Numeric level indicating the user's permission or role level.
Agent Full Name Full name of the agent user.
Agent User Group Group to which the agent user belongs.
Phone Login Phone login identifier for the agent user.
Phone Pass Phone password for the agent user.
Active Whether the user is active ("Y") or inactive ("N").
Campaign Rank Numeric rank within campaigns.
Campaign Grade Numeric grade within campaigns.
Ingroup Rank Numeric rank within ingroups.
Ingroup Grade Numeric grade within ingroups.
Reset Password Numeric flag to reset the password (typically 0 or 1).
In Groups Pipe-delimited string listing the ingroups the user belongs to.

Output

The node outputs JSON data representing the response from the API after attempting to update the user. This typically includes confirmation of success or failure and any relevant messages or updated user data returned by the API.

There is no indication that the node outputs binary data.

Dependencies

  • Requires an API key credential with username and password for authentication.
  • Needs connection details such as the host URL configured in the node credentials.
  • Depends on the external User Agent Management API endpoint to perform updates.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing invalid or incomplete user IDs or parameters may result in errors from the API.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • Authentication errors usually indicate invalid user/pass credentials.
    • Validation errors from the API may specify which fields are incorrect or missing.
    • Timeout or connection errors suggest network or endpoint availability issues.
  • Resolutions:

    • Verify API credentials and permissions.
    • Double-check all required input properties are correctly set.
    • Ensure the API endpoint is reachable and operational.

Links and References

  • Refer to the official User Agent Management API documentation for detailed parameter descriptions and expected responses.
  • Consult n8n documentation on how to configure API credentials and use HTTP request nodes if needed.

Discussion