VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Overview

This node interacts with a Phone DID Management API to export call log data for a specified phone number on a given date. It is useful in scenarios where users need to retrieve detailed call logs for analysis, reporting, or auditing purposes related to Direct Inward Dialing (DID) numbers.

Typical use cases include:

  • Exporting daily call logs for a specific phone number to monitor call activity.
  • Integrating call log data into other systems for further processing or visualization.
  • Automating the retrieval of call records for compliance or billing.

For example, a telecom administrator could use this node to automatically fetch and store call logs every day for their managed phone numbers.

Properties

Name Meaning
Function The API function to call; fixed to "Did Log Export" 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; defaults to "n8n".
Phone Number The target phone number (6-16 digits) for which the call log is requested.
Date The date of the call log in YYYY-MM-DD format.
Stage Output format of the exported log; options are Csv, Tab, Pipe, or Json.
Header Whether to include a header row in the output; options are YES or NO.

Output

The node outputs the call log data as plain text in the selected format (csv, tab, pipe, or json). The output is available in the json field of the node's output items, typically as a string containing the exported log data.

If the output format is JSON, the data will be structured accordingly; otherwise, it will be a delimited text string. There is no binary data output.

Dependencies

  • Requires an API key credential consisting of a username and password for authenticating with the Phone DID Management API.
  • The node sends HTTP requests to the configured API endpoint.
  • No additional external dependencies beyond standard HTTP connectivity.

Troubleshooting

  • Authentication errors: Ensure that the provided API user and password are correct and have sufficient permissions.
  • Invalid phone number or date format: Verify that the phone number contains 6-16 digits and the date follows the YYYY-MM-DD format.
  • Empty or malformed response: Check if the API service is reachable and the parameters are valid. Also, confirm that the requested date has call log data.
  • Output format issues: If the output does not match expectations, verify the Stage property is set correctly and supported by the API.

Links and References

  • Refer to your Phone DID Management API documentation for details on the did_log_export function and supported parameters.
  • n8n documentation on creating and using HTTP request nodes may provide additional context on API integrations.

Discussion