Webitel: Documentation

IVM Configuration

This document describes the process of configuring an outbound IVR dialer in the Webitel system. The instruction includes uploading a media file, creating a voice scheme, configuring resources and a queue. After completing all steps, the system will be ready for automatic outbound calling to customers.

1. Navigation

To upload a media file, go to Admin (Fig. 1) Lookups (Fig. 2.(1))Media files (Fig. 2.(2)).

Admin.png
Fig. 1. Admin section
lookups.png
Fig. 2. Lookups → Media files section

After navigating, the Media files page will open (Fig. 3).

Mediafiles page.png
Fig. 3. Media Files page

2. Uploading a Media File

To upload a new media file:

  1. Click the Drag and drop files here. area at the top of the page (Fig. 4).

Drag and drop files.png
Fig. 4. Drag and drop files here area
  1. Select a file from your device.

  2. Wait until the upload is completed — the file will appear in the registry (Fig. 5).

image-20260304-062714.png
Fig. 5. Records registry

2.1. File Requirements

The following formats are supported:

  • mp3;

  • wav (8 kHz, 16 bit, mono — standard for SIP channel frequency).

It is recommended to use the wav format.

The file size must not exceed 5 MB.

3. Creating a Flow Scheme

To create a Flow scheme for playing a previously uploaded media file, go to Admin (Fig. 6)Routing (Fig. 7.(1))Flow schemas (Fig. 7.(2)).

Admin.png
Fig. 6. Admin section
Flow schemas.png
Fig. 7. Routing → Flow schemas

The page with the list of all schemes will open (Fig. 8).

Flow schemas page.png
Fig. 8. Flow schemas page

3.1. Creating a New Scheme

To create a new flow scheme:

Click the Add button in the upper right corner of the page (Fig. 9).

Add_button.png
Fig. 9. Add button

The flow scheme creation modal window will open (Fig. 10).

create_new flow.png
Fig. 10. Create new flow modal window

In the modal window, perform the following actions:

  • Select the Diagram creation method (Fig. 10.(1)).

  • In the Type field, select Voice (Fig. 10.(2)).

  • Click the Create button (Fig. 10.(3)).

3.2. Editing the Scheme

After creation, the flow scheme editing window will open (Fig. 11).

Редактирование схемы.png
Fig. 11. Flow scheme editing window

In the workspace, you need to add two elements:

3.3. Adding the Playback Element

The Playback element is responsible for playing the media file at the beginning of the call.

To add the element:

  1. In the left panel, find the Playback component (you can use the search) (Fig. 12).

Playback_.png
Fig. 12. Searching for the Playback component
  1. Drag the Playback component to the scheme workspace (Fig. 13). Connect the Start block to the Playback block.

Playback.png
Fig. 13. Adding the Playback component
  1. Next, click on the component (Fig. 14.(1)) — the settings panel will open.

  2. In the Media field (Fig. 14.(2)), select the previously uploaded file.

  3. Click the Add button (Fig. 14.(3)).

Настройка Playback.png
Fig. 14. Playback element settings

A detailed description of the parameters is provided in the documentation.

3.4. Adding the Hangup Element

The Hangup element is responsible for properly terminating the call.

To add the element:

  1. In the left panel, find the Hangup component (Fig. 15).

Hangup.png
Fig. 15. Searching for the Hangup component
  1. Drag it to the workspace (Fig. 16).

  2. Connect the output of the Playback block to the input of the Hangup block. The Hangup block must be placed at the end of the scheme.

Hangup_.png
Fig. 16. Adding the Hangup element

A detailed description of the block parameters is provided in the documentation.

After completing the configuration, save the flow scheme (Fig. 17).

Сохранение схемы.png
Fig. 17. Saving the scheme

4. Creating a Resource for Outbound Calls

To make outbound calls in the IVR queue, a resource must be created in advance.

4.1. Navigation

To create a resource:

Go to Admin (Fig. 18)Contact Center (Fig. 19.(1))Resources (Fig. 19.(2)).

Admin.png
Fig. 18. Admin section
Resources.png
Fig. 19. Contact Center → Resources section

The page with the list of all created resources will open (Fig. 20).

Resources page.png
Fig. 20. Resources page

