VICIdialInstall

Summary

Add a lead to VICIdial by providing necessary lead details and connection credentials.

Inputs

• baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
• function (required) — API function name (auto-filled).
• user — Comes from the VICIdial credential.
• pass — Comes from the VICIdial credential.
• source — Defaults to the source defined in the VICIdial credential.
• phone_number (required) — Phone number (6-16 digits).
• list_id (required) — List ID.
• phone_code — Phone country code.
• first_name — First name of the lead.
• last_name — Last name of the lead.
• address1 — Address line 1.
• address2 — Address line 2.
• address3 — Address line 3.
• city — City.
• state — State.
• province — Province.
• postal_code — Postal code.
• country_code — Country code.
• gender — Gender.
• date_of_birth — Date of birth.
• alt_phone — Alternative phone.
• email — Email address.
• security_phrase — Security phrase.
• comments — Comments.
• vendor_lead_code — Vendor lead code.
• source_id — Source ID.
• gmt_offset_now — GMT offset now.
• title — Title.
• rank — Rank.
• owner — Owner.
• status — Status.
• dnc_check — Do not call check.
• campaign_dnc_check — Campaign do not call check.
• campaign_id — Campaign ID.
• add_to_hopper — Whether to add to hopper.
• hopper_priority — Hopper priority.
• duplicate_check — Duplicate check.
• custom_fields — Use custom fields.
• callback — Callback options.
• callback_status — Callback status.
• callback_datetime — Callback datetime.
• callback_type — Callback type.
• callback_user — Callback user.
• requestOptions — Options for the request.

Output shape

no body — success/failure only

If the lead is added successfully, no body is returned.

Examples

Example 1: Adding a new lead with complete details to the VICIdial system.

Set baseURL, user, and pass credentials; provide the phone_number, list_id, and any additional lead details before execution.