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

Текстові шлюзи

1. Опис

Підключення до месенджерів.

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

  1. Інструмент створення (Рис. 1(1));

  2. Поле пошуку (Рис. 1(2));

  3. Інструмент оновлення реєстру записів (Рис. 1(3));

  4. Реєстр записів (Рис. 1(4));

  5. Пагінація (Рис. 1(5)).

Сторінка Текстові шлюзи.png
Рис. 1. Сторінка “Текстові шлюзи”

Вимоги та обмеження текстових провайдерів можна подивитися тут.

1.1. Інструмент створення

Для створення нового текстового шлюзу слугує кнопка "Додати" (Рис. 1(1)), після натискання на яку відкривається модальне вікно "Новий текстовий шлюз" (Рис. 2), у якому є такі варіанти:

  • Telegram Бот;

  • Telegram Застосунок;

  • Infobit;

  • Meta;

  • Viber;

  • Web chat;

  • Custom Chat Gateway.

Модальне вікно Новий текстовий шлюз.png
Рис. 2. Модальне вікно “Новий текстовий шлюз”

Після вибору і натискання кнопки "Створити" відкривається деталь обраного варіанту.

Для "Telegram Бот" доступні такі деталі:

Для "Telegram Застосунок" доступні такі деталі:

Для "Infobit" доступні такі деталі:

Для "Meta" доступні такі деталі:

Для "Viber" доступні такі деталі:

Для "Web chat" доступні такі деталі:

Для "Custom Chat Gateway" доступні такі деталі:

1.2. Поля пошуку

Пошук здійснюється по колонці "Ім'я".

Складається з поля введення та кнопки закриття ( image-20241231-141138.png ), яка відображається, коли в полі введення встановлено курсор. Для пошуку в частині слова або номера використовується символ *. Можна використовувати символ *  і для заміни будь-якої кількості символів.

1.3. Інструмент оновлення реєстру записів

Оновлення таблиці реєстру записів виконується натисканням кнопки оновлення - image-20241231-123329.png .

1.4. Реєстр записів

Реєстр є список записів існуючих об'єктів цього розділу, кожна з яких складається з набору полів:

  1. Чекбокс;

  2. Колонка "Ім'я";

  3. Колонка "URI";

  4. Колонка "Схема";

  5. Колонка "Провайдер";

  6. Колонка "Стан";

  7. Інструмент редагування;

  8. Інструмент видалення.

Якщо на сторінці немає жодного запису, відображається додаткова кнопка «Додати», функціонал якої дублює кнопку «Додати» у п. 1.1.

1.4.1. Чекбокс

Використовується для вибору одного або кількох записів. Після вибору одного або кількох записів з’являється додатковий інструмент видалення біля поля пошуку. Інформація про кількість записів, вибраних для видалення, з’являється при наведенні на цей інструмент. Коли ви натискаєте на нього, з’являється модальне вікно підтвердження. Він містить кнопки "Так", "Ні" та кнопку закриття - image-2023-7-12_22-34-16.png . Натискання кнопки "Так" видаляє записи. Натискання кнопки «Ні» закриває модальне вікно, а записи не видаляються.
Якщо відмітити чекбокс у заголовку, то усі записи на сторінці будуть вибрані.