4.2. Creating a New Resource

To create a new resource:

  1. Click the Add button in the upper right corner (Fig. 21).

Add button Resources.png
Fig. 21. Add button
  1. The new resource creation page will open. On the General tab, fill in the required fields (Fig. 22).

New resource.png
Fig. 22. General tab (Resources)
  • Name (Fig. 22.(1)) — specify the resource name.

  • Gateway (Fig. 22.(2)) — select the gateway through which outbound calls will be made.

  • Ignore Early Media (Fig. 22.(3)) — it is recommended to set the value to consume. This parameter allows the system to ignore early media (ringback tones, waiting music) and react specifically to the call being answered.

  1. After filling in the data, click the Save button (Fig. 22.(4)).

4.3. Configuring Numbers (When Using a Direct Trunk)

If a direct trunk with a provider is used instead of a registration-based gateway, an additional number must be specified.

To do this:

  1. Go to the Numbers tab. Click the Add number button (Fig. 23).

Numbers tab.png
Fig. 23. Numbers tab
  1. The Add number modal window will open (Fig. 24).

Add number.png
Fig. 24. Add number modal window
  1. In the Number field, specify the number expected by the provider on their side. Click the Add button.

4.4. Enabling the Resource

After creating the resource, it must be activated.

Return to the resources registry. In the State column, enable the toggle for the created resource (Fig. 25).

State Resources.png
Fig. 25. Enabling the created resource

The resource must be in the active state image-20260226-081942.png .

5. Creating a Resource Group

A resource group is used to combine one or more resources and assign them to an IVR queue.

5.1. Navigation

To create a resource group:

  1. Click the menu icon in the upper left corner (Fig. 26).

Menu_Resources.png
Fig. 26. Menu
  1. In the opened menu, select: AdminContact CenterResource Groups (Fig. 27).

Resource groups.png
Fig. 27. Navigating to Admin → Contact Center → Resource Groups
  1. The page with the list of all created resource groups will open (Fig. 28).

Resource groups tab.png
Fig. 28. Resource Groups page

5.2. Creating a New Resource Group

  1. Click the Add button in the upper right corner of the page (Fig. 29).

Add button Resource group.png
Fig. 29. Add button
  1. The new group creation page will open.

  2. On the General tab, fill in the required fields (Fig. 30):

  • Name — specify the name of the resource group.

  • Communication type — select the connection type.

General Res groups.png
Fig. 30. General tab
  1. Go to the Resources tab. Click the Add resource button (Fig. 31).

Resources tab.png
Fig. 31. Adding a resource
  1. The Add resource modal window will open (Fig. 32). Fill in the fields:

  • Resource — select the previously created resource.

  • Priority — specify the resource usage priority (the lower the value, the higher the priority).

  • Reserve resource — specify a backup resource if needed.

  1. Click the Add button.

Add resource.png
Fig. 32. Add resource modal window
  1. The added resource will appear in the list (Fig. 33).

Resources registry.png
Fig. 33. Displaying the added resource
  1. Go to the Time range tab (Fig. 34). Specify the working time interval for the resource group:

  • From (hh:mm) — start time.

  • To (hh:mm) — end time.

If necessary, multiple intervals can be added.

Time range.png
Fig. 34. Time range tab
  1. After completing all tabs, click the Save button in the upper right corner (Fig. 35).

Save bitton Res groups.png
Fig. 35. Saving the resource group
  1. After saving, the group will appear in the general list (Fig. 36).

All resource groups.png
Fig. 36. Displaying the added resource group

6. Creating an IVR Dialer (Outbound IVR Queue)

After creating the resource and the resource group, you need to create an IVR queue.

6.1. Navigation

  1. Open the menu in the upper left corner (Fig. 37).

Menu .png
Fig. 37. Menu
  1. Go to: AdminContact CenterQueues (Fig. 38).

Queues tab.png
Fig. 38. Navigation to Admin → Contact Center → Queues
  1. The page with the list of all queues will open (Fig. 39).

Queues page.png
Fig. 39. Queues page

6.2. Creating a New Queue

  1. Click the Add button in the upper right corner (Fig. 40).

