Webitel: Documentation

Ringback

1. Description

It is designed to set up beeps or sound files before starting a conversation.

This component is present in flow types like:

  • Voice.

The block (Fig.1(1)) is used in space to build the Flow. The settings panel for this component opens (Fig.1(2)) when you click on the block.

Ringback.png
Fig. 1. Ringback component

1.1. Ringback block

The block consists of the following elements:

  1. The name of the component;

  2. In branch — receiving (connecting with the previous block) branch;

  3. Out branch — outgoing (connecting with the following block) branch. When hovering over the Out field, a switch appears. The switch allows this component to be connected to a component that already has a connection.

The presence of an Screenshot%202024-11-07%20154742.png?version=1&modificationDate=1731965796124&cacheVersion=1&api=v2 icon indicates that the switch is on, and this component can be connected to a component that already has a connection.

Changing the switch position removes the outgoing branch of this component.

The Screenshot%202024-11-07%20155145.png?version=1&modificationDate=1731965796318&cacheVersion=1&api=v2&width=20 button deletes the block from the Flow Schema.

1.2. Ringback settings panel

It consists of the following elements:

  1. All;

  2. At Call;

  3. At Hold;

  4. At Transfer;

  5. Break;

  6. Limit;

  7. Add description.

1.2.1. All

The switch is responsible for using the settings entered in this component.

Снимок экрана 2024-02-13 144345.png — use the settings;

Снимок экрана 2024-02-13 144403.png — do not use the settings.

1.2.2. At Call

It is designed to set up a sound file or beeps at call.

It consists of a Type field and a field that depends on the selection in the Type field.

The Type field is used to select the type of sound. The following options are available:

  1. tone;

  2. file.

When the tone type is selected, the second field is responsible for the beep tone code and is named Tone.

When the file type is selected, the second field is responsible for choosing a file that will be played instead of beeps and is named Media file. Clicking on the Media file field opens a list of media files added to the Media files page, from which the file is selected.

1.2.3. At Hold

It is designed to set up a sound file or beeps at hold.

It consists of a Type field and a field that depends on the selection in the Type field.

The Type field is used to select the type of sound. The following options are available:

  1. tone;

  2. file.

When the tone type is selected, the second field is responsible for the beep tone code and is named Tone.

Default tone:
%(1000,6000,425);loops=-1

When the file type is selected, the second field is responsible for choosing a file that will be played instead of beeps and is named Media file. Clicking on the Media file field opens a list of media files added to the Media files page, from which the file is selected.

1.2.4. At Transfer

It is designed to set up a sound file or beeps at Transfer.

It consists of a Type field and a field that depends on the selection in the Type field.

The Type field is used to select the type of sound. The following options are available:

  1. tone;

  2. file.

When the tone type is selected, the second field is responsible for the beep tone code and is named Tone.

When the file type is selected, the second field is responsible for choosing a file that will be played instead of beeps and is named Media file. Clicking on the Media file field opens a list of media files added to the Media files page, from which the file is selected.

1.2.5. Break

Responsible for the completion of the flow execution.

  • image-20250627-120834.png — initiates the end of the flow execution after the given component.

  • image-20250627-120816.png — the switch is in the off position.

1.2.6. Limit

It is intended to determine the maximum number of passes through this component.

The failover branch appears in the edited component when the limit is set image2024-1-26_12-1-12.png .

The failover branch will be used if more passes are passed through the component than entered in the Max field.

Clicking on the Add Limit button adds a Max field and a Delete limit button.

The number of possible passes is indicated in the Max field.

Clicking on the Delete limit button removes the limit and returns the Add limit button.

Limit.png


Fig. 2. Setting a limit

1.2.3. Add description

When you click the Add description button, a Description field and a Delete description button will be added.

The Description field is used to add comments to the component.

Clicking the Delete description button removes the description field and brings back the Add description button.

Description.png

Fig. 3. Add description