VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Overview

This node allows updating a remote user agent in a VICIdial system via its Non-Agent API. It is useful for managing and modifying the status or attributes of agents remotely, such as changing their availability or associating them with campaigns. Practical scenarios include automating agent status updates during shift changes, campaign assignments, or system integrations where agent states need to be synchronized programmatically.

Properties

Name Meaning
Function The API function to call; here it is fixed to "Update Remote Agent".
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 identifier of the agent user to update.
Status New status value to assign to the agent (e.g., available, paused).
Campaign Id Identifier of the campaign to associate the agent with.
Number Of Lines Number of lines assigned to the agent (numeric value).

Output

The node outputs JSON data representing the response from the VICIdial API after attempting to update the remote agent. This typically includes confirmation of the update or error details if the operation failed. There is no binary output.

Dependencies

  • Requires an API key credential (username and password) for authenticating with the VICIdial Non-Agent API.
  • The node expects the base URL of the VICIdial server to be configured in credentials.
  • The node uses HTTP query parameters to send the update request.

Troubleshooting

  • Authentication errors: Ensure that the provided API username and password are correct and have sufficient permissions.
  • Invalid agent user ID: Verify that the agent_user value corresponds to an existing agent in the VICIdial system.
  • Incorrect campaign ID or status: Confirm that the campaign ID exists and the status value is valid within VICIdial.
  • Network issues: Check connectivity to the VICIdial server and that the base URL is correctly set.
  • Empty or missing required fields: Make sure all required properties (function, user, pass, agent_user) are provided.

Links and References

Discussion