VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Overview

This node integrates with the VICIdial Non-Agent API to manage Phone DID (Direct Inward Dialing) numbers, specifically allowing users to add a new FPG phone number to a group. It is useful in scenarios where automated provisioning or management of phone numbers within a VICIdial system is required, such as setting up new call routing configurations or managing telephony resources programmatically.

A practical example would be an operations team automating the addition of new phone numbers to specific groups for call campaigns without manual intervention, improving efficiency and reducing errors.

Properties

Name Meaning
Function The API function to call; here it is fixed to "Add Fpg Phone"
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"
Phone Number The phone number to add (must be between 6 and 16 digits)
Group The group to which the phone number will be added

Output

The node outputs JSON data representing the response from the VICIdial API after attempting to add the FPG phone number. This typically includes success or error information returned by the API. There is no indication that binary data is output by this node.

Dependencies

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

Troubleshooting

  • Authentication Errors: If the API user or password is incorrect, the node will fail to authenticate. Verify credentials are correct and have necessary permissions.
  • Invalid Phone Number: The phone number must be between 6 and 16 digits. Providing invalid formats may cause API errors.
  • Group Not Found: Specifying a non-existent group may result in failure to add the phone number.
  • Network Issues: Ensure the VICIdial server URL is reachable from n8n and that any firewalls allow communication.
  • API Response Errors: Check the raw API response for detailed error messages if the operation fails.

Links and References

Discussion