VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Overview

This node interacts with the VICIdial Non-Agent API to retrieve the status of users in specified groups. Specifically, the "In Group Status" operation queries which users are currently active or present in certain call center groups ("in-groups"). This is useful for monitoring real-time agent availability or group activity within a VICIdial environment.

Practical scenarios include:

  • Supervisors checking which agents are logged into specific groups.
  • Automated workflows that adjust routing or notifications based on group presence.
  • Reporting tools that aggregate user statuses across multiple groups.

Properties

Name Meaning
Function The API function to call; fixed to "In Group Status" for this operation.
User API username credential used for authentication.
Pass API password credential used for authentication.
Source Description or identifier of what originated the API call (default: "n8n").
In Groups Pipe-delimited list of in-group IDs or names to query the status for.
Stage Output format of the response; options: Csv, Tab, Pipe, Json.
Header Whether to include a header row in the output; options: YES or NO.

Output

The node outputs the API response in the selected format (CSV, Tab-delimited, Pipe-delimited, or JSON). The json output field contains the parsed data representing the status of users in the specified groups. This typically includes details such as user identifiers, group membership, and current status indicators.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential with username and password for authenticating against 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 the VICIdial API and n8n's HTTP request capabilities.

Troubleshooting

  • Authentication errors: Ensure the provided API username and password are correct and have sufficient permissions.
  • Empty or missing data: Verify that the specified in-groups exist and contain active users.
  • Incorrect output format: Confirm the chosen output format matches downstream processing expectations.
  • Network issues: Check connectivity to the VICIdial API endpoint and that the base URL is correctly set.
  • Header option confusion: If parsing output fails, try toggling the header inclusion option.

Links and References

Discussion