Документация Webitel
Документация Webitel
Breadcrumbs

Хуки (Команды)

1. Описание

Предназначена для добавления хуков для команды.

Состоит из таких элементов:

  1. Инструмент добавления (Рис.1 (1));

  2. Инструмент обновления списка реестра (Рис.1 (2));

  3. Реестр записей (Рис.1 (3));

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

Страница детали Хуки (Команды).png
Рис. 1. Страница детали "Хуки"

1.1. Инструмент добавления

Для добавления нового хука необходимо нажать кнопку добавления - %D0%A1%D0%BD%D0%B8%D0%BC%D0%BE%D0%BA%20%D1%8D%D0%BA%D1%80%D0%B0%D0%BD%D0%B0%202024-02-16%20005041.png?version=1&modificationDate=1708698369698&cacheVersion=1&api=v2&width=20 . После нажатия кнопки добавления открывается модальное окно "Добавить хук" (Рис. 2), которое состоит из полей "События" и "Схема", а также кнопок "Сохранить" и "Закрыть".

Модальное окно Добавить хук.png
Рис. 2. Модальное окно "Добавить хук"

1.1.1. Поле "События"

Служит для выбора события. При нажатии на поле "Событие" открывается выпадающий список, из которого выбирается событие.

Существуют такие события:

  • Изменение статуса оператора.

1.1.2. Поле “Схема”

Здесь указывается какая схема будет прорабатываться при указанном событии.

При нажатии на поле "Схема" открывается выпадающий список, из которого выбирается схема. Если необходимой схемы нет в выпадающем списке, то используйте поле "Схема", как поле поиска. 

Как создать новую схему можно посмотреть здесь.

В схеме доступны следующие переменные:

  • agent_name - имя оператора;

  • status - статус (online/offline/pause);

  • status_payload - причина перерыва;

  • agent_id - идентификатор оператора;

  • user_id - идентификатор юзера;

  • team_id - идентификатор команды;

  • extension - внутренний номер.

1.2. Инструмент обновления реестра записей

Обновление таблицы реестра записей выполняется нажатием на кнопку обновления - image-20241213-115639.png .

1.3. Реестр записей

Реестр представляет собой список записей существующих объектов этого раздела. Каждая запись состоит из набора полей:

  1. Чекбокс;

  2. Колонка "Событие";

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

  4. Колонка "Состояние";

  5. Инструмент редактирования записи;

  6. Инструмент удаления записи.

1.3.1. Чекбокс

Используется для выбора нескольких записей объектов. После выбора одной, или нескольких, записей появляется дополнительная кнопка удаления вверху реестра записей %D0%A1%D0%BD%D0%B8%D0%BC%D0%BE%D0%BA%20%D1%8D%D0%BA%D1%80%D0%B0%D0%BD%D0%B0%202024-02-16%20005633.png?version=3&modificationDate=1708698712348&cacheVersion=1&api=v2&width=20 . При наведении курсора на этот инструмент появляется информация о количестве выбранных для удаления записей.

1.3.2 Колонка "Событие"

Здесь отображается имя события, при котором необходимо отправлять данные в другую систему.

1.3.3. Колонка “Схема”

Здесь отображается какая схема будет прорабатываться при указанном событии.

1.3.4. Колонка "Состояние"

Включает в себя переключатель, который отвечает за включение и отключения хука в соответствии с положением переключателя:

%D0%A1%D0%BD%D0%B8%D0%BC%D0%BE%D0%BA%20%D1%8D%D0%BA%D1%80%D0%B0%D0%BD%D0%B0%202024-02-13%20144403.png?version=1&modificationDate=1708698495795&cacheVersion=1&api=v2&width=40 - хук включен;

%D0%A1%D0%BD%D0%B8%D0%BC%D0%BE%D0%BA%20%D1%8D%D0%BA%D1%80%D0%B0%D0%BD%D0%B0%202024-02-13%20144345.png?version=1&modificationDate=1708698506450&cacheVersion=1&api=v2&width=38 - хук отключен.

1.3.5. Инструмент редактирования записи

