VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Overview

This node operation, Delete Fpg Phone under the Phone DID Management resource, is designed to delete a phone number from a specific group in a phone system managed via an API. It is useful in scenarios where you need to programmatically remove phone numbers (DIDs) that are no longer needed or have been reassigned, helping maintain an up-to-date and clean phone inventory.

Practical examples include:

  • Automatically removing disconnected or expired phone numbers from your telephony system.
  • Managing phone number allocations dynamically based on business rules or user actions.
  • Integrating with CRM or support systems to deactivate phone numbers when customers close accounts.

Properties

Name Meaning
Function The API function to call; here it is fixed as "Delete Fpg Phone".
User API user credential for authentication.
Pass API password credential for authentication.
Source Description of what originated the API call; default is "n8n".
Phone Number The phone number to delete, consisting of 6 to 16 digits.
Group The group identifier from which the phone number will be deleted.

Output

The node outputs JSON data representing the response from the API after attempting to delete the specified phone number. This typically includes success or error messages indicating whether the deletion was successful. There is no indication that binary data is returned by this operation.

Dependencies

  • Requires an API key credential (user and password) to authenticate requests.
  • Needs the base URL of the VICIdial API configured in credentials.
  • The node sends HTTP requests to the VICIdial Non-Agent API endpoint.

Troubleshooting

  • Authentication errors: If the API user or password is incorrect, the node will fail to authenticate. Verify credentials are correct and have sufficient permissions.
  • Invalid phone number format: Ensure the phone number consists only of digits and is between 6 and 16 characters long.
  • Group not found or invalid: The specified group must exist in the system; otherwise, the API may return an error.
  • Network issues: Connectivity problems to the API endpoint can cause request failures.
  • API errors: Check the API response message for details if the deletion fails, such as the phone number not existing or already deleted.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions.

Discussion