Webitel: Documentation

Chat History

1. Description

The component allows you to send the history of the conversation via e-mail.

This component is present in flow types like:

  • Chat.

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.

Chat History.png

Fig.1. Chat History component

1.1. Chat History 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. Chat History settings panel

It consists of the following elements:

  1. Conversation Id;

  2. Set to variable;

  3. Output format;

  4. Timeout;

  5. Messages limit;

  6. Break;

  7. Limit;

  8. Add description.

1.2.1. Conversation Id

Here you enter the identifier of the chat, the history of which will be recorded in the variable. Required field.

1.2.2. Set to variable

Required field.

Here you enter the variable name to which to transfer the chat history.

1.2.3. Output format

Required field.

Here you select the format in which to transfer the history.

The following options are available:

  • text;

  • html.

1.2.4. Timeout

Required field.

Request execution timeout - time in milliseconds during which the request to get the history will be executed. Only an integer is allowed.

The default value is 3000 (milliseconds).

1.2.5. Messages limit

The maximum number of dialog messages to be transmitted is here.

The default value is 300.

1.2.6. 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.7. 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.8. 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