Хуки (Прев'ю-обдзвін)

1. Опис

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

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

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

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

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

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

Сторінка деталі Хуки (Прев'ю-обдзвін).png
Рис. 1. Сторінка деталі "Хуки"

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

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

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

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

  1. Чекбокс;

  2. Поле "Подія";

  3. Поле “Схема";

  4. Перемикач “Стан”;

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

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

1.3.1. Чекбокс

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1.4. Пагінація

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

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

Ціль

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

Ціль

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

Передумови

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

  2. Доступ до розділу "Черги" в Admin;

  3. Дозвіл на створення і редагування у розділі "Черги";

  4. Наявність щонайменше одної черги, або створення нової.

Сценарій:

 

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

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

  3. Вибрати потрібний.

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

  5. Вибрати потрібний. Список закривається. Кнопка "Зберегти" стає активною.

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

Результат

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

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

Ціль

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

Ціль

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

Передумови

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

  2. Доступ до розділу "Черги" в Admin;

  3. Дозвіл на створення і редагування у розділі "Черги";

  4. Наявність щонайменше одної черги, або створення нової;

  5. Наявність щонайменше одного запису про хук.

Сценарій:

 

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

  2. Натиснути кнопку видалення - image-20241105-123741.png. Відкривається модальне вікно для підтвердження видалення.

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

Результат

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

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

Ціль

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

Ціль

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

Передумови

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

  2. Доступ до розділу "Черги" в Admin;

  3. Дозвіл на створення і редагування у розділі "Черги";

  4. Наявність щонайменше одної черги, або створення нової;

  5. Наявність, мінімум, одного запису про хук.

Сценарій:

 

  1. Знайти запис, який необхідно змінити.

  2. Натиснути кнопку редагування - image-20241105-124245.png. Відкривається модальне вікно "Редагувати хук".

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

  4. Вибрати потрібну схему. Список закривається. Кнопка "Зберегти" стає активною.

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

Результат

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

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

час розмови абонента з оператором – від початку з'єднання абонента з оператором до закінчення дзвінка

+ усі змінні, які передаються з абонентом та у черзі

 

 

Активна дія

аналогічно з Прийнятий оператором,
але не для дзвінків