VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Overview

This node interacts with the VICIdial Non-Agent API to retrieve callback information for a specific lead within the Lead Management resource. It is designed to fetch detailed callback data related to a lead, which can be useful in scenarios such as managing outbound call campaigns, tracking lead follow-ups, or integrating callback data into CRM workflows.

Practical examples include:

  • Automatically retrieving callback details after a lead is contacted.
  • Integrating callback info into reporting dashboards.
  • Triggering subsequent automation based on callback status or timing.

Properties

Name Meaning
Function API function name; fixed to "Lead Callback Info" for this operation.
User API user credential used for authentication.
Pass API password credential used for authentication.
Source Description of what originated the API call; default is "n8n".
Lead Id The unique identifier of the lead whose callback info is being requested.
Stage Output format of the response; options: Csv, Tab, Pipe, Json.
Header Whether to include a header row in the output; options: YES, NO.
Search Location Location scope for searching leads; options: LIST, CAMPAIGN, SYSTEM, CURRENT, ARCHIVE, ALL.

Output

The node outputs the callback information for the specified lead in the chosen format (CSV, Tab-delimited, Pipe-delimited, or JSON). The output is provided in the json field of the node's output data. If a delimited format is selected, the data will be a string representing the callback info table; if JSON is selected, the output will be structured JSON data representing the callback details.

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 the credentials.
  • No additional external dependencies are required beyond the API access.

Troubleshooting

  • Authentication errors: Ensure that the API user and password credentials are correct and have sufficient permissions.
  • Invalid Lead ID: Verify that the Lead Id provided exists and is accessible in the specified search location.
  • Output format issues: If the output appears malformed, check the selected "Stage" property and whether headers are included as expected.
  • API connectivity: Confirm network access to the VICIdial API endpoint and that the base URL is correctly set in credentials.

Links and References

Discussion