Actions58
- Lead Management Actions
- User Agent Management Actions
- Campaign Management Actions
- Phone DID Management Actions
- List Management Actions
- Reporting Monitoring Actions
- System Info Actions
- Other Operations Actions
Overview
This node integrates with the VICIdial Non-Agent API to manage phone Direct Inward Dialing (DID) configurations. Specifically, the "Add Phone" operation allows users to add a new phone extension to the VICIdial system programmatically. This is useful in scenarios where automated provisioning of phone extensions is needed, such as onboarding new agents or scaling telephony infrastructure without manual intervention.
Practical examples include:
- Automatically adding new agent phones when hiring staff.
- Integrating with CRM systems to provision phones based on customer data.
- Managing telephony resources dynamically in response to business needs.
Properties
| Name | Meaning |
|---|---|
| Function | API function name; fixed to "Add 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 add. |
| Dialplan Number | The dialplan number associated with the phone. |
| Voicemail Id | Identifier for the voicemail box linked to the phone. |
| Phone Login | Login username for the phone device. |
| Phone Pass | Password for the phone device login. |
| Server Ip | IP address of the server hosting the phone system. |
| Protocol | Protocol used by the phone; options are IAX2, SIP, Zap, EXTERNAL. |
| Registration Password | Password used for phone registration. |
| Phone Full Name | Full descriptive name for the phone. |
| Outbound Cid | Outbound Caller ID number. |
| Local Gmt | Local GMT offset for the phone; default is "-5.00". |
| Phone Context | Context string for the phone configuration. |
| Email address associated with the phone or user. | |
| Is Webphone | Indicates if the phone is a webphone; options: Y, N, Y API LAUNCH. |
| Template Id | Template identifier for phone configuration. |
Output
The node outputs JSON data representing the response from the VICIdial API after attempting to add the phone. This typically includes success status, any error messages, and details about the newly added phone extension.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential (user and password) for authenticating with the VICIdial Non-Agent API.
- Needs the base URL of the VICIdial server configured in credentials.
- The node sends HTTP requests to the VICIdial API endpoint
/vicidialwith query parameters corresponding to the input properties.
Troubleshooting
- Authentication errors: Ensure that the API user and password credentials are correct and have sufficient permissions.
- Invalid or missing required fields: All required properties like extension, dialplan number, voicemail id, etc., must be provided; missing these will cause API errors.
- Network connectivity issues: Verify that the VICIdial server IP and base URL are reachable from the n8n instance.
- Protocol mismatches: Use one of the supported protocols (IAX2, SIP, Zap, EXTERNAL); unsupported values will cause failures.
- API response errors: Check the returned JSON for error messages indicating issues such as duplicate extensions or invalid parameters.