VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node interacts with the VICIdial Non-Agent API to retrieve information about currently logged-in user agents. Specifically, the "Logged In Agents" operation under the "User Agent Management" resource fetches details about agents who are actively logged into the system.

Common scenarios for this node include:

  • Monitoring active agents in a call center environment.
  • Generating real-time reports on agent availability.
  • Integrating agent status data into dashboards or workflows for operational insights.

For example, a manager could use this node to automatically pull a list of logged-in agents every hour and send notifications if staffing levels are low.

Properties

Name Meaning
Function API function name; fixed to "Logged In Agents" 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").
Campaigns Pipe (`
User Groups Pipe (`
Show Sub Status Option to include sub-status information in the output ("YES" or "NO", default "NO").
Stage Output format of the data: Csv, Tab, Pipe, or Json (default: Pipe).
Header Whether to include a header row in the output ("YES" or "NO", default "NO").

Output

The node outputs the response from the VICIdial API as JSON data in the json field of each item. The structure depends on the selected output format (stage property):

  • If json is selected, the output is structured JSON representing logged-in agents and their details.
  • For other formats (Csv, Tab, Pipe), the output is a string formatted accordingly, optionally including headers based on the header property.

No binary data output is indicated.

Dependencies

  • Requires an API key credential consisting of a username and password for authenticating with the VICIdial Non-Agent API.
  • The node expects the base URL of the VICIdial API to be configured in credentials.
  • No additional external dependencies beyond standard HTTP requests.

Troubleshooting

  • Authentication errors: Ensure that the provided API username and password are correct and have sufficient permissions.
  • Empty or missing data: Verify that the specified campaigns and user groups exist and that agents are currently logged in.
  • Incorrect output format: Confirm that the stage property is set to a supported format and that the consumer of the data can handle it.
  • API connectivity issues: Check network connectivity and that the base URL is correctly configured in credentials.

Links and References

Discussion