Модальне вікно Підтвердіть видалення (декілька об'єктів).png

Рис. 3. Підтвердження видалення декількох записів

1.4.2. Колонка "Ім'я"

Тут відображаються назва текстового шлюзу. При натисканні на неї відкривається деталь даного текстового шлюзу.

1.4.3. Колонка "URI"

Уніфікований ідентифікатор ресурсів — компактний рядок букв, що однозначно ідентифікує окремий абстрактний або фізичний ресурс. Задається під час налаштування текстового шлюзу.

1.4.4. Колонка "Схема"

Тут відображається схема, яка використовується в цьому текстовому шлюзі. Більше інформації про схеми можна подивитися тут.

1.4.5. Колонка "Провайдер"

Тут відображається емблема обраного месенджера.

1.4.6. Колонка "Стан"

Містить перемикач, який відповідає за увімкнення і вимкнення текстового шлюзу, відповідно до положення перемикача:

Screenshot 2025-01-21 125251.png - текстовий шлюз увімкнено;

Screenshot 2025-01-21 125219.png - текстовий шлюз вимкнено.

1.4.7. Інструмент редагування

Відкривається натисканням кнопки редагування ( image-20241231-123436.png ), при наведенні курсором на яку відображається інформація з назвою інструмента. Після натискання цієї кнопки відкривається доступ до деталей, в яких можна змінити дані об'єкта.

1.4.8. Інструмент видалення.

Використовується для видалення об'єкта із підтвердженням через модальне вікно. Під час наведення на кнопку видалення ( image-20241231-123050.png ) відображається інформація з назвою інструменту. Після натискання кнопки видалення з'являється модальне вікно з підтвердженням. Натискання кнопки "Так" видаляє об'єкт. Натискання кнопки "Ні" закриває модальне вікно, об'єкт не видаляється.

Модальне вікно Підтвердіть видалення.png

1.5. Пагінація

Складається з поля "Записів на сторінці", в якому вказується кількість записів (можливо задати від 1 до 1000) на одну сторінку та кнопок вперед image-20250102-163221.png і назад image-20250102-163241.png для перемикання сторінок.

2. Можливості

2.1. Створення нового текстового шлюзу

Ціль

Створити новий текстовий шлюз

Передумови

  1. Доступ до застосунку "Admin";

  2. Доступ до розділу "Текстові шлюзи" в Admin;

  3. Дозвіл на створення у розділі "Текстові шлюзи".

Сценарій:

 

  1. Натиснути кнопку "Додати". Відкривається модальне вікно "Новий текстовий шлюз".

  2. Вибрати необхідний варіант.

  3. Натиснути кнопку "Створити". Відкривається сторінка деталі відповідно до обраного месенджера.

  4. Внести дані до кожної з деталей (за потреби).

  5. Натиснути кнопку "Зберегти". 

Результат

Дані збережені.

2.2. Видалення текстового шлюзу

Ціль

Видалити текстовий шлюз

Передумови

  1. Доступ до застосунку "Admin";

  2. Доступ до розділу "Текстові шлюзи" в Admin;

  3. Дозвіл на перегляд і видалення у розділі "Текстові шлюзи".

  4. Наявність щонайменше одного текстового шлюза.

Сценарій:

 

  1. Знайти текстовий шлюз, який потрібно видалити.

  2. Натиснути кнопку видалення - 016a45f8-df7e-4b58-b732-b44c9bc1a915 . Відкривається модальне вікно для підтвердження видалення.

  3. Натиснути кнопку "Так".

Результат

Модальне вікно закривається. Текстовий шлюз видалено.

2.3. Видалення декількох текстових шлюзів

Ціль

Видалити декілька текстових шлюзів

Передумови

  1. Доступ до застосунку "Admin";

  2. Доступ до розділу "Текстові шлюзи" в Admin;

  3. Дозвіл на перегляд і видалення у розділі "Текстові шлюзи".

  4. Наявність щонайменше одного текстового шлюзу.

Сценарій:

 

  1. Знайти в реєстрі записів текстові шлюзи, які потрібно видалити. Вибрати їх за допомогою чекбоксу.

  2. Натиснути кнопку видалення вгорі реєстру записів. Відкривається модальне вікно для підтвердження видалення.

  3. Натиснути кнопку "Так".

Результат

Модальне вікно закривається. Вибрані текстові шлюзи видалено.

2.4. Редагування параметрів текстового шлюзу

Ціль

Редагувати параметри текстового шлюзу

Передумови

  1. Доступ до застосунку "Admin";

  2. Доступ до розділу "Текстові шлюзи" в Admin;

  3. Дозвіл на перегляд і редагування розділі "Текстові шлюзи".

  4. Наявність щонайменше одного текстового шлюзу.

Сценарій:

 

  1. Знайти в реєстрі записів тексовий шлюз, який необхідно редагувати.

  2. Натиснути кнопку редагування в записі цього текстового шлюзу. Відкривається сторінка деталі цього текстового шлюзу.

  3. Відкрити сторінку потрібної деталі.

  4. Ввести зміни.

  5. Натиснути кнопку "Зберегти".

Результат

Дані збережені.

2.5. Увімкнення/вимкнення текстового шлюзу

Ціль

Увімкнути текстовий шлюз

Передумови

  1. Доступ до застосунку "Admin";

  2. Доступ до розділу "Текстові шлюзи" в Admin;

  3. Дозвіл на перегляд і редагування у розділі "Текстові шлюзи";

  4. Наявність щонайменше одного текстового шлюзу.

Сценарій:

 

  1. Знайти в реєстрі записів текстовий шлюз, який необхідно увімкнути.

  2. Перевести перемикач у колонці "Стан" в активне положення.

Результат

Дані збережено. Текстовий шлюз увімкнено.

3. Додаткові матеріали

3.1. Розумний бот на базі ChatGPT