VoiceOI

Build your bots

Live transfers and notes for your closers

A VoiceOI bot transfers a qualified call by writing notes for the closer into the lead and then handing the live call to the destination you set, over SIP on VICIdial®. The bot does not stay on the line to introduce the caller, and your dialer, not VoiceOI, decides which closer answers. This page covers the two transfer methods that work on VICIdial, the notes for the closer, the closer dialer, and the Closer Hub screens and rules.

Applies to:Every account

Last checked against the product: . Found a mistake? Tell us.

How does a transfer to a closer work?

Before a transfer, the script plays the closing line you put in front of it. The transfer then writes the notes for the closer, sends the hand-off and ends the bot’s side of the call. Warm transfer here means a hand-off with notes: the bot does not stay on the line to introduce the caller (see Live transfer). The pre-recorded voice bot, the AI fronter and the AI junior closer transfer. The AI lead gen bot does not.

  1. The script reaches the transfer

    VoiceOI team

    A Transfer Call step, or the Handoff setting of an AI Voice Agent, starts it. The caller hears your closing line first. On the bot servers for VICIdial, a step with no destination sends no hand-off and ends the call, so the caller is hung up: see The destination.

  2. The notes are written

    VoiceOI team

    VoiceOI tries to write the notes into Comments on the lead. With no lead ID, no notes or a failed write, the transfer goes ahead anyway. See notes for the closer.

  3. The hand-off is sent

    VoiceOI team

    VoiceOI asks VICIdial through its API to move the call, or sends a SIP REFER to your Asterisk, and the bot leaves the call. The status, XFER unless the step sets another, is written through the transfer. See Which transfer method should I use?.

  4. Your dialer routes the call

    You

    Your dialer sends the destination to an in-group, the VICIdial queue your closers answer, and VICIdial picks which ready closer gets the call. If none is ready, nobody answers. Hold audio, waiting time and whether Comments shows on the closer’s screen are VICIdial settings. See VICIdial transfers.

Which transfer method should I use on VICIdial?

Use the Native API method or the REFER method, the two that the bot servers for VICIdial carry out. Either way, the call reaches your closers through the destination you enter.

TopicViciDial Native API Transfer (Instant Release)SIP Blind Transfer (REFER)
What VoiceOI doesAsks VICIdial, through its API, to move the call. If it cannot work out the bot’s line or the lead, it sends a REFER instead.Sends a SIP REFER to your Asterisk, which sends the call to the destination. It can also send a follow-up transfer request to VICIdial: see The closer hears a second call.
If it failsNo SIP code comes back. The call does not arrive.Your dialer answers with a SIP error.

A new Transfer Call step starts on SIP Blind Transfer (REFER), and the AI Voice Agent editor starts on ViciDial Native API (instant release). The VoiceOI team sets the method with you. “Instant Release” frees the bot’s line in VICIdial. It does not mean the closer answers sooner.

The other modes in the Transfer Mode list, such as Direct Exten Transfer and Carrier Bridge (Compatible), are built for the built-in dialer’s Asterisk engine. A VICIdial bot server carries them out as a plain SIP REFER. Direct IP to IP and ViciDial AXFER (Native) hide the destination box, so a step that uses them usually has no destination: the script ends and the caller is hung up. Choose SIP Blind Transfer (REFER) instead.

The destination

The destination is a number or extension that your dialer routes to your closers’ in-group. The VoiceOI team tells you what to enter in Dialplan Extension or Target Number, Destination Phone Number or Transfer target. On the bot servers for VICIdial, a Transfer Call step with no destination sends no hand-off and writes no notes. The script ends and the caller is hung up, so check every transfer step. On the built-in dialer, an empty destination skips the transfer and the call follows the node’s next line, if one is connected.

How do I set up a transfer in the Script Builder?

  1. Put a closing line before the transfer

    You

    Add a Play Audio step before Transfer Call with a short line that tells the caller they are being connected. Clean up with AI runs while it plays. With nothing before the transfer, the AI gets 0.8 seconds at most.

  2. Add the step and choose the mode

    You

    Add a Transfer Call step, connect the step before it to it, and connect nothing after it. Under Transfer Mode, pick ViciDial Native API Transfer (Instant Release) or SIP Blind Transfer (REFER).

  3. Enter the destination, notes and status

    Both

    Enter the number or extension the team gave you, and add the details the closer needs under Notes for the closer (see the next section). The step logs XFER unless you choose another status in Vicidial Disposition; VICIdial drops a status that is not on the campaign’s list, so ask the team first.

  4. Save, sync and test

    Both

    Press Save Flow, then Force bot sync on Integrations. Then follow How do I test a transfer?.

AI Voice Agent: the Handoff tab

