Webitel: Документація

Компонент "Chat History"

1. Опис

Компонент дозволяє надіслати історії діалогу на електронну пошту.

Цей компонент присутній у схемах типу:

  • Текстова.

Блок (Рис. 1(1)) використовується у полі для побудови схеми. При натисканні на блок відкривається панель налаштувань даного компонента (Рис. 1(2)).

Chat History.png

Рис. 1. Компонент "Chat History"

1.1. Блок "Chat History"

Блок складається з таких елементів:

  1. Назви компонента;

  2. Гілка "In" - гілка, що приймає (з'єднує з іншим блоком);

  3. Гілка "Out" - вихідна (з'єднує з наступним блоком) гілка.

При наведенні на поле "Out" з'являється перемикач, який дозволяє з'єднати цей компонент з компонентом, який вже має з'єднання.

Наявність іконки позначає, що перемикач увімкнено, і цей компонент можна з'єднати з компонентом, який уже має з'єднання.

Зміна положення перемикача видаляє вихідну гілку цього компонента.

Кнопка видаляє блок зі схеми.

1.2. Панель налаштувань "Chat History"

Складається з таких елементів:

  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"

Обов'язкове поле.

Тут вказується ідентифікатор чату, історія якого записуватиметься у змінну.

1.2.2. Поле "Set to variable"

Обов'язкове поле.

Тут вказується назва змінної, в яку передавати історію чату.

1.2.3. Поле "Output format"

Обов'язкове поле.

Тут вибирається формат, у якому передаватиме історію.

Доступні такі варіанти:

  • text;

  • html.

1.2.4. Поле "Timeout"

Обов'язкове поле.

Тайм-аут на виконання запиту — час у мілісекундах, протягом якого виконуватиметься запит на отримання історії. Допускається лише ціле число.

Значення за замовчуванням – 3000 (мілісекунд).

1.2.5. Поле "Messages limit"

Тут вказується максимальна кількість повідомлень діалогу, які надсилаються.

Значення за замовчуванням – 300.

1.2.6. Перемикач "Break"

Відповідає за закінчення виконання схеми.

image-20241231-124210.png - ініціює закінчення виконання схеми після цього компонента;

image-20241231-124231.png - перемикач у вимкненому положенні.

1.2.7. Елемент "Limit"

Призначений для визначення максимальної кількості проходжень через цей компонент.

Натискання на кнопку "Add limit" додає поле "Max" та кнопку "Delete limit".

У полі “Max” вказується кількість можливих проходжень.

Якщо через компонент проходження буде більше, ніж зазначено в полі "Max", то використовуватиметься гілка "failover", яка з'являється в блоці компонента при установці ліміту.

Натискання на кнопку "Delete limit" забирає ліміт, повертаючи кнопку "Add limit".

Limit.png


Рис. 2. Встановлення ліміту

1.2.8. Елемент "Add description"

Натискання на кнопку "Add description" додає поле "Description" та кнопку "Delete description".

У полі "Description" вказується опис — коментарі до компонента.

Натискання на кнопку "Delete description" прибирає опис, повертаючи кнопку "Add description".

Description.png


Рис. 3. Елемент "Add description"