VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node interacts with the VICIdial Non-Agent API, specifically providing a "Server Refresh" operation under the "System Info" resource. The "Server Refresh" operation triggers a refresh of the server state or configuration via an API call. This can be useful in scenarios where you want to programmatically ensure that the VICIdial server is up-to-date with the latest settings or data without manual intervention.

Practical examples include:

  • Automatically refreshing the VICIdial server after configuration changes.
  • Scheduling periodic refreshes to maintain system consistency.
  • Integrating server refresh as part of a larger workflow for system maintenance.

Properties

Name Meaning
Function API function name; for this operation, it is fixed as "server_refresh".
User API user 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".
Stage Output format of the response; options are Csv, Tab, Pipe, and Json.

Output

The node outputs the response from the VICIdial API call in the json output field. The structure depends on the selected output format (stage property):

  • If json is selected, the output will be structured JSON data representing the server refresh result.
  • For other formats (csv, tab, pipe), the output will be text formatted accordingly (CSV, tab-delimited, or pipe-delimited).

No binary data output is indicated.

Dependencies

  • Requires an API key credential (user and password) for authenticating with the VICIdial API.
  • Needs the base URL of the VICIdial server configured in credentials.
  • The node uses the @devlikeapro/n8n-openapi-node package and an OpenAPI specification (openapi.json) bundled internally for request building.

Troubleshooting

  • Authentication errors: Ensure that the provided user and password are correct and have sufficient permissions to perform server refresh operations.
  • Connection issues: Verify the base URL of the VICIdial server is reachable from the n8n instance.
  • Invalid output format: Selecting an unsupported stage value may cause unexpected results; use one of the provided options.
  • Empty or malformed responses: Check if the VICIdial server is operational and the API endpoint /vicidial is correctly configured.

Links and References

Discussion