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 a VICIdial Non-Agent API to add new leads into the lead management system. It is designed to automate the process of inserting lead information such as contact details, demographics, and campaign-related data into VICIdial's database.
Common scenarios where this node is beneficial include:
- Automatically adding new customer or prospect leads collected from web forms or other sources.
- Integrating lead generation workflows with VICIdial for outbound calling campaigns.
- Enriching lead data by programmatically updating lead attributes before dialing.
For example, a marketing automation workflow could collect user sign-up data and use this node to add those users as leads in VICIdial, specifying phone numbers, campaign IDs, and custom fields to prepare them for follow-up calls.
Properties
| Name | Meaning |
|---|---|
| Function | API function name; fixed to "Add Lead" for this operation. |
| User | API user credential for authentication. |
| Pass | API password credential for authentication. |
| Source | Description of what originated the API call (default: "n8n"). |
| Phone Number | Required phone number of the lead (6-16 digits). |
| List Id | Required list identifier to which the lead belongs. |
| Phone Code | Phone country code (default: "1"). |
| First Name | Lead's first name. |
| Last Name | Lead's last name. |
| Address 1 | Primary address line. |
| Address 2 | Secondary address line. |
| Address 3 | Tertiary address line. |
| City | City of the lead. |
| State | State of the lead. |
| Province | Province of the lead. |
| Postal Code | Postal or ZIP code. |
| Country Code | Country code. |
| Gender | Gender of the lead; options: M, F, U (unknown). |
| Date Of Birth | Lead's date of birth. |
| Alt Phone | Alternative phone number. |
| Email address of the lead. | |
| Security Phrase | Security phrase associated with the lead. |
| Comments | Additional comments about the lead. |
| Vendor Lead Code | Vendor-specific lead code. |
| Source Id | Identifier for the source of the lead. |
| Gmt Offset Now | Current GMT offset time zone value. |
| Title | Lead's title (e.g., Mr., Ms., Dr.). |
| Rank | Rank or level associated with the lead. |
| Owner | Owner or responsible party for the lead. |
| Status | Status of the lead. |
| Dnc Check | Do-not-call check option; values: Y, N, AREACODE. |
| Campaign Dnc Check | Campaign-specific do-not-call check; values: Y, N, AREACODE. |
| Campaign Id | Campaign identifier to associate the lead with. |
| Add To Hopper | Whether to add the lead to the hopper queue; values: Y, N. |
| Hopper Priority | Numeric priority for hopper placement. |
| Duplicate Check | Duplicate checking parameter. |
| Custom Fields | Whether custom fields are included; values: Y, N. |
| Callback | Callback flag; values: Y, N, REMOVE. |
| Callback Status | Status of the callback. |
| Callback Datetime | Scheduled datetime for callback. |
| Callback Type | Callback type; options: USERONLY, ANYONE. |
| Callback User | User assigned for callback. |
Output
The node outputs JSON data representing the response from the VICIdial API after attempting to add the lead. This typically includes confirmation of success or failure, any generated lead ID, and error messages if applicable.
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 credentials.
- No additional external dependencies beyond standard HTTP request capabilities.
Troubleshooting
- Authentication errors: Ensure that valid API user and password credentials are provided and have sufficient permissions.
- Invalid phone number format: Phone number must be between 6 and 16 digits; verify input formatting.
- Missing required fields: List ID and phone number are mandatory; ensure these are set.
- API connectivity issues: Confirm network access to the VICIdial API endpoint and correct base URL configuration.
- Duplicate lead errors: If duplicate checking is enabled, conflicts may arise; adjust duplicate check settings accordingly.
- Callback field misuse: When using callback options, ensure related fields like callback status and datetime are correctly formatted.