IVRs

Overview

The IVRs page builds interactive voice response menus that collect DTMF or speech input and route callers. Open it from Configuration > IVRs.

The page works against the tenant currently selected in the top bar. The screenshots and demo rows were captured in the Canistracci OIL tenant.

IVRs list page in the Canistracci OIL tenant.
IVRs list page in the Canistracci OIL tenant.

Working with objects

TaskHow to do it
AddSelect the New IVR action, complete the form, and select Save.
EditOpen the IVR from the list by selecting its name, number, or row action. Change the form and select Save.
DeleteSelect the row checkbox and use Delete Selected, or open the IVR and select Delete, then confirm.

Page functions

ActionDescription
New IVROpens the creation form for a new ivr.
Delete SelectedDeletes the selected rows after confirmation.

List columns

ColumnDescription
NameDisplay name used in lists and references.
Welcome MessageObject setting shown by the form.
Allow Dialing ExtensionsTarget or routing selection used when the object sends a call or message onward.
Allow Dialing Feature CodesDialed value, identifier, or matching value used by the PBX.
ActionObject setting shown by the form.

Demo records

The tenant contains 1 documentation demo record for this page: Docs Demo IVR 1.

Deleting records

Before deleting a IVR, check references from call flows, destinations, schedules, reports, or provisioning objects. MiRTA PBX asks for confirmation before the delete is submitted.

Create and Edit IVRs

Use this page when creating a new IVR or editing an existing IVR from Configuration > IVRs.

The form screenshots below are separated by block where the application exposes separate sections. Complete the required values, review routing or destination references, and save the record.

Add and edit form

IVRs add/edit form.
IVRs add/edit form.

Main fields

FieldDescription
Name:Display name used in lists and references.
Type:Mode selector that changes the behavior of the object.
Speech to Text Language:Language or voice selection used for prompts, transcription, or speech synthesis.
Min silence time (ms):Object setting shown by the form.
Silence threshold:Object setting shown by the form.
Messages playback:Object setting shown by the form.
Menu selection timeout:Timing value used by the service.
Digit timeout:Timing value used by the service.
Max loop counts:Object setting shown by the form.
Loop on timeoutTiming value used by the service.
Loop on wrong key press/wordObject setting shown by the form.
Allow dialing internal numbersDialed value, identifier, or matching value used by the PBX.
Allowed numbers:Dialed value, identifier, or matching value used by the PBX.
Allow Custom CodesDialed value, identifier, or matching value used by the PBX.
Allow Dialing Feature CodesDialed value, identifier, or matching value used by the PBX.

Voice IVR fields

Voice IVR field set shown after selecting Type: Voice.
Voice IVR field set shown after selecting Type: Voice.

Set Type to Voice when callers should speak a word or short phrase instead of pressing DTMF digits. MiRTA PBX sends the captured audio to the configured Speech to Text service, compares the recognized text with the entries defined in the IVR, and then routes the call to the matching destination.

FieldDescription
TypeSelect Voice to hide the fixed DTMF key mappings and use spoken words or phrases as menu choices.
Speech to Text LanguageSelects the speech-recognition language used to transcribe the caller audio before matching it against the IVR entries.
Min silence time (ms)Amount of silence, in milliseconds, that MiRTA PBX waits before sending the captured speech to the Speech to Text engine. A higher value allows longer pauses inside a phrase; a lower value submits the audio sooner.
Silence thresholdAudio level below which the input is considered silence. Increase it in noisy environments; decrease it when quiet speech is being cut too early.
Welcome MessageMedia played at the beginning of the IVR, normally only on the first pass through the menu.
Options MessageMedia that explains the available spoken choices to the caller.
Messages playbackControls whether welcome and options media are replayed during loops, only the options media is replayed, or no media is replayed.
Menu selection timeoutHow long the IVR waits for speech before using the timeout behavior.
Loop on timeoutWhen enabled, the IVR repeats after a timeout instead of immediately following the timeout destination. Max loop counts limits how many retries are allowed.
Loop on wrong key press/wordWhen enabled, the IVR repeats after speech is recognized but does not match any configured word or phrase.
EnteringThe word or short phrase to match after transcription, such as sales, support, billing, or operator.
Action to takeThe destination used when the recognized word or phrase matches the Entering value.
On wrong key press/wordFallback destination when the spoken input does not match any configured entry and looping is not used or has reached the maximum loop count.
On timeoutFallback destination when no speech is detected before the menu selection timeout.
On hangupOptional destination or action to run when the caller hangs up while inside the IVR.

Use short, distinct words for Voice IVR entries. Words that sound similar can be transcribed the same way, especially with background noise or low-quality audio.

Saving and deleting

TaskHow to do it
CreateSelect the new action from the IVRs list, fill the required fields, and select Save.
EditOpen the existing IVR, update the needed fields, and select Save.
DeleteBefore deleting a IVR, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm.