vicigeeksimple guides
Browse

Practical VICIdial docs

VICIdial docs

Start with six beginner walkthroughs: follow the steps, compare the practical checks and read what each result establishes. The 15 unchanged reference snapshots remain below for looking up an exact function, field or error.

6 practical guides15 reference snapshotsCheck your installed version

Start with a task

Practical beginner guides

Clear steps, worked examples, troubleshooting and recovery. Each guide separates observed checks from call outcomes that have not been tested.
G01

Practical beginner guide

VICIdial pauses in a background tab: a beginner’s check

Use a browser lab to understand why hidden VICIdial tabs slow down, then check the real timer settings and plan one controlled change.

Topic
VICIdial & agents
Reading
8 minutes
Reviewed
November 7, 2026
Evidence
Dated practical checks and stated limits
Open the practical guide
G02

Practical beginner guide

Stereo recordings in VICIdial: test the two sides safely

Check whether your system is ready, start with one simple recording mode, then prove which voice is on each channel using one synthetic call.

Topic
Phone system (Asterisk)
Reading
8 minutes
Reviewed
November 7, 2026
Evidence
Dated practical checks and stated limits
Open the practical guide
G03

Practical beginner guide

PJSIP in VICIdial: check your server and set up one test phone

Find out which phone driver your server actually uses, understand the PJSIP connection pieces, and prepare one controlled phone test before changing working phones or carriers.

Topic
Carriers & SIP
Reading
7 minutes
Reviewed
November 7, 2026
Evidence
Dated practical checks and stated limits
Open the practical guide
G04

Practical beginner guide

VICIdial ConfBridge: check the audio room before switching

Understand how an agent and caller meet in a conference, check the running module, profiles and server setting, and plan a controlled switch with a clear recovery path.

Topic
Phone system (Asterisk)
Reading
6 minutes
Reviewed
November 7, 2026
Evidence
Dated practical checks and stated limits
Open the practical guide
G05

Practical beginner guide

VICIdial call count limits: stop calling the same lead too often

Choose between lifetime, daily and rolling 24-hour limits, inspect the real switches, and work through a small attempt ledger before testing a campaign.

Topic
VICIdial & agents
Reading
7 minutes
Reviewed
November 7, 2026
Evidence
Dated practical checks and stated limits
Open the practical guide
G06

Practical beginner guide

VICIdial inbound callback queue: let callers leave hold and keep their place

Set up a waiting-line callback, follow a real internal caller from the offer to the return call, and diagnose missing queue entries without creating duplicate calls.

Topic
VICIdial & agents
Reading
10 minutes
Reviewed
November 7, 2026
Evidence
Dated practical checks and stated limits
Open the practical guide

Choose a reference

Original reference snapshots

The 13 text references are copied from VICIdial documentation; the two ViciBox notes are older copies of unverified provenance. VICIdial is a project of the VICIDIAL Group and eflo.net. Vicigeek is not affiliated with them. The text files are snapshots: compare the document date and instructions with your installed revision and the current official copy before use. The older ViciBox notes have not been verified against current releases.
D01

APIs and integration

Agent API

Find documented functions and parameters for an agent session, including pause, dial, hang up, disposition and transfer.

File
AGENT_API.txt
Length
1,199 lines
Covers
VICIdial Agent API, agc/api.php, agent session control
Source
VICIdial text reference
Read the document
D02

APIs and integration

Non-Agent API

Look up documented administrative API functions for leads, lists, campaigns, users, phones, recordings and reports.

File
NON-AGENT_API.txt
Length
2,874 lines
Covers
VICIdial Non-Agent API, non_agent_api.php, add lead API
Source
VICIdial text reference
Read the document
D03

APIs and integration

Call URL features

Find the documented call and disposition URL fields and their --A--variable--B-- substitutions.

File
CALL_URL_FEATURES.txt
Length
209 lines
Covers
VICIdial Call URL, VICIdial webhook, URL variable substitution
Source
VICIdial text reference
Read the document
D04

APIs and integration

Agent events push

Find the agent-screen events and settings used to send event notifications to a URL.

File
AGENT_EVENTS_PUSH.txt
Length
197 lines
Covers
VICIdial agent events, event push, browser events
Source
VICIdial text reference
Read the document
D05

APIs and integration

CORS support

Find Cross-Origin Resource Sharing (CORS) settings for agent and administration pages.

File
CORS_SUPPORT.txt
Length
85 lines
Covers
VICIdial CORS, cross-origin, browser permission boundary
Source
VICIdial text reference
Read the document
D06

APIs and integration

WebSockets support

Find the documented places to insert WebSocket-related code in the agent screen.

File
WEBSOCKETS_SUPPORT.txt
Length
51 lines
Covers
VICIdial WebSocket, websockets, signaling
Source
VICIdial text reference
Read the document
D07

APIs and integration

Chat and messaging

Find the documented agent, manager and customer chat settings and permissions.

File
CHAT_MESSAGING.txt
Length
97 lines
Covers
VICIdial chat, agent messaging, customer chat
Source
VICIdial text reference
Read the document
D08

Telephony and routing

PJSIP support

Find the documented revision requirements and settings for PJSIP support.

File
PJSIP_SUPPORT.txt
Length
111 lines
Covers
VICIdial PJSIP, chan_sip migration, Asterisk SIP driver
Source
VICIdial text reference
Read the document
D09

Data and dispositions

VICIdial statuses

Look up the meanings of status and disposition codes listed in this source file.

File
VICIDIAL_statuses.txt
Length
88 lines
Covers
VICIdial statuses, disposition codes, status meanings
Source
VICIdial text reference
Read the document
D10

Data and dispositions

Custom fields

Find the documented custom-field definitions, list-specific storage and related settings.

File
CUSTOM_FIELDS.txt
Length
112 lines
Covers
VICIdial custom fields, dynamic tables, lead fields
Source
VICIdial text reference
Read the document
D11

Security and compliance

Two-factor authentication

Find the two-factor authentication settings and the revision described by this document.

File
2FA_TWO_FACTOR_AUTHENTICATION.txt
Length
82 lines
Covers
VICIdial 2FA, two-factor authentication, admin security
Source
VICIdial text reference
Read the document
D12

Security and compliance

DNC.com integration

Find the documented DNC.com integration settings and batch-processing options.

File
DNC-dot-COM_integration.txt
Length
240 lines
Covers
VICIdial DNC, DNC.com, do not call scrubbing
Source
VICIdial text reference
Read the document
D13

Security and compliance

TILTX SHAKEN API

Find the documented TILTX caller-identity signing integration and its prerequisites.

File
TILTX_SHAKEN_API.txt
Length
83 lines
Covers
VICIdial STIR SHAKEN, TILTX, caller identity signing
Source
VICIdial text reference
Read the document
D14

Platform maintenance

ViciBox backup and restore

Older ViciBox backup and restore notes of unverified provenance; check the version and test recovery separately.

File
vicibox-backup-restore-guide.md
Length
567 lines
Covers
ViciBox backup, VICIdial restore, disaster recovery
Source
Older ViciBox note; source unverified
Read the document
D15

Platform maintenance

ViciBox kernel upgrade

Older ViciBox kernel and repository notes of unverified provenance; check current support before using any commands.

File
vicibox-kernel-upgrade-guide.md
Length
298 lines
Covers
ViciBox kernel, kernel upgrade, VICIdial maintenance
Source
Older ViciBox note; source unverified
Read the document