VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Overview

This node interacts with the VICIdial Non-Agent API to perform various operations. Specifically, the "Add Group Alias" operation allows users to add a new group alias in the VICIdial system. This is useful for managing call routing and identification within groups by assigning aliases that can be used as caller IDs or identifiers.

Practical scenarios include:

  • Automatically adding new group aliases when onboarding new teams or departments.
  • Integrating with CRM or other systems to dynamically update group aliases based on business logic.
  • Managing caller ID presentation for different groups in a contact center environment.

Properties

Name Meaning
Function The API function to call; here it is fixed to "Add Group Alias".
User API user credential for authentication.
Pass API password credential for authentication.
Source Description of what originated the API call (default: "n8n").
Caller Id Number The phone number to be used as the caller ID for the group alias.
Group Alias Id Identifier for the group alias (optional).
Group Alias Name Name of the group alias to add.
Caller Id Name The name to display as the caller ID for the group alias (optional).
Active Whether the group alias is active ("Y") or not ("N").

Output

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

No binary data output is involved.

Dependencies

  • Requires an API key credential (user and password) for authenticating with the VICIdial Non-Agent API.
  • The node expects the base URL of the VICIdial API to be configured in the credentials.
  • The node uses HTTP query parameters to send data to the API endpoint.

Troubleshooting

  • Authentication errors: Ensure that the user and password credentials are correct and have sufficient permissions.
  • Missing required fields: Caller Id Number and Function are mandatory; missing these will cause API errors.
  • Invalid group alias data: Providing invalid or duplicate group alias names or IDs may result in API rejection.
  • Network issues: Verify connectivity to the VICIdial API host and that the base URL is correctly set.
  • API response errors: Check the returned JSON for error messages indicating what went wrong.

Links and References

Discussion