VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Overview

This node interacts with the VICIdial Non-Agent API to perform a "Recording Lookup" operation within the "Reporting Monitoring" resource. It allows users to query call recording data based on various criteria such as agent user ID, lead ID, date, unique call identifier, extension, and more. The node is useful for retrieving detailed information about call recordings for reporting, monitoring, or auditing purposes.

Practical examples include:

  • Fetching all recordings for a specific agent on a given date.
  • Looking up recordings associated with a particular lead.
  • Retrieving recording details by unique call identifiers.
  • Exporting recording data in different formats (CSV, JSON, etc.) for further analysis.

Properties

Name Meaning
Function API function name; fixed to "Recording Lookup" 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".
Agent User Agent user ID to filter recordings by a specific agent.
Lead Id Lead ID to filter recordings related to a particular lead.
Date Date filter in YYYY-MM-DD format to specify the day of recordings to retrieve.
Uniqueid Unique call identifier to look up a specific recording.
Extension Extension number to filter recordings by extension.
Stage Output format of the response; options are Csv, Tab, Pipe, Json.
Header Whether to include a header row in the output; options are YES or NO.
Duration Whether to include duration information in the output; options are Y (yes) or N (no).

Output

The node outputs the API response in the selected format specified by the "Stage" property. This can be CSV, tab-delimited text, pipe-delimited text, or JSON. The output is provided in the json field of the node's output data.

If the output format is JSON, the data will be structured as parsed JSON objects representing the recording lookup results. For other formats, the output will be plain text strings formatted accordingly.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential (user and password) for authenticating with the VICIdial Non-Agent API.
  • The base URL for the API is configured from credentials and defaults to the /vicidial path.
  • No additional external services or environment variables are explicitly required beyond the API credentials.

Troubleshooting

  • Authentication errors: Ensure that the API user and password credentials are correct and have sufficient permissions.
  • Invalid date format: The "Date" property must be in YYYY-MM-DD format; otherwise, the API may reject the request.
  • Empty or no results: Verify that the filtering parameters (agent user, lead ID, uniqueid, etc.) are correct and correspond to existing recordings.
  • Output format issues: If the output is not as expected, check the "Stage" and "Header" properties to ensure the desired format and headers are selected.
  • API connectivity: Confirm that the base URL and network access to the VICIdial API endpoint are properly configured.

Links and References

Discussion