Webitel: Documentation
Webitel: Documentation
Breadcrumbs

Bridge

1. Description

Component for customizing the connection of leg-A side to leg-B side. It is used to create the Leg-B side, the ability to call the User or another call through the selected Gateway.

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.

Bridge.png
Fig.1. Bridge component

1.1. Bridge 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 2024-11-07 154742.png 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 2024-11-07 155145.png button deletes the block from the Flow schema.

1.2. Bridge settings panel

It consists of the following elements:

  1. Bridge strategy;

  2. Bridge parameters;

  3. Endpoints;

  4. Break;

  5. Limit;

  6. Add description.

1.2.1. Bridge strategy

It is designed to select the strategy for connecting the leg-A side to the Leg-B side.

The following options are available:

  • multiply — simultaneous attempts to connect with several representatives of the Leg-B party (for an incoming call — with several Agents, which are specified in the Endpoints element);

  • failover — serial connection.

1.2.2. Bridge parameters

Click the icon image-20250627-095458.png , open:

  • Key — the name of the parameter;

  • Value — the value of the parameter;

  • Remove tool — when clicked, removes the parameter next to which it stands.

It is possible to set several parameters.

List of parameters that can be used (Table 1).

Key=Value

Description

continue_on_fail=true

Controls what happens when the called party is unavailable (busy/offline). If true, outbound routing continues to be processed. If false - stop processing.

instant_ringback=true

Ringback will not wait for an indication before sending a callback signal to the caller.

ignore_early_media=true

Ignore the early media from the endpoint.

ignore_early_media=ring_ready

Same as ignore_early_media=true , but it also sends SIP 180 to the incoming leg when the first SIP 183 is intercepted.

hangup_after_bridge=true

Controls what happens to the calling party (A) when it is in the bridge state, and the called party (B) hangs up.

If set to true, outbound routing will stop processing, and Leg-A will end when Leg-B ends.

If set to false (default), outgoing routing continues to be processed after Leg-B is completed.

ignore_display_updates=true

Do not send displayed UPDATEs to the call leg (update_display).

call_timeout=20

Specifies how long (in seconds) the endpoint will ring. The default is 60 seconds.

leg_timeout=15

It can only be used inside endpoint parameters.

leg_delay_start=15

Specifies the timeout in seconds before calling a branch. It can only be used inside endpoint parameters.

origination_caller_id_number=911

Sets the initial CallerID number.

sip_renegotiate_codec_on_reinvite=true

Allow changing SDP codec with re-INVITE. 

Table. 1. List of options

1.2.3. Endpoints

It is designed to specify exactly where the connection will occur — the generation of the Leg-B side.

It consists of the following elements:

  1. Add user;

  2. Add gateway.

1.2.3.1. Add user

It is designed to add a User/Agent to which the connection will be made.

Click on the Add user button opens access to the settings of the Endpoint section containing the following parameters (Fig. 2):

  1. Extension;

  2. Call only on idle;

  3. Endpoint parameters;

  4. Remove tool.

Endpoints - Bridge.png
Fig. 2. Endpoint — Add User

It is possible to add several Agents.

1.2.3.1.1. Extension

Here enter the internal number of the Agent to which the connection will be made.

1.2.3.1.2. Call only on idle

Responsible for allowing connection attempts to be made when the Agent is free:

image2024-1-26_13-47-15.png   — make attempts to connect, regardless of the busyness of the Agent;

image2024-1-26_15-58-11.png — make attempts to connect only when the Agent is free.

1.2.3.1.3. Endpoint parameters

Click on the icon image-20250627-095458.png opens the following parameters:

  • Key — the name of the parameter;

  • Value — the value of the parameter;

  • Remove tool — when clicked, removes the parameter next to which it stands.

You can add several parameters using the icon image-20250627-095458.png . The list of parameters can be viewed here.

1.2.3.1.4. Remove tool

Clicking the icon image-20250826-094746.png deletes the "Endpoint" section to which it belongs.

1.2.3.2. Add gateway

It is designed to add a specific Gateway to which the connection will be made.

Click on the Add gateway button opens access to the settings of the Endpoint section containing the following parameters (Fig.3):

  1. Gateway;

  2. Dial string;

  3. Cancel distribute;

  4. Endpoint parameters;

  5. Remove tool.

Endpoint gateway - Bridge.png
Fig. 3. Endpoint — Add Gateway

It is possible to add several Gateways.

1.2.3.2.1. Gateway

It is designed to select a Gateway. Consists of:

  • Gateway — a field for choosing a Gateway. Clicking on the field opens a drop-down list of existing Gateways;

  • Add — button to add the selected Gateway.

After clicking the Add button, the Gateway field and the Add button disappear, and the selected Gateway is displayed with the ability to delete it through the image2024-1-26_16-3-7.png  button (Fig.4).

1.2.3.2.2. Dial string

It is designed to indicate the destination number where the call will be made.

Here you can specify either a specific phone number or reference the destination number using the “$” sign and the ordinal number of the possible value. Such a number is specified in the Destination Number on the Dialplan page for routing that uses this Flow Scheme.

For example, for a Dialplan that uses this Flow Schema, the Destination Number is ^(7)(4997045627)$

Where

$0 = 74997045627;

$1 = 7;

$2 = 4997045627.

1.2.3.2.3. Cancel distribute

Responsible for dropping calls that are distributed to the Agent if, at the same moment, the Agent makes an outgoing call:

image2024-1-26_13-47-15.png — does not reset the call, which is distributed to the Agent;

image2024-1-26_13-47-47.png — resets the call, which is distributed to the Agent.

1.2.3.2.4. Endpoint parameters

Click the icon image-20250627-095458.png opens the following parameters:

  • Key — the name of the parameter;

  • Value — the value of the parameter;

  • Remove tool — when clicked, removes the parameter next to which it stands.

You can add several parameters using the icon image-20250627-095458.png . The list of parameters can be viewed here.

1.2.3.2.5. Remove tool

Clicking the icon image-20250826-094746.png deletes the "Endpoint" section to which it belongs.

1.2.4. 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.5. 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. 4. Setting a limit

1.2.6. 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. 5. Add description