Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
1. Описание
Предназначена для добавления хуков в очередь. Хуки используются при интеграции, если на какое-то событие со стороны Webitel необходимо отправлять данные в другую систему.
Состоит из таких элементов:
- Инструмент добавления (Рис.1 (1));
- Инструмент обновления списка реестра (Рис.1 (2));
- Реестр записей (Рис.1 (3));
- Пагинация (Рис.1 (4)).
Image RemovedImage Added
Рис. 1. Страница детали "Хуки"
1.1. Инструмент добавления
Include Page |
---|
Для добавления нового хука необходимо нажать кнопку добавления - Image Removed. После нажатия кнопки добавления открывается модальное окно "Хук" (Рис. 2), которое состоит из полей "События" и "Схема", а также кнопок "Сохранить" и "Закрыть".
Image Removed
Рис. 2. Модальное окно "Хук"
|
1.1.1. Поле "
СобытияСобытие"
Служит для выбора события. При нажатии на поле "Событие" открывается выпадающий список, из которого выбирается событие.
Существуют такие события:
- Абонент вошел в очередь;
- Принят оператором;
- Распределение на оператора;
- Соединение абонента с оператором;
- Пропущенный оператором;
- Абонент вышел из очереди;
- Постобработка;
- Активное действие.
1.1.2. Поле "Схема"
Здесь указывается какая схема будет прорабатываться при указанном событии.
При нажатии на поле "Схема" открывается выпадающий список, из которого выбирается схема. Если необходимой схемы нет в выпадающем списке, то используйте поле "Схема предварительного набора", как поле поиска.
Как создать новую схему можно посмотреть здесь.
1.2. Инструмент обновления реестра записей
(Рис.1 (2)). Include Page Инструмент обновления реестра записей Инструмент обновления реестра записей
1.3. Реестр записей
Реестр представляет собой список записей существующих объектов этого раздела. Каждая запись состоит из набора полей:
- Чекбокс;
- Колонка "Событие";
- Колонка "Схема";
- Колонка "Состояние";
- Инструмент редактирования записи;
- Инструмент удаления записи.
1.3.1. Чекбокс
Используется для выбора нескольких записей объектов. После выбора одной, или нескольких, записей появляется дополнительная кнопка удаления вверху реестра записей . При наведении курсора на этот инструмент появляется информация о количестве выбранных для удаления записей.
1.3.2 Колонка "Событие"
Здесь отображается имя события, при котором необходимо отправлять данные в другую систему.
1.3.3. Колонка "Схема"
Здесь отображается какая схема будет прорабатываться при указанном событии.
1.3.4. Колонка "Состояние"
Включает в себя переключатель, который отвечает за включение и отключения хука в соответствии с положением переключателя:
- хук включен;
- хук отключен.
1.3.5. Инструмент редактирования записи
Открывается нажатием на кнопку редактирования Image Removed, при наведение курсором на которую отображается информация с названием инструмента. После нажатия на эту кнопку открывается модальное окно "Хук" (Рис. 2).Include Page | ||||
---|---|---|---|---|
|
1.3.6. Инструмент удаления записи
Используется для удаления хука из реестра записей. При наведении на кнопку удаления отображается информация с названием инструмента. После нажатия кнопки удаления запись о хуке удаляется.
1.4. Пагинация
Include Page | ||||
---|---|---|---|---|
|
2. Возможности
2.1. Добавление хука в очередь
Цель | Создать хук |
---|---|
Предусловия |
|
Сценарий: |
|
Результат | Модальное окно закрывается. Данные сохранены. |
2.2. Удаление хука из очереди
Цель | Удалить хук из очереди |
---|---|
Предусловия |
|
Сценарий: |
|
Результат | Хук удален из реестра записей. |
2.3. Редактирование хука в очереди
Цель | Заменить схему при конкретном событии |
---|---|
Предусловия |
|
Сценарий: |
|
Результат | Модальное окно закрывается. Данные сохранены. |
3. Вызовы веб-хуков
Вызов веб-хука на очереди происходит при наступлении некоторого события, после чего вызывается выбранная схема, созданная ранее.
Событие | Описание | Тип очереди, в которой используется | Поля, которые передаются | ||
---|---|---|---|---|---|
Поле | Тип | Описание | |||
Абонент вошел в очередь | абонент вошел в очередь | все очереди:
|
| string | канал (chat/call/task) |
attempt_id | integer | идентификатор попытки дозвона дайлера | |||
destination | string | номер назначения, на который поступает звонок | |||
use_processing | boolen | включена постобработка | |||
agent_channel_id | string | идентификатор сессии оператора (идентификатор звонка для оператора, нужен для использования API) | |||
member_channel_id | string | идентификатор сессии абонента (идентификатор звонка для абонента, нужен для использования API) | |||
+ все переменные, которые передаются с абонентом и в очереди | |||||
Принят оператором | оператор ответил на звонок |
|
| 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 | время разговора абонента с оператором - от начала соединения абонента с оператором, до окончания звонка | |||
+ все переменные, которые передаются с абонентом и в очереди | |||||
Распределение на оператора | на оператора распределился звонок | все очереди:
|
| 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 | время разговора абонента с оператором - от начала соединения абонента с оператором до окончания звонка | |||
+ все переменные, которые передаются с абонентом и в очереди | |||||
Соединение абонента с оператором | произошло соединение оператора с абонентом | все очереди:
|
| 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 | время разговора абонента с оператором - от начала соединения абонента с оператором до окончания звонка | |||
+ все переменные, которые передаются с абонентом и в очереди | |||||
Пропущенный оператором | оператор не ответил на звонок | очереди с участием оператора:
|
| 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 | |||
+ все переменные, которые передаются с абонентом и в очереди | |||||
Абонент вышел из очереди | абонент покинул очередь | все очереди:
|
| 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 | время разговора абонента с оператором - от начала соединения абонента с оператором до окончания звонка | |||
+ все переменные, которые передаются с абонентом и в очереди | |||||
Постобработка | оператор вошел в статус постобработки | очереди с участием оператора:
|
| 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 | время разговора абонента с оператором - от начала соединения абонента с оператором до окончания звонка | |||
+ все переменные, которые передаются с абонентом и в очереди | |||||
Активное действие | аналогично с Принят оператором, но не для звонков |
Table of Contents |
---|