Webitel: Documentation

User info

1. Description

Allows getting information about the User by the user's Extension.

This component is present in flow types like:

  • Voice;

  • Chat;

  • Forms;

  • Service.

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.

User_info.png
Fig. 1. User info component

1.1. User info 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. User info settings panel

It consists of the following elements:

User info settings.png
Fig. 2. User Info settings panel

1.2.1. User Extension

Here you enter the Extension of the User about which you want to get information or a variable into which the Extension is set. For example - ${caller_id_number}.

1.2.2. Set

It consists of the following:

  1. Key;

  2. Value;

  3. Remove tool;

  4. Add tool.

1.2.2.1. Key

Here enters an arbitrary name of the variable to which the data will be transferred.

1.2.2.2. Value

Specifies the value. The following entries are allowed:

  • name — user’s name;

  • user_id — user ID;

  • username — user login;

  • extension — internal number;

  • email — email address;

  • dnd — “Do Not Disturb” status;

  • status_payload — current user status;

  • super_extension — supervisor’s internal number;

  • agent_id — agent ID;

  • team_id — team ID;

  • team_name — team name;

  • bridged_calls — number of connected calls;

  • active_calls — number of active calls;

  • agent_status — agent status;

  • admin_extension — administrator’s internal number;

  • variables.CUSTOM - the value of the CUSTOM variable. CUSTOM is a User's variable key.

Note! You can select a value from the list or add a new one manually if the required option is not available among the suggested ones.

1.2.2.3. Remove tool

It is intended for removing a variable in a row with which it stands—clicking on the  Снимок экрана 2024-02-16 005633.png  button removes the variable.

1.2.2.4. Add tool

The icon IMG_5781.jpeg is designed to add a new variable.

1.2.3. 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.4. 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. 3. Setting a limit

1.2.5. 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. 4. Add description