VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node interacts with the VICIdial Non-Agent API, specifically focusing on the "List Management" resource and its "Moh List" operation. It is designed to retrieve or manage Music on Hold (MOH) lists within VICIdial, a popular open-source contact center solution.

Typical use cases include:

  • Fetching available MOH lists to configure call queues or campaigns.
  • Integrating MOH list retrieval into automated workflows for dynamic call handling.
  • Managing MOH settings programmatically without manual intervention in the VICIdial interface.

For example, a user might automate the retrieval of MOH lists to update IVR menus or dynamically assign hold music based on campaign parameters.

Properties

Name Meaning
Function API function name; fixed to "Moh List" for this operation.
User API username credential used for authentication with the VICIdial API.
Pass API password credential used for authentication with the VICIdial API.
Source Description of what originated the API call; defaults to "n8n".
Format Output format of the response; options are: "Text", "Link", or "Selectframe".
Comments Optional comments or notes sent along with the API request.

Output

The node outputs data retrieved from the VICIdial API related to MOH lists. The output is structured as JSON objects containing the MOH list information formatted according to the selected "Format" property:

  • Text: Plain text representation of the MOH list.
  • Link: URL links related to MOH resources.
  • Selectframe: A framed selection format, possibly HTML or structured data for UI embedding.

If binary data were involved (not indicated here), it would typically represent media files or audio streams for MOH, but this node focuses on metadata and list information.

Dependencies

  • Requires an active connection to a VICIdial server with access to the Non-Agent API.
  • Needs valid API credentials (username and password) configured securely in n8n.
  • The node uses HTTP requests to communicate with the VICIdial API endpoint specified by the user's credentials.

Troubleshooting

  • Authentication errors: Ensure that the provided API username and password are correct and have sufficient permissions.
  • Connection issues: Verify network connectivity to the VICIdial server and that the base URL is correctly set in credentials.
  • Invalid format option: Use only the supported formats ("text", "link", "selectframe") to avoid unexpected responses.
  • Empty or malformed responses: Check if the VICIdial API is operational and that the requested MOH lists exist.

Links and References

Discussion