Caller journey / IVR builderAll pages
Caller journey

IVR builder

Design what callers hear and where they go, block by block, on a canvas. A flow can ask for a CNIC, check it with your bank's system, read back a balance and hand the caller to the right desk, without a line of dialplan.

Numbers
8100–8199 per organization
Blocks
24, in 5 groups
Goes live
On Publish, no reload
Who can edit
Organization Admins

How a flow works

A flow reads from top to bottom, like a phone tree. Every call enters at the Incoming call block and follows the connections from there. Each block shows its outputs as tabs along its bottom edge: a Menu has one tab per key plus No key and Wrong key, a Business hours block has Open and Closed, and so on. Drag from a tab to the next block to connect it. An output takes one connection; drawing a new one replaces the old.

Here is the Debit card activation template, simplified. The caller identifies with CNIC and T-PIN, your card system checks them, and the caller sets a new ATM PIN. Notice that every failed check leads to a person.

NextEnteredNo inputnot_verifiedokEnteredoknot_foundEnteredfailedokIncoming callnumber 8105CNIC, T-PINCollect digits ×2Verify callercustomer.verifyOfficersCall queueCard last 4Collect digitsActivate cardcard.activateNew PIN ×2sensitive inputCard servicesCall queueSet ATM PINcard.set_pinPIN setSay, then Hang up
Card activation: the main path runs down the middle; failures branch to the queues at the sides.

Outputs you leave unconnected

The editor will not publish a flow while an important output is open: every menu key, every answer of a check, both sides of a Compare. Some outputs may stay open, and then this happens:

Output left openWhat the caller gets
Menu: No key, Wrong keyThe menu is replayed as many times as you set under Replay the menu, then the call ends. Connecting these outputs back to the same menu does the same.
Collect digits, Ask for a rating: No / wrong input, No ratingThe prompt is asked again as many times as you set, then the call ends.
Dial an extension: No such extensionThe call ends.
Check with your system, Call an API, Run code: error, Any other answer, Code failedThe call ends.
Ring group (custom list), Forward: No answerThe call ends.

Shortcuts in the editor: Ctrl/⌘ + S saves, Ctrl/⌘ + D duplicates the selected block, and Tidy up lays the whole flow out top to bottom again.

Draft, publish and test

A flow has two versions. The draft is what you see in the editor; saving it never affects callers. The published version is what callers hear. Only an organization Admin can create, edit, publish or delete a flow.

  1. Create the IVR

    Open IVR menus (under Configure) and choose New IVR. Pick a template (or Blank), a name and a free number from 8100 to 8199. Templates ask which queue each desk should use; see Start from a template below.

  2. Edit and save the draft

    Drag blocks from the palette, connect their outputs and fill in each block in the panel on the right. The to fix button in the toolbar lists everything that stops the flow from being published; when it shows Ready, every caller ends up somewhere.

  3. Publish

    Publish saves the draft, checks it again, checks that every extension it rings or sends to voicemail exists, generates the voice prompts and replaces the live version in one step. The message Live on 8105. Calls use the new flow right away. confirms it.

  4. Make a test call

    Test call opens the browser phone and dials the IVR's number. It is available once the flow is published and has no unsaved changes, so you always test exactly what callers get.

  5. Point a phone number at it

    In Numbers, set a phone number's destination to the IVR (listed under Dashboard IVRs). Staff can also dial 81xx from any desk phone or browser, and another flow can jump to it with Go to another IVR menu.

