Which lead fields you can pull into a VICIdial script

How variable substitution works

Inside the Script Text field, you can embed any lead field by wrapping it like this: --A--field_name--B--. When an agent opens a call, VICIdial fetches that field from the active Lead record and drops the value straight into the script. No extra coding needed. The full list of usable field names is covered below.

Core contact fields

These are the fields agents rely on most in an opening line or address block:

• first_name, middle_initial, last_name, title
• address1, address2, address3, city, state, province, postal_code, country_code
• phone_number, alt_phone, phone_code
• email, gender, date_of_birth, security_phrase
• comments — the free-text notes field on the lead record

Lead and list identifiers

• lead_id — the unique numeric ID of the lead record
• list_id — the Lead list the lead belongs to
• vendor_lead_code — an ID your data supplier assigned; also called Vendor lead code in the interface
• source_id — the lead source identifier
• entry_list_id — the list ID the lead was originally uploaded into
• called_count — how many times this lead has been called
• called_since_last_reset — calls since the last list reset

Campaign and session fields

• campaign — the Campaign the agent is logged into
• group, channel_group — the inbound group if applicable
• phone_login — the agent's phone extension login
• session_id — the unique ID of the current agent session
• uniqueid — the Asterisk call unique identifier
• customer_zap_channel, server_ip, SIPexten — low-level channel details
• dialed_number, dialed_label — the DID number and its label that the call came in on
• gmt_offset_now — the lead's current GMT offset based on their area code
• SQLdate, epoch — current server date/time in SQL format and Unix epoch

Recording and transfer fields

• recording_filename, recording_id — the filename and ID of the active call recording
• closecallid, xfercallid — IDs used in transfer and closer workflows
• agent_log_id, call_id — internal logging IDs for the current interaction

Script and layout fields

• camp_script, in_script — the script assigned to the campaign and inbound group respectively
• script_width, script_height — the rendered dimensions of the script panel

Agent and user custom fields

• rank, owner — lead rank and assigned owner
• user_group — the user group the agent belongs to
• user_custom_one through user_custom_five — five free-form custom fields on the user record

Preset and DTMF fields

• preset_number_a through preset_number_f — preset phone numbers configured on the campaign
• preset_dtmf_a, preset_dtmf_b — preset DTMF strings

DID fields

• did_id, did_extension, did_pattern, did_description — details about the inbound DID that routed the call

Special display tokens

• TABLEper_call_notes — renders the per-call notes table inside the script
• MANUALDIALLINK — inserts a manual-dial link into the script
• EMAILinbound_message — renders the body of an inbound email when using email queues

Field substitution flow

flowchart TD
  A[Agent receives call] --> B[VICIdial loads lead record]
  B --> C[Script Text fetched from DB]
  C --> D[Each --A--field--B-- token resolved]
  D --> E[Substituted script rendered in SCRIPT tab]
  E --> F[Agent reads personalized script]

A quick example

Placing this text in Script Text: Hello, can I speak with --A--first_name--B-- --A--last_name--B-- please? renders as Hello, can I speak with John Doe please? when the lead's first_name is John and last_name is Doe. You can combine any number of fields in a single script.

Once your script is built, see the full VICIdial agent screen configuration guide to understand how scripts slot into campaigns, lists, and inbound groups.

If you want to check how your variables will actually render before agents go live, read how to preview a VICIdial script.

Ready to put these fields to work on a full-featured VICIdial instance? See pricing to find the right plan.