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 performs a Lead Search operation within the Lead Management resource of an external VICIdial API. It allows users to search for leads by phone number and retrieve matching lead records from the system. This is useful in scenarios where you want to verify if a lead exists, fetch lead details before further processing, or integrate lead data into workflows such as CRM updates, call center automation, or marketing campaigns.
For example, a user might input a phone number to check if it corresponds to any existing leads in the database, optionally filtering archived leads or limiting the number of returned records.
Properties
| Name | Meaning |
|---|---|
| Function | The API function to call; fixed to "Lead Search" for this operation |
| User | API user credential (username) used for authentication |
| Pass | API password credential used for authentication |
| Source | Description of what originated the API call; default is "n8n" |
| Phone Number | Phone number to search for; must be 6-16 digits |
| Records | Optional limit on the number of records to return |
| Archived Lead | Whether to include archived leads in the search results; options: "Y" or "N" |
| Header | Whether to include a header row in the output; options: "YES" or "NO" |
Output
The node outputs JSON data containing the search results from the lead management system. The structure typically includes lead details matching the phone number query. If the "Header" option is enabled, the output may include a header row describing the fields.
No binary data output is indicated.
Dependencies
- Requires an API key credential with username and password for authenticating against the VICIdial Non-Agent API.
- The node sends HTTP requests to the configured base URL of the VICIdial API endpoint.
- Proper configuration of credentials and API host URL in n8n is necessary.
Troubleshooting
- Invalid Credentials: Errors related to authentication usually mean the provided user or password is incorrect or missing. Verify credentials are correctly set.
- Phone Number Format: Ensure the phone number is between 6 and 16 digits; otherwise, the API may reject the request.
- API Connectivity: Network issues or incorrect API host URL can cause connection failures. Confirm the API endpoint is reachable.
- Empty Results: If no leads are found, verify the phone number exists in the system and that filters like "Archived Lead" are set appropriately.
- Unexpected Response Format: If the output does not parse correctly, check if the "Header" option matches expected output formatting.
Links and References
- VICIdial Official Documentation (for API details)
- n8n Documentation (for general node usage and credential setup)