VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node interacts with the User Agent Management API specifically to retrieve or manage "Agent Campaigns" data. It is designed to query campaign information related to a particular agent user within a VICIdial system or similar call center management platform.

Typical use cases include:

  • Fetching campaign details assigned to a specific agent.
  • Integrating campaign data into workflows for reporting or automation.
  • Filtering campaigns by ID or controlling output format for downstream processing.

For example, a contact center manager could automate the retrieval of active campaigns for an agent and feed that data into a dashboard or CRM system.

Properties

Name Meaning
Function The API function to call; fixed as "Agent Campaigns" 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 is "n8n".
Agent User The unique identifier of the agent user whose campaigns are being queried.
Campaign Id Optional filter specifying a particular campaign ID to retrieve.
Ignore Agentdirect Option to ignore direct agent assignments; values: "Y" or "N".
Stage Output format of the response; options include "csv", "tab", "pipe", and "json".
Header Whether to include a header row in the output; options: "YES" or "NO".

Output

The node outputs the API response in the json field of each item. The structure depends on the selected Stage property:

  • If Stage is set to "json", the output will be a JSON object or array representing the campaign data.
  • For other formats (csv, tab, pipe), the output is a string formatted accordingly, optionally including headers if enabled.

No binary data output is indicated.

Dependencies

  • Requires an API key credential (username and password) for authenticating with the User Agent Management API.
  • The base URL for the API is configured via credentials.
  • No additional external dependencies beyond standard HTTP requests.

Troubleshooting

  • Authentication errors: Ensure the provided user and pass credentials are correct and have sufficient permissions.
  • Empty or missing data: Verify that the agent_user and optional campaign_id parameters correspond to valid entries in the system.
  • Incorrect output format: Confirm the stage parameter matches one of the supported formats; otherwise, parsing downstream may fail.
  • API connectivity issues: Check network access to the API host and that the base URL is correctly configured in credentials.

Links and References

Discussion