1. Описание

Предназначена для добавления хуков в очередь. Хуки используются при интеграции, если на какое-то событие со стороны Webitel необходимо отправлять данные в другую систему.

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

Инструмент добавления (Рис.1 (1));
Инструмент обновления списка реестра (Рис.1 (2));
Реестр записей (Рис.1 (3));
Пагинация (Рис.1 (4)).

Рис. 1. Страница детали "Хуки"

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

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

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

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

Абонент вошел в очередь;
Принят оператором;
Распределение на оператора;
Соединение абонента с оператором;
Пропущенный оператором;
Абонент вышел из очереди;
Постобработка;
Активное действие.

1.1.2. Поле "Схема"

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

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

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

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

(Рис.1 (2)).

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

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

Чекбокс;
Колонка "Событие";
Колонка "Схема";
Колонка "Состояние";
Инструмент редактирования записи;
Инструмент удаления записи.

1.3.1. Чекбокс

Используется для выбора нескольких записей объектов. После выбора одной, или нескольких, записей появляется дополнительная кнопка удаления вверху реестра записей (). При наведении курсора на этот инструмент появляется информация о количестве выбранных для удаления записей.

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

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

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

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

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

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

- хук включен;

- хук отключен.

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

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

Используется для удаления хука из реестра записей. При наведении на кнопку удаления () отображается информация с названием инструмента. После нажатия кнопки удаления запись о хуке удаляется.

1.4. Пагинация

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

2.1. Добавление хука в очередь

Цель	Добавить хук в очередь

Цель	Добавить хук в очередь
Предусловия	Доступ к приложению Admin; Доступ к разделу "Очереди" в приложении Admin; Разрешение на редактирование, или создание, в разделе "Очереди"; Наличие очереди или создание новой.
Сценарий:	Нажать на кнопку добавления - . Открывается модальное окно "Добавить хук". Нажать на поле "События". Открывается выпадающий список существующих событий. Выбрать необходимое событие. Выпадающий список закрывается. Кнопка "Сохранить" становится активной. Нажать на поле "Схема". Открывается выпадающий список существующих схем. Выбрать необходимую схему. Выпадающий список закрывается. Нажать кнопку "Сохранить".
Результат	Модальное окно закрывается. Данные сохранены.

2.2. Удаление хука из очереди

Цель	Удалить хук из очереди

Цель	Удалить хук из очереди
Предусловия	Доступ к приложению Admin; Доступ к разделу "Очереди" в приложении Admin; Разрешение на редактирование, или создание, в разделе "Очереди"; Наличие очереди или создание новой; Наличие минимум одной записи хука.
Сценарий:	Найти запись хука, который необходимо удалить. Нажать кнопку удаления - .
Результат	Хук удален из реестра записей.

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

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

Цель	Заменить схему при конкретном событии
Предусловия	Доступ к приложению Admin; Доступ к разделу "Очереди" в приложении Admin; Разрешение на редактирование, или создание, в разделе "Очереди"; Наличие очереди или создание новой; Наличие минимум одной записи хука.
Сценарий:	Найти запись хука, в котором нужно заменить схему. Нажать кнопку редактирования- . Открывается модальное окно "Редактировать хук". Нажать на поле "Схема". Открывается выпадающим список существующих схем. Выбрать необходимую схему. Выпадающий список закрывается. Кнопка "Сохранить" становится активной. Нажать кнопку "Сохранить".
Результат	Модальное окно закрывается. Данные сохранены.

3. Вызовы веб-хуков

Вызов веб-хука на очереди происходит при наступлении некоторого события, после чего вызывается выбранная схема, созданная ранее.

Событие	Описание	Тип очереди, в которой используется	Поля, которые передаются
Событие	Описание	Тип очереди, в которой используется	Поле	Тип	Описание
Абонент вошел в очередь	абонент вошел в очередь	все очереди: оффлайн очередь; входящая очередь; исходящий IVR; превью обзвон; прогрессивный обзвон; предиктивный обзвон; входящая очередь чатов; очередь задач.	`channel`	string	канал (chat/call/task)
			`attempt_id`	integer	идентификатор попытки дозвона дайлера
			`destination`	string	номер назначения, на который поступает звонок
			`use_processing`	boolen	включена постобработка
			`agent_channel_id`	string	идентификатор сессии оператора (идентификатор звонка для оператора, нужен для использования API)
			`member_channel_id`	string	идентификатор сессии абонента (идентификатор звонка для абонента, нужен для использования API)
			+ все переменные, которые передаются с абонентом и в очереди
