VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node allows users to update Phone DID (Direct Inward Dialing) configurations via an API. It is useful in telephony systems where administrators need to modify the routing, description, status, and other attributes of phone numbers managed by their system. Typical use cases include changing call routing destinations, enabling or disabling DIDs, updating descriptions for easier management, or toggling call recording settings.

For example, a user might update a DID to route calls to a different extension or voicemail box, or deactivate a DID that is no longer in use.

Properties

Name Meaning
Function The API function to call; fixed as "Update Did" for this operation.
User API username credential used for authentication.
Pass API password credential used for authentication.
Source Description of what originated the API call; default is "n8n".
Did Pattern The pattern or identifier of the DID to update (e.g., phone number or pattern).
Did Description A textual description for the DID, useful for identification or notes.
Active Whether the DID is active ("Y") or inactive ("N").
Did Route The routing destination for the DID. Options: EXTEN, VOICEMAIL, AGENT, PHONE, IN GROUP, CALLMENU.
Record Call Call recording setting. Options: "Y" (record), "N" (do not record), "Y QUEUESTOP" (record until queue stops).
Extension Extension number associated with the DID when routing to an extension.
Group Group name or identifier if routing to a group.
Delete Did Whether to delete the DID ("Y") or not ("N").

Output

The node outputs JSON data representing the response from the API after attempting to update the DID. This typically includes confirmation of success or failure and any relevant details returned by the API. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential consisting of a username and password for authenticating with the VICIdial API.
  • The node sends requests to a base URL configured in credentials, specifically targeting the /vicidial endpoint.
  • The API expects query parameters corresponding to the properties listed above.

Troubleshooting

  • Authentication errors: If the API user or password is incorrect or missing, the node will fail to authenticate. Verify credentials are correctly set.
  • Invalid DID pattern: Providing an incorrect or non-existent DID pattern may cause the API to return an error or no changes.
  • Routing mismatches: Setting incompatible routing options (e.g., specifying an extension without proper format) could lead to unexpected behavior.
  • API connectivity issues: Ensure the base URL and network access to the VICIdial API server are correct and available.
  • Delete flag misuse: Setting "Delete Did" to "Y" will remove the DID; ensure this is intentional to avoid accidental deletions.

Links and References

Discussion