VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node interacts with the VICIdial Non-Agent API to update entries in a Caller ID (Cid) Group. It is useful for managing caller identification groups dynamically within an automated workflow, such as updating area codes or outbound caller IDs associated with specific groups. Practical applications include telephony systems where caller ID information needs to be programmatically maintained or adjusted based on business rules or external data sources.

Properties

Name Meaning
Function The API function to call; fixed to "Update Cid Group Entry" 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; defaults to "n8n".
Cid Group Id Identifier of the CID group to update.
Areacode Area code associated with the CID group entry to update.
Stage Output format of the response; options are Csv, Tab, Pipe, Json.
Outbound Cid Outbound caller ID number to set for the group entry.
Cid Description Description text for the CID group entry.
Active Whether the CID group entry is active; options are "Y" (yes) or "N" (no).

Output

The node outputs the response from the VICIdial API in the format specified by the Stage property. This can be CSV, tab-delimited, pipe-delimited, or JSON. The output is provided in the json field of the node's output data. There is no indication that binary data is returned.

Dependencies

  • Requires access to the VICIdial Non-Agent API endpoint.
  • Needs credentials including an API user and password.
  • The base URL for the API is configured via node credentials.
  • The node sends requests with headers accepting plain text responses.

Troubleshooting

  • Authentication errors: Ensure the API user and password are correct and have sufficient permissions.
  • Invalid parameters: Verify that required fields like cid_group_id, areacode, and stage are correctly set.
  • API connectivity issues: Confirm network access to the VICIdial API host and that the base URL is properly configured.
  • Unexpected response formats: If the output does not parse correctly, check the Stage property matches expected formats supported by downstream nodes.

Links and References

Discussion