In the AI Voice Agent editor, Transfer to a closer on the Handoff tab transfers the call and logs XFER. Its Transfer method list starts on ViciDial Native API (instant release) and also offers Direct extension transfer, Carrier bridge (compatible) and SIP blind transfer (REFER). On VICIdial use the first or the last of these.

What are notes for the closer, and where does the closer see them?

Notes for the closer are a short text that VoiceOI writes into the Comments field of the lead in VICIdial before the hand-off. Comments holds 255 characters, and the notes replace what was there. If VICIdial refuses the write, the transfer goes ahead and the closer may see an older note or none. In a Classic Call Flow script you set the notes in Notes for the closer on the Transfer Call step. In an AI Voice Agent, the agent writes them from the whole conversation, following the instruction in Comments on the Handoff tab. That text is cut at 255 characters, even mid-word, so ask for the key facts first.

Notes in the Script Builder

  • Add detail. Type a label of up to 40 characters, such as Age, or pick a suggestion under Add from this script. Each Transfer Call step can have up to 8 details.
  • Answer from. Pick the question. Add a re-ask adds the same question asked again: the latest answer wins.
  • Read as. Choose Age, Zip code, Name, Yes / No, Number, Coverage type or Their words.

The notes read like Age: 67 | Zip: 33101, first detail first, and a detail with no answer is left out. Over 255 characters, VoiceOI shortens long free-text answers first, then drops whole details from the end, so put the details the closer needs most at the top. See The notes are cut off and The closer sees no notes.

Clean up with AI

The switch Clean up with AI fixes misheard answers while your closing line plays, for example “jon smith” to John Smith. It keeps only a fix the caller’s own words support. With a closing line before the transfer it does not hold the transfer up, and with none it waits at most 0.8 seconds. If the AI is late, the notes go out without it. When it is on, the caller’s answers go to VoiceOI’s AI, as the help text beside the switch says.

Can the notes also go to a separate closer dialer?

Yes, if your closers work on a different VICIdial from the one the bots dial from. Turn on Also send the notes to a closer dialer on the Transfer Call step. VoiceOI then writes the same notes into Comments of the lead with the caller’s phone number on that dialer. The call still goes to your destination.

  • Connection. It uses the Closer dialer connection on Integrations, which the VoiceOI team sets up with you, including the address your closer dialer must allow. Keep one connection active: with more, only one receives the notes and you cannot choose which.
  • Timing. The push starts with the transfer, so a closer dialer can receive notes for a hand-off that your dialer then refuses. A failed push does not stop the transfer.
  • Matching. VoiceOI looks for the lead by phone number and adds one if there is none, in List for new leads (optional) on the step, else the one on the connection, else list 999. It needs at least 10 digits and sends them with country code 1.

Test connection changes nothing on the dialer. It checks that the dialer answers and that the API user may update leads (the check is named Can add the caller’s details to leads). If you enter a list for new leads on the connection, it also checks that the list exists.

What is Closer Hub, and what do its screens and rules do?

Closer Hub holds rules that are meant to decide which step of a script a call goes to, by the caller’s age and state, when a Matrix Router step runs. It belongs to the AI junior closer. The VoiceOI team turns it on per organization, and SubManager logins do not get it in the sidebar. A rule names a script step, usually a Transfer Call step, not a closer: your dialer decides which closer answers. The Simulator does not run the routing steps.

The routing steps in the Script Builder

StepWhat it is forSettings
Age ExtractionReads an age from the answer to its audio prompt. With Understand spoken ages on, it understands words (“sixty five”) and birth years. With it off, it picks up only a number from 18 to 99.Max Retries, Success Route (Age Extracted), Failed / Else Route
ZIP ResolverIs meant to replace the state taken from the phone’s area code with the state of the ZIP code on the lead, not a ZIP the caller says.None
Matrix RouterIs meant to compare the age and state with the campaign’s active rules and go to the target step of the winning rule.Fallback Route (No Rules Match)

How do Matrix Rules and Targeting Lists work?

These rules only matter if your bot servers run the Matrix Router step. Ask the VoiceOI team first: see the warning in Closer Hub.

Rules belong to a campaign. Under Script Settings (the gear icon), Assigned Campaign must name the campaign the script runs in; ask the team which one. Until it does, the Matrix Router shows “This script is not assigned to any campaign.” In Closer Hub, Targeting Lists holds ZIP lists (a List Name, a Priority Level from 1 to 10 and the ZIP Code Entries), and Matrix Rules holds the rules for the campaign you pick under Select Campaign.

FieldWhat it does
Min Age and Max AgeThe rule fits callers from the minimum to the maximum age, both included.
Link Custom ZIP/State List (Optional)Limits the rule to the ZIP codes in a targeting list. Allowed States and Excluded States are then hidden, but any Excluded States already set still apply. Unlink the list to see them.
Allowed States, All States and Excluded StatesThe states the rule fits. An empty Allowed States list with All States off still fits every state, although the table shows None. Excluded states are never fit.
Target Node (Where to route)The step the call goes to when the rule wins. The dialog says “No nodes found. Please assign a script to this campaign first” until the campaign has a script.

