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

Компонент "HTTP Request"

1. Опис

Призначений для виконання HTTP REST-запиту й обробки результату.

Використовується для інтеграції зі сторонніми системами (наприклад, Creatio, 1C).

Дає можливість визначати на кого маршрутизувати дзвінок, отримувати інформацію про клієнта з CRS-системи.

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

  • Голосова;

  • Текстова;

  • Форми;

  • Службова.

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

http request.png
Рис. 1. Компонент "HTTP Request”

1.1. Блок "HTTP Request"

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

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

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

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

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

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

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

Кнопка Screenshot 2024-11-07 155145.png видаляє блок зі схеми.

1.2. Панель налаштувань "HTTP Request"

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

  1. Поле "Url";

  2. Поле "Methods";

  3. Поле "Timeout";

  4. Перемикач "Insecure skip verify";

  5. Поле "Response Code to variable";

  6. Поле "Cookie to variable";

  7. Перемикач "Use cache";

  8. Елемент "Headers";

  9. Елемент  "Path";

  10. Елемент "Request data";

  11. Елемент "Export variables";

  12. Перемикач "Break";

  13. Елемент "Limit";

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

1.2.1. Поле "Url"

Тут вказується url-адреса, на яку робити запит.

1.2.2. Поле "Methods"

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

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

  • Post;

  • Put;

  • Get;

  • Delete;

  • Patch.

1.2.3. Поле "Timeout"

У цьому полі вказується максимальна кількість часу, який очікуватиме відповіді.

1.2.4. Перемикач "Insecure skip verify"

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

Снимок экрана 2024-04-18 134012.png - не використовувати;

Снимок экрана 2024-06-07 154953.png - використовувати.

1.2.5. Поле "Response Code to variable"

У цьому полі вказується назва змінної, в яку записувати відповідь сервера.

1.2.6. Поле "Cookie to variable"

У цьому полі вказується назва змінної, в яку записувати куки, що передаються.

1.2.7. Перемикач "Use cache"

Відповідає за можливість зберігати кеш.

Снимок экрана 2024-04-18 134012.png - кеш не зберігається;

Снимок экрана 2024-06-07 154953.png - кеш зберігається.

1.2.8. Елемент "Headers"

Призначений для передачі http заголовків.

1.2.9. Елемент "Path"

Призначений для передачі змінної в url-адресу.

Використовується, наприклад, коли необхідно в посилання передати caller_id_number (Рис. 2).

Path.png
Рис. 2. Приклад заповнення елемента Path

1.2.10. Елемент "Request data"

Тут задається тіло запиту.

1.2.11. Елемент "Export variables"

Призначено для запису відповіді у змінні та її розбиття на деталі для подальшого аналізу.

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

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

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

  • image-20250703-072852.png - перемикач у вимкненому положенні.

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

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

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

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

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

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

Limit.png


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

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

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

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

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

Description.png


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