VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Overview

This node integrates with the VICIdial Non-Agent API to manage phone Direct Inward Dialing (DID) aliases. Specifically, the "Add Phone Alias" operation allows users to create a new phone alias within the VICIdial system. This is useful in scenarios where an organization wants to assign alternative phone numbers or identifiers (aliases) to existing phone lines for routing, tracking, or organizational purposes.

Practical examples include:

  • Adding a new alias to a phone line for marketing campaigns.
  • Creating aliases to route calls differently based on business needs.
  • Managing multiple phone identities under a single user account.

Properties

Name Meaning
Function The API function to call; here it is fixed as "Add Phone Alias".
User The API username credential used for authentication.
Pass The API password credential used for authentication.
Source A description or identifier of what originated the API call; defaults to "n8n".
Alias Id The unique identifier for the phone alias being added.
Alias Name The display name or label for the phone alias.
Phone Logins The phone login(s) associated with this alias; typically identifies the phone line(s).

Output

The node outputs JSON data representing the response from the VICIdial API after attempting to add the phone alias. This typically includes confirmation details such as success status, any error messages, and information about the newly created alias.

No binary data output is involved in this operation.

Dependencies

  • Requires access to the VICIdial Non-Agent API endpoint.
  • Needs valid API credentials: a username and password for authentication.
  • The base URL for the API must be configured in the node's credentials.
  • The node sends requests with query parameters corresponding to the input properties.

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.
  • Missing required fields: Ensure all required properties (Alias Id, Alias Name, Phone Logins) are provided; otherwise, the API may reject the request.
  • API connectivity issues: Confirm that the base URL is reachable and the network allows outbound connections to the VICIdial server.
  • Invalid alias data: The API might return errors if the alias ID or name conflicts with existing entries or violates format rules. Check the API documentation for constraints.

Links and References

Discussion