How a rule is picked

When a Matrix Router step runs, it works through the rules in this order.

  1. Only Active rules count, not Paused ones. A rule is skipped when the caller’s state is in its Excluded States, even if a ZIP list is linked.
  2. With a ZIP list linked, the first 5 digits of the lead’s ZIP must be in that list exactly, so keep leading zeros, for example 02134. Allowed States are then not used. With no list, the caller’s state must be in Allowed States, or All States must be on.
  3. The caller’s age must be from Min Age to Max Age. A caller with no confirmed age counts as age 0.
  4. Of the rules that fit, the lowest Priority Level number wins. If two share a number, the rule created first wins.
  5. If no rule fits, the call goes to Fallback Route (No Rules Match), or ends if No Connection (Hangup) is chosen.

How do I test a transfer?

The Simulator (Text Simulator (Dry Run)) checks the conversation and shows the notes on the Notes for the closer card. It transfers nothing and writes no status. Live test calls check the hand-off, the notes and the status.

  1. Set up a test list and a closer

    You

    Put leads with numbers you control in a test list on your dialer, and let the campaign dial only that list. Have one closer signed in and ready in the destination’s in-group.

  2. Answer and check the closer’s side

    You

    Give answers that pass the script. The caller and the closer should hear each other, the lead’s Comments should show the notes, and VICIdial should show XFER or the status the step sets.

  3. Check Call Logs and the closer dialer

    Both

    Open Call Logs (titled Interaction Logs) and expand the call. Transferring names the destination, but it shows a transfer attempted, not completed. With a closer dialer, read Comments on the lead with your test number there.

What if a routing step or the closer push does not work?

The call ends when it reaches the ZIP Resolver or the Matrix Router

Likely cause

If the bot server that took the call does not run a routing step, the call ends there and the caller is hung up, instead of going to the fallback.

How to check

In Call Logs, press Show System Nodes. If ZIP Resolver or Matrix Router is the last step listed, that is the likely cause.

How to fix it

Connect the qualified path straight to a Transfer Call step, and ask the VoiceOI team whether your bot servers run the routing steps.

Still stuck

The time of the call (with time zone), the lead ID, the campaign and the script name.

The closer dialer gets no notes

Likely cause

The switch Also send the notes to a closer dialer is off on that step, or the connection is missing, inactive or incomplete.

The closer dialer refused the request: the API user cannot add leads, or VoiceOI’s server is not allowed through its firewall.

The phone number has fewer than 10 digits, or the notes were empty.

How to check

Press Test connection on the Closer dialer connection on Integrations. Each failed check names what to fix.

How to fix it

Fix what Test connection names, or ask the team for the address to allow, then place a new test call.

Still stuck

The time of the transfer (with time zone), the caller’s phone number, the step name, and what Test connection reports.

Common questions

Does the VoiceOI bot stay on the line to introduce the caller to the closer?

No. The bot writes notes for the closer into the lead, hands the live call to your dialer and leaves the call. The closer reads the notes in the lead’s Comments field.

Which transfer method should I use with VICIdial?

Use ViciDial Native API Transfer (Instant Release) or SIP Blind Transfer (REFER); the VoiceOI team sets the method with you. Do not use the other modes on a VICIdial bot server: most are carried out as a plain SIP REFER, and the two that hide the destination box, Direct IP to IP and ViciDial AXFER (Native), usually leave the step with no destination, so the script ends and the caller is hung up.

Where does the closer see the notes, and are they added to what is already there?

In the Comments field of the lead in VICIdial. Comments holds 255 characters, and the notes replace what was there, so do not keep your own text in that field on leads the bots call.

Does the AI junior closer close the sale?

No. Your human closers make the sale. The bot qualifies the caller, writes notes for the closer and hands the live call to your dialer, which decides which closer answers. It does not check that a closer is licensed for a state.

Does Closer Hub routing by age, state and ZIP work with VICIdial?

Ask the VoiceOI team before you build a flow that depends on it. The routing steps, ZIP Resolver and Matrix Router, are evaluated by the bot server, so the team must confirm that your bot servers run them and that the lead’s ZIP reaches VoiceOI.

What happens if a Transfer Call step has no destination?

No hand-off is sent and no notes are written. On the bot servers for VICIdial the script ends at that step and the caller is hung up, so check that every transfer step has a destination. On the built-in dialer, an empty destination skips the transfer and the call follows the node’s next line, if one is connected.

Related

VICIdial is a registered trademark of the Vicidial Group. VoiceOI is an independent product and is not affiliated with or endorsed by the Vicidial Group. Asterisk, Twilio and other product names are trademarks of their respective owners.

Questions about your setup? Talk to the VoiceOI team.