How to embed an iframe inside a VICIdial script

What embedding an iframe lets you do

An iframe inside the Agent script tab loads a completely separate web page within the VICIdial agent screen. This is the most common way to show a CRM record, a custom order form, or a real-time lookup tool without requiring agents to switch browser tabs. The external page receives the current Lead data as query-string parameters, so it can pre-fill fields automatically.

Basic iframe structure

Paste an HTML iframe tag into the Script Text field. The src attribute is where you combine your URL with --A--field--B-- tokens. Here is the pattern:

<iframe src="https://yoursite.com/page?lead_id=--A--lead_id--B--&first_name=--A--first_name--B--&last_name=--A--last_name--B--" style="width:460;height:290;background-color:transparent;" scrolling="auto" frameborder="0" allowtransparency="true" width="460" height="290"></iframe>

VICIdial substitutes each --A--field--B-- token before loading the iframe, so the external page receives real lead values.

Which fields you can pass

Any field available in the script variable system can be added as a parameter. Commonly passed fields include lead_id, vendor_lead_code, list_id, first_name, last_name, address1, city, state, postal_code, phone_number, email, comments, campaign, group, gmt_offset_now, SQLdate, epoch, uniqueid, server_ip, SIPexten, and session_id. The complete field reference is in which lead fields you can pull into a VICIdial script.

Sizing and transparency

Set the width and height attributes to fit within the script panel. Using background-color:transparent in the iframe style lets the Script Color field value show through the iframe background, keeping the panel visually consistent. Set frameborder="0" to remove the default border.

Scroll bars and IGNORENOSCROLL

When the script tab contains an iframe, VICIdial may suppress scroll bars on the outer script panel. If your content is taller than the panel, agents will not be able to scroll to see the bottom. To force scroll bars even with an iframe present, add the special variable IGNORENOSCROLL anywhere in the Script Text. See what IGNORENOSCROLL does on a VICIdial script tab for the full explanation.

iframe load flow

sequenceDiagram
  participant VICIdial
  participant ScriptTab as Script Tab
  participant ExternalPage as External Page
  VICIdial->>ScriptTab: Substitute --A--field--B-- tokens in src URL
  ScriptTab->>ExternalPage: HTTP request with lead params in query string
  ExternalPage-->>ScriptTab: HTML page with pre-filled data
  ScriptTab-->>VICIdial: Rendered iframe inside script panel
  VICIdial-->>Agent: Agent sees external page with live lead data

Troubleshooting iframe scripts

• Blank iframe: the external URL is not reachable from the VICIdial server's network or the browser blocks mixed content (HTTP page inside HTTPS).
• Raw token in URL: a field name typo means the parameter sends the literal --A--typo--B-- string. Check the field list and use the Preview Script link to catch this before going live.
• Content cut off: the iframe height is too small or IGNORENOSCROLL is missing. Add IGNORENOSCROLL to the script or increase the height attribute.

For the full context on how scripts fit into the agent experience, start with the VICIdial agent screen configuration guide.

Want to run VICIdial on a fully managed platform? See pricing for available plans.