VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node interacts with the VICIdial Non-Agent API, specifically providing functionality under the "List Management" resource for the "Sounds List" operation. It allows users to retrieve lists of sounds from the VICIdial system, which can be useful for managing audio files used in call campaigns or IVR menus.

Typical use cases include:

  • Fetching available sound files to dynamically populate options in a workflow.
  • Auditing or synchronizing sound assets between VICIdial and other systems.
  • Automating updates or reports related to audio resources in call center environments.

Properties

Name Meaning
Function API function name; fixed to "Sounds List" 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".
Format Output format of the sounds list; options are: Text, Link, Selectframe.
Stage Output delimiter or structure format; options are: Csv, Tab, Pipe, Json.
Comments Optional comments or additional query parameter sent with the request.

Output

The node outputs JSON data representing the response from the VICIdial API for the sounds list request. The exact structure depends on the selected Format and Stage parameters but generally includes details about available sound files.

If binary data were involved (e.g., actual sound files), it would be indicated here, but this node only retrieves metadata/list information, not the binary content itself.

Dependencies

  • Requires an API key credential (user and password) for authenticating with the VICIdial Non-Agent API.
  • Needs the base URL of the VICIdial server configured in credentials.
  • Depends on the external VICIdial API being accessible and properly configured to respond to the "sounds_list" function.

Troubleshooting

  • Authentication errors: Ensure that the provided user and password credentials are correct and have sufficient permissions.
  • Network issues: Verify connectivity to the VICIdial server and that the base URL is correctly set.
  • Invalid parameters: Check that the Format and Stage values are among the supported options.
  • Empty or unexpected responses: Confirm that there are sounds available in the VICIdial system and that the API endpoint is functioning as expected.

Links and References

Discussion