VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node interacts with the VICIdial Non-Agent API to retrieve detailed information about a specific call identified by its Call ID or unique identifier. It is particularly useful in scenarios where users need to fetch call metadata, status, or other related details programmatically within an n8n workflow. For example, after a call ends, this node can be used to pull call logs or analytics data for reporting or further processing.

Properties

Name Meaning
Function API function name; fixed to "Callid Info" for this operation
User API user credential (string) used for authentication
Pass API password credential (string) used for authentication
Source Description of what originated the API call; default is "n8n"
Call Id The unique Call ID or unique identifier of the call to retrieve information for
Stage Output format of the response; options: Csv, Tab, Pipe, Json
Header Whether to include header row in output; options: YES, NO
Detail Level of detail in output; options: YES, NO, ALL, LAST

Output

The node outputs the API response as JSON data in the json field of each item. The structure depends on the selected output format (stage) and detail level (detail). The data typically includes call metadata such as timestamps, status, agent info, and other call-related details. If the output format is set to JSON, the response will be structured JSON; otherwise, it will be formatted as CSV, tab-delimited, or pipe-delimited text.

No binary data output is indicated by the source code.

Dependencies

  • Requires access to the VICIdial Non-Agent API endpoint.
  • Needs valid API credentials: user and password.
  • The base URL for the API is configured via node credentials.
  • The node sends requests with headers accepting plain text responses.

Troubleshooting

  • Authentication errors: Ensure that the provided API user and password are correct and have sufficient permissions.
  • Invalid Call ID: If the call ID does not exist or is malformed, the API may return an error or empty result.
  • Output format issues: Selecting an unsupported or mismatched output format might cause parsing problems downstream.
  • Network connectivity: Verify that the host URL is reachable from the n8n instance.
  • Missing required parameters: The node requires at least the Call ID, user, and password fields to be set.

Common error messages would likely relate to HTTP 401 Unauthorized (bad credentials), 404 Not Found (invalid call ID), or 500 Internal Server Error (API issues). Resolving these involves checking credentials, verifying call IDs, and ensuring the API service is operational.

Links and References

Discussion