VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node allows users to add a new Phone DID (Direct Inward Dialing) number into a VICIdial system via its Non-Agent API. It is useful for telephony administrators or contact center managers who want to programmatically manage phone numbers that route calls within their call center infrastructure.

Typical use cases include:

  • Automating the provisioning of new phone numbers for inbound call routing.
  • Integrating DID management into broader workflows, such as CRM or helpdesk systems.
  • Dynamically updating call routing configurations based on business rules or events.

For example, a user can add a new DID with a specific pattern and description, set whether it is active, define how calls to this DID should be routed (e.g., to an extension, voicemail, or call menu), and specify if calls should be recorded.

Properties

Name Meaning
Function The API function to call; fixed to "Add 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 phone number pattern for the DID to add (required).
Did Description Optional description for the DID.
Active Whether the DID is active: "Y" (yes) or "N" (no).
Did Route How calls to this DID are routed. Options: EXTEN, VOICEMAIL, AGENT, PHONE, IN GROUP, CALLMENU.
Record Call Whether to record calls: "Y", "N", or "Y QUEUESTOP" (record until queue stop).
Extension Extension number to route calls to (if applicable).
Group Group identifier for routing (if applicable).
Menu Id Call menu ID for routing (if applicable).
Server Ip IP address of the server handling the DID.

Output

The node outputs JSON data representing the response from the VICIdial API after attempting to add the DID. This typically includes success status, any error messages, and details about the newly added DID.

No binary data output is involved in this operation.

Dependencies

  • Requires access to a VICIdial system with the Non-Agent API enabled.
  • Needs valid API credentials (username and password) configured in n8n.
  • The node sends HTTP requests to the VICIdial API endpoint specified by the user's credentials.

Troubleshooting

  • Authentication errors: Ensure the API username and password are correct and have sufficient permissions.
  • Invalid DID pattern: The DID pattern must conform to the expected format accepted by VICIdial.
  • Routing configuration issues: If the DID route or related fields (extension, group, menu id) are incorrect or missing when required, the API may reject the request.
  • Network connectivity: Verify that the n8n instance can reach the VICIdial server IP and port.
  • API errors: Check the API response message for details; common errors include duplicate DIDs or invalid parameters.

Links and References

Discussion