VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node interacts with the VICIdial Non-Agent API to update phone details within the Phone DID Management resource. It is designed to modify existing phone configurations such as extension, server IP, protocol, voicemail settings, and more. This node is beneficial in scenarios where automated updates to telephony system phone entries are required, for example, when provisioning new phones, updating credentials, or changing routing parameters programmatically.

Practical examples include:

  • Updating the extension number or server IP of a phone device.
  • Changing the protocol used by a phone (e.g., SIP, IAX2).
  • Modifying voicemail IDs or outbound caller ID information.
  • Deleting a phone entry by setting the delete flag.

Properties

Name Meaning
Function API function name; fixed to "Update Phone" for this operation.
User API user credential for authentication.
Pass API password credential for authentication.
Source Description of what originated the API call; default is "n8n".
Extension The phone extension number to update.
Server Ip The IP address of the server associated with the phone.
Dialplan Number Optional dialplan number associated with the phone.
Voicemail Id Optional voicemail identifier linked to the phone.
Phone Login Login username for the phone device.
Phone Pass Password for the phone login.
Protocol Protocol used by the phone; options: IAX2, SIP, Zap, EXTERNAL.
Phone Full Name Full descriptive name for the phone.
Outbound Cid Outbound Caller ID string for calls from this phone.
Delete Phone Flag indicating whether to delete the phone entry; options: "Y" (yes), "N" (no).

Output

The node outputs JSON data representing the response from the VICIdial API after attempting to update the phone. This typically includes status information about the success or failure of the update operation. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the VICIdial Non-Agent API.
  • The node sends requests to the base URL configured via credentials, specifically targeting the /vicidial endpoint.
  • The node expects the API to accept query parameters corresponding to the input properties.

Troubleshooting

  • Authentication errors: Ensure that valid API user and password credentials are provided. Incorrect credentials will cause authentication failures.
  • Invalid or missing required fields: Required fields such as extension, server_ip, and protocol must be correctly set; otherwise, the API may reject the request.
  • Network issues: Verify connectivity to the VICIdial server and that the base URL is correctly configured.
  • Delete Phone flag misuse: Setting the delete flag to "Y" will remove the phone entry; use with caution to avoid accidental deletions.
  • API response errors: Check the API response message for specific error codes or messages returned by VICIdial to diagnose issues.

Links and References

Discussion