Skip to content

Connect your VICIdial

  1. Open Setup, then Integrations. Stay on the Connections tab.
  2. Under “Connect something”, find VICIdial and press Connect your VICIdial. Nothing is sent to VICIdial until you finish the three steps.
  3. Step 1, Where it is: fill in Address, API user and API password. Press Next.
  4. Step 2, Where people go: fill in VICIdial list number and Source tag. Fill in In-group for transfers if you use one. Press Next.
  5. Step 3, For your VICIdial admin: the addresses your firewall must let through and the checklist from prepare your VICIdial. Press Connect and test.
  6. Read the result. “Your VICIdial is connected” means the test passed. “Saved, but the test did not pass” means it is saved but failed. See test and troubleshoot.
  7. Open the campaign and the step that hands people over. Under “Who handles it” choose “An outside dialer or number”. Under “Send the call to” choose “A VICIdial in-group”. Pick the VICIdial connection and fill in the target.
Field What to enter
Address The web address you use to open VICIdial, for example https://dialer.yourcompany.com. Vodial adds /vicidial/non_agent_api.php. It must start with https:// and be a public address: Vodial’s servers cannot reach a VICIdial on a private network (10.x, 172.16 to 172.31.x, 192.168.x, an office LAN) unless you set up a VPN or a public address, and the wizard says so under the field if you enter one.
My VICIdial uses a self-signed certificate Tick it only if your web server uses a self-signed or private-CA certificate (ViciBox does until a real one is installed). The wizard then shows the certificate’s fingerprint and asks “Is this your VICIdial server’s certificate?”. Have your VICIdial admin compare it with the certificate on the server, then confirm. Vodial trusts only that exact certificate and sends nothing, and never your password, before you confirm. Stored as api_tls: verify (default) or pinned, with the confirmed fingerprint in api_tls_pin.
Let these addresses through Not a field. The public addresses Vodial’s requests come from (the service setting EGRESS_IPS). Your firewall must allow them. If it says to ask Vodial, ask your Vodial contact.
API user The user your admin made. Up to 20 characters.
API password Its password. It is kept encrypted and never shown again.
VICIdial list number Digits only, up to 14. New leads are added to this list. Check it twice: VICIdial accepts a list number that does not exist and files the leads there without an error, so a typo sends every pushed lead to a list nobody opens.
Source tag A short label VICIdial records for API calls. Letters, digits, - and _, up to 20. The default is VODIAL.
In-group for transfers Optional. Letters, digits, - and _, up to 20.

The wizard names the connection “VICIdial”. For a second one, use Advanced setup and another name.

When a result is set, Vodial sets a VICIdial status on the lead. A result is the outcome saved for the person, such as a sale. VICIdial calls it a disposition. Each status must already exist in VICIdial.

Vodial picks a status in this order: your map, the built-in map below, then “Status when nothing else fits”. If none applies, nothing is sent.

Our result Built-in VICIdial status
Sale (SALE) SALE
Handed over (XFER) XFER
Callback (CB) CALLBK
Asked to stop (DNC) DNC
Not interested (NI) NI
Not a fit (NQ) NI
No answer (NA) NA
Busy (B) B
Answering machine (AM) A
Wrong number (WN) DC
Hung up (HU) DROP
Failed (FAIL) N

To change it, open Advanced setup and fill in “Our outcome to VICIdial status”, one per line, written as Name: value, for example SALE: SOLD. A VICIdial status is 1 to 6 letters or digits. See result codes.

Advanced setup also has “SIP address for transfers”, a template such as sip:{in_group}@dialer.example.com. It can use {in_group}, {campaign_id}, {list_id} and {host}. The host is the name from your Address. Vodial shows the result at the end of the wizard, and the API returns it at GET /connectors/{id}/vicidial/transfer-target. Nothing is shown unless you filled in the template.

The API password is write-only. After you save it, the screen shows “Saved” and a Replace button, never the value. Change it in VICIdial and in Vodial at the same time. Until both match, pushes fail and are retried.