Take offline (in the toolbar's menu) removes the live version but keeps the draft; calls to the number stop working until you publish again. Delete IVR removes both. Every publish and delete is written to the audit log.

Start from a template

Templates are complete, working flows built from how Pakistani banks, microfinance banks, hospitals, labs and universities run their phone lines. The banking ones follow the State Bank of Pakistan's call-centre rules (BPRD Circular 04 of 2025, section 5.3): card blocking is the first option, callers are told the call is recorded, and OTPs are only ever entered on the keypad.

TemplateWhat callers get
Customer support lineRecording notice, office hours, then sales, support and billing desks. 0 for the operator, * to repeat. After hours: message or AI assistant.
Business hours lineOpen: the team or the AI assistant. Closed: hours are announced and the caller can leave a message.
AI receptionistA recording notice, then your AI agent answers every call, day and night.
Bank phone bankingLost or stolen card first, card services with self-service activation and PIN, balance after CNIC and T-PIN, T-PIN by OTP, complaints. 24/7.
Debit card activation & PINCNIC, T-PIN, the card's last 4 digits, then a new 4-digit ATM PIN entered twice. Any problem goes to card services.
Microfinance bank / walletBlock account, card or wallet first, transaction issues, loan instalment and balance by CNIC or loan number, complaints. 24/7.
Hospital main lineEmergency first, appointments by MR number, doctor schedules by specialty, cancel or reschedule, lab reports, billing and panels. 8 am to 8 pm, emergency 24/7.
Diagnostic labReport status by lab number, home sample collection, test prices and preparation. 24/7.
UniversityAdmissions with application status, fees with challan status, examinations, registrar, IT helpdesk, operator. Monday to Friday 9 to 5, messages after.
BlankAn empty canvas with only the Incoming call block.

Desks, mailboxes and time zones

  • Desks. Each template names the desks it sends callers to (Card services, Appointments, Admissions office …). For each desk you pick one of your queues, or let the dashboard create a new one: Round robin, 20 s per agent, 5 s wrap-up, position announcements on, and you as its first agent. Priority desks get a service-level target: Card blocking and Blocking 60 s, Emergency department 20 s.
  • Mailbox. Templates that take messages use the voicemail box you choose (by default your own). New desks fall back to that mailbox when nobody answers.
  • Time zone. Business hours blocks use the organization's time zone from Organization settings, else the platform's.
  • Language. Prompts are in English. To offer Urdu, record Urdu prompts in Sounds and choose them in the Say and Menu blocks.

Self-service actions the templates use

Self-service steps use Check with your system blocks. Connect your system through the Self-service API and answer these actions; until then, each one takes its error path to a person.

ActionSendsResults
customer.verifycnic, tpinok, not_verified, locked
card.activatecnic, card_last4ok, not_found, already_active
card.set_pincnic, card_last4, pin, pin_confirmok, mismatch, failed
account.balancecnicok (with the balance to speak)
tpin.send_otpcnicok, not_found
tpin.setcnic, otp, new_tpin, tpin_confirmok, mismatch, failed
loan.balanceloan_refok, not_found
schedule.medicinenothing (also .surgery, .gynaecology, .paediatrics)ok (with the schedule to speak)
lab.report_statuslab_numberready, pending, not_found
admission.statusapplication_nook, not_found
fee.statusstudent_idpaid, unpaid, not_found

Block reference

Every block in the palette, in the palette's order. Outputs are the tabs on the block. Before you can publish lists what the editor checks; until it holds, the block appears under to fix. Every block also has an optional Block name, shown on the canvas and in the to-fix list.

Speak & ask

Blocks that play something to the caller or wait for keys. Every prompt is either typed text, spoken by your speech service when you publish, or a recording from Sounds.

BlockWhat the caller experiencesOutputsBefore you can publish
SayHears a message (a welcome, a recording notice, an explanation), then the flow moves on.NextText or a sound; Next connected.
MenuHears the options and presses one key. Keys 1–9, 0 and * can each have an output (# is not offered: it ends keypad input). Waits 2–20 s for a key (default 6) and replays the menu 0–5 times (default 2) when nothing or a wrong key is pressed.Press 1, Press 2 … ; No key ; Wrong keyA prompt; at least one key; every key connected.
Collect digitsTypes a number: an exact length (4 PIN or T-PIN, 6 OTP, 11 mobile, 13 CNIC, 16 card) or a range of 1–20 digits, finishing with # or after the last digit. The value is stored under the name you give it. Waits 3–30 s (default 10) and asks again 0–5 times (default 2). Turn on Sensitive for a PIN, T-PIN or OTP: the call recording is muted while the caller types.Entered ; No / wrong inputA prompt; a name in lowercase letters, digits and _ that no other Collect digits block uses; 1–20 digits; Entered connected.
Dial an extensionTypes a colleague's extension (3 to 6 digits, first digit 1–7) and is put through to that person, as a company directory does. Only extensions of your own organization are rung.No such extensionA prompt.
Ask for a ratingPresses one key from 1 to 5. The rating is stored with the call and the average shows in Analytics as Caller rating. Waits 3–30 s, asks again 0–5 times (default 1).Rated ; No ratingA question; Rated connected.
PauseHears 1 to 30 seconds of silence (default 2).Next1–30 seconds; Next connected.

Route

Blocks that decide where the call goes without asking the caller anything.

BlockWhat the caller experiencesOutputsBefore you can publish
Business hoursNothing. The call goes one way during opening hours and the other way when closed, including on the holiday dates you list. See Business hours and holidays below.Open ; ClosedAt least one day; Open and Closed connected.
Check caller numberNothing. The caller's number is matched against up to 6 patterns, in order; the first match wins. See Caller number rules below.One per pattern ; Any other caller1–6 valid patterns; every pattern and Any other caller connected.
Go to another IVR menuContinues in another published IVR menu of your organization, from its Incoming call block.NoneA menu number 81xx other than this one. The editor lists only published menus.

Your systems

Blocks that talk to your own software or work with variables. Call an API, Run code, Set a variable and Compare run on the dashboard, not in the phone system; see the sections further down.

BlockWhat the caller experiencesOutputsBefore you can publish
Check with your systemNothing, unless your system returns a sentence to speak. The block sends an action (such as card.activate) and the digits collected earlier to your Self-service API, then follows the result it answers with.One per result (up to 6) ; No answer / errorAn action in lowercase (e.g. card.activate); 1–6 unique results; only variables a Collect digits block stores; every result connected.
Call an APINothing, or a sentence taken from the API's answer. Sends GET, POST, PUT, PATCH or DELETE to any https:// address and branches on the JSON it gets back.One per answer rule (up to 6) ; Any other answer ; Failed / timed outAn https:// URL; timeout 2–15 s; up to 8 headers; body up to 2,000 characters; up to 8 saved values; every answer connected; every {{placeholder}} provided by a block.
Run codeNothing, or one sentence the code speaks. A few lines of JavaScript read the call's variables, set new ones and pick the output.The outputs you declare (up to 6), or Next ; Code failedCode of up to 4,000 characters; unique output names; every output connected.
Set a variableNothing. Stores a fixed text, other variables or a small calculation under a name.NextA valid name; a value; Next connected.
CompareNothing. Compares a variable with a value or another variable and takes Yes or No.Yes ; NoA variable the flow has; a comparison; a value (except for is empty); a valid pattern for matches; Yes and No connected.
Tag the callNothing. Adds one of your call tags (for example Card blocked) to the call, so agents see why the caller called and Analytics can count it.NextA tag of up to 40 letters, digits, spaces and _ & / -; Next connected.

Connect the caller

Blocks that hand the caller to a person, a team, an AI agent or an app.

BlockWhat the caller experiencesOutputsBefore you can publish
Call queueWaits in a call queue (82xx) with music, position announcements and the queue's own welcome, until the next free agent answers. The queue's own maximum wait and fallback apply.NoneA queue.
Ring extensionRings one person on every phone and browser they are signed in on, following that person's own call handling (do not disturb, forwarding, ring time), then reaches their voicemail.NoneAn extension that exists.
Ring groupEither a saved ring group (83xx), which keeps its own order, ring time and fallback, or a custom list of extensions that all ring together for 5–90 s.No answer (custom list only)A saved group, or at least one extension that exists.
Forward to an outside numberIs connected to a mobile, a branch or a partner, dialled through your organization's own carrier. Rings for 10–120 s (default 30).No answer / busyA number of 3–20 digits, with an optional +.
AI agentTalks to one of your AI agents (80xx) for the rest of the call, or to the organization's default agent when none is chosen.NoneNothing.
Offer a callbackHears your confirmation. The caller's number becomes an Inbox item (Asked for a callback) for the team, and the webhook call.callback_requested fires.NextThe confirmation to speak; Next connected (usually to Hang up).
AppIs connected to a built-in app: echo test (8000), music on hold (8003) or the conference room (8004).NoneNothing.

Finish

Blocks that end the call.

BlockWhat the caller experiencesOutputsBefore you can publish
VoicemailHears the mailbox greeting (the person's own from Sounds, else the organization's default, else the standard one), leaves a message, and the call ends.NoneA mailbox (extension) that exists.
Hang upThe call ends, optionally after a 5-second busy tone.NoneNothing.

Variables and placeholders

A variable is a value the flow keeps for the rest of the call. Variables come from four blocks: the digits of a Collect digits block, the value of a Set a variable block, the values Call an API keeps from an answer, and the values Run code sets. Two more always exist: caller (the caller's number) and call_id (the call's id).

  • Names are 1–24 lowercase letters, digits and _, starting with a letter: cnic, card_last4, mr_number.
  • Lifetime. Variables live on the phone server for the duration of the call and are never written to the database. A block receives only the variables it actually uses.
  • Sensitive input. A Collect digits block marked Sensitive mutes the call recording while the caller types, and its value is not copied to the phone of the person the caller is later connected to. It only goes to the blocks that use it.
  • Never logged. Values can be a PIN or a balance, so none of the IVR endpoints write them to a log.

Placeholders

Write {{name}} in a URL, a header, a JSON body, a Set a variable value, a Compare value or an answer rule, and it is replaced with the variable's value when the block runs. Helpers change the value on the way in:

PlaceholderGivesExample with card = 4111222233334821
{{card}}The value as it is4111222233334821
{{last(card, 4)}}The last n characters (1–50, default 4)4821
{{first(card, 6)}}The first n characters (1–50, default 4)411122
{{length(card)}}The number of characters16
{{digits(x)}}Only the digits+92 300-1234567 → 923001234567
{{upper(x)}}Upper caseok → OK
{{lower(x)}}Lower caseOK → ok

A placeholder for a variable no block provides is reported under to fix (in Call an API), or becomes empty text. Placeholders are inserted as they are into a URL, without URL encoding: digits from Collect digits are always safe, and {{digits(x)}} keeps other values safe too.

Call an API

Call an API connects a flow to any HTTPS API you run: a core-banking gateway, a hospital information system, a student portal. It sends the call's variables, keeps parts of the JSON answer as new variables, can read one sentence of the answer to the caller, and picks its output from rules you define.

CallerCallerPhone systemPhone systemDashboardDashboardYour APIYour APItypes CNIC and card digitsCollect digits blocks1GET /api/internal/ivr-oploopback only, with the variables2loads the PUBLISHED block, fills in {{placeholders}}POST /v1/cards/activateyour headers and JSON body4200 OK + JSON5keeps values, checks answer rules in order, voices the sentenceok | values | audio file7plays the sentencethen follows the output ok8
One Call an API block during a live call. The phone system never parses JSON; the dashboard does it on the same server.

Settings

Call an API block

MethodGET | POST | PUT | PATCH | DELETE
A body is sent only with POST, PUT and PATCH.
URLhttps:// onlyrequired
May contain placeholders. Addresses on private networks are refused unless the installation sets WEBHOOK_ALLOW_PRIVATE=yes (on-premises). Redirects are not followed: a 3xx answer counts as failed.Example: https://api.yourbank.example/v1/cards/{{card_last4}}?cnic={{cnic}}
Headersup to 8
Name and value; values may contain placeholders. Press the lock to store a value (an API key, a bearer token) encrypted: it is sent on every call and never shown again, and placeholders inside it are not filled in. Accept: application/json, text/plain;q=0.8 is always sent, and Content-Type: application/json when there is a body and you set none.
JSON bodyup to 2,000 characters
Placeholders inside quotes are inserted as JSON strings, so a value with a quote or a backslash cannot break the document.
Wait at most2–15 s, default 5
Then the call follows Failed / timed out. See the warning below about live calls.
Keep from the answerup to 8
A JSON path and a variable name. Paths use dots and indexes, up to 10 levels: status, data.balance, data.items[0].name. Objects are kept as JSON text; every value is cut at 2,000 characters.
Answers (outputs)up to 6 rules
Each rule has a name (its output), a path, a comparison (equals, contains, is greater than, is less than, exists) and a value that may contain placeholders. Rules are checked in order and the first that holds is the output taken. Numbers compare as numbers. exists means the path has a non-empty value.
Speak from the answerJSON path, optional
The text at this path (up to 400 characters) is voiced and played to the caller before the block moves on.

Which output the call takes

The API…Output
answers 2xx and one of your rules holdsThat rule's output (the first that holds)
answers 2xx and no rule holdsAny other answer
answers with any other status, cannot be reached, or is too slowFailed / timed out

Example: activate a debit card

A bank's activation endpoint takes the CNIC and the card's last four digits. The block is set to POST, with this body and a secret Authorization header:

JSON body (in the block)JSON
1{2  "cnic": "{{cnic}}",3  "card_last4": "{{card_last4}}",4  "channel": "ivr",5  "caller": "{{caller}}",6  "reference": "{{call_id}}"7}
What your API receivesHTTP
1POST /v1/cards/activate HTTP/1.12Host: api.yourbank.example3Accept: application/json, text/plain;q=0.84Content-Type: application/json5Authorization: Bearer <secret header, decrypted only for this request>6 7{"cnic":"3520212345671","card_last4":"4821","channel":"ivr","caller":"+923001234567","reference":"1731670000.42"}
Your API answersJSON
1{2  "status": "ok",3  "data": {4    "card": { "state": "active", "last4": "4821" },5    "attempts_left": 2,6    "message": "Your card ending 4821 is now active."7  }8}
Block settingValueResult for this answer
Keep from the answerdata.attempts_left → attempts_leftattempts_left = 2
Answer rule 1active: data.card.state equals activeHolds: output active
Answer rule 2blocked: status equals blockedNot checked (rule 1 held)
Speak from the answerdata.message“Your card ending 4821 is now active.”

Test without a call

Run now, under the block's settings, runs it with sample values you type for its variables and shows the output, the values it kept and what it would speak. It really calls the API, with caller set to +923001234567 and call_id to test, and waits up to 15 seconds.

Run code

When a rule is too fiddly for Compare blocks, write it in a few lines of JavaScript. The code runs on the dashboard in a sealed sandbox with the call's variables, and decides the output.

What the code can use

varsobject, read-only
Every variable of the flow, as text ("" when not set). Use Number(vars.amount) to calculate.
caller, call_idstring
The caller's number and the call's id.
go(name)function
Chooses the output. The name must be one you declared under Outputs. The last call wins and the code keeps running, so return after it. Without any go(), the first declared output (or Next) is taken.
set(name, value)function
Stores a variable for later blocks. Only names declared under Variables it may set. Objects are stored as JSON; values are cut at 2,000 characters.
say(text)function
One sentence (up to 400 characters) voiced and played to the caller. The last call wins.
log(...values)function
Up to 20 lines, shown only by the Test button.
Built-insglobals
Math, JSON, Number, String, Boolean, Array, Object, Date, RegExp, parseInt, parseFloat, isNaN, isFinite. Nothing else: no require, fetch, process, console, timers, files, and no eval or new Function.

Example: check and mask a CNIC

Run code · Validate CNICJavaScript
1// Outputs: valid, invalid        Variables it may set: cnic_masked2const cnic = vars.cnic            // every variable arrives as a string ("" when not set)3 4if (!/^\d{13}$/.test(cnic)) {5  go("invalid")6  return                          // go() does not stop the code: return after it7}8 9set("cnic_masked", cnic.slice(0, 5) + "-xxxxxxx-" + cnic.slice(-1))10log("masked", cnic.slice(-1))     // shown only by the Test button11go("valid")

Example: route by instalment status

Run code · Instalment dueJavaScript
1// After a "Call an API" block that saved due_days and amount from your loan system.2// Outputs: overdue, due_soon, ok   Variables it may set: amount_text3const days = Number(vars.due_days)4const amount = Number(vars.amount)5 6if (!Number.isFinite(days) || !Number.isFinite(amount)) {7  go("ok")8  return9}10 11const text = String(Math.round(amount)).replace(/\B(?=(\d{3})+(?!\d))/g, ",")12set("amount_text", text)13 14if (days < 0) {15  say("Your instalment of " + text + " rupees is " + -days + " days overdue.")16  go("overdue")17} else if (days <= 3) {18  say("Your instalment of " + text + " rupees is due in " + days + " days.")19  go("due_soon")20} else {21  go("ok")22}

Limits

LimitValue
Code length4,000 characters
Run time100 ms of CPU; the code runs in strict mode, wrapped in a function (so return works)
OutputsUp to 6 declared names, lowercase letters, digits and _, plus Code failed
Variables it may setUp to 8
Values2,000 characters each; say() 400 characters

Set a variable and Compare

Set a variable

Stores a value under a name. The value can be fixed text (blocked), placeholders ({{last(card, 4)}}) or arithmetic. Once the placeholders are filled in, a value made only of numbers, + - * / % and brackets is calculated: {{attempts}} + 1 or ({{amount}} * 105) / 100. Anything else stays text. Results keep at most six decimals.

Compare

Compares one variable with a value (placeholders allowed) and takes Yes or No.

ComparisonYes when
equals / does not equalThe values are (not) the same. Two numbers compare as numbers, so 10 equals 10.0.
contains / starts withThe variable contains, or starts with, the value.
is greater than / is less thanAs numbers when both are numbers (10 is greater than 9), otherwise in alphabetical order.
is emptyThe variable has no value (or only spaces). Takes no value.
matches the patternThe variable matches a regular expression, for example ^03[0-9]{9}$ for a Pakistani mobile number.

Example: three tries, then a person

  1. Set a variable attempts = 0, right after Incoming call. Start counters at 0: an empty variable plus 1 is not a number.
  2. Collect digits stores tpin; Check with your system verifies it.
  3. On not_verified: Set a variable attempts = {{attempts}} + 1.
  4. Compare attempts is less than 3: Yes goes back to Collect digits, No goes to the Phone banking officers queue.

Business hours and holidays

A Business hours block has opening days (Monday to Sunday), a from and to time (09:00 to 17:00) and a time zone such as Asia/Karachi. On an open day between those times the call takes Open; otherwise Closed.

  • Holidays are dates (Eid, Independence Day, a campus closure) on which the block is closed all day. They are checked first, in the block's own time zone.
  • Different hours on different days, for example a hospital's desk open Monday to Saturday but shorter on Saturday: chain two blocks. The first checks Monday to Friday; its Closed output leads to a second block for Saturday.
  • Emergencies first. In a hospital line, put the emergency option before the hours check, or in both the open and the closed menu, as the Hospital main line template does.

Caller number rules

Check caller number compares the caller's number, as your carrier delivers it, with up to six patterns. The first pattern that matches the whole number decides the output; none means Any other caller.

CharacterMeans
0–9That digit.
*Any number of digits, including none.
?Exactly one digit.
+An optional plus: +92 3* also matches 923001234567.
spaces, dashesIgnored, so you can write +92 300-1234567.
PatternMatches
+92 3*Pakistani mobiles in international format (+923…, 923…)
03*Pakistani mobiles in national format (03…), if your carrier delivers numbers that way
042*Lahore landlines in national format
1001Internal calls from extension 1001
10??Internal calls from extensions 1000–1099

Where the data goes

BlockResult
Ask for a ratingStored with the call; the average shows in Analytics as Caller rating.
Offer a callbackAn open Inbox item, Asked for a callback, and the webhook call.callback_requested with the call id, the caller, the IVR number and the block's name.
Tag the callThe tag on the call, on the Calls page and in Analytics, exactly like a tag an agent adds.
Check with your systemA signed request to your Self-service API; see the Self-service API page for the format.
Speak from the answer, say()Voiced once into a temporary file that is deleted after 10 minutes, unlike the cached prompts.

Next steps