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
The "Check Phone Number" operation in the "Phone DID Management" resource allows users to verify and validate phone numbers through an API call. This node is useful for scenarios where you need to confirm the status, validity, or details of a phone number before proceeding with further actions such as dialing, marketing campaigns, or data enrichment.
Practical examples include:
- Validating customer phone numbers before initiating outbound calls.
- Checking if a phone number is on a Do Not Call (DNC) list.
- Retrieving geographic or campaign-related information about a phone number to tailor communication strategies.
Properties
| Name | Meaning |
|---|---|
| Function | API function name; fixed to "Check Phone Number" for this operation. |
| User | API user credential used for authentication. |
| Pass | API password credential used for authentication. |
| Source | Description of what originated the API call; default is "n8n". |
| Phone Number | The phone number to check; must be 6-16 digits. |
| Local Call Time | Local time at which the call would be made (string format). |
| Phone Code | Phone country code; default is "1" (USA). |
| Postal Code | Postal code related to the phone number (optional). |
| State | State related to the phone number (optional). |
| Owner | Owner information related to the phone number (optional). |
| Dnc Check | Whether to perform a Do Not Call check; options: "Y", "N", "AREACODE". |
| Campaign Dnc Check | Whether to perform a campaign-specific Do Not Call check; options: "Y", "N", "AREACODE". |
| Campaign Id | Identifier for the campaign related to the phone number (optional). |
| Tz Method | Timezone method or information (optional). |
Output
The node outputs JSON data containing the response from the phone number check API. This typically includes validation results, DNC status, geographic or campaign-related metadata, and any other relevant information returned by the API.
If the API supports binary data output, it is not indicated here; thus, the output is expected to be purely JSON structured data representing the phone number check results.
Dependencies
- Requires an API key credential consisting of a user and password for authentication.
- The node sends requests to a VICIdial Non-Agent API endpoint configured via credentials.
- Proper configuration of the API host URL and authentication credentials in n8n is necessary.
Troubleshooting
- Authentication errors: Ensure that the API user and password credentials are correctly set and valid.
- Invalid phone number format: The phone number must be between 6 and 16 digits; input validation errors may occur otherwise.
- Missing required parameters: Required fields like phone number, local call time, user, and pass must be provided.
- API connectivity issues: Verify network access to the configured API host and that the base URL is correct.
- Unexpected API responses: Check that optional parameters like DNC checks and campaign IDs are correctly formatted and supported by the API.
Links and References
- VICIdial Official Documentation (for general API reference)
- n8n documentation on HTTP Request Node for understanding API integrations