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
Phone DID Management → Check Phone Number
AI-generatedSummary
Check a phone number against VICIdial's database for validation and additional information.
Inputs
- baseURL (required) — Base VICIdial URL (no trailing /vicidial portion) e.g. https://example.com.
- function (required) — API function name, auto-filled with 'check_phone_number'.
- user — VICIdial username, comes from the VICIdial credentials.
- pass — VICIdial password, comes from the VICIdial credentials.
- source — Source defined in the VICIdial credential.
- phone_number (required) — The phone number to check (6-16 digits).
- local_call_time (required) — Local call time in the required format.
- phone_code — Phone country code, defaults to 1.
- postal_code — Postal code associated with the phone number.
- state — State associated with the phone number.
- owner — Owner of the phone number.
- dnc_check — Option to check against Do Not Call (DNC) lists.
- campaign_dnc_check — Option to check DNC status for the specified campaign.
- campaign_id — Campaign ID to associate the check with.
- tz_method — Timezone method for local call time.
- requestOptions — Additional options for the request, such as batching and timeout.
Output shape
a record containing details about the phone number status, such as validity and DNC status.
The response includes various fields regarding the phone number's validation status. Ensure the phone number follows the required format to get accurate results.