VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node interacts with the VICIdial Non-Agent API to retrieve phone number logs within the Phone DID Management resource. It is designed to fetch detailed call log information for a specified phone number, supporting various output formats and filtering options. This node is beneficial in scenarios where users need to audit or analyze call activity related to specific phone numbers, such as monitoring inbound/outbound calls, checking call details, or integrating call logs into workflows for reporting or further processing.

Practical examples include:

  • Retrieving the last outbound call log for a given phone number.
  • Exporting all call logs in CSV format for archival or analysis.
  • Filtering call logs by type (inbound, outbound, or all) and detail level.

Properties

Name Meaning
Function API function name; fixed to "Phone Number Log" 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".
Phone Number The target phone number (6-16 digits) for which to retrieve call logs.
Stage Output format of the log data; options: Csv, Tab, Pipe, Json.
Header Whether to include a header row in the output; options: YES, NO.
Detail Level of detail in the output; options: YES, NO, ALL, LAST.
Type Call direction filter; options: IN (inbound), OUT (outbound), ALL (both).
Archived Lead Filter for archived leads; options: Y (yes), N (no).

Output

The node outputs the retrieved phone number log data in the selected format under the json output field. Depending on the chosen Stage property, the output can be formatted as:

  • CSV, Tab-delimited, or Pipe-delimited text data including call log entries.
  • JSON structured data representing the call logs.

If the Header option is set to YES, the output includes column headers describing each field. The output contains detailed call log information filtered by the provided parameters such as phone number, call type, and detail level.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential consisting of a username and password for authenticating with the VICIdial Non-Agent API.
  • The node configuration must include the base URL of the VICIdial API server.
  • No additional external services are required beyond access to the VICIdial API endpoint.

Troubleshooting

  • Authentication errors: Ensure that valid API user credentials (username and password) are provided. Incorrect credentials will result in authorization failures.
  • Invalid phone number format: The phone number must be between 6 and 16 digits. Providing an invalid phone number may cause the API to reject the request.
  • Unsupported output format: Selecting an unsupported Stage value could lead to unexpected output or errors.
  • Empty or no results: If no call logs exist for the specified phone number and filters, the output may be empty. Verify the filters and phone number correctness.
  • API connectivity issues: Network problems or incorrect API base URL configuration can prevent successful requests.

Links and References

Discussion