Принят оператором	оператор ответил на звонок	оффлайн очередь; превью обзвон.	`channel`	string	канал (chat/call/task)
			`attempt_id`	integer	идентификатор попытки дозвона дайлера
			`destination`	string	номер назначения, на который поступает звонок
			`use_processing`	boolen	включена постобработка
			`agent_channel_id`	string	идентификатор сессии оператора (идентификатор звонка для оператора, нужен для использования API)
			`member_channel_id`	string	идентификатор сессии абонента (идентификатор звонка для абонента, нужен для использования API)
			`agent_name`	string	имя оператора
			`agent_id`	integer	идентификатор оператора
			`user_id`	integer	идентификатор пользователя
			`agent_extension`	string	внутренний номер оператора
			`member_name`	string	имя абонента
			`member_id`	integer	идентификатор абонента
			`cc_attempt_seq`	integer	номер попытки
			`call_bill_sec`	number	время разговора абонента - с момента поднятия трубки абонентом до данного момента или окончания звонка
			`call_duration`	number	общее время звонка - длительность звонка от начала дозвона до данного момента или же его окончания (постобработка не учитывается)
			`amd_result`	string	результат автоопределения - HUMAN/MASHINE
			`call_voice_sec`	number	время разговора абонента с оператором - от начала соединения абонента с оператором, до окончания звонка
			+ все переменные, которые передаются с абонентом и в очереди
Распределение на оператора	на оператора распределился звонок	все очереди: оффлайн очередь; входящая очередь; исходящий IVR; превью обзвон; прогрессивный обзвон; предиктивный обзвон; входящая очередь чатов; очередь задач.	`channel`	string	канал (chat/call/task)
			`attempt_id`	integer	идентификатор попытки дозвона дайлера
			`destination`	string	номер назначения, на который поступает звонок
			`use_processing`	boolen	включена постобработка
			`agent_channel_id`	string	идентификатор сессии оператора (идентификатор звонка для оператора, нужен для использования API)
			`member_channel_id`	string	идентификатор сессии абонента (идентификатор звонка для абонента, нужен для использования API)
			`agent_name`	string	имя оператора
			`agent_id`	integer	идентификатор оператора
			`user_id`	integer	идентификатор пользователя
			`agent_extension`	string	внутренний номер оператора
			`member_name`	string	имя абонента
			`member_id`	integer	идентификатор абонента
			`cc_attempt_seq`	integer	номер попытки
			`call_bill_sec`	number	время разговора абонента - с момента поднятия трубки абонентом до данного момента или окончания звонка
			`call_duration`	number	общее время звонка - длительность звонка от начала дозвона до данного момента или же его окончания (постобработка не учитывается)
			`amd_result`	string	результат автоопределения - HUMAN/MASHINE
			`call_voice_sec`	number	время разговора абонента с оператором - от начала соединения абонента с оператором до окончания звонка
			+ все переменные, которые передаются с абонентом и в очереди
Соединение абонента с оператором	произошло соединение оператора с абонентом	все очереди: оффлайн очередь; входящая очередь; исходящий IVR; превью обзвон; прогрессивный обзвон; предиктивный обзвон; входящая очередь чатов; очередь задач.	`channel`	string	канал (chat/call/task)
			`attempt_id`	integer	идентификатор попытки дозвона дайлера
			`destination`	string	номер назначения, на который поступает звонок
			`use_processing`	boolen	включена постобработка
			`agent_channel_id`	string	идентификатор сессии оператора (идентификатор звонка для оператора, нужен для использования API)
			`member_channel_id`	string	идентификатор сессии абонента (идентификатор звонка для абонента, нужен для использования API)
			`agent_name`	string	имя оператора
			`agent_id`	integer	идентификатор оператора
			`user_id`	integer	идентификатор пользователя
			`agent_extension`	string	внутренний номер оператора
			`member_name`	string	имя абонента
			`member_id`	integer	идентификатор абонента
			`cc_attempt_seq`	integer	номер попытки
			`call_bill_sec`	number	время разговора абонента - с момента поднятия трубки абонентом до данного момента или окончания звонка
			`call_duration`	number	общее время звонка - длительность звонка от начала дозвона до данного момента или же его окончания (постобработка не учитывается)
			`amd_result`	string	результат автоопределения - HUMAN/MASHINE
			`call_voice_sec`	number	время разговора абонента с оператором - от начала соединения абонента с оператором до окончания звонка
			+ все переменные, которые передаются с абонентом и в очереди
