1. Опис

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

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

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

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

Для додавання нового хука необхідно натиснути кнопку додавання - . Після натискання кнопки відкривається модальне вікно "Додати хук" (Рис. 2), яке складається з полів "Подія" та "Схема", а також кнопок "Зберегти" та "Закрити".

1.1.1. Поле "Подія"

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

Існують такі події:

Абонент увійшов до черги;
Прийнятий оператором;
Розподілення на оператора;
З'єднання абонента з оператором;
Пропущений оператором;
Абонент вийшов із черги;
Постобробка;
Активна дія.

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

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

При натисканні на поле "Схема" відкривається список з якого вибирається схема. Якщо потрібної схеми немає у списку, використовуйте поле "Схема”, як поле пошуку.

Як створити нову схему, можна подивитися тут.

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

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

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

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

Чекбокс;
Поле "Подія";
Поле “Схема";
Перемикач “Стан”;
Інструмент редагування запису;
Інструмент видалення запису.

1.3.1. Чекбокс

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

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

1.3.2 Поле "Подія"

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

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

Схема, що опрацьовується при зазначеній події, відображається тут.

1.3.4. Поле "Стан"

Перемикач відповідає за включення та відключення хука відповідно до його положення:

- хук увімкнений;

- хук вимкнений.

1.3.5. Інструмент редагування запису

Відкривається натисканням кнопки редагування , при наведенні курсором на яку відображається інформація з назвою інструменту. Після натискання на цю кнопку відкривається модальне вікно "Редагувати хук" (Рис. 4), де можна зробити зміни.

Модальне вікно Редагувати хук (Черги).png

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

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

Рис. 5. Модальне вікно підтвердження

1.4. Пагінація

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

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

2.1. Додавання хука в чергу

Ціль

Додати хук в чергу

Передумови

/wiki/spaces/WEB/pages/253493327";
Доступ до розділу "Черги" в Admin;
Дозвіл на створення і редагування у розділі "Черги";
Наявність щонайменше одної черги, або створення нової.

Сценарій:

Натиснути на кнопку додавання - . Відкривається модальне вікно "Додати хук".
Натиснути на поле "Подія". Відкривається список можливих варіантів.
Вибрати потрібний.
Натиснути на поле "Схема". Відкривається список наявних схем.
Вибрати потрібний. Список закривається. Кнопка "Зберегти" стає активною.
Натиснути кнопку "Зберегти".

Результат

Модальне вікно закривається. Дані збережено. Запис додано до реєстру.

2.2. Видалення хука з черги

Ціль

Видалити хук з черги

Передумови

/wiki/spaces/WEB/pages/253493327";
Доступ до розділу "Черги" в Admin;
Дозвіл на створення і редагування у розділі "Черги";
Наявність щонайменше одної черги, або створення нової;
Наявність щонайменше одного запису про хук.

Сценарій:

Знайти запис про хук, який необхідно видалити.
Натиснути кнопку видалення - . Відкривається модальне вікно для підтвердження видалення.
Натиснути кнопку “Так”.

Результат

Модальне вікно закривається. Хук видалено з черги.

2.3. Редагування хука у черзі

Ціль

Замінити схему для конкретної події

Передумови

/wiki/spaces/WEB/pages/253493327";
Доступ до розділу "Черги" в 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.1. Інструмент додавання

1.1.1. Поле "Подія"

1.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. Додавання хука в чергу

2.2. Видалення хука з черги

2.3. Редагування хука у черзі

3. Виклик вебхуків