Add button queues.png
Fig. 40. Add button
  1. In the opened modal window (Fig. 41), select the type Outbound IVR queue (Fig. 41.(1)). Click the Create button (Fig. 41.(2)). The new queue configuration page will open.

New queue.png
Fig. 41. New queue modal window
  1. On the General tab (Fig. 42), fill in the main parameters:

  • Name (Fig. 42.(1)) — specify the dialer name.

  • Calendar (Fig. 42.(2)) — select a calendar. The calendar defines the dialer working hours (calling time windows).

  • Flow schema (Fig. 42.(3)) — select the previously created voice flow that will be played when the call is answered.

Other parameters can be left as default or configured according to the project requirements.

General tab Queues.png
Fig. 42. General tab (Queues)
  1. Go to the Parameters tab (Fig. 43). Configure the key parameters:

  • Wait between retries (hh:mm:ss) — interval between repeated call attempts.

  • Max attempts — number of call attempts per subscriber.

  • Max tasks — limit for the number of active tasks.

  1. Enable the Recording parameter to activate call recording.

Parameters.png
Fig. 43. Parameters tab
  1. Go to the Resources tab. Click the Add button (Fig. 44).

Resources tab .png
Fig. 44. Resources tab. Adding a new resource
  1. In the modal window (Fig. 45), select the previously created Resource group (Fig. 45.(1)). Click the Save button (Fig. 45.(2)).

Resource_group.png
Fig. 45. Resource group modal window
  1. The added group will appear in the list (Fig. 46).

Resource groups registry.png
Fig. 46. Displaying the added resource group
  1. After configuring all parameters, click the Save button in the upper right corner (Fig. 47).

Save button Queues.png
Fig. 47. Saving the queue

6.3. Enabling the IVR Queue

After creating the queue, it must be activated.

Return to the general list of queues. In the State column, enable the toggle next to the created IVR dialer (Fig. 48).

State.png
Fig. 48. Enabling the created queue

The queue must be in the active state – image-20260226-081942.png .

7. Additional Capabilities: Flexible Retry Logic via After Flow

The standard IVR queue parameters allow you to set a single interval between repeated call attempts. This interval is applied equally to all calls.

If more flexible retry logic is required (for example, different intervals after each attempt or depending on the call result), an after flow is used. This flow is executed after the call is completed in the queue.

7.1. Example of After Flow Implementation

[
  {
    "if": {
      "expression": "${call_cause} == 'USER_BUSY' || ${call_cause} == 'CALL_REJECTED'",
      "then": [
        {
          "set": [
            {
              "status": "Busy"
            }
          ]
        },
        {
          "abandoned": {
            "export": [
              "status"
            ],
            "waitBetweenRetries": "3600"
          }
        }
      ]
    }
  },
  {
    "if": {
      "expression": "${cc_result} && +${call_voice_sec} <= 10",
      "then": [
        {
          "set": [
            {
              "status": "Not listened"
            }
          ]
        },
        {
          "abandoned": {
            "export": [
              "status"
            ]
          }
        }
      ]
    }
  }
]

7.2. Tasks Solved by the After Flow

The after flow allows you to:

  • analyze the call result;

  • take into account the call termination cause;

  • check the call duration;

  • set individual retry intervals;

  • determine whether another attempt is required.

This makes it possible to implement scenarios that cannot be configured using only the standard queue parameters.

7.3. Used Variables

The following variables are typically used in the after flow:

  • call_cause — call termination reason (e.g., USER_BUSY, CALL_REJECTED — subscriber is busy or the call was rejected);

  • call_voice_sec — call duration in seconds;

  • set — creation of a variable, for example, setting the status variable (e.g., Busy, Not listened);

  • abandoned — finalizes call processing and determines whether a retry is required;

  • export — outputs the status variable to the call history;

  • waitBetweenRetries — sets a custom retry interval (in seconds).

7.4. Logic Example

The following logic can be implemented in the after flow:

  • if call_cause = USER_BUSY or CALL_REJECTED, the status Busy is set and a retry is scheduled in 3600 seconds;

  • if call_voice_sec ≤ 10 seconds, the status Not listened is set;

  • the final status is saved in the call history.

The after flow extends the standard queue capabilities and enables more flexible control over retry attempts.