Skip to content

Connect your voice agent

  1. Open Setup, then Integrations. Stay on the Connections tab.
  2. Find Voice agent and press Connect your voice agent. Nothing on your agent is changed until you press Apply to your agent.
  3. Step 1, Connect: enter the API key and the agent id. Press Connect and test. This saves the connection and reads your agent; it changes nothing there. When the test is good, the button reads Next. (If you change a field later it reads Save and test, and Test again when nothing changed.)
  4. Step 2, How calls reach the agent: choose your VICIdial or Vodial’s own lines, then fill in the fields below.
  5. Step 3, Closers: enter the phone number that rings your closers.
  6. Step 4, Apply: press Apply to your agent. When it is done, press Done.
  7. Read the result. “Published as v80” means your agent now runs with Vodial’s settings added.
Field What to enter
Voice platform API key Your voice platform API key. Vodial keeps it encrypted, shows it once and never shows it again.
Agent id The id of your agent: 32 letters and digits, 0-9 and a-f.

A good test shows the agent’s name, its live version and when it was published, then “Any change you publish is live on the next call.” If the key is refused, Vodial says the voice platform did not accept it. Check it in your voice platform’s workspace settings.

Field What to enter
How calls reach the agent Your VICIdial or Vodial’s own lines. See VICIdial dials, your agent answers and Vodial’s own lines.
Agent line number A number such as +15551234567 that names your agent on the voice platform’s side. Nobody dials it on the phone network: VICIdial or Vodial dials it over SIP. Use a number you own. A line cannot be renamed: once it is set up, changing this number is refused. Keep it, or remove the old line on your voice platform and apply again.
Allowed addresses The IP addresses your voice platform accepts calls from, up to 32. For VICIdial, the public IP of your VICIdial server. For Vodial’s lines it is filled in.
Termination host VICIdial only. host or host:port of your VICIdial: where the agent sends a call it hands over. Optional: cold hand-overs work without it.
VICIdial connection VICIdial only. The VICIdial connection that finds the lead and receives the status.
Campaign The campaign these calls belong to.

Every journey, fact, result and report in Vodial belongs to a campaign, so the connection names one. It is an AI-only campaign whose first step is your voice agent. An organisation has one voice agent connection. Press Create one for me to make the campaign. For your VICIdial it is called {agent name} via VICIdial and stays paused, because Vodial never dials it. For Vodial’s lines it is called {agent name} on Vodial lines, and you start it when you are ready.

Enter the closer’s phone number, a label, and warm or cold. A closer is optional. Without one, your agent has no transfer tool. The number must ring your closers: a number that reaches a VICIdial in-group, or a Vodial number routed to a queue.

  • Cold: the agent asks the phone system to pass the caller to that number, and leaves.
  • Warm: the agent rings that number and joins the caller when they answer.

Your VICIdial can use either, and cold is the default. On Vodial’s lines the hand-over is always warm. The wizard sets it and says why.

The wizard shows the two web addresses Vodial will give your agent, ending in /init and /event. The first says a call is starting. The second says what happened when it ended.

Apply to your agent does these in order, and skips what is already right:

  1. Creates or updates the phone line for your agent.
  2. Writes the two addresses, a secret Vodial made itself, and the closer into your agent’s draft. You never copy a secret.
  3. Publishes, only when nobody has unpublished edits. Vodial publishes the exact draft it checked, so if a teammate edits the draft while Apply runs, the publish is refused and Vodial leaves your teammate’s edits unpublished and says so.

Your voice platform keeps a draft of your agent and a published version. Callers get the published version. Publishing puts the whole draft live.

Vodial writes its settings into the draft. If someone on your team has half-finished edits there, publishing would put those live too. So Vodial checks first. If the draft equals the published version, it publishes. If not, it stops and asks: “Your agent has unpublished edits (draft ≠ v79). Publish them too?”

  • Confirm publishes the draft, your team’s edits included.
  • Not now leaves Vodial’s settings in the draft. Publish when you are ready, then press Apply to your agent again.

Two other answers you may see. “An apply is already running for this connection” means another Apply on the same connection has not finished: wait a moment and press Check again on the card. “Other voice agent connections are being applied right now. Try again in a moment.” means Vodial limits how many applies run at once: press Apply to your agent again.

The card shows the live version, whether your agent tells Vodial how each call went, the line, the closer, the campaign and the last call. Under it, Recent calls lists each call and what happened to it. See test and troubleshoot.