Открывается нажатием на кнопку редактирования %D0%A1%D0%BD%D0%B8%D0%BC%D0%BE%D0%BA%20%D1%8D%D0%BA%D1%80%D0%B0%D0%BD%D0%B0%202024-02-16%20014501.png?version=2&modificationDate=1708698767677&cacheVersion=1&api=v2&width=20 , при наведении курсором на которую отображается информация с названием инструмента. После нажатия на эту кнопку открывается модальное окно "Редактировать хук" (Рис. 3).

Модальное окно Редактировать хук.png
Рис. 3. Модальное окно "Редактировать хук"

1.3.6. Инструмент удаления записи

Используется для удаления хука из реестра записей. При наведении на кнопку удаления %D0%A1%D0%BD%D0%B8%D0%BC%D0%BE%D0%BA%20%D1%8D%D0%BA%D1%80%D0%B0%D0%BD%D0%B0%202024-02-16%20005633.png?version=3&modificationDate=1708698712348&cacheVersion=1&api=v2&width=20 отображается информация с названием инструмента. После нажатия кнопки удаления запись о хуке удаляется.

1.4. Пагинация

Состоит из поля "Записей на странице", в котором указывается количество записей (возможно задать от 1 до 1000) на одну страницу и кнопок вперед  image-20241213-095758.png и назад  image-20241213-095901.png для переключения страниц.

2. Возможности

2.1. Добавление хука в команду

Цель

Создать хук

Предусловия

  1.  Доступ к приложению Admin;

  2.  Доступ к разделу "Команды" в приложении Admin;

  3.  Разрешение на редактирование, или создание, в разделе "Команды";

  4. Наличие команды или создание новой.

Сценарий:

  1. Нажать на кнопку добавления - %D0%A1%D0%BD%D0%B8%D0%BC%D0%BE%D0%BA%20%D1%8D%D0%BA%D1%80%D0%B0%D0%BD%D0%B0%202024-02-16%20014225.png?version=1&modificationDate=1708698661511&cacheVersion=1&api=v2&width=20 . Открывается модальное окно "Добавить хук".

  2. Нажать на поле "События". Открывается выпадающий список существующих событий.

  3. Выбрать необходимое событие. Выпадающий список закрывается. Кнопка "Сохранить" становится активной.

  4. Нажать на поле "Схема". Открывается выпадающий список существующих схем.

  5. Выбрать необходимую схему. Выпадающий список закрывается.

  6. Нажать кнопку "Сохранить".

Результат

Модальное окно закрывается. Данные сохранены. 

2.2. Удаление хука из команды

Цель

Удалить хук из команды

Предусловия

  1.  Доступ к приложению Admin;

  2.  Доступ к разделу "Команды" в приложении Admin;

  3.  Разрешение на редактирование, или создание, в разделе "Команды";

  4. Наличие команды или создание новой;

  5. Наличие минимум одной записи хука.

Сценарий:

  1. Найти запись хука, который необходимо удалить.

  2. Нажать кнопку удаления - %D0%A1%D0%BD%D0%B8%D0%BC%D0%BE%D0%BA%20%D1%8D%D0%BA%D1%80%D0%B0%D0%BD%D0%B0%202024-02-16%20005633.png?version=3&modificationDate=1708698712348&cacheVersion=1&api=v2&width=20 .

Результат

Хук удален из реестра записей.

2.3. Редактирование хука

Цель

Заменить схему при конкретном событии

Предусловия

  1.  Доступ к приложению Admin;

  2.  Доступ к разделу "Команды" в приложении Admin;

  3.  Разрешение на редактирование, или создание, в разделе "Команды";

  4. Наличие команды или создание новой;

  5. Наличие минимум одной записи хука.

Сценарий:

  1. Найти запись хука, в котором нужно заменить схему.

  2. Нажать кнопку редактирования - %D0%A1%D0%BD%D0%B8%D0%BC%D0%BE%D0%BA%20%D1%8D%D0%BA%D1%80%D0%B0%D0%BD%D0%B0%202024-02-16%20014501.png?version=2&modificationDate=1708698767677&cacheVersion=1&api=v2&width=20 . Открывается модальное окно "Редактировать хук".

  3. Нажать на поле "Схема". Открывается выпадающим список существующих схем.

  4. Выбрать необходимую схему. Выпадающий список закрывается. Кнопка "Сохранить" становится активной. 

  5. Нажать кнопку "Сохранить".

Результат

Модальное окно закрывается. Данные сохранены.