VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Overview

This node interacts with the VICIdial Non-Agent API to retrieve call status statistics for specified campaigns. It is useful in scenarios where users want to monitor and report on call outcomes, statuses, and performance metrics within their VICIdial telephony system. For example, a contact center manager could use this node to fetch daily call status summaries for selected campaigns to analyze agent performance or campaign effectiveness.

Properties

Name Meaning
Function API function name; fixed to "Call Status Stats" 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 (default: "n8n")
Campaigns Pipe (`
Query Date Date for which to query stats, formatted as YYYY-MM-DD
Ingroups Dash-delimited list of ingroup identifiers to filter results
Statuses Dash-delimited list of call statuses to filter results

Output

The node outputs JSON data containing the call status statistics returned by the VICIdial API. This typically includes aggregated counts or metrics related to call outcomes for the specified campaigns and filters. The exact structure depends on the API response but generally provides detailed reporting data such as number of calls per status, time frames, and campaign breakdowns.

No binary data output is indicated.

Dependencies

  • Requires an API key credential (user and password) for authenticating with the VICIdial Non-Agent API.
  • The node expects the base URL of the VICIdial API to be configured in the credentials.
  • The node uses HTTP requests to communicate with the VICIdial API endpoint /vicidial.

Troubleshooting

  • Authentication errors: Ensure that the provided API user and password are correct and have sufficient permissions.
  • Invalid date format: The Query Date must be in YYYY-MM-DD format; otherwise, the API may reject the request.
  • Empty or incorrect campaign identifiers: The Campaigns property must contain valid campaign IDs separated by pipe or dash characters.
  • Network issues: Verify connectivity to the VICIdial API host and that the base URL is correctly set in credentials.
  • Unexpected API responses: Check if the API endpoint has changed or if additional required parameters are missing.

Links and References

Discussion