Пропущенный оператором	оператор не ответил на звонок	очереди с участием оператора: оффлайн очередь; входящая очередь; превью обзвон; прогрессивный обзвон; предиктивный обзвон; входящая очередь чатов; очередь задач.	`channel`	string	канал (chat/call/task)
			`attempt_id`	integer	идентификатор попытки дозвона дайлера
			`destination`	string	номер назначения, на который поступает звонок
			`use_processing`	boolen	включена постобработка
			`agent_channel_id`	string	идентификатор сессии оператора (идентификатор звонка для оператора, нужен для использования API)
			`member_channel_id`	string	идентификатор сессии абонента (идентификатор звонка для абонента, нужен для использования API)
			`agent_name`	string	имя оператора
			`agent_id`	integer	идентификатор оператора
			`user_id`	integer	идентификатор пользователя
			`agent_extension`	string	внутренний номер оператора
			`member_name`	string	имя абонента
			`member_id`	integer	идентификатор абонента
			`cc_attempt_seq`	integer	номер попытки
			`call_bill_sec`	number	время разговора абонента - с момента поднятия трубки абонентом до данного момента или окончания звонка
			`call_duration`	number	общее время звонка - длительность звонка от начала дозвона до данного момента или же его окончания (постобработка не учитывается)
			`amd_result`	string	результат автоопределения - HUMAN/MASHINE
			+ все переменные, которые передаются с абонентом и в очереди
Абонент вышел из очереди	абонент покинул очередь	все очереди: оффлайн очередь; входящая очередь; исходящий IVR; превью обзвон; прогрессивный обзвон; предиктивный обзвон; входящая очередь чатов; очередь задач.	`channel`	string	канал (chat/call/task)
			`attempt_id`	integer	идентификатор попытки дозвона дайлера
			`destination`	string	номер назначения, на который поступает звонок
			`use_processing`	boolen	включена постобработка
			`agent_channel_id`	string	идентификатор сессии оператора (идентификатор звонка для оператора, нужен для использования API)
			`member_channel_id`	string	идентификатор сессии абонента (идентификатор звонка для абонента, нужен для использования API)
			`agent_name`	string	имя оператора
			`agent_id`	integer	идентификатор оператора
			`user_id`	integer	идентификатор пользователя
			`agent_extension`	string	внутренний номер оператора
			`member_name`	string	имя абонента
			`member_id`	integer	идентификатор абонента
			`cc_attempt_seq`	integer	номер попытки
			`cc_result`	string	результат звонка (sucess/cancel/abandoned)
			`call_bill_sec`	number	время разговора абонента - с момента поднятия трубки абонентом до данного момента, или окончания звонка
			`call_duration`	number	общее время звонка - длительность звонка от начала дозвона до данного момента или же его окончания (постобработка не учитывается)
			`call_cause`	string	причина окончания звонка (варианты возможных причин можно посмотреть здесь)
			`call_sip_code`	number	код окончания звонка (варианты можно посмотреть здесь в колонке SIP ответ)
			`amd_result`	string	результат автоопределения - HUMAN/MASHINE
			`call_voice_sec`	number	время разговора абонента с оператором - от начала соединения абонента с оператором до окончания звонка
			+ все переменные, которые передаются с абонентом и в очереди
Постобработка	оператор вошел в статус постобработки	очереди с участием оператора: оффлайн очередь; входящая очередь; превью обзвон; прогрессивный обзвон; предиктивный обзвон; входящая очередь чатов; очередь задач.	`channel`	string	канал (chat/call/task)
			`attempt_id`	integer	идентификатор попытки дозвона дайлера
			`destination`	string	номер назначения, на который поступает звонок
			`use_processing`	boolen	включена постобработка
			`agent_channel_id`	string	идентификатор сессии оператора (идентификатор звонка для оператора, нужен для использования API)
			`member_channel_id`	string	идентификатор сессии абонента (идентификатор звонка для абонента, нужен для использования API)
			`agent_name`	string	имя оператора
			`agent_id`	integer	идентификатор оператора
			`user_id`	integer	идентификатор пользователя
			`agent_extension`	string	внутренний номер оператора
			`member_name`	string	имя абонента
			`member_id`	integer	идентификатор абонента
			`cc_attempt_seq`	integer	номер попытки
			`call_bill_sec`	number	время разговора абонента - с момента поднятия трубки абонентом до данного момента или окончания звонка
			`call_duration`	number	общее время звонка - длительность звонка от начала дозвона до данного момента или же его окончания (постобработка не учитывается)
			`call_cause`	string	причина окончания звонка (варианты возможных причин можно посмотреть здесь)
			`call_sip_code`	number	код окончания звонка (варианты можно посмотреть здесь в колонке SIP ответ)
			`amd_result`	string	результат автоопределения - HUMAN/MASHINE
			`call_voice_sec`	number	время разговора абонента с оператором - от начала соединения абонента с оператором до окончания звонка
			+ все переменные, которые передаются с абонентом и в очереди
Активное действие	аналогично с Принят оператором, но не для звонков

1 1. Описание
2 2. Возможности
3 3. Вызовы веб-хуков

Webitel v24.10: Документация

Хуки (Прогрессивный обзвон)