VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node interacts with the VICIdial Non-Agent API to retrieve detailed lead information based on a specific call identifier. The "Ccc Lead Info" operation under the "Lead Management" resource fetches data related to a particular call or lead by using its unique call ID. This is useful in scenarios where you want to enrich your workflow with lead details from VICIdial, such as for follow-up actions, reporting, or integration with CRM systems.

Practical examples include:

  • Automatically fetching lead details after a call ends to update a CRM.
  • Generating reports on call outcomes and associated lead data.
  • Triggering conditional workflows based on lead information retrieved from VICIdial.

Properties

Name Meaning
Function API function name; fixed to "Ccc Lead Info" 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 is "n8n".
Call Id Unique identifier of the call or lead (call ID or uniqueid) to fetch information for.
Stage Output format of the response; options are Csv, Tab, Pipe, Json.
Header Whether to include a header row in the output; options are YES or NO.

Output

The node outputs the lead information retrieved from the VICIdial API in the specified format (stage property). The json output field contains the raw response data formatted according to the chosen output type:

  • If stage is set to json, the output will be structured JSON representing the lead info.
  • For other formats (csv, tab, pipe), the output is a string with the lead data separated accordingly.
  • The header option controls whether the output includes a header row describing each column.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential (user and password) for authenticating with the VICIdial Non-Agent API.
  • Needs the base URL of the VICIdial API server configured in credentials.
  • The node sends HTTP requests to the VICIdial API endpoint /vicidial with query parameters.

Troubleshooting

  • Invalid Credentials: Errors may occur if the provided user or password is incorrect. Verify API credentials.
  • Call ID Not Found: If the specified call ID does not exist, the API may return an empty result or error. Confirm the call ID is valid.
  • Incorrect Output Format: Selecting an unsupported output format could cause parsing issues downstream. Use one of the supported formats: csv, tab, pipe, json.
  • Network Issues: Connectivity problems to the VICIdial server will prevent data retrieval. Check network access and API endpoint configuration.

Links and References

Discussion