VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node interacts with the VICIdial Non-Agent API to retrieve information about an agent's ingroup memberships. Specifically, the "Agent Ingroup Info" operation fetches details about which ingroups a particular agent user belongs to. This is useful in call center environments where agents are assigned to different groups (ingroups) for routing calls or managing workloads.

Practical scenarios include:

  • Monitoring or reporting on agent group assignments.
  • Dynamically adjusting workflows based on agent ingroup membership.
  • Integrating agent group data into dashboards or CRM systems.

Properties

Name Meaning
Function The API function to call; fixed to "Agent Ingroup Info" 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; defaults to "n8n".
Agent User The ID of the agent user whose ingroup info is being requested.
Stage Output format of the response; options are Csv, Tab, Pipe, or Json.

Output

The node outputs the API response in the json field of the output data. The structure depends on the selected output format (stage property):

  • If json is selected, the output will be a JSON object representing the agent's ingroup information.
  • For csv, tab, or pipe formats, the output will be a string formatted accordingly (comma-separated, tab-separated, or pipe-separated values).

No binary data output is indicated.

Dependencies

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

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 a valid agent in the VICIdial system.
  • Unexpected output format: Confirm that the stage property is set to one of the supported formats; otherwise, parsing the response may fail.
  • Network issues: Check connectivity to the VICIdial API endpoint and that the base URL is correctly configured.

Links and References

Discussion