Oktell - Вклад участника [ru]

Функции

2026-04-16T13:42:33Z

Oktell Support:

<code>[[Техническая документация]] / [[Call-центр]] или [[Администрирование]] / [[Сценарии]] / [[Функции]] </code>

Встроенная функция сценария осуществляет доступ к некоторым данным в момент выполнения сценария обработчиком.

Среди функций можно выделить несколько типов по направлению их действия:

* Оперирующие конкретным звонком и обслуживающей линией;
* Временные;
* Общие серверные (определяющие некоторые состояния системы);
* Специальные функции конкретного типа сценария.

Для задания функции сценария служит соответствующая вкладка окна [[Аргументы|Аргумент]]. Значение функции вычисляется в момент обработки сценария и подставляется в качестве аргумента текущего выполняемого объекта (свойства объекта) сценария.

[[Файл:cl_cc_scra_f1_4.png|center]]

Список встроенных функций сценариев.

В столбце типов указывается при редактировании каких типов сценариев доступна та или иная функция (IVR, Д-диалоговый, С-служебный)

{|cellpadding="10" cellspacing="0" border="1"
!Функция
!Тип возвращ. значения
!Типы сценариев
(IVR, Д, С)
!Описание
|-
|Id сессии сценария
|Строка
|Все
|Текущий уникальный код сессии сценария (строковое представление GUID), в соответствии с которым осуществляется доступ к хранилищу глобальных переменных, формируются цепочки коммутаций при дозвоне.
|-
|Текущая дата
|Дата/время
|Все
|Текущая дата.
|-
|Текущий год
|Число
|Все
|Текущий год.
|-
|Текущий месяц
|Число
|Все
|Текущий месяц.
|-
|Текущий день
|Число
|Все
|Текущий день.
|-
|Текущий день недели
|Число
|Все
|Текущий день недели (1-7).
|-
|Текущее время
|Строка
|Все
|Текущее время.
|-
|Текущий час
|Число
|Все
|Текущий час.
|-
|Текущая минута
|Число
|Все
|Текущая минута.
|-
|Текущая секунда
|Число
|Все
|Текущая секунда.
|-
|Номер абонента (CallerId)
|Строка
|IVR, Д
|Для внешних линий - определитель номера абонента (если не определен – строка «Номер не определен»).
Для внутренних линий (только в IVR) - номер пользователя, который обслуживается в сценарии. В качестве номера возвращается строка, начинающаяся с символа «U» и соответствующая прямому сервисному внутреннему номеру, назначенному на пользователя. Такие номера недоступны для набора непосредственно с телефона из-за спец.символов и используются только для служебных целей. Этот номер может быть подставлен в качестве аргумента в компоненты сценария, имеющие свойство «Внутренний номер получателя» (Уведомление, Голосовая почта и др.).
|-
|Набранный (внешний) номер (CalledId)
|Строка
|IVR, Д
|Номер, по которому дозвонился абонент (актуально для потоков Е1). Если номер не определился – подставляется значение из свойства внешней линии.
Для внутренних линий (только в IVR) - номер, по которому был осуществлен вход в текущий сценарий из АТС. При звонке с IP-телефона: если номер дозвона в АТС в начальных символах содержит внутренний номер для входа в сценарий, то в сценарии функция вернет всю последовательность. Например: номер сценария 25, на IP телефоне набрали 2511 CALL => функция вернет 2511.
|-
|XML-INFO абонента
|Строка
|IVR, Д
|Строка, сформированная внешним приложением, и переданная вместе со звонком из собственного интеграционного модуля SipClient (подробнее в руководстве по интеграции, раздел «Звонок разработчику»). Может быть подвергнута разбору в сценарии и использована для проведения произвольной маршрутизации вызова. Вызов поступает на каналы шлюзов с типом регистрации [[Свойства компонентов#IP шлюз|Вхощящие из COM-клиента]].
|-
|Guid-идентификатор пользователя
|Строка
|IVR
|Строка, содержащая идентификатор пользователя, который обслуживается в сценарии.
|-
|Имя пользователя
|Строка
|IVR
|Используется для внутренних линий всех типов, которые связаны с пользователем. Для остальных возвращает пустую строку.
Имя обслуживаемого в сценарии пользователя.
|-
|Номер пользователя внутри АТС
|Строка
|IVR
|Используется для внутренних линий всех типов. Для внешних возвращает пустую строку.
Определяет внутренний стандартный номер, по которому можно дозвониться до обслуживаемой линии (и/или пользователя) - далее обслуживаемые объекты.
Если во внутреннем номерном плане содержатся несколько номеров со ссылками на обслуживаемые объекты, то будет выбран негрупповой - тот, в списке ссылок которого присутствует единственный объект - обслуживаемый (линия или пользователь). Если негрупповой номер отсутствует, то преимущественно будет выбран групповой номер с наименьшим значением. ''(Из двух групповых номеров 203 и 405, будет выбран 203)''
|-
|Тип линии
|Строка
|IVR, Д
|Число, определяющее типа линии
* 1 - Внешняя аналоговая
* 2 - Внутренняя аналоговая
* 3 - VoIP канал
* 4 - Внешняя GSM
* 5 - IP
* 6 - Канал потока Е1
* 7 - Внешняя SIP
* 8 - Внутренний транк на шлюз SIP
* 11 - Внешний SIP канал из потока шлюза с динамической регистрацией
* 13 - Транк для межсерверного взаимодействия
|-
|Guid-идентификатор линии
|Строка
|Все
|Строка с guid-идентификтором обслуживаемой сценарием линии.
В служебном сценарии функция возвращает непустое значение только в некоторых режимах, например при использовании сценария в качестве [[Параметры АТС|преобразователя callerid]] на входящих вызовах.
|-
|Номер линии
|Строка
|Все
|Строка, определяющая номер линии по классификации АТС Oktell (11001, 15049 и т.п.), обслуживаемой текущим сценарием. Список линий и их номеров доступен в модуле [[Линии|Администрирование.Линии]].
В служебном сценарии функция возвращает непустое значение только в некоторых режимах, например при использовании сценария в качестве [[Параметры АТС|преобразователя callerid]] на входящих вызовах.
|-
|Код линии
|Строка
|Все
|Строка с кодом линии, назначенным в модуле [[Линии|Администрирование.Линии]].
В служебном сценарии функция возвращает непустое значение только в некоторых режимах, например при использовании сценария в качестве [[Параметры АТС|преобразователя callerid]] на входящих вызовах.
|-
|Код направления
|Строка
|IVR
|Строка, определяющая код первого найденного активного [[Линии#Направления|направления]], в котором присутствует обслуживаемая IVR-сценарием линия. В случае, если линии назначены в несколько направлений и нужно уточнить принадлежность линии к определенному, лучше воспользоваться компонентом [[Общие_компоненты_сценариев#Статус объекта|«Статус объекта»]].
|-
|Номер линии, ожидающей во Flash-буфере
|Строка
|IVR
|В случае, если у обслуживаемой текущим сценарием линии во Flash буфере находится в ожидании некоторый абонент, то функция возвращает строку с номером ожидающей линии по классификации АТС Oktell. В противном случае возвращается пустая строка.
|-
|Номер линии, осуществившей переключение
|Строка
|IVR
|В случае, если запущенный сценарий был переведен другой линией в результате использования Flash-удержания, возвращается строка с ее номером по классификации АТС Oktell.
В остальных случаях возвращается пустая строка.
|-
|Название активного фонового IVR-сценария медиа-взаимодействия
|Строка
|IVR
|В случае, если в настоящее время активен [[Фоновый IVR-сценарий медиа-взаимодействия|фоновый сценарий медиа-взаимодействия]] с текущей обслуживаемой линий, возвращает его название. Иначе возвращается пустая строка.
|-
|Время в текущем сценарии
|Число
|Все
|Время в секундах, прошедшее после запуска непосредственно текущего сценария.
|-
|Время в обработчике сценариев
|Число
|Все
|Время в секундах, прошедшее после запуска текущей сессии сценариев.
|-
|Название текущего сценария
|Строка
|Все
|Название текущего выполняемого сценария
|-
|Тип соединения
|Число
|IVR, Д
|
* 1–Звонок с внутренней линии на внешнюю (Только диалоговый)
* 2–Звонок с внутренней линии в IVR
* 4–Звонок с внешней линии в IVR
* 5–Звонок с внешней линии на внутреннюю (Только диалоговый)
* 7–Звонок из IVR на внешнюю линию (из задачи)
* 8–Звонок из IVR на внутреннюю линию (из задачи)
|-
|Количество свободных внешних линий
|Число
|IVR, Д
|Число свободных внешних линий, находящихся в активном состоянии.
|-
|Количество абонентов на набранном номере
|Число
|IVR, Д
|Число абонентов, дозвонившихся на тот же номер, что и текущий абонент. Используется для обрубания вызовов по конкретным номерам при превышении лимита допустимого количества подключений.
|-
|Количество зарегистрированных операторов
|Число
|Все
|Число операторов, находящихся в call-центре онлайн (в свободном и занятом режимах, исключая перерывы).
|-
|Количество свободных операторов
|Число
|Все
|Число операторов, находящихся в call-центре в свободном состоянии, готовых обработать вызов незамедлительно.
|-
|Случайное число
|Число
|Все
|Случайное число от 0 до 999999 (равномерное распределение).
|-
|Id оператора
|Строка
|Д
|Идентификатор текущего оператора в виде
«00000000-0000-0000-0000-000000000000».
Необходимо помнить, что в ходе обработки сценария диалога операторы могут переключаться.
|-
|Имя оператора
|Строка
|Д
|Имя текущего оператора.
|-
|Внутренний номер оператора (Uguid)
|Строка
|Д
|Номер оператора, обслуживающего текущий звонок. Кодовое представление номера. Необходим для компонентов «Уведомление», «Определение статуса», и других, в которых требуется указание номера.
|-
|Хост оператора
|Строка
|Д
|Имя компьютера оператора, обслуживающего текущий звонок.
|-
|Id проекта
|Строка
|Все
|Идентификатор проекта текущей задачи, в ходе обработки которой был запущен сценарий.
|-
|Название проекта
|Строка
|Все
|Название проекта текущей задачи, в ходе обработки которой был запущен сценарий.
|-
|Id задачи
|Строка
|Все
|Идентификатор текущей задачи, в ходе обработки которой был запущен сценарий.
|-
|Код задачи
|Строка
|Все
|Код текущей задачи, в ходе обработки которой был запущен сценарий.
|-
|Название задачи
|Строка
|Все
|Название текущей задачи, в ходе обработки которой был запущен сценарий.
|-
|Параметр задачи
|Число
|Все
|Параметр запуска сценария, переданный из задачи, куда попал в свое время в момент ее создания из компонента «Задание на звонок».
|-
|Id абонента в списке
|Число
|Все
|Идентификатор абонента в прикрепленной таблице абонентов.
|-
|Id коммутации
|Строка
|IVR, Д
|Уникальный идентификатор коммутации.
|-
|Id цепочки коммутаций
|Строка
|IVR, Д
|Уникальный идентификатор звонка (сессии) внутри АТС Oktell.
|-
|Id sip-сессии
|Строка
|IVR
|По умолчанию уникальный идентификатор sip-сессии из поля «Call-ID».
|-
|КС: идентификатор
|Строка
|С
|При запуске служебного сценария для обработки контрольного события Guid-идентификатор контрольного события в строковом представлении.
|-
|КС: название
|Строка
|С
|При запуске служебного сценария для обработки контрольного события название контрольного события.
|-
|КС: идентификатор задачи
|Строка
|С
|При запуске служебного сценария для обработки контрольного события Guid-идентификатор задачи, в которой событие обнаружено, в строковом представлении.
|-
|КС: идентификатор оператора
|Строка
|С
|При запуске служебного сценария для обработки контрольного события Guid-идентификатор оператора, совершившего контрольное событие, в строковом представлении
|-
|КС: показатель
|Число
|С
|При запуске служебного сценария для обработки контрольного события числовой показатель соответствующего события.
|-
|КС: описание
|Строка
|С
|При запуске служебного сценария для обработки контрольного события дополнительное текстовое поле с информацией о деталях события.
|-
|Инициатор запуска. Код типа
|Строка
|С
|Определяет код модуля-иницатора запуска служебного сценария.
* 10 - Контрольное событие.
* 11 - Дозвон из задачи на внешний номер.
* 12 - Автодозвон на внешний номер.
* 13 - Строковое преобразование.
* 14 - Запуск по инициативе клиентского приложения (из модуля администрирования, из плагина, либо из внешнего интегрированного приложения).
* 15 - Набор быстрого номера.
* 16 - Набор экстренного номера.
* 17 - Набор внутреннего номера при приглашении в конференцию.
* 18 - Набор внутреннего номера из автодозвона.
* 19 - Прерывание вызова внутреннего номера в конференции.
* 20 - Обработка завершения конференции.
* 21 - Поиск абонента для голосовой задачи в режиме работы с таблицей абонентов через сценарий.
* 22 - Обработка завершения звонка/попытки звонка в голосовой задаче.
* 23 - Набор внешнего номера из конференции.
* 24 - Набор внешнего номера, указанного в стандартном внутреннем.
* 25 - Обработка завершения сессии внешнего канала (обработка контента линии по общему сценарию АТС).
* 26 - Обработка завершения сессии внешнего канала (обработка контента линии по сценарию задачи).
* 27 - Обработка веб-запроса к серверу на запуск сценария.
* 28 - Определение абонента при входящем вызове.
* 29 - Отправка SMS.
* 30 - Отправка E-mail.
|-
|Инициатор дозвона. Тип
|Строка
|С
|Определяет название модуля-инициатора запуска служебного сценария в некоторых режимах.
* «КС» - контрольное событие.
* «Задача» - сценарий запущен как набор номера в задаче.
* «АДЗ» - сценарий запущен как набор номера в автодозвоне.
* «Быстрый» - сценарий запущен как набор быстрого/внешнего номера.
* «Экстренный» - сценарий запущен как набор экстренного номера.
* «Внутренний из конференции» - сценарий запущен как набор внутреннего номера из конференции.
* «Внутренний из АДЗ» - сценарий запущен как набор внутреннего номера из АДЗ.
В других случаях возвращается пустая строка.
|-
|Инициатор дозвона. Идентификатор (задача/пользователь)
|Строка
|С
|Для вышеприведенных типов запуска служебного сценария возвращает Guid-идентификатор в строковом представлении соответственно контрольного события, задачи, пользователя, запустившего автодозвон. В других случаях возвращается пустая строка.
|-
|Инициатор дозвона. Имя (задача/пользователь)
|Строка
|С
|Для вышеприведенных типов запуска служебного сценария возвращает название соответственно контрольного события, задачи, пользователя, запустившего автодозвон. В других случаях возвращается пустая строка.
|-
|Инициатор дозвона. Внутренний номер (пользователь)
|Строка
|С
|Для режима запуска служебного сценария в качестве набора номера в режиме автодозвона возвращает внутренний номер пользователя, инициировавшего автодозвон. В других случаях возвращается пустая строка.
|-
|Конференция. Идентификатор (Guid)
|Строка
|C
|Задано при запуске сценариев, связанных с конференцией (набор номера, отмена, обработка завершения). Строковое представление GUID-идентификатора связанной конференции.
|-
|Конференция. Код идентификатора (Int32)
|Число
|C
|Задано при запуске сценариев, связанных с конференцией (набор номера, отмена, обработка завершения). Число, являющееся довольно уникальной функцией от GUID-идентификатора связанной конференции. Может быть использовано для идентификации конференции при входе из IVR-сценария.
|-
|Конференция. Номер комнаты
|Число
|C
|Задано при запуске сценариев, связанных с конференцией (набор номера, отмена, обработка завершения). Номер комнаты связанной конференции.
|-
|Конференция. Идентификатор участника (Guid)
|Строка
|C
|Задано при запуске сценариев, связанных с конференцией (набор номера, отмена набора номера). GUID-идентификатор связанного участника связанной конференции. Применяется при организации внешней очереди для привязки звонка к конкретному участнику конференции, находящемуся в состоянии ожидания ответа.
|-
|Конференция. Код идентификатора участника (Int32)
|Число
|C
|Задано при запуске сценариев, связанных с конференцией (набор номера, отмена набора номера). Число, являющееся довольно уникальной функцией от GUID-идентификатора связанного участника связанной конференции. Может быть использовано для идентификации конференции при входе из IVR-сценария.
|-
|Входной параметр 1
|Строка
|С
|Входной параметр 1, передаваемый на старт служебного сценария. Совпадает с параметром, сохраняемым в компоненте «Старт».
|-
|Входной параметр 2
|Строка
|С
|Входной параметр 2, передаваемый на старт служебного сценария.
В сценариях преобразования CallerId содержит внешний номер (CalledId).
Может быть установлен при запуске сценария по инициативе плагинов и внешнего ПО, подключенного через ядро клиентского уровня платформы. Также используется для передачи служебной информации при использовании служебных сценариев - триггеров, обработчиков, набора номера.
|-
|Входной параметр 3
|Строка
|С
|Входной параметр 3, передаваемый на старт служебного сценария.
Может быть установлен при запуске сценария по инициативе плагинов и внешнего ПО, подключенного через ядро клиентского уровня платформы. Также используется для передачи служебной информации при использовании служебных сценариев - триггеров, обработчиков, набора номера.
|-
|Входной параметр 4
|Строка
|С
|Входной параметр 4, передаваемый на старт служебного сценария.
Может быть установлен при запуске сценария по инициативе плагинов и внешнего ПО, подключенного через ядро клиентского уровня платформы. Также используется для передачи служебной информации при использовании служебных сценариев - триггеров, обработчиков, набора номера.
|-
|Входной параметр 5
|Строка
|С
|Входной параметр 5, передаваемый на старт служебного сценария.
Может быть установлен при запуске сценария по инициативе плагинов и внешнего ПО, подключенного через ядро клиентского уровня платформы. Также используется для передачи служебной информации при использовании служебных сценариев - триггеров, обработчиков, набора номера.
|}

Функции

2026-04-16T13:42:00Z

Oktell Support:

<code>[[Техническая документация]] / [[Call-центр]] или [[Администрирование]] / [[Сценарии]] / [[Функции]] </code>

Встроенная функция сценария осуществляет доступ к некоторым данным в момент выполнения сценария обработчиком.

Среди функций можно выделить несколько типов по направлению их действия:

* Оперирующие конкретным звонком и обслуживающей линией;
* Временные;
* Общие серверные (определяющие некоторые состояния системы);
* Специальные функции конкретного типа сценария.

Для задания функции сценария служит соответствующая вкладка окна [[Аргументы|Аргумент]]. Значение функции вычисляется в момент обработки сценария и подставляется в качестве аргумента текущего выполняемого объекта (свойства объекта) сценария.

[[Файл:cl_cc_scra_f1_4.png|center]]

Список встроенных функций сценариев.

В столбце типов указывается при редактировании каких типов сценариев доступна та или иная функция (IVR, Д-диалоговый, С-служебный)

{|cellpadding="10" cellspacing="0" border="1"
!Функция
!Тип возвращ. значения
!Типы сценариев
(IVR, Д, С)
!Описание
|-
|Id сессии сценария
|Строка
|Все
|Текущий уникальный код сессии сценария (строковое представление GUID), в соответствии с которым осуществляется доступ к хранилищу глобальных переменных, формируются цепочки коммутаций при дозвоне.
|-
|Текущая дата
|Дата/время
|Все
|Текущая дата.
|-
|Текущий год
|Число
|Все
|Текущий год.
|-
|Текущий месяц
|Число
|Все
|Текущий месяц.
|-
|Текущий день
|Число
|Все
|Текущий день.
|-
|Текущий день недели
|Число
|Все
|Текущий день недели (1-7).
|-
|Текущее время
|Строка
|Все
|Текущее время.
|-
|Текущий час
|Число
|Все
|Текущий час.
|-
|Текущая минута
|Число
|Все
|Текущая минута.
|-
|Текущая секунда
|Число
|Все
|Текущая секунда.
|-
|Номер абонента (CallerId)
|Строка
|IVR, Д
|Для внешних линий - определитель номера абонента (если не определен – строка «Номер не определен»).
Для внутренних линий (только в IVR) - номер пользователя, который обслуживается в сценарии. В качестве номера возвращается строка, начинающаяся с символа «U» и соответствующая прямому сервисному внутреннему номеру, назначенному на пользователя. Такие номера недоступны для набора непосредственно с телефона из-за спец.символов и используются только для служебных целей. Этот номер может быть подставлен в качестве аргумента в компоненты сценария, имеющие свойство «Внутренний номер получателя» (Уведомление, Голосовая почта и др.).
|-
|Набранный (внешний) номер (CalledId)
|Строка
|IVR, Д
|Номер, по которому дозвонился абонент (актуально для потоков Е1). Если номер не определился – подставляется значение из свойства внешней линии.
Для внутренних линий (только в IVR) - номер, по которому был осуществлен вход в текущий сценарий из АТС. При звонке с IP-телефона: если номер дозвона в АТС в начальных символах содержит внутренний номер для входа в сценарий, то в сценарии функция вернет всю последовательность. Например: номер сценария 25, на IP телефоне набрали 2511 CALL => функция вернет 2511.
|-
|XML-INFO абонента
|Строка
|IVR, Д
|Строка, сформированная внешним приложением, и переданная вместе со звонком из собственного интеграционного модуля SipClient (подробнее в руководстве по интеграции, раздел «Звонок разработчику»). Может быть подвергнута разбору в сценарии и использована для проведения произвольной маршрутизации вызова. Вызов поступает на каналы шлюзов с типом регистрации [[Свойства компонентов#IP шлюз|Вхощящие из COM-клиента]].
|-
|Guid-идентификатор пользователя
|Строка
|IVR
|Строка, содержащая идентификатор пользователя, который обслуживается в сценарии.
|-
|Имя пользователя
|Строка
|IVR
|Используется для внутренних линий всех типов, которые связаны с пользователем. Для остальных возвращает пустую строку.
Имя обслуживаемого в сценарии пользователя.
|-
|Номер пользователя внутри АТС
|Строка
|IVR
|Используется для внутренних линий всех типов. Для внешних возвращает пустую строку.
Определяет внутренний стандартный номер, по которому можно дозвониться до обслуживаемой линии (и/или пользователя) - далее обслуживаемые объекты.
Если во внутреннем номерном плане содержатся несколько номеров со ссылками на обслуживаемые объекты, то будет выбран негрупповой - тот, в списке ссылок которого присутствует единственный объект - обслуживаемый (линия или пользователь). Если негрупповой номер отсутствует, то преимущественно будет выбран групповой номер с наименьшим значением. ''(Из двух групповых номеров 203 и 405, будет выбран 203)''
|-
|Тип линии
|Строка
|IVR, Д
|Число, определяющее типа линии
* 1 - Внешняя аналоговая
* 2 - Внутренняя аналоговая
* 3 - VoIP канал
* 4 - Внешняя GSM
* 5 - IP
* 6 - Канал потока Е1
* 7 - Внешняя SIP
* 8 - Внутренний транк на шлюз SIP
* 11 - Внешний sip канал из потока шлюза с динамической регистрацией
* 13 - Транк для межсерверного взаимодействия
|-
|Guid-идентификатор линии
|Строка
|Все
|Строка с guid-идентификтором обслуживаемой сценарием линии.
В служебном сценарии функция возвращает непустое значение только в некоторых режимах, например при использовании сценария в качестве [[Параметры АТС|преобразователя callerid]] на входящих вызовах.
|-
|Номер линии
|Строка
|Все
|Строка, определяющая номер линии по классификации АТС Oktell (11001, 15049 и т.п.), обслуживаемой текущим сценарием. Список линий и их номеров доступен в модуле [[Линии|Администрирование.Линии]].
В служебном сценарии функция возвращает непустое значение только в некоторых режимах, например при использовании сценария в качестве [[Параметры АТС|преобразователя callerid]] на входящих вызовах.
|-
|Код линии
|Строка
|Все
|Строка с кодом линии, назначенным в модуле [[Линии|Администрирование.Линии]].
В служебном сценарии функция возвращает непустое значение только в некоторых режимах, например при использовании сценария в качестве [[Параметры АТС|преобразователя callerid]] на входящих вызовах.
|-
|Код направления
|Строка
|IVR
|Строка, определяющая код первого найденного активного [[Линии#Направления|направления]], в котором присутствует обслуживаемая IVR-сценарием линия. В случае, если линии назначены в несколько направлений и нужно уточнить принадлежность линии к определенному, лучше воспользоваться компонентом [[Общие_компоненты_сценариев#Статус объекта|«Статус объекта»]].
|-
|Номер линии, ожидающей во Flash-буфере
|Строка
|IVR
|В случае, если у обслуживаемой текущим сценарием линии во Flash буфере находится в ожидании некоторый абонент, то функция возвращает строку с номером ожидающей линии по классификации АТС Oktell. В противном случае возвращается пустая строка.
|-
|Номер линии, осуществившей переключение
|Строка
|IVR
|В случае, если запущенный сценарий был переведен другой линией в результате использования Flash-удержания, возвращается строка с ее номером по классификации АТС Oktell.
В остальных случаях возвращается пустая строка.
|-
|Название активного фонового IVR-сценария медиа-взаимодействия
|Строка
|IVR
|В случае, если в настоящее время активен [[Фоновый IVR-сценарий медиа-взаимодействия|фоновый сценарий медиа-взаимодействия]] с текущей обслуживаемой линий, возвращает его название. Иначе возвращается пустая строка.
|-
|Время в текущем сценарии
|Число
|Все
|Время в секундах, прошедшее после запуска непосредственно текущего сценария.
|-
|Время в обработчике сценариев
|Число
|Все
|Время в секундах, прошедшее после запуска текущей сессии сценариев.
|-
|Название текущего сценария
|Строка
|Все
|Название текущего выполняемого сценария
|-
|Тип соединения
|Число
|IVR, Д
|
* 1–Звонок с внутренней линии на внешнюю (Только диалоговый)
* 2–Звонок с внутренней линии в IVR
* 4–Звонок с внешней линии в IVR
* 5–Звонок с внешней линии на внутреннюю (Только диалоговый)
* 7–Звонок из IVR на внешнюю линию (из задачи)
* 8–Звонок из IVR на внутреннюю линию (из задачи)
|-
|Количество свободных внешних линий
|Число
|IVR, Д
|Число свободных внешних линий, находящихся в активном состоянии.
|-
|Количество абонентов на набранном номере
|Число
|IVR, Д
|Число абонентов, дозвонившихся на тот же номер, что и текущий абонент. Используется для обрубания вызовов по конкретным номерам при превышении лимита допустимого количества подключений.
|-
|Количество зарегистрированных операторов
|Число
|Все
|Число операторов, находящихся в call-центре онлайн (в свободном и занятом режимах, исключая перерывы).
|-
|Количество свободных операторов
|Число
|Все
|Число операторов, находящихся в call-центре в свободном состоянии, готовых обработать вызов незамедлительно.
|-
|Случайное число
|Число
|Все
|Случайное число от 0 до 999999 (равномерное распределение).
|-
|Id оператора
|Строка
|Д
|Идентификатор текущего оператора в виде
«00000000-0000-0000-0000-000000000000».
Необходимо помнить, что в ходе обработки сценария диалога операторы могут переключаться.
|-
|Имя оператора
|Строка
|Д
|Имя текущего оператора.
|-
|Внутренний номер оператора (Uguid)
|Строка
|Д
|Номер оператора, обслуживающего текущий звонок. Кодовое представление номера. Необходим для компонентов «Уведомление», «Определение статуса», и других, в которых требуется указание номера.
|-
|Хост оператора
|Строка
|Д
|Имя компьютера оператора, обслуживающего текущий звонок.
|-
|Id проекта
|Строка
|Все
|Идентификатор проекта текущей задачи, в ходе обработки которой был запущен сценарий.
|-
|Название проекта
|Строка
|Все
|Название проекта текущей задачи, в ходе обработки которой был запущен сценарий.
|-
|Id задачи
|Строка
|Все
|Идентификатор текущей задачи, в ходе обработки которой был запущен сценарий.
|-
|Код задачи
|Строка
|Все
|Код текущей задачи, в ходе обработки которой был запущен сценарий.
|-
|Название задачи
|Строка
|Все
|Название текущей задачи, в ходе обработки которой был запущен сценарий.
|-
|Параметр задачи
|Число
|Все
|Параметр запуска сценария, переданный из задачи, куда попал в свое время в момент ее создания из компонента «Задание на звонок».
|-
|Id абонента в списке
|Число
|Все
|Идентификатор абонента в прикрепленной таблице абонентов.
|-
|Id коммутации
|Строка
|IVR, Д
|Уникальный идентификатор коммутации.
|-
|Id цепочки коммутаций
|Строка
|IVR, Д
|Уникальный идентификатор звонка (сессии) внутри АТС Oktell.
|-
|Id sip-сессии
|Строка
|IVR
|По умолчанию уникальный идентификатор sip-сессии из поля «Call-ID».
|-
|КС: идентификатор
|Строка
|С
|При запуске служебного сценария для обработки контрольного события Guid-идентификатор контрольного события в строковом представлении.
|-
|КС: название
|Строка
|С
|При запуске служебного сценария для обработки контрольного события название контрольного события.
|-
|КС: идентификатор задачи
|Строка
|С
|При запуске служебного сценария для обработки контрольного события Guid-идентификатор задачи, в которой событие обнаружено, в строковом представлении.
|-
|КС: идентификатор оператора
|Строка
|С
|При запуске служебного сценария для обработки контрольного события Guid-идентификатор оператора, совершившего контрольное событие, в строковом представлении
|-
|КС: показатель
|Число
|С
|При запуске служебного сценария для обработки контрольного события числовой показатель соответствующего события.
|-
|КС: описание
|Строка
|С
|При запуске служебного сценария для обработки контрольного события дополнительное текстовое поле с информацией о деталях события.
|-
|Инициатор запуска. Код типа
|Строка
|С
|Определяет код модуля-иницатора запуска служебного сценария.
* 10 - Контрольное событие.
* 11 - Дозвон из задачи на внешний номер.
* 12 - Автодозвон на внешний номер.
* 13 - Строковое преобразование.
* 14 - Запуск по инициативе клиентского приложения (из модуля администрирования, из плагина, либо из внешнего интегрированного приложения).
* 15 - Набор быстрого номера.
* 16 - Набор экстренного номера.
* 17 - Набор внутреннего номера при приглашении в конференцию.
* 18 - Набор внутреннего номера из автодозвона.
* 19 - Прерывание вызова внутреннего номера в конференции.
* 20 - Обработка завершения конференции.
* 21 - Поиск абонента для голосовой задачи в режиме работы с таблицей абонентов через сценарий.
* 22 - Обработка завершения звонка/попытки звонка в голосовой задаче.
* 23 - Набор внешнего номера из конференции.
* 24 - Набор внешнего номера, указанного в стандартном внутреннем.
* 25 - Обработка завершения сессии внешнего канала (обработка контента линии по общему сценарию АТС).
* 26 - Обработка завершения сессии внешнего канала (обработка контента линии по сценарию задачи).
* 27 - Обработка веб-запроса к серверу на запуск сценария.
* 28 - Определение абонента при входящем вызове.
* 29 - Отправка SMS.
* 30 - Отправка E-mail.
|-
|Инициатор дозвона. Тип
|Строка
|С
|Определяет название модуля-инициатора запуска служебного сценария в некоторых режимах.
* «КС» - контрольное событие.
* «Задача» - сценарий запущен как набор номера в задаче.
* «АДЗ» - сценарий запущен как набор номера в автодозвоне.
* «Быстрый» - сценарий запущен как набор быстрого/внешнего номера.
* «Экстренный» - сценарий запущен как набор экстренного номера.
* «Внутренний из конференции» - сценарий запущен как набор внутреннего номера из конференции.
* «Внутренний из АДЗ» - сценарий запущен как набор внутреннего номера из АДЗ.
В других случаях возвращается пустая строка.
|-
|Инициатор дозвона. Идентификатор (задача/пользователь)
|Строка
|С
|Для вышеприведенных типов запуска служебного сценария возвращает Guid-идентификатор в строковом представлении соответственно контрольного события, задачи, пользователя, запустившего автодозвон. В других случаях возвращается пустая строка.
|-
|Инициатор дозвона. Имя (задача/пользователь)
|Строка
|С
|Для вышеприведенных типов запуска служебного сценария возвращает название соответственно контрольного события, задачи, пользователя, запустившего автодозвон. В других случаях возвращается пустая строка.
|-
|Инициатор дозвона. Внутренний номер (пользователь)
|Строка
|С
|Для режима запуска служебного сценария в качестве набора номера в режиме автодозвона возвращает внутренний номер пользователя, инициировавшего автодозвон. В других случаях возвращается пустая строка.
|-
|Конференция. Идентификатор (Guid)
|Строка
|C
|Задано при запуске сценариев, связанных с конференцией (набор номера, отмена, обработка завершения). Строковое представление GUID-идентификатора связанной конференции.
|-
|Конференция. Код идентификатора (Int32)
|Число
|C
|Задано при запуске сценариев, связанных с конференцией (набор номера, отмена, обработка завершения). Число, являющееся довольно уникальной функцией от GUID-идентификатора связанной конференции. Может быть использовано для идентификации конференции при входе из IVR-сценария.
|-
|Конференция. Номер комнаты
|Число
|C
|Задано при запуске сценариев, связанных с конференцией (набор номера, отмена, обработка завершения). Номер комнаты связанной конференции.
|-
|Конференция. Идентификатор участника (Guid)
|Строка
|C
|Задано при запуске сценариев, связанных с конференцией (набор номера, отмена набора номера). GUID-идентификатор связанного участника связанной конференции. Применяется при организации внешней очереди для привязки звонка к конкретному участнику конференции, находящемуся в состоянии ожидания ответа.
|-
|Конференция. Код идентификатора участника (Int32)
|Число
|C
|Задано при запуске сценариев, связанных с конференцией (набор номера, отмена набора номера). Число, являющееся довольно уникальной функцией от GUID-идентификатора связанного участника связанной конференции. Может быть использовано для идентификации конференции при входе из IVR-сценария.
|-
|Входной параметр 1
|Строка
|С
|Входной параметр 1, передаваемый на старт служебного сценария. Совпадает с параметром, сохраняемым в компоненте «Старт».
|-
|Входной параметр 2
|Строка
|С
|Входной параметр 2, передаваемый на старт служебного сценария.
В сценариях преобразования CallerId содержит внешний номер (CalledId).
Может быть установлен при запуске сценария по инициативе плагинов и внешнего ПО, подключенного через ядро клиентского уровня платформы. Также используется для передачи служебной информации при использовании служебных сценариев - триггеров, обработчиков, набора номера.
|-
|Входной параметр 3
|Строка
|С
|Входной параметр 3, передаваемый на старт служебного сценария.
Может быть установлен при запуске сценария по инициативе плагинов и внешнего ПО, подключенного через ядро клиентского уровня платформы. Также используется для передачи служебной информации при использовании служебных сценариев - триггеров, обработчиков, набора номера.
|-
|Входной параметр 4
|Строка
|С
|Входной параметр 4, передаваемый на старт служебного сценария.
Может быть установлен при запуске сценария по инициативе плагинов и внешнего ПО, подключенного через ядро клиентского уровня платформы. Также используется для передачи служебной информации при использовании служебных сценариев - триггеров, обработчиков, набора номера.
|-
|Входной параметр 5
|Строка
|С
|Входной параметр 5, передаваемый на старт служебного сценария.
Может быть установлен при запуске сценария по инициативе плагинов и внешнего ПО, подключенного через ядро клиентского уровня платформы. Также используется для передачи служебной информации при использовании служебных сценариев - триггеров, обработчиков, набора номера.
|}

Резервное копирование и восстановление сервера

2023-11-07T15:32:42Z

Oktell Support: /* Основные правила */

[[Практики | Наверх]]

__TOC__

В данной статье описывается перенос/переустановка сервера Oktell. Статья для тех, кто хочет переустановить ОС на сервере, перенести систему на другой компьютер или восстановить работу телефонии после аварии.

Перед тем, как вы приступите к переносу сервера, ознакомьтесь с основными правилами.

== Основные правила ==

Каждая версия Oktell (серверная часть) работает с определенной версией базы данных. После каждого обновления программы заменяются файлы в папке ''\oktell\server'' и выполняются изменения в БД. Если версии сервера и баз данных различаются, Oktell будет работать некорректно или вовсе не запустится. Исходя из этого, важно делать резервные копии сервера и БД синхронно. Ниже в статье описывается как правильно восстанавливать сервер, если у вас есть эти обе составляющие.

<blockquote>
Может случиться ситуация, что у вас есть копии базы данных, но нет бэкапа серверной части (папки '''server'''). В этом случае установите ту версию Oktell, на которой были сделаны копии БД. Сделать это можно так - вы устанавливаете версию [https://oktell.ru/files/ из дистрибутива], который имеет младшую версию, а затем попросите у техподдержки файл с обновлением до вашей версии. Например, чтобы получить версию сервера 2.10.140516, нужно установить дистрибутив 2.9.140730, а затем обновиться до вашей версии. После этих действий все настройки будут восстановлены, но вы потеряете сделанные ранее сценарии, если нет этой копии.
</blockquote>
<blockquote>
Если у вас есть копия серверной части, но копии баз данных сохранились старые, то есть способ обновить их до актуальной версии. Самый простой способ обновиться до следующей официальной версии Oktell; если не позволяет АГО - до следующей бета-версии, которую можно попросить у технической поддержки. Другой вариант - скопировать папку '''DBAutoUpdate''' из архива с обновлением на вашу версию и вставить в одноименную папку на сервере, после чего перезагрузить службу сервера.
</blockquote>

== Копирование сервера ==

Если вы делаете копирование сервера непосредственно перед переносом, запишите версию программы (Администрирование/Общие настройки/Информация о лицензии). Это может понадобится для специалистов технической поддержки, если возникнут проблемы.

'''Шаг 1.''' Сделайте копию серверного каталога ''Oktell\Server'' (по умолчанию находится ''C:\Program Files (x86)\''). Следует отметить, что не все файлы стоит резервировать в обязательном порядке.
* Обязательными для восстановления являются файлы в корне папки server, папки '''Liveupdate''' и '''WWW'''
* Для восстановления сценариев нужны папки '''Projects''' и '''Scripts'''
* Системные звуковые файлы хранятся в папке '''Snd'''.
* Установленные плагины хранятся в папке '''Plugins'''. Если вы ее не скопируете, вам нужно будет заново их установить.
* Автоматически создаваемые копии БД и сценариев хранятся в папке '''Backup'''. Их копировать не обязательно.
* Записи разговоров хранятся в папке '''RecordedFiles'''. Для системы эта папка не обязательна, но скорее всего она используется для ваших бизнес-процессов.
* Папку '''Log''' можно не копировать. Файлы в этой папке используются для отладки системы.
* Остальные папки используются для различных модулей системы, но копировать их не обязательно.
В свою очередь, мы рекомендуем делать полную копию папки server без подпапок '''Backup''' и '''Log'''.

'''Шаг 2.''' Сохраните копии следующих обязательных баз данных
* '''oktell'''
* '''oktell_settings'''
* '''oktell_cc_temp'''
Для этого перейдите в ''Администрирование/Общие настройки/Управление базами данных'' и нажмите '''Произвести резервное копирование БД'''. Копии БД будут доступны в корне папки \Oktell\Server\Backup.

[[Файл:Резервное копирование и восстановление сервере 20.png|center]]

Если у вас есть модули веб-клиента Okapp, которые используют БД, то их копию можно сделать через SQL Server management Studio. Например, модуль Журнал хранит в своей БД установленные тэги разговоров, а модуль Дашборды хранит запросы и настройки индикаторов.

Более подробно в статье: [[Резервное копирование и восстановление баз данных]]

== Восстановление сервера ==

В данном разделе рассматривается восстановление системы на чистый сервер. Если вы заранее установили Oktell с дистрибутива, то шаги 1, 4 и 6 можете пропустить, предварительно отключив службу oktellserver,если она запущена.

'''Шаг 1.''' Для работы Oktell нужен SQL-сервер (желательно 2008 R2 или 2012) и [http://www.microsoft.com/ru-ru/download/details.aspx?id=17851 .NET 4.0]. Установка и подготовка SQL-сервера рассмотрена в статье [[Установка Microsoft SQL Server 2012]].

'''Шаг 2.''' Создайте папку ''C:\Program Files (x86)\Oktell'' и скопируйте в нее копии папки server и бэкапы баз данных.

ВНИМАНИЕ: Если ранее Oktell находится в папке Program Files, то на новом сервере следует создавать папку Oktell именно в Program Files. В противном случае ни одна запись разговора не будет проигрываться и вам придется исправить путь в таблице БД [oktell]..[A_Stat_RecordDirectories]

<blockquote>
В качестве альтернативного варианта вы можете установить Oktell c дистрибутива и обновить его до вашей версии. Учтите, что все записи разговоров (папка '''RecordedFiles''' на предыдущем сервере), файлы сценариев и проектов все равно придется копировать с предыдущего сервера. Для восстановления сценариев воспользуйтесь статьей [[Резервное копирование и восстановление сценариев]]
</blockquote>

'''Шаг 3.''' Восстановите базы данных. Инструкцию по восстановлению смотрите в статье [[Резервное копирование и восстановление баз данных]]

'''Шаг 4.''' Зарегистрируйте службу oktellserver. Для этого в командной строке выполните следующую команду ( командную строку рекомендуется запускать от имени администратора)

%WINDIR%\Microsoft.NET\Framework\v4.0.30319\InstallUtil.exe "C:\Program Files (x86)\Oktell\Server\oktell.ServerService.exe"

Для регистрации используется программа '''InstallUtil''' по адресу ''C:\Windows\Microsoft.NET\Framework\v4.0.30319'' (на ОС Windows 7). Если в процессе выполнения вы получили ошибку, проверьте, что у вас установлен .NET 4.0 и указанный файл находится по данному пути.

[[Файл:Резервное копирование и восстановление сервере 21.png|center]]

'''Шаг 5.''' Запустите созданную службу с помощью команды:

net start oktellserver

[[Файл:бэкв.PNG|center]]

'''Шаг 6.''' [http://download.oktell.ru/data/oktellClient.msi Скачайте] и установите клиентское приложение. Проверьте, что оно успешно подключилось к серверу. Поскольку после переноса сервера нужно перевыписать регистрационную карту, поэтому подключение доступно только под учетной записью Администратора по умолчанию (логин - Администратор, пароль пустой).

'''Шаг 7.''' После переноса программы вам необходимо запросить новую лицензию у прикрепленного за вами менеджера или через личный кабинет клиента.

'''Скачать:''' [[Медиа:Форма_письменного_обращения.zip|Форма письменного обращения‎.zip]]

Описание полей для заполнения в форме:
*'''Номер регистрации:''' Информацию вы можете найти в модуле ''Администрирование/Общие настройки/Информация о лицензии'' в поле регистрационный номер.
*'''Наименование держателя лицензии:''' Название компании-обладателя лицензии
*'''Идентификатор:''' ИНН вашей компании

После получения новой регистраицонной карты активируйте ее в ''Администрирование/Общие настройки/Информация о лицензии''. Нажмите '''Старт''' и выберите пункт '''Новая регистрация'''.

[[Файл:Перенос3.PNG | center | 800 px]]

После выполнения этих действий вы сможете войти на сервер под своей предыдущей учетной записью. Если и после этого вы не смогли войти, обратитесь к статье [[Действия пользователей при смене ip-адреса сервера]].

Oktell Web-Socket Protocol

2023-09-21T10:13:26Z

Oktell Support: /* Прочие */

[[Веб-интерфейс|Наверх]]

В рамках настоящей статьи рассматриваются вопросы интеграции web-системы и коммуникационной системы (в дальнейшем WebCRM и Oktell). WebCRM на рабочем месте сотрудника используется через браузер. Телефон, находящийся на рабочем месте сотрудника подключен к серверу (узлу коммутаций) Oktell. Решается задача функционального объединения двух системы с предоставлением возможности приема и совершения звонков и управления телефоном из интерфейсов WebCRM.

__TOC__

<div id="OktellFunc"></div>
===Краткое описание возможностей телефонии Oktell===

Стандартный функционал Oktell предоставляет пользователям:
:* доступ к управлению телефонами (позвонить, переключить, отклонить звонок, организовать конференцию, пригласить других участников в конференцию, подключиться к разговору в режиме прослушивания, помощи и т.д.).
:* доступ к управлению состояниями пользователей (перерыв - чтобы поток входящих звонков не поступал, занят - чтобы отметить факт обработки звонка, переадресация - чтобы все звонки на пользователя перенаправлялись в соответствии с настроенными правилами, готов - чтобы вернуться к обычному режиму).
:* информацию о текущем состоянии телефонов, внутренних номеров, пользователей с т.з. занятости в операциях телефонии.
:* информацию о поступающем звонке, абоненте
:* доступ к статистике разговоров (по правам).
:* доступ к записям разговоров (по правам).
:* доступ к информации об ожидающей очереди абонентов в реальном времени.
:* доступ к контентам сессий и линий.
:* доступ к управлению режимом переадресации.
:* возможность запуска служебных сценариев.
и т.д.

В рамках настройки сценариев Oktell, имеется возможность отправлять синхронные и асинхронные запросы в WebCRM (фактически исполнять методы по событиям в Oktell) и получать ответы и применять их в рамках проведения маршрутизации или любых других действий, реализуемых в сценариях. Например:
:* Выяснить, какому клиенту/контакту принадлежит определившийся номер телефона или введенный им вручную с помощью DTMF-набора номер договора, отфильтровать по черному списку, переключить вызов на ответственного за работу с этим контактом пользователя, если пользователя нет в системе - переключить на секретаря, а если контакт новый - соединить с отделом продаж. Если ответственный пользователь занят, предложить оставить голосовое сообщение для VIP клиентов.
:* В момент поступления звонка открыть карточку у пользователя, которому направляется звонок. Закрыть ее автоматически, если пользователь так и не снял трубку (а снял кто-то другой, или звонок потерялся).
:* Выполнить какое-то важное с т.з. WebCRM действие в случае, например, если пользователь оставил заказ на встречный звонок, занести его в список задач.

Именно сценарии придают жизнь Oktell и его сервисам.

Среди событий Oktell, отрабатываемых в сценариях:

:* поступление внешнего звонка.
:* завершение звонка.
:* переключение абонента на пользователя, группу пользователей, задачу call-центра.
:* любое из интересующих явлений в ходе обработки звонка (от преобразования номера абонента в нужный формат и сверки времени поступления звонка до обработки контента звонка после завершения и выявления там факта состоявшейся конференции).
:* наступление определенного времени.
:* периодический запуск по таймеру.
:* поступление/отправка e-mail.
:* поступление/отправка sms/icq/jabber.
:* контрольные события call-центра (оператор первым положил трубку, оператор слишком долго находится в перерыве или поствызывной обработке, число операторов в задаче меньше минимально допустимого, число абонентов в очереди задачи больше допустимого и т.д.)
:* ручной запуск сценария по инициативе пользователя или WebCRM.
:* исходящий звонок от пользователя
:* поступление голосовой почты
:* появление где-то в базе данных интересующего события (например появление новой записи в таблице абонентов)
:* появление где-то на веб-ресурсе интересующего события (например температура на улице опустилась ниже нуля)

<div id="Arch1"></div>
===Схема интеграции 1 (межсерверное соединение)===

[[Файл:Arch1.jpg|center]]

Сервер Oktell взаимодействует с телефонами и с веб-сервером WebCRM.

Веб-сервер WebCRM взаимодействует ответно с сервером Oktell и с браузерами (клиентами).

Между сервером Oktell и веб-сервером WebCRM существует только один [[#Exchange|канал для двустороннего обмена сообщениями]].

Установка соединения может производиться как сервером Oktell, так и веб-сервером WebCRM. В случае разрыва соединения сторона-инициатор вновь организует подключение.
# При выборе соединения со стороны сервера WebCRM в [[Интеграция_с_Web-Socket_CRM|настройках Web-Socket]] Oktell должен быть выбран один из режимов «CRM к Oktell» с указанием требуемого способа авторизации.
# При выборе соединения со стороны сервера Oktell должен быть выбран один из режимов «Oktell к CRM» с указанием [[#websockver|версии]] протокола Web-Socket.

После установки соединения системы обмениваются данными друг о друге, об авторизованных пользователях, о динамических методах.
Все авторизованные в WebCRM пользователи автоматически становятся авторизованными в Oktell. В дальнейшем авторизация подключающихся пользователей и вывод отключившихся осуществляется с помощью сообщений login и logoff.
Считается, что авторизацию пользователь проходит на веб-сервере WebCRM, и повторной проверки пароля в Oktell не требуется. Поэтому при организации сообщений login поле password не требует указания.

Любой запрос от клиента к Oktell отправляется на сервер WebCRM, где формируется интеграционное сообщение и перенаправляется на сервер Oktell.
Персональные сообщения/команды от Oktell клиенту также направляются на WebCRM, где они должны быть перенаправлены клиенту.
Общие сообщения/команды от Oktell направляются к серверу, где проводится их обработка.

Часть общих событий, например изменение состояния абонента в номерном плане, отправляется в WebCRM однократно и без привязки к конкретному пользователю, подразумевая тем самым, что веб-сервер WebCRM самостоятельно размножит сообщение и отправит всем заинтересованным клиентам.

В рамках такой интеграции WebCRM может предоставлять в Oktell некоторые общие сервисы, которые доступны администратору при настройке сценариев Oktell. Например, доступ к БД WebCRM на поиск маршрута для обработки звонка конкретного клиента. Подробнее в разделе [[#Dynamic|Динамическое взаимодействие]].

<div id="Arch2"></div>
===Схема интеграции 2 (клиент-серверное соединение)===

[[Файл:Arch2.jpg|center]]

Сервер Oktell взаимодействует с телефонами и с конечными клиентами (браузерами).

Веб-сервер CRM взаимодействует только с клиентами и БД.

Между Oktell и каждым клиентом существует один или несколько [[#Exchange|каналов для двустороннего обмена сообщениями]] (поддерживается работа в нескольких вкладках браузера).

В данном случае клиенты (браузеры) производят подключения к серверу Oktell, и в его настройках должен быть включен и настроен [[Настройки_веб-сервера|Web-сервер]], а в сообщениях [[#login|''login'']] должен быть указан пароль пользователя (MD5).

При таком способе интеграции у WebCRM не требуется наличие собственного Web-Socket сервера. Каждый клиент (браузер) подключается по Web-Socket протоколу непосредственно к серверу Oktell. Веб-сервер CRM занимается формированием страниц и предоставлением данных из БД WebCRM. Непосредственная взаимосвязь между серверами WebCRM и Oktell отсутствует, доступ не требуется, клиенты самостоятельно обрабатывают и объединяют данные двух систем.
По такому принципу реализованы [http://www.oktell.ru/weboktell Web-клиент Oktell] и плагин [http://js.oktell.ru/ Oktell.js], доступный для встраивания в другие проекты.

Поскольку клиентов может быть много, при рассылке событий возможна оптимизация за счет исключения тех клиентов, где конкретное событие не является необходимым. Достигается это путем подписки/отписки клиентов на определенные типы сообщений.

Применительно к этому способу интеграции существует ряд дополнительных методов интерфейса. Большинство таких методов доступно и при [[#Arch1|схеме интеграции 1]], но не являются там необходимыми, так как часть данных и работ проводится на веб-сервере WebCRM.

В отличие от [[#Arch1|схемы интеграции 1]], где Oktell запрашивает у сервера WebCRM список [[#Dynamic|динамических методов и форм]], которые затем могут быть использованы в сценариях Oktell, здесь динамические методы недоступны. Чтобы получить доступ к динамическим методам, следует использовать упрощенный вариант [[#Arch3|схемы интеграции 3]].

<div id="Arch3"></div>
===Схема интеграции 3 (межсерверное и клиент-серверное соединение)===

[[Файл:Arch_3.jpg|center]]

Является комбинацией [[#Arch1|схемы 1]] и [[#Arch2|схемы 2]]. То есть клиенты имеют возможность подключаться непосредственно к серверу Oktell, минуя websocket-сервер CRM, а связь с сервером происходит по специальному каналу, который может быть обеспечиваться как websocket-подключением, так и периодическими http подключениями.

В этом случае при разработке решений можно пользоваться javascript-библиотекой [http://js.oktell.ru Oktell.js], не требующей ни полного погружения в настоящий интеграционный протокол, ни в настройку websocket. Также в этом случае для CRM не обязательно иметь собственный websocket-сервер для обслуживания клиентов. Более того, можно вообще обойтись лишь настройкой HTTP для обмена сервисными сообщениями вроде [[#whoareyou|взаимных представлений]] и запроса [[#getavailablemethods|динамических методов]] и [[#getavailableforms|форм]]. Исполнение [[#Dynamic|динамических методов и форм]] будет возможно как на сервере, так и на клиентах. На сервере - по межсерверному каналу (http, https, websocket, websocket secure), на клиенте - по индивидуальным websocket-подключениям (защищенным или нет). Все остальные запросы и события имеют персональную подоплеку и отправляются по индивидуальным клиент-серверным подключениям.

При этом в случае websocket соединения между серверами Oktell и CRM остается возможность часть клиентов туннелировать через сервер CRM, а часть клиентов обслуживать непосредственно. В этом смысле это самый широкий способ интеграции, и два других выступают частными случаями.

<div id="UserPhone"></div>
===Привязка пользователя к телефону===

Решению подлежит задача сопоставления конкретных пользователей CRM с конкретными телефонными устройствами. Поскольку элементы управления устройством находятся в браузере, а влияют они на поведение конкретного телефона. Например, так выглядит простейшая задача перевода звонка из браузера на врача Михайлова: звонок должен поступить на телефон, находящийся в кабинете 103, за компьютером в котором сейчас сидит Михайлов (в браузере открыта WebCRM и авторизован Михайлов).
Настройка этого происходит в Oktell.

Пользователи могут работать:
:* стационарно каждый за своим рабочим местом.
:* перемещаться с одного рабочего место за другое.
:* работать посменно за одним рабочим местом.
(Рабочее место = компьютер + телефон)

Необходимо в каждый момент времени знать, около какого телефона какой пользователь сидит.

Существуют два подхода к решению, также возможны их комбинации в рамках одного сервера.

'''1. Жесткая привязка пользователя к телефонной учетной записи.'''

''Для этого в карте сети Oktell в свойствах телефона требуется указание пользователя WebCRM''

''Плюсы'': При взаимодействии Oktell и WebCRM используются одни и те же идентификаторы (например логины пользователей), соответственно отсутствует проблема привязки как таковая.

''Минусы'': Пользователь вынужден перемещаться с одного компьютера на другой вместе со своим телефоном, или переназначая учетную запись в телефонном аппарате.

'''2. Телефон привязывается к компьютеру, а в момент логина пользователя сопоставление производится через этот компьютер.'''

''Плюсы'': Кто бы ни залогинился с этого компьютера, приобретает управление рядом стоящим телефоном, все звонки пользователю попадают на этот телефон.

''Минусы'': Требует указания одного из постоянных идентификаторов компьютера в Oktell, а также передачи его из WebCRM/web-клиента в момент логина для привязки. Это может быть айпи адрес, хостнейм или любой другой постоянный идентификатор, задаваемый в конфигурации.

Синхронизация учетных записей Oktell и WebCRM может производиться по логинам (по умолчанию) или по GUID-идентификаторам. Соответственно в персональных запросах должны указываться userlogin и/или userid.

Логин в Oktell нужен для приведения состояния пользователя в готовность. Без этого звонки на пользователя не поступают, а обрабатываются как и в случае, когда он недоступен. Логофф - обратная операция. В ходе взаимодействия пользователю доступны команды управления своим состоянием. Он может отлучиться, выставить перерыв, переадресацию, занятость и т.д. Все это нужно для того, чтобы изменить направление маршрутизации звонков и режим работы call-центра. А в случае [[#Arch2|схемы интеграции 2]] и [[#Arch3|схемы интеграции 3]] также для авторизации. Индивидуальное подключение не обрабатывает никакие запросы, не осуществив авторизацию.

ВНИМАНИЕ! Ограничение: Oktell не позволяет пользователям авторизовываться с разных рабочих мест одновременно. Делается это для того, чтобы каждому пользователю соответствовало не более одного телефона.
Однако персональные соединения [[#Arch2|схемы интеграции 2]] и [[#Arch3|схемы интеграции 3]] могут быть множественными, например как вкладки одного браузера. При этом привязка к телефону осуществляется первым авторизовавшимся подключением и остается таковой до закрытия всех вкладок/подключений этого пользователя.

<div id="Exchange"></div>
===Взаимодействие по каналу связи===

В этом разделе описывается межсерверный канал websocket, а канал HTTP подразумевается ограниченным аналогом.

Все взаимодействие между Oktell и WebCRM (а также между Oktell и браузером) идет по общему каналу путем двустороннего обмена сообщениями между сторонами.

<center>[[Файл:Socket 3.jpg|500px]][[Файл:Socket 3b.jpg|500px]]</center>

<div id="websockver"></div>
Взаимодействие на транспортном уровне происходит по Web-Socket протоколу. Поддерживаются версии
:* [http://tools.ietf.org/html/rfc6455 rfc6455 v13]
:* [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-08 v8]
:* [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-07 v7]
:* [http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75 75]
:* [http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76 76]

''[[Примеры WebSocket Handshake]]''.

В зависимости от выбранной схемы интеграции и выбранного в настройках направления и способа подключения одна из сторон производит подключение (Oktell к серверу WebCRM, сервер WebCRM к Oktell, клиенты WebCRM к Oktell).
Рукопожатие (handshake) на установление Web-Socket соединения предлагается также стороной-инициатором. [http://ru.wikipedia.org/wiki/WebSocket Подробнее].
Рукопожатие является HTTP запросом и при необходимости поддерживает прохождение Basic или Digest-авторизации. В качестве логина и пароля выступают указанные в [[Интеграция_с_Web-Socket_CRM|настройках Web-Socket]] значения. Описание процедуры рукопожатия описывается в документации к каждой версии протокола Web-Socket.

Все сообщения имеют идентификаторы для организации серий типа «запрос-ответ» (поле ''qid'').
Сообщения могут адресоваться конкретному пользователю или относиться к общим. В первом случае в сообщении должен присутствовать идентификатор, позволяющий различать одинаковые, но направляемые от разных пользователей команды из WebCRM в Oktell и наоборот соответственно.

Возможные направления и типы сообщений:
:* Oktell генерирует события.
:* Oktell производит запросы к веб-системе. WebCRM отправляет ответы на получаемые запросы.
:* WebCRM производит запросы к Oktell. В том числе и команды. Oktell отправляет ответы на запросы.

''В случае HTTP подключения к CRM работа ограничивается запросами из Oktell и ответами на них из CRM.''

Каждое сообщение представляет из себя строку [http://ru.wikipedia.org/wiki/JSON JSON] или [http://ru.wikipedia.org/wiki/XML XML] в кодировке [http://ru.wikipedia.org/wiki/UTF8 UTF-8]. Сообщения в общем потоке данных в канале отделяются друг от друга в соотвествии с версией используемого протокола Web-Socket:
:*Версии [http://tools.ietf.org/html/rfc6455 rfc6455 v13], [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-08 v8], [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-07 v7] подразумевают использование фреймов, в заголовках которых определяется тип и размер.
:*Версии [http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76 76] и [http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75 75] подразумевают отделение сообщений байтами 0 и 255. 0 - в начале сообщения, 255 - в конце. Форматы XML и JSON представления данных в текстовом виде гарантируют отсутствие байтов 0 и 255 в теле сообщений.

''В случае HTTP подключения к CRM запросы из октелл отправляются методом POST с передачей параметра '''data''', значением которого является упакованная в base64 строка JSON или XML.''

Формат самих сообщений определяется непосредственно [[#Список методов интерфейса|протоколом интеграции Oktell-WebCRM]]. Например вот так выглядит сообщение из Oktell в WebCRM о факте входящего вызова в формате json:

[[Файл:Json.jpg]]

Сообщения длиной более 64 КБ упаковываются в [http://ru.wikipedia.org/wiki/Base64 Base64] и разбиваются на несколько сообщений длиной до 64К. Для этого используется формат multipart-сообщения в протоколе Oktell-WebCRM. Если версия протокола Web-Socket для передачи сообщений использует фреймы ([http://tools.ietf.org/html/rfc6455 rfc6455 v13], [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-08 v8], [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-07 v7]), то способ отправки длинных сообщений в нескольких фреймах определен в самом протоколе. Однако это имеет ограничение: при передаче одного длинного сообщения в нескольких фреймах, оно не может быть прервано передачей других сообщений.

Структура каждого сообщения - это список из двух объектов, первый из которых - тип сообщения, второй - словарь параметров. В словаре обязательно присутствует идентификатор запроса (поле ''qid'' с любым текстовым уникальным значением). В случае, когда сообщение производится от имени пользователя, присутствуют его идентификаторы (''userid'' и/или ''userlogin'').

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

<div id="Dynamic"></div>

===Динамическое взаимодействие===

В момент создания сценариев в Oktell администратор имеет возможность настроить индивидуальное взаимодействие с WebCRM.
Взаимодействие представляет собой вызов определенного метода WebCRM с передачей в него входных параметров, и возможно ожидание его исполнения с возвратом (нескольких) выходных значений.

Сразу после организации подключения к серверу WebCRM Oktell производит запрос доступных в WebCRM динамических методов (как было сказано выше, это происходит в рамках [[#Arch1|схемы интеграции 1]] и [[#Arch3|схемы интеграции 3]]).
В ответ WebCRM перечисляет список действий, инициативу исполнения которых она готова отдать наружу в Oktell. При описании метода в представлении указываются:
:* человеческое название;
:* краткий код метода;
:* описание для администратора, настраивающего Oktell;
:* список входных параметров с упоминанием типов (и возможных значений для перечислений);
:* список выходных параметров, если метод возвращает данные и призван влиять на алгоритм сценария в Oktell;
:* признак того, нужно ли исполнять метод с привязкой к конкретному пользователю и в направлении индивидуального пользовательского подключения, или это обращение к серверу вообще;
:* разрешено ли отменять исполнение (например для метода «открыть карточку такую-то» возможна отмена, означающая «закрыть карточку такую-то»);
:* куда Oktell направлять серверный запрос - через стандартное подключение (websocket или http в соответствии с настройками) или по HTTP/HTTPS на альтернативный URL веб-сервера (передача осуществляется точно также POST запросом с упаковкой сообщения в переменную ''data'' в виде base64.

По каждому методу дополнительно описывается перечень входных и выходных параметров, их типы, способ исполнения метода (по организованному каналу или отдельным http-подключением), возможность его отмены (для длительных асинхронных операций, например метод ''Открыть диалоговую форму'' может быть отменен обратным методом ''Закрыть диалоговую форму'', а может быть прерван с тем же результатом).

В [[#Interface|интеграционном интерфейсе Oktell<->WebCRM]] отсутствует таким образом необходимость конкретизировать методы WebCRM.
В момент настройки сценария Oktell администратор уже имеет о них информацию и настраивает конкретный сценарий под место.

Администратором определяется одно или несколько из доступных действий, определяется момент исполнения, определяются входные параметры или способ их вычисления, а также режим ожидания, таймаута или асинхронного выполнения.
В момент работы Oktell отправляет команду на исполнение в соответствии с определенными администратором настройками и представлением динамического метода.
Если метод призван исполняться синхронно и возвращать некие значения, то сценарий приостанавливается, а после получения ответа сохраняет результаты в переменных сценария и продолжает выполнение.
Работа с динамическими методами и формами производится в сценариях Oktell компонентом [[Общие_компоненты_сценариев#Действие/карточка_в_plugin_или_WebCRM|Действие в WebCRM]].

Для примера: в момент поступления вызова Oktell определил номер абонента. Производит синхронное исполнение динамического метода WebCRM ''Вернуть ид компании по номеру телефона'', дожидается ответа и принимает в сценарий значение. Далее исполняет динамический метод ''Ответственный сотрудник по компании'', дожидается ответа и принимает в сценарий значение. Все это время абоненту проигрывается голосовое или музыкальное приветствие. Когда воспроизведение завершается, Oktell производит маршрутизацию в соответствии с вернувшимися значениями, а также в момент поступления звонка сотруднику исполняет динамический метод ''Открыть карточку компании'' с передачей в качестве параметра идентификатора, вернувшегося на первом шаге. В случае, если сотрудник не снимает трубку, Oktell отменяет исполнение метода, тем самым отдавая команду на закрытие карточки компании.

Ни об одном из перечисленных в примере методов WebCRM сервер Oktell не знает, зато знает администратор, настраивающий систему на работу совместно с WebCRM.

Подробно список и интерфейс методов динамического взаимодействия приведен в разделе [[#DynamicMethods|Методы динамического взаимодействия]].

<div id="Interface"></div>
===Список методов общего интерфейса===

Взаимодействие происходит путем обмена сообщениями по установившемуся транспортному каналу.
Часть сообщений носят вид событий, часть - вид запросов (команд), часть - вид ответов на запросы. Каждое сообщение представляет собой байтовое представление текста с escape-последовательностями, описывающего объект в виде структуры JSON (возможен вариант XML), преобразованного через кодировку UTF8.

На первом уровне объекта - массив из двух значений: строковый кодовый идентификатор сообщения, именованный список параметров:
<pre>[ "messagecode", {"var1":"value1", "var2":"value2", ...} ]</pre>

В общем случае среди параметров могут присутствовать сложные объекты (массивы и словари):
<pre>"var1":["a", "b", "c"] или "var2":{"a":1, "b":2, "c":3}</pre>

В каждом сообщении присутствует параметр ''qid'', содержащий уникальный строковый идентификатор сообщения, обеспечивающий возможность построения из сообщений серий вида «запрос-ответ».
В случае, когда сообщение относится к конкретному пользователю (отправляется от его имени), в нем присутствуют параметры ''userlogin'' и ''userid''. По умолчанию синхронизация учетных записей пользователей происходит по их уникальным логинам.

====Представление систем друг другу====

-------------------------------------------------------------------
'''whoareyou'''

Двунаправленный запрос на возврат информации об удаленной стороне. Служит для выстраивания взаимоотношений на основе типа подключения, а также дает возможность получить имя системы для указания администратору.
Ответом является сообщение ''iam''.

Применяется в [[#Arch1|схеме интеграции 1]].

<pre>
[
"whoareyou",
{
"qid": "4FEEB8EF-DF4B-47AE-8EFE-4BDA577A6FF8",
"type": "ws-server",
"name": "Iris CRM",
"version": 10.5
}
]
</pre>
<pre>
//* type - собственный тип сервера, осуществляющего запрос.
Oktell при запросе указывает значение ''commserver''.
WebCRM может указывать что либо отличное, например ''ws-server'' или ''crm-server''.
//* name - собственное название службы.
//* version - собственная версия службы.
</pre>

'''iam'''

Двунаправленный ответ на запрос ''whoareyou''. Возвращает информацию об удаленной стороне.

<pre>
[
"iam",
{
"qid": "080C0DF2-442B-410E-9204-4ADB3399FCC0",
"type": "commserver",
"name": "Oktell",
"version": 100425,
"build": "2.5.3928.8022"
}
]
</pre>
<pre>
//* type - тип удаленного сервера.
Oktell при запросе указывает значение ''commserver''.
WebCRM может указывать что либо отличное, например ''ws-server'' или ''crm-server''.
//* name - название службы на удаленнм сервере.
//* version - версия службы на удаленном сервере.
</pre>

<div id="DynamicMethods"></div>
====Методы динамического взаимодействия====

Информация от CRM о поддерживаемых методах, доступных Oktell для инициации исполнения.

Серия методов forms - частный случай методов, позволяющий выделить в отдельную категорию работу с карточками. Смысл и способ работы тот же самый. Тем не менее карточки могут быть представлены как методы.

----------------------------------------------

Методы:
# >>> getavailablemethods 
# <<< availablemethods 
# >>> executemethod 
# <<< methodresult 
# >>> cancelmethod 
# >>> executemethodwaitaborted 

Формы:
# >>> getavailableforms 
# <<< availableforms 
# >>> showform 
# >>> closeform 
# <<< formresult 
# >>> showformwaitaborted 

------------------------------------------------------------------------------
<div id="getavailablemethods"></div>
>>> '''getavailablemethods'''

Отправляет из Oktell в CRM сообщение-запрос на возврат доступных динамических методов CRM. Отправляется только на сервер CRM (websocket или http).

<pre>
[
"getavailablemethods",
{
"qid": "76EF6E46-23DA-47B6-B3BD-A7076FEDE170"
}
]
</pre>

<<< '''availablemethods'''

Сообщение-ответ из CRM в Oktell со списком доступных динамических методов CRM.

<pre>
[
"availablemethods",
{
"qid": "76EF6E46-23DA-47B6-B3BD-A7076FEDE170",
"methods": [
{
"key": "16893E86-4D73-4F4C-8629-6E484B2CB5B0",
"name": "Вернуть данные о компании",
"description": "Возвращает информацию о компании по одному из выбранных идентификаторов, чтобы в дальнейшем использовать при открытии карточки данных о компании",
"connectiontype": "http",
"url": "http://192.168.0.100:4000/pbxapi/method1.php",
"defineuser": false,
"allowcancel": false,
"inputparams": [
{
"key": "type",
"name": "Тип поиска",
"description": "",
"type": "list",
"items": [
{
id: "byphone",
name: "По номеру телефона"
},
{
id: "byaccount",
name: "По номеру договора"
}
]
},
{
"key": "data",
"name": "Значение идентификатора",
"description": "Номер телефона или номер договора (в соответствии с выбранным типом)",
"type": "string"
},
{...},
{...}
]
"outputparams": [
{
"key": "accountid",
"name": "Идентификатор клиента",
"description": "Для дальнейшей передачи на отображение карточки",
"type": "string"
},
{...},
{...}
]
},
{
"key": "createrecord",
"name": "Создать новое дело",
"description": "Отображает контактные данные об абоненте (комании или человеке) при входящем/исходящем звонке",
"connectiontype": "websocket",
"defineuser": true,
"allowcancel": false,
"inputparams": [
{
"key": "sessionid",
"name": "Идентификатор сессии звонка",
"description": "Для связи с номером дела",
"type": "string"
}
],
"outputparams": [
{
"key": "recordid",
"name": "Идентификатор созданного дела",
"description": "Для дальнейшей передачи на отображение карточки",
"type": "string"
}
{...},
{...}
]
},
{
"key": "card_records",
"name": "Показать карточку «ДЕЛА»",
"description": "Отображает контактные данные об абоненте (комании или человеке) при входящем/исходящем звонке",
"connectiontype": "default",
"defineuser": true,
"allowcancel": true,
"inputparams": [
{
"key": "recordid",
"name": "Номер дела",
"description": "Номер дела, который ранее был создан при вызове метода «Создать запись дела»",
"type": "string"
},
{
"key": "accountid",
"name": "Идентификатор клиента",
"description": "Идентификатор клиента в базе данных CRM",
"type": "string"
},
{...},
{...}
]
},
{...},
{...}
]
}
]
</pre>

<pre>
//* method:key, param:key - произвольные строковые идентификаторы, упоминаемые при вызове форм из октелла
//* method:name, param:name - краткие человеческие названия, отображаются в списках при настройке сценария.
//* method:description, param:description - описания, если смысл формы/параметра нетривиален, и админу может потребоваться объясняение
//* method:inputparams - список входных параметров, значения которых требуется передавать в командном сообщении на исполнение соответствующего метода.
//* method:outputparams - список выходных параметров, значения которых можно ожидать в сообщении о выполнении метода.
//* param:type - тип параметра: string, int|int64, bool, decimal|float|double, datetime, list. Если не указан - строка. Дает администратору представление.
//* param:items - в случае если тип параметра=list, здесь идет перечисление вариантов списка
//* method:connectiontype - websocket|http|https|default - куда ломиться, через веб-сокет (дефолтный канал), или запросом к http-серверу. Дефолтный канал - если к CRM подключение по HTTP, то запрос по тому же адресу будет.
//* method:defineuser - true|false - определять пользователя, или запрос к веб-серверу вообще.
//* method:allowcancel - true|false - поддерживается ли отмена исполнения (например закрытие открывшейся карточки).
</pre>

------------------------------------------------------------------------------
>>> '''executemethod'''

Сообщение-команда из Oktell в CRM на выполнение динамического метода (возможно у конкретного пользователя). В зависимости от представления метода может исполняться на сервере CRM или передаваться в пользовательское подключение.

Параметр ''waitresponsems'' указывает интервал в миллисекундах, которое сценарий предполагает ожидать возврата ответа после исполнения метода; если значение равно нулю, значит метод исполняется асинхронно и ответ не нужен. При этом если происходит прерывание исполнения сценария, или в случае наличия множественных подключений от пользователя при получении первого ответа, отправляется уведомительное событие ''executemethodwaitaborted''.

<pre>
[
"executemethod",
{
"qid": "4A8E20A1-57F9-4CA6-B4EE-221E2EB00364",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"methodkey": "createrecord",
"executionid": "25FC81FC-C5D0-40FB-B4E0-882352E12D86",
"inputparameters": {
"sessionid": "2A2C48FE-D8B6-4B51-951A-09D31543D000"
},
"waitresponsems": 0
}
]
</pre>

<<< '''methodresult'''

Сообщение-результат выполнения динамического метода из CRM в Oktell с возвратом выходных значений. Не отправляется, если исполнение прерывается командой CancelMethod.

<pre>
[
"methodresult",
{
"qid": "A238110C-6B74-4980-AA23-41402B1E9B0E",
"methodkey": "createrecord",
"executionid": "25FC81FC-C5D0-40FB-B4E0-882352E12D86",
"outputparameters": {
"recordid": "ADCB1376-BA66-496C-A56E-AB7A7D5A9193"
}
}
]
</pre>

------------------------------------------------------------------------------
>>> '''cancelmethod'''

Сообщение-команда из Oktell на прекращение выполнения ранее запущенного динамического метода. Отправляется туда же, куда предварительно было отправлено сообщение ''executemethod''.

<pre>
[
"cancelmethod",
{
"qid": "6ADC3F1E-B1DD-4768-BAF8-3EEB477B2F17",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"methodkey": "card_records",
"executionid": "25FC81FC-C5D0-40FB-B4E0-882352E12D86",
"forcecancel": 0
}
]
</pre>

------------------------------------------------------------------------------
>>> '''executemethodwaitaborted'''

Сообщение-событие из Oktell, уведомляющее сервер/клиента CRM о прекращении ожидания ответа на выполнение метода. Отправляется туда же, куда предварительно было отправлено сообщение ''executemethod''. Отправляется только в том случае, если Oktell производил ожидание ответа (параметр ''waitresponsems'' не был равен нулю).

<pre>
[
"executemethodwaitaborted",
{
"qid": "6ADC3F1E-B1DD-4768-BAF8-3EEB477B2F17",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"methodkey": "card_records",
"executionid": "25FC81FC-C5D0-40FB-B4E0-882352E12D86"
}
]
</pre>

------------------------------------------------------------------------------
<div id="getavailableforms"></div>
>>> '''getavailableforms'''

Отправляет из Oktell в CRM сообщение-запрос на возврат доступных карточек CRM. Отправляется только на сервер CRM (websocket или http).

<pre>
[
"getavailableforms",
{
"qid": "7A1FF57A-ED91-4033-A42F-1D2AE630450E"
}
]
</pre>

<<< '''availableforms'''

Сообщение-ответ из CRM в Oktell со списком доступных карточек CRM. Команда на отображение форм отправляется в клиентские подключение (или на сервер-мультиплексор), в серверный канал такие команды не отправляются. В этом основное различие динамических методов и форм.

Следует понимать, что формы могут иметь разное назначение, и соответственно разный способ работы с данными. Например форма некоторого запроса отображается с целью получения данных обратно в сценарий - в этом случае форме нужны выходные параметры, и вызов ее происходит с ожиданием ответа. Одновременно могут существовать и использоваться формы, работающие с данными из CRM и взаимодействующие непосредственно с CRM, возможно находящиеся в отображении длительное время. В этом случае Oktell выступает лишь как инициатор их открытия с передачей входных идентификационных параметров. Таким формам выходные значения не нужны.

<pre>
[
"availableforms",
{
"qid": "7A1FF57A-ED91-4033-A42F-1D2AE630450E",
"forms": [
{
"key": "formB840825C",
"name": "Данные о компании",
"description": "Отображает контактные данные об абоненте (комании или человеке) при входящем/исходящем звонке",
"inputparams": [
{
"key": "accountid",
"name": "Код компании",
"description": "Код компании, который CRM возвращает в поле [accountid] в ответ на запрос данных о компании по номеру телефона",
"type": "string"
},
{
"key": "page",
"name": "Активная страница",
"description": "Открываемая страница формы по умолчанию при открытии карточки",
"type": "list",
"items": [
{
id: "page1",
name: "Контактные данные"
},
{
id: "page2",
name: "История взаимодействия"
},
{
id: "page3",
name: "Комментарии"
}
]
{...},
{...}
]
},
{...},
{...}
]
}
]
</pre>

------------------------------------------------------------------------------
>>> '''showform'''

Сообщение-команда из Oktell в CRM на открытие карточки у конкретного пользователя.

<pre>
[
"showform",
{
"qid": "5CF770AE-E308-41DA-B89E-7BBCE75BE36F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"formkey": "formB840825C",
"windowid": "9F5D8B1A-8818-41EA-A240-04DA07498C40",
"inputparameters": {
"accountid": "05379F49-AB22-4872-B2C2-0D4BA019EA0B",
"page": "page2"
},
"waitresponsems": 0
}
]
</pre>

<<< '''formresult'''

Сообщение-результат из CRM в Oktell при закрытии карточки пользователем с возвратом выходных значений. Не отправляется, если отображение прерывается командой CloseForm

<pre>
[
"formresult",
{
"qid": "EC9E1619-AC1B-4071-98B9-30808B9ED0EC",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"formkey": "formB840825C",
"windowid": "9F5D8B1A-8818-41EA-A240-04DA07498C40",
"outputparameters": {
"comment": "блаблабла"
}
}
]
</pre>

------------------------------------------------------------------------------
>>> '''closeform'''

Сообщение-команда из Oktell на закрытие карточки у конкретного пользователя. Отправляется туда же, куда предварительно было отправлено сообщение ''executemethod''.

<pre>
[
"closeform",
{
"qid": "FAA1A503-FEC6-4D23-ADA9-2E4FD63F2C96",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"formkey": "formB840825C",
"windowid": "9F5D8B1A-8818-41EA-A240-04DA07498C40",
"forceclose": 0
}
]
</pre>

------------------------------------------------------------------------------
>>> '''showformwaitaborted'''

Сообщение-событие из Oktell, уведомляющее сервер/клиента CRM о прекращении ожидания ответа на отображение формы. Отправляется туда же, куда предварительно было отправлено сообщение ''showform''. Отправляется только в том случае, если Oktell производил ожидание ответа (параметр ''waitresponsems'' не был равен нулю).

<pre>
[
"showformwaitaborted",
{
"qid": "6ADC3F1E-B1DD-4768-BAF8-3EEB477B2F17",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"formkey": "formB840825C",
"windowid": "9F5D8B1A-8818-41EA-A240-04DA07498C40"
}
]
</pre>

====Обмен данными об активных пользователях====

-------------------------------------------------
>>> '''getactiveusers'''

Запрос из Oktell в CRM на возврат текущих активных (авторизованных) пользователей. Применяется при старте одной из систем в момент организации подключения.

<pre>
[
"getactiveusers",
{
"qid": "9C44D978-E380-4405-B1B9-C4894BF188A7"
}
]
</pre>

<<< '''activeusers'''

Ответное сообщение из CRM в Oktell со списком активных авторизованных пользователей CRM.

<pre>
[
"activeusers",
{
"qid": "9C44D978-E380-4405-B1B9-C4894BF188A7",
"users": [
{"userlogin": "ivanov", "userid": "20394857203948752345"},
{"userlogin": "petrov", "userid": "kasjdfhlaksjdfhlaks"},
{"userlogin": "sidorov", "userid": "987495873948573945"}
]
}
]
</pre>

-------------------------------------------------
<div id="login"></div>
<<< '''login'''

Сообщение из CRM в Oktell об авторизации пользователя. Запрос кросс-авторизации в Oktell в рамках [[#Arch1|схемы интеграции 1]].

Логин используется в частности для привязки пользователя к конкретному телефонному аппарату. Возможны разные варианты привязки:
# Для конкретного телефона в [[Карта сети|карте сети]] Oktell задается конкретный пользователь WebCRM, при логине производится автоматическая привязка (если телефону назначен также пользователь по умолчанию, то он отключается). При выходе выходе пользователя из WebCRM происходит обратный процесс. При этом телефоном считается учетная запись (комбинация логин-пароль или IP-адрес устройства, в зависимости от типа регистрации), и фактически разные устройства могут в течение времени принимать эти значения.
# Во время логина WebCRM в сообщении указывает любой идентификатор (или их список) рабочего места, с которого осуществляется запуск (это может быть HostName, IP-адрес, или любой другой уникальный идентификатор, указанный для сопоставления также и в карте сети в качестве адреса компьютера). Соединенный с этим компьютером логической связью телефон в карте сети становится рабочим телефоном авторизованного таким образом пользователя. По аналогии с работой клиентских приложений Oktell.

В случае индивидуальных подключений [[#Arch2|схемы интеграции 2]] и [[#Arch3|схемы интеграции 3]] требуется указание как логина, так и пароля для проведения полной проверки, причем пароль необходимо указывать в виде MD5 хеша. При этом возможно использование сессий (параметры ''sessionid'' и ''expires''). Клиент указывает время жизни сессии в секундах, сервер возвращает идентификатор сессии; в дальнейшем при повторном подключении в указанный интервал времени клиент может указывать сессию и новое время жизни для продления, но не указывать пароль. Если сессия существует (время не вышло, сервер не перезагружался), то авторизация будет подтверждена.

ВНИМАНИЕ! В версии 2.8 пароли case-sensitive, в версии 2.7 пароли case-insensitive. При переходе между версиями до полного обновления всех паролей рекомендуется указывать пароль в дублированном виде: параметр ''password'' - MD5(lowercase), ''Password'' - MD5(normalcase).

В случае [[#Arch1|схемы интеграции 1]] подразумевается, что авторизация пользователя происходит в WebCRM, и указания пароля при кросс-логине в Oktell не требуется, равно как и сессий.

<pre>
[
"login",
{
"qid": "9D484E0E-BE08-47B5-ABBD-490936881056",
"userlogin": "ivanov",
"userid": "29834234234",
"password": "D41D8CD98F00B204E9800998ECF8427E",
"expires": 86400,
"usewebrtc": 1
}
]
</pre>

<pre>
[
"login",
{
"qid": "9D484E0E-BE08-47B5-ABBD-490936881056",
"userlogin": "ivanov",
"userid": "29834234234"
}
]
</pre>

<pre>
[
"login",
{
"qid": "9D484E0E-BE08-47B5-ABBD-490936881056",
"userlogin": "ivanov",
"userid": "29834234234",
"workplace": "wp001",
"sessionid": "838AC713-9D4D-43E2-A57D-D4F2D7545FB5",
"expires": 86400
}
]
</pre>

<pre>
[
"login",
{
"qid": "9D484E0E-BE08-47B5-ABBD-490936881056",
"userlogin": "ivanov",
"userid": "29834234234",
"workplace": [
"wp001",
"192.168.0.204",
"81.22.217.33"
]
}
]
</pre>

>>> '''loginresult'''

Сообщение из Oktell в CRM о результате авторизации или кросс-авторизации пользователя. Отправляется в ответ на запрос авторизации в Oktell методом ''login'', а в рамках [[#Arch1|схемы интеграции 1]] может быть отправлено самостоятельно по результатам обработки сообщения ''activeusers'' после установки связи с CRM. В случае запроса использования клиентом WebRTC, в ответе направляется информация по учетной записи телефона, ожидающей подключения по SIP.

<pre>
[
"loginresult",
{
"qid": "939AA33E-011F-4FEC-B60A-8BC1B4888B5A",
"userlogin": "ivanov",
"userid": "29834234234",
"result": 0,
"error": 50093,
"errormsg": "Пользователь уже зарегистрирован"
}
]
</pre>

<pre>
[
"loginresult",
{
"qid": "939AA33E-011F-4FEC-B60A-8BC1B4888B5A",
"userlogin": "ivanov",
"userid": "29834234234",
"result": 1,
"sessionid": "838AC713-9D4D-43E2-A57D-D4F2D7545FB5",
"expires": 10000,
"sipuser": "phone81",
"siplogin": "phone81",
"sippass": "3kd94FnI",
"sipport": 5060
}
]
</pre>

-------------------------------------------------
<<< '''logout'''

Сообщение из CRM в Oktell о выходе (логауте) пользователя. Команда на кросс-логаут в Oktell.

<pre>
[
"logout",
{
"qid": "9D484E0E-BE08-47B5-ABBD-490936881056",
"userlogin": "ivanov",
"userid": "29834234234"
}
]
</pre>

>>> '''logoutresult'''

Сообщение из Oktell в CRM о результате кросс-логаута пользователя. Может быть отправлено в ответ на запрос кросс-логаута в Oktell, а может быть отправлено самостоятельно в случае длительного отсутствия откликов от пользователя (не задействовано) или выгрузки пользователя по инициативе сервера.

<pre>
[
"logoutresult",
{
"qid": "4B25E210-2D67-4675-A5AE-46DC9CBC32F9",
"userlogin": "ivanov",
"userid": "29834234234",
"result": 1
}
]
</pre>

-------------------------------------------------
<<< '''updatesession'''

Команда из CRM в Oktell о продлении сессии пользователя (для сохранения возможности производить вход без пароля).

<pre>
[
"updatesession",
{
"qid": "9D484E0E-BE08-47B5-ABBD-490936881056",
"userlogin": "ivanov",
"userid": "29834234234",
"sessionid": "9238749273982734023",
"expires": 86400
}
]
</pre>

====Обмен состояниями пользователей====

-------------------------------------------------
<<< '''entercallcenter'''

Запрос из CRM на вход в режим call-центра. При проведении изменений в ответ отправляется сообщение userstatechanged.

<pre>
[
"entercallcenter",
{
"qid": "7DD2ED7A-B6BF-4988-A780-99719C65CA5D",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

<<< '''exitcallcenter'''

Запрос из CRM на выход из режима call-центра. При проведении изменений в ответ отправляется сообщение userstatechanged.

<pre>
[
"exitcallcenter",
{
"qid": "6E899456-C373-48EB-949E-E2C0D79D45EA",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''checkmyuserprivilege'''

Запрос из CRM на проверку наличия у пользователя обще-ролевой привилегии.

<pre>
[
"checkmyuserprivilege",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"code": "DashboardCreate"
}
]
</pre>

>>> '''checkmyuserprivilegeresult'''

Ответ на ''checkmyuserprivilege''.

<pre>
[
"checkmyuserprivilegeresult",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"code": "DashboardCreate",
"hasprivilege": true
}
}
]
</pre>

-------------------------------------------------
<<< '''getmyuserprivileges'''

Запрос из CRM на возврат всех имеющихся у пользователя обще-ролевых привилегий.

<pre>
[
"getmyuserprivileges",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''getmyuserprivilegesresult'''

Ответ на ''getmyuserprivileges''.

<pre>
[
"getmyuserprivilegesresult",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"privileges":[
"ExtWP",
"ViewOffice",
...
]
}
}
]
</pre>

====Текстовый чат v.1 (версии до 2.8.130909)====

Обмен текстовыми сообщениями в первоначальном варианте, где подразумевается только диалоговое общение между двумя пользователями.
Начиная с версии 2.8.130909 этот способ считается устаревшим.

-------------------------------------------------
>>> '''usertextmessagereceived'''

Сообщение-событие из Oktell в CRM о новом входящем текстовом сообщении чата.

<pre>
[
"usertextmessagereceived",
{
"qid": "D5582E04-2964-438C-A8DB-21AF898BBAE0",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"messageid": "0263C7BF-DEB3-406F-9CF9-6F56D828C755",
"snduserlogin": "Петров",
"snduserid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"sndusername": "Петров Антон Григорьевич",
"messagetext": "раз два три четыре пять вышел зайчик погулять",
"messagedate": "2011-03-27 14:12:28",
}
]
</pre>

>>> '''usertextmessageviewed'''

Сообщение-событие из Oktell в CRM о прочитанности отправленного сообщения.

<pre>
[
"usertextmessageviewed",
{
"qid": "D5582E04-2964-438C-A8DB-21AF898BBAE0",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"vieweduserid": "66D12297-E400-4862-BD24-F6DACCFDF9DA",
"messageids": [
"0263C7BF-DEB3-406F-9CF9-6F56D828C755",
"4B5110FD-899B-4429-A659-2B9695B4D89E"
]
}
]
</pre>

<<< '''sendusertextmessage'''

Запрос из CRM в Oktell на отправку текстового сообщения в рамках чата другому пользователю.
Вложения и сообщения в конференциях - опция, используемая веб-клиентом Oktell.

<pre>
[
"sendusertextmessage",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"messageid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"recvuserlogin": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"recvuserid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"messagetext": "раз два три четыре пять вышел зайчик погулять",
"isconferencechat": true,
"files": [
"Temp\1.jpg",
"Temp\2.jpg"
]
}
]
</pre>

>>> '''sendusertextmessageresult'''

Ответ из Oktell на команду отправки сообщения.

<pre>
[
"sendusertextmessageresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"messageid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"dtformat": "yyyy-MM-dd HH:mm:ss",
"sentdate": "2012-03-18 13:06:28"
}
]
</pre>

<<< '''setusermessageviewed'''

Запрос из CRM в Oktell на выставление признака прочитанности текстового сообщения пользователем. В ответ возвращается количество реально отмеченных сообщений. Может быть больше или меньше указанного. Событие о прочитанности отправляется пользователю, указанному в поле senderuserid (параметр может не указываться).

<pre>
[
"setusermessageviewed",
{
"qid": "AA29AE60-50C3-48EE-A32E-3D98265D7412",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"senderuserid": "689BD58D-2288-4E93-8647-58FB0756F3CA",
"messageids": [
"0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"4748964E-9ADC-4999-9ACB-12B8B46660CF"
]
}
]
</pre>

>>> '''setusermessageviewedresult'''

Ответ из Oktell на команду установки признака прочитанности ''setusermessageviewed''.

<pre>
[
"setusermessageviewedresult",
{
"qid": "AA29AE60-50C3-48EE-A32E-3D98265D7412",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"updatedcount": 12
}
]
</pre>

====Текстовый чат v.2 (версии начиная с 2.8.130909)====

Обмен текстовыми сообщениями протекает в рамках чатов - индивидуальных, массовых, прикрепленных. Вводится понятие чата с соответствующими свойствами - названием, списком участников, возможностью их редактирования. Требует подписки на совокупность событий ''chat''.
Интерфейс доступен и считается основным начиная с версии 2.8.130909.

-------------------------------------------------
<<< '''chatcreate'''

Запрос из CRM в Oktell на создание нового чата. Чаты создаются одним из участников, все остальные уведомляются о создании. Чаты могут существовать сколь угодно длительное время и использоваться многократно.
Идентификатор может не указываться, тогда он генерируется и возвращается в ответе.
Типы: 1 - приватный диалог двух участников, 2 - чат с нерегламентированным количеством участников, 3 - привязанный к конференции.
По результатам создания генерируется и отправляется событие ''[[chatcreated]]'' всем заявленным участникам чата.

<pre>
[
"chatcreate",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"name": "название чата",
"type": 2,
"linkedobjectid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240"
"members": [
"D9E54EB7-D3D9-43D6-B70C-019ABC6FC457",
"A530C87E-6A07-471C-B70C-E7C1C31AD9A7"
]
}
]
</pre>

>>> '''chatcreateresult'''

Ответ из Oktell на команду создания нового чата.

<pre>
[
"chatcreateresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240"
}
]
</pre>

-------------------------------------------------
<<< '''chatsetname'''

Запрос из CRM в Oktell на изменение названия существующему чату.
По результатам изменения генерируется и отправляется событие ''[[chatnamechanged]]'' всем авторизованным участникам чата.

<pre>
[
"chatsetname",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"name": "новое название чата"
]
}
]
</pre>

>>> '''chatsetnameresult'''

Ответ из Oktell на команду изменения названия чата.

<pre>
[
"chatsetnameresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''chataddmembers'''

Запрос из CRM в Oktell на добавление участников к существующему чату.
Операция доступна только для участников чата.
В качестве ключей участников ожидаются идентификаторы или логины (более затратная операция в части поиска).
По результатам изменения генерируется и отправляется событие ''[[chatmemberadded]]'' всем авторизованным участникам чата, включая новых.

<pre>
[
"chataddmembers",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"members": [
"D9E54EB7-D3D9-43D6-B70C-019ABC6FC457",
"A530C87E-6A07-471C-B70C-E7C1C31AD9A7"
]
}
]
</pre>

>>> '''chataddmembersresult'''

Ответ из Oktell на команду добавления участников к существующему чату.

<pre>
[
"chataddmembersresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''chatremovemembers'''

Запрос из CRM в Oktell на удаление участников из существующего чата.
Операция доступна только для создателя чата.
В качестве ключей участников ожидаются идентификаторы или логины (более затратная операция в части поиска).
По результатам изменения генерируется и отправляется событие ''[[chatmemberremoved]]'' всем авторизованным участникам чата, включая удаленных.

<pre>
[
"chatremovemembers",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"members": [
"D9E54EB7-D3D9-43D6-B70C-019ABC6FC457",
"A530C87E-6A07-471C-B70C-E7C1C31AD9A7"
]
}
]
</pre>

>>> '''chatremovemembersresult'''

Ответ из Oktell на команду удаления участников из существующего чата.

<pre>
[
"chatremovemembersresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''chatgetmembers'''

Запрос из CRM в Oktell на получение информации о текущих участниках указанного чата.

<pre>
[
"chatgetmembers",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
}
]
</pre>

>>> '''chatgetmembersresult'''

Ответ из Oktell на запрос информации о текущих участниках указанного чата.

<pre>
[
"chatgetmembersresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"members": [
{
"id":"D9E54EB7-D3D9-43D6-B70C-019ABC6FC457"
},
...
]
}
]
</pre>

-------------------------------------------------
<<< '''chatsendmessage'''

Запрос из CRM в Oktell на отправку сообщения в указанный чат.
Идентификатор messageid может не указываться, тогда генерируется и возвращается в ответе. Сообщение может содержать вложенные файлы ('''files''') и указание на скрытое их хранение на диске ('''hidefiles''').

<pre>
[
"chatsendmessage",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240"
"messageid": "2CD5BB8F-CC88-4D01-8A1F-5CEB2CD72AAE",
"messagetext": "раз два три четыре пять вышел зайчик погулять"
"hidefiles": false,
"files": [
"Temp\1.jpg",
"Temp\2.txt"
]
}
]
</pre>

>>> '''chatsendmessageresult'''

Ответ из Oktell на отправку сообщения в указанный чат.

<pre>
[
"chatsendmessageresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"messageid": "2CD5BB8F-CC88-4D01-8A1F-5CEB2CD72AAE"
}
]
</pre>

-------------------------------------------------
<<< '''chatsetmessageviewed'''

Запрос из CRM в Oktell на установку флага прочитанности указанного сообщения. Вместе с указанным сообщением маркируются прочитанными также все предшествующие сообщения этого же чата.

<pre>
[
"chatsetmessageviewed",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"messageid": "D9E54EB7-D3D9-43D6-B70C-019ABC6FC457"
}
]
</pre>

>>> '''chatsetmessageviewedresult'''

Ответ из Oktell на установку флага прочитанности сообщения.

<pre>
[
"chatsetmessageviewedresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

-------------------------------------------------
<<< '''chatgetprivateid'''

Запрос из CRM в Oktell на получение идентификатора существующего приватного диалога между двумя пользователями, один из которых - авторизованный пользователь. Приватные диалоги соответствуют чатам с типом "1".
В системе возможно существование нескольких приватных диалогов между пользователями, в этом случае возвращается любой из них. В случае отсутствия приватных диалогов в качестве идентификатора возвращается null.

<pre>
[
"chatgetprivateid",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"opponentid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240"
}
]
</pre>

>>> '''chatgetprivateidresult'''

Ответ из Oktell на запрос идентификатора приватного диалога. Если приватный диалог между пользователями не найден, возвращается null.

<pre>
[
"chatgetprivateidresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "D9E54EB7-D3D9-43D6-B70C-019ABC6FC457"
}
]
</pre>

-------------------------------------------------
<<< '''chatgetbyid'''

Запрос из CRM в Oktell на получение информации о чате, указанному с помощью идентификатора. Среди информационных полей возвращаются название, количество участников, последнее сообщение в чате с признаком ''прочитано/не прочитано'', а также идентификатор оппонента, если это приватный диалог.

<pre>
[
"chatgetbyid",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
}
]
</pre>

>>> '''chatgetbyidresult'''

Ответ из Oktell на запрос информации о чате. Если чат не найден по указанному идентификатору, возвращается null.

<pre>
[
"chatgetbyidresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtformat": "yyyy-MM-dd HH:mm:ss",
"chat": {
"id":"01483664-9D99-4B1B-8131-C46386A6FC68",
"name":"приватный чат",
"type":"1",
"creatorid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"membercount":"4",
"privateopponentid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"linkedobjectid":"",
"lastdtutc":"2013-09-05 14:08:02",
"lastmessage":{
"id":"4067F854-E88A-40C1-82C5-7F125A77A25F",
"amiauthor":false,
"authorid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"authorlogin":"sergeev",
"authorname":"Сергеев Вахтанг Абрикосович",
"dtutc":"2013-09-05 14:08:02",
"text":"Зайди как освободишься",
"isnew":"true"
}
}
}
]
</pre>

-------------------------------------------------
<<< '''chatgethotlist'''

Запрос из CRM в Oktell на получение информации о горячих чатах, в рамках которых последние сообщения были сравнительно недавно.
Запрос информации осуществляется с указанием нужной страницы (в сортированном по убыванию даты последней активности списке ''count'' элементов, начиная с ''startidx'').
Можно также наложить дополнительные фильтры, применяемые к названию чата и к имени оппонента приватного диалога (''search1'' и ''search2'').
Возвращаемая информация аналогична методу ''chatgetbyid''.

<pre>
[
"chatgethotlist",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"startidx": 0,
"count": 10,
"search1": "мой чат",
"search2": "vjq xfn",
}
]
</pre>

>>> '''chatgethotlistresult'''

Ответ из Oktell на запрос информации о горячих чатах.

<pre>
[
"chatgethotlistresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtformat": "yyyy-MM-dd HH:mm:ss",
"chatlist": [
{
"id":"01483664-9D99-4B1B-8131-C46386A6FC68",
"name":"приватный чат",
"type":"1",
"creatorid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"membercount":"4",
"privateopponentid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"linkedobjectid":"",
"lastdtutc":"2013-09-05 14:08:02",
"lastmessage":{
"id":"4067F854-E88A-40C1-82C5-7F125A77A25F",
"amiauthor":false,
"authorid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"authorlogin":"sergeev",
"authorname":"Сергеев Вахтанг Абрикосович",
"dtutc":"2013-09-05 14:08:02",
"text":"Зайди как освободишься",
"isnew":"true"
},
...
]
}
]
</pre>

-------------------------------------------------
<<< '''chatgettotalnewmessagecount'''

Запрос из CRM в Oktell на получение количества непрочитанных сообщений всего по всем чатам с участием пользователя.

<pre>
[
"chatgettotalnewmessagecount",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''chatgettotalnewmessagecountresult'''

Ответ из Oktell на запрос количества непрочитанных сообщений всего.

<pre>
[
"chatgettotalnewmessagecountresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"count": 31
}
]
</pre>

-------------------------------------------------
<<< '''chatgetmessagehistory'''

Запрос из CRM в Oktell на получение истории сообщений по чату.
Может быть наложен дополнительный фильтр на текст сообщения (''search1'' и ''search2''), ограничения на период выдачи истории (''dtstartutc'', ''dtstoputc''). По умолчанию весь период истории без фильтрации по тексту сообщений.
Данные выдаются из сортированного по убыванию даты отправки списка сообщений с указанной страницы (''startidx'', ''count''). По умолчанию первые 10 сообщений.

<pre>
[
"chatgetmessagehistory",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "14D6DBB7-D5CB-471B-888A-9AACC8CD737B",
"startidx": 0,
"count": 50,
"dtstartutc": "2013-07-12 13:00:00",
"dtstoputc": "2013-07-12 15:00:00",
"search1": "abkmnh",
"search2": "фильтр"
}
]
</pre>

>>> '''chatgetmessagehistoryresult'''

Ответ из Oktell на запрос истории сообщений в чате.

<pre>
[
"chatgetmessagehistoryresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtformat": "yyyy-MM-dd HH:mm:ss",
"messagelist": [
{
"id":"4067F854-E88A-40C1-82C5-7F125A77A25F",
"amiauthor":false,
"authorid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"authorlogin":"sergeev",
"authorname":"Сергеев Вахтанг Абрикосович",
"dtutc":"2013-09-05 14:08:02",
"text":"Зайди как освободишься",
"isnew":"true"
"files":[
{
"path":"Temp\1.jpg",
"size":329002
},
...
]
},
...
]
}
]
</pre>

-------------------------------------------------
>>> '''chatcreated'''

Сообщение из Oktell в CRM о факте создания нового текстового чата с участием авторизованного пользователя.
Отправляется всем участникам созданного чата.

<pre>
[
"chatcreated",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtformat": "yyyy-MM-dd HH:mm:ss",
"chat": {
"id":"01483664-9D99-4B1B-8131-C46386A6FC68",
"name":"приватный чат",
"type":"1",
"creatorid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"membercount":"4",
"privateopponentid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"linkedobjectid":"",
"lastdtutc":"2013-09-05 14:08:02",
"members":[
{
"id": "",
"name": ""
},
...
]
}
}
]
</pre>

-------------------------------------------------
>>> '''chatnamechanged'''

Сообщение из Oktell в CRM о факте изменения названия существующего текстового чата.
Отправляется всем участникам этого чата.

<pre>
[
"chatnamechanged",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "41EE8C8F-A7DE-4F78-8F57-7F299CE2767B",
"name": "новое имя"
]
</pre>

-------------------------------------------------
>>> '''chatmemberadded'''

Сообщение из Oktell в CRM о факте добавления новых участников к существующему текстовому чату.
Отправляется всем участникам этого чата.

<pre>
[
"chatmemberadded",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "41EE8C8F-A7DE-4F78-8F57-7F299CE2767B",
"members":[
{
"id": "",
"name": ""
},
...
]
}
]
</pre>

-------------------------------------------------
>>> '''chatmemberremoved'''

Сообщение из Oktell в CRM о факте удаления некоторых участников из существующего текстового чата.
Отправляется всем участникам этого чата.

<pre>
[
"chatmemberremoved",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "41EE8C8F-A7DE-4F78-8F57-7F299CE2767B",
"members":[
{
"id": ""
},
...
]
}
]
</pre>

-------------------------------------------------
>>> '''chatmessage'''

Сообщение из Oktell в CRM о факте поступления сообщения из текстового чата.
Отправляется всем участникам этого чата, включая отправителя (в этом случае поля authorname и authorlogin отсутствуют).

<pre>
[
"chatmessage",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtformat": "yyyy-MM-dd HH:mm:ss",
"chatid": "41EE8C8F-A7DE-4F78-8F57-7F299CE2767B",
"messageid": "14D6DBB7-D5CB-471B-888A-9AACC8CD737B",
"amiauthor": false,
"authorid": "B1D4DCA9-2246-4EA1-B71E-68FF29AC92E4",
"authorname": "",
"authorlogin": "",
"dtutc": "2013-09-05 16:10:04",
"text": "тело сообщения",
"isnew": true
"files":[
{
"path":"Temp\1.jpg",
"size":329002
},
...
]
}
]
</pre>

-------------------------------------------------
>>> '''chatmessageviewed'''

Сообщение из Oktell в CRM о факте прочтения сообщения кем либо из участников текстового чата.
Генерируется для отправителя сообщения, а также для пользователя, который прочитал сообщение.

<pre>
[
"chatmessageviewed",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "41EE8C8F-A7DE-4F78-8F57-7F299CE2767B",
"messageid": "14D6DBB7-D5CB-471B-888A-9AACC8CD737B",
}
]
</pre>

====Голосовая почта====

-------------------------------------------------
>>> '''voicemailreceived'''

Сообщение из Oktell в CRM о факте поступления голосовой почты на ящик пользователя.

<pre>
[
"voicemailreceived",
{
"qid": "080C0DF2-442B-410E-9204-4ADB3399FCC0",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

====Всплывающие уведомления====

-------------------------------------------------
>>> '''shownotifymessage'''

Команда из Oktell в CRM об уведомлении пользователя по аналогии с всплывающими уведомлениями клиентского приложения Oktell

<pre>
[
"shownotifymessage",
{
"qid": "99CC8C57-1793-486A-AFB1-6E5CA3E6855E",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"id": "A33027E1-096F-38B8-1198-BB4D7C15823A",
"sender": "АТС",
"text": "Петров",
"savedb": "true",
"autohide": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"dtformat": "dd.MM.yyyy HH:mm:ss",
"dt": "25.09.2011 13:07:12",
"type": 262144,
"backcolor": "00FF0000",
"uniquekey": "E7899B61-55C3-4007-91EE-DDB348913AA8",
}
]
</pre>
<pre>
//* id - идентификатор сообщения. Присутствует, если сообщение сохранено в БД.
//* savedb: true|false. Сохранено ли сообщение в БД.
//* dt - дата/время генерации уведомления.
//* uniquekey - код сообщения. Может отсутствовать. Но если есть - допускается одновременное отображение только
одного уведомления с таким кодом (либо закрывать автоматически предыдущее, либо не отображать это)
//* backcolor - hex AARRGGBB
//* type - тип сообщения из флагового списка кратных двойке кодов
</pre>

-------------------------------------------------
<<< '''setnotifyshown'''

Запрос из CRM в Oktell об установке признака прочтенности уведомления. Это актуально для уведомлений, сохраняемых в БД.

<pre>
[
"setnotifyshown",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"id": "A33027E1-096F-38B8-1198-BB4D7C15823A",
"wasshown": false
}
]
</pre>
<pre>
//* id - идентификатор сообщения. Может отсутствовать. Но если есть - допускается одновременное отображение только
одного уведомления с таким кодом (либо закрывать автоматически предыдущее, либо не отображать это)
//* ids - список идентификаторов отображенных уведомлений.
</pre>

====Сообщения от АТС====

-------------------------------------------------
>>> '''phoneevent_ringstarted'''

Сообщение из Oktell в CRM о входящем звонке. Не имеет отношения к постановке звонка в очередь. Фактически когда телефон пользователя начал звенеть.

<pre>
[
"phoneevent_ringstarted",
{
"qid": "00488421-97E4-443B-81B7-D645E403AEBB",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
"callerlineid": "BC1FD50B-651F-459D-B659-28230E919673",
"callerlinenum": "13027",
"callerdirection": "oktell_pbx",
"callerid": "73439170203",
"callername": "ОАО Металлург",
"callerdescription": "Металлоконструкции, изделия из черных и цветных металлов",
"callerinfo": "Абонент: 315, Задача 'Входящие в call-центр'",
"callercomment": "Еще что-то об абоненте",
"calleruserlogin": "",
"calleruserid": "00000000-0000-0000-0000-000000000000",
"isextline": true,
"canfax": true,
"canvideo": false,
"isconference": false,
"confid": "00000000-0000-0000-0000-000000000000",
"confname": "",
"confroom": 0,
"confinviternumber": "",
"confinviteruserid": "00000000-0000-0000-0000-000000000000",
"confinviteruserlogin": "",
"istask": true,
"taskid": "F94BD1FE-B628-4CC3-B215-F3F84B275EDD",
"taskname": "Входящие в call-центр"
}
]
</pre>
<pre>
//* Частично могут отсутстовать параметры, описывающие абонента.
// Если istask=false, то остутствуют taskid, taskname, tasktalklimitsec, taskfromhandlesec
// Если звонок не от другого пользователя, то отсутствуют calleruserlogin, calleruserid
// Если isconference=false, то отсутствует confid, confname, confroom
</pre>

-------------------------------------------------
>>> '''phoneevent_ringstopped'''

Сообщение из Oktell в CRM о прекращении входящего вызова. Если пользователь не снял трубку, а вызов прекратился.

<pre>
[
"phoneevent_ringstopped",
{
"qid": "BEB91146-BA27-4236-9CAC-EF562719E7E5",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718"
}
]
</pre>

-------------------------------------------------
>>> '''phoneevent_commstarted'''

Сообщение из Oktell в CRM о коммутации

<pre>
[
"phoneevent_commstarted",
{
"qid": "B7ACFEC1-65BB-4773-A425-DC39F5D1A48C",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
"commutationid": "072F2EE0-4B3B-49A7-AB5B-E213AE752A53"
"callerlineid": "BC1FD50B-651F-459D-B659-28230E919673",
"callerlinenum": "13027",
"callerid": "73439170203",
"callername": "ОАО Металлург",
"callerdescription": "Металлоконструкции, изделия из черных и цветных металлов",
"callerinfosimple": "Абонент: 315, Задача 'Входящие в call-центр'",
"callercomment": "Еще что-то об абоненте",
"calleruserlogin": "",
"calleruserid": "00000000-0000-0000-0000-000000000000",
"isextline": true,
"canfax": true,
"canvideo": false,
"cansendfiles": true,
"canbuildconf": true,
"isivrscript": false,
"isconference": false,
"confid": "00000000-0000-0000-0000-000000000000",
"confname": "",
"confroom": 0,
"istask": true,
"taskid": "F94BD1FE-B628-4CC3-B215-F3F84B275EDD",
"taskname": "Входящие в call-центр",
"tasktalklimitsec": 180,
"taskfromhandlesec": 24
}
]
</pre>
<pre>
//* Частично могут отсутстовать параметры, описывающие абонента.
// Если istask=false, то остутствуют taskid, taskname, tasktalklimitsec, taskfromhandlesec
// Если звонок не от другого пользователя, то отсутствуют calleruserlogin, calleruserid
// Если isconference=false, то отсутствует confid, confname, confroom
</pre>

-------------------------------------------------
>>> '''phoneevent_commstopped'''

Сообщение из Oktell в CRM о завершении коммутации. Не путать со звонком. Коммутаций в рамках обработки звонка может быть много.

<pre>
[
"phoneevent_commstopped",
{
"qid": "D514511C-BD4F-406B-B9C7-695CDC6C40E7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
"commutationid": "072F2EE0-4B3B-49A7-AB5B-E213AE752A53"
}
]
</pre>

-------------------------------------------------
>>> '''phoneevent_ivrstarted'''

Сообщение из Oktell в CRM о соединении с IVR-сценарием.

<pre>
[
"phoneevent_ivrstarted",
{
"qid": "46E07742-0B24-4DD6-B4C6-12CDC1F7B938",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"scriptname": "(Служебный) Вход в АТС",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
"commutationid": "072F2EE0-4B3B-49A7-AB5B-E213AE752A53"
}
]
</pre>

-------------------------------------------------
>>> '''phoneevent_ivrstopped'''

Сообщение из Oktell в CRM о завершении соединения с IVR сценарием.

<pre>
[
"phoneevent_ivrstopped",
{
"qid": "FC9DD78C-1A5F-4E06-9AB5-A9CEDE025F6A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
>>> '''phoneevent_acmcallstarted'''

Сообщение из Oktell в CRM о запуске автодозвона.

<pre>
[
"phoneevent_acmcallstarted",
{
"qid": "410B1930-423E-4632-B3DE-54EC48C0E8A0",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
"callnumber": "471",
"isextline": false,
"callername": "Сигизмунд Львович Кац",
}
]
</pre>

-------------------------------------------------
>>> '''phoneevent_acmcallstopped'''

Сообщение из Oktell в CRM об остановке автодозвона.

<pre>
[
"phoneevent_acmcallstopped",
{
"qid": "410B1930-423E-4632-B3DE-54EC48C0E8A0",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
}
]
</pre>

-------------------------------------------------
>>> '''phoneevent_faxstarted'''

Сообщение из Oktell о начале факс-сеанса на оппозитном канале.

<pre>
[
"phoneevent_faxstarted",
{
"qid": "28979AE8-8E06-4EED-9114-98CB126CA8F4",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
"opponentlineid": "BC1FD50B-651F-459D-B659-28230E919673",
"faxdirection": "send",
"description": ""
}
]
</pre>

-------------------------------------------------
>>> '''phoneevent_faxstopped'''

Сообщение из Oktell о завершении факс-сеанса на оппозитном канале (следом возврат в коммутацию, если трубку не положили там).

<pre>
[
"phoneevent_faxstopped",
{
"qid": "324CD087-BC2D-4FF3-A9BD-86A7276A4DED",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
"result": 0,
"error": 65289,
"errormsg": "NoFaxPages"
}
]
</pre>
<pre>
//* error: список FaxError
</pre>

-------------------------------------------------
>>> '''phoneevent_faxreceived'''

Cообщение из Oktell о завершении приема факса со ссылками на файлы.

<pre>
[
"phoneevent_faxreceived",
{
"qid": "C20E48DF-628D-4954-ADDE-D2C3B31C6700",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"files": [
{
"filename": "",
"filesize": 172934,
"filelink": "\/temp\/receivedfax\/a802d3ea\/img01.tiff",
"availabletill": "2011-03-27 23:39:18",
},
{...},
{...}
]
}
]
</pre>
<pre>
//* Даже если result=0, могут быть частично полученные файлы.
</pre>

-------------------------------------------------
>>> '''flashstatechanged'''

Cообщение из Oktell о смене состояния линии, находящейся на удержании.

<pre>
[
"flashstatechanged",
{
"qid": "99CC8C57-1793-486A-AFB1-6E5CA3E6855E",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"flashtypeid": 1,
"flashtypestr": "Put",
"oppositeid": "91FD3E18-B3A7-4662-8E06-C95C7D245DC3"
}
]
</pre>
<pre>
//* Список возможных состояний:
Put = 1 — постановка на удержание
Return = 2 — возврат с удержания
Abort = 3 — прерывание удержания при положении трубки или другими действиями. Абонент на удержании получит сигнал занято.
Lost = 4 — абонент прервал ожидание, либо ошибка при попытке переключения на него
Switch = 5 — перевод ожидающего на кого-то другого
Invite = 6 — переключение с абонентом в конференцию
Between = 7 — переключение между двумя абонентами на удержании(без обрыва)
Next = 8 — отбой текущего абонента и переход сразу на набор номера без возврата к абоненту на удержании
Flashed = 11 — пользовать сам был поставлен кем-то на удержание
Restored = 12 — пользователь возвращён из удержания
Aborted = 13 — удержание пользователя прервано
</pre>

-------------------------------------------------
>>> '''linestatechanged'''

Cообщение из Oktell о смене состояния внутренней линии

<pre>
[
"linestatechanged",
{
"qid": "99CC8C57-1793-486A-AFB1-6E5CA3E6855E",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"linestateid": 4,
"linestatestr": "lsReady"
}
]
</pre>
<pre>
//* Список возможных состояний внутренней линии:
lsDisconnected = 1 — не подключена
lsOff = 2 — выключена
lsReady = 4 — готова
lsHookUp = 8 — поднята трубка
lsIncomingCall = 16 — входящий звонок
lsCommutated = 32 — скоммутирована
lsWait = 64 — ожидание дозвона\коммутации
lsFlash = 128 — флеш\удержание
lsWaitDown = 256 — ожидание с положенной трубкой(отдельный статус резервирования линии при использовании сервиса автодозвона)
lsListenBusy = 512 — сигнал "Занято" в линии(коммутация разорвана по инициативе противоположной стороны)
lsUndefined = 1024 — неопределено
lsReserved = 2048 — зарезервирована
</pre>

====Команды к АТС====

-------------------------------------------------
<<< '''pbxautocallstart'''

Запрос из CRM к Oktell на совершение звонка. В зависимости от текущего состояния линии - запускается автодозвон или нет, звонок на внешнюю линию, во внутрений номерной план, или автоопределение, сначала вызываться сам пользователь будет, а потом звонок абоненту, или сначала дозвон до абонента, а потом вызов пользователя.

<pre>
[
"pbxautocallstart",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"number": "425",
"direction": "int",
"sequence": "abonent",
"intercom": false
}
]
</pre>
<pre>
//* direction: int, ext, undefined (внутрь, наружу, автоопределение)
//* sequence: abonent, user (сначала до абонента, сначала до пользователя)
//* intercom: true|false (интерком-вызов, обычный вызов)
</pre>

>>> '''pbxautocallstartresult'''

Ответ из Oktell в CRM на запрос звонка.

<pre>
[
"pbxautocallstartresult",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"number": "425",
"direction": "int",
"sequence": "abonent",
"result": 0,
"error": 5,
"errormsg": "cntNumberNotFound"
}
]
</pre>
<pre>
//* error, errormsg: EACMAnswer:
//* cntStartedSuccessfully = 0 //Звонок успешно взят в реализацию
//* cntUserNotReady = 1 //У пользователя-инициатора не найдены линии, готовые линии, или состояние кривое
//* cntBusy = 2 //При звонке на внутренний номер - признак занятости. В очереди и сам повисеть может
//* cntExtLineNotFound = 3, //Не найдены готовые внешние линии
//* cntError = 4, //Прочие ошибки, исключения.
//* cntControlNotReady = 5, //Режим не доделан.
//* cntNumberNotFound = 6 //Внутренний номер не найден (по факту, если сервер сам будет определять
направление звонка, это вообще не будет задействовано)
</pre>

-------------------------------------------------
<<< '''pbxautocallabort'''

Запрос из CRM к Oktell на прекращение автодозвона
<pre>
[
"pbxautocallabort",
{
"qid": "28BF3E8F-1F97-47AB-BD42-92D174D4A705",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''pbxtransfercall'''

Аналогично запросу из CRM на совершение звонка - запрос на совершение переключения. Если линия свободна - действует аналогично полностью запросу на звонок. Если пользователь в разговоре - через флэш набирает указанный номер.

<pre>
[
"pbxtransfercall",
{
"qid": "81FBE5C2-E81B-4D0D-8AC0-72C22ACCD4E2",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"number": "425",
"direction": "int",
"sequence": "abonent",
"intercom": false
}
]
</pre>

>>> '''pbxtransfercallresult'''

И аналогичный ответ из Oktell в CRM.

<pre>
[
"pbxtransfercallresult",
{
"qid": "81FBE5C2-E81B-4D0D-8AC0-72C22ACCD4E2",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"number": "425",
"direction": "int",
"sequence": "abonent",
"result": 0,
"error": 5,
"errormsg": "cntNumberNotFound"
}
]
</pre>

-------------------------------------------------
>>> '''pbxdeclinecall'''

Запрос из CRM к Oktell на отклонение звонка.

<pre>
[
"pbxdeclinecall",
{
"qid": "0AFB2B0C-A68F-448B-9B4B-AB42096D4E95",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''pbxabortcall'''

Запрос из CRM к Oktell на обрыв текущего существующего сеанса связи. Не путать с DeclineCall. Прекращает коммутацию, если существует, прекращает автодозвон, если запущен.

<pre>
[
"pbxabortcall",
{
"qid": "53F2EE86-46AF-4A37-8C60-2F27EADD10DE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<div id="pbxmakeflash"></div>
<<< '''pbxmakeflash'''

Запрос из CRM в Oktell на программную эмуляцию флэш.

<pre>
[
"pbxmakeflash",
{
"qid": "DD836C5D-4F3E-4FD2-9B60-24E330B03FC6",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"mode": "default"
}
]
</pre>
<pre>
//* mode - abort, switch, next - устанавливает поведение, если на удержании уже находится абонент.
abort - обрыв текущему и переключение на того кто на удержании
switch - возврат к тому, кто на удержании, с размещением текущего на удержании
next - обрыв текущему и переход сразу в набор номера
</pre>

-------------------------------------------------
<<< '''pbxmaketransfer'''

Запрос из CRM в Oktell на перевод текущего звонка. 
Если A соединен с B, и от А приходит команда трансфер(C), то абонента B переключает на C, а A в отбой. 
Если A соединен с B, а в это время во флеше/холде находится D, то абонента B переключает на C, а A соединяется с D. 
Если A ни с кем не соединен, то просто отбой в A.

<pre>
[
"pbxmaketransfer",
{
"qid": "DD836C5D-4F3E-4FD2-9B60-24E330B03FC6",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"transferto": "475"
}
]
</pre>
<pre>
//* transferto - номер, на который осуществить перевод.
</pre>

-------------------------------------------------
<<< '''pbxclearflash'''

Запрос из CRM в Oktell на обрыв линии, находящейся на удержании.

<pre>
[
"pbxclearflash",
{
"qid": "DD836C5D-4F3E-4FD2-9B60-24E330B03FC6",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''pbxfaxreceive'''

Запрос из CRM в Oktell на переключение в прием факса.

<pre>
[
"pbxfaxreceive",
{
"qid": "59305AD1-40A5-476A-B76D-2DAB1F2A89D3",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"linkmode": "simple"
}
]
</pre>
<pre>
//* linkmode - full, simple - устанавливает формат ссылок, в котором будут указаны полученные файлы
в событии об окончании приема.
full - вернуть абсолютную ссылку на скачивание через http.
simple - вернуть относительную ссылку на скачивание.
При формировании абсолютной ссылки в качестве доменного имени берется значение из
раздела [[Интеграция с WEB-Socket CRM]] общих настроек Oktell.
</pre>

<<< '''pbxfaxstop'''

Запрос из CRM в Oktell на прерывание приема/передачи факса.

<pre>
[
"pbxfaxstop",
{
"qid": "59305AD1-40A5-476A-B76D-2DAB1F2A89D3",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''pbxdtmf'''

Запрос из CRM в Oktell на генерацию софт-DTMF.

<pre>
[
"pbxdtmf",
{
"qid": "DD836C5D-4F3E-4FD2-9B60-24E330B03FC6",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtmf": "#"
}
]
</pre>
<pre>
//* dtmf: цифры, *, #
</pre>

-------------------------------------------------
<<< '''pbxanswercall'''

Запрос из CRM в Oktell на снятие трубки при входящем звонке (с помощью изменения SIP-вызова на интерком).

<pre>
[
"pbxanswercall",
{
"qid": "DD836C5D-4F3E-4FD2-9B60-24E330B03FC6",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

-------------------------------------------------
<<< '''pbxinterceptcall'''

Запрос из CRM в Oktell на перехват вызова
<pre>
[
"pbxinterceptcall",
{
"qid": "DD836C5D-4F3E-4FD2-9B60-24E330B03FC6",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"number": "400"
}
]
</pre>
<pre>
//* number - внутренний номер, вызов на который необходимо перехватить. Если не задан, то перехват первого доступного из групповых.
</pre>

====Запросы к АТС общего характера====

-------------------------------------------------------------------
<<< '''exectmcall'''

Запрос из CRM в Oktell. Осуществляет размещение короткого задания на дозвон и соединение с указанным оператором (пользователем).
Дозвониться до одного из указанных абонентов-номеров группы A, соединить с одним из указанных абонентов-номеров группы B.
Результатом выполнения является одна коммутация.

Не требует указания пользователя.
Считается серверным методом, хотя может вызываться и по индивидуальному клиентскому каналу.

<pre>
[
"exectmcall",
{
"qid": "BE06A1E4-759A-4BFA-8D15-5FCF756EEE53",
"taskid": "qud82039lsdfmnasd",
"a_abonents": [
"7931289",
"83959279394",
"425",
"688C1DD6-7429-4B47-819D-C15827654A53",
{
"type": 11,
"key": "84951435565"
}
],
"b_abonents": [
"1211F58F-93AE-470C-895D-E3A163E8FF5F",
"ivanov",
"2BC51D79-BA63-47D7-93CA-1F283029C529",
{
"type": 12,
"key": "1211F58F-93AE-470C-895D-E3A163E8FF5F"
}
]
"mode": 0
}
]
</pre>
<pre>
[
"exectmcall",
{
"qid": "BE06A1E4-759A-4BFA-8D15-5FCF756EEE53",
"taskid": "qud82039lsdfmnasd",
"taskcode": "xxxxx",
"a_abonents": ["4952172020"],
"b_abonents": ["417"],
"mode": 0,
"ownertext": "Задача соединения",
"sessionid": "FB232E90-524A-453C-95BA-1B42251F5A14",
"projectid": "F95BA34E-2CE2-49FA-B3C2-4344199F5B42",
"a_callerid": "4959261589",
"a_music": "Фоновое воспроизведение для оператора",
"a_usequeue": false,
"a_queuepriority": 10,
"a_timeoutsec": 40,
"b_callerid": "4952172020",
"b_music": "?**ivr?Фоновое воспроизведение",
"b_usequeue": true,
"b_queuepriority": 5,
"b_timeoutsec": 40,
}
]
</pre>
<pre>
Обязательными параметрами являются только a_abonents и b_abonents. Остальные имеют значения по умолчанию.

//* taskid - уникальный строковый идентификатор задания.
Может быть не указан, тогда генерируется автоматически.
//* taskcode - пользовательский код задачи, передается в сценарии, обслуживающие дозвоны.
//* a_abonents - набор из одного или нескольких абонентов, относящихся к группе A.
//* b_abonents - набор из одного или нескольких абонентов, относящихся к группе B.
abonent:type - типы представления о конкретном абоненте
Undefined = 0, //Не определен, определить автоматически.
External = 11,//Внешний номер
InternalItem = 12,//Внутренний элемент - пользователь или линия,
задаются ключами (идентификатор, номер, логин, имя).
InternalRule = 13,//Стандартный внутренний номер
InternalFast = 14,//Быстрый номер
InternalEmergency = 15,//Экстренный номер
InternalIVR = 16,//Сценарий IVR
//* mode:
0 - вызывает сначала группу A (достает первого ответившего),
потом абонентов группы B (достает первого ответившего)
1 - вызывает сначала группу B (достает первого ответившего),
потом абонентов группы A (достает первого ответившего)
2 - вызывает одновременно всех, достает первого ответившего из группы A
и первого ответившего из группы B.
//* a_music, b_music - мелодия ожидания для абонентов группы A и B. Задается с помощью строки:
- ''?**ivr?scriptname'', где scriptname - название фонового медиа сценария IVR.
- ''?**ff?filepath'', где filepath - абсолютный путь к звуковому файлу (*.mp3 или *.wav).
- ''?**ff?folderpath'', где folderpath - абсолютный путь к каталогу со звуковыми файлами, выбираются рандомно.
- ''?**ff?filename'', где filename - название файла с расширением (*.mp3 или *.wav) в стандартном каталоге Snd.
- абсолютный путь к каталогу cо звуковыми файлами
- абсолютный путь к файлу
- название файла с расширением в стандартном каталоге Snd
- название фонового медиа-сценария IVR
- если не указывать, указывать неверно или указывать пустоту - играется
[[Музыкальное сопровождение#Alternative|альтернативная мелодия ожидания]] (возможно сценарий) из общих настроек
//* sessionid - генерируемый идентификатор цепочки коммутаций/сессии.
//* ownertext - название владельца служебного сценария набора номеров.
//* projectid - привязанный идентификатор проекта (участвует в поиске сценариев).
//* a_usequeue, b_usequeue: true|false. Использовать ли очередь ожидания при вызове внутренних абонентов.
//* a_queuepriority, b_queuepriority: числовой приоритет при размещении в очередях.
Традиционно чем меньше значение - тем больше приоритет.
Значения по умолчанию определены в [[Настройки менеджера очередей|общих настройках]]
//* a_timeoutsec, b_timeoutsec: таймаут в секундах для вызова абонентов соответствующей группы.
Режим использования таймаута задается в разделе [[Настройки менеджера очередей|настроек менеджера очередей]].
</pre>

>>> '''exectmcallresult'''

Ответ из Oktell в CRM. Возвращает результат исполнения хранимой процедуры в БД Oktell. Перечисляет все выходные наборы данных.

<pre>
[
"exectmcallresult",
{
"qid": "BE06A1E4-759A-4BFA-8D15-5FCF756EEE53",
"taskid": "qud82039lsdfmnasd"
}
]
</pre>
<pre>
//* taskid - возвращает идентификатор запущенного задания.
В дальнейшем с помощью него можно будет отменить задание (если оно еще не будет к тому времени исполнено)
</pre>

>>> '''exectmcallreport'''

Отчет о выполнении задания. Указывает код задания, и причину ошибки в случае неудачи.

<pre>
[
"exectmcallreport",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859",
"taskid": "qud82039lsdfmnasd",
"success": false,
"errorid": 21,
"errorstr": "CallAbonentFailure"
}
]
</pre>

-------------------------------------------------------------------
<<< '''stoptmcall'''

Запрос из CRM в Oktell. Отменяет ранее запущенное методом ''exectmcall'' задание, если оно еще не завершило исполнение.

Не требует указания пользователя.

<pre>
[
"stoptmcall",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859",
"taskid": "qud82039lsdfmnasd"
}
]
</pre>

>>> '''stoptmcallresult'''

Ответ от Oktell в CRM. Возвращает результат отмены задания.

<pre>
[
"stoptmcallresult",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859",
"taskid": "qud82039lsdfmnasd",
"success": false,
"errortext": "task not found"
}
]
</pre>

-------------------------------------------------------------------
<<< '''gettotalqueue'''

Запрос из CRM в Oktell на возврат информации обо всех очередях.
Может использоваться без указания пользователя.
Не рекомендуется к частому использованию, так как требует значительных вычислительных ресурсов.

<pre>
[
"gettotalqueue",
{
"qid": "DDDB5BCA-A200-448C-93C7-EFEAE5AFE48D",
"skipempty": true
}
]
</pre>

>>> '''gettotalqueueresultresult'''

Ответ из Oktell в CRM. Возвращает список всех очередей и их абонентов

<pre>
[
"gettotalqueueresult",
{
"qid": "DDDB5BCA-A200-448C-93C7-EFEAE5AFE48D",
"result": [
{
"numid": "507db30b-f8f7-46cf-b3c7-6b8ba7b696a8",
"numprefix": "12",
"ruleid": "6ffab1ac-7b9b-4ba2-8547-233175368b6d",
"rulename": "Денис"
"queue": [
{
"objectid": "928efda2-a3b3-423b-9d49-d2e76879c718",
"chainid": "d1c2b337-6293-4ea0-a355-f59caaeff54b",
"srcelementid": "38d8b6ad-a68b-4075-a1a3-038510f20a54",
"objecttype": 0,
"objecttypestr": "qotQueueLogic",
"queuesource": 1,
"queuesourcestr": "qsLineLogic",
"callerid": "14",
"calledid": "12",
"isuser": true,
"userid": "da803f01-ea77-40fa-bc9d-e2efb36fd5a8",
"userlogin": "Peter",
"username": "Петр Александрович",
"department": "Программисты",
"managedlineid": "38d8b6ad-a68b-4075-a1a3-038510f20a54",
"managedlinenumber": "16001",
"srclineid": "38d8b6ad-a68b-4075-a1a3-038510f20a54",
"srclinenumber": "16001",
"queuepriority": 9,
"startqueuetime": "2012-06-07 12:58:44",
"lenqueue": 1.4375,
"istask": false
}
]
},
...
{}
]
}
]
</pre>
<pre>
//* result - содержит список всех очередей. Очередь при этом содержится в словаре.
//* result:numid - идентификатор стандартного внутреннего номера, при котором данная очередь.
//* result:numprefix - стандартный внутреннего номер, при котором данная очередь.
//* result:ruleid - идентификатор номерного правила, при котором данная очередь.
//* result:rulename - название номерного правила, при котором данная очередь.
//* result:queue - список абонентов очереди в порядке убывания. Каждый абонент содержится в словаре.
</pre>

====Запуск служебного сценария====

-------------------------------------------------
<<< '''startsvcscript''',
'''execsvcscript'''

Запрос из CRM в Oktell на запуск служебного сценария. ''startsvcscript'' - от имени пользователя, ''execsvcscript'' - без указания пользователя от имени сервера.

<pre>
[
"startsvcscript",
{
"qid": "244E3867-470E-4A56-904D-D435D57CFBFE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"scriptname": "Служебный сценарий получения почты",
"startparam1": "значение параметра 1",
"startparam2": "значение параметра 2",
"startparam3": "значение параметра 3",
"startparam4": "значение параметра 4",
"startparam5": "значение параметра 5",
"waitresponse": true,
"waittimeoutsec": 10
}
]
</pre>
<pre>
[
"execsvcscript",
{
"qid": "244E3867-470E-4A56-904D-D435D57CFBFE",
"scriptname": "Служебный сценарий получения почты",
"startparam1": "значение параметра 1",
"startparam2": "значение параметра 2",
"startparam3": "значение параметра 3",
"startparam4": "значение параметра 4",
"startparam5": "значение параметра 5",
"waitresponse": true,
"waittimeoutsec": 10
}
]
</pre>
<pre>
//* scriptname - название сценария в общем разделе.
//* startparamN - строковое значение соответствующего параметра.
При необходимости передать больше параметров следует объединять параметры в одну строку
с использованием символа-разделителя, а в самом сценарии производить обратную операцию.
//* waitresponse - ожидать ли ответа.
//* waittimeoutsec - таймаут ожидания ответа в секундах. 0 - вечно.
</pre>

>>> '''startsvcscriptresult''',
'''execsvcscriptresult'''

Ответ Oktell на запрос запуска служебного сценария.

<pre>
[
"startsvcscriptresult",
{
"qid": "244E3867-470E-4A56-904D-D435D57CFBFE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"scriptname": "Служебный сценарий получения почты",
"result": 0,
"returnvalue": "присвоенный в сценарии результат",
"error": 10
}
]
</pre>
<pre>
[
"execsvcscriptresult",
{
"qid": "244E3867-470E-4A56-904D-D435D57CFBFE",
"scriptname": "Служебный сценарий получения почты",
"result": 0,
"returnvalue": "присвоенный в сценарии результат",
"error": 10
}
]
</pre>
<pre>
//* error: 10 - файл не найден, 11 - исключение, 12 - таймаут
//* returnvalue - возвращаемый результат сценария (если сценарий исполнился, и его завершения удалось дождаться)
</pre>

====Конференц-связь====

Запросы из CRM, ответы от Oktell, события из Oktell

---------------------------------------------
<<< '''confhandleevent'''

Запрос из CRM к Oktell. Подписка/отписка на указанную категорию событий сервера конференций.

<pre>
[
"confhandleevent",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"eventtype": "competitors",
"handle": true
}
]
</pre>
<pre>
//* eventtype - уровень глубины получаемых сообщений. conferences|competitors|userstates
предполагается, что в общем случае инфа идет только о списке конференций (conferences);
когда юзер находится в конференции - дополнительно о внутреннем состоянии конференции (competitors);
когда юзер настраивает конференцию и выбирает из списка участников для автоматического приглашения -
о состояниях всех пользователей (userstates).
Подписками управляет сам внешний модуль. Когда потребность уходит - необходимо отписываться,
чтобы не заваливать канал порожняком.
//* handle - true|false - подписаться/отписаться
</pre>

---------------------------------------------
<<< '''checkcanconnecttogathertoconference'''

Запрос из CRM к oktell. В момент коммутации, в случае если во флеш-буфере находится абонент, определяет, существует ли возможность переключиться всем вместе в конференцию единой командой. Это возможно, если один из абонентов - конференция, а другой - линия/пользователь.

<pre>
[
"checkcanconnecttogathertoconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''confcheckcanconnecttogatherresult'''

Ответ из Oktell в CRM на запрос возможности совместного переключения в конференцию.

<pre>
[
"confcheckcanconnecttogatherresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"canconnecttogather": true,
"inconference": false,
}
]
</pre>

---------------------------------------------
<<< '''connecttogathertoconference'''

Запрос из CRM к oktell. Производит совместное переключение текущего онлайн-абонента и флеш-абонента в существующую конференцию.

<pre>
[
"connecttogathertoconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

---------------------------------------------
<<< '''buildconferencefromcommutation'''

Запрос из CRM к oktell. Производит преобразование текущей коммутации в конференцию с двумя участниками.

<pre>
[
"buildconferencefromcommutation",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

---------------------------------------------
<<< '''attachasghost'''

Запрос из CRM к Oktell. Производит подключение к указанному каналу/пользователю на прослушку/помощь.

<pre>
[
"attachasghost",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"ghostedid": "FE9D6B52-C267-4D39-AC9F-81A0F44713FF",
"ghostedlogin": "Петров"
}
]
</pre>

>>> '''attachasghostresult'''

Ответ из Oktell в CRM на запрос о подключении к каналу на прослушку.

<pre>
[
"attachasghostresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 0,
"error": 52703
}
]
</pre>
<pre>
//* ghostedid - ид пользователя или линии, к которому подцепляться для прослушки
//* ghostedlogin - логин пользователя, к которому подцепляться для прослушки
</pre>

---------------------------------------------
<<< '''getconferences'''

Запрос из CRM в Oktell на возврат текущих активных конференц-сессий.

<pre>
[
"getconferences",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''getconferencesresult'''

Ответ из Oktell в CRM со списком текущих активных конференц-сессий.

<pre>
[
"getconferencesresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferencelist": [
{
"id": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"room": 884,
"name": "Планерка",
"description": "",
"accessmode": 11,
"accessmodestr": "Free",
"isselector": true,
"record": true,
"creatorid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"creatorlogin": "Иванов",
"creatorname": "Иван Иванович Иванов",
"directorid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"directorlogin": "Петров",
"directorname": "Петр Петрович Петров",
"timestart": "2011-04-03 17:58:22",
"canvieweachother": true,
"everyonecaninvite": true,
"recordrights": 2,
"recordrightsstr": "Competitors",
"isghost": false,
"ghostmode": 11,
"ghostmodestr": "Monitor"
},
{...},
{...}
]
}
]
</pre>

---------------------------------------------
<<< '''getconferencecompetitors'''

Запрос из CRM в Oktell на возврат текущих участников указанной конференции.

<pre>
[
"getconferencecompetitors",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "F16D26E3-2A78-49C2-AFCE-815611A16E22"
}
]
</pre>

>>> '''getconferencecompetitorsresult'''

Ответ из Oktell в CRM со списком текущих участников указанной в запросе конференции.

<pre>
[
"getconferencecompetitorsresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "F16D26E3-2A78-49C2-AFCE-815611A16E22",
"competitorlist": [
{
"competitorid": "65AC0E98-64DE-41CF-B609-D00A4C8B07FD",
"chainid": "91687102-E19F-466C-A0BE-B6C3EEF83EE7",
"sessionid": "91687102-E19F-466C-A0BE-B6C3EEF83EE7",
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"username": "Петр Петрович Петров",
"lineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"linenumber": "17004",
"number": "472",
"intnumber": "472",
"extnumber": "",
"confstate": 11,
"confstatestr": "OnlineTalking",
"wanttalk": false,
"isdirector": true,
"iscreator": false,
"isghost": false,
"isghostmajor": false,
"islifebuoy": false
},
{...},
{...}
]
}
]
</pre>

---------------------------------------------
<<< '''getusersforconferenceinvitelist'''

Запрос из CRM в Oktell на возврат возможных участников конференции (учетных записей всех пользователей системы с указанием их состояний и присутствия в других конференциях).

<pre>
[
"getusersforconferenceinvitelist",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''getusersforconferenceinvitelistresult'''

Ответ из Oktell в CRM со списком учетных записей, доступных для приглашения в конференцию с их текущими состояниями и присутствием в других конференциях.

<pre>
[
"getusersforconferenceinvitelistresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"possiblecompetitorlist": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"username": "Петр Петрович Петров",
"groupid": "F72C315A-F9EA-471E-A679-D4BA4797DB51",
"groupname": "Руководство"
"userstate": 5,
"userstatestr": "usFullbusy",
"isredirect": false,
"islunch": false,
"inconference": true,
"conferenceid": "F16D26E3-2A78-49C2-AFCE-815611A16E22",
"confstate": 11,
"confstatestr": "OnlineTalking"
},
{...},
{...}
],
"result": 1
}
]
</pre>

---------------------------------------------
<<< '''createnewconference'''

Запрос из CRM в Oktell на создание новой конференции. Указывает параметры самой конференц-сессии, список участников для приглашения на старте.

<pre>
[
"createnewconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conference": {
"id": "17A3F9D2-040C-471B-A4F5-6A13BEB27667",
"room": 578
"name": "Совещание с заказчиком",
"description": "",
"accessmode": "free",
"isselector": true,
"record": true,
"recordrights": "selected",
"everyonecaninvite": true,
"canvieweachother": true
},
"competitors": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"lineid": "F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"intnumber": "472",
"extnumber": "89047289889",
"cantalk": true
},
{...},
{...}
],
"recordusers": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
},
{...},
{...}
]
}
]
</pre>
<pre>
//* conference:accessmode - free|shared|closed (свободный вход, вход по запросу, вход запрещен)
//* conference:recordrights - director|competitors|selected (только управляющий, все участники, избранные участники)
Определяет, кто может прослушивать запись конференции.
//* competitors - список автоматически приглашаемых участников. Допускается/следует указывать только один
параметр из набора {userid|userlogin, lineid, intnumber, extnumber}
//* список recordusers следует указывать, если conference:recordrights=selected.
</pre>

>>> '''createnewconferenceresult'''

Ответ из Oktell в CRM с результатом исполнения команды на создание конференции.

<pre>
[
"createnewconferenceresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 0,
"error": 1,
"errormsg": "alreadyexists",
}
]
</pre>

---------------------------------------------
<<< '''setupexistingconference'''

Запрос из CRM в Oktell от имени управляющего конференции на изменение параметров указанной конференции.

<pre>
[
"setupexistingconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conference": {
"id": "17A3F9D2-040C-471B-A4F5-6A13BEB27667",
"room": 578
"name": "Совещание с заказчиком",
"description": "",
"accessmode": "free",
"isselector": true,
"recordrights": "selected",
"everyonecaninvite": true,
"canvieweachother": true,
"ghostmode": "monitor"
},
"recordusers": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
},
{...},
{...}
]
}
]
</pre>

>>> '''setupexistingconferenceresult'''

Ответ из Oktell в CRM с результатом исполнения команды на изменение параметров конференции.

<pre>
[
"setupexistingconferenceresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 0,
"error": 1,
"errormsg": "notfound",
}
]
</pre>
<pre>
//* conference:accessmode - free|shared|closed
//* conference:recordrights - director|competitors|selected
//* conference:ghostmode - monitor|help|talk
//* список recordusers имеет смысл только когда conference:recordrights=selected.
</pre>

---------------------------------------------
<<< '''getconferenceinfo'''

Запрос из CRM в Oktell на возврат текущих параметров указанной конференции.

<pre>
[
"getconferenceinfo",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3"
}
]
</pre>

>>> '''getconferenceinforesult'''

Ответ из Oktell в CRM. Возвращает текущие настройки указанной в запросе конференции, текущих ее участников и их состояния.

<pre>
[
"getconferenceinforesult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"conference": {
"id": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"room": 884,
"name": "Планерка",
"description": "",
"accessmode": 11,
"accessmodestr": "Free",
"isselector": true,
"record": true,
"creatorid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"creatorlogin": "Иванов",
"creatorname": "Иван Иванович Иванов",
"directorid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"directorlogin": "Петров",
"directorname": "Петр Петрович Петров",
"timestart": "2011-04-03 17:58:22",
"canvieweachother": true,
"everyonecaninvite": true,
"recordrights": 2,
"recordrightsstr": "Competitors",
"isghost": false,
"ghostmode": 11,
"ghostmodestr": "Monitor"
},
"competitors": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"lineid": "F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"intnumber": "472",
"extnumber": "89047289889",
"cantalk": true
},
{...},
{...}
],
"recordusers": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
},
{...},
{...}
]
}
]
</pre>

---------------------------------------------
<<< '''stopconference'''

Запрос из CRM в Oktell от имени управляющего конференции на прекращение указанной конференции.

<pre>
[
"stopconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3"
}
]
</pre>

>>> '''stopconferenceresult'''

Ответ из Oktell в CRM с результатом выполнения запроса на прекращение указанной конференции.

<pre>
[
"stopconferenceresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 0,
"error": 1,
"errormsg": "accessdenied"
}
]
</pre>

---------------------------------------------
<<< '''confsetvoiceparams'''

Запрос из CRM в Oktell от имени управляющего конференции на изменение голосовых свойств канала указанного участника указанной конференции.

<pre>
[
"confsetvoiceparams",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"competitor": {
"competitorid": "249995A5-8A64-49CC-87CA-D797FCFB7782",
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"lineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"cantalk": true,
"canlisten": true,
"ghosthelp": false
}
}
]
</pre>
<pre>
//* competitor - указывает на одного участника конференции.
/ достаточно/следует указывать только один из набора определяющих участника идентификаторов
{competitorid, userid|userlogin, lineid}

//* competitor:cantalk - может ли говорить
//* competitor:canlisten - может ли слышать
//* competitor:ghosthelp - в режиме прослушки:помощи для одного из подслушиваемых каналов -
может ли слышать подключившегося супервизора
</pre>

>>> '''confsetvoiceparamsresult'''

Ответ из Oktell в CRM с результатом выполнения запроса на изменение голосовых свойств канала.

<pre>
[
"confsetvoiceparamsresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 0,
"error": 1,
"errormsg": "accessdenied"
}
]
</pre>

---------------------------------------------
<<< '''confsetwanttalk'''

Запрос из CRM в Oktell от имени простого бесправного участника селекторного совещания на взятие голоса (сообщение для управляющего).

<pre>
[
"confsetwanttalk",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"wanttalk": true
}
]
</pre>

>>> '''confsetwanttalkresult'''

Ответ из Oktell в CRM с результатом выполнения запроса на взятие голоса.

<pre>
[
"confsetwanttalkresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 1
}
]
</pre>

---------------------------------------------
<<< '''confsetghostmode'''

Запрос из CRM в Oktell от имени прослушивающего супервизора на изменение режима конференц-помощи.

<pre>
[
"confsetghostmode",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"ghostmode": "help",
}
]
</pre>
<pre>
//* ghostmode - monitor, help, conference (подслушивание, помощь, конференция)
</pre>

>>> '''confsetghostmoderesult'''

Ответ из Oktell в CRM с результатом выполнения запроса на изменение режима конференц-помощи.

<pre>
[
"confsetghostmoderesult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 1
}
]
</pre>

---------------------------------------------
<<< '''exitconference'''

Запрос из CRM в Oktell на вывод авторизованного пользователя из конференции. В канал подается отбой. Альтернативой является положение трубки на телефоне.

<pre>
[
"exitconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3"
}
]
</pre>

>>> '''exitconferenceresult'''

Ответ из Oktell в CRM с результатом выполнения запроса на выход из конференции.

<pre>
[
"exitconferenceresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 1
}
]
</pre>

---------------------------------------------
<<< '''confdisconnectcompetitor'''

Запрос из CRM в Oktell от имени управляющего конференцией на вывод из конференции указанного участника.

<pre>
[
"confdisconnectcompetitor",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"competitor": {
"competitorid": "249995A5-8A64-49CC-87CA-D797FCFB7782",
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"lineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
}
}
]
</pre>
<pre>
//* competitor - указывает на одного участника конференции.
/ достаточно/следует указывать только один из набора определяющих участника идентификаторов
{competitorid, userid|userlogin, lineid}
</pre>

>>> '''confdisconnectcompetitorresult'''

Ответ из Oktell в CRM с результатом выполнения запроса на вывод указанного в запросе участника.

<pre>
[
"confdisconnectcompetitorresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 1
}
]
</pre>

---------------------------------------------
<<< '''enterconference'''

Запрос из CRM в Oktell на вход в конференцию. При необходимости осуществляет запрос на вход у управляющего. Прерывание может производиться командой exitconference
<pre>
[
"enterconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3"
}
]
</pre>

>>> '''enterconferenceresult'''

Ответ из Oktell в CRM с результатом выполнения запроса на вход в конференцию.

<pre>
[
"enterconferenceresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 1
}
]
</pre>

---------------------------------------------
<<< '''confdisconnectcompetitor'''

Запрос-команда из CRM в Oktell от имени управляющего конференцией на разрешение/запрет входа в конференцию указанному участнику, ранее запросившему право входа.

<pre>
[
"confpermitdenyentrance",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"competitor": {
"competitorid": "249995A5-8A64-49CC-87CA-D797FCFB7782",
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"lineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"permit": true
}
}
]
</pre>
<pre>
//* competitor - указывает на одного участника конференции.
/ достаточно/следует указывать только один из набора определяющих участника идентификаторов
{competitorid, userid|userlogin, lineid}
</pre>

>>> '''confpermitdenyentranceresult'''

Ответ из Oktell в CRM с результатом выполнения запроса на разрешение/запрет входа в конференцию участнику.

<pre>
[
"confpermitdenyentranceresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 1
}
]
</pre>

---------------------------------------------
<<< '''invitetoconference'''

Запрос из CRM в Oktell от имени управляющего конференцией или любого другого участника на приглашение в конференцию стороннего абонента (пользователя, линию, абонента по внутреннему/внешнему номеру).

<pre>
[
"invitetoconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"competitors": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"lineid": "F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"intnumber": "472",
"extnumber": "89047289889",
"cantalk": true
},
{...},
{...}
]
}
]
</pre>
<pre>
//* competitors - список автоматически приглашаемых участников. Допускается/следует указывать только один
параметр из набора {userid|userlogin, lineid, intnumber, extnumber}
</pre>

>>> '''invitetoconference'''

Ответ из Oktell в CRM с результатом выполнения запроса на приглашение нового участника конференции.

<pre>
[
"invitetoconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 1
}
]
</pre>

====События из Oktell, касающиеся конференций====

---------------------------------------------
>>> '''conflistchanged'''

Событие из Oktell в CRM об изменении списка текущих активных конференций.

<pre>
[
"conflistchanged",
{
"qid": "2A6380B4-ADD4-4CD3-9A5C-9483A3B3723A",
"conferencelist": [
{
"id": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"room": 884,
"name": "Планерка",
"description": "",
"accessmode": 11,
"accessmodestr": "Free",
"isselector": true,
"record": true,
"creatorid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"creatorlogin": "Иванов",
"creatorname": "Иван Иванович Иванов",
"directorid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"directorlogin": "Петров",
"directorname": "Петр Петрович Петров",
"timestart": "2011-04-03 17:58:22",
"canvieweachother": true,
"everyonecaninvite": true,
"recordrights": 2,
"recordrightsstr": "Competitors",
"isghost": false,
"ghostmode": 11,
"ghostmodestr": "Monitor"
},
{...},
{...}
]
}
]
</pre>

---------------------------------------------
>>> '''"conf***"'''

Другие событие из Oktell в CRM об изменениях на сервере конференций. Общий список возможных событий приведен ниже.

<pre>
[
"conf***",
{
"qid": "2A6380B4-ADD4-4CD3-9A5C-9483A3B3723A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"eventinfo": {
***
}
}
]
</pre>
<pre>
//* conflistchanged,
//* confparamschanged,
//* confcompositionchanged,
//* confcompetitorstatechanged,
//* confentrancedenied,
//* confentrancepermitted,
//* confentrancerequest,
//* confnotifyinvite,
//* confpossiblecompetitorstatechanged
</pre>

====Состояния пользователей и линий====

-------------------------------------------------
>>> '''userstatechanged'''

Сообщение из Oktell в CRM о смене состояния пользователя в Oktell. Отправляется на имя пользователя, чье состояние сменилось. Отправляется как результат запроса на смену состояния или независимо.

<pre>
[
"userstatechanged",
{
"qid": "66F8D479-0234-47DF-B043-3A065FF464A7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"userstateid": 2,
"onredirect": true,
"onlunch": false,
"oncallcenter": false,
"onccmanual": false
}
]
</pre>

-------------------------------------------------
<<< '''setuserstate'''

Запрос из CRM к Oktell на смену состояния пользователя от его имени. При проведении изменений в ответ отправляется сообщение userstatechanged.

Для изменения только одного из параметров состояния можно остальные не указывать (например оставлять только oncallcenter).

<pre>
[
"setuserstate",
{
"qid": "2A45010A-8EEA-4876-90CB-F062459D4BE2",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"userstateid": 2,
"onredirect": false,
"onlunch": false,
"oncallcenter": false,
"onccmanual": false,
"lunchreasonid": 120,
"lunchreasonmsg": ""
}
]
</pre>
<pre>
//* lunchreasonid и lunchreasonmsg - расширение для будущей статистики, устанавливают причину перерыва.
id - если причина одна из стандартных. msg - если что-то уникальное юзер ввел.
userstateid:
1 - Готов
2 - Перерыв
3 - Отсутствует
5 - Занят
</pre>

-------------------------------------------------------------------
<<< '''getuserstate'''

Запрос из CRM в Oktell состояния указанного пользователя системы.

<pre>
[
"getuserstate",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''getuserstateresult'''

Ответ из Oktell в CRM с полным состоянием указанного в запросе пользователя системы.
<pre>
[
"getuserstateresult",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"userstate": 5,
"userstateid": 5,
"userstatestr": "usFullbusy",
"onredirect": true,
"onlunch": false,
"oncallcenter": false,
"onccmanual": false
}
]
</pre>

-------------------------------------------------------------------
<<< '''checkuserintask'''

Запрос из CRM в Oktell о присутствии указанного пользователя в задачах call-центра.

<pre>
[
"checkuserintask",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''checkuserintaskresult'''

Ответ из Oktell в CRM с ответом на запрос присутствия указанного в запросе пользователя в задачах колл-центра. Описание задачи в случае положительного ответа.

<pre>
[
"checkuserintaskresult",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"intask": true,
"task": {,
"id": "1D565B41-1D16-46DE-B2C5-CF55ED5279F0",
"name": "Исходящий обзвон",
"code": "af-2329",
"direction": "outgoing",
"contacttype": 0,
"contacttypestr": "Call",
"projectid": "E6ADBA0D-C9FF-40F2-96FF-6D2F455F9D5A"
}
}
]
</pre>

-------------------------------------------------------------------
<<< '''getmyuserinfo'''

Запрос из CRM в Oktell на получение информации о текущем авторизованном пользователе: имя, внутренний номер, номер и идентификатор линии.

<pre>
[
"getmyuserinfo",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''getmyuserinforesult'''

Ответ из Oktell в CRM с ответом на запрос информации о текущем авторизованном пользователе.

<pre>
[
"getmyuserinforesult",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"username": "Иванов Иван Иванович",
"mainpbxnumber": "471",
"hasline": 1,
"lineid": "267F8F36-4713-4B66-81BD-019512E56E7E",
"linenumber": "17374",
"isoperator": true
}
]
</pre>

-------------------------------------------------------------------
<<< '''getuserphoto'''

Запрос из CRM в Oktell о текущем изображении (аватарке) указанного пользователя. Можно указывать только логин (''photoownerlogin'') или только идентификатор (''photoownerid'') интересующего пользователя.

<pre>
[
"getuserphoto",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"photoownerlogin": "Петров",
"photoownerid": "3F140170-AEEF-4621-AF9D-247116AE1411"
"mode": "link"
}
]
</pre>
<pre>
//* mode - link, page, data. По умолчанию page.
link - вернуть абсолютную ссылку на скачивание через http.
page - вернуть относительную ссылку на скачивание.
вернуть данные изображения в base64.
При формировании абсолютной ссылки в качестве доменного имени берется значение из
раздела [[Интеграция с WEB-Socket CRM]] общих настроек Oktell.
//* photoownerlogin, photoownerid - логин и/или идентификатор пользователя, чья аватарка требуется
Может не указываться, тогда будет возвращена аватарка авторизованного пользователя.
</pre>

>>> '''getuserphotoresult'''

Ответ из Oktell в CRM с ответом на запрос информации о текущем авторизованном пользователе.

<pre>
[
"getuserphotoresult",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"link": "http://..."
"link32": "http://..."
"link96": "http://..."
}
}
]
</pre>
<pre>
//* result. В случае отсутствия файла или по любой другой причине неудачи описание неудачи
будет находиться в поле errormsg. Например "File not found".
//* imagedatab64. В случае возврата целиком изображения, оно будет в base64 строке содержаться в поле.
//* link, link32, link96. В случае возврата ссылки на изображение в полях лежат соответственно
ссылки на полное изображение, 32х32- и 96x96- пиксельные образы.
</pre>

-------------------------------------------------------------------
<<< '''getalluserphotolink'''

Запрос из CRM в Oktell на получение ссылок на текущие изображения (аватарки) всех пользователей системы.

<pre>
[
"getalluserphotolink",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"mode": "link"
}
]
</pre>
<pre>
//* mode - link, page. По умолчанию page.
link - вернуть абсолютную ссылку на скачивание через http.
page - вернуть относительную ссылку на скачивание.
При формировании абсолютной ссылки в качестве доменного имени берется значение из
раздела [[Интеграция с WEB-Socket CRM]] общих настроек Oktell.
</pre>

>>> '''getalluserphotolinkresult'''

Ответ из Oktell в CRM с ответом на запрос ссылкок на текущие изображения (аватарки) всех пользователей системы.

<pre>
[
"getalluserphotolinkresult",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"links": [
{
"userid": "C6036E73-FB90-4F0C-B780-81CE5659BFEA",
"userlogin": "Сидоров",
"link": "http://...",
"link32x32": "http://...",
"link96x96": "http://...",
},
...
]
}
]
</pre>
<pre>
//* result. Если в наборе есть хотя бы одна аватарка, будет содержать 1. Иначе 0.
//* links. Содержит набор пользовательских словарей, в каждом из которых идентификатор,
логин и набор ссылок link, link32, link96. В полях лежат соответственно
ссылки на полное изображение, 32х32- и 96x96- пиксельные образы.
</pre>

-------------------------------------------------------------------
<<< '''setmyuserphoto'''

Запрос из CRM в Oktell на установку нового изображения (аватарки) текущего пользователя.

<pre>
[
"setmyuserphoto",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"filepath": "",
"imagedatab64": "",
"filename": ""
}
]
</pre>
<pre>
//* filepath - если файл уже на сервере где-то, то это путь к нему -
относительный рабочего каталога, относительный файлового хранилища, или абсолютный.
Допускается устанавливать в качестве аватарки изображения размером не более 1 MБ.
либо
//* imagedatab64 и filename - если файл целиком прокачивается через веб-сокет, то тут base64 строка
с образом файла.

//* если не указано ни filepath, ни imagedatab64, ни filename - стирает текущую аватарку.
</pre>

>>> '''setmyuserphotoresult'''

Ответ из Oktell в CRM с ответом на запрос информации о текущем авторизованном пользователе.

<pre>
[
"setmyuserphotoresult",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1
}
}
]
</pre>
<pre>
//* result. В случае отсутствия файла или по любой другой причине неудачи описание неудачи
будет находиться в поле errormsg. Например "File not found".
</pre>

-------------------------------------------------------------------
<<< '''changepassword'''

Запрос из CRM в Oktell на изменение пароля текущего авторизованного пользователя.
В версиях 2.7 пароль в нижнем регистре, в версиях 2.8 пароль без изменения регистра.

<pre>
[
"changepassword",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"newpwdmd5": "",
"oldpwdmd5": ""
}
]
</pre>
<pre>
//* oldpwdmd5 - MD5 текущего пароля.
//* newpwdmd5 - MD5 нового пароля.
</pre>

>>> '''changepasswordresult'''

Ответ от Oktell в CRM о результате изменения пароля.

<pre>
[
"changepasswordresult",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 0,
"errormsg": "password should be md5 string"
}
]
</pre>

-------------------------------------------------------------------
<<< '''getcurrentlinestate'''

Запрос из CRM в Oktell состояния телефонной линии указанного пользователя.

<pre>
[
"getcurrentlinestate",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''getcurrentlinestateresult'''

Ответ из Oktell в CRM с полным состоянием телефонной линии указанного в запросе пользователя системы.
<pre>
[
"getcurrentlinestateresult",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"hasline": true,
"lineid": "866692FC-DA08-459D-BAA1-428F9BA6A0D1",
"linenumber": "17012",
"linetype": 5,
"linetypestr": "ltIntIP",
"linestate": 32,
"linestatestr": "lsCommutated"
}
]
</pre>

-------------------------------------------------------------------
<<< '''getcurrentqueue'''

Запрос из CRM в Oktell состояния очереди указанного пользователя.

<pre>
[
"getcurrentqueue",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''getcurrentqueueresult'''

Ответ из Oktell в CRM с состоянием очереди указанного в запросе пользователя системы.
<pre>
[
"getcurrentqueueresult",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"queue": [
{
"objectid": "723114EE-2ABF-4806-9BC6-FBB532C31B44",
"objecttype": 0,
"objecttypestr": "qotQueueLogic",
"queuesource": 1,
"queuesourcestr": "qsLineLogic",
"queuepriority": 9,
"srcelementid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"srclineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"srclinenumber": "17004",
"startqueuetime": "2011-04-05 15:02:28",
"lenqueue": 72,
"managedlineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"managedlinenumber": "17004",
"callerid": "472",
"calledid": "479",
"isuser": true,
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"username": "Петр Петрович Петров",
"department": "Руководство",
"chainid": "02B99AD3-C954-4FD3-B07D-DFEDD83C0BF5",
"istask": true,
"taskid": "95575C37-5FDE-412C-8F42-36D55B1EC6BB",
"taskname": "Входящая кампания",
"taskdirection": "incoming",
"tasklistid": "7D9A3E9C-0AD3-4C68-BC02-4EBFE3684507",
"tasklistinfo": [
{
"key": "Название организации",
"value": "ООО МДГХ"
},
{...},
{...}
]
},
{...},
{...}
]
}
]
</pre>

-------------------------------------------------------------------
<<< '''getcallingoutabonentinfo'''

Запрос из CRM в Oktell на возврат информации об абоненте, которому осуществляется исходящий вызов от имени указанного пользователя.

<pre>
[
"getcallingoutabonentinfo",
{
"qid": "AF4B98AA-51D8-4944-B10C-04B0DE1E1BBC",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''getcallingoutabonentinforesult'''

Ответ из Oktell в CRM. Возвращает информацию об абоненте, которому осуществляется исходящий вызов от имени указанного в запросе пользователя.

<pre>
[
"getcallingoutabonentinforesult",
{
"qid": "AF4B98AA-51D8-4944-B10C-04B0DE1E1BBC",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "19ADB2C3-A0B5-47AB-AB2C-CBE15CF98968",
"number": "89032728973",
"name": "",
"lineid": "98F670D2-20E2-4883-B45E-42CDE1F3365F",
"linenumber": "13005"
}
]
</pre>

-------------------------------------------------------------------
<<< '''getflashedabonentinfo'''

Запрос из CRM в Oktell на возврат информации об абоненте, находящемся на удержании.

<pre>
[
"getflashedabonentinfo",
{
"qid": "DC35D182-8BAB-4DE4-919C-5F79090D92DE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''getflashedabonentinforesult'''

Ответ из Oktell в CRM. Возвращает информацию об абоненте, находящемся на удержании

<pre>
[
"getflashedabonentinforesult",
{
"qid": "DC35D182-8BAB-4DE4-919C-5F79090D92DE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"containsflashed": 1,
"abonent": {
"chainid": "19ADB2C3-A0B5-47AB-AB2C-CBE15CF98968",
"isconference": 0,
"conferenceid": "0D2A4CA1-FF17-473B-A5E9-E035CB16E257",
"conferenceroom": "#124",
"conferencename": "Планерка",
"conferencedescription": "",
"name": "",
"comment": "",
"description": "",
"simplename": "",
"number": "89032728973",
"lineid": "98F670D2-20E2-4883-B45E-42CDE1F3365F",
"linenumber": "13005",
"userid": "",
"userlogin": "",
"username": ""
}
}
]
</pre>

-------------------------------------------------------------------
<<< '''getextendedlineinfo'''

Запрос из CRM в Oktell на возврат расширенной информации о текущей линии и ее оппозитных абонентах: текущее состояние, информация об абоненте в коммутации, информация об абоненте на удержании.

<pre>
[
"getextendedlineinfo",
{
"qid": "55D54351-651E-4EC2-8E48-1D5136811FB9",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''getextendedlineinforesult'''

Ответ из Oktell в CRM. Возвращает информацию о текущей линии и ее оппозитных абонентах

<pre>
[
"getextendedlineinforesult",
{
"qid": "55D54351-651E-4EC2-8E48-1D5136811FB9",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"linestateid": 5,
"linestatestr": "lsCommutated,
"chainid": "19ADB2C3-A0B5-47AB-AB2C-CBE15CF98968",
"datetimeformat" = "dd.MM.yyyy HH:mm:ss",
"activetimestart" = "01.12.2011 16:59:28",
"abonent": {
"isconference": false,
"conferenceid": "0D2A4CA1-FF17-473B-A5E9-E035CB16E257",
"conferenceroom": "#124",
"conferencename": "Планерка",
"conferencedescription": "",
"iscommutated": false,
"iswaitingfaxline": false,
"iswaitinginflash": false,
"iswaitingforanswer": false,
"number": "",
"name": "",
"description": "",
"userid": "",
"userlogin": "",
"username": "",
"comment": "",
"simplename": "",
"lineid": "",
"linenumber": "",
"isextline": false,
"iswaitingforanswer": false,
"extnumber": "",
"queuesourceid": 1,
"queuesourcestr": "",
"isivr": false,
"ivrname": "",
"isroutingivr": false,
"ismediaivr": false,
"isrestartivr": false,
"isautocall": false,
"number": "",
"isringing": false,
"ringtimesec": 172,
"isconference": false,
"conferenceid": "",
"conferencename": "",
"conferenceroom": "",
"conferencedescription": "",
"inviteruserid": "",
"inviterusername": "",
"inviteruserlogin": "",
"number": "",
"name": "",
"comment": "",
"description": "",
"direction": "",
"isextline": true,
"istask": false,
"taskid": "",
"taskname": "",
"userid": "",
"userlogin": "",
"username": "",
"lineid": "",
"linenumber": ""
}
"isflashing": true,
"flashed": {
"isconference": true,
"conferenceid": "0D2A4CA1-FF17-473B-A5E9-E035CB16E257",
"conferenceroom": "#124",
"conferencename": "Планерка",
"conferencedescription": "",
"number": "",
"name": "",
"description": "",
"userid": "",
"userlogin": "",
"username": "",
"comment": "",
"simplename": "",
"lineid": "",
"linenumber": "",
"isextline": false
}
}
]
</pre>
<pre>
//* С отступом в примере указаны поля, появляющиеся в случае, если базовое булево поле имеет значение true.
// Например, если isringing=true, то указанные с отступом поля будут присутствовать и представлять собой
// информацию об абоненте, осуществляющем вызов текущего канала.
</pre>

====Управление переадресацией====

-------------------------------------------------------------------
<<< '''getredirectrules'''

Запрос из CRM в Oktell на возврат списка правил переадресации для текущего пользователя с их настройками.

<pre>
[
"getredirectrules",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''getredirectrulesresult'''

Ответ из Oktell в CRM. Возвращает список правил переадресации для текущего пользователя с их настройками.

<pre>
[
"getredirectrulesresult",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"redirectrules": [
{
"id": "5FD3120D-E86B-4F4B-B57C-AC32343CD00F",
"caption": "Постоянное",
"description": "Действует всегда, когда я в состоянии переадресации",
"priority": 1,
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"isenabled": true,
"allowcascade": true,
"state": 2,
"statestr": "Active",
"destinationnumber": "89050213951",
"onlyforredirectstate": true,
"definesources": true,
"sources": [
{
"type": 0,
"typestr": "ExtNumber",
"description": "",
"srcnumber": "4959741589",
"srcid": ""
},
...
],
"defineschedule": true,
"tformat": "HH:mm:ss",
"schedule": [
{
"weekday": 0,
"weekdaystr": "Sunday",
"tstart": "00:00:00",
"tstop": "23:59:59",
},
...
]
},
...
]
}
]
</pre>
<pre>
//* state: disabled=0, enabled=1, active=2
//* defineschedule - если false, значит активно всегда
//* definesources - если false, значит для всех номеров
//* sourcetype - extnumber=0, user=1, client=3, clientgroup=4.
Если номер - то указывается scrnumber, иначе srcid
</pre>

-------------------------------------------------------------------
<<< '''saveredirectrules'''

Запрос из CRM в Oktell. Сохраняет новое/измененное правило переадресации для текущего пользователя.

<pre>
[
"saveredirectrules",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"redirectrules": [
{
"id": "5FD3120D-E86B-4F4B-B57C-AC32343CD00F",
"caption": "Постоянное",
"description": "Действует всегда, когда я в состоянии переадресации",
"priority": 1,
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"isenabled": true,
"allowcascade": true,
"destinationnumber": "89050213951",
"onlyforredirectstate": true,
"definesources": true,
"sources": [
{
"type": 0,
"typestr": "ExtNumber",
"description": "",
"srcnumber": "4959741589",
"srcid": ""
},
...
],
"defineschedule": true,
"tformat": "HH:mm:ss",
"schedule": [
{
"weekday": 0,
"weekdaystr": "Sunday",
"tstart": "00:00:00",
"tstop": "23:59:59",
},
...
]
},
...
]
}
]
</pre>
<pre>
//* state: disabled=0, enabled=1, active=2
//* defineschedule - если false, значит активно всегда
//* definesources - если false, значит для всех номеров
//* sourcetype - extnumber=0, user=1, client=3, clientgroup=4. Если номер - то указывается scrnumber, иначе srcid
</pre>

>>> '''saveredirectrulesresult'''

Ответ из Oktell в CRM. Возвращает список правил переадресации для текущего пользователя с их настройками.

<pre>
[
"saveredirectrulesresult",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1
}
]
</pre>

-------------------------------------------------------------------
<<< '''deleteredirectrules'''

Запрос из CRM в Oktell. Удаляет указанные правила переадресации для текущего пользователя.

<pre>
[
"deleteredirectrules",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
"ids": [
"5FD3120D-E86B-4F4B-B57C-AC32343CD00F",
...
]
}
]
</pre>

>>> '''deleteredirectrulesresult'''

Ответ из Oktell в CRM. Ничего не возвращает, кроме факта выполнения запроса на удаление правил переадресации.

<pre>
[
"deleteredirectrulesresult",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

-------------------------------------------------------------------
<<< '''setredirectruleenabled'''

Запрос из CRM в Oktell. Включает/выключает указанные правила переадресации.

<pre>
[
"setredirectruleenabled",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
"id": "5FD3120D-E86B-4F4B-B57C-AC32343CD00F",
"enabled": true
}
]
</pre>

>>> '''setredirectruleenabledresult'''

Ответ из Oktell в CRM. Ничего не возвращает, кроме факта выполнения запроса на включение/выключения указанных правил переадресации.

<pre>
[
"setredirectruleenabledresult",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

====Контент звонка====

-------------------------------------------------------------------
<<< '''getchaincontent'''

Запрос из CRM в Oktell на возврат контента текущей сессии, в которой участвует линия указанного пользователя. Кто инициировал звонок, когда, с кем коммутировался, кто переключал, куда, на кого, когда, были ли комментарии какие-то установлены в контент...

<pre>
[
"getchaincontent",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''getchaincontentresult'''

Ответ из Oktell в CRM с контентом текущей сессии указанного в запросе пользователя.
<pre>
[
"getchaincontentresult",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "19ADB2C3-A0B5-47AB-AB2C-CBE15CF98968",
"result": 1,
"content": {
"chainid": "19ADB2C3-A0B5-47AB-AB2C-CBE15CF98968",
"createtime": "2011-04-06 20:38:41",
"customfield": "трололололо",
"trace": [
{
"contentelementtype": "call",
"pbxdirection": "internal",
"objectid": "723114EE-2ABF-4806-9BC6-FBB532C31B44",
"objecttype": 0,
"objecttypestr": "qotQueueLogic",
"queuesource": 5,
"queuesourcestr": "qsIncomingTask",
"queuepriority": 7,
"srcelementid": "98F670D2-20E2-4883-B45E-42CDE1F3365F",
"srclineid": "98F670D2-20E2-4883-B45E-42CDE1F3365F",
"srclinenumber": "13005",
"startqueuetime": "2011-04-06 20:38:41",
"managedlineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"managedlinenumber": "17004",
"callerid": "89048928835",
"calledid": "4959211586",
"isuser": false,
"department": "",
"istask": true,
"taskid": "95575C37-5FDE-412C-8F42-36D55B1EC6BB",
"taskname": "Входящая кампания",
"taskdirection": "incoming",
"tasklistid": "7D9A3E9C-0AD3-4C68-BC02-4EBFE3684507",
"tasklistinfo": [
{
"key": "Название организации",
"value": "ООО МДГХ"
}
]
},
{
"contentelementtype": "commutation",
"commutationid": "58D76504-DA2D-42C2-9016-1089A94DC1BF",
"timestart": "2011-04-06 20:40:01",
"timeanswer": "2011-04-06 20:40:04",
"connectiontype": 5,
"connectiontypestr": "ctOuterInner",
"isrecorded": true,
"customfield": "траляляляля",
"alineid": "98F670D2-20E2-4883-B45E-42CDE1F3365F",
"alinenumber": "13005",
"anumberdialed": "4959211586",
"aoutnumber": "89048928835",
"aisuser": false,
"atext": "ООО «СДЗЦ» (89048928835)",
"blineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"blinenumber": "17004",
"bnumberdialed": "",
"boutnumber": "472",
"bisuser": true,
"buserid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"buserlogin": "Петров",
"busername": "Петр Петрович Петров",
"btext": "Петр Петрович Петров",
"timestop": "2011-04-06 20:42:12",
"length": 128.32,
"stopside": "a",
"stopreason": 2,
"stopreasonstr": "scrAbonentHangOff"
},
{...},
{...}
]
}
}
]
</pre>
<pre>
* trace:contentelementtype:
</pre>

-------------------------------------------------------------------
<<< '''setchaincontentcustomfield'''

Запрос из CRM в Oktell на установку комментария в контент текущей сессии, в которой участвует канал указанного пользователя.

<pre>
[
"setchaincontentcustomfield",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"customfield": "фывафыдвлаожфыдлвао"
}
]
</pre>

>>> '''setchaincontentcustomfieldresult'''

Ответ из Oktell в CRM с результатом установки комментария в контент текущей сессии, в которой участвует канал указанного в запросе пользователя.

<pre>
[
"setchaincontentcustomfieldresult",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "19ADB2C3-A0B5-47AB-AB2C-CBE15CF98968",
"result": 1
}
]
</pre>

-------------------------------------------------------------------
<<< '''getchaincontentcustomfield'''

Запрос из CRM в Oktell на возврат комментария из контента текущей сессии, в которой участвует канал указанного пользователя.

<pre>
[
"getchaincontentcustomfield",
{
"qid": "AF4B98AA-51D8-4944-B10C-04B0DE1E1BBC",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''getchaincontentcustomfieldresult'''

Ответ из Oktell в CRM. Возвращает комментарий из контента текущей сессии, в которой участвует канал указанного в запросе пользователя.

<pre>
[
"getchaincontentcustomfieldresult",
{
"qid": "AF4B98AA-51D8-4944-B10C-04B0DE1E1BBC",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "19ADB2C3-A0B5-47AB-AB2C-CBE15CF98968",
"customfield": "фывафыдвлаожфыдлвао",
"result": 1
}
]
</pre>

====Журнал звонков====

-------------------------------------------------------------------
<<< '''getpbxcalljournal'''

Запрос из CRM в Oktell на возврат журнала звонков АТС по указанному фильтру в соответствии с правами пользователя.
В том числе ссылки на файлы записей разговоров.

<pre>
[
"getpbxcalljournal",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"filter": {
"idconn": "08708573-4AF9-45F2-83B7-B8A0DDEF52EC",
"idchain": "94B5B657-3009-45E0-9095-F5D7BA163EB2",
"datestart": "2011-04-07",
"datestop": "2011-04-07",
"timestart": "08:00:00",
"timestop": "20:00:00",
"connectiontype": "all",
"intnumber": "",
"outnumber": "89503222555",
"minduration": 1,
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin: "Петров"
"comment": "",
"showcallcenter": false,
"taskid": "00000000-0000-0000-0000-000000000000"
}
}
]
</pre>
<pre>
//* filter - фильтр для запроса. Все поля не являются обязательными.
По умолчанию возвращаются разговоры за текущий день с 8:00 до 17:00 без звонков call-центра
длительностью более 1 секунды, которые доступны авторизованному пользователю по правам контроля.
К фильтру могут быть применены:
idconn - идентификатор конкретно интересующей коммутации.
idchain - идентификатор конкретно интересующей цепочки коммутаций/сессии.
datestart - дата начала интересующего периода. Включительно.
datestop - дата окончания интересующего периода. Включительно.
timestart - время начала интересующего внутридневного интервала.
timestop - время окончания интересующего внутридневного интервала.
connectiontype - тип соединения (all, incoming, outgoing, internal, conference).
intnumber - интересующий внутренний номер.
outnumber - интересующий внешний номер.
minduration - минимальная длительность коммутации в секундах, может быть действительным значением.
userid - идентификатор интересующего пользователя.
userlogin - логин интересующего пользователя.
comment - строка включения в комментарии.
showcallcenter: true|false. Отображать ли коммутации call-центра.
taskid - идентификатор задачи в рамках call-центра, чьи звонки интересны.
</pre>

<<< '''getpbxcalljournalresult'''

Ответ от Oktell в CRM. Возвращает журнал звонков АТС по указанному фильтру в соответствии с правами пользователя.

<pre>
[
"getpbxcalljournalresult",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtformat": "dd.MM.yyyy HH:mm:ss",
"data": [
{
"commutationid": "044d56f9-7137-49b6-bacf-a10370a54df4",
"chainid": "672ec703-e77a-47b1-b698-cb8488352fc9",
"connectiontype": 10,
"connectiontypestr": "conference",
"dtstart": "2011-04-09 19:55:30",
"dtanswer": "2011-04-09 19:55:30",
"dtstop": "2011-04-09 19:55:33",
"length": 2,
"answerlength": 0,
"hascomment": false,
"isbetweenusers": true,
"fromcc": false,
"isconf": true,
"isrecorded": true,
"recordlink": "/download/rec/AQAAAAAQIKvNHczNCBEBAAAA",
"fileext": "wav",
"auserid": "AA3B3E14-2B44-4D08-8C62-3C616F9D27E3",
"auserlogin": "Крючков",
"alineid": "A117499D-23EA-4BF8-A6B9-F49580E9628C",
"alinenumber": "16001",
"aoutnumber": "Семен Егорович Крючков",
"anumberdialed": "",
"atext": "Семен Егорович Крючков",
"conferenceid": "224476F1-2E41-4C8F-BA85-6BEF0EBB5339",
"conferenceroom": "751",
"conferencename": "Автоконференция #751 09.04.11 19:55:30",
"conferencedirectorid": "AA3B3E14-2B44-4D08-8C62-3C616F9D27E3",
"conferencedirectorlogin": "Крючков",
"conferencedirectorname": "Семен Егорович Крючков",
"reasonstop": -1,
"stopside": "a"
},
{
"commutationid": "5F64DECF-194C-474B-8CA7-824E82A1C072",
"chainid": "22A01B17-064B-4E19-99BA-FED96680AF25",
"connectiontype": 5,
"connectiontypestr": "ctOuterInner",
"dtstart": "2011-04-09 19:57:24",
"dtanswer": "2011-04-09 19:57:24",
"dtstop": "2011-04-09 19:58:13",
"length": 49,
"answerlength": 0,
"hascomment": true,
"isbetweenusers": true,
"fromcc": false,
"isrecorded": true,
"recordlink": "/download/rec/AAAAAABwOltxHczNCGlCAACBPgAA",
"fileext": "mp3",
"isconf": false,
"auserid": "AA3B3E14-2B44-4D08-8C62-3C616F9D27E3",
"auserlogin": "Крючков",
"alineid": "A117499D-23EA-4BF8-A6B9-F49580E9628C",
"alinenumber": "16001",
"aoutnumber": "Семен Егорович Крючков",
"anumberdialed": "",
"atext": "Семен Егорович Крючков",
"buserid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"buserlogin": "Петров",
"blineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"blinenumber": "17004",
"boutnumber": "",
"bnumberdialed": "217",
"btext": "Петр Петрович Петров",
"reasonstop": -1,
"stopside": "b"
}
{...},
{...}
]
}
]
</pre>
<pre>
//* dtformat - формат представления даты/времени.
//* data - набор попавших в выдачу коммутаций/конференций. Каждая запись - в отдельном словаре.
commutationid - идентификатор коммутации.
chainid - идентификатор цепочки коммутаций/сессии.
connectiontype, connectiontypestr - Тип соединения:
ctInnerOuter = 1, //внутренняя линия с внешней линией
ctInnerIvr = 2, //внутренняя линия с IVR
ctInnerInner = 3, //внутренняя линия с внутренней линией
ctOuterIvr = 4, //внешняя линия с IVR
ctOuterInner = 5, //внешняя линия с внутренней линией линией
ctOuterOuter = 6, //внешняя линия с внешней линией
ctIvrOuter = 7, //IVR с внешней линией
ctIvrInner = 8, //IVR с внутренней линией
ctConference = 10,//Конференция
ctSelector = 11,//Селекторное совещание
dtstart - дата/время начала вызова перед осуществлением коммутации.
dtanswer - дата/время ответа и начала коммутации.
dtstop - дата/время окончания коммутации
length - длительность в секундах
answerlength - длительность ответа в секундах.
hascomment - true|false. Имеет ли данная коммутация комментарий.
isbetweenusers - true|false. Является ли текущая коммутация между пользователями системы.
fromcc - true|false. Произведена ли текущая коммутация в рамках работы call-центра.
isrecorded - true|false. Записана ли коммутация.
recordlink - относительная ссылка на скачивание файла записи разговора.
fileext - если файл записан, то его расширение mp3 или wav. Возвращает только если в полном
результате менее 5 записей, иначе поле отсутствует.
isconf - true|false. Является ли текущая запись конференцией.
auserid - идентификатор пользователя абонента a.
Если IVR - 'ab000000-0000-0000-0000-000000000000',
Если внешний абонент - 'bf000000-0000-0000-0000-000000000000'
auserlogin - логин пользователя абонента a.
alineid - идентификатор линии абонента a.
alinenumber - номер линии абонента a.
aoutnumber - номер абонента a (CallerId).
anumberdialed - набранный абонентом a номер.
atext - текстовое описание абонента a.
buserid - идентификатор пользователя абонента b.
Если IVR - 'ab000000-0000-0000-0000-000000000000',
Если внешний абонент - 'bf000000-0000-0000-0000-000000000000'
buserlogin - логин пользователя абонента b.
blineid - идентификатор линии абонента b.
blinenumber - номер линии абонента b.
boutnumber - номер абонента b (CallerId).
bnumberdialed - набранный абонентом b номер.
btext - текстовое описание абонента b.
reasonstop - причина разрыва коммутации.
stopside - a, b. По чьей инициативе коммутация прервана.
</pre>

-------------------------------------------------------------------
<<< '''getpbxcallcomment'''

Запрос из CRM в Oktell на возврат комментария к указанной коммутации.

<pre>
[
"getpbxcallcomment",
{
"qid": "1E3C27C0-BE28-4621-AD39-6D1B31EB37EB",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"commutationid": "73567FD4-EFB9-46BF-9346-35B8638FE644"
}
]
</pre>

<<< '''getpbxcallcommentresult'''

Ответ от Oktell в CRM. Возвращает комментарий к запрошенной коммутации.

<pre>
[
"getpbxcallcommentresult",
{
"qid": "1E3C27C0-BE28-4621-AD39-6D1B31EB37EB",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"commutationid": "73567FD4-EFB9-46BF-9346-35B8638FE644",
"comment": "раз два три четыре пять вышел зайчик погулять"
}
]
</pre>

-------------------------------------------------------------------
<<< '''setpbxcallcomment'''

Запрос из CRM в Oktell на установку комментария для указанной коммутации.

<pre>
[
"setpbxcallcomment",
{
"qid": "3AB79A11-24FB-4D10-B7FD-5FD1653A679D",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"commutationid": "73567FD4-EFB9-46BF-9346-35B8638FE644"
"comment": "раз два три четыре пять вышел зайчик погулять"
}
]
</pre>

<<< '''setpbxcallcommentresult'''

Ответ от Oktell в CRM. Возвращает результат установки комментария к коммутации.

<pre>
[
"setpbxcallcommentresult",
{
"qid": "3AB79A11-24FB-4D10-B7FD-5FD1653A679D",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1
}
]
</pre>

-------------------------------------------------------------------
<<< '''getpbxmycalljournal'''

Запрос из CRM в Oktell на возврат журнала собственных звонков авторизованного пользователя по указанному фильтру.
В том числе ссылки на файлы записей разговоров.

<pre>
[
"getpbxmycalljournal",
{
"qid": "F95D0A08-D904-49C9-A4B9-8C02B1781A89",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"linkmode": "full",
"filter": {
"datestart": "2011-04-07",
"datestop": "2011-04-07",
"comment": "",
"number": "89503222555",
"media": "all",
"type": "all"
}
}
]
</pre>
<pre>
//* linkmode - full, simple - устанавливает формат ссылок, в котором будут указаны полученные файлы
в событии об окончании приема.
full - вернуть абсолютную ссылку на скачивание через http.
simple - вернуть относительную ссылку на скачивание.
При формировании абсолютной ссылки в качестве доменного имени берется значение из
раздела [[Интеграция с WEB-Socket CRM]] общих настроек Oktell.
//* filter - фильтр для запроса. Все поля не являются обязательными.
По умолчанию возвращаются разговоры за текущий день с 8:00 до 17:00, в которых
участвовал авторизованный пользователь
К фильтру могут быть применены:
datestart - дата начала интересующего периода. Включительно.
datestop - дата окончания интересующего периода. Включительно.
comment - строка включения в комментарии.
number - интересующий номер оппонента.
media - external, internal, all. Среда вызова.
type - тип звонка:
incoming - входящий звонок.
outcoming - исходящий звонок.
missed - пропущенный звонок. Что является пропущенным звонком определяется в разделе
[[Менеджер очередей]] общих настроек Oktell.
conference - конференция.
selector - селекторное совещание.
all - все типы звонков.
</pre>

<<< '''getpbxmycalljournalresult'''

Ответ от Oktell в CRM. Возвращает журнал собственных звонков авторизованного пользователя по указанному фильтру.

<pre>
[
"getpbxmycalljournalresult",
{
"qid": "F95D0A08-D904-49C9-A4B9-8C02B1781A89",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtformat": "dd.MM.yyyy HH:mm:ss",
"data": [
{
"type": 1,
"typestr": "incoming",
"media": 2,
"mediastr": "internal",
"commutationid": "73567FD4-EFB9-46BF-9346-35B8638FE644",
"chainid": "46fe0543-4a58-49c5-b501-644b8ddad69a",
"dtstart": "2011-04-09 19:55:25",
"dtanswer": "2011-04-09 19:55:27",
"dtstop": "2011-04-09 19:56:29",
"length": 61,
"number": "14",
"alineid": "3294CD8F-7865-436A-AC2E-CEA481D8F52D",
"alinenumber": "17011",
"blineid": "021BDECD-196B-408F-8C36-8C37C0A94C5A",
"blinenumber": "17014",
"isrecorded": true,
"recordlink": "http://192.168.0.12:4055/download/rec/AQAAAADQfMDNHczNCBEBAAAA",
"hascomment": true,
"abonentname": "Петр Петрович Петров",
"isconf": false
},
{
"type": 10,
"typestr": "conference",
"media": 10,
"mediastr": "conference",
"commutationid": "20CF9B5A-5FFE-4456-8984-E7B79D7166EE",
"chainid": "E443FEA7-5ABB-49CB-A28D-8CC25F404E97",
"dtstart": "2011-04-09 19:58:12",
"dtanswer": "2011-04-09 19:58:12",
"dtstop": "2011-04-09 19:59:45",
"length": 93,
"alineid": "3294CD8F-7865-436A-AC2E-CEA481D8F52D",
"alinenumber": "17011",
"isconf": true,
"conferenceid": "224476F1-2E41-4C8F-BA85-6BEF0EBB5339",
"conferenceroom": "751",
"conferencename": "Автоконференция #751 09.04.11 19:55:30",
"conferencedirectorid": "AA3B3E14-2B44-4D08-8C62-3C616F9D27E3",
"conferencedirectorlogin": "Крючков",
"conferencedirectorname": "Семен Егорович Крючков",
"isrecorded": true,
"recordlink": "http://192.168.0.12:4055/download/rec/AAAAAACQSBTLHczNCGlCAACBPgAA",
"hascomment": true
},
{...},
{...}
]
}
]
</pre>
<pre>
//* dtformat - формат представления даты/времени.
//* data - набор попавших в выдачу коммутаций/конференций. Каждая запись - в отдельном словаре.
type, typestr - тип звонка:
incoming = 1 - входящий звонок.
outcoming = 2 - исходящий звонок.
missed = 3 - пропущенный звонок. Что является пропущенным звонком определяется
в разделе [[Настройки менеджера очередей|Менеджер очередей]] общих настроек Oktell.
conference = 10 - конференция.
selector = 11 - селекторное совещание.
media, mediastr - тип среды вызова:
external = 2 - внешняя среда.
internal = 1 - внутренний вызов.
conference = 10 - конференция.
selector = 11 - селекторное совещание.
commutationid - идентификатор коммутации.
chainid - идентификатор цепочки коммутаций/сессии.
dtstart - дата/время начала вызова перед осуществлением коммутации.
dtanswer - дата/время ответа и начала коммутации.
dtstop - дата/время окончания коммутации
length - длительность в секундах
alineid - идентификатор линии абонента a.
alinenumber - номер линии абонента a.
blineid - идентификатор линии абонента b, если это коммутация.
blinenumber - номер линии абонента b, если это коммутация.
isrecorded - true|false. Записана ли коммутация.
recordlink - относительная или абсолютная ссылка на скачивание файла записи разговора.
hascomment - true|false. Имеет ли данная коммутация комментарий.
abonentname - текстовое описание оппозитного абонента коммутации.
isconf - true|false. Является ли текущая запись конференцией(селектором) или нет.
conferenceid - идентификатор конференции/селектора.
conferenceroom - номер комнаты конференции/селектора.
conferencename - название конференции/селектора.
conferencedirectorid - идентификатор управляющего пользователя конференции/селектора.
conferencedirectorlogin - логин управляющего пользователя конференции/селектора.
conferencedirectorname - имя управляющего пользователя конференции/селектора.
</pre>

-------------------------------------------------------------------
<<< '''removepbxcallrecord'''

Запрос из CRM в Oktell. Удаляет запись разговора указанной коммутации в соответствии с правами доступа.

<pre>
[
"removepbxcallrecord",
{
"qid": "DF061C5B-1B3B-41AA-94FF-A7A2F8FA6AE7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"commutationid": "73567FD4-EFB9-46BF-9346-35B8638FE644"
}
]
</pre>

<<< '''removepbxcallrecordresult'''

Ответ от Oktell в CRM. Возвращает результат удаления записи разговора.

<pre>
[
"removepbxcallrecordresult",
{
"qid": "DF061C5B-1B3B-41AA-94FF-A7A2F8FA6AE7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1
}
]
</pre>

-------------------------------------------------------------------
<<< '''getvoiceperc'''

Запрос из CRM в Oktell. Возвращает информацию о [[Управление_базами_данных#ComputeVoices|распределении владения разговором участниками коммутации]].

<pre>
[
"getvoiceperc",
{
"qid": "DF061C5B-1B3B-41AA-94FF-A7A2F8FA6AE7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"commutationid": "73567FD4-EFB9-46BF-9346-35B8638FE644"
}
]
</pre>

<<< '''getvoicepercresult'''

Ответ от Oktell в CRM. Возвращает результат.

<pre>
[
"getvoicepercresult",
{
"qid": "DF061C5B-1B3B-41AA-94FF-A7A2F8FA6AE7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"aperc": 12,
"bperc": 29,
"alinenum": "17e003",
"blinenum": "16e215"
}
]
</pre>

-------------------------------------------------------------------
<<< '''getvoicemap'''

Запрос из CRM в Oktell. Возвращает [[Управление_базами_данных#VoiceMap|детальную карту владения разговором участниками коммутации]].

<pre>
[
"getvoicemap",
{
"qid": "DF061C5B-1B3B-41AA-94FF-A7A2F8FA6AE7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"commutationid": "73567FD4-EFB9-46BF-9346-35B8638FE644"
}
]
</pre>

<<< '''getvoicepercresult'''

Ответ от Oktell в CRM. Возвращает результат.

<pre>
[
"getvoicemapresult",
{
"qid": "DF061C5B-1B3B-41AA-94FF-A7A2F8FA6AE7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"errormsg": "",
"abinbase64": [base64 от бинарки ("0100101101011110"-> byte[]-> base64)],
"bbinbase64": [base64 от бинарки ("0100101101011110"-> byte[]-> base64)],
"abinlen": 15,
"bbinlen": 15,
"alinenum": "17e003",
"blinenum": "16e215"
}
]
</pre>

====Номерной план====

-------------------------------------------------
>>> '''pbxnumberstatechanged'''

Сообщение из Oktell о смене состояния внутреннего номера (или группы внутренних номеров)

<pre>
[
"pbxnumberstatechanged",
{
"qid": "5B9508DF-565B-44E1-A122-6FEB70ADA0B9",
"numbers": [
{"num": "425", "numstateid": 3},
{"num": "427", "numstateid": 2},
{"num": "#82", "numstateid": 3}
]
}
]
</pre>

-------------------------------------------------------------------
<<< '''getusersbynumbers'''

Запрос из CRM в Oktell на возврат информации о пользователях системы по указанным внутренним номерам от имени указанного пользователя.

<pre>
[
"getusersbynumbers",
{
"qid": "20D0F23E-F26A-4BD9-BE65-B6F76D91880A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"numbers": [
"883",
"470",
"472",
"485"
]
}
]
</pre>

>>> '''getusersbynumbersresult'''

Ответ из Oktell в CRM. Возвращает информацию о пользователях, которые обнаруживаются системой при парсинге указанных в запросе внутренних номеров.

<pre>
[
"getusersbynumbersresult",
{
"qid": "20D0F23E-F26A-4BD9-BE65-B6F76D91880A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"users": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"username": "Петр Петрович Петров",
},
{
"userid": "2AC66E31-ADF0-4F84-A589-417A5A599EEA",
"userlogin": "Сидоров",
"username": "Сидор Сидорович Сидоров"
}
]
}
]
</pre>

-------------------------------------------------------------------
<<< '''getitemsbynumbers'''

Запрос из CRM в Oktell на возврат информации о пользователях и линиях системы по указанным внутренним номерам от имени указанного пользователя.

<pre>
[
"getitemsbynumbers",
{
"qid": "0A8B1B7C-E4DD-47FC-A17F-A9200602A8DE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"numbers": [
"883",
"470",
"472",
"485"
]
}
]
</pre>

>>> '''getitemsbynumbersresult'''

Ответ из Oktell в CRM. Возвращает информацию о пользователях и линиях, которые обнаруживаются системой при парсинге указанных в запросе внутренних номеров.

<pre>
[
"getitemsbynumbersresult",
{
"qid": "0A8B1B7C-E4DD-47FC-A17F-A9200602A8DE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"items": [
{
"type": "user",
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"username": "Петр Петрович Петров",
},
{
"type": "user",
"userid": "2AC66E31-ADF0-4F84-A589-417A5A599EEA",
"userlogin": "Сидоров",
"username": "Сидор Сидорович Сидоров"
},
{
"type": "line",
"lineid": "50203B8C-8079-4B52-8D24-ECDA4BF7877A",
"linenumber": "17025"
}
]
}
]
</pre>

-------------------------------------------------------------------
<<< '''getsystemnumberbyuser'''

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

<pre>
[
"getsystemnumberbyuser",
{
"qid": "0A8B1B7C-E4DD-47FC-A17F-A9200602A8DE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"user": {
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров"
}
}
]
</pre>

>>> '''getsystemnumberbyuserresult'''

Ответ из Oktell в CRM. Возвращает системный внутренний номер указанного в суб-параметре пользователя.

<pre>
[
"getsystemnumberbyuserresult",
{
"qid": "0A8B1B7C-E4DD-47FC-A17F-A9200602A8DE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"systemnumber": "U28CA980EF9F84B83B4934454AA54FCD8"
]
}
]
</pre>

-------------------------------------------------------------------
<<< '''getpbxnumbersforitem'''

Запрос из CRM в Oktell на возврат текстового списка внутренних номеров указанного в суб-параметре пользователя.

<pre>
[
"getpbxnumbersforitem",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
"itemtype": "user",
"itemuserid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"itemuserlogin: "Петров"
}
]
</pre>

>>> '''getpbxnumbersforitemresult'''

Ответ из Oktell в CRM. Возвращает список несистемных внутренних номеров через запятую, по которым возможен вызов пользователя, указанного в суб-параметре запроса.

<pre>
[
"getpbxnumbersforitemresult",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"itemtype": "user",
"itemuserid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"itemuserlogin: "Петров",
"itemnumbers": "403, 472"
}
]
</pre>
<pre>
/* "itemtype": "line",
/* "itemlineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
/* "itemlinenumber": "17004"
</pre>

-------------------------------------------------------------------
<<< '''getmainpbxnumberforitem'''

Запрос из CRM в Oktell на возврат основного несистемного внутреннего номера, по которому возможен вызов объекта системы (пользователя/линии), указанного в суб-параметре.

<pre>
[
"getmainpbxnumberforitem",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
"itemtype": "user",
"itemuserid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"itemuserlogin: "Петров"
}
]
</pre>

>>> '''getmainpbxnumberforitemresult'''

Ответ из Oktell в CRM. Возвращает основной несистемный внутренний номер, по которому возможен вызов объекта системы (пользователя/линии), указанного в суб-параметре запроса.

<pre>
[
"getmainpbxnumberforitemresult",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"itemtype": "user",
"itemuserid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"itemuserlogin: "Петров",
"itemnumber": "472"
}
]
</pre>
<pre>
/* "itemtype": "line",
/* "itemlineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
/* "itemlinenumber": "17004"
</pre>

-------------------------------------------------------------------
<<< '''getpbxnumbers'''

Запрос из CRM в Oktell на возврат всех внутренних номеров системы.
Не требует указания авторизованного пользователя, так как может исполняться по инициативе сервера WebCRM.
В примере приведен запрос для формирования ответа с перечнем номеров в простом виде.

<pre>
[
"getpbxnumbers",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"mode": "simple"
}
]
</pre>
<pre>
//* mode: simple, full (простой вид, полный вид).
</pre>

>>> '''getpbxnumbersresult'''

Ответ из Oktell в CRM. Возвращает список всех внутренних номеров системы.
В примере приведен ответ на запрос с перечнем номеров в простом виде.

<pre>
[
"getpbxnumbersresult",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"mode": "simple",
"numbers": [
"401",
"402",
"403",
"404",
"405",
"471",
"472",
"473"
]
}
]
</pre>

В следующем примере приведен ответ на запрос с перечнем номеров в полном виде со всеми описаниями и состояниями.

<pre>
[
"getpbxnumbersresult",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"mode": "full",
"numbers": [
{
"id": "9079E514-FECF-4DFD-BF48-5EDE4241E3A1",
"number": "472",
"type": 0,
"typestr": "intRule",
"isgroup": false,
"caption": "Петров",
"state": 5,
"statestr": "usFullbusy",
"department": "Руководство"
},
{...},
{...}
]
}
]
</pre>
<pre>
/* number:type - intRule(0), intFast(2), intIVR(3), intEmergency(4)
/* number:state - usDisconnected(0), usReady(1), usLunch(2), usOff(3), usFullbusy(5),
usReserved(6), usWOPhone(7), usError(100), usRinging(201)
</pre>

-------------------------------------------------------------------
<<< '''getallusernumbers'''

Запрос из CRM в Oktell на возврат списка всех пользователей, содержащего актуальную информацию по их прямым, основным и групповым номерам.

<pre>
[
"getallusernumbers",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"fillsubordinates": true
}
]
</pre>
<pre>
//* fillsubordinates: true|false. По умолчанию false.
Включать ли информацию о подчиненных (добавляет каждому пользователю поле "sub":true|false)
</pre>

>>> '''getallusernumbersresult'''

Ответ из Oktell в CRM. Возвращает список всех пользователей, содержащий актуальную информацию по их прямым, основным и групповым номерам.

<pre>
[
"getallusernumbersresult",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"users": [
{"id": "47A8B3A0-0B33-41BB-9D08-1D9EB0D6F09B",
"name: "Петров",
"sub": true,
"main: "14",
"nums": "14, 625, 773"
},
{"id": "5A84368D-5ED3-434B-8EB2-41AE86E1566A",
"name: "Иванов",
"sub": false
},
...
]
}
]
</pre>
<pre>
/* users:main - основной прямой номер,
/* users:nums - перечень номеров, в которых участвует пользователь или его текущая линия.
Порядок следования от главного к групповым, затем от главного к групповым с участием линии.
/* users:sub - является ли подчиненным пользователем (в соответствии с правами авторизованного пользователя)
Включается только если в запросе установлен флаг fillsubordinates.
</pre>

==== Управление задачами call-центра ====

-------------------------------------------------------------------
<div id="attachcalltotask"></div>
<<< '''cc_attachcalltotask'''

Запрос из CRM в Oktell на привязку текущего звонка пользователя к задаче.
Позволяет указать задачу ключом - идентификатор, название, код.
При необходимости звонок может быть привязан к конкретному абоненту из таблицы абонентов, прикрепленной к задаче (по его числовому идентификатору). В противном случае в таблицу добавляется новая строчка, даже если набираемый номер уже присутствовал в ней. Подробнее о прикреплении звонка к задаче в разделе [[Голосовые задачи#ManualCall|«Call-центр. Голосовые задачи»]].

<pre>
[
"cc_attachcalltotask",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"taskkey": "EDFE9A1F-E27E-4693-A427-A392C919F8B0",
"idinlist": 183
}
]
</pre>

>>> '''cc_attachcalltotaskresult'''

Ответ от Oktell в CRM. Возвращает результат привязки звонка к задаче, дополнительно сообщая номер абонента в списке. В случае неудачи содержит причину.

<pre>
[
"cc_attachcalltotaskresult",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"idinlist": 183,
"errormsg": ""
}
]
</pre>

-------------------------------------------------------------------
<div id="settaskactive"></div>
<<< '''cc_settaskactive'''

Запрос из CRM в Oktell на активацию/деактивацию задачи.
Позволяет указать задачу ключом - идентификатор, название или код. Тип задачи - ''call'' (по умолчанию) или ''text''.
Метод доступен с версии 2.8.130909.

<pre>
[
"cc_settaskactive",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"tasktype": "call",
"taskkey": "EDFE9A1F-E27E-4693-A427-A392C919F8B0",
"active": true
}
]
</pre>

>>> '''cc_settaskactiveresult'''

Ответ от Oktell в CRM. Возвращает результат активации/деактивации задачи.

<pre>
[
"cc_settaskactiveresult",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1
}
]
</pre>

-------------------------------------------------------------------
<div id="addoperatortotask"></div>
<<< '''cc_addoperatortotask'''

Запрос из CRM в Oktell на добавление оператора к задаче.
Операция доступна супервизорам задачи, а также самому оператору. Более глубокие фильтры необходимо организовывать на клиентской стороне.
Позволяет указать задачу ключом - идентификатор, название или код. Позволяет указать оператора ключом - идентификатор, логин, имя.
Метод доступен с версии 2.8.130909.

<pre>
[
"cc_addoperatortotask",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"taskkey": "EDFE9A1F-E27E-4693-A427-A392C919F8B0",
"operatorkey": "BD252256-08DE-4693-9A31-FC02B600E609"
}
]
</pre>

>>> '''cc_addoperatortotaskresult'''

Ответ от Oktell в CRM. Возвращает результат процедуры добавления оператора в задачу. Неудача возможна при невозможности обнаружить указанного оператора или указанную задачу, а также при отсутствии прав управления задачей.

<pre>
[
"cc_addoperatortotaskresult",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1
}
]
</pre>

-------------------------------------------------------------------
<div id="removeoperatorfromtask"></div>
<<< '''cc_removeoperatorfromtask'''

Запрос из CRM в Oktell на удаление оператора из задачи.
Операция доступна супервизорам задачи, а также самому оператору. Более глубокие фильтры необходимо организовывать на клиентской стороне.
Позволяет указать задачу ключом - идентификатор, название или код. Позволяет указать оператора ключом - идентификатор, логин, имя.
Метод доступен с версии 2.8.130909.

<pre>
[
"cc_removeoperatorfromtask",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"taskkey": "EDFE9A1F-E27E-4693-A427-A392C919F8B0",
"operatorkey": "BD252256-08DE-4693-9A31-FC02B600E609"
}
]
</pre>

>>> '''cc_removeoperatorfromtaskresult'''

Ответ от Oktell в CRM. Возвращает результат процедуры удаления оператора из задачи. Неудача возможна при невозможности обнаружить указанного оператора или указанную задачу, а также при отсутствии прав управления задачей.

<pre>
[
"cc_removeoperatorfromtaskresult",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1
}
]
</pre>

====Преобразования====

-------------------------------------------------------------------
<<< '''getuserbyline'''

Запрос из CRM в Oktell на возврат информации о связанном пользователе по ключу линии. Ключом линии традиционно является идентификатор или номер линии.

<pre>
[
"getuserbyline",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"linekey": "17002"
}
}
]
</pre>

>>> '''getuserbylineresult'''

Ответ из Oktell в CRM. Возвращает системный внутренний номер указанного в суб-параметре пользователя.

<pre>
[
"getuserbylineresult",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"founduser": {
"userid": "BE6A252A-D7E7-4D15-8D75-385A210DF997",
"userlogin": "john",
"username": "John Smith"
}
}
]
</pre>
<pre>
//* founduser - информация о связанном с указанной линии пользователе - его идентификатор, логин, имя.
Если линия указана неверно или к ней в данный момент не привязан пользователь - null.
</pre>

-------------------------------------------------------------------
<<< '''getlinebyuser'''

Запрос из CRM в Oktell на возврат информации о связанной линии по ключу пользователя. Ключом пользователя традиционно является идентификатор, логин или имя.

<pre>
[
"getlinebyuser",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"userkey": "ivanov"
}
}
]
</pre>

>>> '''getlinebyuserresult'''

Ответ из Oktell в CRM. Возвращает системный внутренний номер указанного в суб-параметре пользователя.

<pre>
[
"getlinebyuserresult",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"foundline": {
"lineid": "FA86E75A-6383-42B7-873C-37A0654B18EF",
"linenum": "17002"
}
}
]
</pre>
<pre>
//* foundline - информация о связанной с указанным авторизованным пользователем линии - ее идентификатор, номер.
Если пользователь указана неверно, или не авторизован - null.
''Пользователь по умолчанию'' считается авторизованным.
</pre>

====Служебные методы====

-------------------------------------------------------------------
<<< '''getversion'''

Запрос из CRM в Oktell на возврат информации о версии сервера Oktell.

<pre>
[
"getversion",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"showalloweddbstoredprocs": 1
}
]
</pre>
<pre>
//* showalloweddbstoredprocs: true|false. Отображать ли список доступных хранимых процедур БД.
</pre>

>>> '''getversionresult'''

Ответ из Oktell в CRM. Возвращает системный внутренний номер указанного в суб-параметре пользователя.

<pre>
[
"getversionresult",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"version": {
"text": "Версия программы: 2.7.110808(4237.32979). Версия БД: 110713.",
"dated": "110808",
"build": "2.7.4237.32979",
"datedhal": "110808",
"buildhal": "2.15.3.2871",
"webserverport": 80,
"webservertls": false
}
"alloweddbstoredprocs": {
"w_favoritegetbyuser": 1,
"w_favoritesavebyuser": 1,
"w_favoritedeletebyuser": 1,
"w_clientsget": 1,
"w_clientgroupsget": 1
}
}
]
</pre>
<pre>
//* version - информация о версии сервера логики и HAL.
//* version:webserverport - номер порта [[Серверный_HTTP_интерфейс|HTTP веб-сервера oktell]].
//* version:webservertls - true|false - защищенный ли канал на указанном порте (http или https).
//* alloweddbstoredprocs - перечень хранимых процедур, доступных для исполнения в БД Oktell
посредством метода ''execpredefineddbstoredproc''
</pre>

-------------------------------------------------------------------
<<< '''gettemphttppass'''

Запрос из CRM в Oktell. Генерирует и возвращает временный пароль на доступ к [[Веб-интерфейс|HTTP веб-серверу]] без авторизации.
Временный пароль живет не более 10 секунд до первого обращения к HTTP с указанием этого пароля среди параметров запроса.
Пароль привязывается к IP адресу дополнительно.
После этого вне зависимости от способа авторизации, установленного для HTTP веб-сервера Oktell, однократный вызов любого [[Серверный_HTTP_интерфейс|метода серверного веб-интерфейса]] возможен без авторизации с указанием среди параметров дополнительного служебного параметра ''temppass=A'', где A - выданный временный пароль.

Доступно для [[#Arch2|схемы интеграции 2]] и [[#Arch3|схемы интеграции 3]] в рамках индивидуальных подключений.

<pre>
[
"gettemphttppass",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"responsetowebsock": true
}
]
</pre>

>>> '''gettemphttppassresult'''

Ответ из Oktell в CRM. Возвращает системный внутренний номер указанного в суб-параметре пользователя.

<pre>
[
"gettemphttppassresult",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"password": "6f3200ac"
}
]
</pre>
<pre>
//* password - временный пароль для подстановки в качестве значения параметра temppass
при осуществлении GET или POST запроса к HTTP веб-серверу Oktell.
Следует иметь в виду, что даже в случае POST запроса со специальным контентом
указание параметра-пароля возможно в теле самой страницы (по аналогии с GET запросом).
</pre>

-------------------------------------------------------------------
<<< '''triggercustomevent'''

Запрос из CRM в Oktell на генерацию пользовательского произвольного события всем или только указанным пользователям.
Может быть использовано в [[#Arch2|схеме интеграции 2]] и [[#Arch3|схеме интеграции 3]] в рамках индивидуальных подключений.
Производит массовую рассылку указанного события. Точно также как и все остальные события требует подписки.

<pre>
[
"triggercustomevent",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"eventname": "newClientCategoryAdded",
"eventparam": "строка"
"sendback": 1, // отправлять мне самому или нет
}
]
</pre>
<pre>
[
"triggercustomevent",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"eventname": "newClientCategoryAdded",
"eventparam": "строка",
"recipients": [
"Петров",
"Сидоров"
]
}
]
</pre>
<pre>
[
"triggercustomevent",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"eventname": "newClientCategoryAdded",
"eventparam": { "param1": "123", "p2": { "asdfasd": "sdfgsdf" } , ... },
"recipients": [
"C45D4911-BDE2-40C0-8D11-A4AFF1F160CC",
"BA2C4BAC-7A7C-4959-B1A7-2F63C248DF3D"
]
}
]
</pre>
<pre>
//* recipients - список идентификаторов/логинов получателей сообщений.
Может не быть указанным, тогда отправка производится всем.
//* sendback - генерировать ли событие для самого отправителя. Имеет смысл, поскольку
в случае использования нескольких вкладок в браузере, каждое из подключений
получит событие независимо.
//* eventname - название пользовательского события.
//* eventparam - параметр пользовательского события. Переходит в сгенерированное сообщение без изменений.
Может содержать строку, набор, массив, словарь - все что угодно.
</pre>

>>> '''gettemphttppassresult'''

Событие из Oktell пользователям CRM. Отправляется всем пользователям, указанным при запросе на рассылку события.

<pre>
[
"customevent",
{
"qid":"aaa3f5c9-bcd5-4bf9-aef9-0b4ee735170d",
"userlogin": "Петров",
"userid": "C45D4911-BDE2-40C0-8D11-A4AFF1F160CC",
"eventname": "newClientCategoryAdded",
"triggereduserid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"triggereduserlogin": "Иванов",
"eventparam": { "param1": "123", "p2": { "asdfasd": "sdfgsdf" } , ... }
}
]
</pre>
<pre>
//* eventname - название пользовательского события.
//* eventparam - параметр пользовательского события в неизменном виде, как в запросе.
//* triggereduserid - идентификатор пользователя-рассыльщика.
//* triggereduserlogin - логин пользователя-рассыльщика.
</pre>

-------------------------------------------------------------------
<<< '''execpredefineddbstoredproc'''

Запрос из CRM в Oktell. Исполняет указанную хранимую процедуру в БД Oktell и возвращает данные всех сформированных в ходе выполнения наборов.
Доступные для исполнения процедуры содержатся в конфигурационном файле ''websocket.config'', а также могут быть возвращены методом ''getversion''.

Существует специальный параметр @authorizeduserid, значение которого перед исполнением заменяется на идентификатор авторизованного пользователя. Такие процедуры нельзя исполнять от имени CRM.

Не требует указания пользователя.

<pre>
[
"execpredefineddbstoredproc",
{
"qid": "7198D943-7BA9-443D-B283-55812BC82AFB",
"procedure": "T_GetFavorites",
"inputparams": {
"param1": "XXX",
"param2": 10
}
}
]
</pre>
<pre>
//* procedure - название процедуры из разрешенного списка.
//* inputparams - значения параметров процедуры. Имена параметров могут содержать в начале символ ''@'',
В случае его отсутствия он добавляется автоматически.
Если в списке присутствует параметр ''authorizeduserid'', его значение будет принудительно заменено
на идентификатор текущего авторизованного пользователя в Oktell. Этим можно пользоваться для
создания в БД процедур, учитывающих инициатора исполнения.
</pre>

>>> '''execpredefineddbstoredprocresult'''

Ответ из Oktell в CRM. Возвращает результат исполнения хранимой процедуры в БД Oktell. Перечисляет все выходные наборы данных.

<pre>
[
"execpredefineddbstoredprocresult",
{
"qid": "7198D943-7BA9-443D-B283-55812BC82AFB",
"result": 1,
"errorcode": 0,
"errorstr": "",
"dataset": [
[
["column1", "column2", "column3"],
["row1val1", "row1val2", "row1val3" ],
["row2val1", "row2val2", "row2val3" ],
...
],
[
["column1", "column2"]
],
...
]
}
]
</pre>
<pre>
//* result - 1 или 0. Успешно или неудачно проведена операция.
//* errorcode - код ошибки. 50044 - служебное значение, в случае запрета или исключения при исполнении,
не связанного с ошибкой SQL
//* errorstr - описание ошибки.
//* dataset - наборы данных по порядку выдачи в ходе исполнения хранимой процедуры.
Набор - это список строк, каждая из которых - список значений по ячейкам.
Первая строка в наборе - всегда содержит названия столбцов набора.
</pre>

-------------------------------------------------------------------
<<< '''execpluginmethod'''

Запрос из CRM в Oktell. Исполняет указанный метод в [[Встраиваемые_plugin-модули|серверном плагине]], передавая в него параметры и возвращая результат с выходными параметрами.

Не требует обязательного указания пользователя. Однако если вызов осуществляется в рамках подключения из браузера к серверу Oktell, то пользователь проставляется автоматически перед исполнением метода.

<pre>
[
"execpluginmethod",
{
"qid": "7198D943-7BA9-443D-B283-55812BC82AFB",
"pluginid": "44710EF2-9C5E-489E-B6CC-FD4ED34C13FE",
"formid": "44710EF2-9C5E-489E-B6CC-FD4ED34C13FE",
"inputparams": {
"param1": "...",
"param2": "...",
...
}
}
]
</pre>
<pre>
//* pluginid - идентификатор плагина.
//* formid - идентификатор одной из заявленных форм (методов) плагина.
//* inputparams - список значений для заявленных плагином входных параметров выбранной формы (метода).
В качестве значений параметров могут быть json структуры
(октелл осуществляет преобразование в строку самостоятельно).
</pre>

>>> '''execpluginmethodresult'''

Ответ из Oktell в CRM. Возвращает результат исполнения метода в серверном плагине.

<pre>
[
"execpluginmethodresult",
{
"qid": "7198D943-7BA9-443D-B283-55812BC82AFB",
"result": 1,
"error": 0,
"errormsg": "",
"outputparams": {
"outputdata": "...",
...
}
}
]
</pre>
<pre>
//* outputparams - список значений заявленных плагином выходных переменных выбранной формы (метода).
В качестве значений параметров могут быть json структуры.
</pre>

-------------------------------------------------------------------
<<< '''ping'''

Запрос из CRM в Oktell. Периодически пробивает канал связи, напоминая о жизнеспособности подключения. Требуется для [[#Arch2|Схемы интеграции 2]] и [[#Arch3|Схемы интеграции 3]] в рамках индивидуальных подключений. Для [[#Arch1|Схемы интеграции 1]] необязательно.

Не требует указания пользователя.

<pre>
[
"ping",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859"
}
]
</pre>

>>> '''pong'''

Ответ от Oktell в CRM на запрос ''ping''.

<pre>
[
"pong",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859"
}
]
</pre>

-------------------------------------------------------------------
<<< '''subscribeevent''',
'''unsubscribeevent'''

Запрос из CRM в Oktell. Производит соответственно подписку и отписку на указанные события.

Доступно и требуется только для [[#Arch2|схемы интеграции 2]] и [[#Arch3|схемы интеграции 3]] в рамках индивидуальных подключений.

В [[#Arch1|схеме интеграции 1]] события поступают в полном объеме, часть из них объединяются и отправляются на сервер WebCRM без привязки к пользователю; ожидается, что сервер WebCRM самостоятельно размножит их. К таким событиям относятся, например ''pbxnumberstatechanged'', ''conflistchanged'' и им подобные. Остальные же направляются с привязкой к пользователю и только в случае, когда пользователь авторизован из-под CRM.

<pre>
[
"subscribeevent",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859"
"eventmethod": "userstatechanged",
}
]
</pre>
<pre>
[
"subscribeevent",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859"
"eventmethod": [
"userstatechanged",
"pbxnumberstatechanged"
]
}
]
</pre>
<pre>
[
"unsubscribeevent",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859"
"eventmethod": "userstatechanged",
}
]
</pre>

События, требующие подписки:
:* pbxnumberstatechanged
:* pbxnumberlistmodified
:* shownotifymessage
:* voicemailreceived
:* usertextmessagereceived
:* usertextmessageviewed
:* chatcreated
:* chatnamechanged
:* chatmemberadded
:* chatmemberremoved
:* chatmessage
:* chatmessageviewed
:* chat (совокупность всех методов ''chat*'')
:* userstatechanged
:* linestatechanged
:* chainstatechanged
:* flashstatechanged
:* phoneevent_acmcallstarted
:* phoneevent_acmcallstopped
:* phoneevent_ringstarted
:* phoneevent_ringstopped
:* phoneevent_ivrstarted
:* phoneevent_ivrstopped
:* phoneevent_commstarted
:* phoneevent_commstopped
:* phoneevent_faxstarted
:* phoneevent_faxstopped
:* phoneevent_faxreceived
:* phoneevent (совокупность всех методов ''phoneevent_*'')
:* conferenceevent
:* conflistchanged
:* confparamschanged
:* confcompositionchanged
:* confcompetitorstatechanged
:* confentrancedenied
:* confentrancepermitted
:* confentrancerequest
:* confnotifyinvite
:* confpossiblecompetitorstatechanged
:* conference (совокупность всех методов ''conf*'')
:* dynamic (совокупность методов executemethod, cancelmethod, showform, closeform)
:* dynamicwaitabort (совокупность методов executemethodwaitaborted, showformwaitaborted)
:* dlgcard_showreserve
:* dlgcard_showconfirm
:* dlgcard_showformstop
:* dlgcard_showformdialog
:* dlgcard_closeall
:* dlgcard_closereserve
:* dlgcard_closeformreturnvalues
:* dlgcard_closeformreturncomment
:* dlgcard (совокупность методов dlgcard_*)
:* customevent

>>> '''subscribeeventresult''',
 '''unsubscribeeventresult'''

Ответ от Oktell в CRM на запросы ''subscribeeventresult'' и ''unsubscribeeventresult'' соответственно.

<pre>
[
"subscribeeventresult",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859"
"result": 1
}
]
</pre>

-------------------------------------------------------------------
<<< '''wp_setuserstate'''

Запрос на установку состояния указанному пользователю. Исполняется от имени сервера, даже если пользователь подключен с помощью другого подключения или из толстого клиента. Ответ не возвращается, в случае удачи отправляется событие ''userstatechanged''. Пользователь задается с помощью одного из ключей (wp - рабочее место, line - линия, user - пользователь).

<pre>
[
"wp_setuserstate",
{
"qid": "2A45010A-8EEA-4876-90CB-F062459D4BE2",
"wp": "...",
"line": "...",
"user": "...",
"userstateid": 2,
"onredirect": false,
"lunchreasonid": 120,
"lunchreasonmsg": ""
}
]
</pre>

-------------------------------------------------------------------
<<< '''wp_getuserstate'''

Запрос от сервера CRM на возврат состояния указанного пользователя. Исполняется от имени сервера, даже если пользователь подключен с помощью другого подключения или из толстого клиента. Пользователь задается с помощью одного из ключей (wp - рабочее место, line - линия, user - пользователь).

<pre>
[
"wp_getuserstate",
{
"qid": "2A45010A-8EEA-4876-90CB-F062459D4BE2",
"wp": "...",
"line": "...",
"user": "..."
}
]
</pre>

>>> '''wp_getuserstateresult'''

Ответ на запрос ''wp_getuserstateresult''.

<pre>
[
"wp_getuserstateresult",
{
"qid": "2A45010A-8EEA-4876-90CB-F062459D4BE2",
"wp": "...",
"line": "...",
"user": "...",
"found": true,
"userid": "BDB8519F-AE77-4E33-81DB-41EE8E7D4E33",
"stateid": 5,
"statestr": "usFullBusy",
"onredirect": false,
"onlunch": true,
"oncc": true,
"onccmanual": false
}
]
</pre>

-------------------------------------------------------------------
<<< '''getuserstates'''

Запрос от сервера CRM на получение состояний всех пользователей в системе вне зависимости от того, где они авторизованы и авторизованы ли вообще.

<pre>
[
"getuserstates",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F"
}
]
</pre>

>>> '''getalluserstatesresult'''

Ответ на запрос ''getuserstates''.

<pre>
[
"getalluserstatesresult",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"users":[
{
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"userstate": 5,
"userstateid": 5,
"userstatestr": "usFullbusy",
"onredirect": true,
"onlunch": false,
"oncallcenter": false,
"onccmanual": false
},
...
]
}
]
</pre>

-------------------------------------------------------------------
<<< '''closecallbychain'''

Запрос от сервера CRM на завершение коммутаций, принадлежащих указанной сессии (цепочке коммутаций). Исполняется от имени сервера, даже если пользователь подключен с помощью другого подключения или из толстого клиента

<pre>
[
"closecallbychain",
{
"qid": "2A45010A-8EEA-4876-90CB-F062459D4BE2",
"idchain": "A7623B51-41F5-42E6-A2AE-1063C52D010A"
}
]
</pre>

>>> '''closecallbychainresult'''

Ответ на запрос ''closecallbychain''.

<pre>
[
"closecallbychainresult",
{
"qid": "2A45010A-8EEA-4876-90CB-F062459D4BE2",
"found": true
}
]
</pre>

====Прочие====

Существует также [[Media:Others.zip|'''набор методов и событий''']] для рабочего места оператора и отображения диалоговых форм.
Их реализация осуществлена в web-клиенте Oktell и нетривиальна, поскольку требует от клиентского модуля четкого исполнения требований по логическому взаимодействию с менеджером задач сервера Oktell. В частности именно на клиентскую часть возлагается работа по решению вопроса о множественном отображении диалоговой формы и о предоставлении серверу данных по ее заполнению, кэширование метаданных диалоговых форм, подтверждения получения и исполнения запросов и т.д.

Запросы, команды и события от CRM к Oktell:
* cc_getcallstates (ответ cc_getcallstatesresult)
* cc_getuserresults (ответ cc_getuserresultsresult)
* cc_getlunchtypes (ответ cc_getlunchtypesresult)
* dlgcard_setsupported (ответ dlgcard_setsupportedresult)
* dlgcard_confirmgot
* dlgcard_confirmresult
* dlgcard_showformdone
* dlgcard_getmetadata (ответ dlgcard_getmetadataresult)
* dlgcard_getcachedvalues (ответ dlgcard_getcachedvaluesresult)
* dlgcard_setvaluesonclose
* dlgcard_setcontrolvalue
* dlgcard_setresultonnext
* dlgcard_setresultonstop
* dlgcard_setstopformresult

События из Oktell в CRM:
* dlgcard_showreserve
* dlgcard_showconfirm
* dlgcard_showformstop
* dlgcard_showformdialog
* dlgcard_closeall
* dlgcard_closereserve
* dlgcard_closeformreturnvalues
* dlgcard_closeformreturncomment

Файл:Others.zip

2023-09-21T10:09:42Z

Oktell Support:

Oktell Web-Socket Protocol

2023-09-21T09:45:28Z

Oktell Support: /* Состояния пользователей и линий */

[[Веб-интерфейс|Наверх]]

В рамках настоящей статьи рассматриваются вопросы интеграции web-системы и коммуникационной системы (в дальнейшем WebCRM и Oktell). WebCRM на рабочем месте сотрудника используется через браузер. Телефон, находящийся на рабочем месте сотрудника подключен к серверу (узлу коммутаций) Oktell. Решается задача функционального объединения двух системы с предоставлением возможности приема и совершения звонков и управления телефоном из интерфейсов WebCRM.

__TOC__

<div id="OktellFunc"></div>
===Краткое описание возможностей телефонии Oktell===

Стандартный функционал Oktell предоставляет пользователям:
:* доступ к управлению телефонами (позвонить, переключить, отклонить звонок, организовать конференцию, пригласить других участников в конференцию, подключиться к разговору в режиме прослушивания, помощи и т.д.).
:* доступ к управлению состояниями пользователей (перерыв - чтобы поток входящих звонков не поступал, занят - чтобы отметить факт обработки звонка, переадресация - чтобы все звонки на пользователя перенаправлялись в соответствии с настроенными правилами, готов - чтобы вернуться к обычному режиму).
:* информацию о текущем состоянии телефонов, внутренних номеров, пользователей с т.з. занятости в операциях телефонии.
:* информацию о поступающем звонке, абоненте
:* доступ к статистике разговоров (по правам).
:* доступ к записям разговоров (по правам).
:* доступ к информации об ожидающей очереди абонентов в реальном времени.
:* доступ к контентам сессий и линий.
:* доступ к управлению режимом переадресации.
:* возможность запуска служебных сценариев.
и т.д.

В рамках настройки сценариев Oktell, имеется возможность отправлять синхронные и асинхронные запросы в WebCRM (фактически исполнять методы по событиям в Oktell) и получать ответы и применять их в рамках проведения маршрутизации или любых других действий, реализуемых в сценариях. Например:
:* Выяснить, какому клиенту/контакту принадлежит определившийся номер телефона или введенный им вручную с помощью DTMF-набора номер договора, отфильтровать по черному списку, переключить вызов на ответственного за работу с этим контактом пользователя, если пользователя нет в системе - переключить на секретаря, а если контакт новый - соединить с отделом продаж. Если ответственный пользователь занят, предложить оставить голосовое сообщение для VIP клиентов.
:* В момент поступления звонка открыть карточку у пользователя, которому направляется звонок. Закрыть ее автоматически, если пользователь так и не снял трубку (а снял кто-то другой, или звонок потерялся).
:* Выполнить какое-то важное с т.з. WebCRM действие в случае, например, если пользователь оставил заказ на встречный звонок, занести его в список задач.

Именно сценарии придают жизнь Oktell и его сервисам.

Среди событий Oktell, отрабатываемых в сценариях:

:* поступление внешнего звонка.
:* завершение звонка.
:* переключение абонента на пользователя, группу пользователей, задачу call-центра.
:* любое из интересующих явлений в ходе обработки звонка (от преобразования номера абонента в нужный формат и сверки времени поступления звонка до обработки контента звонка после завершения и выявления там факта состоявшейся конференции).
:* наступление определенного времени.
:* периодический запуск по таймеру.
:* поступление/отправка e-mail.
:* поступление/отправка sms/icq/jabber.
:* контрольные события call-центра (оператор первым положил трубку, оператор слишком долго находится в перерыве или поствызывной обработке, число операторов в задаче меньше минимально допустимого, число абонентов в очереди задачи больше допустимого и т.д.)
:* ручной запуск сценария по инициативе пользователя или WebCRM.
:* исходящий звонок от пользователя
:* поступление голосовой почты
:* появление где-то в базе данных интересующего события (например появление новой записи в таблице абонентов)
:* появление где-то на веб-ресурсе интересующего события (например температура на улице опустилась ниже нуля)

<div id="Arch1"></div>
===Схема интеграции 1 (межсерверное соединение)===

[[Файл:Arch1.jpg|center]]

Сервер Oktell взаимодействует с телефонами и с веб-сервером WebCRM.

Веб-сервер WebCRM взаимодействует ответно с сервером Oktell и с браузерами (клиентами).

Между сервером Oktell и веб-сервером WebCRM существует только один [[#Exchange|канал для двустороннего обмена сообщениями]].

Установка соединения может производиться как сервером Oktell, так и веб-сервером WebCRM. В случае разрыва соединения сторона-инициатор вновь организует подключение.
# При выборе соединения со стороны сервера WebCRM в [[Интеграция_с_Web-Socket_CRM|настройках Web-Socket]] Oktell должен быть выбран один из режимов «CRM к Oktell» с указанием требуемого способа авторизации.
# При выборе соединения со стороны сервера Oktell должен быть выбран один из режимов «Oktell к CRM» с указанием [[#websockver|версии]] протокола Web-Socket.

После установки соединения системы обмениваются данными друг о друге, об авторизованных пользователях, о динамических методах.
Все авторизованные в WebCRM пользователи автоматически становятся авторизованными в Oktell. В дальнейшем авторизация подключающихся пользователей и вывод отключившихся осуществляется с помощью сообщений login и logoff.
Считается, что авторизацию пользователь проходит на веб-сервере WebCRM, и повторной проверки пароля в Oktell не требуется. Поэтому при организации сообщений login поле password не требует указания.

Любой запрос от клиента к Oktell отправляется на сервер WebCRM, где формируется интеграционное сообщение и перенаправляется на сервер Oktell.
Персональные сообщения/команды от Oktell клиенту также направляются на WebCRM, где они должны быть перенаправлены клиенту.
Общие сообщения/команды от Oktell направляются к серверу, где проводится их обработка.

Часть общих событий, например изменение состояния абонента в номерном плане, отправляется в WebCRM однократно и без привязки к конкретному пользователю, подразумевая тем самым, что веб-сервер WebCRM самостоятельно размножит сообщение и отправит всем заинтересованным клиентам.

В рамках такой интеграции WebCRM может предоставлять в Oktell некоторые общие сервисы, которые доступны администратору при настройке сценариев Oktell. Например, доступ к БД WebCRM на поиск маршрута для обработки звонка конкретного клиента. Подробнее в разделе [[#Dynamic|Динамическое взаимодействие]].

<div id="Arch2"></div>
===Схема интеграции 2 (клиент-серверное соединение)===

[[Файл:Arch2.jpg|center]]

Сервер Oktell взаимодействует с телефонами и с конечными клиентами (браузерами).

Веб-сервер CRM взаимодействует только с клиентами и БД.

Между Oktell и каждым клиентом существует один или несколько [[#Exchange|каналов для двустороннего обмена сообщениями]] (поддерживается работа в нескольких вкладках браузера).

В данном случае клиенты (браузеры) производят подключения к серверу Oktell, и в его настройках должен быть включен и настроен [[Настройки_веб-сервера|Web-сервер]], а в сообщениях [[#login|''login'']] должен быть указан пароль пользователя (MD5).

При таком способе интеграции у WebCRM не требуется наличие собственного Web-Socket сервера. Каждый клиент (браузер) подключается по Web-Socket протоколу непосредственно к серверу Oktell. Веб-сервер CRM занимается формированием страниц и предоставлением данных из БД WebCRM. Непосредственная взаимосвязь между серверами WebCRM и Oktell отсутствует, доступ не требуется, клиенты самостоятельно обрабатывают и объединяют данные двух систем.
По такому принципу реализованы [http://www.oktell.ru/weboktell Web-клиент Oktell] и плагин [http://js.oktell.ru/ Oktell.js], доступный для встраивания в другие проекты.

Поскольку клиентов может быть много, при рассылке событий возможна оптимизация за счет исключения тех клиентов, где конкретное событие не является необходимым. Достигается это путем подписки/отписки клиентов на определенные типы сообщений.

Применительно к этому способу интеграции существует ряд дополнительных методов интерфейса. Большинство таких методов доступно и при [[#Arch1|схеме интеграции 1]], но не являются там необходимыми, так как часть данных и работ проводится на веб-сервере WebCRM.

В отличие от [[#Arch1|схемы интеграции 1]], где Oktell запрашивает у сервера WebCRM список [[#Dynamic|динамических методов и форм]], которые затем могут быть использованы в сценариях Oktell, здесь динамические методы недоступны. Чтобы получить доступ к динамическим методам, следует использовать упрощенный вариант [[#Arch3|схемы интеграции 3]].

<div id="Arch3"></div>
===Схема интеграции 3 (межсерверное и клиент-серверное соединение)===

[[Файл:Arch_3.jpg|center]]

Является комбинацией [[#Arch1|схемы 1]] и [[#Arch2|схемы 2]]. То есть клиенты имеют возможность подключаться непосредственно к серверу Oktell, минуя websocket-сервер CRM, а связь с сервером происходит по специальному каналу, который может быть обеспечиваться как websocket-подключением, так и периодическими http подключениями.

В этом случае при разработке решений можно пользоваться javascript-библиотекой [http://js.oktell.ru Oktell.js], не требующей ни полного погружения в настоящий интеграционный протокол, ни в настройку websocket. Также в этом случае для CRM не обязательно иметь собственный websocket-сервер для обслуживания клиентов. Более того, можно вообще обойтись лишь настройкой HTTP для обмена сервисными сообщениями вроде [[#whoareyou|взаимных представлений]] и запроса [[#getavailablemethods|динамических методов]] и [[#getavailableforms|форм]]. Исполнение [[#Dynamic|динамических методов и форм]] будет возможно как на сервере, так и на клиентах. На сервере - по межсерверному каналу (http, https, websocket, websocket secure), на клиенте - по индивидуальным websocket-подключениям (защищенным или нет). Все остальные запросы и события имеют персональную подоплеку и отправляются по индивидуальным клиент-серверным подключениям.

При этом в случае websocket соединения между серверами Oktell и CRM остается возможность часть клиентов туннелировать через сервер CRM, а часть клиентов обслуживать непосредственно. В этом смысле это самый широкий способ интеграции, и два других выступают частными случаями.

<div id="UserPhone"></div>
===Привязка пользователя к телефону===

Решению подлежит задача сопоставления конкретных пользователей CRM с конкретными телефонными устройствами. Поскольку элементы управления устройством находятся в браузере, а влияют они на поведение конкретного телефона. Например, так выглядит простейшая задача перевода звонка из браузера на врача Михайлова: звонок должен поступить на телефон, находящийся в кабинете 103, за компьютером в котором сейчас сидит Михайлов (в браузере открыта WebCRM и авторизован Михайлов).
Настройка этого происходит в Oktell.

Пользователи могут работать:
:* стационарно каждый за своим рабочим местом.
:* перемещаться с одного рабочего место за другое.
:* работать посменно за одним рабочим местом.
(Рабочее место = компьютер + телефон)

Необходимо в каждый момент времени знать, около какого телефона какой пользователь сидит.

Существуют два подхода к решению, также возможны их комбинации в рамках одного сервера.

'''1. Жесткая привязка пользователя к телефонной учетной записи.'''

''Для этого в карте сети Oktell в свойствах телефона требуется указание пользователя WebCRM''

''Плюсы'': При взаимодействии Oktell и WebCRM используются одни и те же идентификаторы (например логины пользователей), соответственно отсутствует проблема привязки как таковая.

''Минусы'': Пользователь вынужден перемещаться с одного компьютера на другой вместе со своим телефоном, или переназначая учетную запись в телефонном аппарате.

'''2. Телефон привязывается к компьютеру, а в момент логина пользователя сопоставление производится через этот компьютер.'''

''Плюсы'': Кто бы ни залогинился с этого компьютера, приобретает управление рядом стоящим телефоном, все звонки пользователю попадают на этот телефон.

''Минусы'': Требует указания одного из постоянных идентификаторов компьютера в Oktell, а также передачи его из WebCRM/web-клиента в момент логина для привязки. Это может быть айпи адрес, хостнейм или любой другой постоянный идентификатор, задаваемый в конфигурации.

Синхронизация учетных записей Oktell и WebCRM может производиться по логинам (по умолчанию) или по GUID-идентификаторам. Соответственно в персональных запросах должны указываться userlogin и/или userid.

Логин в Oktell нужен для приведения состояния пользователя в готовность. Без этого звонки на пользователя не поступают, а обрабатываются как и в случае, когда он недоступен. Логофф - обратная операция. В ходе взаимодействия пользователю доступны команды управления своим состоянием. Он может отлучиться, выставить перерыв, переадресацию, занятость и т.д. Все это нужно для того, чтобы изменить направление маршрутизации звонков и режим работы call-центра. А в случае [[#Arch2|схемы интеграции 2]] и [[#Arch3|схемы интеграции 3]] также для авторизации. Индивидуальное подключение не обрабатывает никакие запросы, не осуществив авторизацию.

ВНИМАНИЕ! Ограничение: Oktell не позволяет пользователям авторизовываться с разных рабочих мест одновременно. Делается это для того, чтобы каждому пользователю соответствовало не более одного телефона.
Однако персональные соединения [[#Arch2|схемы интеграции 2]] и [[#Arch3|схемы интеграции 3]] могут быть множественными, например как вкладки одного браузера. При этом привязка к телефону осуществляется первым авторизовавшимся подключением и остается таковой до закрытия всех вкладок/подключений этого пользователя.

<div id="Exchange"></div>
===Взаимодействие по каналу связи===

В этом разделе описывается межсерверный канал websocket, а канал HTTP подразумевается ограниченным аналогом.

Все взаимодействие между Oktell и WebCRM (а также между Oktell и браузером) идет по общему каналу путем двустороннего обмена сообщениями между сторонами.

<center>[[Файл:Socket 3.jpg|500px]][[Файл:Socket 3b.jpg|500px]]</center>

<div id="websockver"></div>
Взаимодействие на транспортном уровне происходит по Web-Socket протоколу. Поддерживаются версии
:* [http://tools.ietf.org/html/rfc6455 rfc6455 v13]
:* [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-08 v8]
:* [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-07 v7]
:* [http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75 75]
:* [http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76 76]

''[[Примеры WebSocket Handshake]]''.

В зависимости от выбранной схемы интеграции и выбранного в настройках направления и способа подключения одна из сторон производит подключение (Oktell к серверу WebCRM, сервер WebCRM к Oktell, клиенты WebCRM к Oktell).
Рукопожатие (handshake) на установление Web-Socket соединения предлагается также стороной-инициатором. [http://ru.wikipedia.org/wiki/WebSocket Подробнее].
Рукопожатие является HTTP запросом и при необходимости поддерживает прохождение Basic или Digest-авторизации. В качестве логина и пароля выступают указанные в [[Интеграция_с_Web-Socket_CRM|настройках Web-Socket]] значения. Описание процедуры рукопожатия описывается в документации к каждой версии протокола Web-Socket.

Все сообщения имеют идентификаторы для организации серий типа «запрос-ответ» (поле ''qid'').
Сообщения могут адресоваться конкретному пользователю или относиться к общим. В первом случае в сообщении должен присутствовать идентификатор, позволяющий различать одинаковые, но направляемые от разных пользователей команды из WebCRM в Oktell и наоборот соответственно.

Возможные направления и типы сообщений:
:* Oktell генерирует события.
:* Oktell производит запросы к веб-системе. WebCRM отправляет ответы на получаемые запросы.
:* WebCRM производит запросы к Oktell. В том числе и команды. Oktell отправляет ответы на запросы.

''В случае HTTP подключения к CRM работа ограничивается запросами из Oktell и ответами на них из CRM.''

Каждое сообщение представляет из себя строку [http://ru.wikipedia.org/wiki/JSON JSON] или [http://ru.wikipedia.org/wiki/XML XML] в кодировке [http://ru.wikipedia.org/wiki/UTF8 UTF-8]. Сообщения в общем потоке данных в канале отделяются друг от друга в соотвествии с версией используемого протокола Web-Socket:
:*Версии [http://tools.ietf.org/html/rfc6455 rfc6455 v13], [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-08 v8], [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-07 v7] подразумевают использование фреймов, в заголовках которых определяется тип и размер.
:*Версии [http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76 76] и [http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75 75] подразумевают отделение сообщений байтами 0 и 255. 0 - в начале сообщения, 255 - в конце. Форматы XML и JSON представления данных в текстовом виде гарантируют отсутствие байтов 0 и 255 в теле сообщений.

''В случае HTTP подключения к CRM запросы из октелл отправляются методом POST с передачей параметра '''data''', значением которого является упакованная в base64 строка JSON или XML.''

Формат самих сообщений определяется непосредственно [[#Список методов интерфейса|протоколом интеграции Oktell-WebCRM]]. Например вот так выглядит сообщение из Oktell в WebCRM о факте входящего вызова в формате json:

[[Файл:Json.jpg]]

Сообщения длиной более 64 КБ упаковываются в [http://ru.wikipedia.org/wiki/Base64 Base64] и разбиваются на несколько сообщений длиной до 64К. Для этого используется формат multipart-сообщения в протоколе Oktell-WebCRM. Если версия протокола Web-Socket для передачи сообщений использует фреймы ([http://tools.ietf.org/html/rfc6455 rfc6455 v13], [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-08 v8], [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-07 v7]), то способ отправки длинных сообщений в нескольких фреймах определен в самом протоколе. Однако это имеет ограничение: при передаче одного длинного сообщения в нескольких фреймах, оно не может быть прервано передачей других сообщений.

Структура каждого сообщения - это список из двух объектов, первый из которых - тип сообщения, второй - словарь параметров. В словаре обязательно присутствует идентификатор запроса (поле ''qid'' с любым текстовым уникальным значением). В случае, когда сообщение производится от имени пользователя, присутствуют его идентификаторы (''userid'' и/или ''userlogin'').

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

<div id="Dynamic"></div>

===Динамическое взаимодействие===

В момент создания сценариев в Oktell администратор имеет возможность настроить индивидуальное взаимодействие с WebCRM.
Взаимодействие представляет собой вызов определенного метода WebCRM с передачей в него входных параметров, и возможно ожидание его исполнения с возвратом (нескольких) выходных значений.

Сразу после организации подключения к серверу WebCRM Oktell производит запрос доступных в WebCRM динамических методов (как было сказано выше, это происходит в рамках [[#Arch1|схемы интеграции 1]] и [[#Arch3|схемы интеграции 3]]).
В ответ WebCRM перечисляет список действий, инициативу исполнения которых она готова отдать наружу в Oktell. При описании метода в представлении указываются:
:* человеческое название;
:* краткий код метода;
:* описание для администратора, настраивающего Oktell;
:* список входных параметров с упоминанием типов (и возможных значений для перечислений);
:* список выходных параметров, если метод возвращает данные и призван влиять на алгоритм сценария в Oktell;
:* признак того, нужно ли исполнять метод с привязкой к конкретному пользователю и в направлении индивидуального пользовательского подключения, или это обращение к серверу вообще;
:* разрешено ли отменять исполнение (например для метода «открыть карточку такую-то» возможна отмена, означающая «закрыть карточку такую-то»);
:* куда Oktell направлять серверный запрос - через стандартное подключение (websocket или http в соответствии с настройками) или по HTTP/HTTPS на альтернативный URL веб-сервера (передача осуществляется точно также POST запросом с упаковкой сообщения в переменную ''data'' в виде base64.

По каждому методу дополнительно описывается перечень входных и выходных параметров, их типы, способ исполнения метода (по организованному каналу или отдельным http-подключением), возможность его отмены (для длительных асинхронных операций, например метод ''Открыть диалоговую форму'' может быть отменен обратным методом ''Закрыть диалоговую форму'', а может быть прерван с тем же результатом).

В [[#Interface|интеграционном интерфейсе Oktell<->WebCRM]] отсутствует таким образом необходимость конкретизировать методы WebCRM.
В момент настройки сценария Oktell администратор уже имеет о них информацию и настраивает конкретный сценарий под место.

Администратором определяется одно или несколько из доступных действий, определяется момент исполнения, определяются входные параметры или способ их вычисления, а также режим ожидания, таймаута или асинхронного выполнения.
В момент работы Oktell отправляет команду на исполнение в соответствии с определенными администратором настройками и представлением динамического метода.
Если метод призван исполняться синхронно и возвращать некие значения, то сценарий приостанавливается, а после получения ответа сохраняет результаты в переменных сценария и продолжает выполнение.
Работа с динамическими методами и формами производится в сценариях Oktell компонентом [[Общие_компоненты_сценариев#Действие/карточка_в_plugin_или_WebCRM|Действие в WebCRM]].

Для примера: в момент поступления вызова Oktell определил номер абонента. Производит синхронное исполнение динамического метода WebCRM ''Вернуть ид компании по номеру телефона'', дожидается ответа и принимает в сценарий значение. Далее исполняет динамический метод ''Ответственный сотрудник по компании'', дожидается ответа и принимает в сценарий значение. Все это время абоненту проигрывается голосовое или музыкальное приветствие. Когда воспроизведение завершается, Oktell производит маршрутизацию в соответствии с вернувшимися значениями, а также в момент поступления звонка сотруднику исполняет динамический метод ''Открыть карточку компании'' с передачей в качестве параметра идентификатора, вернувшегося на первом шаге. В случае, если сотрудник не снимает трубку, Oktell отменяет исполнение метода, тем самым отдавая команду на закрытие карточки компании.

Ни об одном из перечисленных в примере методов WebCRM сервер Oktell не знает, зато знает администратор, настраивающий систему на работу совместно с WebCRM.

Подробно список и интерфейс методов динамического взаимодействия приведен в разделе [[#DynamicMethods|Методы динамического взаимодействия]].

<div id="Interface"></div>
===Список методов общего интерфейса===

Взаимодействие происходит путем обмена сообщениями по установившемуся транспортному каналу.
Часть сообщений носят вид событий, часть - вид запросов (команд), часть - вид ответов на запросы. Каждое сообщение представляет собой байтовое представление текста с escape-последовательностями, описывающего объект в виде структуры JSON (возможен вариант XML), преобразованного через кодировку UTF8.

На первом уровне объекта - массив из двух значений: строковый кодовый идентификатор сообщения, именованный список параметров:
<pre>[ "messagecode", {"var1":"value1", "var2":"value2", ...} ]</pre>

В общем случае среди параметров могут присутствовать сложные объекты (массивы и словари):
<pre>"var1":["a", "b", "c"] или "var2":{"a":1, "b":2, "c":3}</pre>

В каждом сообщении присутствует параметр ''qid'', содержащий уникальный строковый идентификатор сообщения, обеспечивающий возможность построения из сообщений серий вида «запрос-ответ».
В случае, когда сообщение относится к конкретному пользователю (отправляется от его имени), в нем присутствуют параметры ''userlogin'' и ''userid''. По умолчанию синхронизация учетных записей пользователей происходит по их уникальным логинам.

====Представление систем друг другу====

-------------------------------------------------------------------
'''whoareyou'''

Двунаправленный запрос на возврат информации об удаленной стороне. Служит для выстраивания взаимоотношений на основе типа подключения, а также дает возможность получить имя системы для указания администратору.
Ответом является сообщение ''iam''.

Применяется в [[#Arch1|схеме интеграции 1]].

<pre>
[
"whoareyou",
{
"qid": "4FEEB8EF-DF4B-47AE-8EFE-4BDA577A6FF8",
"type": "ws-server",
"name": "Iris CRM",
"version": 10.5
}
]
</pre>
<pre>
//* type - собственный тип сервера, осуществляющего запрос.
Oktell при запросе указывает значение ''commserver''.
WebCRM может указывать что либо отличное, например ''ws-server'' или ''crm-server''.
//* name - собственное название службы.
//* version - собственная версия службы.
</pre>

'''iam'''

Двунаправленный ответ на запрос ''whoareyou''. Возвращает информацию об удаленной стороне.

<pre>
[
"iam",
{
"qid": "080C0DF2-442B-410E-9204-4ADB3399FCC0",
"type": "commserver",
"name": "Oktell",
"version": 100425,
"build": "2.5.3928.8022"
}
]
</pre>
<pre>
//* type - тип удаленного сервера.
Oktell при запросе указывает значение ''commserver''.
WebCRM может указывать что либо отличное, например ''ws-server'' или ''crm-server''.
//* name - название службы на удаленнм сервере.
//* version - версия службы на удаленном сервере.
</pre>

<div id="DynamicMethods"></div>
====Методы динамического взаимодействия====

Информация от CRM о поддерживаемых методах, доступных Oktell для инициации исполнения.

Серия методов forms - частный случай методов, позволяющий выделить в отдельную категорию работу с карточками. Смысл и способ работы тот же самый. Тем не менее карточки могут быть представлены как методы.

----------------------------------------------

Методы:
# >>> getavailablemethods 
# <<< availablemethods 
# >>> executemethod 
# <<< methodresult 
# >>> cancelmethod 
# >>> executemethodwaitaborted 

Формы:
# >>> getavailableforms 
# <<< availableforms 
# >>> showform 
# >>> closeform 
# <<< formresult 
# >>> showformwaitaborted 

------------------------------------------------------------------------------
<div id="getavailablemethods"></div>
>>> '''getavailablemethods'''

Отправляет из Oktell в CRM сообщение-запрос на возврат доступных динамических методов CRM. Отправляется только на сервер CRM (websocket или http).

<pre>
[
"getavailablemethods",
{
"qid": "76EF6E46-23DA-47B6-B3BD-A7076FEDE170"
}
]
</pre>

<<< '''availablemethods'''

Сообщение-ответ из CRM в Oktell со списком доступных динамических методов CRM.

<pre>
[
"availablemethods",
{
"qid": "76EF6E46-23DA-47B6-B3BD-A7076FEDE170",
"methods": [
{
"key": "16893E86-4D73-4F4C-8629-6E484B2CB5B0",
"name": "Вернуть данные о компании",
"description": "Возвращает информацию о компании по одному из выбранных идентификаторов, чтобы в дальнейшем использовать при открытии карточки данных о компании",
"connectiontype": "http",
"url": "http://192.168.0.100:4000/pbxapi/method1.php",
"defineuser": false,
"allowcancel": false,
"inputparams": [
{
"key": "type",
"name": "Тип поиска",
"description": "",
"type": "list",
"items": [
{
id: "byphone",
name: "По номеру телефона"
},
{
id: "byaccount",
name: "По номеру договора"
}
]
},
{
"key": "data",
"name": "Значение идентификатора",
"description": "Номер телефона или номер договора (в соответствии с выбранным типом)",
"type": "string"
},
{...},
{...}
]
"outputparams": [
{
"key": "accountid",
"name": "Идентификатор клиента",
"description": "Для дальнейшей передачи на отображение карточки",
"type": "string"
},
{...},
{...}
]
},
{
"key": "createrecord",
"name": "Создать новое дело",
"description": "Отображает контактные данные об абоненте (комании или человеке) при входящем/исходящем звонке",
"connectiontype": "websocket",
"defineuser": true,
"allowcancel": false,
"inputparams": [
{
"key": "sessionid",
"name": "Идентификатор сессии звонка",
"description": "Для связи с номером дела",
"type": "string"
}
],
"outputparams": [
{
"key": "recordid",
"name": "Идентификатор созданного дела",
"description": "Для дальнейшей передачи на отображение карточки",
"type": "string"
}
{...},
{...}
]
},
{
"key": "card_records",
"name": "Показать карточку «ДЕЛА»",
"description": "Отображает контактные данные об абоненте (комании или человеке) при входящем/исходящем звонке",
"connectiontype": "default",
"defineuser": true,
"allowcancel": true,
"inputparams": [
{
"key": "recordid",
"name": "Номер дела",
"description": "Номер дела, который ранее был создан при вызове метода «Создать запись дела»",
"type": "string"
},
{
"key": "accountid",
"name": "Идентификатор клиента",
"description": "Идентификатор клиента в базе данных CRM",
"type": "string"
},
{...},
{...}
]
},
{...},
{...}
]
}
]
</pre>

<pre>
//* method:key, param:key - произвольные строковые идентификаторы, упоминаемые при вызове форм из октелла
//* method:name, param:name - краткие человеческие названия, отображаются в списках при настройке сценария.
//* method:description, param:description - описания, если смысл формы/параметра нетривиален, и админу может потребоваться объясняение
//* method:inputparams - список входных параметров, значения которых требуется передавать в командном сообщении на исполнение соответствующего метода.
//* method:outputparams - список выходных параметров, значения которых можно ожидать в сообщении о выполнении метода.
//* param:type - тип параметра: string, int|int64, bool, decimal|float|double, datetime, list. Если не указан - строка. Дает администратору представление.
//* param:items - в случае если тип параметра=list, здесь идет перечисление вариантов списка
//* method:connectiontype - websocket|http|https|default - куда ломиться, через веб-сокет (дефолтный канал), или запросом к http-серверу. Дефолтный канал - если к CRM подключение по HTTP, то запрос по тому же адресу будет.
//* method:defineuser - true|false - определять пользователя, или запрос к веб-серверу вообще.
//* method:allowcancel - true|false - поддерживается ли отмена исполнения (например закрытие открывшейся карточки).
</pre>

------------------------------------------------------------------------------
>>> '''executemethod'''

Сообщение-команда из Oktell в CRM на выполнение динамического метода (возможно у конкретного пользователя). В зависимости от представления метода может исполняться на сервере CRM или передаваться в пользовательское подключение.

Параметр ''waitresponsems'' указывает интервал в миллисекундах, которое сценарий предполагает ожидать возврата ответа после исполнения метода; если значение равно нулю, значит метод исполняется асинхронно и ответ не нужен. При этом если происходит прерывание исполнения сценария, или в случае наличия множественных подключений от пользователя при получении первого ответа, отправляется уведомительное событие ''executemethodwaitaborted''.

<pre>
[
"executemethod",
{
"qid": "4A8E20A1-57F9-4CA6-B4EE-221E2EB00364",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"methodkey": "createrecord",
"executionid": "25FC81FC-C5D0-40FB-B4E0-882352E12D86",
"inputparameters": {
"sessionid": "2A2C48FE-D8B6-4B51-951A-09D31543D000"
},
"waitresponsems": 0
}
]
</pre>

<<< '''methodresult'''

Сообщение-результат выполнения динамического метода из CRM в Oktell с возвратом выходных значений. Не отправляется, если исполнение прерывается командой CancelMethod.

<pre>
[
"methodresult",
{
"qid": "A238110C-6B74-4980-AA23-41402B1E9B0E",
"methodkey": "createrecord",
"executionid": "25FC81FC-C5D0-40FB-B4E0-882352E12D86",
"outputparameters": {
"recordid": "ADCB1376-BA66-496C-A56E-AB7A7D5A9193"
}
}
]
</pre>

------------------------------------------------------------------------------
>>> '''cancelmethod'''

Сообщение-команда из Oktell на прекращение выполнения ранее запущенного динамического метода. Отправляется туда же, куда предварительно было отправлено сообщение ''executemethod''.

<pre>
[
"cancelmethod",
{
"qid": "6ADC3F1E-B1DD-4768-BAF8-3EEB477B2F17",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"methodkey": "card_records",
"executionid": "25FC81FC-C5D0-40FB-B4E0-882352E12D86",
"forcecancel": 0
}
]
</pre>

------------------------------------------------------------------------------
>>> '''executemethodwaitaborted'''

Сообщение-событие из Oktell, уведомляющее сервер/клиента CRM о прекращении ожидания ответа на выполнение метода. Отправляется туда же, куда предварительно было отправлено сообщение ''executemethod''. Отправляется только в том случае, если Oktell производил ожидание ответа (параметр ''waitresponsems'' не был равен нулю).

<pre>
[
"executemethodwaitaborted",
{
"qid": "6ADC3F1E-B1DD-4768-BAF8-3EEB477B2F17",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"methodkey": "card_records",
"executionid": "25FC81FC-C5D0-40FB-B4E0-882352E12D86"
}
]
</pre>

------------------------------------------------------------------------------
<div id="getavailableforms"></div>
>>> '''getavailableforms'''

Отправляет из Oktell в CRM сообщение-запрос на возврат доступных карточек CRM. Отправляется только на сервер CRM (websocket или http).

<pre>
[
"getavailableforms",
{
"qid": "7A1FF57A-ED91-4033-A42F-1D2AE630450E"
}
]
</pre>

<<< '''availableforms'''

Сообщение-ответ из CRM в Oktell со списком доступных карточек CRM. Команда на отображение форм отправляется в клиентские подключение (или на сервер-мультиплексор), в серверный канал такие команды не отправляются. В этом основное различие динамических методов и форм.

Следует понимать, что формы могут иметь разное назначение, и соответственно разный способ работы с данными. Например форма некоторого запроса отображается с целью получения данных обратно в сценарий - в этом случае форме нужны выходные параметры, и вызов ее происходит с ожиданием ответа. Одновременно могут существовать и использоваться формы, работающие с данными из CRM и взаимодействующие непосредственно с CRM, возможно находящиеся в отображении длительное время. В этом случае Oktell выступает лишь как инициатор их открытия с передачей входных идентификационных параметров. Таким формам выходные значения не нужны.

<pre>
[
"availableforms",
{
"qid": "7A1FF57A-ED91-4033-A42F-1D2AE630450E",
"forms": [
{
"key": "formB840825C",
"name": "Данные о компании",
"description": "Отображает контактные данные об абоненте (комании или человеке) при входящем/исходящем звонке",
"inputparams": [
{
"key": "accountid",
"name": "Код компании",
"description": "Код компании, который CRM возвращает в поле [accountid] в ответ на запрос данных о компании по номеру телефона",
"type": "string"
},
{
"key": "page",
"name": "Активная страница",
"description": "Открываемая страница формы по умолчанию при открытии карточки",
"type": "list",
"items": [
{
id: "page1",
name: "Контактные данные"
},
{
id: "page2",
name: "История взаимодействия"
},
{
id: "page3",
name: "Комментарии"
}
]
{...},
{...}
]
},
{...},
{...}
]
}
]
</pre>

------------------------------------------------------------------------------
>>> '''showform'''

Сообщение-команда из Oktell в CRM на открытие карточки у конкретного пользователя.

<pre>
[
"showform",
{
"qid": "5CF770AE-E308-41DA-B89E-7BBCE75BE36F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"formkey": "formB840825C",
"windowid": "9F5D8B1A-8818-41EA-A240-04DA07498C40",
"inputparameters": {
"accountid": "05379F49-AB22-4872-B2C2-0D4BA019EA0B",
"page": "page2"
},
"waitresponsems": 0
}
]
</pre>

<<< '''formresult'''

Сообщение-результат из CRM в Oktell при закрытии карточки пользователем с возвратом выходных значений. Не отправляется, если отображение прерывается командой CloseForm

<pre>
[
"formresult",
{
"qid": "EC9E1619-AC1B-4071-98B9-30808B9ED0EC",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"formkey": "formB840825C",
"windowid": "9F5D8B1A-8818-41EA-A240-04DA07498C40",
"outputparameters": {
"comment": "блаблабла"
}
}
]
</pre>

------------------------------------------------------------------------------
>>> '''closeform'''

Сообщение-команда из Oktell на закрытие карточки у конкретного пользователя. Отправляется туда же, куда предварительно было отправлено сообщение ''executemethod''.

<pre>
[
"closeform",
{
"qid": "FAA1A503-FEC6-4D23-ADA9-2E4FD63F2C96",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"formkey": "formB840825C",
"windowid": "9F5D8B1A-8818-41EA-A240-04DA07498C40",
"forceclose": 0
}
]
</pre>

------------------------------------------------------------------------------
>>> '''showformwaitaborted'''

Сообщение-событие из Oktell, уведомляющее сервер/клиента CRM о прекращении ожидания ответа на отображение формы. Отправляется туда же, куда предварительно было отправлено сообщение ''showform''. Отправляется только в том случае, если Oktell производил ожидание ответа (параметр ''waitresponsems'' не был равен нулю).

<pre>
[
"showformwaitaborted",
{
"qid": "6ADC3F1E-B1DD-4768-BAF8-3EEB477B2F17",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"formkey": "formB840825C",
"windowid": "9F5D8B1A-8818-41EA-A240-04DA07498C40"
}
]
</pre>

====Обмен данными об активных пользователях====

-------------------------------------------------
>>> '''getactiveusers'''

Запрос из Oktell в CRM на возврат текущих активных (авторизованных) пользователей. Применяется при старте одной из систем в момент организации подключения.

<pre>
[
"getactiveusers",
{
"qid": "9C44D978-E380-4405-B1B9-C4894BF188A7"
}
]
</pre>

<<< '''activeusers'''

Ответное сообщение из CRM в Oktell со списком активных авторизованных пользователей CRM.

<pre>
[
"activeusers",
{
"qid": "9C44D978-E380-4405-B1B9-C4894BF188A7",
"users": [
{"userlogin": "ivanov", "userid": "20394857203948752345"},
{"userlogin": "petrov", "userid": "kasjdfhlaksjdfhlaks"},
{"userlogin": "sidorov", "userid": "987495873948573945"}
]
}
]
</pre>

-------------------------------------------------
<div id="login"></div>
<<< '''login'''

Сообщение из CRM в Oktell об авторизации пользователя. Запрос кросс-авторизации в Oktell в рамках [[#Arch1|схемы интеграции 1]].

Логин используется в частности для привязки пользователя к конкретному телефонному аппарату. Возможны разные варианты привязки:
# Для конкретного телефона в [[Карта сети|карте сети]] Oktell задается конкретный пользователь WebCRM, при логине производится автоматическая привязка (если телефону назначен также пользователь по умолчанию, то он отключается). При выходе выходе пользователя из WebCRM происходит обратный процесс. При этом телефоном считается учетная запись (комбинация логин-пароль или IP-адрес устройства, в зависимости от типа регистрации), и фактически разные устройства могут в течение времени принимать эти значения.
# Во время логина WebCRM в сообщении указывает любой идентификатор (или их список) рабочего места, с которого осуществляется запуск (это может быть HostName, IP-адрес, или любой другой уникальный идентификатор, указанный для сопоставления также и в карте сети в качестве адреса компьютера). Соединенный с этим компьютером логической связью телефон в карте сети становится рабочим телефоном авторизованного таким образом пользователя. По аналогии с работой клиентских приложений Oktell.

В случае индивидуальных подключений [[#Arch2|схемы интеграции 2]] и [[#Arch3|схемы интеграции 3]] требуется указание как логина, так и пароля для проведения полной проверки, причем пароль необходимо указывать в виде MD5 хеша. При этом возможно использование сессий (параметры ''sessionid'' и ''expires''). Клиент указывает время жизни сессии в секундах, сервер возвращает идентификатор сессии; в дальнейшем при повторном подключении в указанный интервал времени клиент может указывать сессию и новое время жизни для продления, но не указывать пароль. Если сессия существует (время не вышло, сервер не перезагружался), то авторизация будет подтверждена.

ВНИМАНИЕ! В версии 2.8 пароли case-sensitive, в версии 2.7 пароли case-insensitive. При переходе между версиями до полного обновления всех паролей рекомендуется указывать пароль в дублированном виде: параметр ''password'' - MD5(lowercase), ''Password'' - MD5(normalcase).

В случае [[#Arch1|схемы интеграции 1]] подразумевается, что авторизация пользователя происходит в WebCRM, и указания пароля при кросс-логине в Oktell не требуется, равно как и сессий.

<pre>
[
"login",
{
"qid": "9D484E0E-BE08-47B5-ABBD-490936881056",
"userlogin": "ivanov",
"userid": "29834234234",
"password": "D41D8CD98F00B204E9800998ECF8427E",
"expires": 86400,
"usewebrtc": 1
}
]
</pre>

<pre>
[
"login",
{
"qid": "9D484E0E-BE08-47B5-ABBD-490936881056",
"userlogin": "ivanov",
"userid": "29834234234"
}
]
</pre>

<pre>
[
"login",
{
"qid": "9D484E0E-BE08-47B5-ABBD-490936881056",
"userlogin": "ivanov",
"userid": "29834234234",
"workplace": "wp001",
"sessionid": "838AC713-9D4D-43E2-A57D-D4F2D7545FB5",
"expires": 86400
}
]
</pre>

<pre>
[
"login",
{
"qid": "9D484E0E-BE08-47B5-ABBD-490936881056",
"userlogin": "ivanov",
"userid": "29834234234",
"workplace": [
"wp001",
"192.168.0.204",
"81.22.217.33"
]
}
]
</pre>

>>> '''loginresult'''

Сообщение из Oktell в CRM о результате авторизации или кросс-авторизации пользователя. Отправляется в ответ на запрос авторизации в Oktell методом ''login'', а в рамках [[#Arch1|схемы интеграции 1]] может быть отправлено самостоятельно по результатам обработки сообщения ''activeusers'' после установки связи с CRM. В случае запроса использования клиентом WebRTC, в ответе направляется информация по учетной записи телефона, ожидающей подключения по SIP.

<pre>
[
"loginresult",
{
"qid": "939AA33E-011F-4FEC-B60A-8BC1B4888B5A",
"userlogin": "ivanov",
"userid": "29834234234",
"result": 0,
"error": 50093,
"errormsg": "Пользователь уже зарегистрирован"
}
]
</pre>

<pre>
[
"loginresult",
{
"qid": "939AA33E-011F-4FEC-B60A-8BC1B4888B5A",
"userlogin": "ivanov",
"userid": "29834234234",
"result": 1,
"sessionid": "838AC713-9D4D-43E2-A57D-D4F2D7545FB5",
"expires": 10000,
"sipuser": "phone81",
"siplogin": "phone81",
"sippass": "3kd94FnI",
"sipport": 5060
}
]
</pre>

-------------------------------------------------
<<< '''logout'''

Сообщение из CRM в Oktell о выходе (логауте) пользователя. Команда на кросс-логаут в Oktell.

<pre>
[
"logout",
{
"qid": "9D484E0E-BE08-47B5-ABBD-490936881056",
"userlogin": "ivanov",
"userid": "29834234234"
}
]
</pre>

>>> '''logoutresult'''

Сообщение из Oktell в CRM о результате кросс-логаута пользователя. Может быть отправлено в ответ на запрос кросс-логаута в Oktell, а может быть отправлено самостоятельно в случае длительного отсутствия откликов от пользователя (не задействовано) или выгрузки пользователя по инициативе сервера.

<pre>
[
"logoutresult",
{
"qid": "4B25E210-2D67-4675-A5AE-46DC9CBC32F9",
"userlogin": "ivanov",
"userid": "29834234234",
"result": 1
}
]
</pre>

-------------------------------------------------
<<< '''updatesession'''

Команда из CRM в Oktell о продлении сессии пользователя (для сохранения возможности производить вход без пароля).

<pre>
[
"updatesession",
{
"qid": "9D484E0E-BE08-47B5-ABBD-490936881056",
"userlogin": "ivanov",
"userid": "29834234234",
"sessionid": "9238749273982734023",
"expires": 86400
}
]
</pre>

====Обмен состояниями пользователей====

-------------------------------------------------
<<< '''entercallcenter'''

Запрос из CRM на вход в режим call-центра. При проведении изменений в ответ отправляется сообщение userstatechanged.

<pre>
[
"entercallcenter",
{
"qid": "7DD2ED7A-B6BF-4988-A780-99719C65CA5D",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

<<< '''exitcallcenter'''

Запрос из CRM на выход из режима call-центра. При проведении изменений в ответ отправляется сообщение userstatechanged.

<pre>
[
"exitcallcenter",
{
"qid": "6E899456-C373-48EB-949E-E2C0D79D45EA",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''checkmyuserprivilege'''

Запрос из CRM на проверку наличия у пользователя обще-ролевой привилегии.

<pre>
[
"checkmyuserprivilege",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"code": "DashboardCreate"
}
]
</pre>

>>> '''checkmyuserprivilegeresult'''

Ответ на ''checkmyuserprivilege''.

<pre>
[
"checkmyuserprivilegeresult",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"code": "DashboardCreate",
"hasprivilege": true
}
}
]
</pre>

-------------------------------------------------
<<< '''getmyuserprivileges'''

Запрос из CRM на возврат всех имеющихся у пользователя обще-ролевых привилегий.

<pre>
[
"getmyuserprivileges",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''getmyuserprivilegesresult'''

Ответ на ''getmyuserprivileges''.

<pre>
[
"getmyuserprivilegesresult",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"privileges":[
"ExtWP",
"ViewOffice",
...
]
}
}
]
</pre>

====Текстовый чат v.1 (версии до 2.8.130909)====

Обмен текстовыми сообщениями в первоначальном варианте, где подразумевается только диалоговое общение между двумя пользователями.
Начиная с версии 2.8.130909 этот способ считается устаревшим.

-------------------------------------------------
>>> '''usertextmessagereceived'''

Сообщение-событие из Oktell в CRM о новом входящем текстовом сообщении чата.

<pre>
[
"usertextmessagereceived",
{
"qid": "D5582E04-2964-438C-A8DB-21AF898BBAE0",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"messageid": "0263C7BF-DEB3-406F-9CF9-6F56D828C755",
"snduserlogin": "Петров",
"snduserid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"sndusername": "Петров Антон Григорьевич",
"messagetext": "раз два три четыре пять вышел зайчик погулять",
"messagedate": "2011-03-27 14:12:28",
}
]
</pre>

>>> '''usertextmessageviewed'''

Сообщение-событие из Oktell в CRM о прочитанности отправленного сообщения.

<pre>
[
"usertextmessageviewed",
{
"qid": "D5582E04-2964-438C-A8DB-21AF898BBAE0",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"vieweduserid": "66D12297-E400-4862-BD24-F6DACCFDF9DA",
"messageids": [
"0263C7BF-DEB3-406F-9CF9-6F56D828C755",
"4B5110FD-899B-4429-A659-2B9695B4D89E"
]
}
]
</pre>

<<< '''sendusertextmessage'''

Запрос из CRM в Oktell на отправку текстового сообщения в рамках чата другому пользователю.
Вложения и сообщения в конференциях - опция, используемая веб-клиентом Oktell.

<pre>
[
"sendusertextmessage",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"messageid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"recvuserlogin": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"recvuserid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"messagetext": "раз два три четыре пять вышел зайчик погулять",
"isconferencechat": true,
"files": [
"Temp\1.jpg",
"Temp\2.jpg"
]
}
]
</pre>

>>> '''sendusertextmessageresult'''

Ответ из Oktell на команду отправки сообщения.

<pre>
[
"sendusertextmessageresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"messageid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"dtformat": "yyyy-MM-dd HH:mm:ss",
"sentdate": "2012-03-18 13:06:28"
}
]
</pre>

<<< '''setusermessageviewed'''

Запрос из CRM в Oktell на выставление признака прочитанности текстового сообщения пользователем. В ответ возвращается количество реально отмеченных сообщений. Может быть больше или меньше указанного. Событие о прочитанности отправляется пользователю, указанному в поле senderuserid (параметр может не указываться).

<pre>
[
"setusermessageviewed",
{
"qid": "AA29AE60-50C3-48EE-A32E-3D98265D7412",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"senderuserid": "689BD58D-2288-4E93-8647-58FB0756F3CA",
"messageids": [
"0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"4748964E-9ADC-4999-9ACB-12B8B46660CF"
]
}
]
</pre>

>>> '''setusermessageviewedresult'''

Ответ из Oktell на команду установки признака прочитанности ''setusermessageviewed''.

<pre>
[
"setusermessageviewedresult",
{
"qid": "AA29AE60-50C3-48EE-A32E-3D98265D7412",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"updatedcount": 12
}
]
</pre>

====Текстовый чат v.2 (версии начиная с 2.8.130909)====

Обмен текстовыми сообщениями протекает в рамках чатов - индивидуальных, массовых, прикрепленных. Вводится понятие чата с соответствующими свойствами - названием, списком участников, возможностью их редактирования. Требует подписки на совокупность событий ''chat''.
Интерфейс доступен и считается основным начиная с версии 2.8.130909.

-------------------------------------------------
<<< '''chatcreate'''

Запрос из CRM в Oktell на создание нового чата. Чаты создаются одним из участников, все остальные уведомляются о создании. Чаты могут существовать сколь угодно длительное время и использоваться многократно.
Идентификатор может не указываться, тогда он генерируется и возвращается в ответе.
Типы: 1 - приватный диалог двух участников, 2 - чат с нерегламентированным количеством участников, 3 - привязанный к конференции.
По результатам создания генерируется и отправляется событие ''[[chatcreated]]'' всем заявленным участникам чата.

<pre>
[
"chatcreate",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"name": "название чата",
"type": 2,
"linkedobjectid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240"
"members": [
"D9E54EB7-D3D9-43D6-B70C-019ABC6FC457",
"A530C87E-6A07-471C-B70C-E7C1C31AD9A7"
]
}
]
</pre>

>>> '''chatcreateresult'''

Ответ из Oktell на команду создания нового чата.

<pre>
[
"chatcreateresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240"
}
]
</pre>

-------------------------------------------------
<<< '''chatsetname'''

Запрос из CRM в Oktell на изменение названия существующему чату.
По результатам изменения генерируется и отправляется событие ''[[chatnamechanged]]'' всем авторизованным участникам чата.

<pre>
[
"chatsetname",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"name": "новое название чата"
]
}
]
</pre>

>>> '''chatsetnameresult'''

Ответ из Oktell на команду изменения названия чата.

<pre>
[
"chatsetnameresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''chataddmembers'''

Запрос из CRM в Oktell на добавление участников к существующему чату.
Операция доступна только для участников чата.
В качестве ключей участников ожидаются идентификаторы или логины (более затратная операция в части поиска).
По результатам изменения генерируется и отправляется событие ''[[chatmemberadded]]'' всем авторизованным участникам чата, включая новых.

<pre>
[
"chataddmembers",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"members": [
"D9E54EB7-D3D9-43D6-B70C-019ABC6FC457",
"A530C87E-6A07-471C-B70C-E7C1C31AD9A7"
]
}
]
</pre>

>>> '''chataddmembersresult'''

Ответ из Oktell на команду добавления участников к существующему чату.

<pre>
[
"chataddmembersresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''chatremovemembers'''

Запрос из CRM в Oktell на удаление участников из существующего чата.
Операция доступна только для создателя чата.
В качестве ключей участников ожидаются идентификаторы или логины (более затратная операция в части поиска).
По результатам изменения генерируется и отправляется событие ''[[chatmemberremoved]]'' всем авторизованным участникам чата, включая удаленных.

<pre>
[
"chatremovemembers",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"members": [
"D9E54EB7-D3D9-43D6-B70C-019ABC6FC457",
"A530C87E-6A07-471C-B70C-E7C1C31AD9A7"
]
}
]
</pre>

>>> '''chatremovemembersresult'''

Ответ из Oktell на команду удаления участников из существующего чата.

<pre>
[
"chatremovemembersresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''chatgetmembers'''

Запрос из CRM в Oktell на получение информации о текущих участниках указанного чата.

<pre>
[
"chatgetmembers",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
}
]
</pre>

>>> '''chatgetmembersresult'''

Ответ из Oktell на запрос информации о текущих участниках указанного чата.

<pre>
[
"chatgetmembersresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"members": [
{
"id":"D9E54EB7-D3D9-43D6-B70C-019ABC6FC457"
},
...
]
}
]
</pre>

-------------------------------------------------
<<< '''chatsendmessage'''

Запрос из CRM в Oktell на отправку сообщения в указанный чат.
Идентификатор messageid может не указываться, тогда генерируется и возвращается в ответе. Сообщение может содержать вложенные файлы ('''files''') и указание на скрытое их хранение на диске ('''hidefiles''').

<pre>
[
"chatsendmessage",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240"
"messageid": "2CD5BB8F-CC88-4D01-8A1F-5CEB2CD72AAE",
"messagetext": "раз два три четыре пять вышел зайчик погулять"
"hidefiles": false,
"files": [
"Temp\1.jpg",
"Temp\2.txt"
]
}
]
</pre>

>>> '''chatsendmessageresult'''

Ответ из Oktell на отправку сообщения в указанный чат.

<pre>
[
"chatsendmessageresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"messageid": "2CD5BB8F-CC88-4D01-8A1F-5CEB2CD72AAE"
}
]
</pre>

-------------------------------------------------
<<< '''chatsetmessageviewed'''

Запрос из CRM в Oktell на установку флага прочитанности указанного сообщения. Вместе с указанным сообщением маркируются прочитанными также все предшествующие сообщения этого же чата.

<pre>
[
"chatsetmessageviewed",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
"messageid": "D9E54EB7-D3D9-43D6-B70C-019ABC6FC457"
}
]
</pre>

>>> '''chatsetmessageviewedresult'''

Ответ из Oktell на установку флага прочитанности сообщения.

<pre>
[
"chatsetmessageviewedresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

-------------------------------------------------
<<< '''chatgetprivateid'''

Запрос из CRM в Oktell на получение идентификатора существующего приватного диалога между двумя пользователями, один из которых - авторизованный пользователь. Приватные диалоги соответствуют чатам с типом "1".
В системе возможно существование нескольких приватных диалогов между пользователями, в этом случае возвращается любой из них. В случае отсутствия приватных диалогов в качестве идентификатора возвращается null.

<pre>
[
"chatgetprivateid",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"opponentid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240"
}
]
</pre>

>>> '''chatgetprivateidresult'''

Ответ из Oktell на запрос идентификатора приватного диалога. Если приватный диалог между пользователями не найден, возвращается null.

<pre>
[
"chatgetprivateidresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "D9E54EB7-D3D9-43D6-B70C-019ABC6FC457"
}
]
</pre>

-------------------------------------------------
<<< '''chatgetbyid'''

Запрос из CRM в Oktell на получение информации о чате, указанному с помощью идентификатора. Среди информационных полей возвращаются название, количество участников, последнее сообщение в чате с признаком ''прочитано/не прочитано'', а также идентификатор оппонента, если это приватный диалог.

<pre>
[
"chatgetbyid",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "0B9A00D8-12F6-4A0F-A8A3-4C840E98C240",
}
]
</pre>

>>> '''chatgetbyidresult'''

Ответ из Oktell на запрос информации о чате. Если чат не найден по указанному идентификатору, возвращается null.

<pre>
[
"chatgetbyidresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtformat": "yyyy-MM-dd HH:mm:ss",
"chat": {
"id":"01483664-9D99-4B1B-8131-C46386A6FC68",
"name":"приватный чат",
"type":"1",
"creatorid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"membercount":"4",
"privateopponentid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"linkedobjectid":"",
"lastdtutc":"2013-09-05 14:08:02",
"lastmessage":{
"id":"4067F854-E88A-40C1-82C5-7F125A77A25F",
"amiauthor":false,
"authorid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"authorlogin":"sergeev",
"authorname":"Сергеев Вахтанг Абрикосович",
"dtutc":"2013-09-05 14:08:02",
"text":"Зайди как освободишься",
"isnew":"true"
}
}
}
]
</pre>

-------------------------------------------------
<<< '''chatgethotlist'''

Запрос из CRM в Oktell на получение информации о горячих чатах, в рамках которых последние сообщения были сравнительно недавно.
Запрос информации осуществляется с указанием нужной страницы (в сортированном по убыванию даты последней активности списке ''count'' элементов, начиная с ''startidx'').
Можно также наложить дополнительные фильтры, применяемые к названию чата и к имени оппонента приватного диалога (''search1'' и ''search2'').
Возвращаемая информация аналогична методу ''chatgetbyid''.

<pre>
[
"chatgethotlist",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"startidx": 0,
"count": 10,
"search1": "мой чат",
"search2": "vjq xfn",
}
]
</pre>

>>> '''chatgethotlistresult'''

Ответ из Oktell на запрос информации о горячих чатах.

<pre>
[
"chatgethotlistresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtformat": "yyyy-MM-dd HH:mm:ss",
"chatlist": [
{
"id":"01483664-9D99-4B1B-8131-C46386A6FC68",
"name":"приватный чат",
"type":"1",
"creatorid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"membercount":"4",
"privateopponentid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"linkedobjectid":"",
"lastdtutc":"2013-09-05 14:08:02",
"lastmessage":{
"id":"4067F854-E88A-40C1-82C5-7F125A77A25F",
"amiauthor":false,
"authorid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"authorlogin":"sergeev",
"authorname":"Сергеев Вахтанг Абрикосович",
"dtutc":"2013-09-05 14:08:02",
"text":"Зайди как освободишься",
"isnew":"true"
},
...
]
}
]
</pre>

-------------------------------------------------
<<< '''chatgettotalnewmessagecount'''

Запрос из CRM в Oktell на получение количества непрочитанных сообщений всего по всем чатам с участием пользователя.

<pre>
[
"chatgettotalnewmessagecount",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''chatgettotalnewmessagecountresult'''

Ответ из Oktell на запрос количества непрочитанных сообщений всего.

<pre>
[
"chatgettotalnewmessagecountresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"count": 31
}
]
</pre>

-------------------------------------------------
<<< '''chatgetmessagehistory'''

Запрос из CRM в Oktell на получение истории сообщений по чату.
Может быть наложен дополнительный фильтр на текст сообщения (''search1'' и ''search2''), ограничения на период выдачи истории (''dtstartutc'', ''dtstoputc''). По умолчанию весь период истории без фильтрации по тексту сообщений.
Данные выдаются из сортированного по убыванию даты отправки списка сообщений с указанной страницы (''startidx'', ''count''). По умолчанию первые 10 сообщений.

<pre>
[
"chatgetmessagehistory",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "14D6DBB7-D5CB-471B-888A-9AACC8CD737B",
"startidx": 0,
"count": 50,
"dtstartutc": "2013-07-12 13:00:00",
"dtstoputc": "2013-07-12 15:00:00",
"search1": "abkmnh",
"search2": "фильтр"
}
]
</pre>

>>> '''chatgetmessagehistoryresult'''

Ответ из Oktell на запрос истории сообщений в чате.

<pre>
[
"chatgetmessagehistoryresult",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtformat": "yyyy-MM-dd HH:mm:ss",
"messagelist": [
{
"id":"4067F854-E88A-40C1-82C5-7F125A77A25F",
"amiauthor":false,
"authorid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"authorlogin":"sergeev",
"authorname":"Сергеев Вахтанг Абрикосович",
"dtutc":"2013-09-05 14:08:02",
"text":"Зайди как освободишься",
"isnew":"true"
"files":[
{
"path":"Temp\1.jpg",
"size":329002
},
...
]
},
...
]
}
]
</pre>

-------------------------------------------------
>>> '''chatcreated'''

Сообщение из Oktell в CRM о факте создания нового текстового чата с участием авторизованного пользователя.
Отправляется всем участникам созданного чата.

<pre>
[
"chatcreated",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtformat": "yyyy-MM-dd HH:mm:ss",
"chat": {
"id":"01483664-9D99-4B1B-8131-C46386A6FC68",
"name":"приватный чат",
"type":"1",
"creatorid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"membercount":"4",
"privateopponentid":"F6CDFE11-91D2-47C0-89ED-FA9243B80A77",
"linkedobjectid":"",
"lastdtutc":"2013-09-05 14:08:02",
"members":[
{
"id": "",
"name": ""
},
...
]
}
}
]
</pre>

-------------------------------------------------
>>> '''chatnamechanged'''

Сообщение из Oktell в CRM о факте изменения названия существующего текстового чата.
Отправляется всем участникам этого чата.

<pre>
[
"chatnamechanged",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "41EE8C8F-A7DE-4F78-8F57-7F299CE2767B",
"name": "новое имя"
]
</pre>

-------------------------------------------------
>>> '''chatmemberadded'''

Сообщение из Oktell в CRM о факте добавления новых участников к существующему текстовому чату.
Отправляется всем участникам этого чата.

<pre>
[
"chatmemberadded",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "41EE8C8F-A7DE-4F78-8F57-7F299CE2767B",
"members":[
{
"id": "",
"name": ""
},
...
]
}
]
</pre>

-------------------------------------------------
>>> '''chatmemberremoved'''

Сообщение из Oktell в CRM о факте удаления некоторых участников из существующего текстового чата.
Отправляется всем участникам этого чата.

<pre>
[
"chatmemberremoved",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "41EE8C8F-A7DE-4F78-8F57-7F299CE2767B",
"members":[
{
"id": ""
},
...
]
}
]
</pre>

-------------------------------------------------
>>> '''chatmessage'''

Сообщение из Oktell в CRM о факте поступления сообщения из текстового чата.
Отправляется всем участникам этого чата, включая отправителя (в этом случае поля authorname и authorlogin отсутствуют).

<pre>
[
"chatmessage",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtformat": "yyyy-MM-dd HH:mm:ss",
"chatid": "41EE8C8F-A7DE-4F78-8F57-7F299CE2767B",
"messageid": "14D6DBB7-D5CB-471B-888A-9AACC8CD737B",
"amiauthor": false,
"authorid": "B1D4DCA9-2246-4EA1-B71E-68FF29AC92E4",
"authorname": "",
"authorlogin": "",
"dtutc": "2013-09-05 16:10:04",
"text": "тело сообщения",
"isnew": true
"files":[
{
"path":"Temp\1.jpg",
"size":329002
},
...
]
}
]
</pre>

-------------------------------------------------
>>> '''chatmessageviewed'''

Сообщение из Oktell в CRM о факте прочтения сообщения кем либо из участников текстового чата.
Генерируется для отправителя сообщения, а также для пользователя, который прочитал сообщение.

<pre>
[
"chatmessageviewed",
{
"qid": "F14F31B7-F203-4462-975F-3A37DD16240B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chatid": "41EE8C8F-A7DE-4F78-8F57-7F299CE2767B",
"messageid": "14D6DBB7-D5CB-471B-888A-9AACC8CD737B",
}
]
</pre>

====Голосовая почта====

-------------------------------------------------
>>> '''voicemailreceived'''

Сообщение из Oktell в CRM о факте поступления голосовой почты на ящик пользователя.

<pre>
[
"voicemailreceived",
{
"qid": "080C0DF2-442B-410E-9204-4ADB3399FCC0",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

====Всплывающие уведомления====

-------------------------------------------------
>>> '''shownotifymessage'''

Команда из Oktell в CRM об уведомлении пользователя по аналогии с всплывающими уведомлениями клиентского приложения Oktell

<pre>
[
"shownotifymessage",
{
"qid": "99CC8C57-1793-486A-AFB1-6E5CA3E6855E",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"id": "A33027E1-096F-38B8-1198-BB4D7C15823A",
"sender": "АТС",
"text": "Петров",
"savedb": "true",
"autohide": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"dtformat": "dd.MM.yyyy HH:mm:ss",
"dt": "25.09.2011 13:07:12",
"type": 262144,
"backcolor": "00FF0000",
"uniquekey": "E7899B61-55C3-4007-91EE-DDB348913AA8",
}
]
</pre>
<pre>
//* id - идентификатор сообщения. Присутствует, если сообщение сохранено в БД.
//* savedb: true|false. Сохранено ли сообщение в БД.
//* dt - дата/время генерации уведомления.
//* uniquekey - код сообщения. Может отсутствовать. Но если есть - допускается одновременное отображение только
одного уведомления с таким кодом (либо закрывать автоматически предыдущее, либо не отображать это)
//* backcolor - hex AARRGGBB
//* type - тип сообщения из флагового списка кратных двойке кодов
</pre>

-------------------------------------------------
<<< '''setnotifyshown'''

Запрос из CRM в Oktell об установке признака прочтенности уведомления. Это актуально для уведомлений, сохраняемых в БД.

<pre>
[
"setnotifyshown",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"id": "A33027E1-096F-38B8-1198-BB4D7C15823A",
"wasshown": false
}
]
</pre>
<pre>
//* id - идентификатор сообщения. Может отсутствовать. Но если есть - допускается одновременное отображение только
одного уведомления с таким кодом (либо закрывать автоматически предыдущее, либо не отображать это)
//* ids - список идентификаторов отображенных уведомлений.
</pre>

====Сообщения от АТС====

-------------------------------------------------
>>> '''phoneevent_ringstarted'''

Сообщение из Oktell в CRM о входящем звонке. Не имеет отношения к постановке звонка в очередь. Фактически когда телефон пользователя начал звенеть.

<pre>
[
"phoneevent_ringstarted",
{
"qid": "00488421-97E4-443B-81B7-D645E403AEBB",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
"callerlineid": "BC1FD50B-651F-459D-B659-28230E919673",
"callerlinenum": "13027",
"callerdirection": "oktell_pbx",
"callerid": "73439170203",
"callername": "ОАО Металлург",
"callerdescription": "Металлоконструкции, изделия из черных и цветных металлов",
"callerinfo": "Абонент: 315, Задача 'Входящие в call-центр'",
"callercomment": "Еще что-то об абоненте",
"calleruserlogin": "",
"calleruserid": "00000000-0000-0000-0000-000000000000",
"isextline": true,
"canfax": true,
"canvideo": false,
"isconference": false,
"confid": "00000000-0000-0000-0000-000000000000",
"confname": "",
"confroom": 0,
"confinviternumber": "",
"confinviteruserid": "00000000-0000-0000-0000-000000000000",
"confinviteruserlogin": "",
"istask": true,
"taskid": "F94BD1FE-B628-4CC3-B215-F3F84B275EDD",
"taskname": "Входящие в call-центр"
}
]
</pre>
<pre>
//* Частично могут отсутстовать параметры, описывающие абонента.
// Если istask=false, то остутствуют taskid, taskname, tasktalklimitsec, taskfromhandlesec
// Если звонок не от другого пользователя, то отсутствуют calleruserlogin, calleruserid
// Если isconference=false, то отсутствует confid, confname, confroom
</pre>

-------------------------------------------------
>>> '''phoneevent_ringstopped'''

Сообщение из Oktell в CRM о прекращении входящего вызова. Если пользователь не снял трубку, а вызов прекратился.

<pre>
[
"phoneevent_ringstopped",
{
"qid": "BEB91146-BA27-4236-9CAC-EF562719E7E5",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718"
}
]
</pre>

-------------------------------------------------
>>> '''phoneevent_commstarted'''

Сообщение из Oktell в CRM о коммутации

<pre>
[
"phoneevent_commstarted",
{
"qid": "B7ACFEC1-65BB-4773-A425-DC39F5D1A48C",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
"commutationid": "072F2EE0-4B3B-49A7-AB5B-E213AE752A53"
"callerlineid": "BC1FD50B-651F-459D-B659-28230E919673",
"callerlinenum": "13027",
"callerid": "73439170203",
"callername": "ОАО Металлург",
"callerdescription": "Металлоконструкции, изделия из черных и цветных металлов",
"callerinfosimple": "Абонент: 315, Задача 'Входящие в call-центр'",
"callercomment": "Еще что-то об абоненте",
"calleruserlogin": "",
"calleruserid": "00000000-0000-0000-0000-000000000000",
"isextline": true,
"canfax": true,
"canvideo": false,
"cansendfiles": true,
"canbuildconf": true,
"isivrscript": false,
"isconference": false,
"confid": "00000000-0000-0000-0000-000000000000",
"confname": "",
"confroom": 0,
"istask": true,
"taskid": "F94BD1FE-B628-4CC3-B215-F3F84B275EDD",
"taskname": "Входящие в call-центр",
"tasktalklimitsec": 180,
"taskfromhandlesec": 24
}
]
</pre>
<pre>
//* Частично могут отсутстовать параметры, описывающие абонента.
// Если istask=false, то остутствуют taskid, taskname, tasktalklimitsec, taskfromhandlesec
// Если звонок не от другого пользователя, то отсутствуют calleruserlogin, calleruserid
// Если isconference=false, то отсутствует confid, confname, confroom
</pre>

-------------------------------------------------
>>> '''phoneevent_commstopped'''

Сообщение из Oktell в CRM о завершении коммутации. Не путать со звонком. Коммутаций в рамках обработки звонка может быть много.

<pre>
[
"phoneevent_commstopped",
{
"qid": "D514511C-BD4F-406B-B9C7-695CDC6C40E7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
"commutationid": "072F2EE0-4B3B-49A7-AB5B-E213AE752A53"
}
]
</pre>

-------------------------------------------------
>>> '''phoneevent_ivrstarted'''

Сообщение из Oktell в CRM о соединении с IVR-сценарием.

<pre>
[
"phoneevent_ivrstarted",
{
"qid": "46E07742-0B24-4DD6-B4C6-12CDC1F7B938",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"scriptname": "(Служебный) Вход в АТС",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
"commutationid": "072F2EE0-4B3B-49A7-AB5B-E213AE752A53"
}
]
</pre>

-------------------------------------------------
>>> '''phoneevent_ivrstopped'''

Сообщение из Oktell в CRM о завершении соединения с IVR сценарием.

<pre>
[
"phoneevent_ivrstopped",
{
"qid": "FC9DD78C-1A5F-4E06-9AB5-A9CEDE025F6A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
>>> '''phoneevent_acmcallstarted'''

Сообщение из Oktell в CRM о запуске автодозвона.

<pre>
[
"phoneevent_acmcallstarted",
{
"qid": "410B1930-423E-4632-B3DE-54EC48C0E8A0",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
"callnumber": "471",
"isextline": false,
"callername": "Сигизмунд Львович Кац",
}
]
</pre>

-------------------------------------------------
>>> '''phoneevent_acmcallstopped'''

Сообщение из Oktell в CRM об остановке автодозвона.

<pre>
[
"phoneevent_acmcallstopped",
{
"qid": "410B1930-423E-4632-B3DE-54EC48C0E8A0",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
}
]
</pre>

-------------------------------------------------
>>> '''phoneevent_faxstarted'''

Сообщение из Oktell о начале факс-сеанса на оппозитном канале.

<pre>
[
"phoneevent_faxstarted",
{
"qid": "28979AE8-8E06-4EED-9114-98CB126CA8F4",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
"opponentlineid": "BC1FD50B-651F-459D-B659-28230E919673",
"faxdirection": "send",
"description": ""
}
]
</pre>

-------------------------------------------------
>>> '''phoneevent_faxstopped'''

Сообщение из Oktell о завершении факс-сеанса на оппозитном канале (следом возврат в коммутацию, если трубку не положили там).

<pre>
[
"phoneevent_faxstopped",
{
"qid": "324CD087-BC2D-4FF3-A9BD-86A7276A4DED",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "D6C8232D-4E4A-48BB-954E-C719582A4718",
"result": 0,
"error": 65289,
"errormsg": "NoFaxPages"
}
]
</pre>
<pre>
//* error: список FaxError
</pre>

-------------------------------------------------
>>> '''phoneevent_faxreceived'''

Cообщение из Oktell о завершении приема факса со ссылками на файлы.

<pre>
[
"phoneevent_faxreceived",
{
"qid": "C20E48DF-628D-4954-ADDE-D2C3B31C6700",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"files": [
{
"filename": "",
"filesize": 172934,
"filelink": "\/temp\/receivedfax\/a802d3ea\/img01.tiff",
"availabletill": "2011-03-27 23:39:18",
},
{...},
{...}
]
}
]
</pre>
<pre>
//* Даже если result=0, могут быть частично полученные файлы.
</pre>

-------------------------------------------------
>>> '''flashstatechanged'''

Cообщение из Oktell о смене состояния линии, находящейся на удержании.

<pre>
[
"flashstatechanged",
{
"qid": "99CC8C57-1793-486A-AFB1-6E5CA3E6855E",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"flashtypeid": 1,
"flashtypestr": "Put",
"oppositeid": "91FD3E18-B3A7-4662-8E06-C95C7D245DC3"
}
]
</pre>
<pre>
//* Список возможных состояний:
Put = 1 — постановка на удержание
Return = 2 — возврат с удержания
Abort = 3 — прерывание удержания при положении трубки или другими действиями. Абонент на удержании получит сигнал занято.
Lost = 4 — абонент прервал ожидание, либо ошибка при попытке переключения на него
Switch = 5 — перевод ожидающего на кого-то другого
Invite = 6 — переключение с абонентом в конференцию
Between = 7 — переключение между двумя абонентами на удержании(без обрыва)
Next = 8 — отбой текущего абонента и переход сразу на набор номера без возврата к абоненту на удержании
Flashed = 11 — пользовать сам был поставлен кем-то на удержание
Restored = 12 — пользователь возвращён из удержания
Aborted = 13 — удержание пользователя прервано
</pre>

-------------------------------------------------
>>> '''linestatechanged'''

Cообщение из Oktell о смене состояния внутренней линии

<pre>
[
"linestatechanged",
{
"qid": "99CC8C57-1793-486A-AFB1-6E5CA3E6855E",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"linestateid": 4,
"linestatestr": "lsReady"
}
]
</pre>
<pre>
//* Список возможных состояний внутренней линии:
lsDisconnected = 1 — не подключена
lsOff = 2 — выключена
lsReady = 4 — готова
lsHookUp = 8 — поднята трубка
lsIncomingCall = 16 — входящий звонок
lsCommutated = 32 — скоммутирована
lsWait = 64 — ожидание дозвона\коммутации
lsFlash = 128 — флеш\удержание
lsWaitDown = 256 — ожидание с положенной трубкой(отдельный статус резервирования линии при использовании сервиса автодозвона)
lsListenBusy = 512 — сигнал "Занято" в линии(коммутация разорвана по инициативе противоположной стороны)
lsUndefined = 1024 — неопределено
lsReserved = 2048 — зарезервирована
</pre>

====Команды к АТС====

-------------------------------------------------
<<< '''pbxautocallstart'''

Запрос из CRM к Oktell на совершение звонка. В зависимости от текущего состояния линии - запускается автодозвон или нет, звонок на внешнюю линию, во внутрений номерной план, или автоопределение, сначала вызываться сам пользователь будет, а потом звонок абоненту, или сначала дозвон до абонента, а потом вызов пользователя.

<pre>
[
"pbxautocallstart",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"number": "425",
"direction": "int",
"sequence": "abonent",
"intercom": false
}
]
</pre>
<pre>
//* direction: int, ext, undefined (внутрь, наружу, автоопределение)
//* sequence: abonent, user (сначала до абонента, сначала до пользователя)
//* intercom: true|false (интерком-вызов, обычный вызов)
</pre>

>>> '''pbxautocallstartresult'''

Ответ из Oktell в CRM на запрос звонка.

<pre>
[
"pbxautocallstartresult",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"number": "425",
"direction": "int",
"sequence": "abonent",
"result": 0,
"error": 5,
"errormsg": "cntNumberNotFound"
}
]
</pre>
<pre>
//* error, errormsg: EACMAnswer:
//* cntStartedSuccessfully = 0 //Звонок успешно взят в реализацию
//* cntUserNotReady = 1 //У пользователя-инициатора не найдены линии, готовые линии, или состояние кривое
//* cntBusy = 2 //При звонке на внутренний номер - признак занятости. В очереди и сам повисеть может
//* cntExtLineNotFound = 3, //Не найдены готовые внешние линии
//* cntError = 4, //Прочие ошибки, исключения.
//* cntControlNotReady = 5, //Режим не доделан.
//* cntNumberNotFound = 6 //Внутренний номер не найден (по факту, если сервер сам будет определять
направление звонка, это вообще не будет задействовано)
</pre>

-------------------------------------------------
<<< '''pbxautocallabort'''

Запрос из CRM к Oktell на прекращение автодозвона
<pre>
[
"pbxautocallabort",
{
"qid": "28BF3E8F-1F97-47AB-BD42-92D174D4A705",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''pbxtransfercall'''

Аналогично запросу из CRM на совершение звонка - запрос на совершение переключения. Если линия свободна - действует аналогично полностью запросу на звонок. Если пользователь в разговоре - через флэш набирает указанный номер.

<pre>
[
"pbxtransfercall",
{
"qid": "81FBE5C2-E81B-4D0D-8AC0-72C22ACCD4E2",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"number": "425",
"direction": "int",
"sequence": "abonent",
"intercom": false
}
]
</pre>

>>> '''pbxtransfercallresult'''

И аналогичный ответ из Oktell в CRM.

<pre>
[
"pbxtransfercallresult",
{
"qid": "81FBE5C2-E81B-4D0D-8AC0-72C22ACCD4E2",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"number": "425",
"direction": "int",
"sequence": "abonent",
"result": 0,
"error": 5,
"errormsg": "cntNumberNotFound"
}
]
</pre>

-------------------------------------------------
>>> '''pbxdeclinecall'''

Запрос из CRM к Oktell на отклонение звонка.

<pre>
[
"pbxdeclinecall",
{
"qid": "0AFB2B0C-A68F-448B-9B4B-AB42096D4E95",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''pbxabortcall'''

Запрос из CRM к Oktell на обрыв текущего существующего сеанса связи. Не путать с DeclineCall. Прекращает коммутацию, если существует, прекращает автодозвон, если запущен.

<pre>
[
"pbxabortcall",
{
"qid": "53F2EE86-46AF-4A37-8C60-2F27EADD10DE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<div id="pbxmakeflash"></div>
<<< '''pbxmakeflash'''

Запрос из CRM в Oktell на программную эмуляцию флэш.

<pre>
[
"pbxmakeflash",
{
"qid": "DD836C5D-4F3E-4FD2-9B60-24E330B03FC6",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"mode": "default"
}
]
</pre>
<pre>
//* mode - abort, switch, next - устанавливает поведение, если на удержании уже находится абонент.
abort - обрыв текущему и переключение на того кто на удержании
switch - возврат к тому, кто на удержании, с размещением текущего на удержании
next - обрыв текущему и переход сразу в набор номера
</pre>

-------------------------------------------------
<<< '''pbxmaketransfer'''

Запрос из CRM в Oktell на перевод текущего звонка. 
Если A соединен с B, и от А приходит команда трансфер(C), то абонента B переключает на C, а A в отбой. 
Если A соединен с B, а в это время во флеше/холде находится D, то абонента B переключает на C, а A соединяется с D. 
Если A ни с кем не соединен, то просто отбой в A.

<pre>
[
"pbxmaketransfer",
{
"qid": "DD836C5D-4F3E-4FD2-9B60-24E330B03FC6",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"transferto": "475"
}
]
</pre>
<pre>
//* transferto - номер, на который осуществить перевод.
</pre>

-------------------------------------------------
<<< '''pbxclearflash'''

Запрос из CRM в Oktell на обрыв линии, находящейся на удержании.

<pre>
[
"pbxclearflash",
{
"qid": "DD836C5D-4F3E-4FD2-9B60-24E330B03FC6",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''pbxfaxreceive'''

Запрос из CRM в Oktell на переключение в прием факса.

<pre>
[
"pbxfaxreceive",
{
"qid": "59305AD1-40A5-476A-B76D-2DAB1F2A89D3",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"linkmode": "simple"
}
]
</pre>
<pre>
//* linkmode - full, simple - устанавливает формат ссылок, в котором будут указаны полученные файлы
в событии об окончании приема.
full - вернуть абсолютную ссылку на скачивание через http.
simple - вернуть относительную ссылку на скачивание.
При формировании абсолютной ссылки в качестве доменного имени берется значение из
раздела [[Интеграция с WEB-Socket CRM]] общих настроек Oktell.
</pre>

<<< '''pbxfaxstop'''

Запрос из CRM в Oktell на прерывание приема/передачи факса.

<pre>
[
"pbxfaxstop",
{
"qid": "59305AD1-40A5-476A-B76D-2DAB1F2A89D3",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

-------------------------------------------------
<<< '''pbxdtmf'''

Запрос из CRM в Oktell на генерацию софт-DTMF.

<pre>
[
"pbxdtmf",
{
"qid": "DD836C5D-4F3E-4FD2-9B60-24E330B03FC6",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtmf": "#"
}
]
</pre>
<pre>
//* dtmf: цифры, *, #
</pre>

-------------------------------------------------
<<< '''pbxanswercall'''

Запрос из CRM в Oktell на снятие трубки при входящем звонке (с помощью изменения SIP-вызова на интерком).

<pre>
[
"pbxanswercall",
{
"qid": "DD836C5D-4F3E-4FD2-9B60-24E330B03FC6",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

-------------------------------------------------
<<< '''pbxinterceptcall'''

Запрос из CRM в Oktell на перехват вызова
<pre>
[
"pbxinterceptcall",
{
"qid": "DD836C5D-4F3E-4FD2-9B60-24E330B03FC6",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"number": "400"
}
]
</pre>
<pre>
//* number - внутренний номер, вызов на который необходимо перехватить. Если не задан, то перехват первого доступного из групповых.
</pre>

====Запросы к АТС общего характера====

-------------------------------------------------------------------
<<< '''exectmcall'''

Запрос из CRM в Oktell. Осуществляет размещение короткого задания на дозвон и соединение с указанным оператором (пользователем).
Дозвониться до одного из указанных абонентов-номеров группы A, соединить с одним из указанных абонентов-номеров группы B.
Результатом выполнения является одна коммутация.

Не требует указания пользователя.
Считается серверным методом, хотя может вызываться и по индивидуальному клиентскому каналу.

<pre>
[
"exectmcall",
{
"qid": "BE06A1E4-759A-4BFA-8D15-5FCF756EEE53",
"taskid": "qud82039lsdfmnasd",
"a_abonents": [
"7931289",
"83959279394",
"425",
"688C1DD6-7429-4B47-819D-C15827654A53",
{
"type": 11,
"key": "84951435565"
}
],
"b_abonents": [
"1211F58F-93AE-470C-895D-E3A163E8FF5F",
"ivanov",
"2BC51D79-BA63-47D7-93CA-1F283029C529",
{
"type": 12,
"key": "1211F58F-93AE-470C-895D-E3A163E8FF5F"
}
]
"mode": 0
}
]
</pre>
<pre>
[
"exectmcall",
{
"qid": "BE06A1E4-759A-4BFA-8D15-5FCF756EEE53",
"taskid": "qud82039lsdfmnasd",
"taskcode": "xxxxx",
"a_abonents": ["4952172020"],
"b_abonents": ["417"],
"mode": 0,
"ownertext": "Задача соединения",
"sessionid": "FB232E90-524A-453C-95BA-1B42251F5A14",
"projectid": "F95BA34E-2CE2-49FA-B3C2-4344199F5B42",
"a_callerid": "4959261589",
"a_music": "Фоновое воспроизведение для оператора",
"a_usequeue": false,
"a_queuepriority": 10,
"a_timeoutsec": 40,
"b_callerid": "4952172020",
"b_music": "?**ivr?Фоновое воспроизведение",
"b_usequeue": true,
"b_queuepriority": 5,
"b_timeoutsec": 40,
}
]
</pre>
<pre>
Обязательными параметрами являются только a_abonents и b_abonents. Остальные имеют значения по умолчанию.

//* taskid - уникальный строковый идентификатор задания.
Может быть не указан, тогда генерируется автоматически.
//* taskcode - пользовательский код задачи, передается в сценарии, обслуживающие дозвоны.
//* a_abonents - набор из одного или нескольких абонентов, относящихся к группе A.
//* b_abonents - набор из одного или нескольких абонентов, относящихся к группе B.
abonent:type - типы представления о конкретном абоненте
Undefined = 0, //Не определен, определить автоматически.
External = 11,//Внешний номер
InternalItem = 12,//Внутренний элемент - пользователь или линия,
задаются ключами (идентификатор, номер, логин, имя).
InternalRule = 13,//Стандартный внутренний номер
InternalFast = 14,//Быстрый номер
InternalEmergency = 15,//Экстренный номер
InternalIVR = 16,//Сценарий IVR
//* mode:
0 - вызывает сначала группу A (достает первого ответившего),
потом абонентов группы B (достает первого ответившего)
1 - вызывает сначала группу B (достает первого ответившего),
потом абонентов группы A (достает первого ответившего)
2 - вызывает одновременно всех, достает первого ответившего из группы A
и первого ответившего из группы B.
//* a_music, b_music - мелодия ожидания для абонентов группы A и B. Задается с помощью строки:
- ''?**ivr?scriptname'', где scriptname - название фонового медиа сценария IVR.
- ''?**ff?filepath'', где filepath - абсолютный путь к звуковому файлу (*.mp3 или *.wav).
- ''?**ff?folderpath'', где folderpath - абсолютный путь к каталогу со звуковыми файлами, выбираются рандомно.
- ''?**ff?filename'', где filename - название файла с расширением (*.mp3 или *.wav) в стандартном каталоге Snd.
- абсолютный путь к каталогу cо звуковыми файлами
- абсолютный путь к файлу
- название файла с расширением в стандартном каталоге Snd
- название фонового медиа-сценария IVR
- если не указывать, указывать неверно или указывать пустоту - играется
[[Музыкальное сопровождение#Alternative|альтернативная мелодия ожидания]] (возможно сценарий) из общих настроек
//* sessionid - генерируемый идентификатор цепочки коммутаций/сессии.
//* ownertext - название владельца служебного сценария набора номеров.
//* projectid - привязанный идентификатор проекта (участвует в поиске сценариев).
//* a_usequeue, b_usequeue: true|false. Использовать ли очередь ожидания при вызове внутренних абонентов.
//* a_queuepriority, b_queuepriority: числовой приоритет при размещении в очередях.
Традиционно чем меньше значение - тем больше приоритет.
Значения по умолчанию определены в [[Настройки менеджера очередей|общих настройках]]
//* a_timeoutsec, b_timeoutsec: таймаут в секундах для вызова абонентов соответствующей группы.
Режим использования таймаута задается в разделе [[Настройки менеджера очередей|настроек менеджера очередей]].
</pre>

>>> '''exectmcallresult'''

Ответ из Oktell в CRM. Возвращает результат исполнения хранимой процедуры в БД Oktell. Перечисляет все выходные наборы данных.

<pre>
[
"exectmcallresult",
{
"qid": "BE06A1E4-759A-4BFA-8D15-5FCF756EEE53",
"taskid": "qud82039lsdfmnasd"
}
]
</pre>
<pre>
//* taskid - возвращает идентификатор запущенного задания.
В дальнейшем с помощью него можно будет отменить задание (если оно еще не будет к тому времени исполнено)
</pre>

>>> '''exectmcallreport'''

Отчет о выполнении задания. Указывает код задания, и причину ошибки в случае неудачи.

<pre>
[
"exectmcallreport",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859",
"taskid": "qud82039lsdfmnasd",
"success": false,
"errorid": 21,
"errorstr": "CallAbonentFailure"
}
]
</pre>

-------------------------------------------------------------------
<<< '''stoptmcall'''

Запрос из CRM в Oktell. Отменяет ранее запущенное методом ''exectmcall'' задание, если оно еще не завершило исполнение.

Не требует указания пользователя.

<pre>
[
"stoptmcall",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859",
"taskid": "qud82039lsdfmnasd"
}
]
</pre>

>>> '''stoptmcallresult'''

Ответ от Oktell в CRM. Возвращает результат отмены задания.

<pre>
[
"stoptmcallresult",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859",
"taskid": "qud82039lsdfmnasd",
"success": false,
"errortext": "task not found"
}
]
</pre>

-------------------------------------------------------------------
<<< '''gettotalqueue'''

Запрос из CRM в Oktell на возврат информации обо всех очередях.
Может использоваться без указания пользователя.
Не рекомендуется к частому использованию, так как требует значительных вычислительных ресурсов.

<pre>
[
"gettotalqueue",
{
"qid": "DDDB5BCA-A200-448C-93C7-EFEAE5AFE48D",
"skipempty": true
}
]
</pre>

>>> '''gettotalqueueresultresult'''

Ответ из Oktell в CRM. Возвращает список всех очередей и их абонентов

<pre>
[
"gettotalqueueresult",
{
"qid": "DDDB5BCA-A200-448C-93C7-EFEAE5AFE48D",
"result": [
{
"numid": "507db30b-f8f7-46cf-b3c7-6b8ba7b696a8",
"numprefix": "12",
"ruleid": "6ffab1ac-7b9b-4ba2-8547-233175368b6d",
"rulename": "Денис"
"queue": [
{
"objectid": "928efda2-a3b3-423b-9d49-d2e76879c718",
"chainid": "d1c2b337-6293-4ea0-a355-f59caaeff54b",
"srcelementid": "38d8b6ad-a68b-4075-a1a3-038510f20a54",
"objecttype": 0,
"objecttypestr": "qotQueueLogic",
"queuesource": 1,
"queuesourcestr": "qsLineLogic",
"callerid": "14",
"calledid": "12",
"isuser": true,
"userid": "da803f01-ea77-40fa-bc9d-e2efb36fd5a8",
"userlogin": "Peter",
"username": "Петр Александрович",
"department": "Программисты",
"managedlineid": "38d8b6ad-a68b-4075-a1a3-038510f20a54",
"managedlinenumber": "16001",
"srclineid": "38d8b6ad-a68b-4075-a1a3-038510f20a54",
"srclinenumber": "16001",
"queuepriority": 9,
"startqueuetime": "2012-06-07 12:58:44",
"lenqueue": 1.4375,
"istask": false
}
]
},
...
{}
]
}
]
</pre>
<pre>
//* result - содержит список всех очередей. Очередь при этом содержится в словаре.
//* result:numid - идентификатор стандартного внутреннего номера, при котором данная очередь.
//* result:numprefix - стандартный внутреннего номер, при котором данная очередь.
//* result:ruleid - идентификатор номерного правила, при котором данная очередь.
//* result:rulename - название номерного правила, при котором данная очередь.
//* result:queue - список абонентов очереди в порядке убывания. Каждый абонент содержится в словаре.
</pre>

====Запуск служебного сценария====

-------------------------------------------------
<<< '''startsvcscript''',
'''execsvcscript'''

Запрос из CRM в Oktell на запуск служебного сценария. ''startsvcscript'' - от имени пользователя, ''execsvcscript'' - без указания пользователя от имени сервера.

<pre>
[
"startsvcscript",
{
"qid": "244E3867-470E-4A56-904D-D435D57CFBFE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"scriptname": "Служебный сценарий получения почты",
"startparam1": "значение параметра 1",
"startparam2": "значение параметра 2",
"startparam3": "значение параметра 3",
"startparam4": "значение параметра 4",
"startparam5": "значение параметра 5",
"waitresponse": true,
"waittimeoutsec": 10
}
]
</pre>
<pre>
[
"execsvcscript",
{
"qid": "244E3867-470E-4A56-904D-D435D57CFBFE",
"scriptname": "Служебный сценарий получения почты",
"startparam1": "значение параметра 1",
"startparam2": "значение параметра 2",
"startparam3": "значение параметра 3",
"startparam4": "значение параметра 4",
"startparam5": "значение параметра 5",
"waitresponse": true,
"waittimeoutsec": 10
}
]
</pre>
<pre>
//* scriptname - название сценария в общем разделе.
//* startparamN - строковое значение соответствующего параметра.
При необходимости передать больше параметров следует объединять параметры в одну строку
с использованием символа-разделителя, а в самом сценарии производить обратную операцию.
//* waitresponse - ожидать ли ответа.
//* waittimeoutsec - таймаут ожидания ответа в секундах. 0 - вечно.
</pre>

>>> '''startsvcscriptresult''',
'''execsvcscriptresult'''

Ответ Oktell на запрос запуска служебного сценария.

<pre>
[
"startsvcscriptresult",
{
"qid": "244E3867-470E-4A56-904D-D435D57CFBFE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"scriptname": "Служебный сценарий получения почты",
"result": 0,
"returnvalue": "присвоенный в сценарии результат",
"error": 10
}
]
</pre>
<pre>
[
"execsvcscriptresult",
{
"qid": "244E3867-470E-4A56-904D-D435D57CFBFE",
"scriptname": "Служебный сценарий получения почты",
"result": 0,
"returnvalue": "присвоенный в сценарии результат",
"error": 10
}
]
</pre>
<pre>
//* error: 10 - файл не найден, 11 - исключение, 12 - таймаут
//* returnvalue - возвращаемый результат сценария (если сценарий исполнился, и его завершения удалось дождаться)
</pre>

====Конференц-связь====

Запросы из CRM, ответы от Oktell, события из Oktell

---------------------------------------------
<<< '''confhandleevent'''

Запрос из CRM к Oktell. Подписка/отписка на указанную категорию событий сервера конференций.

<pre>
[
"confhandleevent",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"eventtype": "competitors",
"handle": true
}
]
</pre>
<pre>
//* eventtype - уровень глубины получаемых сообщений. conferences|competitors|userstates
предполагается, что в общем случае инфа идет только о списке конференций (conferences);
когда юзер находится в конференции - дополнительно о внутреннем состоянии конференции (competitors);
когда юзер настраивает конференцию и выбирает из списка участников для автоматического приглашения -
о состояниях всех пользователей (userstates).
Подписками управляет сам внешний модуль. Когда потребность уходит - необходимо отписываться,
чтобы не заваливать канал порожняком.
//* handle - true|false - подписаться/отписаться
</pre>

---------------------------------------------
<<< '''checkcanconnecttogathertoconference'''

Запрос из CRM к oktell. В момент коммутации, в случае если во флеш-буфере находится абонент, определяет, существует ли возможность переключиться всем вместе в конференцию единой командой. Это возможно, если один из абонентов - конференция, а другой - линия/пользователь.

<pre>
[
"checkcanconnecttogathertoconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''confcheckcanconnecttogatherresult'''

Ответ из Oktell в CRM на запрос возможности совместного переключения в конференцию.

<pre>
[
"confcheckcanconnecttogatherresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"canconnecttogather": true,
"inconference": false,
}
]
</pre>

---------------------------------------------
<<< '''connecttogathertoconference'''

Запрос из CRM к oktell. Производит совместное переключение текущего онлайн-абонента и флеш-абонента в существующую конференцию.

<pre>
[
"connecttogathertoconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

---------------------------------------------
<<< '''buildconferencefromcommutation'''

Запрос из CRM к oktell. Производит преобразование текущей коммутации в конференцию с двумя участниками.

<pre>
[
"buildconferencefromcommutation",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

---------------------------------------------
<<< '''attachasghost'''

Запрос из CRM к Oktell. Производит подключение к указанному каналу/пользователю на прослушку/помощь.

<pre>
[
"attachasghost",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"ghostedid": "FE9D6B52-C267-4D39-AC9F-81A0F44713FF",
"ghostedlogin": "Петров"
}
]
</pre>

>>> '''attachasghostresult'''

Ответ из Oktell в CRM на запрос о подключении к каналу на прослушку.

<pre>
[
"attachasghostresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 0,
"error": 52703
}
]
</pre>
<pre>
//* ghostedid - ид пользователя или линии, к которому подцепляться для прослушки
//* ghostedlogin - логин пользователя, к которому подцепляться для прослушки
</pre>

---------------------------------------------
<<< '''getconferences'''

Запрос из CRM в Oktell на возврат текущих активных конференц-сессий.

<pre>
[
"getconferences",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''getconferencesresult'''

Ответ из Oktell в CRM со списком текущих активных конференц-сессий.

<pre>
[
"getconferencesresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferencelist": [
{
"id": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"room": 884,
"name": "Планерка",
"description": "",
"accessmode": 11,
"accessmodestr": "Free",
"isselector": true,
"record": true,
"creatorid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"creatorlogin": "Иванов",
"creatorname": "Иван Иванович Иванов",
"directorid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"directorlogin": "Петров",
"directorname": "Петр Петрович Петров",
"timestart": "2011-04-03 17:58:22",
"canvieweachother": true,
"everyonecaninvite": true,
"recordrights": 2,
"recordrightsstr": "Competitors",
"isghost": false,
"ghostmode": 11,
"ghostmodestr": "Monitor"
},
{...},
{...}
]
}
]
</pre>

---------------------------------------------
<<< '''getconferencecompetitors'''

Запрос из CRM в Oktell на возврат текущих участников указанной конференции.

<pre>
[
"getconferencecompetitors",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "F16D26E3-2A78-49C2-AFCE-815611A16E22"
}
]
</pre>

>>> '''getconferencecompetitorsresult'''

Ответ из Oktell в CRM со списком текущих участников указанной в запросе конференции.

<pre>
[
"getconferencecompetitorsresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "F16D26E3-2A78-49C2-AFCE-815611A16E22",
"competitorlist": [
{
"competitorid": "65AC0E98-64DE-41CF-B609-D00A4C8B07FD",
"chainid": "91687102-E19F-466C-A0BE-B6C3EEF83EE7",
"sessionid": "91687102-E19F-466C-A0BE-B6C3EEF83EE7",
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"username": "Петр Петрович Петров",
"lineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"linenumber": "17004",
"number": "472",
"intnumber": "472",
"extnumber": "",
"confstate": 11,
"confstatestr": "OnlineTalking",
"wanttalk": false,
"isdirector": true,
"iscreator": false,
"isghost": false,
"isghostmajor": false,
"islifebuoy": false
},
{...},
{...}
]
}
]
</pre>

---------------------------------------------
<<< '''getusersforconferenceinvitelist'''

Запрос из CRM в Oktell на возврат возможных участников конференции (учетных записей всех пользователей системы с указанием их состояний и присутствия в других конференциях).

<pre>
[
"getusersforconferenceinvitelist",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''getusersforconferenceinvitelistresult'''

Ответ из Oktell в CRM со списком учетных записей, доступных для приглашения в конференцию с их текущими состояниями и присутствием в других конференциях.

<pre>
[
"getusersforconferenceinvitelistresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"possiblecompetitorlist": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"username": "Петр Петрович Петров",
"groupid": "F72C315A-F9EA-471E-A679-D4BA4797DB51",
"groupname": "Руководство"
"userstate": 5,
"userstatestr": "usFullbusy",
"isredirect": false,
"islunch": false,
"inconference": true,
"conferenceid": "F16D26E3-2A78-49C2-AFCE-815611A16E22",
"confstate": 11,
"confstatestr": "OnlineTalking"
},
{...},
{...}
],
"result": 1
}
]
</pre>

---------------------------------------------
<<< '''createnewconference'''

Запрос из CRM в Oktell на создание новой конференции. Указывает параметры самой конференц-сессии, список участников для приглашения на старте.

<pre>
[
"createnewconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conference": {
"id": "17A3F9D2-040C-471B-A4F5-6A13BEB27667",
"room": 578
"name": "Совещание с заказчиком",
"description": "",
"accessmode": "free",
"isselector": true,
"record": true,
"recordrights": "selected",
"everyonecaninvite": true,
"canvieweachother": true
},
"competitors": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"lineid": "F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"intnumber": "472",
"extnumber": "89047289889",
"cantalk": true
},
{...},
{...}
],
"recordusers": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
},
{...},
{...}
]
}
]
</pre>
<pre>
//* conference:accessmode - free|shared|closed (свободный вход, вход по запросу, вход запрещен)
//* conference:recordrights - director|competitors|selected (только управляющий, все участники, избранные участники)
Определяет, кто может прослушивать запись конференции.
//* competitors - список автоматически приглашаемых участников. Допускается/следует указывать только один
параметр из набора {userid|userlogin, lineid, intnumber, extnumber}
//* список recordusers следует указывать, если conference:recordrights=selected.
</pre>

>>> '''createnewconferenceresult'''

Ответ из Oktell в CRM с результатом исполнения команды на создание конференции.

<pre>
[
"createnewconferenceresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 0,
"error": 1,
"errormsg": "alreadyexists",
}
]
</pre>

---------------------------------------------
<<< '''setupexistingconference'''

Запрос из CRM в Oktell от имени управляющего конференции на изменение параметров указанной конференции.

<pre>
[
"setupexistingconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conference": {
"id": "17A3F9D2-040C-471B-A4F5-6A13BEB27667",
"room": 578
"name": "Совещание с заказчиком",
"description": "",
"accessmode": "free",
"isselector": true,
"recordrights": "selected",
"everyonecaninvite": true,
"canvieweachother": true,
"ghostmode": "monitor"
},
"recordusers": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
},
{...},
{...}
]
}
]
</pre>

>>> '''setupexistingconferenceresult'''

Ответ из Oktell в CRM с результатом исполнения команды на изменение параметров конференции.

<pre>
[
"setupexistingconferenceresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 0,
"error": 1,
"errormsg": "notfound",
}
]
</pre>
<pre>
//* conference:accessmode - free|shared|closed
//* conference:recordrights - director|competitors|selected
//* conference:ghostmode - monitor|help|talk
//* список recordusers имеет смысл только когда conference:recordrights=selected.
</pre>

---------------------------------------------
<<< '''getconferenceinfo'''

Запрос из CRM в Oktell на возврат текущих параметров указанной конференции.

<pre>
[
"getconferenceinfo",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3"
}
]
</pre>

>>> '''getconferenceinforesult'''

Ответ из Oktell в CRM. Возвращает текущие настройки указанной в запросе конференции, текущих ее участников и их состояния.

<pre>
[
"getconferenceinforesult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"conference": {
"id": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"room": 884,
"name": "Планерка",
"description": "",
"accessmode": 11,
"accessmodestr": "Free",
"isselector": true,
"record": true,
"creatorid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"creatorlogin": "Иванов",
"creatorname": "Иван Иванович Иванов",
"directorid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"directorlogin": "Петров",
"directorname": "Петр Петрович Петров",
"timestart": "2011-04-03 17:58:22",
"canvieweachother": true,
"everyonecaninvite": true,
"recordrights": 2,
"recordrightsstr": "Competitors",
"isghost": false,
"ghostmode": 11,
"ghostmodestr": "Monitor"
},
"competitors": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"lineid": "F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"intnumber": "472",
"extnumber": "89047289889",
"cantalk": true
},
{...},
{...}
],
"recordusers": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
},
{...},
{...}
]
}
]
</pre>

---------------------------------------------
<<< '''stopconference'''

Запрос из CRM в Oktell от имени управляющего конференции на прекращение указанной конференции.

<pre>
[
"stopconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3"
}
]
</pre>

>>> '''stopconferenceresult'''

Ответ из Oktell в CRM с результатом выполнения запроса на прекращение указанной конференции.

<pre>
[
"stopconferenceresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 0,
"error": 1,
"errormsg": "accessdenied"
}
]
</pre>

---------------------------------------------
<<< '''confsetvoiceparams'''

Запрос из CRM в Oktell от имени управляющего конференции на изменение голосовых свойств канала указанного участника указанной конференции.

<pre>
[
"confsetvoiceparams",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"competitor": {
"competitorid": "249995A5-8A64-49CC-87CA-D797FCFB7782",
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"lineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"cantalk": true,
"canlisten": true,
"ghosthelp": false
}
}
]
</pre>
<pre>
//* competitor - указывает на одного участника конференции.
/ достаточно/следует указывать только один из набора определяющих участника идентификаторов
{competitorid, userid|userlogin, lineid}

//* competitor:cantalk - может ли говорить
//* competitor:canlisten - может ли слышать
//* competitor:ghosthelp - в режиме прослушки:помощи для одного из подслушиваемых каналов -
может ли слышать подключившегося супервизора
</pre>

>>> '''confsetvoiceparamsresult'''

Ответ из Oktell в CRM с результатом выполнения запроса на изменение голосовых свойств канала.

<pre>
[
"confsetvoiceparamsresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 0,
"error": 1,
"errormsg": "accessdenied"
}
]
</pre>

---------------------------------------------
<<< '''confsetwanttalk'''

Запрос из CRM в Oktell от имени простого бесправного участника селекторного совещания на взятие голоса (сообщение для управляющего).

<pre>
[
"confsetwanttalk",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"wanttalk": true
}
]
</pre>

>>> '''confsetwanttalkresult'''

Ответ из Oktell в CRM с результатом выполнения запроса на взятие голоса.

<pre>
[
"confsetwanttalkresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 1
}
]
</pre>

---------------------------------------------
<<< '''confsetghostmode'''

Запрос из CRM в Oktell от имени прослушивающего супервизора на изменение режима конференц-помощи.

<pre>
[
"confsetghostmode",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"ghostmode": "help",
}
]
</pre>
<pre>
//* ghostmode - monitor, help, conference (подслушивание, помощь, конференция)
</pre>

>>> '''confsetghostmoderesult'''

Ответ из Oktell в CRM с результатом выполнения запроса на изменение режима конференц-помощи.

<pre>
[
"confsetghostmoderesult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 1
}
]
</pre>

---------------------------------------------
<<< '''exitconference'''

Запрос из CRM в Oktell на вывод авторизованного пользователя из конференции. В канал подается отбой. Альтернативой является положение трубки на телефоне.

<pre>
[
"exitconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3"
}
]
</pre>

>>> '''exitconferenceresult'''

Ответ из Oktell в CRM с результатом выполнения запроса на выход из конференции.

<pre>
[
"exitconferenceresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 1
}
]
</pre>

---------------------------------------------
<<< '''confdisconnectcompetitor'''

Запрос из CRM в Oktell от имени управляющего конференцией на вывод из конференции указанного участника.

<pre>
[
"confdisconnectcompetitor",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"competitor": {
"competitorid": "249995A5-8A64-49CC-87CA-D797FCFB7782",
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"lineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
}
}
]
</pre>
<pre>
//* competitor - указывает на одного участника конференции.
/ достаточно/следует указывать только один из набора определяющих участника идентификаторов
{competitorid, userid|userlogin, lineid}
</pre>

>>> '''confdisconnectcompetitorresult'''

Ответ из Oktell в CRM с результатом выполнения запроса на вывод указанного в запросе участника.

<pre>
[
"confdisconnectcompetitorresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 1
}
]
</pre>

---------------------------------------------
<<< '''enterconference'''

Запрос из CRM в Oktell на вход в конференцию. При необходимости осуществляет запрос на вход у управляющего. Прерывание может производиться командой exitconference
<pre>
[
"enterconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3"
}
]
</pre>

>>> '''enterconferenceresult'''

Ответ из Oktell в CRM с результатом выполнения запроса на вход в конференцию.

<pre>
[
"enterconferenceresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 1
}
]
</pre>

---------------------------------------------
<<< '''confdisconnectcompetitor'''

Запрос-команда из CRM в Oktell от имени управляющего конференцией на разрешение/запрет входа в конференцию указанному участнику, ранее запросившему право входа.

<pre>
[
"confpermitdenyentrance",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"competitor": {
"competitorid": "249995A5-8A64-49CC-87CA-D797FCFB7782",
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"lineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"permit": true
}
}
]
</pre>
<pre>
//* competitor - указывает на одного участника конференции.
/ достаточно/следует указывать только один из набора определяющих участника идентификаторов
{competitorid, userid|userlogin, lineid}
</pre>

>>> '''confpermitdenyentranceresult'''

Ответ из Oktell в CRM с результатом выполнения запроса на разрешение/запрет входа в конференцию участнику.

<pre>
[
"confpermitdenyentranceresult",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 1
}
]
</pre>

---------------------------------------------
<<< '''invitetoconference'''

Запрос из CRM в Oktell от имени управляющего конференцией или любого другого участника на приглашение в конференцию стороннего абонента (пользователя, линию, абонента по внутреннему/внешнему номеру).

<pre>
[
"invitetoconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"competitors": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"lineid": "F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"intnumber": "472",
"extnumber": "89047289889",
"cantalk": true
},
{...},
{...}
]
}
]
</pre>
<pre>
//* competitors - список автоматически приглашаемых участников. Допускается/следует указывать только один
параметр из набора {userid|userlogin, lineid, intnumber, extnumber}
</pre>

>>> '''invitetoconference'''

Ответ из Oktell в CRM с результатом выполнения запроса на приглашение нового участника конференции.

<pre>
[
"invitetoconference",
{
"qid": "4F78270D-B35F-48A9-B88A-557B1AA97A1B",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"conferenceid": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"result": 1
}
]
</pre>

====События из Oktell, касающиеся конференций====

---------------------------------------------
>>> '''conflistchanged'''

Событие из Oktell в CRM об изменении списка текущих активных конференций.

<pre>
[
"conflistchanged",
{
"qid": "2A6380B4-ADD4-4CD3-9A5C-9483A3B3723A",
"conferencelist": [
{
"id": "519C0DDA-8DDF-4212-9AE1-9E4047AB4BE3",
"room": 884,
"name": "Планерка",
"description": "",
"accessmode": 11,
"accessmodestr": "Free",
"isselector": true,
"record": true,
"creatorid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"creatorlogin": "Иванов",
"creatorname": "Иван Иванович Иванов",
"directorid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"directorlogin": "Петров",
"directorname": "Петр Петрович Петров",
"timestart": "2011-04-03 17:58:22",
"canvieweachother": true,
"everyonecaninvite": true,
"recordrights": 2,
"recordrightsstr": "Competitors",
"isghost": false,
"ghostmode": 11,
"ghostmodestr": "Monitor"
},
{...},
{...}
]
}
]
</pre>

---------------------------------------------
>>> '''"conf***"'''

Другие событие из Oktell в CRM об изменениях на сервере конференций. Общий список возможных событий приведен ниже.

<pre>
[
"conf***",
{
"qid": "2A6380B4-ADD4-4CD3-9A5C-9483A3B3723A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"eventinfo": {
***
}
}
]
</pre>
<pre>
//* conflistchanged,
//* confparamschanged,
//* confcompositionchanged,
//* confcompetitorstatechanged,
//* confentrancedenied,
//* confentrancepermitted,
//* confentrancerequest,
//* confnotifyinvite,
//* confpossiblecompetitorstatechanged
</pre>

====Состояния пользователей и линий====

-------------------------------------------------
>>> '''userstatechanged'''

Сообщение из Oktell в CRM о смене состояния пользователя в Oktell. Отправляется на имя пользователя, чье состояние сменилось. Отправляется как результат запроса на смену состояния или независимо.

<pre>
[
"userstatechanged",
{
"qid": "66F8D479-0234-47DF-B043-3A065FF464A7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"userstateid": 2,
"onredirect": true,
"onlunch": false,
"oncallcenter": false,
"onccmanual": false
}
]
</pre>

-------------------------------------------------
<<< '''setuserstate'''

Запрос из CRM к Oktell на смену состояния пользователя от его имени. При проведении изменений в ответ отправляется сообщение userstatechanged.

Для изменения только одного из параметров состояния можно остальные не указывать (например оставлять только oncallcenter).

<pre>
[
"setuserstate",
{
"qid": "2A45010A-8EEA-4876-90CB-F062459D4BE2",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"userstateid": 2,
"onredirect": false,
"onlunch": false,
"oncallcenter": false,
"onccmanual": false,
"lunchreasonid": 120,
"lunchreasonmsg": ""
}
]
</pre>
<pre>
//* lunchreasonid и lunchreasonmsg - расширение для будущей статистики, устанавливают причину перерыва.
id - если причина одна из стандартных. msg - если что-то уникальное юзер ввел.
userstateid:
1 - Готов
2 - Перерыв
3 - Отсутствует
5 - Занят
</pre>

-------------------------------------------------------------------
<<< '''getuserstate'''

Запрос из CRM в Oktell состояния указанного пользователя системы.

<pre>
[
"getuserstate",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''getuserstateresult'''

Ответ из Oktell в CRM с полным состоянием указанного в запросе пользователя системы.
<pre>
[
"getuserstateresult",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"userstate": 5,
"userstateid": 5,
"userstatestr": "usFullbusy",
"onredirect": true,
"onlunch": false,
"oncallcenter": false,
"onccmanual": false
}
]
</pre>

-------------------------------------------------------------------
<<< '''checkuserintask'''

Запрос из CRM в Oktell о присутствии указанного пользователя в задачах call-центра.

<pre>
[
"checkuserintask",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''checkuserintaskresult'''

Ответ из Oktell в CRM с ответом на запрос присутствия указанного в запросе пользователя в задачах колл-центра. Описание задачи в случае положительного ответа.

<pre>
[
"checkuserintaskresult",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"intask": true,
"task": {,
"id": "1D565B41-1D16-46DE-B2C5-CF55ED5279F0",
"name": "Исходящий обзвон",
"code": "af-2329",
"direction": "outgoing",
"contacttype": 0,
"contacttypestr": "Call",
"projectid": "E6ADBA0D-C9FF-40F2-96FF-6D2F455F9D5A"
}
}
]
</pre>

-------------------------------------------------------------------
<<< '''getmyuserinfo'''

Запрос из CRM в Oktell на получение информации о текущем авторизованном пользователе: имя, внутренний номер, номер и идентификатор линии.

<pre>
[
"getmyuserinfo",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''getmyuserinforesult'''

Ответ из Oktell в CRM с ответом на запрос информации о текущем авторизованном пользователе.

<pre>
[
"getmyuserinforesult",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"username": "Иванов Иван Иванович",
"mainpbxnumber": "471",
"hasline": 1,
"lineid": "267F8F36-4713-4B66-81BD-019512E56E7E",
"linenumber": "17374",
"isoperator": true
}
]
</pre>

-------------------------------------------------------------------
<<< '''getuserphoto'''

Запрос из CRM в Oktell о текущем изображении (аватарке) указанного пользователя. Можно указывать только логин (''photoownerlogin'') или только идентификатор (''photoownerid'') интересующего пользователя.

<pre>
[
"getuserphoto",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"photoownerlogin": "Петров",
"photoownerid": "3F140170-AEEF-4621-AF9D-247116AE1411"
"mode": "link"
}
]
</pre>
<pre>
//* mode - link, page, data. По умолчанию page.
link - вернуть абсолютную ссылку на скачивание через http.
page - вернуть относительную ссылку на скачивание.
вернуть данные изображения в base64.
При формировании абсолютной ссылки в качестве доменного имени берется значение из
раздела [[Интеграция с WEB-Socket CRM]] общих настроек Oktell.
//* photoownerlogin, photoownerid - логин и/или идентификатор пользователя, чья аватарка требуется
Может не указываться, тогда будет возвращена аватарка авторизованного пользователя.
</pre>

>>> '''getuserphotoresult'''

Ответ из Oktell в CRM с ответом на запрос информации о текущем авторизованном пользователе.

<pre>
[
"getuserphotoresult",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"link": "http://..."
"link32": "http://..."
"link96": "http://..."
}
}
]
</pre>
<pre>
//* result. В случае отсутствия файла или по любой другой причине неудачи описание неудачи
будет находиться в поле errormsg. Например "File not found".
//* imagedatab64. В случае возврата целиком изображения, оно будет в base64 строке содержаться в поле.
//* link, link32, link96. В случае возврата ссылки на изображение в полях лежат соответственно
ссылки на полное изображение, 32х32- и 96x96- пиксельные образы.
</pre>

-------------------------------------------------------------------
<<< '''getalluserphotolink'''

Запрос из CRM в Oktell на получение ссылок на текущие изображения (аватарки) всех пользователей системы.

<pre>
[
"getalluserphotolink",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"mode": "link"
}
]
</pre>
<pre>
//* mode - link, page. По умолчанию page.
link - вернуть абсолютную ссылку на скачивание через http.
page - вернуть относительную ссылку на скачивание.
При формировании абсолютной ссылки в качестве доменного имени берется значение из
раздела [[Интеграция с WEB-Socket CRM]] общих настроек Oktell.
</pre>

>>> '''getalluserphotolinkresult'''

Ответ из Oktell в CRM с ответом на запрос ссылкок на текущие изображения (аватарки) всех пользователей системы.

<pre>
[
"getalluserphotolinkresult",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"links": [
{
"userid": "C6036E73-FB90-4F0C-B780-81CE5659BFEA",
"userlogin": "Сидоров",
"link": "http://...",
"link32x32": "http://...",
"link96x96": "http://...",
},
...
]
}
]
</pre>
<pre>
//* result. Если в наборе есть хотя бы одна аватарка, будет содержать 1. Иначе 0.
//* links. Содержит набор пользовательских словарей, в каждом из которых идентификатор,
логин и набор ссылок link, link32, link96. В полях лежат соответственно
ссылки на полное изображение, 32х32- и 96x96- пиксельные образы.
</pre>

-------------------------------------------------------------------
<<< '''setmyuserphoto'''

Запрос из CRM в Oktell на установку нового изображения (аватарки) текущего пользователя.

<pre>
[
"setmyuserphoto",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"filepath": "",
"imagedatab64": "",
"filename": ""
}
]
</pre>
<pre>
//* filepath - если файл уже на сервере где-то, то это путь к нему -
относительный рабочего каталога, относительный файлового хранилища, или абсолютный.
Допускается устанавливать в качестве аватарки изображения размером не более 1 MБ.
либо
//* imagedatab64 и filename - если файл целиком прокачивается через веб-сокет, то тут base64 строка
с образом файла.

//* если не указано ни filepath, ни imagedatab64, ни filename - стирает текущую аватарку.
</pre>

>>> '''setmyuserphotoresult'''

Ответ из Oktell в CRM с ответом на запрос информации о текущем авторизованном пользователе.

<pre>
[
"setmyuserphotoresult",
{
"qid": "0DD06DFF-E7C7-431B-BC29-920EAC81F76F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1
}
}
]
</pre>
<pre>
//* result. В случае отсутствия файла или по любой другой причине неудачи описание неудачи
будет находиться в поле errormsg. Например "File not found".
</pre>

-------------------------------------------------------------------
<<< '''changepassword'''

Запрос из CRM в Oktell на изменение пароля текущего авторизованного пользователя.
В версиях 2.7 пароль в нижнем регистре, в версиях 2.8 пароль без изменения регистра.

<pre>
[
"changepassword",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"newpwdmd5": "",
"oldpwdmd5": ""
}
]
</pre>
<pre>
//* oldpwdmd5 - MD5 текущего пароля.
//* newpwdmd5 - MD5 нового пароля.
</pre>

>>> '''changepasswordresult'''

Ответ от Oktell в CRM о результате изменения пароля.

<pre>
[
"changepasswordresult",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 0,
"errormsg": "password should be md5 string"
}
]
</pre>

-------------------------------------------------------------------
<<< '''getcurrentlinestate'''

Запрос из CRM в Oktell состояния телефонной линии указанного пользователя.

<pre>
[
"getcurrentlinestate",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''getcurrentlinestateresult'''

Ответ из Oktell в CRM с полным состоянием телефонной линии указанного в запросе пользователя системы.
<pre>
[
"getcurrentlinestateresult",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"hasline": true,
"lineid": "866692FC-DA08-459D-BAA1-428F9BA6A0D1",
"linenumber": "17012",
"linetype": 5,
"linetypestr": "ltIntIP",
"linestate": 32,
"linestatestr": "lsCommutated"
}
]
</pre>

-------------------------------------------------------------------
<<< '''getcurrentqueue'''

Запрос из CRM в Oktell состояния очереди указанного пользователя.

<pre>
[
"getcurrentqueue",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''getcurrentqueueresult'''

Ответ из Oktell в CRM с состоянием очереди указанного в запросе пользователя системы.
<pre>
[
"getcurrentqueueresult",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"queue": [
{
"objectid": "723114EE-2ABF-4806-9BC6-FBB532C31B44",
"objecttype": 0,
"objecttypestr": "qotQueueLogic",
"queuesource": 1,
"queuesourcestr": "qsLineLogic",
"queuepriority": 9,
"srcelementid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"srclineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"srclinenumber": "17004",
"startqueuetime": "2011-04-05 15:02:28",
"lenqueue": 72,
"managedlineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"managedlinenumber": "17004",
"callerid": "472",
"calledid": "479",
"isuser": true,
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"username": "Петр Петрович Петров",
"department": "Руководство",
"chainid": "02B99AD3-C954-4FD3-B07D-DFEDD83C0BF5",
"istask": true,
"taskid": "95575C37-5FDE-412C-8F42-36D55B1EC6BB",
"taskname": "Входящая кампания",
"taskdirection": "incoming",
"tasklistid": "7D9A3E9C-0AD3-4C68-BC02-4EBFE3684507",
"tasklistinfo": [
{
"key": "Название организации",
"value": "ООО МДГХ"
},
{...},
{...}
]
},
{...},
{...}
]
}
]
</pre>

-------------------------------------------------------------------
<<< '''getcallingoutabonentinfo'''

Запрос из CRM в Oktell на возврат информации об абоненте, которому осуществляется исходящий вызов от имени указанного пользователя.

<pre>
[
"getcallingoutabonentinfo",
{
"qid": "AF4B98AA-51D8-4944-B10C-04B0DE1E1BBC",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''getcallingoutabonentinforesult'''

Ответ из Oktell в CRM. Возвращает информацию об абоненте, которому осуществляется исходящий вызов от имени указанного в запросе пользователя.

<pre>
[
"getcallingoutabonentinforesult",
{
"qid": "AF4B98AA-51D8-4944-B10C-04B0DE1E1BBC",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "19ADB2C3-A0B5-47AB-AB2C-CBE15CF98968",
"number": "89032728973",
"name": "",
"lineid": "98F670D2-20E2-4883-B45E-42CDE1F3365F",
"linenumber": "13005"
}
]
</pre>

-------------------------------------------------------------------
<<< '''getflashedabonentinfo'''

Запрос из CRM в Oktell на возврат информации об абоненте, находящемся на удержании.

<pre>
[
"getflashedabonentinfo",
{
"qid": "DC35D182-8BAB-4DE4-919C-5F79090D92DE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''getflashedabonentinforesult'''

Ответ из Oktell в CRM. Возвращает информацию об абоненте, находящемся на удержании

<pre>
[
"getflashedabonentinforesult",
{
"qid": "DC35D182-8BAB-4DE4-919C-5F79090D92DE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"containsflashed": 1,
"abonent": {
"chainid": "19ADB2C3-A0B5-47AB-AB2C-CBE15CF98968",
"isconference": 0,
"conferenceid": "0D2A4CA1-FF17-473B-A5E9-E035CB16E257",
"conferenceroom": "#124",
"conferencename": "Планерка",
"conferencedescription": "",
"name": "",
"comment": "",
"description": "",
"simplename": "",
"number": "89032728973",
"lineid": "98F670D2-20E2-4883-B45E-42CDE1F3365F",
"linenumber": "13005",
"userid": "",
"userlogin": "",
"username": ""
}
}
]
</pre>

-------------------------------------------------------------------
<<< '''getextendedlineinfo'''

Запрос из CRM в Oktell на возврат расширенной информации о текущей линии и ее оппозитных абонентах: текущее состояние, информация об абоненте в коммутации, информация об абоненте на удержании.

<pre>
[
"getextendedlineinfo",
{
"qid": "55D54351-651E-4EC2-8E48-1D5136811FB9",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''getextendedlineinforesult'''

Ответ из Oktell в CRM. Возвращает информацию о текущей линии и ее оппозитных абонентах

<pre>
[
"getextendedlineinforesult",
{
"qid": "55D54351-651E-4EC2-8E48-1D5136811FB9",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"linestateid": 5,
"linestatestr": "lsCommutated,
"chainid": "19ADB2C3-A0B5-47AB-AB2C-CBE15CF98968",
"datetimeformat" = "dd.MM.yyyy HH:mm:ss",
"activetimestart" = "01.12.2011 16:59:28",
"abonent": {
"isconference": false,
"conferenceid": "0D2A4CA1-FF17-473B-A5E9-E035CB16E257",
"conferenceroom": "#124",
"conferencename": "Планерка",
"conferencedescription": "",
"iscommutated": false,
"iswaitingfaxline": false,
"iswaitinginflash": false,
"iswaitingforanswer": false,
"number": "",
"name": "",
"description": "",
"userid": "",
"userlogin": "",
"username": "",
"comment": "",
"simplename": "",
"lineid": "",
"linenumber": "",
"isextline": false,
"iswaitingforanswer": false,
"extnumber": "",
"queuesourceid": 1,
"queuesourcestr": "",
"isivr": false,
"ivrname": "",
"isroutingivr": false,
"ismediaivr": false,
"isrestartivr": false,
"isautocall": false,
"number": "",
"isringing": false,
"ringtimesec": 172,
"isconference": false,
"conferenceid": "",
"conferencename": "",
"conferenceroom": "",
"conferencedescription": "",
"inviteruserid": "",
"inviterusername": "",
"inviteruserlogin": "",
"number": "",
"name": "",
"comment": "",
"description": "",
"direction": "",
"isextline": true,
"istask": false,
"taskid": "",
"taskname": "",
"userid": "",
"userlogin": "",
"username": "",
"lineid": "",
"linenumber": ""
}
"isflashing": true,
"flashed": {
"isconference": true,
"conferenceid": "0D2A4CA1-FF17-473B-A5E9-E035CB16E257",
"conferenceroom": "#124",
"conferencename": "Планерка",
"conferencedescription": "",
"number": "",
"name": "",
"description": "",
"userid": "",
"userlogin": "",
"username": "",
"comment": "",
"simplename": "",
"lineid": "",
"linenumber": "",
"isextline": false
}
}
]
</pre>
<pre>
//* С отступом в примере указаны поля, появляющиеся в случае, если базовое булево поле имеет значение true.
// Например, если isringing=true, то указанные с отступом поля будут присутствовать и представлять собой
// информацию об абоненте, осуществляющем вызов текущего канала.
</pre>

====Управление переадресацией====

-------------------------------------------------------------------
<<< '''getredirectrules'''

Запрос из CRM в Oktell на возврат списка правил переадресации для текущего пользователя с их настройками.

<pre>
[
"getredirectrules",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''getredirectrulesresult'''

Ответ из Oktell в CRM. Возвращает список правил переадресации для текущего пользователя с их настройками.

<pre>
[
"getredirectrulesresult",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"redirectrules": [
{
"id": "5FD3120D-E86B-4F4B-B57C-AC32343CD00F",
"caption": "Постоянное",
"description": "Действует всегда, когда я в состоянии переадресации",
"priority": 1,
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"isenabled": true,
"allowcascade": true,
"state": 2,
"statestr": "Active",
"destinationnumber": "89050213951",
"onlyforredirectstate": true,
"definesources": true,
"sources": [
{
"type": 0,
"typestr": "ExtNumber",
"description": "",
"srcnumber": "4959741589",
"srcid": ""
},
...
],
"defineschedule": true,
"tformat": "HH:mm:ss",
"schedule": [
{
"weekday": 0,
"weekdaystr": "Sunday",
"tstart": "00:00:00",
"tstop": "23:59:59",
},
...
]
},
...
]
}
]
</pre>
<pre>
//* state: disabled=0, enabled=1, active=2
//* defineschedule - если false, значит активно всегда
//* definesources - если false, значит для всех номеров
//* sourcetype - extnumber=0, user=1, client=3, clientgroup=4.
Если номер - то указывается scrnumber, иначе srcid
</pre>

-------------------------------------------------------------------
<<< '''saveredirectrules'''

Запрос из CRM в Oktell. Сохраняет новое/измененное правило переадресации для текущего пользователя.

<pre>
[
"saveredirectrules",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"redirectrules": [
{
"id": "5FD3120D-E86B-4F4B-B57C-AC32343CD00F",
"caption": "Постоянное",
"description": "Действует всегда, когда я в состоянии переадресации",
"priority": 1,
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"isenabled": true,
"allowcascade": true,
"destinationnumber": "89050213951",
"onlyforredirectstate": true,
"definesources": true,
"sources": [
{
"type": 0,
"typestr": "ExtNumber",
"description": "",
"srcnumber": "4959741589",
"srcid": ""
},
...
],
"defineschedule": true,
"tformat": "HH:mm:ss",
"schedule": [
{
"weekday": 0,
"weekdaystr": "Sunday",
"tstart": "00:00:00",
"tstop": "23:59:59",
},
...
]
},
...
]
}
]
</pre>
<pre>
//* state: disabled=0, enabled=1, active=2
//* defineschedule - если false, значит активно всегда
//* definesources - если false, значит для всех номеров
//* sourcetype - extnumber=0, user=1, client=3, clientgroup=4. Если номер - то указывается scrnumber, иначе srcid
</pre>

>>> '''saveredirectrulesresult'''

Ответ из Oktell в CRM. Возвращает список правил переадресации для текущего пользователя с их настройками.

<pre>
[
"saveredirectrulesresult",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1
}
]
</pre>

-------------------------------------------------------------------
<<< '''deleteredirectrules'''

Запрос из CRM в Oktell. Удаляет указанные правила переадресации для текущего пользователя.

<pre>
[
"deleteredirectrules",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
"ids": [
"5FD3120D-E86B-4F4B-B57C-AC32343CD00F",
...
]
}
]
</pre>

>>> '''deleteredirectrulesresult'''

Ответ из Oktell в CRM. Ничего не возвращает, кроме факта выполнения запроса на удаление правил переадресации.

<pre>
[
"deleteredirectrulesresult",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

-------------------------------------------------------------------
<<< '''setredirectruleenabled'''

Запрос из CRM в Oktell. Включает/выключает указанные правила переадресации.

<pre>
[
"setredirectruleenabled",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
"id": "5FD3120D-E86B-4F4B-B57C-AC32343CD00F",
"enabled": true
}
]
</pre>

>>> '''setredirectruleenabledresult'''

Ответ из Oktell в CRM. Ничего не возвращает, кроме факта выполнения запроса на включение/выключения указанных правил переадресации.

<pre>
[
"setredirectruleenabledresult",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

====Контент звонка====

-------------------------------------------------------------------
<<< '''getchaincontent'''

Запрос из CRM в Oktell на возврат контента текущей сессии, в которой участвует линия указанного пользователя. Кто инициировал звонок, когда, с кем коммутировался, кто переключал, куда, на кого, когда, были ли комментарии какие-то установлены в контент...

<pre>
[
"getchaincontent",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
}
]
</pre>

>>> '''getchaincontentresult'''

Ответ из Oktell в CRM с контентом текущей сессии указанного в запросе пользователя.
<pre>
[
"getchaincontentresult",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "19ADB2C3-A0B5-47AB-AB2C-CBE15CF98968",
"result": 1,
"content": {
"chainid": "19ADB2C3-A0B5-47AB-AB2C-CBE15CF98968",
"createtime": "2011-04-06 20:38:41",
"customfield": "трололололо",
"trace": [
{
"contentelementtype": "call",
"pbxdirection": "internal",
"objectid": "723114EE-2ABF-4806-9BC6-FBB532C31B44",
"objecttype": 0,
"objecttypestr": "qotQueueLogic",
"queuesource": 5,
"queuesourcestr": "qsIncomingTask",
"queuepriority": 7,
"srcelementid": "98F670D2-20E2-4883-B45E-42CDE1F3365F",
"srclineid": "98F670D2-20E2-4883-B45E-42CDE1F3365F",
"srclinenumber": "13005",
"startqueuetime": "2011-04-06 20:38:41",
"managedlineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"managedlinenumber": "17004",
"callerid": "89048928835",
"calledid": "4959211586",
"isuser": false,
"department": "",
"istask": true,
"taskid": "95575C37-5FDE-412C-8F42-36D55B1EC6BB",
"taskname": "Входящая кампания",
"taskdirection": "incoming",
"tasklistid": "7D9A3E9C-0AD3-4C68-BC02-4EBFE3684507",
"tasklistinfo": [
{
"key": "Название организации",
"value": "ООО МДГХ"
}
]
},
{
"contentelementtype": "commutation",
"commutationid": "58D76504-DA2D-42C2-9016-1089A94DC1BF",
"timestart": "2011-04-06 20:40:01",
"timeanswer": "2011-04-06 20:40:04",
"connectiontype": 5,
"connectiontypestr": "ctOuterInner",
"isrecorded": true,
"customfield": "траляляляля",
"alineid": "98F670D2-20E2-4883-B45E-42CDE1F3365F",
"alinenumber": "13005",
"anumberdialed": "4959211586",
"aoutnumber": "89048928835",
"aisuser": false,
"atext": "ООО «СДЗЦ» (89048928835)",
"blineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"blinenumber": "17004",
"bnumberdialed": "",
"boutnumber": "472",
"bisuser": true,
"buserid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"buserlogin": "Петров",
"busername": "Петр Петрович Петров",
"btext": "Петр Петрович Петров",
"timestop": "2011-04-06 20:42:12",
"length": 128.32,
"stopside": "a",
"stopreason": 2,
"stopreasonstr": "scrAbonentHangOff"
},
{...},
{...}
]
}
}
]
</pre>
<pre>
* trace:contentelementtype:
</pre>

-------------------------------------------------------------------
<<< '''setchaincontentcustomfield'''

Запрос из CRM в Oktell на установку комментария в контент текущей сессии, в которой участвует канал указанного пользователя.

<pre>
[
"setchaincontentcustomfield",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"customfield": "фывафыдвлаожфыдлвао"
}
]
</pre>

>>> '''setchaincontentcustomfieldresult'''

Ответ из Oktell в CRM с результатом установки комментария в контент текущей сессии, в которой участвует канал указанного в запросе пользователя.

<pre>
[
"setchaincontentcustomfieldresult",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "19ADB2C3-A0B5-47AB-AB2C-CBE15CF98968",
"result": 1
}
]
</pre>

-------------------------------------------------------------------
<<< '''getchaincontentcustomfield'''

Запрос из CRM в Oktell на возврат комментария из контента текущей сессии, в которой участвует канал указанного пользователя.

<pre>
[
"getchaincontentcustomfield",
{
"qid": "AF4B98AA-51D8-4944-B10C-04B0DE1E1BBC",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
}
]
</pre>

>>> '''getchaincontentcustomfieldresult'''

Ответ из Oktell в CRM. Возвращает комментарий из контента текущей сессии, в которой участвует канал указанного в запросе пользователя.

<pre>
[
"getchaincontentcustomfieldresult",
{
"qid": "AF4B98AA-51D8-4944-B10C-04B0DE1E1BBC",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"chainid": "19ADB2C3-A0B5-47AB-AB2C-CBE15CF98968",
"customfield": "фывафыдвлаожфыдлвао",
"result": 1
}
]
</pre>

====Журнал звонков====

-------------------------------------------------------------------
<<< '''getpbxcalljournal'''

Запрос из CRM в Oktell на возврат журнала звонков АТС по указанному фильтру в соответствии с правами пользователя.
В том числе ссылки на файлы записей разговоров.

<pre>
[
"getpbxcalljournal",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"filter": {
"idconn": "08708573-4AF9-45F2-83B7-B8A0DDEF52EC",
"idchain": "94B5B657-3009-45E0-9095-F5D7BA163EB2",
"datestart": "2011-04-07",
"datestop": "2011-04-07",
"timestart": "08:00:00",
"timestop": "20:00:00",
"connectiontype": "all",
"intnumber": "",
"outnumber": "89503222555",
"minduration": 1,
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin: "Петров"
"comment": "",
"showcallcenter": false,
"taskid": "00000000-0000-0000-0000-000000000000"
}
}
]
</pre>
<pre>
//* filter - фильтр для запроса. Все поля не являются обязательными.
По умолчанию возвращаются разговоры за текущий день с 8:00 до 17:00 без звонков call-центра
длительностью более 1 секунды, которые доступны авторизованному пользователю по правам контроля.
К фильтру могут быть применены:
idconn - идентификатор конкретно интересующей коммутации.
idchain - идентификатор конкретно интересующей цепочки коммутаций/сессии.
datestart - дата начала интересующего периода. Включительно.
datestop - дата окончания интересующего периода. Включительно.
timestart - время начала интересующего внутридневного интервала.
timestop - время окончания интересующего внутридневного интервала.
connectiontype - тип соединения (all, incoming, outgoing, internal, conference).
intnumber - интересующий внутренний номер.
outnumber - интересующий внешний номер.
minduration - минимальная длительность коммутации в секундах, может быть действительным значением.
userid - идентификатор интересующего пользователя.
userlogin - логин интересующего пользователя.
comment - строка включения в комментарии.
showcallcenter: true|false. Отображать ли коммутации call-центра.
taskid - идентификатор задачи в рамках call-центра, чьи звонки интересны.
</pre>

<<< '''getpbxcalljournalresult'''

Ответ от Oktell в CRM. Возвращает журнал звонков АТС по указанному фильтру в соответствии с правами пользователя.

<pre>
[
"getpbxcalljournalresult",
{
"qid": "4CC7EDEC-499B-4C03-95D3-57B8C30FC110",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtformat": "dd.MM.yyyy HH:mm:ss",
"data": [
{
"commutationid": "044d56f9-7137-49b6-bacf-a10370a54df4",
"chainid": "672ec703-e77a-47b1-b698-cb8488352fc9",
"connectiontype": 10,
"connectiontypestr": "conference",
"dtstart": "2011-04-09 19:55:30",
"dtanswer": "2011-04-09 19:55:30",
"dtstop": "2011-04-09 19:55:33",
"length": 2,
"answerlength": 0,
"hascomment": false,
"isbetweenusers": true,
"fromcc": false,
"isconf": true,
"isrecorded": true,
"recordlink": "/download/rec/AQAAAAAQIKvNHczNCBEBAAAA",
"fileext": "wav",
"auserid": "AA3B3E14-2B44-4D08-8C62-3C616F9D27E3",
"auserlogin": "Крючков",
"alineid": "A117499D-23EA-4BF8-A6B9-F49580E9628C",
"alinenumber": "16001",
"aoutnumber": "Семен Егорович Крючков",
"anumberdialed": "",
"atext": "Семен Егорович Крючков",
"conferenceid": "224476F1-2E41-4C8F-BA85-6BEF0EBB5339",
"conferenceroom": "751",
"conferencename": "Автоконференция #751 09.04.11 19:55:30",
"conferencedirectorid": "AA3B3E14-2B44-4D08-8C62-3C616F9D27E3",
"conferencedirectorlogin": "Крючков",
"conferencedirectorname": "Семен Егорович Крючков",
"reasonstop": -1,
"stopside": "a"
},
{
"commutationid": "5F64DECF-194C-474B-8CA7-824E82A1C072",
"chainid": "22A01B17-064B-4E19-99BA-FED96680AF25",
"connectiontype": 5,
"connectiontypestr": "ctOuterInner",
"dtstart": "2011-04-09 19:57:24",
"dtanswer": "2011-04-09 19:57:24",
"dtstop": "2011-04-09 19:58:13",
"length": 49,
"answerlength": 0,
"hascomment": true,
"isbetweenusers": true,
"fromcc": false,
"isrecorded": true,
"recordlink": "/download/rec/AAAAAABwOltxHczNCGlCAACBPgAA",
"fileext": "mp3",
"isconf": false,
"auserid": "AA3B3E14-2B44-4D08-8C62-3C616F9D27E3",
"auserlogin": "Крючков",
"alineid": "A117499D-23EA-4BF8-A6B9-F49580E9628C",
"alinenumber": "16001",
"aoutnumber": "Семен Егорович Крючков",
"anumberdialed": "",
"atext": "Семен Егорович Крючков",
"buserid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"buserlogin": "Петров",
"blineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
"blinenumber": "17004",
"boutnumber": "",
"bnumberdialed": "217",
"btext": "Петр Петрович Петров",
"reasonstop": -1,
"stopside": "b"
}
{...},
{...}
]
}
]
</pre>
<pre>
//* dtformat - формат представления даты/времени.
//* data - набор попавших в выдачу коммутаций/конференций. Каждая запись - в отдельном словаре.
commutationid - идентификатор коммутации.
chainid - идентификатор цепочки коммутаций/сессии.
connectiontype, connectiontypestr - Тип соединения:
ctInnerOuter = 1, //внутренняя линия с внешней линией
ctInnerIvr = 2, //внутренняя линия с IVR
ctInnerInner = 3, //внутренняя линия с внутренней линией
ctOuterIvr = 4, //внешняя линия с IVR
ctOuterInner = 5, //внешняя линия с внутренней линией линией
ctOuterOuter = 6, //внешняя линия с внешней линией
ctIvrOuter = 7, //IVR с внешней линией
ctIvrInner = 8, //IVR с внутренней линией
ctConference = 10,//Конференция
ctSelector = 11,//Селекторное совещание
dtstart - дата/время начала вызова перед осуществлением коммутации.
dtanswer - дата/время ответа и начала коммутации.
dtstop - дата/время окончания коммутации
length - длительность в секундах
answerlength - длительность ответа в секундах.
hascomment - true|false. Имеет ли данная коммутация комментарий.
isbetweenusers - true|false. Является ли текущая коммутация между пользователями системы.
fromcc - true|false. Произведена ли текущая коммутация в рамках работы call-центра.
isrecorded - true|false. Записана ли коммутация.
recordlink - относительная ссылка на скачивание файла записи разговора.
fileext - если файл записан, то его расширение mp3 или wav. Возвращает только если в полном
результате менее 5 записей, иначе поле отсутствует.
isconf - true|false. Является ли текущая запись конференцией.
auserid - идентификатор пользователя абонента a.
Если IVR - 'ab000000-0000-0000-0000-000000000000',
Если внешний абонент - 'bf000000-0000-0000-0000-000000000000'
auserlogin - логин пользователя абонента a.
alineid - идентификатор линии абонента a.
alinenumber - номер линии абонента a.
aoutnumber - номер абонента a (CallerId).
anumberdialed - набранный абонентом a номер.
atext - текстовое описание абонента a.
buserid - идентификатор пользователя абонента b.
Если IVR - 'ab000000-0000-0000-0000-000000000000',
Если внешний абонент - 'bf000000-0000-0000-0000-000000000000'
buserlogin - логин пользователя абонента b.
blineid - идентификатор линии абонента b.
blinenumber - номер линии абонента b.
boutnumber - номер абонента b (CallerId).
bnumberdialed - набранный абонентом b номер.
btext - текстовое описание абонента b.
reasonstop - причина разрыва коммутации.
stopside - a, b. По чьей инициативе коммутация прервана.
</pre>

-------------------------------------------------------------------
<<< '''getpbxcallcomment'''

Запрос из CRM в Oktell на возврат комментария к указанной коммутации.

<pre>
[
"getpbxcallcomment",
{
"qid": "1E3C27C0-BE28-4621-AD39-6D1B31EB37EB",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"commutationid": "73567FD4-EFB9-46BF-9346-35B8638FE644"
}
]
</pre>

<<< '''getpbxcallcommentresult'''

Ответ от Oktell в CRM. Возвращает комментарий к запрошенной коммутации.

<pre>
[
"getpbxcallcommentresult",
{
"qid": "1E3C27C0-BE28-4621-AD39-6D1B31EB37EB",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"commutationid": "73567FD4-EFB9-46BF-9346-35B8638FE644",
"comment": "раз два три четыре пять вышел зайчик погулять"
}
]
</pre>

-------------------------------------------------------------------
<<< '''setpbxcallcomment'''

Запрос из CRM в Oktell на установку комментария для указанной коммутации.

<pre>
[
"setpbxcallcomment",
{
"qid": "3AB79A11-24FB-4D10-B7FD-5FD1653A679D",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"commutationid": "73567FD4-EFB9-46BF-9346-35B8638FE644"
"comment": "раз два три четыре пять вышел зайчик погулять"
}
]
</pre>

<<< '''setpbxcallcommentresult'''

Ответ от Oktell в CRM. Возвращает результат установки комментария к коммутации.

<pre>
[
"setpbxcallcommentresult",
{
"qid": "3AB79A11-24FB-4D10-B7FD-5FD1653A679D",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1
}
]
</pre>

-------------------------------------------------------------------
<<< '''getpbxmycalljournal'''

Запрос из CRM в Oktell на возврат журнала собственных звонков авторизованного пользователя по указанному фильтру.
В том числе ссылки на файлы записей разговоров.

<pre>
[
"getpbxmycalljournal",
{
"qid": "F95D0A08-D904-49C9-A4B9-8C02B1781A89",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"linkmode": "full",
"filter": {
"datestart": "2011-04-07",
"datestop": "2011-04-07",
"comment": "",
"number": "89503222555",
"media": "all",
"type": "all"
}
}
]
</pre>
<pre>
//* linkmode - full, simple - устанавливает формат ссылок, в котором будут указаны полученные файлы
в событии об окончании приема.
full - вернуть абсолютную ссылку на скачивание через http.
simple - вернуть относительную ссылку на скачивание.
При формировании абсолютной ссылки в качестве доменного имени берется значение из
раздела [[Интеграция с WEB-Socket CRM]] общих настроек Oktell.
//* filter - фильтр для запроса. Все поля не являются обязательными.
По умолчанию возвращаются разговоры за текущий день с 8:00 до 17:00, в которых
участвовал авторизованный пользователь
К фильтру могут быть применены:
datestart - дата начала интересующего периода. Включительно.
datestop - дата окончания интересующего периода. Включительно.
comment - строка включения в комментарии.
number - интересующий номер оппонента.
media - external, internal, all. Среда вызова.
type - тип звонка:
incoming - входящий звонок.
outcoming - исходящий звонок.
missed - пропущенный звонок. Что является пропущенным звонком определяется в разделе
[[Менеджер очередей]] общих настроек Oktell.
conference - конференция.
selector - селекторное совещание.
all - все типы звонков.
</pre>

<<< '''getpbxmycalljournalresult'''

Ответ от Oktell в CRM. Возвращает журнал собственных звонков авторизованного пользователя по указанному фильтру.

<pre>
[
"getpbxmycalljournalresult",
{
"qid": "F95D0A08-D904-49C9-A4B9-8C02B1781A89",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"dtformat": "dd.MM.yyyy HH:mm:ss",
"data": [
{
"type": 1,
"typestr": "incoming",
"media": 2,
"mediastr": "internal",
"commutationid": "73567FD4-EFB9-46BF-9346-35B8638FE644",
"chainid": "46fe0543-4a58-49c5-b501-644b8ddad69a",
"dtstart": "2011-04-09 19:55:25",
"dtanswer": "2011-04-09 19:55:27",
"dtstop": "2011-04-09 19:56:29",
"length": 61,
"number": "14",
"alineid": "3294CD8F-7865-436A-AC2E-CEA481D8F52D",
"alinenumber": "17011",
"blineid": "021BDECD-196B-408F-8C36-8C37C0A94C5A",
"blinenumber": "17014",
"isrecorded": true,
"recordlink": "http://192.168.0.12:4055/download/rec/AQAAAADQfMDNHczNCBEBAAAA",
"hascomment": true,
"abonentname": "Петр Петрович Петров",
"isconf": false
},
{
"type": 10,
"typestr": "conference",
"media": 10,
"mediastr": "conference",
"commutationid": "20CF9B5A-5FFE-4456-8984-E7B79D7166EE",
"chainid": "E443FEA7-5ABB-49CB-A28D-8CC25F404E97",
"dtstart": "2011-04-09 19:58:12",
"dtanswer": "2011-04-09 19:58:12",
"dtstop": "2011-04-09 19:59:45",
"length": 93,
"alineid": "3294CD8F-7865-436A-AC2E-CEA481D8F52D",
"alinenumber": "17011",
"isconf": true,
"conferenceid": "224476F1-2E41-4C8F-BA85-6BEF0EBB5339",
"conferenceroom": "751",
"conferencename": "Автоконференция #751 09.04.11 19:55:30",
"conferencedirectorid": "AA3B3E14-2B44-4D08-8C62-3C616F9D27E3",
"conferencedirectorlogin": "Крючков",
"conferencedirectorname": "Семен Егорович Крючков",
"isrecorded": true,
"recordlink": "http://192.168.0.12:4055/download/rec/AAAAAACQSBTLHczNCGlCAACBPgAA",
"hascomment": true
},
{...},
{...}
]
}
]
</pre>
<pre>
//* dtformat - формат представления даты/времени.
//* data - набор попавших в выдачу коммутаций/конференций. Каждая запись - в отдельном словаре.
type, typestr - тип звонка:
incoming = 1 - входящий звонок.
outcoming = 2 - исходящий звонок.
missed = 3 - пропущенный звонок. Что является пропущенным звонком определяется
в разделе [[Настройки менеджера очередей|Менеджер очередей]] общих настроек Oktell.
conference = 10 - конференция.
selector = 11 - селекторное совещание.
media, mediastr - тип среды вызова:
external = 2 - внешняя среда.
internal = 1 - внутренний вызов.
conference = 10 - конференция.
selector = 11 - селекторное совещание.
commutationid - идентификатор коммутации.
chainid - идентификатор цепочки коммутаций/сессии.
dtstart - дата/время начала вызова перед осуществлением коммутации.
dtanswer - дата/время ответа и начала коммутации.
dtstop - дата/время окончания коммутации
length - длительность в секундах
alineid - идентификатор линии абонента a.
alinenumber - номер линии абонента a.
blineid - идентификатор линии абонента b, если это коммутация.
blinenumber - номер линии абонента b, если это коммутация.
isrecorded - true|false. Записана ли коммутация.
recordlink - относительная или абсолютная ссылка на скачивание файла записи разговора.
hascomment - true|false. Имеет ли данная коммутация комментарий.
abonentname - текстовое описание оппозитного абонента коммутации.
isconf - true|false. Является ли текущая запись конференцией(селектором) или нет.
conferenceid - идентификатор конференции/селектора.
conferenceroom - номер комнаты конференции/селектора.
conferencename - название конференции/селектора.
conferencedirectorid - идентификатор управляющего пользователя конференции/селектора.
conferencedirectorlogin - логин управляющего пользователя конференции/селектора.
conferencedirectorname - имя управляющего пользователя конференции/селектора.
</pre>

-------------------------------------------------------------------
<<< '''removepbxcallrecord'''

Запрос из CRM в Oktell. Удаляет запись разговора указанной коммутации в соответствии с правами доступа.

<pre>
[
"removepbxcallrecord",
{
"qid": "DF061C5B-1B3B-41AA-94FF-A7A2F8FA6AE7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"commutationid": "73567FD4-EFB9-46BF-9346-35B8638FE644"
}
]
</pre>

<<< '''removepbxcallrecordresult'''

Ответ от Oktell в CRM. Возвращает результат удаления записи разговора.

<pre>
[
"removepbxcallrecordresult",
{
"qid": "DF061C5B-1B3B-41AA-94FF-A7A2F8FA6AE7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1
}
]
</pre>

-------------------------------------------------------------------
<<< '''getvoiceperc'''

Запрос из CRM в Oktell. Возвращает информацию о [[Управление_базами_данных#ComputeVoices|распределении владения разговором участниками коммутации]].

<pre>
[
"getvoiceperc",
{
"qid": "DF061C5B-1B3B-41AA-94FF-A7A2F8FA6AE7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"commutationid": "73567FD4-EFB9-46BF-9346-35B8638FE644"
}
]
</pre>

<<< '''getvoicepercresult'''

Ответ от Oktell в CRM. Возвращает результат.

<pre>
[
"getvoicepercresult",
{
"qid": "DF061C5B-1B3B-41AA-94FF-A7A2F8FA6AE7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"aperc": 12,
"bperc": 29,
"alinenum": "17e003",
"blinenum": "16e215"
}
]
</pre>

-------------------------------------------------------------------
<<< '''getvoicemap'''

Запрос из CRM в Oktell. Возвращает [[Управление_базами_данных#VoiceMap|детальную карту владения разговором участниками коммутации]].

<pre>
[
"getvoicemap",
{
"qid": "DF061C5B-1B3B-41AA-94FF-A7A2F8FA6AE7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"commutationid": "73567FD4-EFB9-46BF-9346-35B8638FE644"
}
]
</pre>

<<< '''getvoicepercresult'''

Ответ от Oktell в CRM. Возвращает результат.

<pre>
[
"getvoicemapresult",
{
"qid": "DF061C5B-1B3B-41AA-94FF-A7A2F8FA6AE7",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"errormsg": "",
"abinbase64": [base64 от бинарки ("0100101101011110"-> byte[]-> base64)],
"bbinbase64": [base64 от бинарки ("0100101101011110"-> byte[]-> base64)],
"abinlen": 15,
"bbinlen": 15,
"alinenum": "17e003",
"blinenum": "16e215"
}
]
</pre>

====Номерной план====

-------------------------------------------------
>>> '''pbxnumberstatechanged'''

Сообщение из Oktell о смене состояния внутреннего номера (или группы внутренних номеров)

<pre>
[
"pbxnumberstatechanged",
{
"qid": "5B9508DF-565B-44E1-A122-6FEB70ADA0B9",
"numbers": [
{"num": "425", "numstateid": 3},
{"num": "427", "numstateid": 2},
{"num": "#82", "numstateid": 3}
]
}
]
</pre>

-------------------------------------------------------------------
<<< '''getusersbynumbers'''

Запрос из CRM в Oktell на возврат информации о пользователях системы по указанным внутренним номерам от имени указанного пользователя.

<pre>
[
"getusersbynumbers",
{
"qid": "20D0F23E-F26A-4BD9-BE65-B6F76D91880A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"numbers": [
"883",
"470",
"472",
"485"
]
}
]
</pre>

>>> '''getusersbynumbersresult'''

Ответ из Oktell в CRM. Возвращает информацию о пользователях, которые обнаруживаются системой при парсинге указанных в запросе внутренних номеров.

<pre>
[
"getusersbynumbersresult",
{
"qid": "20D0F23E-F26A-4BD9-BE65-B6F76D91880A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"users": [
{
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"username": "Петр Петрович Петров",
},
{
"userid": "2AC66E31-ADF0-4F84-A589-417A5A599EEA",
"userlogin": "Сидоров",
"username": "Сидор Сидорович Сидоров"
}
]
}
]
</pre>

-------------------------------------------------------------------
<<< '''getitemsbynumbers'''

Запрос из CRM в Oktell на возврат информации о пользователях и линиях системы по указанным внутренним номерам от имени указанного пользователя.

<pre>
[
"getitemsbynumbers",
{
"qid": "0A8B1B7C-E4DD-47FC-A17F-A9200602A8DE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"numbers": [
"883",
"470",
"472",
"485"
]
}
]
</pre>

>>> '''getitemsbynumbersresult'''

Ответ из Oktell в CRM. Возвращает информацию о пользователях и линиях, которые обнаруживаются системой при парсинге указанных в запросе внутренних номеров.

<pre>
[
"getitemsbynumbersresult",
{
"qid": "0A8B1B7C-E4DD-47FC-A17F-A9200602A8DE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"items": [
{
"type": "user",
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров",
"username": "Петр Петрович Петров",
},
{
"type": "user",
"userid": "2AC66E31-ADF0-4F84-A589-417A5A599EEA",
"userlogin": "Сидоров",
"username": "Сидор Сидорович Сидоров"
},
{
"type": "line",
"lineid": "50203B8C-8079-4B52-8D24-ECDA4BF7877A",
"linenumber": "17025"
}
]
}
]
</pre>

-------------------------------------------------------------------
<<< '''getsystemnumberbyuser'''

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

<pre>
[
"getsystemnumberbyuser",
{
"qid": "0A8B1B7C-E4DD-47FC-A17F-A9200602A8DE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"user": {
"userid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"userlogin": "Петров"
}
}
]
</pre>

>>> '''getsystemnumberbyuserresult'''

Ответ из Oktell в CRM. Возвращает системный внутренний номер указанного в суб-параметре пользователя.

<pre>
[
"getsystemnumberbyuserresult",
{
"qid": "0A8B1B7C-E4DD-47FC-A17F-A9200602A8DE",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"systemnumber": "U28CA980EF9F84B83B4934454AA54FCD8"
]
}
]
</pre>

-------------------------------------------------------------------
<<< '''getpbxnumbersforitem'''

Запрос из CRM в Oktell на возврат текстового списка внутренних номеров указанного в суб-параметре пользователя.

<pre>
[
"getpbxnumbersforitem",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
"itemtype": "user",
"itemuserid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"itemuserlogin: "Петров"
}
]
</pre>

>>> '''getpbxnumbersforitemresult'''

Ответ из Oktell в CRM. Возвращает список несистемных внутренних номеров через запятую, по которым возможен вызов пользователя, указанного в суб-параметре запроса.

<pre>
[
"getpbxnumbersforitemresult",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"itemtype": "user",
"itemuserid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"itemuserlogin: "Петров",
"itemnumbers": "403, 472"
}
]
</pre>
<pre>
/* "itemtype": "line",
/* "itemlineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
/* "itemlinenumber": "17004"
</pre>

-------------------------------------------------------------------
<<< '''getmainpbxnumberforitem'''

Запрос из CRM в Oktell на возврат основного несистемного внутреннего номера, по которому возможен вызов объекта системы (пользователя/линии), указанного в суб-параметре.

<pre>
[
"getmainpbxnumberforitem",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B"
"itemtype": "user",
"itemuserid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"itemuserlogin: "Петров"
}
]
</pre>

>>> '''getmainpbxnumberforitemresult'''

Ответ из Oktell в CRM. Возвращает основной несистемный внутренний номер, по которому возможен вызов объекта системы (пользователя/линии), указанного в суб-параметре запроса.

<pre>
[
"getmainpbxnumberforitemresult",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"itemtype": "user",
"itemuserid": "8232C52D-ACFF-4DC9-B33A-C2A3CD2FC002",
"itemuserlogin: "Петров",
"itemnumber": "472"
}
]
</pre>
<pre>
/* "itemtype": "line",
/* "itemlineid": "9F93FE9C-0B80-4242-BD24-D338BE8E4FC0",
/* "itemlinenumber": "17004"
</pre>

-------------------------------------------------------------------
<<< '''getpbxnumbers'''

Запрос из CRM в Oktell на возврат всех внутренних номеров системы.
Не требует указания авторизованного пользователя, так как может исполняться по инициативе сервера WebCRM.
В примере приведен запрос для формирования ответа с перечнем номеров в простом виде.

<pre>
[
"getpbxnumbers",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"mode": "simple"
}
]
</pre>
<pre>
//* mode: simple, full (простой вид, полный вид).
</pre>

>>> '''getpbxnumbersresult'''

Ответ из Oktell в CRM. Возвращает список всех внутренних номеров системы.
В примере приведен ответ на запрос с перечнем номеров в простом виде.

<pre>
[
"getpbxnumbersresult",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"mode": "simple",
"numbers": [
"401",
"402",
"403",
"404",
"405",
"471",
"472",
"473"
]
}
]
</pre>

В следующем примере приведен ответ на запрос с перечнем номеров в полном виде со всеми описаниями и состояниями.

<pre>
[
"getpbxnumbersresult",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"mode": "full",
"numbers": [
{
"id": "9079E514-FECF-4DFD-BF48-5EDE4241E3A1",
"number": "472",
"type": 0,
"typestr": "intRule",
"isgroup": false,
"caption": "Петров",
"state": 5,
"statestr": "usFullbusy",
"department": "Руководство"
},
{...},
{...}
]
}
]
</pre>
<pre>
/* number:type - intRule(0), intFast(2), intIVR(3), intEmergency(4)
/* number:state - usDisconnected(0), usReady(1), usLunch(2), usOff(3), usFullbusy(5),
usReserved(6), usWOPhone(7), usError(100), usRinging(201)
</pre>

-------------------------------------------------------------------
<<< '''getallusernumbers'''

Запрос из CRM в Oktell на возврат списка всех пользователей, содержащего актуальную информацию по их прямым, основным и групповым номерам.

<pre>
[
"getallusernumbers",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"fillsubordinates": true
}
]
</pre>
<pre>
//* fillsubordinates: true|false. По умолчанию false.
Включать ли информацию о подчиненных (добавляет каждому пользователю поле "sub":true|false)
</pre>

>>> '''getallusernumbersresult'''

Ответ из Oktell в CRM. Возвращает список всех пользователей, содержащий актуальную информацию по их прямым, основным и групповым номерам.

<pre>
[
"getallusernumbersresult",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"users": [
{"id": "47A8B3A0-0B33-41BB-9D08-1D9EB0D6F09B",
"name: "Петров",
"sub": true,
"main: "14",
"nums": "14, 625, 773"
},
{"id": "5A84368D-5ED3-434B-8EB2-41AE86E1566A",
"name: "Иванов",
"sub": false
},
...
]
}
]
</pre>
<pre>
/* users:main - основной прямой номер,
/* users:nums - перечень номеров, в которых участвует пользователь или его текущая линия.
Порядок следования от главного к групповым, затем от главного к групповым с участием линии.
/* users:sub - является ли подчиненным пользователем (в соответствии с правами авторизованного пользователя)
Включается только если в запросе установлен флаг fillsubordinates.
</pre>

==== Управление задачами call-центра ====

-------------------------------------------------------------------
<div id="attachcalltotask"></div>
<<< '''cc_attachcalltotask'''

Запрос из CRM в Oktell на привязку текущего звонка пользователя к задаче.
Позволяет указать задачу ключом - идентификатор, название, код.
При необходимости звонок может быть привязан к конкретному абоненту из таблицы абонентов, прикрепленной к задаче (по его числовому идентификатору). В противном случае в таблицу добавляется новая строчка, даже если набираемый номер уже присутствовал в ней. Подробнее о прикреплении звонка к задаче в разделе [[Голосовые задачи#ManualCall|«Call-центр. Голосовые задачи»]].

<pre>
[
"cc_attachcalltotask",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"taskkey": "EDFE9A1F-E27E-4693-A427-A392C919F8B0",
"idinlist": 183
}
]
</pre>

>>> '''cc_attachcalltotaskresult'''

Ответ от Oktell в CRM. Возвращает результат привязки звонка к задаче, дополнительно сообщая номер абонента в списке. В случае неудачи содержит причину.

<pre>
[
"cc_attachcalltotaskresult",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1,
"idinlist": 183,
"errormsg": ""
}
]
</pre>

-------------------------------------------------------------------
<div id="settaskactive"></div>
<<< '''cc_settaskactive'''

Запрос из CRM в Oktell на активацию/деактивацию задачи.
Позволяет указать задачу ключом - идентификатор, название или код. Тип задачи - ''call'' (по умолчанию) или ''text''.
Метод доступен с версии 2.8.130909.

<pre>
[
"cc_settaskactive",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"tasktype": "call",
"taskkey": "EDFE9A1F-E27E-4693-A427-A392C919F8B0",
"active": true
}
]
</pre>

>>> '''cc_settaskactiveresult'''

Ответ от Oktell в CRM. Возвращает результат активации/деактивации задачи.

<pre>
[
"cc_settaskactiveresult",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1
}
]
</pre>

-------------------------------------------------------------------
<div id="addoperatortotask"></div>
<<< '''cc_addoperatortotask'''

Запрос из CRM в Oktell на добавление оператора к задаче.
Операция доступна супервизорам задачи, а также самому оператору. Более глубокие фильтры необходимо организовывать на клиентской стороне.
Позволяет указать задачу ключом - идентификатор, название или код. Позволяет указать оператора ключом - идентификатор, логин, имя.
Метод доступен с версии 2.8.130909.

<pre>
[
"cc_addoperatortotask",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"taskkey": "EDFE9A1F-E27E-4693-A427-A392C919F8B0",
"operatorkey": "BD252256-08DE-4693-9A31-FC02B600E609"
}
]
</pre>

>>> '''cc_addoperatortotaskresult'''

Ответ от Oktell в CRM. Возвращает результат процедуры добавления оператора в задачу. Неудача возможна при невозможности обнаружить указанного оператора или указанную задачу, а также при отсутствии прав управления задачей.

<pre>
[
"cc_addoperatortotaskresult",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1
}
]
</pre>

-------------------------------------------------------------------
<div id="removeoperatorfromtask"></div>
<<< '''cc_removeoperatorfromtask'''

Запрос из CRM в Oktell на удаление оператора из задачи.
Операция доступна супервизорам задачи, а также самому оператору. Более глубокие фильтры необходимо организовывать на клиентской стороне.
Позволяет указать задачу ключом - идентификатор, название или код. Позволяет указать оператора ключом - идентификатор, логин, имя.
Метод доступен с версии 2.8.130909.

<pre>
[
"cc_removeoperatorfromtask",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"taskkey": "EDFE9A1F-E27E-4693-A427-A392C919F8B0",
"operatorkey": "BD252256-08DE-4693-9A31-FC02B600E609"
}
]
</pre>

>>> '''cc_removeoperatorfromtaskresult'''

Ответ от Oktell в CRM. Возвращает результат процедуры удаления оператора из задачи. Неудача возможна при невозможности обнаружить указанного оператора или указанную задачу, а также при отсутствии прав управления задачей.

<pre>
[
"cc_removeoperatorfromtaskresult",
{
"qid": "0423AABC-F20D-4A94-BF2B-94EEEAB1FE40",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"result": 1
}
]
</pre>

====Преобразования====

-------------------------------------------------------------------
<<< '''getuserbyline'''

Запрос из CRM в Oktell на возврат информации о связанном пользователе по ключу линии. Ключом линии традиционно является идентификатор или номер линии.

<pre>
[
"getuserbyline",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"linekey": "17002"
}
}
]
</pre>

>>> '''getuserbylineresult'''

Ответ из Oktell в CRM. Возвращает системный внутренний номер указанного в суб-параметре пользователя.

<pre>
[
"getuserbylineresult",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"founduser": {
"userid": "BE6A252A-D7E7-4D15-8D75-385A210DF997",
"userlogin": "john",
"username": "John Smith"
}
}
]
</pre>
<pre>
//* founduser - информация о связанном с указанной линии пользователе - его идентификатор, логин, имя.
Если линия указана неверно или к ней в данный момент не привязан пользователь - null.
</pre>

-------------------------------------------------------------------
<<< '''getlinebyuser'''

Запрос из CRM в Oktell на возврат информации о связанной линии по ключу пользователя. Ключом пользователя традиционно является идентификатор, логин или имя.

<pre>
[
"getlinebyuser",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"userkey": "ivanov"
}
}
]
</pre>

>>> '''getlinebyuserresult'''

Ответ из Oktell в CRM. Возвращает системный внутренний номер указанного в суб-параметре пользователя.

<pre>
[
"getlinebyuserresult",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"foundline": {
"lineid": "FA86E75A-6383-42B7-873C-37A0654B18EF",
"linenum": "17002"
}
}
]
</pre>
<pre>
//* foundline - информация о связанной с указанным авторизованным пользователем линии - ее идентификатор, номер.
Если пользователь указана неверно, или не авторизован - null.
''Пользователь по умолчанию'' считается авторизованным.
</pre>

====Служебные методы====

-------------------------------------------------------------------
<<< '''getversion'''

Запрос из CRM в Oktell на возврат информации о версии сервера Oktell.

<pre>
[
"getversion",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"showalloweddbstoredprocs": 1
}
]
</pre>
<pre>
//* showalloweddbstoredprocs: true|false. Отображать ли список доступных хранимых процедур БД.
</pre>

>>> '''getversionresult'''

Ответ из Oktell в CRM. Возвращает системный внутренний номер указанного в суб-параметре пользователя.

<pre>
[
"getversionresult",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"version": {
"text": "Версия программы: 2.7.110808(4237.32979). Версия БД: 110713.",
"dated": "110808",
"build": "2.7.4237.32979",
"datedhal": "110808",
"buildhal": "2.15.3.2871",
"webserverport": 80,
"webservertls": false
}
"alloweddbstoredprocs": {
"w_favoritegetbyuser": 1,
"w_favoritesavebyuser": 1,
"w_favoritedeletebyuser": 1,
"w_clientsget": 1,
"w_clientgroupsget": 1
}
}
]
</pre>
<pre>
//* version - информация о версии сервера логики и HAL.
//* version:webserverport - номер порта [[Серверный_HTTP_интерфейс|HTTP веб-сервера oktell]].
//* version:webservertls - true|false - защищенный ли канал на указанном порте (http или https).
//* alloweddbstoredprocs - перечень хранимых процедур, доступных для исполнения в БД Oktell
посредством метода ''execpredefineddbstoredproc''
</pre>

-------------------------------------------------------------------
<<< '''gettemphttppass'''

Запрос из CRM в Oktell. Генерирует и возвращает временный пароль на доступ к [[Веб-интерфейс|HTTP веб-серверу]] без авторизации.
Временный пароль живет не более 10 секунд до первого обращения к HTTP с указанием этого пароля среди параметров запроса.
Пароль привязывается к IP адресу дополнительно.
После этого вне зависимости от способа авторизации, установленного для HTTP веб-сервера Oktell, однократный вызов любого [[Серверный_HTTP_интерфейс|метода серверного веб-интерфейса]] возможен без авторизации с указанием среди параметров дополнительного служебного параметра ''temppass=A'', где A - выданный временный пароль.

Доступно для [[#Arch2|схемы интеграции 2]] и [[#Arch3|схемы интеграции 3]] в рамках индивидуальных подключений.

<pre>
[
"gettemphttppass",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"responsetowebsock": true
}
]
</pre>

>>> '''gettemphttppassresult'''

Ответ из Oktell в CRM. Возвращает системный внутренний номер указанного в суб-параметре пользователя.

<pre>
[
"gettemphttppassresult",
{
"qid": "21D38282-DFB7-4DEF-8C76-BFB338A80947",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"password": "6f3200ac"
}
]
</pre>
<pre>
//* password - временный пароль для подстановки в качестве значения параметра temppass
при осуществлении GET или POST запроса к HTTP веб-серверу Oktell.
Следует иметь в виду, что даже в случае POST запроса со специальным контентом
указание параметра-пароля возможно в теле самой страницы (по аналогии с GET запросом).
</pre>

-------------------------------------------------------------------
<<< '''triggercustomevent'''

Запрос из CRM в Oktell на генерацию пользовательского произвольного события всем или только указанным пользователям.
Может быть использовано в [[#Arch2|схеме интеграции 2]] и [[#Arch3|схеме интеграции 3]] в рамках индивидуальных подключений.
Производит массовую рассылку указанного события. Точно также как и все остальные события требует подписки.

<pre>
[
"triggercustomevent",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"eventname": "newClientCategoryAdded",
"eventparam": "строка"
"sendback": 1, // отправлять мне самому или нет
}
]
</pre>
<pre>
[
"triggercustomevent",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"eventname": "newClientCategoryAdded",
"eventparam": "строка",
"recipients": [
"Петров",
"Сидоров"
]
}
]
</pre>
<pre>
[
"triggercustomevent",
{
"qid": "C13CE714-A502-4699-BE1A-9C4DB28BB70A",
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"eventname": "newClientCategoryAdded",
"eventparam": { "param1": "123", "p2": { "asdfasd": "sdfgsdf" } , ... },
"recipients": [
"C45D4911-BDE2-40C0-8D11-A4AFF1F160CC",
"BA2C4BAC-7A7C-4959-B1A7-2F63C248DF3D"
]
}
]
</pre>
<pre>
//* recipients - список идентификаторов/логинов получателей сообщений.
Может не быть указанным, тогда отправка производится всем.
//* sendback - генерировать ли событие для самого отправителя. Имеет смысл, поскольку
в случае использования нескольких вкладок в браузере, каждое из подключений
получит событие независимо.
//* eventname - название пользовательского события.
//* eventparam - параметр пользовательского события. Переходит в сгенерированное сообщение без изменений.
Может содержать строку, набор, массив, словарь - все что угодно.
</pre>

>>> '''gettemphttppassresult'''

Событие из Oktell пользователям CRM. Отправляется всем пользователям, указанным при запросе на рассылку события.

<pre>
[
"customevent",
{
"qid":"aaa3f5c9-bcd5-4bf9-aef9-0b4ee735170d",
"userlogin": "Петров",
"userid": "C45D4911-BDE2-40C0-8D11-A4AFF1F160CC",
"eventname": "newClientCategoryAdded",
"triggereduserid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"triggereduserlogin": "Иванов",
"eventparam": { "param1": "123", "p2": { "asdfasd": "sdfgsdf" } , ... }
}
]
</pre>
<pre>
//* eventname - название пользовательского события.
//* eventparam - параметр пользовательского события в неизменном виде, как в запросе.
//* triggereduserid - идентификатор пользователя-рассыльщика.
//* triggereduserlogin - логин пользователя-рассыльщика.
</pre>

-------------------------------------------------------------------
<<< '''execpredefineddbstoredproc'''

Запрос из CRM в Oktell. Исполняет указанную хранимую процедуру в БД Oktell и возвращает данные всех сформированных в ходе выполнения наборов.
Доступные для исполнения процедуры содержатся в конфигурационном файле ''websocket.config'', а также могут быть возвращены методом ''getversion''.

Существует специальный параметр @authorizeduserid, значение которого перед исполнением заменяется на идентификатор авторизованного пользователя. Такие процедуры нельзя исполнять от имени CRM.

Не требует указания пользователя.

<pre>
[
"execpredefineddbstoredproc",
{
"qid": "7198D943-7BA9-443D-B283-55812BC82AFB",
"procedure": "T_GetFavorites",
"inputparams": {
"param1": "XXX",
"param2": 10
}
}
]
</pre>
<pre>
//* procedure - название процедуры из разрешенного списка.
//* inputparams - значения параметров процедуры. Имена параметров могут содержать в начале символ ''@'',
В случае его отсутствия он добавляется автоматически.
Если в списке присутствует параметр ''authorizeduserid'', его значение будет принудительно заменено
на идентификатор текущего авторизованного пользователя в Oktell. Этим можно пользоваться для
создания в БД процедур, учитывающих инициатора исполнения.
</pre>

>>> '''execpredefineddbstoredprocresult'''

Ответ из Oktell в CRM. Возвращает результат исполнения хранимой процедуры в БД Oktell. Перечисляет все выходные наборы данных.

<pre>
[
"execpredefineddbstoredprocresult",
{
"qid": "7198D943-7BA9-443D-B283-55812BC82AFB",
"result": 1,
"errorcode": 0,
"errorstr": "",
"dataset": [
[
["column1", "column2", "column3"],
["row1val1", "row1val2", "row1val3" ],
["row2val1", "row2val2", "row2val3" ],
...
],
[
["column1", "column2"]
],
...
]
}
]
</pre>
<pre>
//* result - 1 или 0. Успешно или неудачно проведена операция.
//* errorcode - код ошибки. 50044 - служебное значение, в случае запрета или исключения при исполнении,
не связанного с ошибкой SQL
//* errorstr - описание ошибки.
//* dataset - наборы данных по порядку выдачи в ходе исполнения хранимой процедуры.
Набор - это список строк, каждая из которых - список значений по ячейкам.
Первая строка в наборе - всегда содержит названия столбцов набора.
</pre>

-------------------------------------------------------------------
<<< '''execpluginmethod'''

Запрос из CRM в Oktell. Исполняет указанный метод в [[Встраиваемые_plugin-модули|серверном плагине]], передавая в него параметры и возвращая результат с выходными параметрами.

Не требует обязательного указания пользователя. Однако если вызов осуществляется в рамках подключения из браузера к серверу Oktell, то пользователь проставляется автоматически перед исполнением метода.

<pre>
[
"execpluginmethod",
{
"qid": "7198D943-7BA9-443D-B283-55812BC82AFB",
"pluginid": "44710EF2-9C5E-489E-B6CC-FD4ED34C13FE",
"formid": "44710EF2-9C5E-489E-B6CC-FD4ED34C13FE",
"inputparams": {
"param1": "...",
"param2": "...",
...
}
}
]
</pre>
<pre>
//* pluginid - идентификатор плагина.
//* formid - идентификатор одной из заявленных форм (методов) плагина.
//* inputparams - список значений для заявленных плагином входных параметров выбранной формы (метода).
В качестве значений параметров могут быть json структуры
(октелл осуществляет преобразование в строку самостоятельно).
</pre>

>>> '''execpluginmethodresult'''

Ответ из Oktell в CRM. Возвращает результат исполнения метода в серверном плагине.

<pre>
[
"execpluginmethodresult",
{
"qid": "7198D943-7BA9-443D-B283-55812BC82AFB",
"result": 1,
"error": 0,
"errormsg": "",
"outputparams": {
"outputdata": "...",
...
}
}
]
</pre>
<pre>
//* outputparams - список значений заявленных плагином выходных переменных выбранной формы (метода).
В качестве значений параметров могут быть json структуры.
</pre>

-------------------------------------------------------------------
<<< '''ping'''

Запрос из CRM в Oktell. Периодически пробивает канал связи, напоминая о жизнеспособности подключения. Требуется для [[#Arch2|Схемы интеграции 2]] и [[#Arch3|Схемы интеграции 3]] в рамках индивидуальных подключений. Для [[#Arch1|Схемы интеграции 1]] необязательно.

Не требует указания пользователя.

<pre>
[
"ping",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859"
}
]
</pre>

>>> '''pong'''

Ответ от Oktell в CRM на запрос ''ping''.

<pre>
[
"pong",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859"
}
]
</pre>

-------------------------------------------------------------------
<<< '''subscribeevent''',
'''unsubscribeevent'''

Запрос из CRM в Oktell. Производит соответственно подписку и отписку на указанные события.

Доступно и требуется только для [[#Arch2|схемы интеграции 2]] и [[#Arch3|схемы интеграции 3]] в рамках индивидуальных подключений.

В [[#Arch1|схеме интеграции 1]] события поступают в полном объеме, часть из них объединяются и отправляются на сервер WebCRM без привязки к пользователю; ожидается, что сервер WebCRM самостоятельно размножит их. К таким событиям относятся, например ''pbxnumberstatechanged'', ''conflistchanged'' и им подобные. Остальные же направляются с привязкой к пользователю и только в случае, когда пользователь авторизован из-под CRM.

<pre>
[
"subscribeevent",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859"
"eventmethod": "userstatechanged",
}
]
</pre>
<pre>
[
"subscribeevent",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859"
"eventmethod": [
"userstatechanged",
"pbxnumberstatechanged"
]
}
]
</pre>
<pre>
[
"unsubscribeevent",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859"
"eventmethod": "userstatechanged",
}
]
</pre>

События, требующие подписки:
:* pbxnumberstatechanged
:* pbxnumberlistmodified
:* shownotifymessage
:* voicemailreceived
:* usertextmessagereceived
:* usertextmessageviewed
:* chatcreated
:* chatnamechanged
:* chatmemberadded
:* chatmemberremoved
:* chatmessage
:* chatmessageviewed
:* chat (совокупность всех методов ''chat*'')
:* userstatechanged
:* linestatechanged
:* chainstatechanged
:* flashstatechanged
:* phoneevent_acmcallstarted
:* phoneevent_acmcallstopped
:* phoneevent_ringstarted
:* phoneevent_ringstopped
:* phoneevent_ivrstarted
:* phoneevent_ivrstopped
:* phoneevent_commstarted
:* phoneevent_commstopped
:* phoneevent_faxstarted
:* phoneevent_faxstopped
:* phoneevent_faxreceived
:* phoneevent (совокупность всех методов ''phoneevent_*'')
:* conferenceevent
:* conflistchanged
:* confparamschanged
:* confcompositionchanged
:* confcompetitorstatechanged
:* confentrancedenied
:* confentrancepermitted
:* confentrancerequest
:* confnotifyinvite
:* confpossiblecompetitorstatechanged
:* conference (совокупность всех методов ''conf*'')
:* dynamic (совокупность методов executemethod, cancelmethod, showform, closeform)
:* dynamicwaitabort (совокупность методов executemethodwaitaborted, showformwaitaborted)
:* dlgcard_showreserve
:* dlgcard_showconfirm
:* dlgcard_showformstop
:* dlgcard_showformdialog
:* dlgcard_closeall
:* dlgcard_closereserve
:* dlgcard_closeformreturnvalues
:* dlgcard_closeformreturncomment
:* dlgcard (совокупность методов dlgcard_*)
:* customevent

>>> '''subscribeeventresult''',
 '''unsubscribeeventresult'''

Ответ от Oktell в CRM на запросы ''subscribeeventresult'' и ''unsubscribeeventresult'' соответственно.

<pre>
[
"subscribeeventresult",
{
"qid": "DDA55585-F598-4F8C-B605-E6E186E6D859"
"result": 1
}
]
</pre>

-------------------------------------------------------------------
<<< '''wp_setuserstate'''

Запрос на установку состояния указанному пользователю. Исполняется от имени сервера, даже если пользователь подключен с помощью другого подключения или из толстого клиента. Ответ не возвращается, в случае удачи отправляется событие ''userstatechanged''. Пользователь задается с помощью одного из ключей (wp - рабочее место, line - линия, user - пользователь).

<pre>
[
"wp_setuserstate",
{
"qid": "2A45010A-8EEA-4876-90CB-F062459D4BE2",
"wp": "...",
"line": "...",
"user": "...",
"userstateid": 2,
"onredirect": false,
"lunchreasonid": 120,
"lunchreasonmsg": ""
}
]
</pre>

-------------------------------------------------------------------
<<< '''wp_getuserstate'''

Запрос от сервера CRM на возврат состояния указанного пользователя. Исполняется от имени сервера, даже если пользователь подключен с помощью другого подключения или из толстого клиента. Пользователь задается с помощью одного из ключей (wp - рабочее место, line - линия, user - пользователь).

<pre>
[
"wp_getuserstate",
{
"qid": "2A45010A-8EEA-4876-90CB-F062459D4BE2",
"wp": "...",
"line": "...",
"user": "..."
}
]
</pre>

>>> '''wp_getuserstateresult'''

Ответ на запрос ''wp_getuserstateresult''.

<pre>
[
"wp_getuserstateresult",
{
"qid": "2A45010A-8EEA-4876-90CB-F062459D4BE2",
"wp": "...",
"line": "...",
"user": "...",
"found": true,
"userid": "BDB8519F-AE77-4E33-81DB-41EE8E7D4E33",
"stateid": 5,
"statestr": "usFullBusy",
"onredirect": false,
"onlunch": true,
"oncc": true,
"onccmanual": false
}
]
</pre>

-------------------------------------------------------------------
<<< '''getuserstates'''

Запрос от сервера CRM на получение состояний всех пользователей в системе вне зависимости от того, где они авторизованы и авторизованы ли вообще.

<pre>
[
"getuserstates",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F"
}
]
</pre>

>>> '''getalluserstatesresult'''

Ответ на запрос ''getuserstates''.

<pre>
[
"getalluserstatesresult",
{
"qid": "F19E223C-3EF3-4002-B1D6-B756DF8E978F",
"users":[
{
"userlogin": "Иванов",
"userid": "3357F4D2-B37C-4809-9A1A-E4D64808DE1B",
"userstate": 5,
"userstateid": 5,
"userstatestr": "usFullbusy",
"onredirect": true,
"onlunch": false,
"oncallcenter": false,
"onccmanual": false
},
...
]
}
]
</pre>

-------------------------------------------------------------------
<<< '''closecallbychain'''

Запрос от сервера CRM на завершение коммутаций, принадлежащих указанной сессии (цепочке коммутаций). Исполняется от имени сервера, даже если пользователь подключен с помощью другого подключения или из толстого клиента

<pre>
[
"closecallbychain",
{
"qid": "2A45010A-8EEA-4876-90CB-F062459D4BE2",
"idchain": "A7623B51-41F5-42E6-A2AE-1063C52D010A"
}
]
</pre>

>>> '''closecallbychainresult'''

Ответ на запрос ''closecallbychain''.

<pre>
[
"closecallbychainresult",
{
"qid": "2A45010A-8EEA-4876-90CB-F062459D4BE2",
"found": true
}
]
</pre>

====Прочие====

Существует также набор методов и событий для рабочего места оператора и отображения диалоговых форм.
Их реализация осуществлена в web-клиенте Oktell и нетривиальна, поскольку требует от клиентского модуля четкого исполнения требований по логическому взаимодействию с менеджером задач сервера Oktell. В частности именно на клиентскую часть возлагается работа по решению вопроса о множественном отображении диалоговой формы и о предоставлении серверу данных по ее заполнению, кэширование метаданных диалоговых форм, подтверждения получения и исполнения запросов и т.д.

Запросы, команды и события от CRM к Oktell:
* cc_getcallstates (ответ cc_getcallstatesresult)
* cc_getuserresults (ответ cc_getuserresultsresult)
* cc_getlunchtypes (ответ cc_getlunchtypesresult)
* dlgcard_setsupported (ответ dlgcard_setsupportedresult)
* dlgcard_confirmgot
* dlgcard_confirmresult
* dlgcard_showformdone
* dlgcard_getmetadata (ответ dlgcard_getmetadataresult)
* dlgcard_getcachedvalues (ответ dlgcard_getcachedvaluesresult)
* dlgcard_setvaluesonclose
* dlgcard_setcontrolvalue
* dlgcard_setresultonnext
* dlgcard_setresultonstop
* dlgcard_setstopformresult

События из Oktell в CRM:
* dlgcard_showreserve
* dlgcard_showconfirm
* dlgcard_showformstop
* dlgcard_showformdialog
* dlgcard_closeall
* dlgcard_closereserve
* dlgcard_closeformreturnvalues
* dlgcard_closeformreturncomment

Параметры файлов конфигурации

2023-06-16T10:45:29Z

Oktell Support: /* Параметры файла конфигурации серверного приложения */

[[Техническая документация|Наверх]]

__TOC__

Ряд настроек комплекса хранится в файлах конфигурации соответствующих приложений. Файл конфигурации загружается однократно в момент запуска приложения, и хранящиеся в нем настройки не могут быть изменены в ходе работы. Любые изменения файлов конфигурации применяются только при следующем запуске соответствующего приложения.

Настройки файла конфигурации клиентского приложения влияют на работу только конкретного клиента.

Файлы конфигурации находятся в том же каталоге, в котором расположен запускаемый модуль.

Файл конфигурации клиентского приложения: oktell.ClientStarter4.exe.config

Файл конфигурации серверной службы: oktell.ServerService.exe.config (приложения - oktell.ServerForm.exe.config)

Файлы конфигурации есть также у ряда сопутствующих сервисов: служба файл-сервера, служба обмена межсерверными сообщениями, служба туннелирования запросов в БД, служба сервера видео-конференций, и т.д.

Изменять файлы необходимо в редакторах, не изменяющих кодировку (рекомендуется стандартный редактор «Блокнот»). Такие редакторы как «Microsoft Word» и «Wordpad» сбивают кодировку, в следствие чего запуск приложения системы становится невозможным. При попытке запуска с некорректным конфигурационном файлом возникает системное окно с описанием ошибки.

Конфигурационные файлы содержат ряд служебных настроек, поэтому в целях сохранения целостности и работоспособности не рекомендуется изменять формат файла и параметры, у которых нет описания.

Формат представляет собой стандартный XML-документ со специфическими элементами. Допустимые настройки находятся в разделе между тегами <appSettings> и </appSettings>. Каждый конкретный параметр представляет собой строку

<pre> <add key="KEY_STRING" value="VALUE_STRING" /></pre>

где KEY_STRING-название параметра,VALUE_STRING-значение параметра.Комментарии располагаются между строками <nowiki></nowiki>.

__TOC__

===Обновление клиентских конфигураций===

При необходимости обновить настройки файлов конфигурации у всех или некоторых клиентов можно воспользоваться системой обновления (каталог LiveUpdate сервера). Размещение клиентского конфигурационного файла целиком возможно только в том случае, когда все настройки, включая адрес сервера, идентичны у всех клиентов. При различиях можно воспользоваться служебным механизмом частичного обновления: файлы update*.config, находящиеся в каталоге LiveUpdate, сортируются лексикографически и применяются к тем клиентам, которые определены в настройках каждого из этих файлов. При этом могут быть указаны конкретные клиентские места, или исключения. Клиентские места указываются с помощью идентификатора, определяющего его в карте сети (любой принадлежащий ему IP-адрес, имя хоста, либо хеш-идентификатор, определенный ключом [[#ManualHostAddress|ManualHostAddress]]).

Например, нижеприведенный файл update1.config применится на всех клиентах, локальный адрес которых 192.168.0.12 или 192.168.0.13.
При этом будут добавлены/обновлены ключи "xxx" и "yyy", а ключ "zzz" будет удален.

<pre>
<?xml version="1.0"?>
<configuration>

<updateAddress>
<include address="192.168.0.12"/>
<include address="192.168.0.13"/>
</updateAddress>

<appSettings>

<add key="xxx" value="111" />
<add key="yyy" value="555" />
<add key="zzz" />

</appSettings>

</configuration>
</pre>

По умолчанию при отсутствии раздела ''updateAddress'' изменение конфигурационного файла производится на всех клиентских рабочих местах, подключающихся к серверу.
Могут быть обновлены конкретные (<include address="*"/>), или все кроме указанных (<exclude address="*"/>), где * - IP-адрес, имя хоста или хеш-идентификатор.

Обновиться самостоятельно могут только те клиенты, которые в силу текущих настроек конфигурационного файла способны подключиться к серверу.

===Параметры файла конфигурации серверного приложения===

Language. Определяет языковую схему, используемую комплексом. В основном каталоге приложения находятся файлы Lang*.xml, представляющие собой наборы текстов для отображения в клиентских интерфейсах и БД. Для выбора того или иного языка необходимо в качестве значения данного параметра выставить соответствующее расширение имени файла (*). Например для использования файла LangRus.xml необходимо прописать значение «rus».

Язык по умолчанию – русский (применяется, если в конфигурационном файле не указан язык, или если не найден файл указанного языка).

Русский также является базовым языком. То есть если какого-либо кода не найдено в файле языка, то в альтернативу будет применен русский текст, заданный в коде программы. Язык также определяется в конфигурационном файле клиентского приложения, но после подключения к серверу клиентское приложение синхронизирует язык с установленным на сервере.

Локализация программы производится компаниями-партнерами, файлы с текстами могут распространяться в открытом и шифрованном виде. В последнем случае осуществляется привязка к лицензии.

HALSeparate. Режим запуска модуля поддержки оборудования. «0» - в текущем процессе, «1» - в отдельном процессе используя взаимодействие через NET.Remoting, «2» - в отдельном процессе используя собственный альтернативный канал связи по протоколу TCP.

В случае, если оборудование в некоторых случаях вызывает критические ошибки, подгрузка модуля поддержки оборудования в отдельном процессе позволяет не терять основной работоспособности сервера. В моменты падения процесса основная служба перезапускает его, производит фоновую регистрацию и продолжает работу.

В момент перерегистрации все линии переходят в состояние «Отключена», пользователи переходят в состояние «Без телефона», все коммутации разрываются, логика резервирований очищается. Менеджер задач реагирует способом, аналогичным тому случаю, когда абоненты на внешних линиях положили трубки. Возможно файлы записей оборвавшихся разговоров будут иметь некорректный заголовок, что сделает невозможным их прослушивание стандартными средствами. Полностью процесс автоматической переинициализации занимает 5-10 секунд.

HALRemoteAddress. Адрес расположения вынесенной в отдельной процесс службы HAL. По умолчанию localhost.

HALRemotePort. Порт доступа к вынесенной в отдельный процесс службе HAL. По умолчанию 4052.

'''Раздел Настройки серверов HAL.'''

START_SERVER. Индексированные параметры, определяющие запускаемые серверы аппаратуры. Доступные серверы: Сервер CTI плат Ольха-9, Сервер CTI плат Ольха-14, сервер CTI плат Synway, сервер SIP, серверы VoIP телефонии. При установке системы параметры выставляются согласно выбранным в дистрибутиве значениям. Однако в сложных системах могут потребоваться модификации. Например, в случае если происходит замена типа платы на рабочей системе, использование нескольких разных типов плат, а также при запуске нескольких VoIP серверов, обслуживающих разные подсети. Загрузке подлежат серверы с индексами от 1 до 32 (в примере - часть строки XX).

Сервер плат «Ольха 9», «Ольха 14»:

<pre><add key="START_SERVER_XX" value="Alder9 Server;oktell.HALAlder9Srv.dll;Alder9;_Loaders\" />

<add key="START_SERVER_XX" value="Alder14 Server;oktell.HALAlder9Srv.dll;Alder14;_Loaders\" /></pre>

Последний элемент строки после точки с запятой указывает путь к файлам-загрузчикам. По умолчанию это подкаталог серверной службы _Loaders.

Сервер плат «Synway»:

<pre><add key="START_SERVER_XX" value="Synway Server;oktell.HALSynwaySrv.dll;ShCti;" /></pre>

Сервер плат «Yeastar»:

<pre><add key="START_SERVER_XX" value="E1 Yeastar Server;oktell.HALYeastarSrv.dll;YeaCTI" />

<add key="START_SERVER_XX" value="TDM800 Yeastar Server;oktell.HALYeastarSrv.dll;TDM800" /></pre>

Сервер SIP:

<pre><add key="START_SERVER_XX" value="SIP Server;oktell.HALSipSrv.dll;SIP;sip:*:5060" /></pre>

Последний элемент строки после точки с запятой устанавливает детальные настройки сетевого интерфейса и порта, на которых запускаемый SIP-сервер будет активен. По умолчанию «sip:*:5060», то есть сервер слушает все интерфейсы на порте 5060. При необходимости установить какой-либо конкретный интерфейс необходимо вместо «*» указать его адрес.

Серверы VoIP:

<pre><add key="START_SERVER_XX" value="Buildin VOIP Server;;Voip;localhost:4003" /></pre>

Последний элемент строки после точки с запятой указывает сетевой интерфейс и порт слушателя регистраций локальных устройств. При необходимости использования сервера для поддержки локальных устройств разных подсетей возможно запустить несколько VoIP-серверов - несколько однотипных строчек файла конфигурации с разными индексами и разными сетевыми интерфейсами.

Сервер виртуальных каналов

<pre><add key="START_SERVER_XX" value="Virtual Server;oktell.HALVirtualSrv.dll;VS;12/10" /></pre>

Последний элемент строки указывает количество используемых каналов - внешних/внутренних.

RTP_PORT_START. Начальный порт для обмена RTP-трафиком медиа-подсистемой (SIP, VoIP). По умолчанию 9000.

RTP_PORT_COUNT. Количество портов, начиная со стартового, доступные для медиа-подсистемы (SIP, VoIP). По умолчанию 10000.

RTP_MAX_CHANNELS. Количество сокетов получения RTP-трафика на один поток-слушатель. От 1 до 32. (SIP, VoIP). По умолчанию 8.

USE_AFFINITY_MASK. «1» - использовать разделение задач по процессорам. Половина процессоров для сервера логики, другая половина для сервера HAL. «0» - значение по умолчанию. В этом случае операционная система самостоятельно занимается распределением.

JITTER_DEPTH. Значение глубины джиттер-буфера на сервере. Минимальное значение - «4», по умолчанию - «4». При увеличении значения происходит рост задержки в голосовом обмене по направлению звука к серверу, эффективнее исключая влияние проблем сети.

TIMER_TYPE. Тип используемого таймера высокой разрешающей способности для тактирования звуковых пакетов. На разных операционных системах и компьютерах различные варианты таймеров могут иметь достаточно сильную погрешность, влияющую на итоговое качество звука. Основная задача при выборе таймера состоит в обеспечении корректного среднего промежутка времени между тиками. Замечены случаи, когда некоторые из вариантов таймеров ОС тактируют постоянно увеличенные интервалы времени (например постоянно 46 мс вместо 40 положенных). Если не происходит корректировок, то такой таймер следует заменить на другой тип. Для определения значений всех вариантов таймеров можно использовать специальное тестовое приложение.

Возможные значения:

:::0 - Системный таймер по умолчанию. Дает более точное тактирование по сравнению с таймером на ожидании. Выдает точное тактирование в Windows Vista и некоторую погрешность в предыдущих версиях Windows. Система буферизации звука в этом случае сглаживает разброс, однако существуют компьютеры, где погрешность таймера постоянна. Это влечет пропуск пакетов и заметное ухудшение итогового качества звука. На таких компьютерах необходимо использовать другие типы таймеров. Рекомендуется мультимедийный.

:::1 - Системный таймер в собственном потоке приложения.

:::2 - Имплементация таймера в потоке с использованием функции WaitForSingleObject().

:::3 - Мультимедийный таймер. Дает наиболее точное тактирование, однако имеет общее ограничение на количество одновременно существующих таймеров в системе (16 объектов). Сервер Oktell использует 3 объекта таймера высокой разрешающей способности.

:::4 - Автоопределение. На старте системы осуществляется тестовый прогон всех вариантов таймеров и определяется средне наиболее точный. В случае, если все имеют одинаковую среднюю точность, предпочтение отдается таймеру с меньшим индексом (таймер по умолчанию системный, таймер ожидания, мультимедийный). На прогон теста на старте системы выделяется лишняя секунда.По умолчанию «4».

TIMER_HIGHRES. Тип используемого счетчика интервалов времени. «0» - миллисекундный системный счетчик GetTickCount, «1» - Query Performance Counter. По умолчанию «1».

<div id="FORCE_BRACKETS_FOR_URI"></div>
FORCE_BRACKETS_FOR_URI. «1» - значения заголовков To и From отправляемых SIP-пакетов размещаются в треугольных скобках. По умолчанию «0».

<div id="EnableSipTransportFilter"></div>
EnableSipTransportFilter. «1» - активирует на сервере спам-фильтр, защищающий от атак на SIP-подсистему. При поступлении с одного IP-адреса за короткий отрезок времени чрезмерно большого количества регистрационных пакетов, завершающихся неудачей по причине неверной авторизационной информации, осуществляется блокирование адреса на период времени, указанный в параметре и исчислимый в минутах. На все попытки регистрации с заблокированного IP-адреса сервер не отвечает никаким образом. По умолчанию 1440 минут (= 1 сутки), 1 - не отключать фильтрацию адреса вплоть до перезагрузки сервера, остальные действительные значения являются непосредственными значениями интервала в минутах. 0 - режим отключен.

'''Раздел Настройки клиентских подключений.'''

PBXServerPort. Порт для подключения собственных клиентских приложений через механизм NET.Remoting (устаревш.).

InternalClientPort. Порт для подключения собственных клиентских приложений и приложений на базе клиентского ядра через встроенную надстройку над протоколом TCP. По умолчанию 4054.

ExternalClientPort. Порт для подключения внешних приложений 4053.

SIP_ENABLE_TCP. Разрешает TCP-подключение по протоколу SIP. Конкретный порт зависит от настроек SIP-сервера (по умолчанию 5060). «0» - не активно, «1» - активно. По умолчанию «0».

'''Раздел Настройки автодозвона.'''

ACM_UseIntercom. «1» - активирует интерком-звонок при автодозвоне, в случае схемы "абонент, затем пользователь", «0» - выключает. По умолчанию «1»

ACM_DisableIntercomModeBack. «0» - активирует интерком-звонок при автодозвоне, в случае схемы "пользователь, затем абонент", «1» - выключает. По умолчанию «0»

'''Раздел Настройки рабочего каталога.'''

WORK_ROOTDIR. Устанавливает в явном виде путь к рабочей папке серверной службы. Временные файлы, сценарии, проекты, плагины, каталог по умолчанию для записи разговоров, резервные копии - все, кроме основных сборок службы, размещается именно там.

WORK_ROOTDIR_TYPE. Устанавливает один из нескольких возможных вариантов размещения рабочей папки. Используется, если не задана рабочая папка в явном виде. Возможные варианты: 0 – папка запустившего процесс выполняемого файла, 2 – Documents And Settings\All Users, 3 – Documents And Settings\CurrentUser (''C:\Users\User\AppData\Roaming\Oktell\Client\Scripts\Ivr'')

'''Раздел Настройки доступа к БД.'''

DBServerName. Адрес сервера, на котором находится база данных MSSQL. По умолчанию «(local)».

DBName. Имя основной оперативной базы данных, к которой производится подключение. По умолчанию «oktell».

DBNameCC. Имя базы данных статистики call-центра. По умолчанию «oktell_cc_temp».

DBNameSettings. Имя базы данных с настройками системы. По умолчанию «oktell_settings».

DBLogin. Имя пользователя, учетной записью которого пользуется система. По умолчанию «AutelService».

DBInstanceName. Имя экземпляра сервера MSSQL. По умолчанию «MSSQLSERVER». Для доступа к службе, обеспечивающей работу БД. В момент запуска службы Oktell осуществляется проверка доступности БД. Если SQLServer, обслуживающий БД коммуникационного сервера, находится на том же компьютере, что и служба Oktell, то при невозможности обращения к БД Oktellпроверяет и перезапускает локальную службу SQLServer (указанный instance).

Если работа SQLServer осуществляется на другом компьютере, то во избежании запуска службы SQLServer на локальной машине в значение поля можно поставить «0». Октелл будет осуществлять бесконечное ожидание корректного подключения к БД перед началом загрузки, а сервер баз данных не будет загружать в ОЗУ свои данные, тем самым коммуникационный сервер будет гарантирован от кэширования данных на диск, и, как следствие, временных приостановок операционной системой работы всех служб и приложений в ожидании завершения операции, что достаточно критично при активных коммутациях.

DBConnectionString. Строка подключения, задаваемая явно. Используется при настройке подключения к службам SQL с индивидуальными параметрами, при которых не подходят параметры по умолчанию. При отсуствии этого свойства, или пустом его значении, подставляется строка:

<pre>"server=(local);database=oktell;uid=AutelService;pwd=[pwd];pooling=true",</pre>

где значения параметров server, database и uid подставляются из вышеописанных свойств. При явном указании строки подключения пароль может быть указан явно, либо использована последовательность символов «[pwd]», указывающая системе на необходимость подстановки пароля для логина AutelService.

DBTransactionLogSize_1, DBTransactionLogSize_2. Размеры транзакционных лог-файлов баз данных - основной и пространственной. По умолчанию по 500 МБ.

DBBackupDir. Путь к каталогу на сервере баз данных, в котором осуществляется создание резервных копий баз данных. По умолчанию это Backup в рабочей папке сервера. Однако в случае, если сервер баз данных работает на отдельном компьютере, путь должен существовать именно на нём.

DBAutoDailyBackup. «1» - устанавливает режим автоматического ежедневного резервного копирования баз данных одновременно с оптимизацией используемых баз данных. Режим оптимизации сам по себе настраивается в разделе [[Управление базами данных|Администрирование. Общие настройки. Управление базами данных]]. Если режим ежедневной оптимизации отключен, то вне зависимости от значения описываемого параметра резервная копия создана не будет. Cоздание файлов резервных копий производится на компьютере, где установлен текущий используемый MSSQLServer. Файлы размещаются в каталоге, установленном параметром [[#Параметры файла конфигурации серверного приложения|DBBackupDir]], а при его отсутствии в каталоге, путь к которому совпадает с рабочей папкой службы сервера в подкаталоге \Backup. Файлы резервных копий баз имеют названия db_ok.bak, db_okcc.bak, db_okset.bak, при ежедневном автоматическом создании резервных копий предыдущие резервные копии автоматически заменяются новыми. При необходимости осуществлять хранение нескольких копий за некоторый промежуток времени необходимо налаживать схему бэкапа или копирования файлов самостоятельно.

ScrBackupDir. Путь к каталогу на сервере АТС, в котором осуществляется создание резервных архивов со сценариями. По умолчанию это каталог Backup в рабочей папке сервера.

RepUpdateDir. Каталог с обновлениями отчетов call-центра.

DBUpdateDir. Каталог с обновлениями для БД.

DBUpdateDirExtern. Каталог с внешними обновлениями для БД. Расположенные здесь файлы с текстом, представляющим собой один совокупность нескольких SQL-batch, исполняются в БД по очередности их имен в момент запуска сервера. После успешного исполнения файлы удаляются. В случае возникновения ошибок их описание можно обнаружить в лог-журнале Exception.

PauseTMOnDbQueueLength. Определяет количество сообщений в очереди на сохранение в БД, при котором менеджер задач приостанавливает совершение звонков по исходящим голосовым задачам. Система считает, что таким образом нагрузка уменьшается, и БД имеет больше шансов к уменьшению очереди запросов. По умолчанию 100. Бывают случаи временной загрузки БД, когда своп происходит редко и длится в течение минуты или более того, а в остальные случаи сервер БД не подвержен притормаживанию. В этом случае имеет смысл оценить производительность сервера и увеличить максимальный предел очереди вплоть до нескольких тысяч. Отсутствие предела может привести в особо критичных случаях к тому, что данных в очереди накопится чрезмерно много, что выльется либо в нехватку памяти процессу, либо в несохранение результатов звонков после их совершения в случае сбоя сервера или базы данных.

PauseProgressiveOnDbQueueLength. Аналогичный предыдущему параметр для прогрессивного пула задач. Может иметь обособленную настройку и сказывается на запуск прогрессивных исходящих звонков. По умолчанию 50;

<div id="DbRemote"></div>
UseDbRemote. Довольно большое количество обращений из клиентских приложений к серверу являются суть запросами к БД. 1 - использует отдельный процесс туннелирования (oktell.DbRemoteService.exe) для прямых обращений к БД из клиентских приложений. 0 - все обращения к БД через основную службу. По умолчанию 0. При подключении к службе туннелирования все клиенты проходят аутентификацию. Служба туннелирования получает параметры доступа к БД из конфигурационного файла основной службы Oktell. Собственный конфигурационный файл необходим лишь для определения способа старта (служба или приложение), порта слушателя TCP подключений, а также возможно некоторых настроек логирования.

CheckStartDbRemote. Применяется в случае использования отдельного процесса туннелирования доступа клиентских приложений к БД. 1 - указывает серверу на необходимость самостоятельного запуска процесса; процесс при этом запускается на том же физическом сервере, где и основная служба Oktell; при завершении службы при этом процесс выгружается. 0 - указывает на необходимость подключения к постоянно запущенной службе (при этом служба может находиться на другом физическом сервере). По умолчанию 1. В конфигурационном файле службы туннелирования устанавливается, какой способ запуска используется - как служба или как приложение (ключ IsService). Настройки доступа к процессу туннелирования и самого процесса должны соответствовать друг другу.

DbRemoteServer. Применяется в случае использования отдельного процесса туннелирования доступа клиентских приложений к БД. Определяет адрес и порт для TCP доступа к приложению («address:port»). Сервер с помощью них осуществляет самостоятельное подключение для управления, а также выдает этот адрес клиентам для организации их собственных каналов связи. В случае, если указан localhost (используется по умолчанию), сервер выдает клиентам свой публичный адрес. Порт указывается в конфигурационном файле приложения/службы oktell.DbRemoteService.exe, по умолчанию 4086.

'''Раздел Настройки службы.'''

EnableEmptyAdmin. «1» - активирует на сервере возможность пользования учетной записью системного администратора. По умолчанию запись доступна только на сервере, где неактивен сервер состояний или среди учетных записей пользователей которого не существует ни одной, обладающей базовой ролью администратора. Может понадобиться в случае, если пароль учетной записи администратора утерян. Для применения требуется перезапуск службы сервера. По умолчанию «0».

<div id="EnableAutoMap"></div>
EnableAutoMap. «1» - активирован режим, при котором авторизация с рабочего места, не имеющего в карте сети учетной записи, приводит к автоматической временной регистрации на сервере рабочего места, снабженного USB-телефоном. «0» - доступ с неизвестных рабочих станций заблокирован. В целях обеспечения работы веб-клиентов, значение по умолчанию «1».

<div id="EnableAutoMapSip"></div>
EnableAutoMapSip. «1» - активирован режим, при котором при динамической регистрации вместо создания динамической линии USB-телефона производится связка с существующим в карте сети SIP-телефоном. Связка осуществляется по совпадению логина телефона с логином пользователя, либо по совпадению назначенного «пользователя по умолчанию» с авторизующимся пользователем. Для работы требуется включение параметра [[#EnableAutoMap|EnableAutoMap]]. «0» - связка динамических рабочих мест с SIP-телефонами не используется.

UseWlockForDynamicReg. «1» - использовать блокировку писателя при добавлении/удалении динамических рабочих мест. По умолчанию «0» - использовать блокировку читателя.

<div id="Use4xLineNumbers"></div>
Use4xLineNumbers. «1» - использовать при создании линий четырехзначную числовую нумерацию (0000-9999). Может быть использовано в проектах с более чем 1000 линий одного типа. По умолчанию «0».

ManualHostAddress. Устанавливает уникальное имя сервера для идентификации в карте сети на старте службы. В случае, если в качестве адреса сервера в карте сети указано это значение - позволяет устранить зависимость от смены DNS-имени, а также смены и назначения динамических адресов сервера.

Следует обратить внимание, что сервер может являться также и клиентской рабочей станцией. В этом случае необходимо в файл конфигурации клиентского приложения на сервере задать аналогичный параметр тем же значением, либо создать в карте сети отдельный компьютер с указанным реальным адресом или любой другой уникальной строкой (в случае использования на клиенте аналогичной схемы подмены адреса).

ProcessPriority. Приоритет серверного процесса. По умолчанию «0» - Нормальный. «1» - выше среднего, «2» - высокий, «3» - реального времени.

HALRemoteProcessPriority. Приоритет процесса HALRemote. «0» - нормальный, «1» - выше среднего (по умолчанию), «2» - высокий, «3» - реального времени.

Default_DateTime_Format. Индексированные параметры, определяющие нестандартныей варианты преобразования типа СТРОКА к типу ДАТАВРЕМЯ. Используются строки с индексами от 0 до 99, перебор в ходе работы осуществляется в порядке увеличения индексов.

MixerDeleteSourceRecords. «1» - удалять исходные файлы записей коммутаций после упаковки и/или микширования, «0» - оставлять на месте. По умолчанию «1».

CheckRecordDriveEmptySpace. «1» - осуществляет слежение за объемом свободного места на диске для записи разговоров. «0» - игнорирует проверку. Игнорирование может потребоваться при использовании сетевых дисков для записи, размер свободного пространства которых системой определяется нулевым, а также при использовании файлового сервера. По умолчанию «1».

TaskListAbonentUseLikeNumber. «1» - позволяет активировать поиск абонентской строчки в таблице абонентов с фильтром "number like '%x%'". По умолчанию «0» и поиск осуществляется только по идентификатору абонента.

SkipCloseMutexCommand. Режим автоматического закрытия сервера через мьютекс-команду необходим в целях исключения проблем с операциями обнаружения процессов. Встречаются системы, в которых отключены или недееспособны службы, необходимые для обнаружения внешнего процесса. В этом случае процесс копира не в состоянии при необходимости остановить серверный процесс перед обновлением и/или для перезапуска. «1» - пропускать команду закрытия, отданную через системные мьютексы процессом копира. «0» и другие значения - команда будет распознаваться и сервер будет реагировать на нее автоматическим закрытием.

<div id="UseSimpleLineState"></div>
UseSimpleLineState. Определяет способ привязки состояний внутренних номеров, ссылающихся на линии к состоянию самих линий. Если указать 0, то состояние номера, в случае свободности подчиненной ему линии, будет оцениваться по состоянию привязанного к ней пользователя. По умолчанию 1.

<div id="HideGhostMonitor"></div>
HideGhostMonitor. 1 - скрывает [[Прослушивание и помощь|слушателей разговора]] друг от друга, 0 - делает их доступными друг другу. По умолчанию 1.

<div id="GCCollectorPeriodMin"></div>
GCCollectorPeriodMin. Определяет периодичность принудительного запуска сборщика мусора .NET в минутах. По умолчанию 1 минута.

<div id="UseNumStateChangedEventDelayer"></div>
UseNumStateChangedEventDelayer. Интервал в мс, определяющий задержку перед рассылкой уведомлений о смене состояния номеров в номерном плане. 0 - выключено. По умолчанию 500. Применяется при большом количестве номеров и пользователей, следящих за их изменением. За время задержки происходит накопление данных и отправка одним пакетом. Позволяет экономить вычислительную мощность.

DEBUG_incomingemail. Логирование в common логе сервера принимаемых e-mail сообщений (pop3) "1" - включено. По умолчанию выключено.

<div id="DEBUG_LogActiveThreadStackTrace"></div>
DEBUG_LogActiveThreadStackTrace. При установке значения «1» производит вывод в лог ''DEBUG'' информации о стеке всех активных потоков основной службы сервера.

<div id="UsePriorSwitchCallername"></div>
UsePriorSwitchCallername. При осуществлении переключения из сценария на внутренний номер определяет, что будет отображаться в качестве имени абонента (callername) на sip-телефоне. 0 - автоопределение; если пусто, то callername из компонента «Переключение на номер» сценария IVR. 1 - наоборот, с приоритетом заданного в компоненте значения. По умолчанию 1.

UserMessageCheckPeriodSec. Позволяет активировать отслеживание появления новых сообщений между пользователями в базе данных и отправить их на отображение. Применяется в случае индивидуальной или внешней настройки и отправки сообщений путем размещения в таблицу A_UserMessages в БД. Указывается период отслеживания появления новых в секундах. 0 - выключено. По умолчанию 0.

<div id="UserMessageCheckMakeViewed"></div>
UserMessageCheckMakeViewed. В случае периодического отслеживания появления новых сообщений между пользователями в БД, указывает, отмечать ли их сразу как прочитанные с тем, чтобы при следующей итерации они не возникали вновь.

<div id="DBPluginCommandTimeoutSec"></div>
DBPluginCommandTimeoutSec. Позволяет задать таймаут в секундах на исполнение запросов от плагинов к БД. По умолчанию 600. Начиная с версии 120911.

<div id="AllowDownloadFilesDirectlyOnlyFromTemp"></div>
AllowDownloadFilesDirectlyOnlyFromTemp. 1 - блокирует скачивание файлов с сервера через HTTP интерфейс отовсюду, кроме как из временной папки Temp и [[Настройки веб-сервера#LocalStoragePath|локального хранилища]]. 0 - разрешает скачивать произвольные файлы с диска сервера по прямой ссылке. По умолчанию 1 (блокировать).

<div id="BanUserAgent"></div>
BanUserAgentXX, XX - порядковый номер от 00 до 99. Позволяет установить SIP-транспортный фильтр для определенных значений поля User-Agent. По умолчанию банится "Friendly-Scanner" в целях снижения нагрузки и уменьшения вероятности взлома.

<div id="WhiteListIps"></div>
WhiteListIps. Позволяет установить список разрешённых IP-адресов, которые исключаются из проверки спам-фильтром. Можно указать несколько адресов через точку запятой. По умолчанию пустой список.

<div id="UpdateSelectorOnDirectorDisconnect"></div>
UpdateSelectorOnDirectorDisconnect. 1 - при выходе/выпадении управляющего из селекторного совещания производит преобразование селектора к общей конференции. 0 - оставляет селектор с теми правами и в том виде, в котором он находился в последний момент присутствия управляющего. По умолчанию «1».

<div id="PBX_Use180SdpAs183"></div>
PBX_Use180SdpAs183. 1 - воспринимает команду ''180 Ringing'' с SDP содержимым как команду ''183 Progress'' и начинает сеанс медиасвязи. Используется в режиме ''прослушивание медиа-потока'' компонента [[Компоненты_сценариев_IVR#SwitchExt|Переключение на внешние линии]]. 0 - генерирует стандартный сигнал КПВ (длинные гудки). По умолчанию 1.

<div id="PBX_BackFrom183To180"></div>
PBX_BackFrom183To180. 1 - воспринимает команду ''180 Ringing'' к обязательному исполнению - начинает генерацию сигнала КПВ (длинные гудки), даже если предварительно был получен ответ ''183 Progress'' и канал находится в медиа-коммутации. Используется в режиме ''прослушивание медиа-потока'' компонента [[Компоненты_сценариев_IVR#SwitchExt|Переключение на внешние линии]]. 0 - пропускает такую команду. По умолчанию 0.

<div id="UseAssertedIdentity"></div>
UseAssertedIdentity. Включает отправку SIP-заголовоков ''P-Asserted-Identity'' и ''Remote-Party-ID'' в ответ на входящие вызовы с внутренних SIP-устройств на сервер с целью отправить на отображение в SIP-устройство ''Сaller-name'' вызываемого абонента. Применяется в случае осуществления вызова на внутренний номер.

<div id="ScreenShotSize"></div>
AutoScreenshotWidth, AutoScreenshotHeight. Определяют максимальные размеры скриншотов экранов, снимаемых с помощью компонента сценариев [[Общие компоненты сценариев#UserState|Статус объекта]].

<div id="PredictivePoolTimerIntervalMs"></div>
PredictivePoolTimerIntervalMs. Устанавливает общий для всей системы интервал пересчета параметров предиктивных задач в мс, в ходе которого могут быть начаты новые дозвоны (по умолчанию 5000).

<div id="PredictivePoolClearStatOnDeactivate"></div>
PredictivePoolClearStatOnDeactivate. Устанавливает общий для всей системы режим очистки статистики в предиктивных задачах при деактивации (по умолчанию 0).

<div id="PredictivePoolExtraShiftTimeoutMs"></div>
PredictivePoolExtraShiftTimeoutMs. Устанавливает общий для всей системы дополнительный интервал в мс, применяемый безусловно к спрогнозированным параметрам. Может быть отрицательным и положительным. Если указать положительное число, следующий звонок будет совершаться с запозданием, давая операторам некоторое дополнительное время, например, для перерыва. Если указать отрицательное число, следующий звонок будет совершаться раньше, чем это требуется, тем самым ускоряя темп обзвона. По умолчанию 0.

<div id="WebServerNoAuth_Loopback"></div>
WebServerNoAuth_Loopback. Позволяет отменить требование базовой авторизации при обращении к веб-серверу по loopback-интерфейсу (из приложений на самом сервере). По умолчанию 0.

<div id="FileServer"></div>
FileServer_Log, FileServer_Record. Позволяет активировать сохранение соответственно лог-журналов и записей разговоров на удаленный файл-сервер. Значение задается в формате «address:port», например «192.168.0.199:4088». В качестве файлсервера может выступать любой компьютер с установленной и активированной службой oktell.FileService.exe из каталога серверной службы Oktell. О настройке и способах работы файл-сервера доступна [[Запись лог-журналов и записей разговоров на удаленный файловый сервер|статья]] в базе знаний.

<div id="FileServerRecDir"></div>
Хранение записей может происходить в разных каталогах в соответствии с настройкой в Oktell. При использовании файл-сервера в качестве хранилища записей может потребоваться подключать дополнительные хранилища и изменять путь для сохранения записей и последующего доступа к ним. Чтобы это обеспечить, необходимо подвергать корректировке совместно настройку каталога для записи в Oktell и конфиг файлового-сервера. При этом в конфигурационном файле файлового сервера требуется указание соответствия переданного службой Oktell пути с локальным путем (ключ ''BaseDir_*'', где * - это subdir.ToLower(recordedfiles\dirname), а dirname - название последнего внутреннего каталога по выбранному службой Oktell пути; значение - локальный путь на файловом сервере. Например <add key="BaseDir_recordedfiles\path2" value="D:\_OktellWorkDir\Files\Base2\"/>. При настройке Oktell следует указывать пути, последний каталог которых имеет уникальное название и ранее не использовалось).

<div id="FaceTime"></div>
'''Раздел Настройки сервера видео-конференций.'''

FaceTimeLocalPort. Определяет порт локального сервиса видео-конференций. По умолчанию 4090.

FaceTimeServer. Определяет доступные серверы видео-конференций. Перечисляются через запятую с помощью алиасов, которые затем определяются отдельными ключами конфигурации. По умолчанию доступен только локальный сервер, но могут быть вместо или дополнительно настроены один или несколько обособленных серверов. Локальный сервер определяется алиасом «local». Например
<pre><add key="FaceTimeServer" value="local, futurama, videoserver"/></pre>

FaceTime_*. Определяет адрес и порт обособленного сервера видео-конференций. Вместо символа * подлежит указанию алиас сервера. Эта настройка должна присутствовать для каждого упомянутого алиаса кроме «local». Например
<pre><add key="FaceTime_futurama" value="192.168.0.10:4092"/></pre>

<div id="ThreadManagement"></div>
'''Раздел Управление потоками.'''

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

ThreadCountLowLimit. Количество потоков в общем пуле системы, свободно доступных службе сервера. По умолчанию 500.

ThreadCountHighLimit. Максимально допустимое количество потоков в общем пуле системы, доступных службе сервера. Потоки, находящиеся в разнице между нижним и верхним ограничениями, выделяются системой с запаздыванием. По умолчанию 700.

CachedThreadFreeMode. Режим работы пула асинхронных потоков. «0» по умолчанию - использовать пул, никогда не уничтожать потоки, «1» - не использовать пул, уничтожать потоки сразу после использования, «2» - размещать в пул на 1 секунду, уничтожать по истечении в случае простоя.

CheckReleaseRWOnAbort. По умолчанию «1» - производить дополнительную проверку блокировки критической секции сервера состояний перед освобождением асинхронного потока и освобождать в случае обнаружения. «0» - не производить.

OKTCP_CP_ThreadCountLimit. 0 - отключает ограничение на количество потоков, обслуживающих клиентские запросы.

OKTCP_CP_ThreadCountLimitHighest. Устанавливает максимально допустимое количество потоков, доступных системе для обработки высокоприоритетных клиентских запросов, таких как Ping. По умолчанию 10.

OKTCP_CP_ThreadCountLimitData. Устанавливает максимально допустимое количество потоков, доступных системе для обработки клиентских запросов, возвращающих большие объемы данных. По умолчанию 10. В момент длительной отправки данных по сети поток не считается использующимся.

OKTCP_CP_ThreadCountLimitDownload. Устанавливает максимально допустимое количество потоков, доступных системе для обработки клиентских запросов на скачивание и закачивание файлов. По умолчанию 10. В момент длительной отправки данных по сети поток не считается использующимся.

OKTCP_CP_ThreadCountLimitSetup. Устанавливает максимально допустимое количество потоков, доступных системе для обработки клиентских запросов из раздела администрирования. По умолчанию 5.

OKTCP_CP_ThreadCountLimitLiveupdate. Устанавливает максимально допустимое количество потоков, доступных системе для обработки клиентских запросов в части проверки обновлений, подготовки архива и его скачивания. По умолчанию совпадает с половиной общего количества ядер всех процессоров сервера, но не менее 2. В момент длительной отправки данных по сети поток не считается использующимся.

OKTCP_CP_ThreadCountLimitNormal. Устанавливает максимально допустимое количество потоков, доступных системе для обработки клиентских запросов в части проверки обновлений, подготовки архива и его скачивания. По умолчанию 100.

OKTCP_CP_ThreadCountLimitEvent. Устанавливает максимально допустимое количество потоков, доступных системе для рассылки событий клиентским приложениям. По умолчанию 10.

Этот же набор параметров с другим префиксом действует для службы туннелирования клиентских запросов в БД. Их указание требуется в конфигурационном файле сервера, так как конфигурационные параметры передаются в службу туннелирования из основной службы.
OKTCP_DB_ThreadCountLimit.
OKTCP_DB_ThreadCountLimitHighest.
OKTCP_DB_ThreadCountLimitData.
OKTCP_DB_ThreadCountLimitDownload.
OKTCP_DB_ThreadCountLimitSetup.
OKTCP_DB_ThreadCountLimitNormal.

OKTCP_HALL_ThreadCountLimit. Устанавливает максимально допустимое количество потоков, доступных системе для взаимодействия с внешним процессом HAL. По умолчанию 0 - не ограничено.

OKTCP_HALR_ThreadCountLimit. Применяется в конфигурационном файле внешнего процесса HAL (oktell.HALRemoteApp.exe) или в собственном (если процесс настроен на работу с конфигурационным файлом основной службы). Устанавливает максимально допустимое количество потоков, доступных внешнему процессу HAL для взаимодействия с основным процессом службы. По умолчанию 0 - не ограничено.

Line_ThreadCountLimit. Устанавливает максимально допустимое количество потоков, обслуживающих каналы АТС. По умолчанию 20.

Script_ThreadCountLimit. Устанавливает максимально допустимое количество потоков, обслуживающих сценарии. По умолчанию 20.

TML_ThreadCountLimit. Устанавливает максимально допустимое количество потоков, обслуживающих звонки в голосовых задачах. По умолчанию 10.

'''Раздел LOG.'''

Хранит настройки лог-сервера комплекса. Среди неописываемых настроек - пути к папкам для сбора журналов.

LOG_storedays. Длительность хранения лог-журналов в днях. По умолчанию «7». По истечении указанного периода журналы удаляются системой. В некоторых случаях объем журналов может достигать нескольких гигабайтов за день.

LOG_maxfilesize. Максимальный размер одного файла лог-журнала в МБ. При достижении лог-журналом указанного размера логирование прекращается. Имеет воздействие на все лог-журналы, исключая HAL (Hardware). По умолчанию 3 ГБ.

LOG_maxpartsize. Позволяет настроить максимальный размер одного файла в МБ. По умолчанию 500 МБ. При достижении лог-журналом указанного размера формируется новый файл. Имеет воздействие на все лог-журналы, исключая HAL (Hardware).

LOG_root. Абсолютный или относительный путь к папке с лог-журналами. По умолчанию «Log», то есть относительный путь в каталоге серверной службы/приложения.

LOG_asyncwrite. Использовать асинхронную запись в лог модулем аппаратуры. По умолчанию «0» - выключено.

LOG_cachesize. Размер кэша памяти(в Кб) хранения логов перед записью на диск. По умолчанию 128 Кб.

LOG_cachefreq. Частота(в мс) записи кэша на диск. По умолчанию 100 мс.

<div id="DebugLogTcpBufferSizeKB"></div>
DebugLogTcpBufferSizeKB. Позволяет включить логирование информации обо всех объемных пакетах, переданных или отправленных сервером. Указывается размер в KB, выше которого пакеты логируются в Debug лог. По умолчанию 0 - не логировать.

<div id="DebugLogCPEventTypes"></div>
DebugLogCPEventTypes. 1 - включает логирование информации обо всех событиях, отправляемых в клиентские приложения в Debug-лог. По умолчанию 0 - выключено.

WEBSOCK_LogTransform. При установке 1 выводит в лог TCP информацию о работе протокола WebSocket.

WEBSOCK_LogListener. При установке 1 выводит в лог TCP информацию о работе протокола WebSocket.

WEBSOCK_LogDebug. При установке 1 выводит в лог TCP информацию о работе протокола WebSocket.

WEBSOCK_LogPackets. При установке 1 выводит в лог TCP информацию о работе протокола WebSocket.

'''Раздел DEBUGGING.'''

Хранит настройки, согласно которым ведется заполнение служебного сервисного лог-журнала. По умолчанию все параметры выставлены в «1», что влечет полное логирование служб сервера. Полное или частичное отключение уменьшает размер журнала, однако не даст информации в случае возникновения сбоев и общением с технической поддержкой.

'''Раздел KEYREMOTE.'''

Хранит настройки для подключения к внешнему серверу, управляющему ключом защиты. Необходимо в редких случаях, если USB-порт на сервере не функционирует должным образом.

===Параметры файла конфигурации клиентского приложения===

Language. Определяет языковую схему, используемую клиентским приложением до момента подключения к соответствующему серверу. После подключения производится принудительная синхронизация языковой схемы. Фактически это происходит в момент отображения окна авторизации. Подробнее в [[#Параметры файла конфигурации серверного приложения|описании ключа]] в разделе серверного приложения.

ServerSelectMode. Определяет, каким образом происходит выбор сервера в случае, если указано несколько адресов (нижеперечисленные ключи конфигурации). «0» - в окне авторизации отображается список серверов в соответствии с перечислением в конфигурационном файле. При автоматическом переподключении всегда берется последний активный сервер. «1» - осуществляется автоматический перебор серверов начиная с самого первого. Подключение производится к тому, который дал положительный ответ. При автоматическом подключении без окна авторизации в учет берется не только подключение, но и ответ авторизации. Таким образом будет активирован сервер, успешно подключенный и разрешивший вход. В этом случае в окне авторизации список серверов для выбора не отображается. «2» - перебор серверов осуществляется автоматически, начиная с последнего активированного. «3» - случайный выбор сервера. «4» - основной сервер единственный, при потере связи с ним подключение осуществляется к одному из резервных на основании случайного выбора. По умолчанию - 0.

ConnectBackReserve. «1» - активирует режим мониторинга за появлением основного сервера в случае, если текущее подключение установлено с резервным сервером. Применяется при настройке резервных схем с преимущественной привязкой к одному серверу.

'''Раздел Подключения к серверу.'''

NetConnectionName. Название подключения (сервера) для отображения в окне авторизации (при указании нескольких возможных подключений).

LogicServerAddress. Адрес для подключения к серверу логики.

LogicServerPort. Порт для подключения к серверу логики.

ConnectProtocol. Устанавливает протокол, по которому осуществляется подключение клиента к серверу. 0 - по умолчанию 1 - Remoting, 2 - OkTCP.

NETCLIENT_SERVER_ADDRESS. Адрес для подключения к серверу аппаратуры.

NETCLIENT_SERVER_PORT. Порт на сервере для подключения к нему по сигнальному протоколу.

NETCLIENT_LOCAL_PORT. Локальный порт для обмена сигнальным трафиком по UDP. Используется для версий 2.9 и ниже, работающих по VOIP-технологии.

NETCLIENT_VOICE_PORT. Локальный порт для обмена голосовым трафиком по UDP.

<div id="SipDomain"></div>
SipDomain. Переопределяет доменное имя SIP-сервера при отправке регистрационных пакетов с клиентского локального устройства. Явное указание может потребоваться в случае нестандартных настроек NAT сервера.

<div id="SipPort"></div>
SipPort. Переопределяет порт SIP-сервера при отправке SIP пакетов с клиентского локального устройства. Явное указание может потребоваться в случае нестандартных настроек NAT сервера. По умолчанию 5060.

SipLocalPort. Переопределяет локальный порт клиентского приложения для обмена сигнальным трафиком по протоколу SIP. По умолчанию 5080. Работает начиная с версии 2.11.

ВНИМАНИЕ! Вышеперечисленные параметры (NetConnectionName, ..., NETCLIENT_VOICE_PORT) определяют различные адреса и порты для организации сетевого канала подключения к серверу. Эти параметры могут присутствовать в конфигурационном файле несколько раз с добавлением к концу строки-ключа разных целочисленных индексов. Например NetConnectionName_1 и NetConnectionName_2. Индекс 0 не указывается, вместо него используется значение без индекса. В случае указания в конфигурационном файле нескольких подключений в окне авторизации будет отображен список их имен и доступен выбор одного из них. Это удобно использовать при работе с несколькими серверами с одних и тех же клиентских рабочих станций.

<div id="SipDomainMode"></div>
SipDomainMode. Режим формирования доменного имени при подключении локального устройства по SIP к серверу. По умолчанию используется IP-адрес указанного в конфигурационном файле [[#LogicServerAddress|доменного имени логического сервера]] (''=2''). Варианты: ''0'' - имя хоста серверной машины, ''1'' - указанное в конфигурационном файле [[#LogicServerAddress|доменное имя логического сервера]]. В любом случае доменное имя может быть явно переопределено параметром конфига [[#SipDomain]], если он установлен для текущего подключения. В большинстве случаев изменения значения этого параметра не требуется

<div id="SipForceKeepAliveIntervalSec"></div>
SipForceKeepAliveIntervalSec. Позволяет явно включить и задать интервал в секундах для отправки пакетов Keep-Alive в SIP-подключении к серверу. Может потребоваться при настройках NAT для удерживания порта.

WORK_ROOTDIR. Устанавливает в явном виде путь к рабочей папке клиентского приложения. Временные файлы, сценарии, проекты, плагины, каталог по умолчанию для записи разговоров - все кроме основных сборок службы размещается именно там.

WORK_ROOTDIR_TYPE. Устанавливает один из нескольких возможных вариантов размещения рабочей папки. Используется, если не задана рабочая папка в явном виде. Возможные варианты: 0 – папка запустившего процесс выполняемого файла, 1 – папка размещения основных сборок приложения, 2 – Documents And Settings\All Users, 3 – Documents And Settings\CurrentUser.

AutoUpdate. «1» - обновлять клиента автоматически. «0» - не обновлять автоматически при запуске, если обнаружено отличие версий. По умолчанию «1». Настоятельно не рекомендуется оставлять рабочую версию программы со значением «0» и использовать этот режим только для отладочных целей.

AutoUpdateGateway. «1» - обновлять шлюз автоматически. «0» - не трогать. По умолчанию «0». В список шлюзов требуется добавить адрес сервера, если подключение производится к серверу с несколькими сетевыми интерфейсами через интерфейс с индексом более 1. В большинстве случаев указания не требуется.

<div id="ManualHostAddress"></div>
ManualHostAddress. Альтернативный псевдо-адрес клиентского компьютера для идентификации на сервере в карте сети. Может быть использован для подключения к серверу при динамически выделяемом IP-адресе и сложностях с идентификацией по HostName. Каждый клиент должен иметь уникальное значение ключа, не совпадающее с реальными возможными адресами и именами других компьютеров сети.

<div id="TerminalMode"></div>
TerminalMode. Определяет режим подстановки адреса (для организации работы в терминальном режиме) - какой адрес берется, какое терминальное расширение для идентификации в карте сети используется (''address/terminalkey''). С помощью настройки вы можете передавать название вашего компьютера через удаленное подключение.
0 — адрес локальный, без терминального расширения: ''address''.
1 — адрес локальный, терминальное расширение из текущего конфигурационного файла [[#TerminalAddress|TerminalAddress]]: ''address/terminalkey''.
2 — адрес локальный, терминальное расширение с помощью текущего авторизованного Win-User: ''address/user''.
3 — адрес клиентского терминала (ищется активная сессия авторизованная под совпадающим с текущим win-user), терминальное расширение из текущего
конфигурационного файла [[#TerminalAddress|TerminalAddress]]: ''clientaddress/terminalkey''.
Если удовлетворяющая условиям терминальная сессия не найдена, то используется локальный адрес. Если терминальное расширение не задано - не используется.
По умолчанию 1.

<div id="TerminalAddress"></div>
TerminalAddress. Строка, определяющая уникальный адрес клиентского места. Приписывается ко всем адресам компьютера для определения клиентского места в карте офиса (например «FUTURAMA/terminal1»). Именно эту строку необходимо будет указать в карте офиса для идентификации. Решает проблему терминальных подключений, где все клиенты физически запускаются с одного компьютера. По умолчанию «».

<div id="ShowLoginAuthMode"></div>
ShowLoginAuthMode. ''1'' - отображать выбор способа авторизации (active dictionary/oktell), ''0'' - не отображать и использовать всегда стандартный режим. По умолчанию ''1''.

TimeSynchronization. «1» - синхронизировать время с сервером при запуске, «0» - не синхронизировать. По умолчанию «1».

RestartApplicationWithProcess. «1» - любой перезапуск клиента производится с выгрузкой процесса. «0» - выгрузка процесса производится только для применения обновлений, другие перезапуски осуществляются внутри процесса. По умолчанию «0».

ProcessPriority. Приоритет процесса клиентского приложения и процесса обслуживания внешних звуковых устройств. «0» - нормальный, «1» - выше среднего, «2» - высокий, «3» - реального времени. По умолчанию «1».

HAL_skip_loading. «1» - пропускать загрузку модуля обслуживания устройств работы со звуком. «0» - нормальный режим.

Register_ocx. «1» - регистрировать библиотеки обслуживаемых устройств перед запуском, «0» - не регистрировать. По умолчанию «1».

<div id="ClientWebServerPort"></div>
ClientWebServerPort. Устанавливает порт слушателя [[Клиентский_HTTP_интерфейс|HTTP-запросов]] к клиентскому приложению (например запрос http://localhost:4059/callto?number=184 - команда на звонок через Oktell). Доступ возможен только по локальному loopback интерфейсу.

ComAsyncEventing. Применяется для форсированной активации/отключения соответствующего режима COM-ядра без изменения кода приложения. Активирует/деактивирует режим раздачи событий COM-объекта в асинхронных служебных потоках. Применяется только в случае указания значений «1» или «0». По умолчанию применяется режим, установленный в коде внешнего интегрирующего приложения. Подробно в руководстве по интеграции (раздел «Октелл в других проектах», статья «Загрузка и выгрузка модуля»).

ComXmlFullLogging. Применяется для форсированной активации/отключения соответствующего режима COM-ядра без изменения кода приложения. Активирует/деактивирует режим полного логирования всех событий и вызовов управляющего объекта. Применяется только в случае указания значений «1» или «0». По умолчанию применяется режим, установленный в коде внешнего интегрирующего приложения. Подробно в руководстве по интеграции (раздел «Октелл в других проектах», статья «Загрузка и выгрузка модуля»).

TRACE_HARDWARE. Уровень трассировки аппаратного модуля. Применяется для логирования событий в момент запуска системы. Возможны следующие ключи: CALL, NET, TRANS, SESSION, PROTO, EVENTS, TIMER, ERRORS, WARNING, RTP-FLOW, MEDIA-FLOW. Ключи необходимо перечислить в атрибуте value друг за другом через пробел. Прочитать описание ключей можно в статье [[Логирование#.D0.9F.D0.B0.D1.80.D0.B0.D0.BC.D0.B5.D1.82.D1.80.D1.8B_.D0.B0.D0.BF.D0.BF.D0.B0.D1.80.D0.B0.D1.82.D1.83.D1.80.D1.8B._.D0.9A.D0.BE.D0.BD.D1.84.D0.B8.D0.B3.D1.83.D1.80.D0.B0.D1.86.D0.B8.D1.8F|Логирование]]

SEPARATE_PROCESS. «1» - запускать отдельный процесс для работы с устройствами. «0» - работать с устройствами в собственном процессе. По умолчанию «1».

JITTER_DEPTH. Значение глубины джиттер-буфера на клиенте, измеряемое в количестве пакетов по 20 мс. Минимальное значение - «0», по умолчанию - «6». При увеличении значения происходит рост задержки в голосовом обмене по направлению звука в локальное устройство, эффективнее устраняя влияние проблем сети. При указании «0» джиттер буфер не используется.

Если наблюдается поступление пакетов вперемешку с незначительным разбросом, и/или периодические задержки с последующим одновременным поступлением серии пакетов, увеличение значения может способствовать выравниванию звука. Для диагностики этого явления можно активировать логирование голосового трафика (TRACE_HARDWARE) или использовать программы-перехватчики трафика (снифферы), например WireShark.

WAVE_COUNT. Значение, определяющее количество буферов для обмена звуком со звуковым устройством. Минимальное значение - «2», по умолчанию - «2». При увеличении значения происходит рост задержки в голосовом обмене по направлению звука в локальное устройство, эффективнее устраняя влияние проблем в медлительности звукового устройства.

Если при ровно поступающем звуке из сети (диагностировать можно с помощью отладочной записи на входе - WAVE_COUNT, либо с помощью программ-перехватчиков трафика, например WireShark) наблюдается щелканье или пропадание кусков голосового потока, увеличение значения может способствовать выравниванию звука.

WRITE_VOICE. Отладочный параметр для оценки звукового потока на входе в клиентский HAL из сети до воспроизведения непосредственно в устройстве. «1» - отладочная запись в файл включена, файл с именем, соответствующим текущему времени размещается в корне клиентского приложения . «0» - отладочная запись отключена. По умолчанию «0».

WAVEIN_AUTOCLOSE. «1» - закрывать устройство ввода звука после завершения коммутации. «0» - оставлять открытым. По умолчанию «0».

WAVEOUT_AUTOCLOSE. «1» - закрывать устройство вывода звука после завершения коммутации. «0» - оставлять открытым. По умолчанию «0».

USE_DIRECTSOUND. Тип работы со звуком по умолчанию. Выбирается в клиентском интерфейсе. «1» - использовать для работы со звуком библиотеки DirectSound. «0» - обычный режим через системные функции Windows Multimedia (WMM). По умолчанию «0».

NETCLIENT_PAYLOAD. Кодек по умолчанию для обмена голосовым трафиком. Выбирается в клиентском интерфейсе. Здесь служит для задания начальной настройки. 0 - 711mulaw, 8 - 711alaw, 41 - gsm610. По умолчанию «8».

PHONEDEVICE_WAVEOUT. Устройство вывода звука (спикер) по умолчанию. Выбирается в клиентском интерфейсе. Здесь служит для задания начальной настройки.

PHONEDEVICE_WAVEIN. Устройство ввода звука (микрофон) по умолчанию. Выбирается в клиентском интерфейсе. Здесь служит для задания начальной настройки.

PHONEDEVICE. Имя устройства по умолчанию. Выбирается в клиентском интерфейсе. Здесь служит для задания начальной настройки.

SIGNAL_VOLUME. 0-100. Уровень громкости генерируемых в локальное устройство системных звуков и тонов. По умолчанию 50.

<div id="UseKeyHook"></div>
UseKeyHook. Параметр позволяет принудительно отключить режим перехвата действий клавиатуры для управления гарнитурой. Отключение может понадобиться при обнаружении проблем и конфликтов с операционной системой. «1» - режим перехвата активирован. «0» - режим перехвата деактивирован. По умолчанию «1». Выключение требуется на 64 разрядных ОС при работе версий до 2.8.130325.

default_HeadSet_AutoHookUp. Определяет используемый по умолчанию режим автоподнятия трубки на гарнитуре при поступлении входящего звонка. После фактического изменения настроек пользователем в параметрах локального устройства значение из конфигурационного файла теряет актуальность. По умолчанию «1».

default_HeadSet_UseKeyBoard. Определяет используемый по умолчанию режим перехвата нажатий на клавиатуре для управления гарнитурой. После фактического изменения настроек пользователем в параметрах локального устройства значение из конфигурационного файла теряет актуальность. По умолчанию «1».

default_HeadSet_UseACM. Определяет, активен ли по умолчанию режим автодозвона для гарнитуры. После фактического изменения настроек пользователем в параметрах локального устройства значение из конфигурационного файла теряет актуальность. По умолчанию «1».

default_Phone_ShowRingPopup. Определяет используемый по умолчанию способ отображения информации о вызывающем абоненте (всплывающее окно/всплывающее уведомление). После фактического изменения настроек пользователем в параметрах локального устройства значение из конфигурационного файла теряет актуальность. По умолчанию «1».

WatcherResourceLogType. Формат логирования ресурсов. С помощью параметра можно настроить вывод в клиентский лог-журнал WATCHER информации по использованию процессом ресурсов системы. Объем используемой памяти, количество открытых дескрипторов, количество потоков, пользовательские системные ресурсы, ориентировочное среднее процессорное время по всему процессу и отдельно по всем его потокам. 0 - не логировать, 1 - информация о процессе каждую секунду, 2 - информация о процессе и активным потокам каждую секунду, 3 - информация о процессе и всем его потокам каждую секунду, 4 - информация о процессе каждую минуту. По умолчанию 4.

RestoreLastModules. «1» - осуществляет при загрузке приложения загрузку и восстановление модулей, активных перед закрытием программы. «0» - запускает приложение с пустым фоном без дополнительной загрузки модулей; это экономит время на загрузке, так как некоторые модули требуют достаточно длительного времени для полной загрузки, однако пользователь при необходимости сам может активировать модуль по стандартной схеме из главного меню. По умолчанию «1».

ShowVideoNoise. «1» - в видео-окне модуля ТЕЛЕФОН при отсутствии видео-сигнала отображается черно-белый шум, «0» - черное окно. По умолчанию «1».

CameraFrameFrequencyLimit. Устанавливает ограничение на количество передаваемых кадров из клиентского приложения в сеть в ходе видео-сессии. Может использоваться при необходимости снизить исходящий трафик при видео-коммутациях с настраиваемой клиентской рабочей станцией.

CameraJitterDepth. Глубина джиттер-буфера фреймов с камеры. Позволяет нивелировать задержку в выдаче кадров в целях выравнивания отправляемого видео-потока. По умолчанию «3». «0» - не использовать джиттер.

SkipLoadCamera. «1» - пропускать загрузку модуля работы с веб-камерой. «0» - нормальный режим.

Phone_UseBlockedDelay. «1» - использует асинхронный отложенный механизм по выставлению заблокированного состояния модулю [[Телефон]]. «0» - заблокированное состояние выставляется сразу (может потребоваться при работе на медленных машинах, где асинхронность сказывается отрицательно с приведением телефона в недееспособное состояние. Рекомендуется изменять только при соответствующем запросе службы технической поддержки). По умолчанию «1».

Phone_ACMMode. Определяет порядок действий при нажатии на кнопку «Позвонить» в модуле [[Телефон]]. «0» - стандартная последовательность действий: сначала производится вызов абонента, потом обратный вызов пользователя. «1» - обратная последовательность: сначала производится вызов самого пользователя, потом абонента. См. раздел [[Звонки и сервис автодозвона|Телефон. Звонки]].

ACM_directcallfrommodules. Режим использования сервиса автодозвона в разделах клиентского приложения для доступных команд контекстного меню (Например: Позвонить). По умолчанию ''1''

ACM_callsequence. Используется при установке ключа '''ACM_directcallfrommodules'''=0. Режим автодозвона в разделах клиентского приложения где доступно контекстное меню "Позвонить". «0» - сначала абонент, затем обратный вызов пользователя. «1» - сначала обратный вызов пользователя, затем набор номера. По умолчанию ''0''

ACM_switchsequence. Используется при установке ключа '''ACM_directcallfrommodules'''=0. Режим автодозвона в разделах клиентского приложения где доступно контекстное меню "Переключить". «0» - сначала абонент, затем обратный вызов пользователя. «1» - сначала обратный вызов пользователя, затем набор номера. По умолчанию ''1''

<div id="PhoneAllowHotline"></div>
PhoneAllowHotline. ''1'' - разрешить ''HOTLINE'' вызовы из локального устройства на SIP-сервер (при звонке на пустой номер), ''0'' - запретить. По умолчанию ''1''.

HeadsetNonACMMode. Режим вызова с гарнитуры без использования автодозвона. «0» - сначала обратный вызов пользователя, потом набор абонента. «1» - поднятие трубки, таймаут, набор номера. По умолчанию «1».

UseAutoReconnectOnFly. При установке значения «1» в случае потери связи по каналу TCP между клиентом и сервером клиентское приложение будет пытаться переподключиться без перезагрузки. Неактуально при использовании протокола Remoting (по умолчанию порт 4050).

ShowHelpInside. Определяет, где отображать справку по системе. «0» - в отдельных процессах браузера по умолчанию «1» - во встроенном браузере в окне клиентского приложения. По умолчанию «0».

<div id="PlugRegLoadType"></div>
PlugRegLoadType. Устанавливает режим загрузки при настройке plugin-программ. «1» - стандартный режим в отдельном домене с последующей выгрузкой. «2» - загрузка plugin-программ в отдельный процесс для настройки. Для загрузки plugin-библиотек используется запускающий модуль oktell.PluginStarter.exe, который может быть скопирован под другим названием. Используемая версия .NET Framework для работы плагина в отдельном процессе определяется в конфигурационном файле этого процесса (по умолчанию oktell.PluginStarter.exe.config). Сам же запускающий модуль (название файла в каталоге клиентского приложения) определяется в конфигурационном файле oktell (клиентском и возможно серверном) с ключом, зависящим от названия основной библиотеки plugin-программы. Например <add key="PluginTcp_libnamewithoutextension" value="oktell.PluginStarter2.exe"/>. Существующий модуль oktell.PluginStarter.exe может скопирован под другим именем и снабжен таким образом индивидуальным конфигурационным файлом. Это может понадобиться в частности для применения разных версий .NET Framework к разным plugin-программам.

AutoSortGroups. Устанавливает режим сортировки отделов для модуля [[Сотрудники]] по названиям. По умолчанию «1». В случае отключения ожидается, что сортировкой занимается хранимая процедура, результаты ее исполнения выводятся последовательно.

PersonalHandleDepartments. При установке значения «1» обновление состояний внутренних номеров в разделе [[Сотрудники|«Сотрудники. Отделы»]] производится только для номеров, входящих в выделенный отдел. Имеет смысл применять для сокращения трафика.

<div id="SplitDepartmentsTreeByDot"></div>
SplitDepartmentsTreeByDot. «1» - осуществлять построение глубокого дерева вложенных отделов в модуле «Сотрудники», разбивая указанные для сотрудников отделы на категории по символу «.». «0» - одноуровневое дерево отделов. По умолчанию «0».

<div id="ExportCsvDelimiter"></div>
ExportCsvDelimiter. Устанавливает символ-разделитель столбцов при формировании файлов экспорта CSV во всех модулях клиентского приложения. Список возможных значений: comma, space, semicolon, tab.

<div id="ExportTextDelimiter"></div>
ExportTextDelimiter. Устанавливает символ-разделитель столбцов при формировании текстовых файлов с отчетами во всех модулях клиентского приложения. Список возможных значений: comma, space, semicolon, tab.

CCJournalTopCount. Для версий ниже 2.11.2.141120. Устанавливает ограничение на количество выводимых строк в статистике Call-центра.

HandleSessionToChangeUserState. «1» - при блокировании сессии авторизованного пользователя windows производится автоматический перевод состояния авторизованного пользователя oktell в «Нет на месте». При возврате в сессию производится автоматический перевод в «На месте». При этом перевод не осуществляется, если в момент блокировки пользователь не был свободен (находился в разговоре, в резерве или в состоянии перерыва), при этом не производится и обратного перевода при входе в сессию. «0» - действие по автоматической смене состояний не применяется. По умолчанию «1».

RecordDownloadNameAddInfo. «1» - устанавливает режим выгрузки записей разговоров статистики с включением в имена файлов имен участвующих абонентов.

Memory_UseSameDialogForms. «1» - активирует режим использования одних и тех же окон в режиме операторских диалоговых форм без уничтожения и создания при каждом показе. Используется на компьютерах с минимальным объемом оперативной памяти во избежание скачкообразного роста используемой памяти. «0» - деактивирует режим. По умолчанию «0».

Debug_PingErrorRestart. «0» - отключает автоматическую перезагрузку клиентского приложения при отсутствии откликов сервера на команды Ping. Используется для отладочных режимов, в основном при отладке plugin-программ. «1» - обычный режим. По умолчанию «1».

PingTimeoutNotify. Устанавливает период в миллисекундах, при превышении которого в момент вызова метода Ping возникает уведомление о плохой связи с сервером.

Debug_PingPause. Устанавливает паузу между опросами от клиентского приложения к серверу.

Debug_PingOutTimes. Устанавливает количество неудачных опросов, после которого закрывать клиентское приложение.

ActivationServer. Ссылка на сайт активаций для режима автоматической активации тестовой версии. По умолчанию «http://activate.telsystems.ru».

ShowLoadingBar. Отображает полосу загрузки при открытии модулей клиентского приложения. В некоторых случаях, улучшает работу отрисовки приложения. «0» - не отображает, «1» - отображает. По умолчанию «1».

helplinks. Тип используемой справки: «0» - встроенная справка в файле manual.chm, «1» - ссылка на вики. По умолчанию «1».

BrowserType. Используемый браузер в приложении: «1»- IE7, «2»- IE7, «3»- Chrome18. По умолчанию «3»

FaxPreperformProcess. Режим работы факса при отправке с клиентского приложения: «0» - обычный режим отправки изображений с преобразованием на сервере к необходимому виду. «1» - использование локального XPS-принтера для изготовления общего многостраничного файла TIFF из нескольких выбранных документов (для этого режима необходимы .NET Framework 3.0, установленный Microsoft Office версии 2003 или старше, установленный XPS принтер). По умолчанию «0».

<div id="AutoUserStateChangeOnSystemLock"></div>
AutoUserStateChangeOnSystemLock. 1 - активирует режим автоматического перевода состояния пользователя в ''Отключен'' или ''Перерыв'' (в зависимости от присутствия пользователя в режиме Call-центра) при блокировке ОС и автоматический перевод обратно при входе в систему снова. 0 - не использует режим. По умолчанию 1.

<div id="PhoneDirectDigit"></div>
PhoneDirectDigit. Определяет поведение софт-телефона. 1 - в активном состоянии набор символов осуществляется по одному, ввод в текстовое поле невозможен, кнопка «Набрать» недоступна. 0 - набор осуществляется в текстовое поле, после чего кнопкой «Набрать» отправляется на сервер. По умолчанию 0. Это касается состояний набора номера, коммутаций с абонентами, коммутаций с IVR, ожидания ответа, ожидания факс-сеанса.

PhoneIvrDirectDigit. Определяет поведение софт-телефона в состоянии коммутации с IVR при отключенном режиме прямого набора символов. 1 - позволяет активировать прямой набор только для случая коммутации с IVR. 0 - оставляет доступным только набор в текстовое поле с последующей отправкой по нажатию на «Набрать», при этом сценарий завершается и осуществляется набор номера по-новой. По умолчанию 0.

PhoneLineDirectDigit. Определяет поведение софт-телефона в состоянии коммутации с абонентом при отключенном режиме прямого набора символов. 1 - позволяет активировать прямой набор только для случая коммутации с абонентом. 0 - оставляет доступным только набор в текстовое поле с последующей отправкой по нажатию на «Набрать», при этом осуществляется переключение. По умолчанию 1.

'''Раздел LOG.'''

Хранит настройки лог-сервера комплекса. Среди неописываемых настроек - пути к папкам для сбора журналов.

LOG_storedays. Длительность хранения лог-журналов в днях. По умолчанию «7». По истечении указанного периода журналы удаляются системой. В некоторых случаях объем журналов может достигать нескольких гигабайтов за день.

LOG_maxfilesize. Максимальный размер одного файла лог-журнала в байтах. Имеет воздействие на все лог-журналы, исключая HAL (Hardware). По умолчанию 3 ГБ.

LOG_root. Абсолютный или относительный путь к папке с лог-журналами. По умолчанию «Log», то есть относительный путь в каталоге клиентского приложения.

Okapp 2.12

2023-06-08T06:29:05Z

Oktell Support:

[[Утилиты | Наверх]] <nowiki>[Oktell 2.12+]</nowiki>

{| valign="top"
|-
|<ul>Предыдущие версии статьи<li>[//wiki.oktell.ru/Okapp Okapp]</ul>
|
|}

__TOC__

= Введение =

'''Okapp''' — web-приложение для работы и настройки Oktell в браузере. Не требует установки дополнительного ПО кроме браузера, что позволяет использовать операционные системы отличные от '''Windows''' ('''Linux''', '''iOS''', '''Android''' и др). Напомним, что стандартное клиентское приложение может работать только в ОС '''Windows'''.

Okapp представляет из себя одностраничное веб-приложение и состоит из следующих функциональных частей:
*Боковое меню — отображаются все модули, до которых у пользователя есть доступ. Следует учитывать, что некоторые приложения могут работать в фоновом режиме (например, карточка оператора).
*Основное окно активного модуля — отображение рабочей области расширения.

[[Файл:okapp_212_1.jpg|center|800px]]

Настройки профиля текущего пользователя располагаются в левом нижнем углу меню.

[[Файл:okapp_212_16.jpg|center|800px]]

Функционал смены пароля доступен только при установке соответствующей привилегии в роли пользователя.

[[Файл:okapp_212_17.jpg|center|800px]]

= Установка =

Чтобы использовать '''Okapp''', предварительно''' настройте Web-сервер Oktell'''. Воспользуйтесь статьей: [[Настройка_Web-сервера_Oktell | Настройка Web-сервера Oktell]].

Для входа наберите в браузере '''ip-адрес''' сервера '''Oktell'''.

Например,

http://192.168.0.82
http://192.168.0.82:4055
http://192.168.0.82:50500

 ВНИМАНИЕ: Если у вас закрыт '''порт 80''', то для подключения необходимо дополнительно указать доступный порт, как показано в примере.

Возможны два варианта подключения:

* '''с привязкой к IP-телефону''' — для совершения звонков используется IP-телефон
* '''с использованием гарнитуры''' — используется технология WebRTC.

<center>
{|cellpadding="10" cellspacing="0" border="1"
| ВНИМАНИЕ: Если '''Oktell''' находится за '''NAT-устройством''' пробросьте следующие порты: 
* Для работы в браузере необходимы порты, которые указаны в настройках '''Web-сервера'''. По умолчанию, '''80, 443, 4055, 4066 (tcp)'''.
* Для работы по технологии '''WebRTC''' дополнительно необходимы порты '''5060 (tcp), 5070 (tcp), 9000-19000 (udp)'''.
|-
|}
</center>



== Работа с привязкой к ip-телефону ==

Чтобы сотрудник смог совершать и принимать звонки с IP-телефона, в карте сети необходимо закрепить этот телефон за сотрудником.

Зайдите в '''Администрирование''' -> '''Карта сети''' -> '''Настройки телефона'''. Выберите сотрудника в поле '''Пользователь WebCRM'''.

[[Файл:Oktelljs-004.png | center]]

== Работа с использованием гарнитуры ==

ВНИМАНИЕ: Использовать гарнитуру можно в браузере '''Google Chrome''' до [https://yadi.sk/d/YNO3uxsv8h8mwA 70 версии] включительно(старые версии доступны, например, [https://www.slimjet.com/chrome/google-chrome-old-version.php здесь]), а также в '''Opera''' и '''Яндекс.Браузер'''.

Чтобы использовать гарнитуру необходимо, чтобы '''Oktell''' выделил динамическую линию. В серверном конфигурационном файле ('''\oktell\server\oktell.ServerService.exe.config'''), определите параметр '''EnableAutoMap'''. Если у вас нет такого ключа, добавьте его.

<add key="EnableAutoMap" value="1" />

Если '''EnableAutoMap = 1''', то в клиентское приложение можно заходить с любого компьютера, не определенного в карте сети и к нему автоматически будет прикрепляться '''динамическая''' внутренняя линия (гарнитура). Если '''EnableAutoMap = 0''', то зайти в клиентское приложение можно только с тех компьютеров, которые определены в карте сети.

Перезагрузите службу сервера '''OktellServer'''.

[[Файл:Oktelljs-006.png | center]]

При входе в Okapp после нажатия кнопки "'''Войти'''" для получения доступа к гарнитуре нажмите "'''Разрешить'''".

<center> [[Файл:Okapp_212_2.jpg| 500px]][[Файл:Okapp_212_3.jpg| 500px]] </center>

= Возможности приложения =

==Модуль "Телефон"==

Удобная панель, с помощью которой вы сможете совершать и принимать звонки, осуществлять переключения абонентов на других сотрудников и быстро создавать конференции для совещаний.

В веб-панели вы можете настроить отображение номерного плана с помощью следующих опций:
* группировать по разделам или показывать единым списком
* показывать всех пользователей или только доступных

Для совершения звонка, выберите в модуле нужного пользователя и нажмите на значок зеленой трубки либо наберите необходимый номер в поле (с подсказкой "введите имя или номер") и нажмите '''Enter'''. Если сотрудник занят - то его имя подсвечивается красным цветом.

[[Файл:Okapp_212_8.jpg|800px|center]]

Для номеров которые находятся в свободном состоянии в меню действий доступны возможности:
*позвонить - вызов данного номера
*конференция - добавление данного номера в конференцию при активном разговоре, либо создание конференции со своим пользователем если в данный момент активного разговора нет
*интерком - вызов данного номера в режиме интерком (необходима поддержка со стороны вызываемого устройства)

Для номеров которые находятся в разговоре в меню действий доступны возможности:
*позвонить - вызов данного номера, если установлена очередь ожидания, то постановка в очередь.
*конференция - подключение к активному разговору в режиме конференции, при наличии прав контроля.
*интерком - вызов данного номера в режиме интерком (необходима поддержка со стороны вызываемого устройства), если установлена очередь ожидания, то постановка в очередь.
*прослушка - подключение к звонку в режиме прослушивания ([//wiki.oktell.ru/Прослушивание_и_помощь#.D0.9F.D1.80.D0.BE.D1.81.D0.BB.D1.83.D1.88.D0.B8.D0.B2.D0.B0.D0.BD.D0.B8.D0.B5 Прослушивание])
*помощь - подключение к звонку в режиме помощи ([//wiki.oktell.ru/Прослушивание_и_помощь#.D0.9F.D0.BE.D0.BC.D0.BE.D1.89.D1.8C Помощь])

Во время разговора доступны:
*меню действий (1) в котором есть возможность:
**завершить разговор
**поставить абонента на удержание
**преобразовать данный разговор в конференцию
**активировать панель донабора
*панель донабора (2)
*меню действий (3) в котором есть возможность:
**позвонить - дозвон до данного номера, при этом текущий звонок будет переключен в режим удержания
**перевести - безусловный перевод на данный номер
**конференция - дозвон до данного номера и добавление его к текущему разговору
**интерком - дозвон до данного номера в режиме интерком (необходима поддержка со стороны вызываемого устройства), при этом текущий звонок будет переключен в режим удержания

[[Файл:Okapp_212_6.jpg|800px|center]]

В нижней части приложения доступна панель статусов.

<center> [[Файл:Okapp_212_9.jpg|800px]] </center>

*При выборе статуса группы "Call-центр" (Автоматический режим, Ручной режим, Перерыв) произойдет автоматический вход пользователя в Call-центр.

*Аналогично для обратной ситуации, пользователь будет выведен из Call-центра при выборе статуса из группы "Офисная телефония".

*Варианты типов предустановленных перерывов можно задать в общих настройках системы [[//wiki.oktell.ru/Настройки_Call-центра#.D0.A1.D0.BF.D0.B8.D1.81.D0.BE.D0.BA_.D0.BF.D1.80.D0.B5.D0.B4.D1.83.D1.81.D1.82.D0.B0.D0.BD.D0.BE.D0.B2.D0.BB.D0.B5.D0.BD.D0.BD.D1.8B.D1.85_.D0.BF.D0.B5.D1.80.D0.B5.D1.80.D1.8B.D0.B2.D0.BE.D0.B2 Типы предустановленных перерывов]].

*В поле для ввода у статуса "Переадресация" можно ввести номер на который будет автоматически переведен звонок при установке данного состояния пользователем.

*Сняв галочку с режима "Веб-телефон" пользователь перейдет в состояние "Без телефона".

*Режим "Автоответ" позволяет автоматически снимать трубку при поступлении вызова. Запрет изменения параметра, а так же значение по умолчанию можно установить в ролях пользователя.

[[Файл:Okapp_212_10.jpg|800px|center]]

 ВНИМАНИЕ: Если вы просто закроете вкладку в браузере, то приложение выполнит выход в течение 1 минуты.

Чтобы выйти из приложения нажмите "'''Выйти'''".

==Модуль "Кабинет оператора"==

Рабочее место оператора call-центра с личной информацией

При наличии лицензий Call-центра для работы операторов и приема звонков по задачам, установите модули '''Карточка оператора''' и '''Кабинет оператора'''. С помощью этих модулей вы сможете использовать диалоговые карточки и веб-формы также, как и в стандартном клиентском приложении.

ВНИМАНИЕ: При работе с web-страницами вы не сможете считывать введенные значения. Такой функционал доступен только при работе в стандартном клиентском приложении

В процессе работы оператор видит следующие статистические показатели своей работы: Время, проведенное в работе и время до конца рабочего дня; Время, проведенное в перерыве; Время, проведенное в разговоре и занятость оператора в процентах; Количество всех и успешных звонков.

В правой части модуля отображается список всех задач. Во время разговора с внешним абонентом, оператор может прикрепить звонок к определенной задаче. В этом случае откроется диалоговая форма, в которой будет доступны поля для ввода информации, а также звонок будет учитываться в статистике Call-центра.

[[Файл:Okapp_212_27.jpg|center|800px]]

==Модуль "Сообщения"==

Модуль для мгновенного обмена сообщениями между сотрудниками. При создании вы можете выбрать тип диалога "Личное сообщение" (1) или "Конференция" (2).

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

[[Файл:Okapp_212_12.jpg|800px|center]]

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

При получении нового сообщения отображается всплывающее уведомление с текстом и именем отправителя (в случае конференции отобразится название конференции).
Для того чтобы сообщение отметилось как прочитанное достаточно навести на него курсор мыши.

[[Файл:Okapp_212_13.jpg|800px|center]]

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

[[Файл:Okapp_212_14.jpg|800px|center]]

К сообщению можно так же прикрепить файл, для этого вы можете нажать на соответствующую кнопку в окне набора сообщения и выбрать необходимый документ на компьютере. Данный файл будет отображаться всем пользователям которые участвуют в диалоге и используют web-приложение. В окне чата в клиентском приложении Oktell файл отображаться НЕ будет (если было написано сообщение и к нему прикреплен файл, то отобразится только текст).

==Модуль "Журнал"==

Модуль для просмотра информации по звонкам, голосовой почте и уведомлениям пользователя.

Модуль состоит из нескольких вкладок. В окне (1) можно выбрать дату отображения звонков, при этом будут отображены звонки за данный день и ранее.

'''1)'''Мои звонки - Каждый сотрудник может просмотреть историю своих звонков (2). Отображаются входящие, исходящие, пропущенные звонки и конференции. При выборе разговора (3) его можно прослушать и добавить заметку или тег.

[[Файл:Okapp_212_18.jpg|center|800px]]

Рядом с названием вкладки отображается количество непросмотренных пропущенных звонков, при нажатии на значок будут отображены данные звонки.

При выборе успешного звонка в окне (3) вы можете:
*Прослушать звонок - при наличии привилегии "Возможность прослушивать записи" у данного пользователя, иначе при попытке прослушать запись будет отображена фраза - запись не найдена.
*Оставить заметку - при наличии привилегии "Возможность оставлять комментарии" у данного пользователя, иначе будут отображены существующие комментарии без возможности редактирования.
*Добавить тег - выбрать из существующего списка тегов, либо ввести название нового, он будет создан автоматически.
*Скачать запись - при наличии привилегии "Возможность выгружать записи" у данного пользователя.
*Удалить запись - при наличии привилегии "Возможность Удалять записи разговоров" и "Возможность удалять записи любых конференций" в зависимости от типа звонка у данного пользователя

<center>[[Файл:Okapp_212_19.jpg|500px]][[Файл:Okapp_212_21.jpg|578px]]</center>

Справа от кнопки воспроизведения отображается карта разговора, а так же для каждого участника рассчитывается процент владения разговором. Для отображения данных необходимо активировать параметры в разделе "Администрирование" - "Общие настройки" - "Управление базами данных" - "Рассчитать время владения разговором участниками" и "Рассчитывать детальную карту владения разговором участниками"

[[Файл:Okapp_212_25.jpg|center|800px]]

'''2)'''Голосовая почта - Вкладка предназначена для прослушивания голосового ящика и просмотра заказов на встречный звонок. Для каждого сообщения, сотрудник может оставить комментарий. Рядом с названием вкладки (окно 1) отображается количество непросмотренных обратных звонков и сообщений голосовой почты, при нажатии на значок будут отображены данные сообщения (окно 2).

[[Файл:Okapp_212_22.jpg|center|800px]]

'''3)'''Уведомления - На вкладке показываются уведомления от бизнес-процессов компании, настроенных в сценариях. При удалении сообщения будет запрошено подтверждение операции.

[[Файл:Okapp_212_23.jpg|center|800px]]

'''4)'''Звонки коллег - Сотрудник может просмотреть и прослушать звонки всех подчиненных ему коллег. Доступные действия и доступ к ним аналогичны описанным во вкладке "Мои звонки".

[[Файл:Okapp_212_24.jpg|center|800px]]

==Модуль "Сценарии"==

Графический редактор настройки сценариев.

[[Файл:Okapp_212_20.jpg|800px|center]]

В области 1 расположены все проекты созданные ранее, а так же можно создать новый проект. После выбора проекта в области 2 доступны для выбора сценарии данного проекта либо можно создать новый. Сценарии группируются по проектам, доступ к которым выдается в соответствии с правами на проект. Сценарии «Вне проекта» доступны всем пользователям, у которых есть доступ к модулю.

Сценарии создаются в графическом редакторе, который содержит 60 компонентов для взаимодействия с абонентом, работы с данными и контакт-сервисами. У каждого элемента есть свойства. Чтобы назначить переход между компонентами, зажмите клавишу CTRL и левой кнопкой мыши протяните линию от начального до конечного элементов. По завершению настройки назначьте права на доступ к сценариям и сохраните его.

[[Файл:Okapp_212_26.jpg|800px|center]]

Более подробно о сценариях можно прочитать по ссылке [//wiki.oktell.ru/Сценарии Сценарии]

==Модуль "Управление"==

Модуль позволяет создавать и настраивать пользователей, отделы и роли. Доступ к этому модулю рекомендуется выдавать только администраторам системы.

'''Сотрудники и отделы'''

[[Файл:Okapp_212_28.jpg|center|800px]]

'''Пользователи''' — учетные записи сотрудников, имеющих доступ к системе. В модуле администратор настраивает персональные данные пользователей, их роли и права контроля. Для пользователя возможны действия: сохранить, уволить, удалить. Окно настройки пользователя состоит из следующих вкладок:

*Анкета. Персональные данные сотрудника: имя, отдел, учетная запись для авторизации, возможность назначения на задачи.

[[Файл:Okapp_212_29.jpg|center|800px]]

*Роли. Настройка ролей и персональных привилегий. Привилегии определяют право совершения действий и доступ к модулям.

[[Файл:Okapp_212_30.jpg|center|800px]]

*Контроль. Список руководителей и подчиненных. Руководители могут просматривать статистику звонков, прослушивать записи разговоров и подключаться к разговорам подчиненных.

[[Файл:Okapp_212_31.jpg|center|800px]]

*Доступ. Список объектов системы, доступные выбранному пользователю.

[[Файл:Okapp_212_32.jpg|center|800px]]

'''Управление ролями'''

'''Роль''' — набор привилегий и прав. Роли упрощают настройку прав для однотипных сотрудников. В системе предустановлено 5 базовых ролей. Каждую роль можно сохранить, переименовать, клонировать или удалить. Окно настройки роли состоит из следующих вкладок:

*Привилегии. Набор привилегий, доступных роли. Родительская роль позволяет создавать модификации ролей с наследованием привилегии одной роли от другой. Например, роль «Oktell_user» наследует привилегии от роли «Пользователь (системная)», но отличается по нескольким из них.

[[Файл:Okapp_212_33.jpg|center|800px]]

*Состав. Список пользователей, которые имеют данную роль.

[[Файл:Okapp_212_34.jpg|center|800px]]

*Доступ. Список объектов системы, доступные выбранной роли.

[[Файл:Okapp_212_35.jpg|center|800px]]

== Управление приложениями ==

'''Okapp''' имеет модульную структуру, которая может быть настроена индивидуально для каждой компании. Каждый модуль — это самостоятельная программа, которая может устанавливаться и обновляться независимо с помощью системного приложения "'''Магазин'''". Установленные приложения отображаются в боковом меню Okapp. Магазин постоянно пополняется сообществом Oktell. Вы тоже можете принять участие в создании новых модулей, прочитав статью [[Создание модуля для Okapp]].

[[Файл:Okapp_212_36.jpg|center|800px]]



Для установки модуля выполните следующие пункты:

'''Шаг 1.''' Перейдите в модуль "'''Магазин'''". Выберите интересующее вас приложение и нажмите "'''Установить'''".

ВНИМАНИЕ: Для выполнения этого действия необходимо наличие у пользователя права доступа "'''Установка приложений'''".

[[Файл:Okapp_212_37.jpg|center|800px]]

'''Шаг 2.''' После установки нового модуля администраторы системы автоматически получают права на использование приложения. Остальным пользователям необходимо отдельно выделить права на установленные расширения в клиентском приложении ('''Администрирование'''\'''Пользователи'''\'''Доступ''').

[[Файл:Okapp_212_38.jpg|center|800px]]

Просмотреть установленные приложения вы можете в модуле "'''Магазин'''" нажав на кнопку "'''Мои'''". Чтобы вернуться к списку всех доступных приложений, нажмите кнопку "'''Все'''".

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

=Возможные проблемы =

'''1.''' Okapp не подключается и выдает сообщение '''Ошибка соединения сервером'''

*Проверьте наличие ключа '''EnableAutoMap = 1''' в серверном конфигурационном файле '''oktell.ServerService.exe.config'''. Если этого ключа нет, добавьте следующую строку:
<add key="EnableAutoMap" value="1" />

*Проверьте, не занят ли порт 80 или 4055 сторонним приложением с помощью команды <code>netstat -anopb tcp</code> в командной строке. Порты должны быть заняты процессом oktell.ServerService.exe. Попробуйте зайти в okapp с помощью порта 50500, предварительно укажите его в настройках [[Настройка Web-сервера Oktell]].

'''2.''' Okapp не регистрирует веб-телефон через wss-соединение.
*Нет слушателя на порту 5070. В серверном конфигурационном файле '''oktell.ServerService.exe.config''' добавьте порт sips:*:5070 (TLS) для защищенных соединений. Пример:
<pre> <add key="START_SERVER_04" value="SIP Server;oktell.HALSipSrv.dll;SIP;sip:*:5060,sips:*:5070" /></pre>
*Не указан домен в списке дополнительных доменов для регистрации в Параметрах аппаратуры
*Нет права на использование модуля "Телефон". Чтобы внутренняя линия зарегистрировалась, установите привилегию на модуль "Телефон" в настройках пользователя.

'''3.''' Периодически пропадает соединение с Okapp, отключается внутренняя линия.
*Проверьте параметр "Способ соединения с сервером CRM" в модуле '''Администрирование/Общие настройки/Web-интеграция с CRM'''. Если у вас выбран способ "Oktell к CRM", то в поле "URL CRM-сервера" '''не должно быть''' строки <code><nowiki>http://:80</nowiki></code>. Возможно, вы случайно указали этот параметр, поэтому либо измените его на действительный адрес CRM-сервера, либо переключите "Способ соединения с сервером CRM" на "''Не использовать''".

=== Метод диагностики неполадок ===

В браузере Google Chrome нажмите F12. Затем войдите в Okapp с параметром debug:

http://192.168.0.82:50500?debug

Затем введите ваши учетные данные, попробуйте совершить звонок. Все ошибки, которые возникают в приложении будут выводиться на вкладке '''Сonsole'''. Это может дать вам информацию о проблемах в веб-приложении.

[[Файл:Проблемы с okapp 001.png|center|800px]]

Отправляемые и получаемые сообщения от сервера Oktell вы можете на вкладке '''Network/WebSockets'''. Далее выберите нужный WebSocket и откройте вкладку Frames, на которой вы увидите всю необходимую трассировку (команды oktell.js; SIP-сообщения)

[[Файл:Проблемы с okapp 002.png|center|800px]]

Статистика

2023-05-25T09:31:05Z

Oktell Support: /* Диаграммы и настройка */

<code>[[Техническая документация]] / [[Call-центр]] / [[Статистика]] </code>

Модуль статистики call-центра доступен супервизорам, администраторам и другим пользователям, обладающим соответствующим правом. Для пользования модулем необходимо зарегистрироваться в call-центре системы. Служит для построения хронологических отчетов различной формы и содержания.

===Журнал звонков===

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

Данные, отображаемые пользователю, помимо установленного им фильтра будут отфильтрованы согласно правам на проекты. Информация по задаче в журнале видна только ее супервизорам и имеющим доступ к ее проекту.

ВНИМАНИЕ! При запросе больших объемов данных необходимо учитывать, что это создает дополнительную нагрузку на процессорное время сервера БД и сетевой трафик. В некоторых случаях это может отразиться на качестве разговоров, осуществляющихся через VoIP шлюз сервера.

Полученные результаты доступны для экспорта в текстовые файлы, в файлы MS Excel и HTML. Также доступна выгрузка записей всех разговоров, попадающих под условие фильтра. Необходимо иметь в виду, что выгрузка записей осуществляется в их текущем состоянии. Используйте предварительное микширование, чтобы гарантировать объединение разговоров в один файл.

===Диаграммы и настройка===

Содержание и количество прочих отчетов не ограничено. По умолчанию модуль содержит ряд предустановленных отчетов, оценивающих основные показатели работы call-центра на основе полной статистики, собираемой системой в отдельную БД. Статистическая БД Oktell хранит данные в виде пространственной модели (OLAP-кубов), данные в которую попадают в процессе работы. Перечень существующих в ней кубов продолжает расширяться. Это и куб коммутаций, попыток звонков по задачам, куб состояний операторов, куб состояний очереди ожидания. Подробнее в разделе [[Структура пространственной БД]].

Пользователи системы могут редактировать существующие отчеты и создавать новые. Также доступны функции экспорта и импорта отчетов, позволяющими вести динамический обмен со сторонними пользователями и разработчиками.

Отчеты подчиняются политике прав доступа. Параметры доступа к ним определяются на соответствующей вкладке «Доступ». Доступные привилегии: чтение, изменение. Также применяется общая ролевая привилегия ''«Возможность редактирования запросов SQL»''

Технология OLAP в простом виде позволяет получить из пространственных таблиц любые срезы. Несмотря на простоту использования звездной схемы пространственной БД, большинство сложных отчетов строятся не путем среза данных OLAP-куба, а на основе отдельных различной степени сложности алгоритмов. При создании отчетов администратор баз данных может подключить в качестве источника данных любой запрос как из всех баз данных Oktell, так и из любых других баз данных. Таким же образом можно производить анализ полученных данных в каждом конкретном проекте, строя отчеты под конкретные задачи, в частности на основе таблиц абонентов.

Этот механизм полной произвольности отчетов предоставляет широкие возможности как для администраторов БД, так и для супервизоров.

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

Среди вариантов отображения:

{|cellpadding="10" cellspacing="0" border="1"
|График
|Одна ось, каждый элемент оси может иметь несколько показателей. На одном изображении разным цветом строятся графики соответствующих показателей. Масштаб отображения показателей может быть общим или раздельным на усмотрение создателя отчета.
Поддерживает выгрузку в файл изображения. Поддерживает большие объемы данных, отображая графически-зависимую полосу прокрутки.
|[[Файл:cl_cc_stat_i7.png]]
|-
|Точки
|Одна ось, каждый элемент оси имеет может иметь несколько показателей. На одном изображении разным цветом отображаются точки, соответствующие значениям своих показателей. Масштаб отображения показателей может быть общим или раздельным на усмотрение создателя отчета.
Поддерживает выгрузку в файл изображения. Поддерживает большие объемы данных, отображая графически-зависимую полосу прокрутки.
|[[Файл:cl_cc_stat_i8.png]]
|-
|<div id="VertHysto"></div>Вертикальная гистограмма
|Аналогична графику, но ориентирована вертикально.
|[[Файл:cl_cc_stat_i10.png]]
|-
|Соотношение
|Одна ось, каждый элемент оси может иметь несколько показателей, каждый из которых отображается отдельной полосой.
Вид отчета аналогичен виду модуля «Индикаторы».
|[[Файл:cl_cc_stat_i9.png]]
|-
|Диаграмма
|Одна ось, для каждого элемента из которых выводится только один показатель (первый из показателей в запросе). Суммарная величина показателей всех элементов образует 100%. На круговой диаграмме строятся сектора, соответствующие процентным соотношениям.
Поддерживает выгрузку в файл изображения.
|[[Файл:cl_cc_stat_i4.png]]
|-
|<div id="Plane"></div>Плоскость
|Две оси. Отображается только один показатель (первый из показателей в запросе). На пересечении осей (горизонтальной и вертикальной) выводится значение показателя с подсветкой, интенсивность которой соответствует величине соответствующего показателя.
Поддерживает выгрузку в MSExcel в виде транспонированной таблицы
|[[Файл:cl_cc_stat_i5.png]]
|-
|Таблица
|Оси отсутствуют, каждая категория данных рассматривается отдельно. Произвольное число показателей. Наиболее общий способ вывода информации. Поддерживает выгрузку в MSExcel виде таблицы данных, соответствующей полученной выборке.
|[[Файл:cl_cc_stat_i6.png]]
|-
|Динамическая таблица
|Аналогична таблице. Оперирует произвольным числом столбцов. Отсутствует раздел назначения типов выходных данных. Все, что возвращает запрос, автоматически выводится на экран, однако за исключением столбцов, имена которых начинаются с символа подчеркивания «_».
|[[Файл:cl_cc_stat_i6.png]]
|}

Каждый отчет может содержать произвольный фильтр.

Выбрав в списке интересующий отчет, супервизору необходимо задать значения для установленного в отчете фильтра (даты, время, операторы, задачи и произвольный набор других параметров, использованных создателем отчета при его формировании). После нажатия кнопки «Отобразить» отчет примет вид в соответствии с его настройкой на основе данных, полученных из БД. Нажав кнопку «Экспортировать» супервизор может выгрузить отчет в MS Excel в том виде, в котором он представлен в его клиентском модуле Oktell.

Создание отчетов должно вестись людьми, имеющими представление о структуре данных.
* Описание. Краткое или полное описание отчета. Доступно супервизору на вкладке диаграммы по щелчку на пиктограмме с вопросительным знаком. В случае, когда супервизору по соображениям безопасности запрещен доступ к вкладке настроек, это единственный способ доступа к описанию.
* Группа. Перечень групп, к которым относится редактируемый отчет. На этапе редактирования прямым заданием текста могут быть созданы новые группы. Используются для фильтрации на вкладке настроек.
* Тип диаграммы. Один из приведенных выше вариантов отображения результатов отчета.
* Тип формирования. Пользовательский режим создания отчетов дает возможность формирования простых агрегирующих срезов OLAP. Доступны также обобщенные механизмы формирования отчетов на основе текста запросов SQL и на основе хранимых процедур.
Для создания отчета на базе текста запроса SQL в режиме редактирования на вкладке «Свойства» выберите тип формирования «Запрос SQL». Перейдите на вкладку «Данные» и заполните поле запроса в соответствии со своей задачей. Запрос может быть практически любой сложности с единственным ограничением: весь запрос будет передан на обработку одним пакетом. При необходимости задайте входные параметры, подставляемые из фильтра.
Для создания отчета на базе хранимой процедуры в режиме редактирования на вкладке «Свойства» выберите вариант «Хранимая процедура». После перехода на вкладку данных в выпадающем дереве необходимо выбрать базу и хранимую процедуру (также можно ввести полное имя процедуры в ручном режиме). Автоматически будут загружены все ее параметры, для которых необходимо назначить типы. Параметры попадут в фильтр при построении отчета. Отчеты на основе хранимых процедур позволяют удобно отлаживать сложные запросы, а также использовать весь функционал, доступный для них.

Автообновление отчетов. В некоторых случаях необходимы отчеты, которые постоянно выводят на экран свежие данные. Для этого в свойствах отчета необходимо установить период автообновления. При запуске расчета будет запущен процесс обновления информации (перерасчета) через установленные промежутки времени.

Сохраните запрос, и он сразу же станет доступным для использования.

Для экспорта отчета в файл выделите необходимые отчеты и нажмите кнопку «Экспорт» слева внизу (или выберите соответствующий пункт в контекстном меню), а в предложенном окне укажите путь.

Для импорта отчетов нажмите «Импорт» (или выберите соответствующий пункт в контекстном меню) и в окне выбора файлов выделите один или несколько файлов отчетов. При неуспешном импорте во всплывающем окне будет подведен итог количества успешно и неуспешно импортированных отчетов. Импорт может быть осуществлен с заменой идентификаторов отчетов. В обычном режиме при обнаружении в системе отчета с совпадающим кодом он будет перезаписан. При импорте с заменой идентификатора при обнаружении совпадения код импортируемого отчета заменяется на уникальный новый.

Если в системе установлено очень много отчетов, и они мешают восприятию, часть редко используемых специфических отчетов можно экспортировать и хранить отдельно, удалив из системы.

[[Файл:cl_cc_stat1.png|center|800px]]

В запросе могут быть использованы параметры, которые необходимо будет ввести пользователю перед формированием отчета (перед отправкой запроса на выполнение). Все параметры в запросе (как это принято в MS SQL) обозначаются через одинарный символ «@», например @paramname. Используйте их в тексте запроса по своему усмотрению. Помимо переданных извне параметров в запросе могут присутствовать и внутренние переменные, обозначающиеся таким же способом. Отличие переменной от параметра в том, что переменная в тексте запроса однократно объявляется перед использованием с помощью директивы «Declare», например «DECLARE @var1 INT, @var2 nvarchar(200)». Если в запросе отрезок текста начинается с однократного @, и не является переменной, он автоматически считается параметром. Все параметры должны быть объявлены. Для этого используется верхнее поле в интерфейсе настройки отчета. Задайте необходимое число параметров: укажите их идентификаторы, типы и заголовки (для удобного восприятия пользователем при формировании фильтра). Если все корректно, то после нажатия кнопки «Выполнить» запрос считается компилируемым и поля затеняются. Любое изменение в любом из двух полей (поля фильтра и SQL-запрос) автоматически снимет флаг компилируемости.

Следите за тем, чтобы не использовались одинаково именованные параметры. Это не приведет ни к чему адекватному.

Стоит отметить, что каждый тип параметра в фильтре представляет собой переменную определенного типа. Среди них int, nvarchar, bit, datetime. Однако существуют в перечне и более сложные параметры: временнЫе интервалы и врЕменные таблицы (наборы).

Временной интервал представляет для пользователя поле с выпадающим вниз инструментом Oktell «Календарь». Выбрав период, пользователь указывает на две даты – начало и конец интервала. В параметрах фильтра они задаются двумя разными идущими подряд строчками, а отображаются в фильтре единым полем.
Категория «Набор» для пользователя, заполняющего фильтр, представляет собой совокупность галочек соответствующего множества элементов (операторы, состояния, задачи, проекты, результаты задач). Для администратора БД, создающего отчет в виде SQL-запроса подобный идентификатор является не параметром-переменной, а параметром-таблицей с единственным полем «Id» внутри. Именно в ней будут сохранены строки, соответствующие элементам, включенным в набор. В отчетах на базе текста SQL обращение к этим таблицам осуществляется с префиксом «@», в отчетах на базе хранимых процедур - с префиксом «#».

Перечень всевозможных типов параметров с указанием соответствующих им типов в SQL, которые можно использовать в фильтре:
* Целое число (int)
* Вещественное число (float)
* Строка (nvarchar)
* Галочка (bit)
* Галочка с 3 состояниями (int)
* Дата (datetime)
* Интервал дат (начало) (используется в паре с «интервал дат-конец») (datetime, datetime)
* Интервал дат (конец) (используется в паре с «интервал дат-начало») (datetime, datetime)
* Время (datetime)
* Временной интервал (начало) (используется в паре с «временной интервал-конец») (datetime, datetime)
* Временной интервал (конец) (используется в паре с «временной интервал-начало») (datetime, datetime)
* Оператор (uniqueidentifier)
* Набор операторов ( table ( Id uniqueidentifier ) )
* Задача (uniqueidentifier)
* Набор задач ( table ( Id uniqueidentifier ) )
* Проект (uniqueidentifier)
* Набор проектов ( table ( Id uniqueidentifier ) )
* Статус оператора (int)
* Набор статусов операторов ( table ( Id int ) )
* Результат задачи (int)
* Набор результатов задачи ( table ( Id int ) )
* Пользовательский список ( тип, соответствующий запросу пользователя на определение списка, или sql_variant )
* Пользовательский набор ( table ( Id sql_variant ) )

Пользовательские типы фильтров (список и набор) требуют задания SQL-запроса для формирования списка доступных значений. Для задания или изменения текущего запроса какого-либо элемента фильтра с пользовательским типом необходимо щелкнуть в правой части таблицы параметров (в последнем столбце, содержащем «...»), в строке интересующего элемента. В открывшемся окне скорректировать запрос, после чего закрыть окно. Запрос должен представлять собой один пакет (batch) и может иметь любую сложноcть. Однако следует учитывать, что постоянное его выполнение в ходе создания фильтра может привести к длительным задержкам, в случае, если время выполнения созданного запроса достаточно велико. В качестве результатов берется первый возвращаемый набор данных. Первый столбец считается идентификатором, значение (или таблица значений) которого будет передано в основной запрос отчета на этапе его построения. Второй столбец - описания, подставляемые в визуальные компоненты для отображения. А качестве идентификаторов могут выступать любые типы, за исключением TEXT, NTEXT, TIMESTAMP.

Для привязки запросов к конкретным пользователям, осуществляющим построение отчетов, можно использовать предопределенную переменную ''@authorizeduserid'' (в отчетах из хранимых процедур - таблицу ''#authorizeduserid'').

Примеры запросов на формирование пользовательского фильтра:

<pre>Select [Id], [Caption] From dbo.[ClientTypes]

Declare @dttoday DateTime

Set @dttoday = Cast ( Floor ( Cast ( GetDate() as float ) ) as DateTime )

Select [Id], [Name]

From dbo.[Clients] cl

Inner join dbo.[ClientCalls] cc on cl.[Id] = cc.[IdClient]

Where [LastCall] > @dttoday

Group By [Id], [Name]</pre>

После формирования запроса и успешной его проверки выставляется флаг компилируемости. Из получающейся в результате выполнения запроса выборки выделяются столбцы и помещаются в нижнюю часть интерфейса в таблицу «Назначение». Здесь в зависимости от типа выбранного визуального представления запроса необходимо проставить нужным столбцам соответствующие типы и задать описания (для удобного восприятия отчета пользователем)

Среди типов уже рассмотренные выше «Ось» и «Значение». Тип «Не отображается» указывает построителю отчета на отсутствие необходимости использовать поле. Для отчета типа «Плоскость» среди типов вместо «Ось» появляются два «Горизонтальная ось» и «Вертикальная ось». Для табличных отчетов все поля типа «Ось» будут подсвечены в результирующем поле. Не отображаемые поля будут пропущены при выводе данных и при экспорте.

ВНИМАНИЕ! При использовании временных таблиц # в отчетах на основе текстового запроса, необходимо в начале тела запроса помещать команду SET FMTONLY OFF, иначе использование # не будет возможным. В других случаях не рекомендуется использовать указанную команду. При обнаружении некорректных ситуаций при использовании # или других команд рекомендуется преобразовать отчет в хранимую процедуру.

ВНИМАНИЕ! В некоторых отчетах могут понадобиться данные из прикрепленной таблицы абонентов. Операция обращения к ней тривиальна в случае работы с внешней таблицей, и может быть проблематична при работе с локальной таблицей в силу специфики ее хранения (если для нее выбрана автоматическая генерация имени). Это необходимо учитывать при формировании проекта. Для удобства работы с отчетами внутри системы рекомендуются к использованию внешние таблицы, а также локальные таблицы с явным указанием имени и типов полей. Ниже приведен пример кода для формирования временной таблицы с полями Id и Name с данными из произвольной (в том числе и локальной) прикрепленной таблицы абонентов.

<pre>
-------------------------------------------------------------------

-- Формирование временной таблицы @tmpic ( Id, Name ) с данными

-- из прикрепленной к задаче с кодом @idtask таблицы абонентов.

-------------------------------------------------------------------</pre>

<pre>SET FMTONLY OFF

Declare @emptyname nvarchar ( 30 )

Set @emptyname = ''

Declare @hasnames bit

Set @hasnames = 0

Declare @idlist uniqueidentifier

Select @idlist = ListId From A_TaskManager_Tasks t where Id = @idtask

if ( @idlist is null )

Set @emptyname = '<список удален>'

Declare @abons table ( Id int, Name nvarchar ( 200 ) )

Declare @type int

Declare @query nvarchar ( 4000 )

Declare @jtable nvarchar ( 1000 )

Declare @colname nvarchar ( 50 )

Declare @colid nvarchar ( 50 )

Select @type = Type, @query = Query, @jtable = JoinedTable, @colid = ColumnId, @colname = ColumnName

From A_TaskManager_Lists

Where Id = @idlist

Declare @tmpic table ( Id int, Name nvarchar ( 1000 ) )

if ( Len ( @colid ) > 0 ) and ( Len ( @colname ) > 0 ) and ( not @type is null )

begin

Declare @extquery nvarchar ( 4000 )

if exists ( Select * From tempdb..sysobjects Where Id = object_id ( 'tempdb..#tmpic' ) )

Drop Table #tmpic

Create table #tmpic ( id int, name nvarchar ( 1000 ) )

if ( Len ( @jtable ) > 0 ) and ( @type in ( 1, 2 ) )

begin

Set @extquery = 'Select ' + @colid + ' as Id, Cast ( IsNull ( ' +

@colname + ', ''' + @emptyname +

''' ) as nvarchar ( 1000 ) ) as Name From ' + @jtable

Insert into #tmpic

Exec sp_sqlexec @extquery

Set @hasnames = 1

end

else if ( Len ( @query ) > 0 ) and ( @type = 3 )

begin

Set @extquery = 'Select ' + @colid + ' as Id, Cast ( IsNull ( ' +

@colname + ', ''' + @emptyname +

''' ) as nvarchar ( 1000 ) ) as Name From (' + @query + ')a'

Insert into #tmpic

Exec sp_sqlexec @extquery

Set @hasnames = 1

end

Insert into @tmpic

Select * From #tmpic

Set @emptyname = '<не найден>'

Update @tmpic

Set Name = @emptyname

Where Name = ''

Drop Table #tmpic

Set @emptyname = '<не задано>'

end</pre>

<pre>
-------------------------------------------------------------------

-- Далее можно пользоваться таблицей @tmpic с полями Id и Name

-------------------------------------------------------------------</pre>

Статистика

2023-05-25T09:30:46Z

Oktell Support: /* Диаграммы и настройка */

<code>[[Техническая документация]] / [[Call-центр]] / [[Статистика]] </code>

Модуль статистики call-центра доступен супервизорам, администраторам и другим пользователям, обладающим соответствующим правом. Для пользования модулем необходимо зарегистрироваться в call-центре системы. Служит для построения хронологических отчетов различной формы и содержания.

===Журнал звонков===

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

Данные, отображаемые пользователю, помимо установленного им фильтра будут отфильтрованы согласно правам на проекты. Информация по задаче в журнале видна только ее супервизорам и имеющим доступ к ее проекту.

ВНИМАНИЕ! При запросе больших объемов данных необходимо учитывать, что это создает дополнительную нагрузку на процессорное время сервера БД и сетевой трафик. В некоторых случаях это может отразиться на качестве разговоров, осуществляющихся через VoIP шлюз сервера.

Полученные результаты доступны для экспорта в текстовые файлы, в файлы MS Excel и HTML. Также доступна выгрузка записей всех разговоров, попадающих под условие фильтра. Необходимо иметь в виду, что выгрузка записей осуществляется в их текущем состоянии. Используйте предварительное микширование, чтобы гарантировать объединение разговоров в один файл.

===Диаграммы и настройка===

Содержание и количество прочих отчетов не ограничено. По умолчанию модуль содержит ряд предустановленных отчетов, оценивающих основные показатели работы call-центра на основе полной статистики, собираемой системой в отдельную БД. Статистичская БД Oktell хранит данные в виде пространственной модели (OLAP-кубов), данные в которую попадают в процессе работы. Перечень существующих в ней кубов продолжает расширяться. Это и куб коммутаций, попыток звонков по задачам, куб состояний операторов, куб состояний очереди ожидания. Подробнее в разделе [[Структура пространственной БД]].

Пользователи системы могут редактировать существующие отчеты и создавать новые. Также доступны функции экспорта и импорта отчетов, позволяющими вести динамический обмен со сторонними пользователями и разработчиками.

Отчеты подчиняются политике прав доступа. Параметры доступа к ним определяются на соответствующей вкладке «Доступ». Доступные привилегии: чтение, изменение. Также применяется общая ролевая привилегия ''«Возможность редактирования запросов SQL»''

Технология OLAP в простом виде позволяет получить из пространственных таблиц любые срезы. Несмотря на простоту использования звездной схемы пространственной БД, большинство сложных отчетов строятся не путем среза данных OLAP-куба, а на основе отдельных различной степени сложности алгоритмов. При создании отчетов администратор баз данных может подключить в качестве источника данных любой запрос как из всех баз данных Oktell, так и из любых других баз данных. Таким же образом можно производить анализ полученных данных в каждом конкретном проекте, строя отчеты под конкретные задачи, в частности на основе таблиц абонентов.

Этот механизм полной произвольности отчетов предоставляет широкие возможности как для администраторов БД, так и для супервизоров.

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

Среди вариантов отображения:

{|cellpadding="10" cellspacing="0" border="1"
|График
|Одна ось, каждый элемент оси может иметь несколько показателей. На одном изображении разным цветом строятся графики соответствующих показателей. Масштаб отображения показателей может быть общим или раздельным на усмотрение создателя отчета.
Поддерживает выгрузку в файл изображения. Поддерживает большие объемы данных, отображая графически-зависимую полосу прокрутки.
|[[Файл:cl_cc_stat_i7.png]]
|-
|Точки
|Одна ось, каждый элемент оси имеет может иметь несколько показателей. На одном изображении разным цветом отображаются точки, соответствующие значениям своих показателей. Масштаб отображения показателей может быть общим или раздельным на усмотрение создателя отчета.
Поддерживает выгрузку в файл изображения. Поддерживает большие объемы данных, отображая графически-зависимую полосу прокрутки.
|[[Файл:cl_cc_stat_i8.png]]
|-
|<div id="VertHysto"></div>Вертикальная гистограмма
|Аналогична графику, но ориентирована вертикально.
|[[Файл:cl_cc_stat_i10.png]]
|-
|Соотношение
|Одна ось, каждый элемент оси может иметь несколько показателей, каждый из которых отображается отдельной полосой.
Вид отчета аналогичен виду модуля «Индикаторы».
|[[Файл:cl_cc_stat_i9.png]]
|-
|Диаграмма
|Одна ось, для каждого элемента из которых выводится только один показатель (первый из показателей в запросе). Суммарная величина показателей всех элементов образует 100%. На круговой диаграмме строятся сектора, соответствующие процентным соотношениям.
Поддерживает выгрузку в файл изображения.
|[[Файл:cl_cc_stat_i4.png]]
|-
|<div id="Plane"></div>Плоскость
|Две оси. Отображается только один показатель (первый из показателей в запросе). На пересечении осей (горизонтальной и вертикальной) выводится значение показателя с подсветкой, интенсивность которой соответствует величине соответствующего показателя.
Поддерживает выгрузку в MSExcel в виде транспонированной таблицы
|[[Файл:cl_cc_stat_i5.png]]
|-
|Таблица
|Оси отсутствуют, каждая категория данных рассматривается отдельно. Произвольное число показателей. Наиболее общий способ вывода информации. Поддерживает выгрузку в MSExcel виде таблицы данных, соответствующей полученной выборке.
|[[Файл:cl_cc_stat_i6.png]]
|-
|Динамическая таблица
|Аналогична таблице. Оперирует произвольным числом столбцов. Отсутствует раздел назначения типов выходных данных. Все, что возвращает запрос, автоматически выводится на экран, однако за исключением столбцов, имена которых начинаются с символа подчеркивания «_».
|[[Файл:cl_cc_stat_i6.png]]
|}

Каждый отчет может содержать произвольный фильтр.

Выбрав в списке интересующий отчет, супервизору необходимо задать значения для установленного в отчете фильтра (даты, время, операторы, задачи и произвольный набор других параметров, использованных создателем отчета при его формировании). После нажатия кнопки «Отобразить» отчет примет вид в соответствии с его настройкой на основе данных, полученных из БД. Нажав кнопку «Экспортировать» супервизор может выгрузить отчет в MS Excel в том виде, в котором он представлен в его клиентском модуле Oktell.

Создание отчетов должно вестись людьми, имеющими представление о структуре данных.
* Описание. Краткое или полное описание отчета. Доступно супервизору на вкладке диаграммы по щелчку на пиктограмме с вопросительным знаком. В случае, когда супервизору по соображениям безопасности запрещен доступ к вкладке настроек, это единственный способ доступа к описанию.
* Группа. Перечень групп, к которым относится редактируемый отчет. На этапе редактирования прямым заданием текста могут быть созданы новые группы. Используются для фильтрации на вкладке настроек.
* Тип диаграммы. Один из приведенных выше вариантов отображения результатов отчета.
* Тип формирования. Пользовательский режим создания отчетов дает возможность формирования простых агрегирующих срезов OLAP. Доступны также обобщенные механизмы формирования отчетов на основе текста запросов SQL и на основе хранимых процедур.
Для создания отчета на базе текста запроса SQL в режиме редактирования на вкладке «Свойства» выберите тип формирования «Запрос SQL». Перейдите на вкладку «Данные» и заполните поле запроса в соответствии со своей задачей. Запрос может быть практически любой сложности с единственным ограничением: весь запрос будет передан на обработку одним пакетом. При необходимости задайте входные параметры, подставляемые из фильтра.
Для создания отчета на базе хранимой процедуры в режиме редактирования на вкладке «Свойства» выберите вариант «Хранимая процедура». После перехода на вкладку данных в выпадающем дереве необходимо выбрать базу и хранимую процедуру (также можно ввести полное имя процедуры в ручном режиме). Автоматически будут загружены все ее параметры, для которых необходимо назначить типы. Параметры попадут в фильтр при построении отчета. Отчеты на основе хранимых процедур позволяют удобно отлаживать сложные запросы, а также использовать весь функционал, доступный для них.

Автообновление отчетов. В некоторых случаях необходимы отчеты, которые постоянно выводят на экран свежие данные. Для этого в свойствах отчета необходимо установить период автообновления. При запуске расчета будет запущен процесс обновления информации (перерасчета) через установленные промежутки времени.

Сохраните запрос, и он сразу же станет доступным для использования.

Для экспорта отчета в файл выделите необходимые отчеты и нажмите кнопку «Экспорт» слева внизу (или выберите соответствующий пункт в контекстном меню), а в предложенном окне укажите путь.

Для импорта отчетов нажмите «Импорт» (или выберите соответствующий пункт в контекстном меню) и в окне выбора файлов выделите один или несколько файлов отчетов. При неуспешном импорте во всплывающем окне будет подведен итог количества успешно и неуспешно импортированных отчетов. Импорт может быть осуществлен с заменой идентификаторов отчетов. В обычном режиме при обнаружении в системе отчета с совпадающим кодом он будет перезаписан. При импорте с заменой идентификатора при обнаружении совпадения код импортируемого отчета заменяется на уникальный новый.

Если в системе установлено очень много отчетов, и они мешают восприятию, часть редко используемых специфических отчетов можно экспортировать и хранить отдельно, удалив из системы.

[[Файл:cl_cc_stat1.png|center|800px]]

В запросе могут быть использованы параметры, которые необходимо будет ввести пользователю перед формированием отчета (перед отправкой запроса на выполнение). Все параметры в запросе (как это принято в MS SQL) обозначаются через одинарный символ «@», например @paramname. Используйте их в тексте запроса по своему усмотрению. Помимо переданных извне параметров в запросе могут присутствовать и внутренние переменные, обозначающиеся таким же способом. Отличие переменной от параметра в том, что переменная в тексте запроса однократно объявляется перед использованием с помощью директивы «Declare», например «DECLARE @var1 INT, @var2 nvarchar(200)». Если в запросе отрезок текста начинается с однократного @, и не является переменной, он автоматически считается параметром. Все параметры должны быть объявлены. Для этого используется верхнее поле в интерфейсе настройки отчета. Задайте необходимое число параметров: укажите их идентификаторы, типы и заголовки (для удобного восприятия пользователем при формировании фильтра). Если все корректно, то после нажатия кнопки «Выполнить» запрос считается компилируемым и поля затеняются. Любое изменение в любом из двух полей (поля фильтра и SQL-запрос) автоматически снимет флаг компилируемости.

Следите за тем, чтобы не использовались одинаково именованные параметры. Это не приведет ни к чему адекватному.

Стоит отметить, что каждый тип параметра в фильтре представляет собой переменную определенного типа. Среди них int, nvarchar, bit, datetime. Однако существуют в перечне и более сложные параметры: временнЫе интервалы и врЕменные таблицы (наборы).

Временной интервал представляет для пользователя поле с выпадающим вниз инструментом Oktell «Календарь». Выбрав период, пользователь указывает на две даты – начало и конец интервала. В параметрах фильтра они задаются двумя разными идущими подряд строчками, а отображаются в фильтре единым полем.
Категория «Набор» для пользователя, заполняющего фильтр, представляет собой совокупность галочек соответствующего множества элементов (операторы, состояния, задачи, проекты, результаты задач). Для администратора БД, создающего отчет в виде SQL-запроса подобный идентификатор является не параметром-переменной, а параметром-таблицей с единственным полем «Id» внутри. Именно в ней будут сохранены строки, соответствующие элементам, включенным в набор. В отчетах на базе текста SQL обращение к этим таблицам осуществляется с префиксом «@», в отчетах на базе хранимых процедур - с префиксом «#».

Перечень всевозможных типов параметров с указанием соответствующих им типов в SQL, которые можно использовать в фильтре:
* Целое число (int)
* Вещественное число (float)
* Строка (nvarchar)
* Галочка (bit)
* Галочка с 3 состояниями (int)
* Дата (datetime)
* Интервал дат (начало) (используется в паре с «интервал дат-конец») (datetime, datetime)
* Интервал дат (конец) (используется в паре с «интервал дат-начало») (datetime, datetime)
* Время (datetime)
* Временной интервал (начало) (используется в паре с «временной интервал-конец») (datetime, datetime)
* Временной интервал (конец) (используется в паре с «временной интервал-начало») (datetime, datetime)
* Оператор (uniqueidentifier)
* Набор операторов ( table ( Id uniqueidentifier ) )
* Задача (uniqueidentifier)
* Набор задач ( table ( Id uniqueidentifier ) )
* Проект (uniqueidentifier)
* Набор проектов ( table ( Id uniqueidentifier ) )
* Статус оператора (int)
* Набор статусов операторов ( table ( Id int ) )
* Результат задачи (int)
* Набор результатов задачи ( table ( Id int ) )
* Пользовательский список ( тип, соответствующий запросу пользователя на определение списка, или sql_variant )
* Пользовательский набор ( table ( Id sql_variant ) )

Пользовательские типы фильтров (список и набор) требуют задания SQL-запроса для формирования списка доступных значений. Для задания или изменения текущего запроса какого-либо элемента фильтра с пользовательским типом необходимо щелкнуть в правой части таблицы параметров (в последнем столбце, содержащем «...»), в строке интересующего элемента. В открывшемся окне скорректировать запрос, после чего закрыть окно. Запрос должен представлять собой один пакет (batch) и может иметь любую сложноcть. Однако следует учитывать, что постоянное его выполнение в ходе создания фильтра может привести к длительным задержкам, в случае, если время выполнения созданного запроса достаточно велико. В качестве результатов берется первый возвращаемый набор данных. Первый столбец считается идентификатором, значение (или таблица значений) которого будет передано в основной запрос отчета на этапе его построения. Второй столбец - описания, подставляемые в визуальные компоненты для отображения. А качестве идентификаторов могут выступать любые типы, за исключением TEXT, NTEXT, TIMESTAMP.

Для привязки запросов к конкретным пользователям, осуществляющим построение отчетов, можно использовать предопределенную переменную ''@authorizeduserid'' (в отчетах из хранимых процедур - таблицу ''#authorizeduserid'').

Примеры запросов на формирование пользовательского фильтра:

<pre>Select [Id], [Caption] From dbo.[ClientTypes]

Declare @dttoday DateTime

Set @dttoday = Cast ( Floor ( Cast ( GetDate() as float ) ) as DateTime )

Select [Id], [Name]

From dbo.[Clients] cl

Inner join dbo.[ClientCalls] cc on cl.[Id] = cc.[IdClient]

Where [LastCall] > @dttoday

Group By [Id], [Name]</pre>

После формирования запроса и успешной его проверки выставляется флаг компилируемости. Из получающейся в результате выполнения запроса выборки выделяются столбцы и помещаются в нижнюю часть интерфейса в таблицу «Назначение». Здесь в зависимости от типа выбранного визуального представления запроса необходимо проставить нужным столбцам соответствующие типы и задать описания (для удобного восприятия отчета пользователем)

Среди типов уже рассмотренные выше «Ось» и «Значение». Тип «Не отображается» указывает построителю отчета на отсутствие необходимости использовать поле. Для отчета типа «Плоскость» среди типов вместо «Ось» появляются два «Горизонтальная ось» и «Вертикальная ось». Для табличных отчетов все поля типа «Ось» будут подсвечены в результирующем поле. Не отображаемые поля будут пропущены при выводе данных и при экспорте.

ВНИМАНИЕ! При использовании временных таблиц # в отчетах на основе текстового запроса, необходимо в начале тела запроса помещать команду SET FMTONLY OFF, иначе использование # не будет возможным. В других случаях не рекомендуется использовать указанную команду. При обнаружении некорректных ситуаций при использовании # или других команд рекомендуется преобразовать отчет в хранимую процедуру.

ВНИМАНИЕ! В некоторых отчетах могут понадобиться данные из прикрепленной таблицы абонентов. Операция обращения к ней тривиальна в случае работы с внешней таблицей, и может быть проблематична при работе с локальной таблицей в силу специфики ее хранения (если для нее выбрана автоматическая генерация имени). Это необходимо учитывать при формировании проекта. Для удобства работы с отчетами внутри системы рекомендуются к использованию внешние таблицы, а также локальные таблицы с явным указанием имени и типов полей. Ниже приведен пример кода для формирования временной таблицы с полями Id и Name с данными из произвольной (в том числе и локальной) прикрепленной таблицы абонентов.

<pre>
-------------------------------------------------------------------

-- Формирование временной таблицы @tmpic ( Id, Name ) с данными

-- из прикрепленной к задаче с кодом @idtask таблицы абонентов.

-------------------------------------------------------------------</pre>

<pre>SET FMTONLY OFF

Declare @emptyname nvarchar ( 30 )

Set @emptyname = ''

Declare @hasnames bit

Set @hasnames = 0

Declare @idlist uniqueidentifier

Select @idlist = ListId From A_TaskManager_Tasks t where Id = @idtask

if ( @idlist is null )

Set @emptyname = '<список удален>'

Declare @abons table ( Id int, Name nvarchar ( 200 ) )

Declare @type int

Declare @query nvarchar ( 4000 )

Declare @jtable nvarchar ( 1000 )

Declare @colname nvarchar ( 50 )

Declare @colid nvarchar ( 50 )

Select @type = Type, @query = Query, @jtable = JoinedTable, @colid = ColumnId, @colname = ColumnName

From A_TaskManager_Lists

Where Id = @idlist

Declare @tmpic table ( Id int, Name nvarchar ( 1000 ) )

if ( Len ( @colid ) > 0 ) and ( Len ( @colname ) > 0 ) and ( not @type is null )

begin

Declare @extquery nvarchar ( 4000 )

if exists ( Select * From tempdb..sysobjects Where Id = object_id ( 'tempdb..#tmpic' ) )

Drop Table #tmpic

Create table #tmpic ( id int, name nvarchar ( 1000 ) )

if ( Len ( @jtable ) > 0 ) and ( @type in ( 1, 2 ) )

begin

Set @extquery = 'Select ' + @colid + ' as Id, Cast ( IsNull ( ' +

@colname + ', ''' + @emptyname +

''' ) as nvarchar ( 1000 ) ) as Name From ' + @jtable

Insert into #tmpic

Exec sp_sqlexec @extquery

Set @hasnames = 1

end

else if ( Len ( @query ) > 0 ) and ( @type = 3 )

begin

Set @extquery = 'Select ' + @colid + ' as Id, Cast ( IsNull ( ' +

@colname + ', ''' + @emptyname +

''' ) as nvarchar ( 1000 ) ) as Name From (' + @query + ')a'

Insert into #tmpic

Exec sp_sqlexec @extquery

Set @hasnames = 1

end

Insert into @tmpic

Select * From #tmpic

Set @emptyname = '<не найден>'

Update @tmpic

Set Name = @emptyname

Where Name = ''

Drop Table #tmpic

Set @emptyname = '<не задано>'

end</pre>

<pre>
-------------------------------------------------------------------

-- Далее можно пользоваться таблицей @tmpic с полями Id и Name

-------------------------------------------------------------------</pre>

Резервное копирование и восстановление баз данных

2023-05-16T07:32:29Z

Oktell Support: /* Восстановление баз данных */

[[Практики|Наверх]]

__TOC__

Необходимость сохранить базы данных настроенной системы возникает, как правило, перед переустановкой ОС на серверной машине, либо для переноса работающей серверной конфигурации на другую машину.

==Копирование баз данных==

Используемые базы данных делятся на две категории: 3 системные БД (oktell, oktell_cc_temp и oktell_settings) и БД для модулей веб-клиента Okapp. Для запуска Oktell после восстановления нужны только системные базы. Остальные БД нужны только, если вы хотите сохранить ваши настройки веб-модуля.
<blockquote>
Например, база WO_Module_journal используется модулем '''Журнал''' хранит в себе теги записей разговоров. База WO_Module_dashboards нужна для работы модуля Дашборды Okboard и содержит настройки используемых индикаторов.
</blockquote>
В любом случае, мы рекомендуем делать резервные копии всех баз данных, которые используются системой.

'''Шаг 1.''' Копии системных таблиц создаются автоматически каждый день, по умолчанию в 02:00 по серверному времени, если не отключен параметр [[Параметры файлов конфигурации#Параметры файла конфигурации серверного приложения|DBAutoDailyBackup]]. Создание копий происходит особым образом, оставляя копии
* последние две недели - каждый день
* далее три месяца - раз в неделю
* далее два года - каждый месяц
* далее раз в год
Все копии находятся в папке \oktell\server\Backup, если не переопределено в параметре [[Параметры файлов конфигурации#Параметры файла конфигурации серверного приложения|DBBackupDir]].

В свою очередь, вы можете сделать резервные копии в любой момент. Для этого перейдите в ''Администрирование/Обшие настройки/Управление базами данных''. Нажмите кнопку '''Произвести резервное копирование БД'''.

[[Файл:бэк1.PNG |center]]

После окончания резервного копирования созданные бэкапы будут доступны в корне папки ''oktell\server\backup''.

<center>[[Файл:бэк2.PNG]][[Файл:бэк3.PNG]]</center>

'''Шаг 2.''' Для созданий копий остальных баз данных откройте SQL Server Management Studio. Кликните правой кнопкой на нужной БД и в контекстном меню выберите Задачи, затем '''Создать резервную копию'''. В открывшемся окне вы можете поменять путь для создания бэкапа, для начала копирования нажмите ОК. Копии по умолчанию создается в папке ''C:\Program Files\Microsoft SQL Server\MSSQL11.OKTELL\MSSQL\Backup\''.

[[Файл:Резервное копирование и восстановление баз данных 020.png|center|1000px]]

==Восстановление баз данных==

Восстановить базы данных можно только на такую же версию SQL-сервера или выше. Если базы были созданы на версии SQL Server 2008 R2, их нельзя восстановить на SQL Server 2008.

'''Шаг 1.''' Остановите службу oktellserver. Запустите командную строку с правами администратора и введите туда следующую строчку:

net stop oktellserver

[[Файл:бэк4.PNG|center]]

'''Шаг 2.''' Запустите SQL Server Management Studio с учетной записью sa:
* Login: sa
* Password: 123Oktell321

'''Шаг 3.''' Если у вас есть ранее установленные базы данных Oktell, то их нужно удалить. Это касается системных БД и БД, используемых веб-модулями.

'''Шаг 4.''' Приступаем к процедуре восстановления. Нажмите правой кнопкой на System Database (Системные базы данных) и нажмите '''Restore Database''' (Восстановить резервную копию).

<center>[[Файл:бэк6.PNG]]</center>

Выберите файл с копией баз данных. Для этого выберите пункт Device (Устройство), в открывшемся окне Add (Добавить) и выберите ваш файл с резервной копией, например '''db_ok_130628.bak''' (в данном случае, это БД oktell).

[[Файл:бэк8.PNG|center|1000px]]

Наберите имя базы данных в верхней части окна, которую вы восстанавливаете. Название базы данных вы можете видеть в нижней части окна. Не забудьте поставить галочку '''Restore''' (Восстановить).

[[Файл:бэк9.PNG|center|600px]]

Повторите тоже самое с остальными базами данных.

'''Шаг 5.''' После восстановления баз данных для полноценной работы необходимо создать пользователей базы данных. Для этого выполните скачайте и выполните следующий запрос.

[[Media:Восстановление базы данных.zip|Скачать файл '''Восстановление базы данных.zip''']]

'''Шаг 6.''' Если вы перенесли базу данных на сторонний сервер, то проверьте настройки в серверном конфигурационном файле ''\oktell\server\oktell.ServerService.exe.config''. Убедитесь что в строке с ключом DBConnectionString ссылка на базу данных, логин и пароль указаны верно. По умолчанию, строка подключения выглядит следующим образом:

server=(local)\OKTELL;database=oktell;uid=AutelService;pwd=[pwd];pooling=true

Новое название сервера нужно указать вместо значения ''(local)\OKTELL''. Например, SQL-сервер перенесен на сервер WORK с IP-адресом 192.168.0.3. Следовательно, в параметре вам нужно указать ''WORK\OKTELL''. Если сервер не запускается с этой настройкой, попробуйте указать только название сервера без инстанса — ''WORK''. Вместо названия сервера можно указать IP-адрес — ''192.168.0.3/OKTELL'' или только ''192.168.0.3''.

Если вы поменяли основную учетную запись AutelService, то необходимо указать новые логин и пароль в полях '''uid''' и '''pwd''' соответственно.

[[Файл:Серверная служба не запускается -003.png|center]]

Узнать название вашего сервера (инстанс) вы всегда можете с помощью команды
sqlcmd.exe -L
в командной строке Windows.

[[Файл:Серверная служба не запускается -004.png|center]]

'''Шаг 7.''' Запустите службу '''oktellserver'''. Для этого в командной строке выполните
net start oktellserver

[[Файл:бэкв.PNG|center]]

Порядок обновления программы в ручном режиме

2023-04-05T07:37:41Z

Oktell Support:

[[Дополнительно|Наверх]]

Порядок действия при обновлении Oktell до старшей версии.

Внимание, файлы обновления будут установлены, только в том случае, если ваша лицензия имеет действительный АГО (абонемент годового обновления). Крайне не рекомендуется обновляться в ручном режиме, в случае отсутствия действующего АГО. Наличие АГО вы можете проверить в меню Администрирование — Общие настройки — Информация — Ограничения по версиям
Обновление проходит в несколько этапов. При необходимости обновления комплекса инструкция будет дополнительно предоставлена технической поддержкой. Ниже приведены общие этапы.

'''1. В полуавтоматическом режиме:'''

* скачать файл обновления.

* указать файл обновления в меню "Администрирование > Общие настройки > Управление сервером" кнопка "Провести обновление из файла".

* После этого сервер перезапустится и обновит всех клиентов.

'''2. В ручном режиме:'''

* скачать файл обновления с и распаковать на жесткий диск сервера.

* остановить сервер oktell (службу oktellserver);

* содержимое папок srv, both скопировать в папку C:\Program Files\Oktell\Server\

* содержимое папок cli, both скопировать в папку C:\Program Files\Oktell\Server\LiveUpdate\

* запустить сервер oktell (службу oktellserver).

----

'''Примечания'''

# Настоятельно рекомендуется сохранить сборки работающего комплекса и произвести резервное копирование баз данных.
# Для последующего обновления всех клиентских рабочих мест файлы дублируются в каталог серверного приложения «LiveUpdate».
# Файлы обновления БД перед первым запуском находятся в каталоге сервера «DBAutoUpdate» (SQL скрипты).
# Контроль корректности обновления БД (каталог «DBAutoUpdate» должен быть пуст после корректного обновления).

Порядок обновления программы в ручном режиме

2023-04-05T07:37:08Z

Oktell Support:

[[Дополнительно|Наверх]]

Порядок действия при обновлении Oktell до старшей версии.

Внимание, файлы обновления будут установлены, только в том случае, если ваша лицензия имеет действительный АГО (абонемент годового обновления). Крайне не рекомендуется обновляться в ручном режиме, в случае отсутствия действующего АГО. Наличие АГО вы можете проверить в меню Администрирование — Общие настройки — Информация — Ограничения по версиям
Обновление проходит в несколько этапов. При необходимости обновления комплекса инструкция будет дополнительно предоставлена технической поддержкой. Ниже приведены общие этапы.

'''1. В полуавтоматическом режиме:'''

* скачать файл обновления.

* указать файл обновления в меню "Администрирование > Общие настройки > Управление сервером" кнопка "Провести обновление из файла".

* После этого сервер перезапустится и обновит всех клиентов.

'''2. В ручном режиме:'''

* скачать файл обновления с и распаковать на жесткий диск сервера.

* остановить сервер oktell (службу oktellserver);

* содержимое папок srv, both скопировать в папку C:\Program Files\Oktell\Server\

* содержимое папок cli, both скопировать в папку C:\Program Files\Oktell\Server\LiveUpdate\

* запустить сервер oktell (службу oktellserver).

----

'''Примечания'''

# Настоятельно рекомендуется сохранить сборки работающего комплекса и произвести резервное копирование баз данных.
# Для последующего обновления всех клиентских рабочих мест файлы дублируются в каталог серверного приложения «LiveUpdate».
# Файлы обновления БД перед первым запуском находятся в каталоге сервера «DBAutoUpdate». (SQL скрипты)
# Контроль корректности обновления БД (каталог «DBAutoUpdate» должен быть пуст после корректного обновления).

Сценарии без подробного описания

2023-03-31T12:50:13Z

Oktell Support:

[[Практики|Наверх]]

В этой статье будут добавляться все сценарии, которые подлежат описанию, либо те, для которых подробное описание не требуется.

:*'''Call-центр. Служебный сценарий набора номера абонента [[Media:Svc_%D0%BD%D0%B0%D0%B1%D0%BE%D1%80_%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0_cc.oscr|Сценарий последовательного перебора линий]]''' - При совершении звонка исходящей задачей последовательно проходит по всем внешним линиям, в случае не удачных попыток система попытается совершить набор следующим образом: НОМЕР1 по линии 13001, НОМЕР1 по линии 13002,..., НОМЕР1 по линии 13ххх, НОМЕР1 по линии 13001,... (циклически по всем доступным линиям).

Oktell Fast Call

2023-03-31T12:49:20Z

Oktell Support:

[[Утилиты|Наверх]]

__TOC__

'''Oktell Fast Call''' - удобное приложение, которое позволяет звонить на выделенный в данный момент номер. Чтобы совершить вызов вам нужно всего лишь выделить номер и нажать горячую клавишу на клавиатуре.

[[Файл:Oktell Fast Call 11.png|center|800px]]

'''Возможности программы'''

*Звонок из любого приложения/места, где можно выделить текст/номер телефона;
*Назначение горячей клавиши из одной или двух кнопок;
*Повторный звонок на тот же номер по горячей клавише, не выделяя текст заново. Буфер обмена при этом заменяется набранным номером телефона;
*Обработка ссылок ''callto:'' и ''tel:''. При этом другие приложения использующие данный функционал должны быть выключены или в них должен быть отключен подобный функционал на уровне настроек;
*Использование клиентского приложения Oktell для звонков;
*Использование серверной части, если у вас не установлено клиентское приложение;
*Возможность использования одного телефона на двоих или большее число людей. Для этого просто укажите внутренний номер этого телефона;
*Расположение в трее.

Скачать программу: [[Media:Oktell_Fast_Call_v1.1.zip|Oktell Fast Call v1.1.exe]]

Материалы статьи взяты из блога [http://pacifizd.blogspot.ru/2014/08/oktell-fast-call.html http://pacifizd.blogspot.ru]

==Работа с клиентским приложением Oktell==

'''1.''' Скачайте и запустите приложение '''Oktell Fast Call'''

'''2.''' Откройте '''Настройки''' двойным щелчком левой клавишей мыши по иконке в трее или правой клавишей мыши и выберите пункт "'''Настройки'''" из контекстного меню.

'''3.''' Для работы с клиентским приложением задайте следующие настройки:
* '''Горячая клавиша''' - Нажатие на заданную клавишу или комбинацию клавиш активирует звонок по выделенному номеру. По умолчанию, F9.
* '''Порт''' - локальный порт клиентского приложения для приема http-запросов. По умолчанию, 4059. О том как поменять порт, читайте в статье [[Параметры_файлов_конфигурации#ClientWebServerPort|Параметры файлов конфигурации]] (настройка ''ClientWebServerPort'')
* '''Использовать клиентское место Oktell''' - установите галочку для работы с клиентским приложением.
По окончанию настроек, нажмите '''Ок'''.

[[Файл:Oktell Fast Call 2.png|center]]

==Работа в отсутствие клиентского приложения Oktell==

'''1.''' Скачайте и запустите приложение '''Oktell Fast Call'''

'''2.''' Откройте '''Настройки''' двойным щелчком левой клавишей мыши по иконке в трее или правой клавишей мыши и выберите пункт "'''Настройки'''" из контекстного меню.

'''3.''' Для работы в отсутствие клиентского приложения Oktell используется серверный HTTP интерфейс. Для этого требуется указать следующие настройки:
* '''Горячая клавиша''' - по умолчанию, F9. Нажатие на заданную клавишу или комбинацию клавиш активирует звонок по выделенному номеру.
* '''Логин / Пароль''' - учетная запись пользователя, от имени которого будет совершаться HTTP-запрос на сервер. В примере используется учетная запись '''admin'''.
ВНИМАНИЕ: в настройках доступа пользователя (Администрирование/Пользователи/''{данный пользователь}''/Доступ) должно быть установлена привилегия "''Возможность исполнять методы Web-API''".
* '''Внутренний номер''' - номер сотрудника, который совершает вызов по выделенному номеру. Если не указан, то в служебном сценарии для OktellFastCall внутренний номер пользователя можно определить по его учетной записи (логину). В примере указан номер пользователя admin - '''400'''.
* '''Сценарий''' - служебный сценарий для коммутации сотрудника с внешним абонентом. В примере используется сценарий OktellFastCall; разбор сценария представлен ниже. На вход сценария передаются следующие параметры: 1 - выделенный номер, 2 - логин пользователя, 3 - внутренний номер.
* '''Сервер''' - IP адрес сервера Oktell. В примере ''192.168.0.82''.
* '''Порт''' - доступный порт web-сервера Oktell. В примере используется 4055. Настройка web-сервера Oktell рассматривается в статье [[Настройка Web-сервера Oktell]]
* '''Использовать клиент Oktell''' - для режима работы с сервером Oktell снимите галочку.

<center>[[Файл:Oktell Fast Call 10.png]]</center>

===Описание сценария OktellFastCall===

Служебный сценарий OktellFastCall выглядит следующим образом:

[[Файл:Oktell Fast Call 4.png|center]]

Компонент "'''Входные параметры'''". Сохраняет входные параметры в переменные:
* переменной '''внешний номер''' присваивается значение функции "'''Входной параметр 1'''"
* переменной '''Пользователь''' присваивается значение функции "'''Входной параметр 2'''"
* переменной '''номер пользователя''' присваивается значение функции "'''Входной параметр 3'''"

[[Файл:Oktell Fast Call 6.png|center|800px]]

Компонент "'''Номер не указан?'''". Определяет указан ли внутренний номер в приложении Oktell Fast Call, сравнивает переменную '''Номер пользователя''' с пустой строкой.
* Аргумент 1 - переменная '''номер пользователя'''
* Аргумент 2 - пустая строка
* Тип сравнения - '''='''

Компонент "'''Внутренний номер'''". Если внутренний номер не указан, то сценарий попробует определить внутренний номер по логину пользователя (переменная '''Пользователь''') с помощью компонента "''Статус объекта''".
* Действие - Определить
* Тип объекта - Пользователь
* Ключ пользователя - переменная '''Пользователь'''
* Функция - Внутренний номер
* Значение в переменную - '''номер пользователя'''
Если у пользователя нет внутреннего номера, Oktell запишет в переменную "'''номер пользователя'''" специальную строку, обозначающую идентификатор пользователя, по которой впоследствии сможет дозвониться до пользователя.

Компонент "'''Дозвон'''". Производит вызов на пользователя, а затем запускает IVR сценарий маршрутизации исходящих с передачей на вход номера внешнего абонента.
* Номер/команда - переменная "'''Номер пользователя'''"
* Среда - Внутренний номерной план
* Обслуживание - IVR
* Тип вызова - Обычный
* Сценарий IVR - выбран сценарий "'''Маршрутизация исходящих'''"
* Параметр запуска IVR - переменная "'''внешний номер'''"
* CallerId - строка ''OktellFastCall''
Вместо компонента "'''Дозвон'''" вы можете использовать компонент "'''Коммутатор'''", однако при сложном распределении линий по операторам в зависимости от внешнего номера этот вариант реализовывается сложнее. Также вы можете указать любой другой IVR сценарий для набора номера, указав в параметре запуска внешний номер.

[[Файл:Oktell Fast Call 7.png|center|1000px]]

В стандартном IVR сценарии "'''Маршрутизации исходящих'''" необходимо выполнить следующую модификацию:

1) Указать в компоненте "'''Старт'''" параметр запуска переменную '''Номер'''

2) Добавить сравнение переменной '''Номер''' с пустой строкой.

[[Файл:Oktell Fast Call 5.png|center|800px]]

'''Удачной работы!'''

Oktell AMI Adapter

2023-03-31T12:48:25Z

Oktell Support:

[[Утилиты|Наверх]]

__TOC__

== Введение ==

'''Oktell AMI Adapter''' - это служба для интеграции '''внешних программ''' и '''Oktell''' по протоколу AMI.

В настоящее время существует большое количество программ, работающих по протоколу AMI с сервером Asterisk. Протокол AMI часто используют для интеграции с бизнес-процессами и программным обеспечением CRM. Он также может применяться для разнообразных приложений, таких как программы автоматического набора номера и системы click-to-call.

Благодаря AMI, внешние программы могут осуществлять соединения посредством TCP протокола, инициировать выполнение команд, считывать результат их выполнения, а так же получать уведомления о происходящих событиях в реальном времени. Этими механизмами можно пользоваться, например, в следующих случаях:
* Необходимо узнать текущее состояние системы
* Определить количество активных абонентов, состояние очередей
* Запуск внешнего процесса, дозвона или задачи
* Отправка статистики соединений на электронную почту

'''Oktell AMI Adapter''' позволяет легко перейти с '''Asterisk''' на программный комплекс '''Oktell''' без потери функционала. По сути, продукт эмулирует работу программы '''Asterisk''', принимая сообщения интерфейса AMI и передавая их на сервер '''Oktell''' по постоянному установившемуся TCP-каналу.

Работа адаптера заключается в приеме запросов, поступающих на определенный TCP-порт и передача их на порты Web-сервера '''Oktell'''. При поступлении запроса в '''Oktell''' запускается определенный служебный сценарий, который анализирует сообщение и генерирует ответ обратно в адаптер. Для удобства разбора сообщения, '''Oktell AMI Adapter''' может преобразовывать запрос в XML-формат.

ВНИМАНИЕ: Для работы требуется предустановленный '''.NET Framework v4.5''' ([http://go.microsoft.com/fwlink/?LinkId=321331 Скачать]).

[[Файл:AmiAdapter-010.png|center]]

Скачать дистрибутив Oktell AMI Adapter вы можете по ссылке [https://download.oktell.ru/data/Oktell_AMI_Adapter.zip https://download.oktell.ru/data/Oktell_AMI_Adapter.zip]

== Подготовка Oktell==

Настройте способ соединения '''Oktell''' и '''Oktell AMI Adapter''':
* Перейдите в '''Администрирование''' - '''Общие настройки''' - '''Web-интеграция с CRM'''.
* Выберите следующие настройки
:*'''Способ соединения с сервером CRM''' - '''CRM к Oktell (WebSocket)'''
:*'''Порт WebSocket Oktell для CRM''' - выберите порт для WebSocket-соединения. В примере, '''4067'''
:*'''Авторизация''' - '''Без авторизации'''
*Нажмите "'''Сохранить'''"

[[Файл:AmiAdapter-002.png |center|600px]]

==Установка Oktell AMI Adapter==

'''Шаг 1.''' Скачайте и распакуйте архив в любое место. В примере, архив распаковывается на диск '''C:\'''

'''Шаг 2.''' '''Регистрация службы Oktell.AMI.Adapter.''' Для этого необходимо воспользоваться программой '''InstallUtil''' по адресу '''C:\Windows\Microsoft.NET\Framework\v4.0.30319''' (на ОС Windows 7).

В командной строке заходим в папку с программой и выполняем команду (в примере '''Oktell.AMI.Adapter.Svc.exe''' находится в папке '''C:\AMI_Adapter''').

C:\Windows\Microsoft.NET\Framework\v4.0.30319\InstallUtil.exe C:\AMI_Adapter\Oktell.AMI.Adapter.Svc.exe

[[Файл:AmiAdapter-001.png|center]]

'''Шаг 3.''' '''Редактирование конфигурационного файла Oktell AMI Adapter'''. Откройте файл '''Oktell.AMI.Adapter.Svc.exe.config'''.

Для работы '''Oktell AMI Adapter''':
* Введите адрес для подключения к web-серверу Oktell:
<add key="OktellWebSocketUrl" value="ws://192.168.0.82:4067" />
* Введите интерфейс и порт слушателя:
<add key="TcpListenerEndPoint" value="192.168.0.82:8888" />
* Введите название сценария обработки запросов:
<add key="OktellScriptName" value="AMI_ADAPTER_Script" />

'''Шаг 4.''' '''Запуск службы Oktell.AMI.Adapter'''.
* Откройте "'''Управление службами'''" ('''Мой компьютер''' "правой кнопкой" ->''' Управление''' -> '''Службы и приложения''' -> '''Службы''').
* Запустите службу '''Oktell.AMI.Adapter'''.

[[Файл:AmiAdapter-003.png|center|600px]]

== Настройка сценария обработки запросов ==

Все запросы, поступающие в '''Oktell AMI Adapter''', пересылаются в '''Oktell'''. При этом запускается сценарий (параметр конфигурационного файла '''OktellScriptName'''), на вход которого передается текст сообщения в XML-формате. Преобразование сообщение в XML-формат задается в конфигурационном файле в параметре '''ConvertAmiToXml'''.

'''Действия сценария при получении запроса:'''
#Разбор и анализ поступившего сообщения
#Выполнение действий и формирование ответа
#Отправка сообщения в '''Oktell AMI Adapter'''

'''Скачать пример:''' [[Media:AMI_ADAPTER_Script.zip|AMI_ADAPTER_Script.zip]]

Создайте сценарий с названием, которое прописано в конфигурационном файле. В примере, '''AMI_ADAPTER_Script'''.

[[Файл:AmiAdapter-004.png |center | 600px]]

Простейший сценарий выглядит следующим образом:

[[Файл:AmiAdapter-005.png|center]]

Сценарий разбирает запросы '''Login''', '''Logoff''' и '''Originate''', формирует и отправляет ответы. При запросе '''Originate''' коммутирует абонентов указанных в полях Exten и Channel.

Компонент '''"Старт 1"'''. В качестве параметра запуска переменная xml (строковая) содержит текст запроса в XML-виде.

Компонент '''"Анализ action"'''. Разбирает '''xml''' структуру, определяет параметр '''Action''' и записывает в соответствующую переменную '''Action'''(строковая). Переход осуществляется к следующему элементу как по основной ветке, так и по ветке "'''Ошибка'''" (тогда в переменной '''Action''' будет пустая строка).

[[Файл:AmiAdapter-006.png|center|600px]]

Компонент '''"Текст action"'''. Отладочное уведомление, выводит текст переменной '''Action'''.

Компонент '''"action?"'''. Меню, в зависимости от параметра '''Action''' формирует ответ и совершает необходимые действия.

Компонент '''"Success"'''. Формирует ответ на запрос. В переменную answer записывается строка (с переносом строки)

Response: Success
Message: Authentication accepted

Аналогично настраивается компонент "'''Goodbye'''". Формат ответа:

Response: Goodbye
Message: Thanks for all the fish.

Формат ответа на "'''Originate'''"

Response: Success
Message: Originate successfully queued

Компоненты '''"Callerid"''' и '''"Exten"''' . Разбирают структуру запроса и выделяют поля '''Callerid''' и '''Exten'''. Далее с помощью компонента "'''Коммутация 1'''" данные абоненты коммутируются.

Компонент "'''Отправка ответа'''". Отправляет ответ в '''Oktell AMI Adapter''' с помощью компонента "'''Действие/карточка в Plugin или WebCRM'''".
*"'''Модуль, действие'''" - WebCRM - SendAMIMessage.
*"'''Свойства'''" - для выходной переменной модуля message выберите переменную сценария '''answer'''.

[[Файл:AmiAdapter-008.png|center|1000px]]

'''Скачать пример сценария:''' [[Media:AMI_ADAPTER_Script.zip|AMI ADAPTER Script.zip]]

== Проверка работы ==

Для проверки работы вы можете использовать компонент Windows "'''клиент telnet'''". Подключение осуществляется в командной строке:

telnet 192.168.0.82 8888

После входа, введите запрос и нажмите два раза клавишу ввода.

Action: Login

Вам должен прийти ответ от '''Oktell AMI Adapter'''.

[[Файл:AmiAdapter-009.png|center]]

== Конфигурационный файл==

Откройте папку с '''Oktell AMI Adapter'''. Конфигурационный файл '''Oktell.AMI.Adapter.Svc.exe.config''' находится в корне папки, открывается с помощью блокнота (рекомендуется использовать notepad++).

Конфигурационный файл имеет следующие параметры:
*'''OktellWebSocketUrl''' - адрес для web-socket подключения к серверу Oktell. По умолчанию, «'''ws://192.168.0.82:4067'''».
*'''OktellWebSocketUrl_2''' - адрес для web-socket подключения к другому серверу Oktell. Используется для обеспечения отказоустойчивости системы.
*'''OktellWebSocketUrl_3''' - адрес для web-socket подключения к третьему серверу Oktell. Используется для обеспечения отказоустойчивости системы.
*'''TcpListenerEndPoint''' - интерфейс и порт слушателя tcp-подключений. По умолчанию, «'''127.0.0.1:8888'''».
*'''OktellScriptName''' - название сценария обработки запросов. По умолчанию, «'''some_script'''».
*'''EnableAdapterLog''' - логирование работы адаптера. «0» - не активно, «1» - активно. По умолчанию, «'''1'''».
*'''EnableAMIConnectionLog''' - логирование подключений. «0» - не активно, «1» - активно. По умолчанию, «'''1'''».
*'''EnableOktellConnectionLog''' - логирование соединений с сервером Oktell. «0» - не активно, «1» - активно. По умолчанию, «'''1'''».
*'''ConvertAmiToXml''' - преобразование сообщения на языке AMI протокола в XML для удобства парсинга. «0» - не активно, «1» - активно. По умолчанию, «'''1'''».

==Возможные проблемы==

'''1.''' Если не получается зарегистрировать службу Oktell.AMI.Adapter (ошибка HRESULT: 0x80131515), то откройте свойства файла
Oktell.AMI.Adapter.Svc.exe и разблокируйте содержимое. Затем нажмите ОК.

[[Файл:AmiAdapter-011.png|center]]

Oktell Antirobot

2023-03-31T12:46:50Z

Oktell Support:

[[Утилиты | Наверх]]

'''Oktell Antirobot (Call Progress Analysis), (CPA)''' — анализатор голосовых ответов мобильных операторов.

===Введение===

Если абонент недоступен, занят, или не отвечает, в трубке при звонке можно услышать такие фразы как

* "Телефон абонента выключен или находится вне зоны действия сети"
* "В настоящее время абонент не может ответить на ваш звонок. Оставьте сообщение после сигнала"
* "Абонент временно недоступен. Попробуйте позвонить позднее"

Эти фразы относительно системы '''Antirobot''' называются '''Эталонами'''.

'''Oktell Antirobot''' предназначен для того, чтобы правильно распознавать такие ответы и заранее разрывать соединение, не допуская попадания оператора на голосовую почту. Особенно это актуально для компаний, которые используют исходящие задачи.

'''Antirobot''' регистрируется между установленной в офисе системой телефонии и провайдером связи и работает за счёт реализованного метода сравнения голосовых данных с эталонными файлами операторских ответов. В момент, когда звонок call-центра попадает на автоответчик, программа разрывает соединение и направляет в call-центр ответ о занятости или недоступности абонента.

[[Файл:Антиробот-000.png | center ]]

Анализ голосовых сообщений от провайдера и сравнение их с эталонами - '''ресурсозатратная задача'''. Затраты сильно зависят от количества совершаемых звонков.

 ВНИМАНИЕ: Рекомендуется устанавливать Antirobot и Oktell на разные компьютеры.

'''Требования к серверу Antirobot''':
Следующие технические требования предназначены для нагрузки 500 одновременных коммутаций с интенсивностью обзвона до 50 коммутаций в секунду (сессий на распознаваний):
* Процессор Intel Core i7.
* Оперативная память не менее 4 Гб. Рекомендуется 8 Гб и больше.
Сервер Oktell Antirobot с большей мощностью может проксировать/обрабатывать большее количество звонков.

'''Требования к операционной системе''':
* не ниже Windows 7 SP1
* Для работы требуется Framework 4.0.


[[Media:AntirobotSetup ru.zip|Скачать '''Oktell Antirobot''']]

[[Media:Antirobot 1.4.2.0 (08.07.15).zip|Скачать '''Обновление Oktell Antirobot 1.4.2.0''']]

Ниже рассказывается об установке и настройке '''Oktell Antirobot'''.

В данной статье "'''Oktell'''" установлен на сервере с ip-адресом "192.168.0.81" , "'''Oktell Antirobot'''" установлен на сервере с ip-адресом "192.168.0.82".

 ВНИМАНИЕ: Если вы хотите разместить Oktell Antirobot на той же рабочей станции, где установлен Oktell, то вам следует поменять порты в конфигурационном файле.

=== Установка Oktell Antirobot ===

'''1.''' Установка системы на сервере '''Antirobot'''. Запустите '''AntirobotSetup_ru.msi'''. Следуйте инструкции.


<center> 1. [[Файл:Антиробот-002.PNG | 300px ]] 2. [[Файл:Антиробот-003.PNG | 300px ]] 3. [[Файл:Антиробот-004.PNG | 300px ]] </center>

<center> 4. [[Файл:Антиробот-005.PNG | 300px ]] 5. [[Файл:Антиробот-006.PNG | 300px ]] </center>


 ВНИМАНИЕ: По умолчанию, Oktell Antirobot использует порт 5060 (udp). Убедитесь, что этот порт не занимается другим процессом. Вы всегда можете сменить этот порт в конфигурационном файле.

Наберите в командной строке:

netstat -anop udp

По '''PID''' процесса в диспетчере задач найдите '''наименование процесса'''. Если порт занимается другим процессом, завершите его и перезагрузите службу '''Oktell Antirobot'''.

=== Обновление Oktell Antirobot ===

Чтобы обновить Oktell Antirobot:

'''1)''' Остановите службу '''Oktell Antirobot'''.

'''2)''' Скачайте и распакуйте файлы обновления в корень папки Oktell Antirobot с заменой.

Скачать '''Обновление Oktell Antirobot 1.4.2.0''': [[Media:Antirobot_1.4.2.0_%2808.07.15%29.zip|Antirobot 1.4.2.0 (08.07.15).zip]]

'''3)''' Запустите службу '''Oktell Antirobot'''.

=== Схемы настройки Oktell, Антиробота и провайдера ===

Существует два варианта настройки системы в зависимости от взаимодействия с поставщиком связи - с регистрацией и без регистрации на стороне провайдера.

'''Вариант 1:''' Подключение с регистрацией на провайдере (до и после)

*В настройках подключения АТС указываете в Outbound proxy адрес компьютера с Антироботом.
*В Антироботе в настройках нового шлюза в качестве SIP-домена дублируется адрес провайдера (по этому адресу Антиробот будет сопоставлять звонки, если будет использовано несколько аккаунтов). В Outbound proxy укажите адрес взятый из прежних настроек подключения вашей АТС. Если он идентичен домену, то поле можно оставить пустым.

[[Файл:Антиробот-040.png|center|800px]]

 ВНИМАНИЕ: В связке '''Oktell''' с '''Antirobot''' рекомендуется использовать тип "'''С регистрацией'''" для облегчения маршрутизации SIP-сообщений.

'''Вариант 2:''' Подключение без регистрации (до и после)

*Настройка режима без регистрации аналогична предыдущему.
*Ранее провайдер ссылался на адрес вашей АТС. Для использования Антиробота провайдер должен ссылаться на его адрес вместо АТС. Таким образом входящие звонки от провайдера будут попадать на Антиробот.
*Антиробот же в настройках шлюза должен ссылаться на адрес вашей АТС. Таким образом входящие звонки от провайдера, пришедшие на Антиробот, будут им перенаправляться на вашу АТС.

[[Файл:Антиробот-041.png|center|800px]]

 ВНИМАНИЕ: После подключения без регистрации для начала работы обязательно совершите хотя бы один исходящий звонок из АТС. До тех пор, пока вы это не сделаете, система будет отклонять все входящие звонки с кодом ответа 403.

=== Настройка системы с регистрацией ===

В качестве примера, рассмотрим подключение Oktell Antirobot с регистрацией на провайдере.

'''1.''' Зайдите в '''панель управления Antirobot''', для этого кликните на ярлык "'''AntiRobot Admin'''" на вашем рабочем столе. Или наберите в браузере "'''http://localhost:8888/'''".

Наберите пароль "'''123'''". Нажмите '''Войти'''.

[[Файл:Антиробот-010.PNG | center |300px ]]

'''2.''' Введите регистрационные данные. ('''Если у вас их нет, обратитесь к менеджерам Oktell'''). Нажмите "'''Активировать'''"

[[Файл:Антиробот-011.PNG | center | 800px ]]

'''3.''' Нажмите "'''Добавить шлюз'''". Введите следующие данные:

* '''Название''': любое, будет отображаться в списке Шлюзы. В примере, '''Сипнет'''
* '''Тип регистрации''': выберите нужный тип регистрации. В примере, '''С регистрацией'''
* '''Домен''': домен провайдера. В примере, '''sipnet.ru'''
* '''Outbound proxy''': по умолчанию, совпадает с доменом. В примере, '''sipnet.ru'''

Нажмите "'''Сохранить'''".

[[Файл:Антиробот-012.PNG | center | 800px ]]

'''4.''' Так как вы не настроили '''Oktell''', вы увидите следующую схему. На ней показано, что Antirobot не связан с Oktell (регистрация не завершена).

[[Файл:Антиробот-013.PNG | center | 800px ]]

'''5.''' Перейдите на сервер '''Oktell'''. Необходимо настроить '''Oktell''' для работы с '''Antirobot'''. Зайдите в '''Oktell''' -> раздел "'''Администрирование'''" -> модуль "'''Карта сети'''". Зайдите в '''настройки шлюза''', через линии которого работает исходящая задача. Поменяйте "'''IP адрес SIP-Proxy сервера'''" на ip-адрес сервера '''Antirobot'''.

[[Файл:Антиробот-015.PNG | center ]]

'''6.''' Нажмите '''ОК'''. Перейдите на вкладку "'''Сохранение'''". Нажмите "'''Проверить'''" -> "'''Сохранить карту'''" -> "'''Перезагрузить'''".

'''7.''' После перезагрузки в панели управления '''Antirobot''' будет показано, что регистрация успешно завершена .

[[Файл:Антиробот-014.PNG | center | 800px ]]

=== Сохранение эталонов средствами Antirobot===

'''Эталон''' - голосовое сообщение получаемое от провайдера. В процессе своей работы '''Oktell Antirobot''' записывает сообщение от провайдера и сравнивает его с эталоном. Если сходство файлов высоко, то '''Oktell Antirobot''' распознает это как соответствующий сигнал ("'''Занято'''" или "'''Недоступен'''"), отсылает сигнал серверу '''Oktell''' и разрывает связь.

Для записи голосового сообщения выполните следующие шаги:

'''1.''' Откройте конфигурационный файл "'''antirobot.json.cfg'''", который по умолчанию, располагается по пути ''C:\Program Files (x86)\oktell\Antirobot'' с помощью блокнота.

'''2.''' Установите ключ ''save_temp_files'' значение "'''1'''".

"save_temp_files": 1

[[Файл:Антиробот-042.png | center]]

'''3.''' Перезагрузите службу Oktell Antirobot.

После выполнения данных шагов в папке '''\Antirobot\temp''' будут храниться записи ответов от провайдера. Длительность записи зависит от настройки ''response_time_milliseconds'' (см. [[Oktell_Antirobot#.D0.9A.D0.BE.D0.BD.D1.84.D0.B8.D0.B3.D1.83.D1.80.D0.B0.D1.86.D0.B8.D0.BE.D0.BD.D0.BD.D1.8B.D0.B9_.D1.84.D0.B0.D0.B9.D0.BB | конфигурационный файл]]). Записи можно использовать в качестве эталонов.

Данный метод сохраняет только ограниченную часть голосового ответа от провайдера. Если голосовой трафик поступает в систему с переменными задержками, то система может не распознать ваше сообщение. В этом случае, обратитесь ко второму способу сохранения полной записи с помощью сниффера Wireshark.

=== Сохранение эталонов с помощью Wireshark===

'''1.''' Чтобы записать голосовое сообщение от провайдера воспользуйтесь программой-сниффером [https://www.wireshark.org/ Wireshark]. Запустите программу и откройте '''окно выбора интерфейса'''.

[[Файл:Антиробот-016.PNG | center | 800px ]]

'''2.''' Выберите '''необходимый сетевой интерфейс'''. Распознать сетевой интерфейс поможет столбец '''Packets'''. Если количество захваченных пакетов будет увеличиваться, значит через этот интерфейс идет сетевой трафик. Нажмите '''Options'''.

[[Файл:Антиробот-017.PNG | center | 800px ]]

'''3.''' В окне '''фильтра захвата''' (Capture Filter) наберите: '''udp'''. Далее нажмите "'''Start'''".

[[Файл:Антиробот-018.PNG | center | 600px ]]

'''4.''' Позвоните через Oktell на любой телефон. Для того, чтобы записать голосовое сообщение от провайдера, смоделируйте такую ситуацию, например, '''отключите ваш телефон и позвоните на него'''. Подождите '''пару циклов голосового сообщения'''. Нажмите "'''Стоп'''".

[[Файл:Антиробот-019.PNG | center | 800px ]]

'''5.''' Найдите запись разговора. Выберите в меню '''Telephony''' -> '''RTP''' -> '''Show All Streams'''. Выберите необходимую запись разговора. Отбирать следует только те записи у которых столбец "'''Src addr'''" совпадает с ip-адресом сервера '''Antirobot''', а "'''Dst addr'''" совпадает с ip-адресом сервера '''Oktell'''. Нажмите '''Analyze'''.

[[Файл:Антиробот-020.png | center | 800px ]]

[[Файл:Антиробот-021.png | center | 600px ]]

'''6.''' В открывшемся окне, вы можете прослушать запись разговора нажав на '''Player''' -> '''Decode''' -> '''установить галочку на потоке''' -> нажать '''Play'''. Если эта запись не содержит голосового сообщения от провайдера, вернитесь на 5 пункт.

Сохраните запись, нажав на "'''Save payload...'''". Укажите следующие параметры:

* '''Name''': имя файла. В примере, "'''raw-format'''".
* '''Save in folder''': выберите место, куда сохранить файл. В примере, '''Desktop'''.
* '''Format''': '''.raw'''
* '''Channels''': '''forward'''.

Нажмите '''ОК'''.

[[Файл:Антиробот-022.png | center | 600px ]]

[[Файл:Антиробот-023.png | center | 600px ]]

'''7.''' Сохраните ваш '''raw'''-файл в '''wav'''-формат. Воспользуйтесь программой [https://www.audacityteam.org/ Audacity]. Запустите программу нажмите "'''Импортировать'''"-> "'''Звуковой файл без заголовка Raw'''".

[[Файл:Антиробот-024.png | center | 600px ]]

Выберите следующие параметры:

* '''Кодирование''': кодек, в котором была произведена запись в wireshark (поле Payload) в пункте 5. В примере,''' A-Law'''.

* '''Каналов''': '''1 канал (моно)'''.

* '''Частота сэмплирования''': '''8000 Гц'''.

Нажмите "'''Импортировать'''".

[[Файл:Антиробот-025.png | center ]]

Выберите нужный файл. В примере, созданный ранее "'''raw-format'''".

[[Файл:Антиробот-026.png | center ]]

'''8.''' Прослушайте запись разговора. '''Выберите корректное устройство воспроизведения.''' Если воспроизведение некорректно перейдите в пункт 7.

[[Файл:Антиробот-027.png | center |800px]]

'''9.''' Экспортируйте файл в нужном формате. '''Oktell Antirobot''' принимает файлы в формате '''WAV (8000 кГц, 16 бит, Моно)'''. Нажмите '''Файл'''->'''Экспортировать'''.

[[Файл:Антиробот-028.png | center |800px]]

Выберите место, куда вы хотите '''сохранить файл'''. Напишите имя файла, выберите тип файла: '''WAV (Microsoft) signed 16 bit PCM'''. Нажмите "'''Сохранить'''". В следующем окне нажмите '''ОК'''.

<center> [[Файл:Антиробот-029.png ]] [[Файл:Антиробот-029a.png ]] </center>

'''Пример''' записанного файла: [[Файл:Ростелеком_недоступен.zip]]

===Добавление эталонов в систему===

Зайдите в панель администрирования '''Oktell'''. Перейдите на вкладку "'''Эталоны'''". Нажмите "'''Добавить эталон'''".

Выберите следующие параметры:

* "'''Название'''": в примере, "Ростелеком - недоступен".
* "'''Тип ответа'''": ответ, '''соответствующий данному голосовому сообщению'''. В примере, "'''Недоступен (вне действия сети, голосовая почта)'''"
** Тип ответа: '''Недоступен''' - код sip-ответа '''480'''.
** Тип ответа: '''Занято''' - код sip-ответа '''486'''.
* "'''Расположение файла'''"

[[Файл:Антиробот-030.png | center |800px]]

[[Файл:Антиробот-031.png | center |800px]]

Для большей вероятности распознавания добавьте несколько однотипных голосовых сообщений.

 ВНИМАНИЕ! Количество эталонов влияет на нагрузку системы. 

[[Файл:Антиробот-032.PNG | center |500px ]]

=== Мониторинг и Статистика===

В разделе '''Мониторинг''' в режиме реального времени показываются все текущие разговоры и звонки, которые анализируются.

В правой части раздела показывается статистика по звонкам. '''Статистика''' доступна за конкретный день (при наведении мышкой) и за последний месяц. Доступны следующие данные:
* '''Всего звонков''' - общее количество звонков
* '''Занято''' - количество звонков, которые были распознаны, как "'''Занято'''".
* '''Недоступны''' - количество звонков, которые были распознаны, как "'''Недоступен'''".

ВНИМАНИЕ: Неудачные ответы от провайдера в статистике не учитываются

[[Файл:Антиробот-035.PNG.png|center|1000px]]

=== Конфигурационный файл ===

Каталог с''' Oktell Antirobot''', по умолчанию, располагается по пути "'''C:\Program Files (x86)\oktell\Antirobot'''". Конфигурационный файл "'''antirobot.json.cfg'''" находится в корне папки, открывается с помощью блокнота (рекомендуется использовать '''notepad++''').

'''Параметры конфигурационного файла:'''

 Раздел "'''log'''" - настройки логирования 

"'''max_storing_days'''" - длительность хранения лог-журналов, по умолчанию, '''4'''

"'''common_enabled'''" - общее логирование системы, по умолчанию, '''1'''

"'''media_enabled'''" - логирование медиа-трафика, по умолчанию,''' 0'''

"'''web_enabled'''" - логирование web-интерфейса, по умолчанию, '''0'''

 Раздел "'''sip'''" - настройки sip-протокола. 

"'''local_port'''" - локальный sip-порт. Есть возможность добавить несколько портов, для этого скопируйте строку и укажите другой sip-порт. Также может использоваться для обеспечения работы antirobot и oktell на одном сервере. По умолчанию, '''5060'''

"'''call_session_lifetime_seconds'''" - максимальная продолжительность любого разговора в секундах, по умолчанию, '''7200'''

"'''keep_alive_interval_seconds'''" - интервал отправки сообщений keep-alive в секундах, по умолчанию, '''30'''

"'''min_udp_port'''" и "'''max_udp_port'''" - интервал udp портов для передачи звуковых rtp пакетов. Если antirobot и oktell находятся на одном сервере, то порты не должны пересекаться с портами, определенными в oktell server. , по умолчанию '''2000''' и '''12000''' соответственно

"'''busy_response_code'''" - ответ antirobot при распознанном эталоне "Занято". По умолчанию 486.

"'''unavailable_response_code'''" - ответ antirobot при распознанном эталоне "Недоступен". По умолчанию 480.

 Раздел "'''web'''" - настройки web-интерфейса 

"'''listener_port'''" - порт web-сервера. По умолчанию, '''8888'''

"'''session_expire_seconds'''" - максимальное время продолжительности сессии в секундах. По умолчанию, '''3600'''

 Раздел "'''analysis'''" - настройка анализа голосовых сообщений 

"'''disabled'''" - деактивирует режим анализа голосовых сообщение, по умолчанию, '''0'''

"'''response_time_milliseconds'''" - интервал времени для принятия решения, в миллисекундах. По умолчанию, '''5000'''

"'''frame_length_milliseconds'''" - длина временного окна, в миллисекундах. По умолчанию, '''20'''. ВНИМАНИЕ: данную настройку менять не рекомендуется.

"'''bands_count'''" - количество полос частотного спектра окна. По умолчанию, '''20'''. ВНИМАНИЕ: данную настройку менять не рекомендуется.

"'''criterion'''" - порог принятия решения (диапазон: 0 - 100). По умолчанию, '''50'''.

* При уменьшении коэффициента, вероятность срабатывания системы возрастает (увеличится количество распознанных сообщений). Также увеличивается вероятность ошибки (увеличится количество неправильно распознанных сообщений).

"'''save_temp_files'''" - сохранение временных файлов, по умолчанию, '''0'''.

* Если выставить ключу '''save_temp_files''' значение "'''1'''", то в папке '''\Antirobot\temp''' будут храниться записи ответов от провайдера. Длительность записи зависит от настройки "'''response_time_milliseconds'''". Записи можно использовать в качестве эталонов.

=== Подключение к базе данных SQLite ===

В процессе своей работы '''Oktell Antirobot''' использует СУБД '''SQLite'''. Файл базы данных '''antirobot.sqlite.db''' располагается в корневом каталоге '''Oktell Antirobot'''.

Для того, чтобы посмотреть содержимое базы данных рекомендуется использовать, например, '''SQLiteBrowser'''.

[[Файл:SQLiteBrowser.zip]]

'''Перечень таблиц:'''
* '''stats''' : статистика работы
* '''settings''': настройки
* '''gateways''': шлюзы
* '''etalons''': список эталонов
* '''rejected''': список отклоненных (распознанных) вызовов

[[Файл:Антироботч2-001.png | center]]

Прилинковать '''SQLite''' к '''MSSQL''' поможет [http://community.spiceworks.com/how_to/show/2271-create-ms-sql-linked-server-to-the-spiceworks-sqlite-server следующая инструкция].

При составлении запросов используйте функцию '''OpenQuery''', например

select * from openquery(NameOfLinkedServer, 'select * from rejected')

===Обновление лицензии===

1. Чтобы '''обновить''' лицензию, зайдите в папку '''\oktell\Antirobot''' и удалите скрытый файл '''product.lic'''. ''Чтобы отобразить все скрытые файлы нажмите Alt-сервис-параметры папок-вид-показывать скрытые файлы, папки и диски.''

ВНИМАНИЕ: Узнать свой регистрационный номер вы всегда можете, открыв файл '''product.inf''' с помощью блокнота.

[[Файл:Антиробот-033.PNG | center]]

2. Перезапустите службу '''Oktell Antirobot'''. ('''Панель управления''' - '''Администрирование''' - '''Службы''')

[[Файл:Антиробот-034.png | center]]

3. Войдите в '''панель управления Antirobot''' и введите ваши новые '''регистрационные данные''', как описано в пункте [[Oktell Antirobot#Настройка системы | Настройка системы]]

'''Успешной работы с Oktell Antirobot!'''

Скачать '''Oktell Antirobot''': [[Media:Oktell_Antirobot.zip|Oktell Antirobot.zip]]

=== Возможные проблемы ===

'''1.''' Невозможно активировать продукт, при активации пишет "Сервер активации недоступен".
*Возможно, у вас неправильный пароль. Перевыпишите у менеджеров регистрационную карту и введите новые данные.
*Перейдите на сайт http://activate.oktell.ru/ и вручную выпишите файл активации. Поместите файл в корень папки Antirobot и переименуйте его в product.lic. Затем перезагрузите службу Oktell Antirobot.

'''2.''' Входящий звонок отклоняется.
*Совершите хотя бы один исходящий звонок.

Okboard

2023-03-31T12:42:20Z

Oktell Support:

[[Утилиты| Наверх]]

__TOC__

==Введение==

Дашборды Okboard — система отображения динамических и хронологических показателей. Этот модуль в Okapp позволяет создавать графики для наблюдения за работой компании, выявлять слабые места и планировать соответствующие изменения. Такой способ отображения информации наглядно и компактно показывает всю аналитику call-центра и других бизнес-процессов компании.

Преимущества такой системы очевидны:
# Доступ с любого устройства через удобный web-интерфейс Okapp
# Широкий спектр инструментов для мониторинга и построения отчетов
# Быстрое внедрение, настройка и модификация системы KPI
# Собственные настраиваемые алгоритмы обработки данных
# Настройка прав для разных групп пользователей

[[Файл:Дашборд-040.png|center|800px]]

Данные для отображения собираются из баз данных. Так, для сall-центра используются предустановленные показатели из собственной базы, а для других подразделений — из внешних систем. Взаимодействие с внешними источниками возможно посредством интеграции между базами данных, использования Web API и служебных сценариев. Собранная информация хранится в базе данных Oktell, тем самым обеспечивается сохранность данных в случае недоступности внешних ресурсов.

Дашборды Okboard помогают принимать решения руководителям, аналитикам, маркетологам, специалистам по стратегическому развитию кампании. Также можно вывести показатели на большой экран, чтобы их мог видеть каждый сотрудник вашей компании.

----
<center>
Посмотреть '''демонстрационный дашборд''' можно по этой [https://t.oktell.ru/modules/dashboards/app/#/7be4556e-8549-4764-9273-49d67c4572d7 ссылке].
</center>
----

==Установка==

Okboard работает с SQL Server не ниже 2005 версии.

1. Для работы сначала необходимо настроить Okapp. Подробнее о настройке читайте в статье [[Okapp]]

2. В Okapp перейдите в модуль '''Магазин'''. Выберите модуль "Дашборды" и нажмите кнопку "'''Установить'''".

ВНИМАНИЕ: Доступ к модулю "'''Магазин'''" имеют только те пользователи, у которых есть соответствующие права доступа. Права доступа выставляются в клиентском приложении в модуле '''Администрирование'''/'''Пользователи'''.

ВНИМАНИЕ: Во избежание ошибок, обновите ваш Okapp до последней версии.

[[Файл:Дашборд-030.png|center|800px]]

3. Для получения пробного 30-дневного периода перейдите на вкладку "'''Цена и покупка'''" и нажмите "'''Обновить список лицензий'''". Пробная лицензия будет добавлена в список лицензий вашего сервера Oktell. Во время пробного периода в Okboard вам доступно 20 индикаторов.

ВНИМАНИЕ: В лицензии считается суммарное число индикаторов. Таким образом, если у вас 5 дашбордов по 6 индикаторов, то это 30 индикаторов, а значит в тестовой версии случайные 10 будут отключены по лицензии.

[[Файл:Дашборд-031.png|center|800px]]

Для приобретения лицензии вы можете заполнить форму на вкладке "'''Цена и покупка'''" и отправить заявку. На указанный адрес электронной почты мы отправим договор и счет. После поступления оплаты вам нужно будет "'''Обновить список лицензий'''" также как и в пункте 3.

4. После установки модуля, администраторы Oktell автоматически получают доступ для работы в Okboard. Для работы с дашбордами остальным пользователям необходимо выставить соответствующие права доступа. Перейдите в клиентское приложение Oktell в модуль Администрирование/Пользователи. Права доступа вы можете выставить как роли, так и конкретному пользователю системы. Имеются следующие права доступа:
*'''Dashboards''' - доступ к модулю "Okboard" в приложении Okapp
*'''Создание дашбордов''' - возможность создавать свои дашборды
*'''Создание и изменение SQL-запроса виджета''' - возможность создавать/изменять свои SQL-запросы для индикатора

[[Файл:Дашборд-041.png|center|600px]]

==Работа с дашбордами==

=== Cоздание дашборда ===

Отображение данных в Okboard начинается с создания дашбордов. Каждый дашборд состоит из индикаторов — графиков, построенных на настраиваемых выборках данных. Каждый сотрудник компании может, если у него есть соответствующие права, просмотреть созданные отчеты и даже настроить свои собственные.
Отчеты настраиваются таким образом, чтобы по ним было удобно оценивать тенденции и закономерности процессов, протекающих в компании. Дашборды имеют свойство автообновления, однако следует учитывать, что при большой частоте запросов вы можете сильно нагрузить базу данных системы.

[[Файл:Дашборды-001.png|center|800px]]

Для создания дашборда выполните следующие шаги:
*Перейдите в раздел '''Дашборды'''.
*Выберите интересующий проект и нажмите кнопку "'''Новый'''"
*Чтобы создать дашборд, не привязанный к определенному проекту выберите в списке "'''Общие для проектов'''". В этом случае, права на просмотр или изменение будут полностью определятся правами дашборда.
*Введите название дашборда.

[[Файл:Дашборд-001.png|center|800px]]

После создания дашборда на экране показывается лист с 4 пустыми индикаторами. Чтобы создать отчет, нажмите на любой из них.

=== Источники данных ===

Каждому индикатору требуется указать значения, которые он будет выводить на экране. В качестве значений могут быть строки (nvarchar), числа (int, float) и данные типа дата/время (datetime). Для построения графиков строки преобразовываются в числа. Исключением являются строки вида "чч:мм:сс", которые преобразовываются в секунды. Мы не рекомендуем использовать в одном наборе разные типы данных, это приведет к их неправильному отображению.

Часть виджетов - графиков требует также указания оси абсцисс, по которой они будут строиться. В таких отчетах ось, фактически, является легендой и отображается на оси абсцисс в том виде, в котором содержится в таблице. Точки ставятся на равном расстоянии друг от друга (например, числа 1, 10 и 100 будут на равном расстоянии друг от друга). Данные оси могут быть строковыми величинами.

Для каждого типа (кроме виджета "Картинка") доступно
*Указание названия графика - название графика отображается в верхней части отчета
*Период автообновления данных - укажите с какой периодичностью в секундах индикатор будет выполнять запрос в базу данных с целью получения актуальных сведений для отчета.
*Указание источника данных - выбор данных для построения отчета. Ниже рассматриваются три возможных варианта.

'''1. Конструктор''' - выбор предустановленного значения с указанием функции и фильтра.

Для настройки индикатора:
*Выберите рассчитываемое значение из списка. Для добавления параметров нажмите "'''+ Добавить еще одно значение'''"
*Выберите функцию, которую необходимо применить к данным. Вы можете выбрать - Среднее, Максимальное, Минимальное и Суммарное значения.
*Выберите ось для отображения данных. Возможен выбор оси по интервалам времени, по операторам, проектам и задачам.
*Выберите фильтр для отображаемых данных. Выбирать данные можно времени, задаче, проекту, оператору, типу звонков, дате и времени.
*Укажите дополнительные опции (отличаются для разных типов) и интервал автообновления данных.

[[Файл:Дашборд-033.png|center]]

'''2. Таблица БД''' - выбор определенных полей таблицы с указанием фильтра.

Для настройки индикатора:
*Выберите таблицу в базе данных
*Отметьте галочками столбцы для отображения
*Для каждого выбранного столбца укажите назначение (Ось, Значение). Для корректной работы индикатора не рекомендуется указывать более одной оси.
*Выберите фильтр для отображаемых данных. Выбирать данные можно времени, задаче, проекту, оператору, типу звонков, дате и времени.
*Укажите дополнительные опции (отличаются для разных типов) и интервал автообновления данных.

[[Файл:Дашборд-034.png|center]]

'''3. SQL-запрос''' - самостоятельное обращение в базу данных с целью выборки необходимых данных. В отличии от предыдущих двух вариантов, вы можете указать любую таблицу в БД Oktell или в связанных серверах, а также написать любую логику для выборки данных, пользуясь языком SQL.

Для настройки индикатора:
*Введите текст запроса в поле "'''SQL-запрос'''". Запрос использует региональные настройки сервера Oktell. Если у вас неправильно отображаются даты или запрос выдает ошибки попробуйте в начале запроса добавьте строку <code>set dateformat ymd</code>
*Нажмите кнопку "'''Выполнить запрос'''"
*Для всех переменных запроса укажите назначение (Ось, Значение). Для корректной работы дашбордов не рекомендуется указывать более одной оси.
*Выберите фильтр для отображаемых данных. Выбирать данные можно времени, задаче, проекту, оператору, типу звонков, дате и времени.
*Укажите дополнительные опции (отличаются для разных типов) и интервал автообновления данных.

[[Файл:Дашборд-035.png|center]]

=== Виды индикаторов ===

Для каждого индикатора вы можете выбрать один из следующих типов отображения:

<center>
{|cellpadding="10" cellspacing="0" border="1"
|[[Файл:Дашборд-010.png|center|60px]]
|Представление информации в виде числа. Возможно отображение мини-графика с историей предыдущих значений.

Входные данные - ячейка таблицы (строка/число, 1 значение).
select 12345
Для мини-графика необходимо предоставить 1 столбец для оси, по одному столбцу для значений (число). Число выводится для первого значения
select 1,50,20 union select 2,100,130 union select 3,150,50

[[Файл:Дашборд-021.png|center|900px]]
|-
|[[Файл:Дашборд-011.png|center|60px]]
|Представление информации в виде графика. Объединяет линией набор точек, соответствующих значениям по осям.

Доступна опция "Закрашивать область под графиком".

Входные данные - 1 столбец для оси, по одному столбцу значений (число) для каждого графика.
select 1,50,20 union select 2,100,130 union select 3,150,50

[[Файл:Дашборд-022.png|center|700px]]
|-
|[[Файл:Дашборд-012.png|center|60px]]
|Отображение данных в виде столбиковой диаграммы. Показывает один или несколько наборов данных, сравнивая их между собой.

Доступна опция "Горизонтальное отображение данных".

Входные данные - 1 столбец для оси, по одному столбцу значений (число) для каждого графика.
select 1,50,20 union select 2,100,130 union select 3,150,50

[[Файл:Дашборд-023.png|center|700px]]
|-
|[[Файл:Дашборд-013.png|center|60px]]
|Круговая диаграмма. Отображает процент, занимаемый каждым значением внутри набора данных, в виде разбитого на части круга.

Возможно отображение в виде бублика

Входные данные - 1 столбец для оси (легенды), 1 столбец значений (число) для значений.
select 'первый',50 union select 'второй',100 union select 'третий',30

[[Файл:Дашборд-024.png|center|400px]]
|-
|[[Файл:Дашборд-014.png|center|70px]]
|Отображение данных в таблице. Показывает набор данных в виде заполненных его значениями ячеек, которые образуют собой строки и столбцы. Каждому столбцу и строке соответствует параметр, который определяет конкретную ячейку для значения.

Возможно указание сортировки по полям, также показ первых n строк.

Входные данные - 1 столбец для оси (необязательно, отображается слева), по одному столбцу значений (строка/число) для каждой колонки в таблице. Информация сортируется по оси, а в случае ее отсутствия - по первому столбцу.
select 'первый',50,'Категория А' union select 'второй',100,'Категория Б' union select 'третий',30,'Категория В'

[[Файл:Дашборд-025.png|center|400px]]
|-
|[[Файл:Дашборд-015.png|center|60px]]
|Отображение данных в календаре. Частный случай таблицы, показывает данные по каждому дню.

Возможно отображение всего года.

Входные данные - 1 столбец для оси (обязательно строка в формате yyyy-mm-dd или дата), 1 столбец для значений (число).

select getdate(),10
или
select '2014-01-01', 20 union select '2014-01-02', 30

[[Файл:Дашборд-026.png|center|900px]]
|-
|[[Файл:Дашборд-016.png|center|60px]]
|Отображение информации в разрезе времени.

Доступные опции: формат времени (часы)

Входные данные - 1 столбец для оси (число, обозначающее час или строка вида чч:мм:сс ), 1 столбец для значения (число). Значения суммируются, если относятся к одному часу дня.

Пример:
select '18:20:44', 20 union select '13:23:33', 13
или
select '18', 20

[[Файл:Дашборд-029.png|center|400px]]
|-
|[[Файл:Дашборд-017.png|center|60px]]
|Вывод произвольной текстовой информации.

Доступные опции: изменение размера текста.

Входные данные - ячейка таблицы (строка/число, 1 значение).
select 'Ячейка таблицы'

[[Файл:Дашборд-027.png|center|400px]]
|-
|[[Файл:Дашборд-018.png|center|60px]]
|Вывод произвольного изображения на экран, например, логотипа компании.

Доступные опции: изменение режима отображения.

[[Файл:Дашборд-028.png|center|400px]]
|-
|}
</center>

Как было замечено выше, вы можете указать любой тип отображения для одних и тех же данных. На одном индикаторе вы можете указать несколько величин для отображения. Для указания нескольких величин, не предусмотренных в источнике "'''Конструктор'''" используйте "'''SQL-запрос'''". Вы можете указать несколько значений, изменяющихся со временем, и несколько констант в качестве порогов (или уровней).

После настройки индикатора нажмите "'''Сохранить'''".

=== Управление индикаторами ===

У созданного индикатора вы можете менять размеры, перетягивая мышью за края окна. При изменении размеров индикатора появляются дополнительные поля. Таким образом вы можете разместить достаточно много графиков на одной странице.

[[Файл:Дашборд-003.png|center|600px]]

Для управления листами дашборда в верхней части окна выведен ряд опций:
* Для добавления листа нажмите на [[Файл:Дашборд-036.png]] в верхней части листа;
* Для удаления листа нажмите на [[Файл:Дашборд-037.png]];
* Чтобы изменить название листа нажмите на [[Файл:Дашборд-038.png]];
* Чтобы изменить название дашборда щелкните на его название;
* Перейти к списку дашбордов можно щелкнув на ссылке Дашборды.

[[Файл:Дашборд-032.png|center]]

==Настройка общего доступа==

Созданный дашборд может просмотреть любой пользователь системы, у которого есть доступ к проекту, а также права на дашборд. Однако, если вы сделали дашборд в разделе "''Общие для проектов''", то он по умолчанию доступен всем пользователям, если это не запрещено правами самого дашборда.

Для того, чтобы пользователи могли редактировать созданный вами дашборд, нажмите на кнопку "'''Доступ'''". В открывшемся окне вы можете указать права для остальных сотрудников.

В списке доступны динамические группы, например "все операторы", "операторы текущего проекта" и другие, а также конкретные пользователи.

Для предоставления статистики заказчикам аутсорсинговых сall-центров предусмотрен внешний доступ без права редактирования. Для этого установите галочку в опции "Разрешить просмотр по ссылке и паролю". В окне появится ссылка для доступа, а также поле для ввода пароля. Установка пароля не является обязательной.

[[Файл:Дашборд-006.png|center|600px]]

==Советы для внедрения==

'''1.''' Не используйте больших и сложных запросов в дашбордах, особенно с маленьким периодом автообновления. Это приведет к большой нагрузке на сервер при открытии одного и тоже виджета несколькими людьми.

Рекомендуется использовать периодически запускаемый служебный сценарий, который будет рассчитывать данные и складировать их в отдельную таблицу. В свою очередь, дашборд будет обращаться к уже рассчитанным данным в эту таблицу и отображать их. Таким образом, нагрузка на сервер значительно снижается, а значит стабильность работы повышается.

'''2.''' Чтобы экстренно удалить запрос из программы Okboard, замените поле '''Query''' в таблице '''[WO_Module_dashboards]..[WO_Dashboards_Widgets]''' для данного виджета. К примеру, можно присвоить запрос ''select 1'':

<pre>
update WO_Module_dashboards..WO_Dashboards_Widgets
set Query='select 1'
where id = 'DF8D697B-2E28-47D5-B20F-06EC9AAA6991'
</pre>
* где полю id присвойте идентификатор вашего виджета

==Возможные проблемы==

'''ВНИМАНИЕ: Если у вас есть настроенные дашборды, то для решения проблем не удаляйте модуль из магазина. Все связи идентификаторов из базы данных будут удалены и вы не сможете восстановить их. Удалять и восстанавливать базу данных дашбордов можно.'''

'''1.''' Okboard выдает сообщения: "Ошибка загрузки проектов" и "Ошибка загрузки показателей".

Для решения вам нужно дать учетной записи AutelService роль sysadmin. Подробнее в статье: [[Установка_Microsoft_SQL_Server_2012#.D0.A1.D0.BE.D0.B7.D0.B4.D0.B0.D0.BD.D0.B8.D0.B5_.D0.B8.D0.BC.D0.B5.D0.BD.D0.B8_.D0.B2.D1.85.D0.BE.D0.B4.D0.B0_.D0.B2_.D0.91.D0.94_Oktell|Создание имени входа в БД Oktell]]

Далее выполните следующие запросы в SQL Server Management Studio:
USE oktell
GO
EXEC sys.sp_changedbowner 'AutelService'

USE oktell_settings
GO
EXEC sys.sp_changedbowner 'AutelService'

ALTER DATABASE [oktell] SET TRUSTWORTHY ON;
ALTER DATABASE [oktell_settings] SET TRUSTWORTHY ON;
GO

'''Успешной работы с Okboard!'''

Прикрепление записи разговора в каталог Bpium

2023-03-31T12:41:17Z

Oktell Support: /* Файлы */

[[Интеграции_с_CRM_системами | Наверх]]

__TOC__

== Описание ==
В Бипиум есть возможность в каталогах использовать поля для прикрепления файлов к записи. Файлы могут иметь различный тип, но наибольший интерес при интеграции представляют звуковые файлы, который можно прослушать непосредственно из Бипиум.

В статье рассматривается настройка интеграционной схемы с Oktell, которая реализует возможность прикреплять файлы записи разговора и прослушивать их из Бипиум.

Настройку можно условно разделить на несколько частей:
* создание каталога в Бипиум для хранения записей
* создание служебного сценария добавления ссылки на запись разговора в каталог Бипиум
* создание служебного сценария, возвращающего звуковой файл

== Пример ==
Создадим в Бипиум каталог '''Журнал звонков''' со следующей структурой:
* Дата звонка - поле типа Дата
* Номер звонящего - поле типа Текст
* Запись разговора - поле типа Файл

[[Файл:Bpium_journal.png|center]]

Ссылку на файл записи будем добавлять из служебного сценария обработки контента. Для доступа к файлу будем использовать метод серверного HTTP-интерфейса download\byscript. Для формирования полной ссылки потребуется название запускаемого сценария и передаваемый параметр, идентифицирующий запись разговора. В качестве такого параметра возьмем идентификатор последней коммутации из контента звонка. Также следует помнить, что вызов http-методов oktell требуют авторизации. Поэтому необходимо создать фиктивного пользователя с привилегией выполнения методов WebAPI.

Пример ссылки: https://user:password@myoktell.ru/download/byscript?name=getfile&startparam1=00000000-0000-0000-0000-000000000000&attachment=1

Сценарий обработки контента будет выглядеть следующим образом:
* получаем контент в компоненте '''Старт'''
* компонентами '''Парсер''' выделяем идентификатор последней коммутации и другие необходимые параметры
* готовим JSON-сoобщение на добавление новой записи в каталог '''Журнал звонков'''. Формат сообщения можно найти в описании API Бипиум по ссылке http://docs.bpium.apiary.io/#reference/record/records-collection/create-new-record
* компонентом '''Запрос в Bpium''' подключаемся к Бипиум и добавляем запись.

[[Файл:Bpium_content.png|center]]

Теперь осталось настроить сценарий, который будет выдавать файл по запросу. Необходимо в сценарии сформировать полный путь к файлу. Один из примеров формирования пути к файлу описан в статье [[Получить путь к записи разговора по завершению коммутации]].

Воспользуемся SQL-запросом указанным в статье:
<pre>
declare @aln nvarchar(10)
declare @bln nvarchar(10)
declare @idrecdir int
declare @ts nvarchar(50)
declare @path nvarchar(1000)
select top 1 @aln=case when alinenum<blinenum then alinenum else blinenum end,
@bln=case when blinenum>alinenum then blinenum else alinenum end,
@idrecdir=idrecdir,
@ts=replace(convert(nvarchar(10), TimeStart, 121),'-','_')+'__'+replace(convert(nvarchar(20), TimeStart, 114),':','_') from A_Stat_Connections_1x1
where Id=@id and isrecorded=1
set @path='C:\Program Files (x86)\Oktell\Server\RecordedFiles\'

if (@idrecdir>0)
select @path=path from A_Stat_RecordDirectories where id=@idrecdir
set @filename=@path+replace(substring(@ts, 1, 10),'_','')+'\'+substring(@ts, 13, 2)+substring(@ts, 16, 2)+'\mix_'+@aln+'_'+@bln+'__'+@ts+'.mp3'
</pre>

ВНИМАНИЕ! Предполагается, что запись разговоров ведется в формате mp3. В случае wav-файлов запрос необходимо скорректировать.

Присваиваем полученной значение служебной переменной '''(сл) Возвращаемое значение 1'''.

[[Файл:Bpium_getfile.png|center]]

Назначаем созданный сценарий '''Обработка контента''' в качестве Служебного сценария обработки контента в Oktell.

После разговора с абонентом в каталоге '''Журнал звонков''' Бипиум появится новая запись с информацией о звонящем и возможностью прослушать запись разговора.

[[Файл:Bpium_recfile.png|center]]

== Файлы ==

*[[Media:Bpium_contentsvc.oscr|Сценарий обработки контента]]
*[[Media:Bpium_getfilesvc.oscr|Сценарий получения файла записи]]

Использование REST API Bitrix24

2023-03-31T12:40:17Z

Oktell Support: /* Файлы */

[[Интеграции_с_CRM_системами | Наверх]]

==Общий порядок работы с OAuth при создании приложений для Битрикс24==
#Регистрируется своё приложение в Маркетплейсе Битрикс24
#Запрашиваются с удаленного сервера ключи
#Сервер перенаправляет браузер на зарегистрированный приложением URL
#Обрабатывается ответ
#Подписываются полученным ключом все запросы к Rest API.

==Регистрация приложения в Маркетплейс Битрикс24==
C 25 мая 2015г. для того чтобы добавлять свои приложения на портал больше не требуется становиться технологическим партнером.

Если у вас права администратора на вашем портале, зайдите в раздел Приложения — Добавить приложение. Выбрать для личного пользования (в этом случае, никто кроме вас и вашего портала не сможет использовать это приложение)

[[Файл:bitrix24_1.jpg|center|800px]]

Откроется форма добавления приложения

[[Файл:bitrix24_2.jpg|center|800px]]

В форме заполняем:
#Название приложения — произвольное.
#Приложение использует только API – обязательно
#Права доступа — указываем к каким разделам будет доступ у данного приложения
#Укажите ссылку — указываем произвольный ваш сайт (или любую произвольную страницу).

После этого нажимаем «Сохранить»

[[Файл:bitrix24_3.jpg|center|800px]]

После этого мы увидим «Список локальных приложений», в котором будет указан «Код приложения» и «Ключ приложения». Они будут необходимы в дальнейшем для авторизации и выполнении методов REST API.

[[Файл:bitrix24_4.jpg|center|800px]]

==OAuth-авторизация для desktop-приложения==
Алгоритм:
#При помощи client_id получаем параметр code, требуемый для получения авторизационного токена.
#При помощи clent_id, client_secret и code приложение получает параметры access_code и refresh_token.
#При помощи access_code приложение совершает запросы к REST-сервису до его истечения.
#Через час access_code истекает, и приложение может использовать полученный refresh_token для получения нового.
#Если refresh_token еще не истек (с момента его получения не прошел месяц), то приложение получает свежий access_code и свежий refresh_token, после чего, можно перейти к шагу 3.
#Если refresh_token уже истек, то требуется повторная авторизация с участием пользователя.

По сути, физическая авторизация пользователя требуется только на шаге 1. В итоге получаем, что если приложение используется постоянно (шаг 4 используется чаще раза в месяц), то приложение имеет возможность продлевать авторизацию не трогая пользователя сколь угодно долго.Рассмотрим данный алгоритм более подробно.

Desktop приложение должно слушать какой-либо порт на localhost (Oktell как правило слушает порт 4055).

1)Для авторизации необходимо открыть браузер и перейти на адрес вида:
https://мой_портал.bitrix24.ru/oauth/authorize/?client_id=код_приложения&response_type=code&redirect_uri=http%3A%2F%2Foktell.ru

, где
*мой_портал.bitrix24.ru — адрес портала, например oktell.bitrix24.ru
*client_id — код приложения, который был получен на после успешной регистрации приложения.
*response_type — тип ответа — код (константа)
*redirect_uri — адрес который был указан при создании приложения в Маркетплейс (необходимо указывать urlencode), например http%3A%2F%2Foktell.ru

2)Далее произойдет редирект на адрес вида:
http://redirect_uri/?code=код_получения_авторизации&domain=мой_портал.bitrix24.ru

, где
*code – код получения авторизации, необходим для выполнения дальнейших шагов.
*domain – адрес портала Битрикс24 (например oktell.bitrix24.ru)

После получения этих данных браузер больше не нужен. Данные которые были получены в результате создания приложения и полученный code необходимо внести в таблицу oktell.dbo.bitrix_oauth в соответствующие поля. Скрипт для создания таблицы приведен в конце статьи

[[Файл:bitrix24_5.jpg|center|800px]]

3)Приложение (Oktell) должно сделать http-запрос к адресу вида:
https://мой_портал.bitrix24.ru/oauth/token/?client_id=код_приложения&grant_type=authorization_code&client_secret=секретный_ключ_приложения&redirect_uri=http%3A%2F%2Flocalhost%3A70005&code=код_получения_авторизации&scope=требуемый_набор_разрешений

, где
*мой_портал.bitrix24.ru — адрес портала, например oktell.bitrix24.ru
*client_id — код приложения, который был получен на после успешной регистрации приложения.
*client_secret – секретный ключ приложения, который был получен на после успешной регистрации приложения.
*redirect_uri — адрес на который должен произойти редирект, как правило запрос выполняется в браузере на сервере где установлен Oktell и поэтому указывается ссылка вида — http%3A%2F%2Flocalhost%3A4055 (urlencode от http://localhost:4055)
*code - код получения авторизации
*scope – требуемый набор разрешений (например: scope=task,crm)

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

{"access_token":"XXXXXXXXXXXXXXXX","expires_in":3600,"scope":"crm","user_id":41,"refresh_token":"XXXXXXXXXXXXXXXXXXXXXX","domain":"oktell.bitrix24.ru","member_id":"XXXXXXXXXXXXXXXXXXXXXXXXXXX"}

, где
*access_token – ключ для отправки запросов к REST-сервису
*expires_in – период действия данного at (access_token)
*scope – объекты к которым предоставлен доступ
*user_id – id пользователя от имени которого произошла авторизация
*refresh_token - маркер обновления, для получения нового access_token
*domain – домен к которому был получен доступ
*member_id - уникальный идентификатор портала

 Все, приложение может совершать запросы к REST-сервису.
 
4)При достижении периода жизни at необходимо отправить запрос на получение нового at на следующего вида:

https:// мой_портал.bitrix24.ru /oauth/token/?client_id=xxxxx&grant_type=refresh_token&client_secret=xxxxx&redirect_uri= http%3A%2F%2Flocalhost%3A4055 &refresh_token=zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz

, где
*мой_портал.bitrix24.ru — адрес портала, например oktell.bitrix24.ru
*client_id — код приложения, который был получен на после успешной регистрации приложения.
*grant_type – константа – refresh_token
*client_secret – секретный ключ приложения, который был получен на после успешной регистрации приложения.
*redirect_uri — адрес на который должен произойти редирект, как правило запрос выполняется в браузере на сервере где установлен Oktell и поэтому указывается ссылка вида — http%3A%2F%2Flocalhost%3A4055 (urlencode от http://localhost:4055)
*refresh_token - маркер обновления, для получения нового access_token

В результате выполнения данного запроса будет возвращена json-структура вида:
{"access_token":"XXXXXXXXX","expires_in":3600,"scope":"task,crm","user_id":41,"refresh_token":"XXXXXXXXXXXXXXXX","domain":"oktell.bitrix24.ru","member_id":"XXXXXXXX"}

access_token, который хранится в БД обновляется каждый час, для того чтобы была возможность непрерывно выполнять любые запросы к Bitrix24.

Пример сценария, который отправляет запрос на получение access_token, после получения code и обновляет access_token по существующему refresh_token:

[[Файл:bitrix24_6.jpg|center|800px]]

==Пример использования REST API==
Рассмотрим пример получения списка всех лидов. Для этого нам понадобятся 2 метода:
*crm.lead.list - Возвращает список лидов по фильтру, при этом фильтры использоваться не будут это означает, что будет получаться весь список лидов (в дальнейшем имеет смысл рассмотреть применение фильтра и получать только тех, кто был изменен после последней синхронизации).
*crm.lead.get - Возвращает лид по идентификатору, с помощью данного метода мы получим контактные данные по лиду – телефон, e-mail, web-сайт.

===Сценарий «bitrix_crm_lead_list»===
 
[[Файл:bitrix24_7.jpg|center|800px]]

0)Выводим уведомление о Запуске сценария и Получаем текущую дату и время для того чтобы отобразить время выполнения сценария. Дату и время получаем из функции «Текущие дата и время». 
1)В данном сценарии как и в любом другом удобно использовать существующий, автоматически обновляемый access_token, который мы получили в предыдущей главе. Получаем данные из таблицы oktell.dbo.bitrix_oauth для выполнения REST запроса.
Текст выполняемого запроса -
select @access_token=access_token,
@domain=domain
from oktell.dbo.bitrix_oauth
where client_id='client_id'

2)Устанавливаем счетчик для получения списка лидов = 0 и счетчик последней итерации = 0 и счетчик итераций получения лидов=0

[[Файл:bitrix24_8.jpg|center|800px]]

3)Получаем первые N лидов, во второй итерации след N лидов, количество N получаем после выполнения 1-го запроса и в каждом последующем, так же после первого запроса получим сколько всего лидов.
В примере: 'https://'+[domain]+'/rest/crm.lead.list?start='+[counter_lead_start]+'&auth='+[access_token]

[[Файл:bitrix24_9.jpg|center|800px]]

4)Получаем сколько всего лидов. Используется компонент Парсер с алгоритмом «Парсер JSON». В примере: поисковый запрос - ''total''

[[Файл:bitrix24_10.jpg|center|800px]]

Важно! Все компоненты парсер в данном сценарии используют алгоритм «Парсер JSON».

5)Записываем в счетчик получения лидов начальный номер для следующей итерации. В примере: поисковый запрос - ''next''
:5.1)Если парсер JSON выполнился с ошибкой, это означает что счетчик для следующей итерации отсутствует, что свидетельствует о последней итерации, тогда дополнительно определяем счетчик последней итерации и устанавливаем для последней итерации счетчик получения лидов = сколько всего лидов (total)

[[Файл:bitrix24_11.jpg|center|800px]]

6)Устанавливаем счетчик для получения N-го лида парсером (как правило счетчик будет бегать от 0 до 49).

7)Получаем N-ый лид для дальнейшего парсинга (Парсер JSON). В примере: поисковый запрос- выражение - '"result"/'+[counter_lead_parse]

[[Файл:bitrix24_12.jpg|center|800px]]

:7.1)Далее идет серия JSON парсеров по тегам которые необходимы для сохранения (количество тегов можно менять в зависимости от условий, главное всегда получать как минимум тег “ID”, который соответствует № лида).

Важно! У компонентов парсер всегда должны быть назначены переходы по ветке «Ошибка», т.к. в случае если данных в этом поле не будет парсер отработает именно по этому переходу и если он не указан, то сценарий завершится.

8)Обновляем лид в таблице - [oktell].[dbo].[bitrix_leads] если он там есть и добавляем если нет, определение происходит по sql_ID (по № лида).
Текст выполняемого запроса -
if exists (select * from oktell.dbo.bitrix_leads where sql_ID=replace(@sql_ID,'"',''))
UPDATE [oktell].[dbo].[bitrix_leads]
SET [sql_ADDRESS] = replace(@sql_ADDRESS,'"','')
,[sql_ADDRESS_2] = replace(@sql_ADDRESS_2,'"','')
,[sql_ADDRESS_CITY] = replace(@sql_ADDRESS_CITY,'"','')
,[sql_ADDRESS_COUNTRY] = replace(@sql_ADDRESS_COUNTRY,'"','')
,[sql_ADDRESS_COUNTRY_CODE] = replace(@sql_ADDRESS_COUNTRY_CODE,'"','')
,[sql_ADDRESS_POSTAL_CODE] = replace(@sql_ADDRESS_POSTAL_CODE,'"','')
,[sql_ADDRESS_PROVINCE] = replace(@sql_ADDRESS_PROVINCE,'"','')
,[sql_ADDRESS_REGION] = replace(@sql_ADDRESS_REGION,'"','')
,[sql_ASSIGNED_BY_ID] = replace(@sql_ASSIGNED_BY_ID,'"','')
,[sql_BIRTHDATE] = cast(replace(@sql_BIRTHDATE,'"','') as datetime2(0))
,[sql_COMMENTS] = replace(@sql_COMMENTS,'"','')
,[sql_COMPANY_ID] = replace(@sql_COMPANY_ID,'"','')
,[sql_COMPANY_TITLE] = replace(@sql_COMPANY_TITLE,'"','')
,[sql_CONTACT_ID] = replace(@sql_CONTACT_ID,'"','')
,[sql_CREATED_BY_ID] = replace(@sql_CREATED_BY_ID,'"','')
,[sql_CURRENCY_ID] = replace(@sql_CURRENCY_ID,'"','')
,[sql_DATE_CLOSED] = cast(replace(@sql_DATE_CLOSED,'"','') as datetime2(0))
,[sql_DATE_CREATE] = cast(replace(@sql_DATE_CREATE,'"','') as datetime2(0))
,[sql_DATE_MODIFY] = cast(replace(@sql_DATE_MODIFY,'"','') as datetime2(0))
,[sql_LAST_NAME] = replace(@sql_LAST_NAME,'"','')
,[sql_MODIFY_BY_ID] = replace(@sql_MODIFY_BY_ID,'"','')
,[sql_NAME] = replace(@sql_NAME,'"','')
,[sql_OPENED] = replace(@sql_OPENED,'"','')
,[sql_OPPORTUNITY] = replace(@sql_OPPORTUNITY,'"','')
,[sql_ORIGIN_ID] = replace(@sql_ORIGIN_ID,'"','')
,[sql_ORIGINATOR_ID] = replace(@sql_ORIGINATOR_ID,'"','')
,[sql_POST] = replace(@sql_POST,'"','')
,[sql_SECOND_NAME] = replace(@sql_SECOND_NAME,'"','')
,[sql_SOURCE_DESCRIPTION] = replace(@sql_SOURCE_DESCRIPTION,'"','')
,[sql_SOURCE_ID] = replace(@sql_SOURCE_ID,'"','')
,[sql_STATUS_DESCRIPTION] = replace(@sql_STATUS_DESCRIPTION,'"','')
,[sql_STATUS_ID] = replace(@sql_STATUS_ID,'"','')
,[sql_TITLE] = replace(replace(@sql_TITLE,'"',''),'\','')
WHERE sql_ID=replace(@sql_ID,'"','')
else
INSERT INTO [oktell].[dbo].[bitrix_leads]
([sql_ADDRESS]
,[sql_ADDRESS_2]
,[sql_ADDRESS_CITY]
,[sql_ADDRESS_COUNTRY]
,[sql_ADDRESS_COUNTRY_CODE]
,[sql_ADDRESS_POSTAL_CODE]
,[sql_ADDRESS_PROVINCE]
,[sql_ADDRESS_REGION]
,[sql_ASSIGNED_BY_ID]
,[sql_BIRTHDATE]
,[sql_COMMENTS]
,[sql_COMPANY_ID]
,[sql_COMPANY_TITLE]
,[sql_CONTACT_ID]
,[sql_CREATED_BY_ID]
,[sql_CURRENCY_ID]
,[sql_DATE_CLOSED]
,[sql_DATE_CREATE]
,[sql_DATE_MODIFY]
,[sql_ID]
,[sql_LAST_NAME]
,[sql_MODIFY_BY_ID]
,[sql_NAME]
,[sql_OPENED]
,[sql_OPPORTUNITY]
,[sql_ORIGIN_ID]
,[sql_ORIGINATOR_ID]
,[sql_POST]
,[sql_SECOND_NAME]
,[sql_SOURCE_DESCRIPTION]
,[sql_SOURCE_ID]
,[sql_STATUS_DESCRIPTION]
,[sql_STATUS_ID]
,[sql_TITLE])
VALUES
(replace(@sql_ADDRESS,'"','')
,replace(@sql_ADDRESS_2,'"','')
,replace(@sql_ADDRESS_CITY,'"','')
,replace(@sql_ADDRESS_COUNTRY,'"','')
,replace(@sql_ADDRESS_COUNTRY_CODE,'"','')
,replace(@sql_ADDRESS_POSTAL_CODE,'"','')
,replace(@sql_ADDRESS_PROVINCE,'"','')
,replace(@sql_ADDRESS_REGION,'"','')
,replace(@sql_ASSIGNED_BY_ID,'"','')
,cast(replace(@sql_BIRTHDATE,'"','') as datetime2(0))
,replace(@sql_COMMENTS,'"','')
,replace(@sql_COMPANY_ID,'"','')
,replace(@sql_COMPANY_TITLE,'"','')
,replace(@sql_CONTACT_ID,'"','')
,replace(@sql_CREATED_BY_ID,'"','')
,replace(@sql_CURRENCY_ID,'"','')
,cast(replace(@sql_DATE_CLOSED,'"','') as datetime2(0))
,cast(replace(@sql_DATE_CREATE,'"','') as datetime2(0))
,cast(replace(@sql_DATE_MODIFY,'"','') as datetime2(0))
,replace(@sql_ID,'"','')
,replace(@sql_LAST_NAME,'"','')
,replace(@sql_MODIFY_BY_ID,'"','')
,replace(@sql_NAME,'"','')
,replace(@sql_OPENED,'"','')
,replace(@sql_OPPORTUNITY,'"','')
,replace(@sql_ORIGIN_ID,'"','')
,replace(@sql_ORIGINATOR_ID,'"','')
,replace(@sql_POST,'"','')
,replace(@sql_SECOND_NAME,'"','')
,replace(@sql_SOURCE_DESCRIPTION,'"','')
,replace(@sql_SOURCE_ID,'"','')
,replace(@sql_STATUS_DESCRIPTION,'"','')
,replace(@sql_STATUS_ID,'"','')
,replace(replace(@sql_TITLE,'"',''),'\',''))

:8.1)Если sql запрос по добавлению\обновлению лида выполнился с ошибкой, то Записываем информацию об ошибке в таблицу [oktell].[dbo].[bitrix_import_lead_error]
Текст выполняемого запроса -
insert into oktell.dbo.bitrix_import_lead_error
([sql_ID]
,[sql_error]
,[sql_full_lead_info]
,[sql_date_error])
values
(@sql_id,
@sql_error,
@sql_dull_lead_info,
getdate())

9) Увеличиваем счетчик для получения N-го лида на 1 (+1)

[[Файл:bitrix24_13.jpg|center|800px]]

10) После этого происходит проверка Счетчик получения N-го лида меньше чем Счетчик количества полученных лидов в веб-запросе? Текст выражения - [Счетчик итераций получения списка лидов]*50+num([counter_lead_parse])
В выражении используем коэффициент в виде счетчика итераций получения списка лидов, для того чтобы корректно проходить по всем лидам которые получили в результате web-запроса. Например при первой итерации пройдем по 0*50+[0..49] лидам, при второй по 1*50+[0..49], т.е. с 50 по 99 лид и т.д.

[[Файл:bitrix24_14.jpg|center|800px]]

:10.1)Если да, то переходим на шаг 7)
:10.2)Если нет, то переходим на шаг 11)

11) Увеличиваем Счетчик итерации получения списка лидов +1

[[Файл:bitrix24_15.jpg|center|800px]]

12)Проверяем Счетчик последней итерации=1?

[[Файл:bitrix24_16.jpg|center|800px]]

:12.1)Если да, то переходим на шаг 13)
:12.2)Если нет, то переходим на шаг 3)

13)Отображаем уведомление о Завершении сценария со временем выполнения.
Текст уведомления — выражение -
'Сценарий импорта лидов завершен!
Последний стартовый ID: '+[counter_lead_start]+endline+
'Всего лидов: '+[counter_total]+endline+
'Время выполнения: ' + DateDiff( s,[Дата запуска сценария], NOW )+' секунд'

14) Обновляем данные по завершению сценария в таблице oktell.dbo.bitrix_lead_runtime
Текст выполняемого запроса -
if exists (select lead_list_dt from oktell.dbo.bitrix_lead_runtime where id=1)
update oktell.dbo.bitrix_lead_runtime
set lead_list_dt=getdate()
where id=1
else
insert into oktell.dbo.bitrix_lead_runtime
(lead_list_dt)
values
(getdate())

15) Производим Запуск сценария bitrix_crm_lead_get_by_id, в котором мы обновим контакты лидов, при первом запуске будут получены все контакты, при дальнейших запусках только контакты у лидов которые были обновлены после выполнения данного сценария.

[[Файл:bitrix24_17.jpg|center|800px]]

===Сценарий «bitrix_crm_lead_get_by_id»===
В данном сценарии будет последовательно обрабатываться каждый № лида, т.к. это могло бы занять достаточно много времени, проверять будем только те лиды, которые были изменены после предыдущего запуска данного сценария (если он запускается в первый раз, то получим данные по всем лидам). Дату запуска получаем из таблицы [oktell]. [dbo].[bitrix_lead_runtime]

[[Файл:bitrix24_18.jpg|center|800px]]

0) Выводим уведомление о Запуске сценария и Получаем текущую дату и время для того чтобы отобразить время выполнения сценария. Дату и время получаем из функции «Текущие дата и время».

1) Получаем данные из таблицы oktell.dbo.bitrix_oauth для выполнения REST запроса
Текст запроса -
select @access_token=access_token,
@domain=domain
from oktell.dbo.bitrix_oauth
where client_id='client_id'

, где
*client_id - id приложения, который был получен ранее, в данном запросе указывается в виде строки.

2) Присваиваем счетчику для перебора лидов отрицательное значение, это необходимо для получение первого лида.

[[Файл:bitrix24_19.jpg|center|800px]]

3) SQL-запрос. Получение N-го лида. Получаем № лида (ID)

[[Файл:bitrix24_20.jpg|center|800px]]

Текст запроса -
declare @dt datetime
if exists(select coalesce(lead_get_by_id_dt,'') from oktell.dbo.bitrix_lead_runtime where id=1)
select @dt=coalesce(lead_get_by_id_dt,'') from oktell.dbo.bitrix_lead_runtime where id=1
else select @dt=''
select top 1 @sql_ID=sql_ID
from [oktell].[dbo].[bitrix_leads]
where sql_ID>@counter_id
and sql_date_modify>=@dt
set @res=@@rowcount

4)sql_result>0? – в результате выполнения запроса нашелся хотя бы один лид?

[[Файл:bitrix24_21.jpg|center|800px]]

:4.1)Если да, то идем на шаг 5)
:4.2)Если нет, то Обновляем данные о времени выполнения в таблице [oktell].[dbo].[bitrix_lead_runtime] и выводим уведомление с временем завершения сценария.

Текст запроса -
if exists (select * from oktell.dbo.bitrix_lead_runtime where id=1)
update oktell.dbo.bitrix_lead_runtime
set lead_get_by_id_dt=getdate()
where id=1
else
insert into oktell.dbo.bitrix_lead_runtime
(lead_get_by_id_dt)
values
(getdate())

5)Выполняем web-запрос и получаем информацию по N-му лиду передавая его ID

[[Файл:bitrix24_22.jpg|center|800px]]

Текст запроса — выражение вида - 'https://'+[domain]+'/rest/crm.lead.get?id='+[sql_ID]+'&auth='+[access_token]

6)Получаем «Выбранное решение» лидом (опционально, можно убрать данный компонент)

Текст запроса — выражение вида - '"result"/"UF_CRM_1387525788"/'+str([i])

[[Файл:bitrix24_23.jpg|center|800px]]

7)Добавляем выбранное клиентом решение в таблицу - oktell.dbo.bitrix_lead_solution (опционально, можно убрать данный компонент)
Текст запроса -
if exists (select * from oktell.dbo.bitrix_lead_solution where sql_LEAD_ID=replace(@sql_ID,'"',''))
update oktell.dbo.bitrix_lead_solution
set sql_solution=replace(@solution,'"','')
where sql_LEAD_ID=replace(@sql_ID,'"','')
else
insert into oktell.dbo.bitrix_lead_solution
(sql_LEAD_ID, sql_solution)
values
(replace(@sql_ID,'"',''), replace(@solution,'"',''))

8)Устанавливаем Счетчик i =0, он необходим для того, чтобы из JSON структуры мы могли получить произвольное количество e-mail на следующей цепочке шагов.

9)Подсчитываем количество e-mail у лида. Компонент Парсер.
Текст запроса — выражение вида - "result"/"EMAIL"

[[Файл:bitrix24_24.jpg|center|800px]]

10)Получаем i-ый e-mail и выполняем серию компонентов Парсер JSON, для получения каждого из них.
Получаем структуру вида:
{"ID"="1111", "TYPE_ID"="EMAIL", "VALUE"="name@domen.ru", "VALUE_TYPE"="WORK"}

11)Каждый из них добавляем в таблицу oktell.dbo.bitrix_lead_contacts
Текст запроса -
if exists (select * from oktell.dbo.bitrix_lead_contacts where sql_LEAD_ID=replace(@sql_ID,'"','') and sql_CONTACT_ID=replace(@sql_CONTACT_ID,'"',''))
begin /*begin if 1*/
if (coalesce(replace(@sql_CONTACT_ID,'"',''),'')+coalesce(replace(@sql_VALUE_TYPE,'"',''),'')+coalesce(replace(@sql_VALUE,'"',''),'')+coalesce(replace(@sql_TYPE_ID,'"',''),''))<>''
update oktell.dbo.bitrix_lead_contacts
set [sql_VALUE_TYPE]=replace(@sql_VALUE_TYPE,'"','')
,[sql_VALUE]=replace(@sql_VALUE,'"','')
,[sql_TYPE_ID]=replace(@sql_TYPE_ID,'"','')
where sql_LEAD_ID=replace(@sql_ID,'"','')
and sql_CONTACT_ID=replace(@sql_CONTACT_ID,'"','')
end /*end if 1 */
else
begin /*begin if 2*/
if (coalesce(replace(@sql_CONTACT_ID,'"',''),'')+coalesce(replace(@sql_VALUE_TYPE,'"',''),'')+coalesce(replace(@sql_VALUE,'"',''),'')+coalesce(replace(@sql_TYPE_ID,'"',''),''))<>''
insert into oktell.dbo.bitrix_lead_contacts
([sql_LEAD_ID]
,[sql_CONTACT_ID]
,[sql_VALUE_TYPE]
,[sql_VALUE]
,[sql_TYPE_ID])
values
(replace(@sql_ID,'"','')
,replace(@sql_CONTACT_ID,'"','')
,replace(@sql_VALUE_TYPE,'"','')
,replace(@sql_VALUE,'"','')
,replace(@sql_TYPE_ID,'"',''))
end /*end if 2 */

12)Увеличиваем счетчик i=i+1

13)Проверяем i<cnt_EMAIL? Т.е. еще остались e-mail которые необходимо добавить в БД?
:13.1)Если да, то идем на шаг 10)
:13.2)Если нет, то идем на шаг 14)

14)Устанавливаем Счетчик i=0 (для получения телефонов) и повторяем точно такой же цикл как и для e-mail, т.к. JSON структура ответа у них совпадает.

15)Подсчитываем количество телефонов у лида
Текст запроса — выражение вида - "result"/"PHONE"

16)Получаем i-ый телефон и выполняем серию компонентов Парсер JSON, для получения каждого из них.
Получаем структуру вида:
{"ID"="1111", "TYPE_ID"="PHONE", "VALUE"="+7 (123) 345-67-89 (доб. 123)", "VALUE_TYPE"="WORK", "POST"="Начальник отдела IT"}

17)Каждый из них добавляем в таблицу oktell.dbo.bitrix_lead_contacts
Текст запроса -
if exists (select * from oktell.dbo.bitrix_lead_contacts where sql_LEAD_ID=replace(@sql_ID,'"','') and sql_CONTACT_ID=replace(@sql_CONTACT_ID,'"',''))
begin /*begin if 1*/
if (coalesce(replace(@sql_CONTACT_ID,'"',''),'')+coalesce(replace(@sql_VALUE_TYPE,'"',''),'')+coalesce(replace(@sql_VALUE,'"',''),'')+coalesce(replace(@sql_TYPE_ID,'"',''),''))<>''
update oktell.dbo.bitrix_lead_contacts
set [sql_VALUE_TYPE]=replace(@sql_VALUE_TYPE,'"','')
,[sql_VALUE]=replace(@sql_VALUE,'"','')
,[sql_TYPE_ID]=replace(@sql_TYPE_ID,'"','')
where sql_LEAD_ID=replace(@sql_ID ,'"','')
and sql_CONTACT_ID=replace(@sql_CONTACT_ID,'"','')
end /*end if 1*/
else
begin /*begin if 2*/
if (coalesce(@sql_CONTACT_ID,'')+coalesce(@sql_VALUE_TYPE,'')+coalesce(@sql_VALUE,'')+coalesce(@sql_TYPE_ID,''))<>''
insert into oktell.dbo.bitrix_lead_contacts
([sql_LEAD_ID]
,[sql_CONTACT_ID]
,[sql_VALUE_TYPE]
,[sql_VALUE]
,[sql_TYPE_ID])
values
(replace(@sql_ID,'"','')
,replace(@sql_CONTACT_ID,'"','')
,replace(@sql_VALUE_TYPE,'"','')
,replace(@sql_VALUE,'"','')
,replace(@sql_TYPE_ID,'"',''))
end /*end if 2*/

18)Увеличиваем счетчик i=i+1

19)Проверяем i<cnt_PHONE? Т.е. еще остались телефоны которые необходимо добавить в БД?
:19.1)Если да, то идем на шаг 16)
:19.2)Если нет, то идем на шаг 20)

20)Присваиваем счетчик перебора лидов = текущему ID лида, для поиска построчно и переходим на шаг 3) и так до тех пор пока не отработает условие 4.2)

[[Файл:bitrix24_25.jpg|center|800px]]

===Создание служебных задач===
После того, как все сценарии были настроены можно создать служебные задачи для автоматизации процесса получения новых refresh_token, access_token, и информации из Bitrix24.
Исходя из описания REST API следует что access_token необходимо получать каждые 3600с, в то время как refresh_token активен в течении 1 месяца. В данном примере была создана служебная задача с периодом запуска — раз в 50 минут. Что позволяет всегда хранить действующий access_token, следует учитывать что после выполнения запроса refresh_token так же обновляется.

Таким образом были созданы 2 служебные задачи:

[[Файл:bitrix24_26.jpg|center|800px]]

==Заключение==
В результате мы можем совершать запросы используя REST API и получать и записывать практически любую информацию из облачной версии Bitrix24. В данной статье был рассмотрен пример получения всех лидов и сохранения информации в БД.

Эти данные мы можем использовать:

1)Для определения номера при входящем звонке и отображении web-формы в Call-центре сразу со страницей лида.

2)Для отображение названии компании в различных отчетах, например пропущенные вызовы, что упростит поиск и скорость принятия решения на отработку вызова.

3)Для использования данной базы в различных исходящих обзвонах, отправки почты на e-mail.

Приведены только несколько примеров. Применение может быть различным.

==Файлы==

#[[Media:Bitrix_crm_lead_get_by_id.oscr|Служебный сценарий "Bitrix_crm_lead_get_by_id"]]
#[[Media:Bitrix_crm_lead_list.oscr|Служебный сценарий "Bitrix_crm_lead_list"]]
#[[Media:Bitrix_refresh_get_new_access_token.oscr|Служебный сценарий "Bitrix_refresh_get_new_access_token"]]
#[[Media:Sql_create_table_Bitrix.zip|Архив со скриптами для создания таблиц в БД Oktell]]

==Исходный код==
Скрипт создания таблиц в БД OKTELL

/*[bitrix_oauth] – Таблица с данными по Bitrix OAuth*/

USE [oktell]
GO
/****** Object: Table [dbo].[bitrix_oauth] Script Date: 05/24/2015 00:50:09 ******/
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
CREATE TABLE [dbo].[bitrix_oauth](
[Id] [int] IDENTITY(1,1) NOT NULL,
[access_token] [nvarchar](2000) NULL,
[expires_in] [nvarchar](2000) NULL,
[scope] [nvarchar](2000) NULL,
[user_id] [nvarchar](2000) NULL,
[refresh_token] [nvarchar](2000) NULL,
[domain] [nvarchar](2000) NULL,
[member_id] [nvarchar](2000) NULL,
[redirect_uri] [nvarchar](2000) NULL,
[client_id] [nvarchar](2000) NULL,
[client_secret] [nvarchar](2000) NULL,
[dateexec] [datetime] NULL,
[code] [nvarchar](2000) NULL,
PRIMARY KEY CLUSTERED
(
[Id] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]
GO

/*-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------*/

/*[bitrix_leads] – Таблица которая содержит всю информацию по лидам*/

USE [oktell]
GO
/****** Object: Table [dbo].[bitrix_leads] Script Date: 05/24/2015 00:49:34 ******/
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
CREATE TABLE [dbo].[bitrix_leads](
[Id] [int] IDENTITY(1,1) NOT NULL,
[sql_ADDRESS] [nvarchar](3000) NULL,
[sql_ADDRESS_2] [nvarchar](3000) NULL,
[sql_ADDRESS_CITY] [nvarchar](3000) NULL,
[sql_ADDRESS_COUNTRY] [nvarchar](3000) NULL,
[sql_ADDRESS_COUNTRY_CODE] [nvarchar](3000) NULL,
[sql_ADDRESS_POSTAL_CODE] [nvarchar](3000) NULL,
[sql_ADDRESS_PROVINCE] [nvarchar](3000) NULL,
[sql_ADDRESS_REGION] [nvarchar](3000) NULL,
[sql_ASSIGNED_BY_ID] [nvarchar](3000) NULL,
[sql_BIRTHDATE] [datetime] NULL,
[sql_COMMENTS] [ntext] NULL,
[sql_COMPANY_ID] [nvarchar](3000) NULL,
[sql_COMPANY_TITLE] [nvarchar](4000) NULL,
[sql_CONTACT_ID] [nvarchar](3000) NULL,
[sql_CREATED_BY_ID] [nvarchar](3000) NULL,
[sql_CURRENCY_ID] [nvarchar](3000) NULL,
[sql_DATE_CLOSED] [datetime] NULL,
[sql_DATE_CREATE] [datetime] NULL,
[sql_DATE_MODIFY] [datetime] NULL,
[sql_ID] [int] NOT NULL,
[sql_LAST_NAME] [nvarchar](3000) NULL,
[sql_MODIFY_BY_ID] [nvarchar](3000) NULL,
[sql_NAME] [nvarchar](3000) NULL,
[sql_OPENED] [nvarchar](3000) NULL,
[sql_OPPORTUNITY] [nvarchar](3000) NULL,
[sql_ORIGIN_ID] [nvarchar](3000) NULL,
[sql_ORIGINATOR_ID] [nvarchar](3000) NULL,
[sql_POST] [nvarchar](3000) NULL,
[sql_SECOND_NAME] [nvarchar](3000) NULL,
[sql_SOURCE_DESCRIPTION] [nvarchar](3000) NULL,
[sql_SOURCE_ID] [nvarchar](3000) NULL,
[sql_STATUS_DESCRIPTION] [nvarchar](3000) NULL,
[sql_STATUS_ID] [nvarchar](3000) NULL,
[sql_TITLE] [nvarchar](4000) NULL,
CONSTRAINT [PK__bitrix_l__3214EC075C4299A5] PRIMARY KEY CLUSTERED
(
[Id] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY] TEXTIMAGE_ON [PRIMARY]
GO

/*---------------------------------------------------------------------------------------------------------------------------------------------*/

/* [bitrix_lead_contacts] – Список контактов лидов*/

USE [oktell]
GO
/****** Object: Table [dbo].[bitrix_lead_contacts] Script Date: 05/24/2015 00:47:54 ******/
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
CREATE TABLE [dbo].[bitrix_lead_contacts](
[Id] [int] IDENTITY(1,1) NOT NULL,
[sql_LEAD_ID] [int] NULL,
[sql_CONTACT_ID] [nvarchar](2000) NULL,
[sql_VALUE_TYPE] [nvarchar](2000) NULL,
[sql_VALUE] [nvarchar](2000) NULL,
[sql_TYPE_ID] [nvarchar](2000) NULL,
CONSTRAINT [PK__bitrix_l__3214EC07699C94C3] PRIMARY KEY CLUSTERED
(
[Id] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]
GO

/*---------------------------------------------------------------------------------------------------------------------------------------*/

/*[bitrix_import_lead_error] – таблица ошибок при выполнении sql запроса на добавление\обновление лида*/

USE [oktell]
GO
Object Table [dbo].[bitrix_import_lead_error] Script Date 05242015 004716
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
CREATE TABLE [dbo].[bitrix_import_lead_error](
[Id] [int] IDENTITY(1,1) NOT NULL,
[sql_ID] [nvarchar](2000) NULL,
[sql_error] [nvarchar](2000) NULL,
[sql_full_lead_info] [ntext] NULL,
[sql_date_error] [datetime] NULL,
PRIMARY KEY CLUSTERED
(
[Id] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY] TEXTIMAGE_ON [PRIMARY]
GO

/*----------------------------------------------------------------------------------------------------------------------------------------------*/

/*[bitrix_lead_runtime] – Таблица с данными по дате запуска сценариев импорта лидов и импорта контактов лидов*/

USE [oktell]
GO
/****** Object: Table [dbo].[bitrix_lead_runtime] Script Date: 05/24/2015 00:48:20 ******/
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
CREATE TABLE [dbo].[bitrix_lead_runtime](
[Id] [int] IDENTITY(1,1) NOT NULL,
[lead_get_by_id_dt] [datetime] NULL,
[lead_list_dt] [datetime] NULL,
PRIMARY KEY CLUSTERED
(
[Id] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]
GO

/*-------------------------------------------------------------------------------------------------------------------------------------------------------------*/

/*[bitrix_lead_solution] – Таблица содержащая решение клиентов по проектам (распологается в самом низу карточки лида)*/

USE [oktell]
GO
/****** Object: Table [dbo].[bitrix_lead_solution] Script Date: 05/24/2015 00:49:04 ******/
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
CREATE TABLE [dbo].[bitrix_lead_solution](
[Id] [int] IDENTITY(1,1) NOT NULL,
[sql_LEAD_ID] [int] NULL,
[sql_solution] [nvarchar](2000) NULL,
CONSTRAINT [PK__bitrix_l__3214EC0765CC03DF] PRIMARY KEY CLUSTERED
(
[Id] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]
GO

Oktell и ReCRM

2023-03-31T12:38:29Z

Oktell Support:

[[Интеграции с CRM системами|Наверх]]

__TOC__

'''ReCRM''' (Real Estate CRM)— интернет-сервис для специалистов по недвижимости России и СНГ. Для увеличения продаж сервис предоставляет:
*авто-выгрузку на популярные порталы
*готовый веб-сайта агентства, оптимизированный для поисковых систем
*SMS-уведомления
*рассылку ваших презентаций клиентам
*встроенный менеджер задач для всей вашей команды
*поддержку всех мобильных устройств

'''Сайт компании:''' http://www.recrm.ru/

ВНИМАНИЕ: Интеграция возможна, начиная с версии Oktell не ниже 2.11.

==Подготовка к интеграции==

===Настройка Web-сервера Oktell===

Чтобы ReCRM связалась с Oktell, необходимо настроить web-сервер.

Для настройки web-сервера воспользуйтесь статьей: [[Настройка Web-сервера Oktell]].

===Подключение оператора с привязкой к телефону===

Чтобы сотрудник мог совершать и принимать звонки в карте сети необходимо закрепить телефон за сотрудником.

Зайдите в '''Администрирование''' -> '''Карта сети''' -> '''Настройки телефона'''. Выберите сотрудника в поле '''Пользователь WebCRM'''.

[[Файл:Amocrm-011.png | center]]

ВНИМАНИЕ: Интеграция не позволяет использовать гарнитуру в работе. Вы можете использовать софтфоны в качестве IP-телефона. Настройка идентична вышеописанной.

== Настройка ReCRM ==

Откройте '''Настройки''' и перейдите на вкладку '''IP-телефония'''. В окне напротив своего пользователя установите галочку "Включить IP телефонию" и заполните следующие поля:
*Имя пользователя Oktell
*Пароль пользователя Oktell
*Хост (IP адрес) сервера АТС. Если вы работаете в одной сети с сервером, то используйте локальный IP-адрес. В противном случае, введите внешний IP-адрес.
После ввода данных нажмите кнопку «'''Сохранить'''».

ВНИМАНИЕ: Если вы используете SSL-сертификат для web-сервера Oktell,то вводить IP-адрес нужно с '''wss://'''. Например, '''wss://12.34.56.78:4055'''

ВНИМАНИЕ: При использовании Google Chrome 36+ версии, вам необходимо установить SSL сертификат на сервере Oktell или разрешить нешифрованные соединения. Связано это с тем, что ReCRM работает на https и Google Chrome не разрешает использовать нешифрованные соединения при таком подключении. Обратитесь к статье: [[Нужен SSL-сертификат для интеграции с https-системами в Google Chrome]]

[[Файл:ReCRM-001.png|center|800px]]

ВНИМАНИЕ: Для каждого пользователя на вкладке "'''Доступ'''" необходимо разрешить "'''Возможность исполнять методы Web-API'''". 
* Перейдите в '''Администрирование''' - '''Пользователи'''.
* Выберите конкретного пользователя и перейдите на вкладку '''Доступ'''.
* Поставьте галочку напротив "'''Возможность исполнять методы Web-API'''".
* Нажмите '''Сохранить'''.
* Затем нажмите '''Применить'''.

[[Файл:Amocrm-003.png |600px| center]]

== Прием звонка ==

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

'''Шаг 1.''' Импортируйте сценарий для работы с ReCRM.

Для этого перейдите в Администрирование/Сценарии. В контекстном меню выберите "Импортировать сценарий" и откройте сценарий "'''Маршрутизация ReCRM'''".

'''Скачать сценарий:''' [[Media:%D0%9C%D0%B0%D1%80%D1%88%D1%80%D1%83%D1%82%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B4%D0%BB%D1%8F_ReCRM.oscr|Маршрутизация ReCRM.oscr]]

[[Файл:ReCRM-002.png|center|900px]]

'''Шаг 2.''' Настройте параметры подключения к ReCRM.

Откройте импортированный сценарий "Маршрутизация ReCRM". Введите в компонент "'''API KEY'''" ваш код.

ВНИМАНИЕ: Чтобы узнать ваш ключ обратитесь в техническую поддержку компании ReCRM.

[[Файл:ReCRM-003.png|center|900px]]

'''Шаг 3.''' Модифицируйте главный сценарий входящей маршрутизации.

Добавьте сессионную переменную в главный сценарий:
* agent_phone (строковая) - номер ответственного менеджера

Возможен вывод другой информации по абоненту (ID контакта, название компании, ID компании, ответственный менеджер)
Добавьте следующие элементы:
:1. Компонент "'''ReCRM'''". Запускает сценарий "Маршрутизация ReCRM". В сценарии в созданную сессионную переменную '''agent_phone''' будет присвоен номер ответственного менеджера.
:2. Компонент "'''if (agent_phone == ‘’)'''". Проверяет на наличие номера в переменной '''agent_phone'''.
:3. Компонент "'''Number from CRM by default'''". Если номер в переменной отсутствует, то введите номер сотрудника по умолчанию.
По желанию, вы можете добавить CallerId и CallerName в компоненты переключения на сотрудников.

[[Файл:ReCRM-004.png|center|900px]]

[[Файл:ReCRM-005.png|center]]

'''Шаг 4.''' При входящем звонке в ReCRM отправляется запрос на получение ответственного менеджера по этому контакту. ReCRM возвращает имя пользователя, на которого происходит переключение. Параллельно открывается карточка у данного ответственного менеджера.

[[Файл:ReCRM-006.png|center|900px]]

'''Скачать сценарий:''' [[Media:%D0%9C%D0%B0%D1%80%D1%88%D1%80%D1%83%D1%82%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B4%D0%BB%D1%8F_ReCRM.oscr|Маршрутизация ReCRM.oscr]]

'''Скачать пример главного сценария:''' [[Media:%28%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D1%8B%D0%B9%29_%D0%9C%D0%B0%D1%80%D1%88%D1%80%D1%83%D1%82%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D1%85%D0%BE%D0%B4%D1%8F%D1%89%D0%B8%D1%85_%28Backup%29.oscr|(Служебный) Маршрутизация входящих (Backup).oscr]] (для версий от 2.11)

Использование API amoCRM

2023-03-31T12:37:05Z

Oktell Support:

[[Интеграции_с_CRM_системами | Наверх]]

'''amoCRM''' — это простая и понятная система учета потенциальных клиентов и сделок, которая поможет контролировать и увеличивать Ваши продажи. Она не требует установки или настройки — достаточно зарегистрироваться на этом сайте и ваша персональная CRM система готова к работе.

'''Сайт компании:''' [https://www.amocrm.ru/ https://www.amocrm.ru/]

'''amoCRM''' имеет удобный API-интерфейс, позволяющий с помощью специальных запросов обмениваться данными со сторонними системами, в том числе и с '''Oktell'''. С помощью этого интерфейса вы сможете с помощью запросов создавать задачи, добавлять сотрудников, получать список клиентов. Например, при входящем звонке в '''Oktell''' возможно параллельное создание контакта в '''amoCRM''' с заполненным номером телефона. Если же использовать диалоговые карточки Call-центра, возможна упрощенная схема создания заявок с назначением ответственных менеджеров.

'''Справка по API amoCRM:''' https://www.amocrm.ru/add-ons/api.php или https://developers.amocrm.ru/rest_api/

В этой статье описывается пример подключения и использования API-интерфейса средствами '''Oktell'''.

Рассмотрим задачу получения списка всех клиентов и выделения имени первого клиента с помощью команды API: '''/private/api/v2/json/contacts/list'''

Сценарий выглядит следующим образом:

[[Файл:API amoCRM -001.png|center]]

'''Шаг 1.''' Для начала работы введите ваши авторизационные данные в компоненте "'''Учетная запись'''".
* Переменной '''URL''' присвойте точный адрес вашего аккаунта - например, https://test.amocrm.ru
* Переменной '''User_Login''' присвойте логин пользователя
* Переменной '''User_Hash''' присвойте ключ для авторизации в API.

[[Файл:API amoCRM -002.png|center|600px]]

'''User Hash''' (ключ для авторизации в API) можно узнать в amoCRM в настройках пользователя (страница "'''Пользователи аккаунта'''").

[[Файл:API amoCRM -003.png|center|800px]]

'''Шаг 2.''' Введите необходимый запрос в компоненте "'''Запрос'''". В примере: '''/private/api/v2/json/contacts/list'''

[[Файл:API amoCRM -004.png|center]]

'''Шаг 3.''' Для отладки сценария во всех компонентах типа '''Уведомление''' определите '''Адресата'''.

'''Шаг 4.''' Результат запроса от amoCRM приходит в формате JSON. Для определения параметров из выборки используйте парсер JSON. В примере показано как получить имя первого клиента из списка.

* '''Документ''' - переменная ans, в которой содержится JSON-структура со списком клиентов.
* '''Алгоритм''' - Парсер JSON
* '''Поисковый запрос''' - строка ''"response"/"contacts"/0/"name"''
* '''Функция''' - Содержимое
* '''Результат в переменную''' - переменная '''ans1''' (строковая)

[[Файл:API amoCRM -005.png|center]]

'''Шаг 5.''' Запустите сценарий. Вы должны получить имя первого клиента, определенного в вашей '''amoCRM'''.

[[Файл:API amoCRM -006.png|center]]

Аналогичным образом вы сможете производить любые действия: подсчитывать количество клиентов в вашей компании, записывать в базу данных и т.д. Для выделения необходимой информации используйте JSON-парсер. Подробнее можно прочитать в статье [[Компонент Парсер|компонент Парсер]].

Вы можете не только получать информацию из системы, но и совершать служебные действия - создавать сделку, добавлять клиента. Для этого используйте необходимый запрос в компоненте "'''Запрос'''". Посмотреть список всех запросов можно в справке по API amoCRM: https://www.amocrm.ru/add-ons/api.php или https://developers.amocrm.ru/rest_api/

'''Скачать сценарий:''' [[Media:API_amoCRM.oscr|API_amoCRM.oscr]] (для версий старше 2.9 131007)

Oktell и amoCRM

2023-03-31T12:35:59Z

Oktell Support: /* Прием звонка */

[[Интеграции_с_CRM_системами | Наверх]]

__TOC__

'''amoCRM''' — это простая и понятная система учета потенциальных клиентов и сделок, которая поможет контролировать и увеличивать Ваши продажи. Она не требует установки или настройки — достаточно зарегистрироваться на этом сайте и ваша персональная CRM система готова к работе.

'''Сайт компании:''' [https://www.amocrm.ru/ https://www.amocrm.ru/]

 ВНИМАНИЕ: Интеграция возможна, начиная с версии '''Oktell''' не ниже 2.9 131002 (от 2 октября 2013 года).

== Подготовка к интеграции ==

=== Настройка Web-сервера Oktell ===

'''1.''' Чтобы '''amoCRM''' связалась с '''Oktell''', необходимо настроить '''web-сервер'''.

Для настройки '''web-сервера''' воспользуйтесь статьей: [[Настройка_Web-сервера_Oktell | Настройка Web-сервера Oktell]].

'''2.''' Чтобы работала выгрузка записей из Oktell в настройках web-сервера также нужно указать "'''Домен для формирования ссылок на скачивание'''". Укажите ваш внешний IP-адрес, например ''http://123.45.67.89:4055''

=== Подключение оператора с привязкой к телефону ===

Чтобы сотрудник мог совершать и принимать звонки в карте сети необходимо закрепить телефон за сотрудником.

Зайдите в '''Администрирование''' -> '''Карта сети''' -> '''Настройки телефона'''. Выберите сотрудника в поле '''Пользователь WebCRM'''.

[[Файл:Amocrm-011.png | center]]

ВНИМАНИЕ: Интеграция не позволяет использовать гарнитуру в работе. Вы можете использовать софтфоны в качестве IP-телефона. Настройка идентична вышеописанной.

== Настройка amoCRM ==

'''Шаг 1.''' Откройте '''Настройки''' и перейдите на вкладку '''Виджеты'''. В виджете '''Oktell''' нажмите кнопку "'''Установить'''".

[[Файл:Amocrm-002.png |800 px| center]]

'''Шаг 2.''' В настройках вам надо внести параметры телефонии: '''адрес сервера Oktell''' с указанием порта web-сервера, а также данные для авторизации - логины и пароли пользователей '''Oktell'''. Нажмите "'''Сохранить'''"

ВНИМАНИЕ: Если вы используете SSL-сертификат для web-сервера Oktell,то вводить IP-адрес нужно с '''wss://'''. Например, '''wss://12.34.56.78:4055'''

ВНИМАНИЕ: При использовании Google Chrome 36+ версии, вам необходимо установить SSL сертификат на сервере Oktell или разрешить нешифрованные соединения. Связано это с тем, что amoCRM работает на https и Google Chrome не разрешает использовать нешифрованные соединения при таком подключении. Обратитесь к статье: [[Нужен SSL-сертификат для интеграции с https-системами в Google Chrome]]

[[Файл:Amocrm-001.png | center]]

ВНИМАНИЕ: Для каждого пользователя на вкладке "'''Доступ'''" необходимо разрешить "'''Возможность исполнять методы Web-API'''". 
* Перейдите в '''Администрирование''' - '''Пользователи'''.
* Выберите конкретного пользователя и перейдите на вкладку '''Доступ'''.
* Поставьте галочку напротив "'''Возможность исполнять методы Web-API'''".
* Нажмите '''Сохранить'''.
* Затем нажмите '''Применить'''.

[[Файл:Amocrm-003.png |600px| center]]

== Прием и совершение звонка ==

=== Совершение звонка ===

Для совершения звонка используйте кнопку [[Файл:Amocrm-004.png]]. Запустится сервис автодозвона, отменить не получится.

[[Файл:Amocrm-005.png |800px| center]]

В сервисе автодозвона, по умолчанию, количество попыток на автодозвон до внешнего номера равно '''50'''. Рекомендуется установить количество попыток равное '''1'''.
* Для этого перейдите в '''Общие настройки''' - '''Автодозвон'''
* Установите "'''Количество попыток на автодозвон до внешнего номера'''" равное 1.

[[Файл:Amocrm-013.png | center]]

=== Прием звонка ===

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

'''Шаг 1.''' Импортируйте сценарий для работы с amoCRM.
* Для этого перейдите в '''Администрирование''' - '''Сценарии'''. В контекстном меню выберите "'''Импортировать сценарий'''" и выберите сценарий "'''Работа с AMO CRM'''".
'''Скачать сценарий:''' [[Media:%D0%98%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D1%8F_%D1%81_AMO_CRM.oscr|Работа с amoCRM.oscr]]

[[Файл:Amocrm-006.png | 600px|center]]

'''Шаг 2.''' Настройте параметры подключения к amoCRM.

Откройте импортированный сценарий "'''Работа с AMO CRM'''". Введите в компоненты "'''Ваш аккаунт AMO'''" и "'''Пользователь'''" значения из настроек виджета "'''Oktell'''".

ВНИМАНИЕ: Когда вы будете вставлять выражение в компонент "'''Пользователь'''", уберите перенос строки. Значение должно быть введено в одну строку.

[[Файл:Amocrm-007.png |800px|center]]

'''Шаг 3.''' Модифицируйте главный сценарий входящей маршрутизации.

* Добавьте 2 переменные в главный сценарий:
:#'''CRM_Number''' (строковая) - номер ответственного менеджера
:#'''CRM_INFO''' (строковая) - имя контакта
:Возможен вывод другой информации по абоненту (ID контакта, название компании, ID компании, ответственный менеджер)

* Добавьте следующие элементы:

:# Компонент "'''AMO CRM'''" - запуск сценария "'''Работа с AMO CRM'''".
:# Компонент "'''Есть номер?'''" - проверяет на наличие номера оператора
:# Компонент "'''Номер из CRM'''" - присваивает номер сотрудника в переменную сценария.

* По желанию, вы можете добавить '''CallerId''' и '''CallerName''' в компоненты переключения на сотрудников.

[[Файл:Amocrm-010.png |600px|center]]

[[Файл:Amocrm-009.png |1000px|center]]

'''Шаг 4.''' При входящем звонке в '''amoCRM''' отправляется запрос на получение ответственного менеджера по этому контакту. '''amoCRM''' возвращает имя пользователя, на которого происходит переключение. Параллельно открывается карточка у данного ответственного менеджера.

[[Файл:Amocrm-012.png |center]]

'''Скачать сценарий:''' [[Media:%D0%98%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D1%8F_%D1%81_AMO_CRM.oscr|Работа с amoCRM.oscr]]

'''Скачать пример главного сценария:''' [[Media:%D0%9C%D0%B0%D1%80%D1%88%D1%80%D1%83%D1%82%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D1%85%D0%BE%D0%B4%D1%8F%D1%89%D0%B8%D1%85_%28amocrm%29.zip|Маршрутизация_входящих_(amocrm).zip]] (для версий от 2.10.140313)

== Возможные проблемы ==

'''1.''' Если у вас не всплывает уведомление при входящем звонке, проверьте как в Oktell определяется CallerID. Используйте компонент уведомление в главном сценарии. Проверить определение '''CallerId''' в '''amoCRM''' можно с помощью web-запроса:

{Ваш аккаунт AMO}?{Ваш пользователь}&caller_number=89041112233&transliterate=Y

где '''Ваш аккаунт AMO''' и '''Ваш пользователь''' берутся из настроек виджета '''Oktell''', а номер можно определить с помощью уведомления в главном сценарии.

Например, '''https://test.amocrm.ru/private/acceptors/oktell/index.php?admin@oktell.ru&caller_number=89041112233&transliterate=Y'''

ВНИМАНИЕ: Если у вас некорректно определяется '''CallerId''' в '''Oktell''' выполните следующее:
* Перейдите в '''Администрирование''' - '''Параметры аппаратуры''' - {Выберите шлюз}.
* В поле "'''Источник определения CallerID'''" выберите, например, '''From: DisplayName'''
* Нажмите "'''Сохранить'''"

[[Файл:Amocrm-014.png |600px |center]]

'''2.''' Ошибка 1200 (cant connect to server):
*Если используется незащищенное соединение (ws) и в настройках виджета указан ws://<ip>. IP пишется без указания протокола ws.
*Если используется незащищенное соединение (ws) - в адресной строке нажать на "щит", затем на "разрешить выполнение небезопасного скрипта".
*Неправильные настройки firewall, маршрутизаторов и т.д., использование прокси могут так же являться причиной ошибки подключения. Иногда бывает, что на сервере на 80 порт установлен сторонний веб-сервис – в данном случае нужно поменять порт либо этого веб-сервиса, либо в настройках веб-сервера Oktell заменить 80 на любой другой открытый порт, (например, 8080).

'''3.''' Ошибка 1202

Если введены неправильные настройки login/password/ip в виджете – исправить их.

'''4.''' Ошибка 1204 (using oktell desktop client)

Нельзя одновременно использовать клиент Oktell и интеграцию. В данном случае работать будет только desktop Oktell.

'''5.''' Ошибка (phone not connected)

Попытка позвонить без подключенного softphone или ip-phone по SIP.

'''6.''' Не выгружаются записи разговоров

Чаще всего бывает из-за того, что в настройках веб-сервера Oktell указан 127.0.0.1 в качестве домена для генерирования ссылок на скачивание записи - нужно указать внешний адрес.

'''7.''' Не работает переадресация звонка на менеджера

Вызвано тем, что сценарий настроен неправильно. Про правильную настройку можно прочитать выше.

===Метод диагностики неполадок===

'''1.''' В браузере Google Chrome нажмите F12. Откроется консоль браузера.

'''2.''' Обновите страницу.

'''3.''' Перейдите в карточку клиента и дождитесь вывода ошибки.

'''4.''' Посмотрите информацию на вкладке '''Network/WebSockets'''. На вкладке выберите нужный WebSocket и откройте окно Frames, на котором вы увидите всю необходимую трассировку (команды oktell.js). Там вы сможете подробнее узнать о проблеме подключения.

'''5.''' Некоторая информация также доступна на вкладке '''Console'''.

'''Подробнее в статье''' [[Okapp#.D0.9C.D0.B5.D1.82.D0.BE.D0.B4_.D0.B4.D0.B8.D0.B0.D0.B3.D0.BD.D0.BE.D1.81.D1.82.D0.B8.D0.BA.D0.B8_.D0.BD.D0.B5.D0.BF.D0.BE.D0.BB.D0.B0.D0.B4.D0.BE.D0.BA|Okapp: Метод диагностики неполадок]]

Использование API Мегаплана

2023-03-31T12:34:15Z

Oktell Support:

[[Интеграции с CRM системами|Наверх]]

'''Мегаплан''' — один из лидеров среди SaaS-провайдеров на российском рынке, бизнес-приложение '''Мегаплан''' интегрирует '''Oktell''' в качестве модуля для совершения голосовых вызовов. Это простая и мощная облачная система для повышения эффективности бизнеса. Лучше всего подходит малому и среднему бизнесу из сферы услуг, проектных команд, агентств, консультационного бизнеса, ИТ-бизнеса, компаний из B2B-сектора. '''Мегаплан''' увеличивает выручку и прибыль компании: повышает скорость и качество обслуживания, позволяет управлять задачами и поручениями, следить за их выполнением, вести базу данных сотрудников компании, историю клиентов и многое другое.

'''Сайт компании:''' [http://www.megaplan.ru/ http://www.megaplan.ru/]

'''Мегаплан''' имеет API-интерфейс, позволяющий с помощью специальных запросов обмениваться данными со сторонними системами, в том числе и с '''Oktell'''. С помощью этого интерфейса вы сможете с помощью запросов создавать задачи, добавлять сотрудников, получать список клиентов. Например, при входящем звонке в '''Oktell''' возможно параллельное создание контакта в '''Мегаплане''' с заполненным номером телефона. Если же использовать диалоговые карточки Call-центра, возможна упрощенная схема создания заявок с назначением ответственных менеджеров.

'''Справка по API Мегаплана:''' [http://help.megaplan.ru/API http://help.megaplan.ru/API]

В этой статье описывается пример подключения и использования API-интерфейса средствами '''Oktell'''.

'''Скачать сценарий:''' [[Media:API_%D0%9C%D0%B5%D0%B3%D0%B0%D0%BF%D0%BB%D0%B0%D0%BD%D0%B0.oscr|API Мегаплана.oscr]] (собрано на версии 2.11.2.141217)

Рассмотрим задачу получения списка всех клиентов с помощью команды API: '''/BumsCrmApiV01/Contractor/list.xml'''

Сценарий выглядит следующим образом:

[[Файл:API мегаплана-001.png|center]]

'''Шаг 1.''' Для начала работы введите ваши авторизационные данные в компоненте "'''Начальные параметры'''".

'''Шаг 2.''' Введите необходимый запрос в компоненте "'''Запрос'''". В примере: '''/BumsCrmApiV01/Contractor/list.xml'''

[[Файл:API мегаплана-002.png|center|1000px]]

'''Шаг 3.''' Во всех компонентах типа '''Уведомление''' определите '''Адресата'''.

'''Шаг 4.''' Если используется версия ниже, чем 2.11 вместо компонента "'''Тело письма'''" установите компонент "'''Тело письма для Oktell 2.10'''". Это связано с тем, что из компонента Web-запрос для метода GET был убран заголовок '''Content-Type'''.

ВНИМАНИЕ: В компоненте "Получаем дату в виде RFC 2822" используется GMT +0300. Если у вас другой часовой пояс поменяйте его.

'''Шаг 5.''' Запустите сценарий. Вы должны получить список всех клиентов, определенных в вашем '''Мегаплане''' в формате XML.

[[Файл:API мегаплана-004.png|center]]

С полученным списком вы сможете производить любые действия: подсчитывать количество клиентов в вашей компании, записывать в базу данных и т.д. Для выделения необходимой информации используйте [[Компонент Парсер|компонент '''Парсер''']].

Вы можете не только получать информацию из системы, но и совершать служебные действия - создавать сделку, добавлять клиента. Для этого используйте необходимый запрос в компоненте "'''Запрос'''". Посмотреть список всех запросов можно в справке по API Мегаплана: [http://help.megaplan.ru/API http://help.megaplan.ru/API]

'''Скачать сценарий:''' [[Media:API_%D0%9C%D0%B5%D0%B3%D0%B0%D0%BF%D0%BB%D0%B0%D0%BD%D0%B0.oscr|API Мегаплана.oscr]] (собрано на версии 2.11.2.141217)

Использование API Мегаплана

2023-03-31T12:33:27Z

Oktell Support:

[[Интеграции с CRM системами|Наверх]]

'''Мегаплан''' — один из лидеров среди SaaS-провайдеров на российском рынке, бизнес-приложение '''Мегаплан''' интегрирует '''Oktell''' в качестве модуля для совершения голосовых вызовов. Это простая и мощная облачная система для повышения эффективности бизнеса. Лучше всего подходит малому и среднему бизнесу из сферы услуг, проектных команд, агентств, консультационного бизнеса, ИТ-бизнеса, компаний из B2B-сектора. '''Мегаплан''' увеличивает выручку и прибыль компании: повышает скорость и качество обслуживания, позволяет управлять задачами и поручениями, следить за их выполнением, вести базу данных сотрудников компании, историю клиентов и многое другое.

'''Сайт компании:''' [http://www.megaplan.ru/ http://www.megaplan.ru/]

'''Мегаплан''' имеет API-интерфейс, позволяющий с помощью специальных запросов обмениваться данными со сторонними системами, в том числе и с '''Oktell'''. С помощью этого интерфейса вы сможете с помощью запросов создавать задачи, добавлять сотрудников, получать список клиентов. Например, при входящем звонке в '''Oktell''' возможно параллельное создание контакта в '''Мегаплане''' с заполненным номером телефона. Если же использовать диалоговые карточки Call-центра, возможна упрощенная схема создания заявок с назначением ответственных менеджеров.

'''Справка по API Мегаплана:''' [http://help.megaplan.ru/API http://help.megaplan.ru/API]

В этой статье описывается пример подключения и использования API-интерфейса средствами '''Oktell'''.

'''Скачать сценарий:''' [[Media:API_%D0%9C%D0%B5%D0%B3%D0%B0%D0%BF%D0%BB%D0%B0%D0%BD%D0%B0.oscr|API Мегаплана.oscr]] (собрано на версии 2.11.2.141217)

Рассмотрим задачу получения списка всех клиентов с помощью команды API: '''/BumsCrmApiV01/Contractor/list.xml'''

Сценарий выглядит следующим образом:

[[Файл:API мегаплана-001.png|center]]

'''Шаг 1.''' Для начала работы введите ваши авторизационные данные в компоненте "'''Начальные параметры'''".

'''Шаг 2.''' Введите необходимый запрос в компоненте "'''Запрос'''". В примере: '''/BumsCrmApiV01/Contractor/list.xml'''

[[Файл:API мегаплана-002.png|center|1000px]]

'''Шаг 3.''' Во всех компонентах типа '''Уведомление''' определите '''Адресата'''.

'''Шаг 4.''' Если используется версия ниже, чем 2.11 вместо компонента "'''Тело письма'''" установите компонент "'''Тело письма для Oktell 2.10'''". Это связано с тем, что из компонента Web-запрос для метода GET был убран заголовок '''Content-Type'''.

ВНИМАНИЕ: В компоненте "Получаем дату в виде RFC 2822" используется GMT +0300. Если у вас другой часовой пояс поменяйте его.

'''Шаг 5.''' Запустите сценарий. Вы должны получить список всех клиентов, определенных в вашем '''Мегаплане''' в формате XML.

[[Файл:API мегаплана-004.png|center]]

С полученным списком вы сможете производить любые действия: подсчитывать количество клиентов в вашей компании, записывать в базу данных и т.д. Для выделения необходимой информации используйте [[Компонент Парсер|компонент '''Парсер''']].

Вы можете не только получать информацию из системы, но и совершать служебные действия - создавать сделку, добавлять клиента. Для этого используйте необходимый запрос в компоненте "'''Запрос'''". Посмотреть список всех запросов можно в справке по API Мегаплана: [http://help.megaplan.ru/API http://help.megaplan.ru/API]

'''Скачать сценарий:''' [[Media:API_%D0%9C%D0%B5%D0%B3%D0%B0%D0%BF%D0%BB%D0%B0%D0%BD%D0%B0.osc| API Мегаплана.oscr]] (собрано на версии 2.11.2.141217)

Oktell и Мегаплан

2023-03-31T12:31:14Z

Oktell Support: /* Проблемы и решения */

[[Интеграции_с_CRM_системами | Наверх]]

__TOC__

'''Мегаплан''' — один из лидеров среди SaaS-провайдеров на российском рынке, бизнес-приложение '''Мегаплан''' интегрирует '''Oktell''' в качестве модуля для совершения голосовых вызовов. Это простая и мощная облачная система для повышения эффективности бизнеса. Лучше всего подходит малому и среднему бизнесу из сферы услуг, проектных команд, агентств, консультационного бизнеса, ИТбизнеса, компаний из B2Bсектора. '''Мегаплан''' увеличивает выручку и прибыль компании: повышает скорость и качество обслуживания, позволяет управлять задачами и поручениями, следить за их выполнением, вести базу данных сотрудников компании, историю клиентов и многое другое.

'''Сайт компании:''' [http://www.megaplan.ru/ http://www.megaplan.ru/]

 ВНИМАНИЕ: Интеграция возможна, начиная с версии '''Oktell''' не ниже 2.9 131002 (от 2 октября 2013 года).

ВНИМАНИЕ: При использовании Google Chrome 36+ версии, вам необходимо установить SSL сертификат на сервере Oktell или разрешить нешифрованные соединения. Связано это с тем, что amoCRM работает на https и Google Chrome не разрешает использовать нешифрованные соединения при таком подключении. Обратитесь к статье: [[Нужен SSL-сертификат для интеграции с https-системами в Google Chrome]]

<video type="youtube" id="P5xKYHX4ffk" width="1280" desc="Интеграция Мегаплан с Октелл" frame="false" position="center" size="full" allowfullscreen="false"/>

== Подготовка к интеграции ==

=== Настройка Web-сервера Oktell ===

Чтобы '''Мегаплан''' связался с '''Oktell''', необходимо настроить '''web-сервер'''.

Для настройки '''web-сервера''' воспользуйтесь статьей: [[Настройка_Web-сервера_Oktell | Настройка Web-сервера Oktell]].

=== Подключение оператора с привязкой к телефону ===

В системе '''Oktell''' сотрудник может использовать '''ip-телефон''' или '''гарнитуру'''. В данной части рассматривается '''подключение сотрудника с привязкой к телефону.'''

Чтобы сотрудник мог совершать и принимать звонки в карте сети необходимо закрепить телефон за сотрудником.

Зайдите в '''Администрирование''' -> '''Карта сети''' -> '''Настройки телефона'''. Выберите сотрудника в поле '''Пользователь WebCRM'''.

[[Файл:Oktelljs-004.png | center]]

=== Подключение оператора с гарнитурой ===

В этой части статьи рассматривается подключение сотрудника с выделением ему гарнитуры (динамической линии). Чтобы '''Oktell''' выделил динамическую линию необходимо в серверном конфигурационном файле ('''\oktell\server\oktell.ServerService.exe.config''') определить параметр '''automap'''. Если у вас нет такого ключа добавьте его.

<add key="EnableAutoMap" value="1" />

''Если '''EnableAutoMap = 1''', то в клиентское приложение можно заходить с любого компьютера, не определенного в карте сети и к нему автоматически будет прикрепляться '''динамическая''' внутренняя линия (гарнитура). Если '''EnableAutoMap = 0''', то зайти в клиентское приложение можно только с тех компьютеров, которые определены в карте сети.''

Перезагрузите сервер '''Oktell'''.

[[Файл:Oktelljs-006.png | center]]

== Настройка Мегаплана ==

'''Шаг 1.''' Откройте '''Настройки''' и перейдите на вкладку '''Интеграция'''. Здесь вам надо оставить заявку на подключение. Менеджеры Мегаплана внесут изменения в настройки лицензии и вы сможете подключиться к '''Oktell'''.

[[Файл:Мегаплан-000.png | 800 px | center]]

'''Шаг 2.''' После подключения телефонии, вам надо внести параметры телефонии: '''IP-адрес сервера Oktell''', а также дополнительную информацию- коды телефона, максимальную длину внутреннего номера. В примере, указан только IP-адрес сервера Oktell.

[[Файл:Мегаплан-001.png | 800 px | center]]

'''Шаг 3.''' Теперь введите учетные данные от вашего пользователя '''Oktell''' - логин и пароль. Если пользователь будет использовать гарнитуру, то установите галочку "'''Звонить прямо из Мегаплана'''", пользователю будет выделена динамическая линия.

Если за пользователем закреплен IP-телефон, но вы захотите использовать также и гарнитуру, то оба устройства будут работать по технологии '''SIP-Forking''' (множественная регистрация линий под одной учетной записью). Вызов приходит одновременно на все устройства, но разговаривать можно будет только по одному.

Нажмите '''Сохранить'''.

 ВНИМАНИЕ: Использовать гарнитуру можно только в браузере '''Google Chrome'''.

[[Файл:Мегаплан-002.png | 800 px | center]]

'''Шаг 4.''' На остальных рабочих местах сотрудников в CRM "'''Мегаплан'''" нужно будет также ввести логин и пароль их учетной записи в '''Oktell'''.

[[Файл:Мегаплан-003.png | 800 px | center]]

== Прием и совершение звонка ==

=== Прием звонка ===

При входящем звонке в CRM-системе всплывает уведомление о звонке, в котором пользователь нажимает '''Ответить'''. Во время разговора пользователь может
* создать карточку клиента или компании. Телефон автоматически подставляется в соответствующее поле.
* добавить комментарий к звонку
* перевести или завершить звонок

<center>[[Файл:Мегаплан-004.png | 500 px ]][[Файл:Мегаплан-005.png | 500 px ]]</center>

После разговора, выберите связанного клиента и результат. Нажмите '''Завершить коммуникацию'''.

[[Файл:Мегаплан-006.png | 600 px |center]]

После успешного завершения коммуникации в '''карточке клиента''' вам будут доступны записи разговоров.

 ВНИМАНИЕ: Записи разговоров доступны только если вы нажали '''Завершить коммуникацию''' и выбрали связанного клиента.

[[Файл:Мегаплан-009.png | 600 px |center]]

=== Совершение звонка ===

Для совершения звонка выберите контакт и нажмите на кнопку [[Файл:Мегаплан-007.png]]

[[Файл:Мегаплан-008.png | 700 px | center]]

==Проблемы и решения==

'''1. Проблема:''' Не появляется значок "Позвонить"

'''Решение:'''

Необходимо 1)нажать на иконку серого телефона в правом нижнем углу

2)В конце адресной строки браузера появится изображение "щита"

[[Файл:MEGAPLAN PHONE ICON1.jpg | 600 px |center]]

После нажатия на него появится окно с предложением "Загрузить небезопасный скрипт"

[[Файл:MEGAPLAN PHONE ICON2.jpg | 600 px |center]]

Нажимаем на него, страница обновится, появится значок позвонить

[[Файл:MEGAPLAN PHONE ICON4.jpg | 600 px |center]]

ВНИМАНИЕ! После того как Вы закроете браузер и откроете его вновь необходимо будет повторить операцию.
Чтобы не выполнять эту процедуру каждый раз решения два

1)Шифрованное соединение с Октелл

2)Разрешить в браузере все не шифрованные соединения через флаг --allow-running-insecure-content ([https://support.google.com/chrome/answer/1342714?hl=ru На этой странице есть небезопасное содержание])
или в браузере: chrome://flags/#allow-insecure-websocket-from-https-origin

Второй вариант снижает безопасность, будьте осторожны!

В случае если после этого значок позвонить не появился и телефон в правом нижнем угла остался серым, необходимо проверить доступен ли сервер Октелл. Если он не доступен в консоли Google Chrome можно увидеть следующую ошибку

[[Файл:MEGAPLAN PHONE ICON3.jpg | 600 px |center]]

'''2. Проблема:''' Не появляется запись разговора.

'''Решение:'''

Необходимо проверить настройки микширования в Октелл, Администрирование - Общие настройки - Управление записями разговоров - должен быть установлен Используемый кодек mp3.

При необходимости можно активировать параметр - Упаковывать сразу после завершения коммутации [[%D0%A3%D0%BF%D1%80%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5_%D0%B7%D0%B0%D0%BF%D0%B8%D1%81%D1%8F%D0%BC%D0%B8_%D1%80%D0%B0%D0%B7%D0%B3%D0%BE%D0%B2%D0%BE%D1%80%D0%BE%D0%B2|Управление записями разговоров]]

[[Файл:MEGAPLAN PHONE ICON5.jpg | 600 px |center]]

Обработка webhooks Bpium в Oktell

2023-03-31T12:29:46Z

Oktell Support: /* Файлы */

[[Интеграции_с_CRM_системами | Наверх]]

__TOC__

== Описание ==
В Бипиум существует возможность отправки уведомлений сторонним системам при изменении данных пользователями. Для отправки уведомлений сторонние системы должны быть подписаны на события - вебхуки(webhooks). Подробнее с настройкой вебхуков в Бипиум можно ознакомиться по ссылке: [https://docs.bpium.ru/manual/structure/systemcatalogs/webhooks Вебхуки].

В данной статье рассматривается способ приема таких уведомлений в Oktell.

Бипиум отправляет события на указанный при создании webhook адрес при помощи POST-запроса с передачей сообщения о событии в теле запроса в формате JSON.

Принять и обработать POST-запрос с произвольным содержимым в Oktell можно при помощи служебного сценария генерации 404 ошибки. Он запускается когда на web-сервер Oktell приходит запрос на неизвестный ресурс. В качестве входных параметров в сценарий передаются: адрес ресурса, HTTP-заголовки запроса, содержимое запроса.

Таким образом получаем следующий алгоритм обработки вебхуков:
* создаем вебхук и указываем адрес для запросов в Oktell
* настраиваем служебный сценарий генерации 404 ошибки, в котором анализируем адрес, на который пришел запрос
* обрабатываем содержимое запроса и выполняем необходимые действия в Oktell

== Пример ==
Рассмотрим простой пример:

1) В Бипиум настроен каталог '''Задачи'''. При добавлении новой задачи и назначении ответственного, ему необходимо отправить уведомление на электронную почту.

2) Каталог '''Задачи''' содержит 3 поля: Название задачи, Описание и Ответственный.

[[Файл:Bpium_tasks_structure.png|center|800px]]

3) Настроим вебхук, укажем адрес web-сервера Oktell, на который будут отправляться уведомления - https://user:password@myoktell.ru/Bpium/NewTask.

[[Файл:Bpium_webhook.png|center|800px]]

4) Создадим служебный сценарий '''HTTP404'''. Сохраняем в переменные адрес ресурса и содержимое значение функций '''Входной параметр 1''' и '''Входной параметр 4''', которые содержат соответственно адрес ресурса и содержимое запроса.

[[Файл:Bpium_404.png|center|800px]]

5) Анализируем адрес ресурса: если переменная содержит строку “/Bpium/NewTask”, то продолжаем обработку запроса, в противном случае завершаем сценарий.

6) Обработку содержимого будем производить в отдельном служебном сценарии '''BpiumNewTask''', который запустим асинхронно. Основной сценарий завершаем установкой кода ответа HTTP 200 в служебную переменную '''(сл) Возвращаемое значение 2'''.

7) В сценарии обработки содержимого запроса '''BpiumNewTask''' с помощью компонента '''Парсер''' разбираем полученное JSON-сообщение. Подробнее о работе с компонентом '''Парсер''' можно прочитать в статье [[Компонент Парсер|компонент Парсер]].

8) Выделяем из полученного сообщения Название задачи, Описание задачи и идентификатор ответственного. Далее при помощи компонента '''Bpium''' получаем адрес электронной почты ответственного.
Формируем текст письма и отправляем ответственному сотруднику.

[[Файл:Bpium_newtask.png|center|800px]]

9) Указываем в настройках web-сервера Oktell созданный сценарий.

[[Файл:Bpium_oktellwebserver.png|center|800px]]

10) Проверяем, что при добавлении новой записи в каталог '''Задачи''', получаем уведомление на электронную почту.

==Файлы==

*[[Media:Bpium_webhook_scr.zip|Архив со сценариями]]

Сценарии исходящей маршрутизации

2023-03-31T12:22:31Z

Oktell Support:

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

Для начала, следует иметь в виду, что для различных типов абонентских устройств вход в сценарий происходит с небольшими отличиями:

Аналоговый телефон - сценарий запускается сразу после снятия трубки. USB телефон или встроеный в клиентское приложение soft-фон - сценарий запускается сразу после нажатия кнопки "снять трубку". Очевидно, что в общем случае, для корректной работы этих устройств, сценарий маршрутизации должен предусматривать сбор номера, его анализ (внешний или внутренний), выбор внешней линии или направления в зависимости от того, какой номер набран (городской/мобильный/междугородный).

IP телефоны и Софтфоны - сценарий запускается после набора номера и нажатия кнопки SND (начало вызова). Набранный номер передается в сценарий через функцию called-ID. Таким образом для IP телефонов нет необходимости использовать блок, предполагающий сбор номера, а можно сразу переходить к анализу полученного через called-id значения.

Важно понимать, что переключение абонентов также определяется сценарием исходящей маршрутизации. При необходимости совершить переключение, сотрудник нажимает flash (transfer), и оставляя абонента во flash-буфере, производит набор номера, на который необходимо произвести переключение. При этом, если переключающий, после набора номера и начала вызывных гудков (КПВ) не дождется ответа и положит трубку, то ожидающий во flash-буфере абонент попадет в сценарий исходящей маршрутизации.

Таким образом в сценарии исходящей маршрутизации должны быть предусмотрены следующие логические блоки:

[[Файл:Блок-схема сценария исходящей маршрутизации.jpg|800px]]

Компоненты служебных сценариев

2023-03-31T12:20:03Z

Oktell Support: /* Коммутатор */

<code>[[Техническая документация]] / [[Call-центр]] или [[Администрирование]] / [[Сценарии]] / [[Служебные сценарии]] / [[Компоненты служебных сценариев]]</code>

В данном разделе в справочном порядке приведены лишь узкоспециализированные компоненты, доступные только служебным сценариям. Остальные компоненты являются общими для всех типов сценариев и описаны выше в разделе [[Общие компоненты сценариев]]

__TOC__

<div id="ContentSave"></div>
[[Файл:cl_cc_scr_i91.png|left]]
===Сохранение контента===

Компонент служит для сохранения переданного ему на старт контента в файл. Сбор таких файлов может быть необходим для последующих задач обработки и тарификации. Файлы могут быть сохранены в текстовом и xml виде. Их дальнейшую обработку может взять на себя или отдельный процесс, или служебный сценарий с таймерной активацией.

'''Свойства''':

{|cellpadding="10" cellspacing="0" border="1"
|Контент
|Переменная, содержащая переданный в сценарий контент. Заполняется в компоненте «Старт».
|-
|Тип файла
|Текст / XML.
|-
|Файл
|Аргумент, определяющий путь к файлу. Доступна генерация случайных имен (включающих время).
|-
|Добавлять в конец
|Да/нет. Определяет способ формирования файла. Включение режима дописывает в конец к выбранному файлу информацию. Работает только при сохранении в текстовые файлы. Актуально только при настройке записи в один и тот же файл с целью избежания затирания предыдущей информации.
Поле доступно только при выборе значения «Текст» в свойстве «Тип файла».
|-
|Имя файла в переменную
|В указанную переменную будет занесено название файла (или путь), в который было произведено сохранение.
|-
|Возвращать полный путь
|Да/нет. При выборе пункта «Да» в переменную будет сохранен полный путь, иначе только имя файла.
|-
|Переход
|Компонент, на который передается управление.
|-
|Имя
|Название компонента для отображения в визуальной среде и выбора в списке.
|}

<div id="ContentParse"></div>
[[Файл:cl_cc_scr_i92.png|left]]
===Парсинг контента===

 С версии 100120 ликвидирован. Контент преобразован к XML-виду, парсинг его необходимо осуществлять компонентом [[Общие компоненты сценариев#Парсер текста|Разбор текста]]

Компонент служит для принятия решения в сценарии на основе содержащейся в контенте информации. Производит выделение из контента интересующего значения, такого как номер линии, время звонка и др.

'''Свойства''':

{|cellpadding="10" cellspacing="0" border="1"
|Контент
|Переменная, содержащая переданный в сценарий контент. Заполняется в компоненте «Старт».
|-
|Параметр
|Одна из множества содержащихся в контенте величин:
* Направление звонка;
* Время начала;
* Время окончания;
* Идентификатор линии;
* Номер линии;
* Идентификатор цепочки коммутаций;
* Номер абонента (CallerId);
* Внешний номер;
* Количество коммутаций;
* Количество коммутаций с оператором;
* Количество коммутаций с IVR;
* Общее время в секундах;
* Обработка в задаче;
* Идентификатор проекта;
* Идентификатор задачи;
* Имя задачи;
* Код задачи;
* Время в задаче в секундах;
* Время начала задачи;
* Код абонента в списке задачи;
Тип возвращаемого значения строковый или числовой.
|-
|Переменная
|Переменная, в которую производится выгрузка значения.
|-
|Переход
|Компонент, на который передается управление.
|-
|Имя
|Название компонента для отображения в визуальной среде и выбора в списке.
|}

<div id="Call"></div>
[[Файл:Script IVR call.png|left]]
===Дозвон===

Служебный сценарий не связан ни с какой линией, однако он может инициировать звонок на внешнее направление. Компонент позволяет осуществить вызов абонента и в зависимости от свойств либо дождаться ответа абонента и передать управление линией в сценарий IVR, либо запустить набор во внешнюю сеть и сразу же передать инициативу во внешний управляющий модуль (например менеджер задач) с моментальным переходом к следующему компоненту сценария, либо запустить набор и дождаться ответа, после чего передать инициативу во внешний управляющий модуль (например конференцию при вызове внутренних).

В ходе дозвона во внешнюю сеть производится поиск свободной внешней линии в соответствии с установленным списком, резервирование, набор номера. Далее в случае передачи управления внешней линией в сценарий IVR осуществляется ожидание ответа в течение установленного интервала времени (по умолчанию 40 секунд) и дальнейший запуск указанного обслуживающего сценария. В случае передачи управления в вышестоящий менеджер, ожидание ответа абонента осуществляется уже в нем, а сценарий после отправки номера на набор сразу сразу переходит к следующему компоненту.

Использование в режиме вышестоящего управляющего модуля происходит при активации режима набора номеров через сценарий в сервисе автодозвона, в голосовых задачах, в конференции. Например, может стоять задача жесткой маршрутизации звонков. В задаче указывается перечень равноправных линий, однако мобильные номера необходимо набирать через GSM-шлюз, внутригородские через городскую АТС, междугородние через SIP-соединения или через городскую АТС с использованием городской IP-телефонии. Для решения этой задачи может быть организован служебный сценарий, который в соответствии с переданным на его старт номером осуществляет маршрутизацию, выбор [[Линии#Направления|направлений]], преобразование номера в [[Линии#Направления|команду]], резервирование и отправку строки-команды на набор. Сценарий устанавливается как способ набора номеров в задачах (могут быть установлены различные сценарии в разных задачах) или при автодозвоне. После отправки команды-номера на набор управляющий модуль берет на себя задачу ожидания ответа линии, а сценарий либо завершается, либо производит дальнейшие необходимые действия, связанные с контекстом своего исполнения. Естественно, сценарий для определения способа маршрутизации и преобразования может использовать всю доступную информацию: время, номер, задача/пользователь, информация во внешних источниках (web, БД) и т.д.
В компоненте устанавливается список внешних линий и направлений, отсортированных в соответствии с приоритетом выделения. Может быть задействован дополнительный фильтр по правам внешнего объекта (задачи или пользователя), то есть могут быть исключены те линии, которые не присутствуют в ресурсах инициирующей дозвон задачи или в правах инициирующего автодозвон пользователя.
Преобразование номера в команду может быть произведено направлением, в котором зарезервирована свободная линия. Также преобразование может быть выполнено предварительно в текущем сценарии, а на набор передано без изменений.

Использование в режиме вышестоящего управляющего модуля с ожиданием в сценарии требуется при реализации приглашений внутренних номеров в конференцию через служебный сценарий (задается в общих настройках), а также при активации режима набора внутренних номеров в автодозвоне через служебный сценарий (задается в общих настройках). При этом в самом служебном сценарии может происходить набор как внешних, так и внутренних номеров - важно только, чтобы в качестве значения свойства «Обслуживание» был выбран режим «управляющий модуль с ожиданием в сценарии».

В одном обработчике сценария может быть успешно выполнено сколько угодно компонентов «Дозвон» с режимом обслуживания в IVR, но только один с режимом обслуживания в вышестоящем управляющем модуле. Остальные будут фильтроваться.

В случае ожидания в сценарии и обслуживания в вышестоящем управляющем модуле - может быть использовано множество компонентов с последовательно неудачными ответами и только один удачный, после чего будет включена фильтрация.

'''Свойства''':

{|cellpadding="10" cellspacing="0" border="1"
|Номер/команда
|Аргумент, определяющий номер, по которому производить дозвон.
В качестве номера может быть принята команда (строка, содержащая DTMF символы и командные спец. символы w, q, z, {, }). Подробнее о командах в разделе [[Линии#Направления|Администрирование. Направления]].

При звонке через [[Свойства_компонентов#IP_шлюз|sip-шлюз без регистрации]] возможно указывать в качестве номера URI (sip:username@domain). В этом случае несмотря на настройки звонок будет отправлен на указанный в URI адрес. То же самое в обязательном порядке касается шлюзов межсерверного взаимодействия.
|-
|Среда
|Внешняя сеть / Внутренний номерной план.
Определяет в каком направлении осуществлять вызов. При вызове внутреннего абонента осуществляется его соединение с указанным IVR сценарием. При вызове внешнего абонента существуют разновидности (свойство «Обслуживание»).
|-
|Обслуживание
|IVR / Управляющий модуль / Управляющий модуль с ожиданием в сценарии.
Вариант использования компонента в режиме набора номера. Различие в режимах описано выше.
|-
|Тип команды
|Доступно только в режиме набора номера во внешнюю сеть.
Определяет способ преобразования номера в команду, отсылаемую на набор. По умолчанию без преобразования.
* Без преобразования. Отправляет номер как есть в зарезервированную линию.
* Использовать команду [[Линии#Направления|направления]]. Если зарезервированная линия взята из направления, и в нем настроено преобразование номера, то перед отправкой на набор номер будет преобразован в строку-команду по указанной в направлении схеме.[[Линии#Направления|Подробно здесь]].
В некоторых случаях преобразование номера в команду может быть произведено предварительно в самом сценарии, или вовсе команда как итог может быть указана в таблице абонентов (номер в чистом виде - частный случай команды). В этом случае дополнительно преобразовывать команду не следует, и стоит оставить режим "без преобразования". Конечный режим реализации зависит от задач и целей.
|-
|Тип вызова
|Доступно только в режиме набора номера во внешнюю сеть.
Обычный / экстренный / интерком.
Набор в экстренном режиме при отсутствии свободных линий среди назначенных будет производить разрыв активных коммутаций с целью освобождения внешней линии для совершения этого звонка.

ВНИМАНИЕ! Значение «экстренный» следует выставлять в [[Экстренные номера|сценарии набора экстренных номеров]]. В других случаях рекомендуется оставлять тип со значением по умолчанию «обычный». Возможны вариации, но их следует тщательно продумывать во избежание незапланированных разрывов.

Подробно об экстренных номерах в разделах [[Внутренние номера#Экстренные номера|Администрирование. Внутренние номера. Экстренные]] и [[Экстренные номера|Администрирование. Общие настройки. Экстренные номера]].

Интерком-вызов имеет отличие от обычного, если функция поддерживается конечным устройством. В противном случае вызов будет происходить в обычном режиме. При интерком-вызове телефонное устройство снимает трубку автоматически сразу же после поступления звонка.
|-
|Линии, направления
|Осуществляет выбор линий и направлений для осуществления звонка во внешнюю сеть

На вкладке «Список объектов» предоставляется возможность указать явно последовательность существующих в системе линий и [[Линии#Направления|направлений]] для осуществления звонка. Можно отключить использование некоторых элементов, а для выбранных установить последовательность поиска свободной линии.
Поиск свободной будет осуществляться в соответствии с установленной последовательностью. По каждому направлению анализируются все линии, входящие в его состав. Если линия присутствует в нескольких направлениях, то при обнаружении ее свободной и установленном в компоненте режиме преобразования номера в соответствии с командой направления, будет применена команда того направления, которое в перечислении находится выше по приоритету.
На вкладке «Аргумент» возможно динамическое указание линии через ее код или Guid-идентификатор в строковом представлении. Также здесь может быть указан идентификатор или код направления, потока или шлюза. В этом случае будут последовательно перебираться все линии указанного объекта до обнаружения свободной и готовой к совершению вызова. Режим введен для использования совместно со [[Свойства компонентов#IP шлюз|шлюзами с динамической регистрацией потоков]] и компонентом сценариев [[Общие компоненты сценариев#Регистрация|Регистрация потока]].
|-
|Идентификатор выбранной линии в переменную
|Устанавливает строковую переменную, в которую происходит сохранение GUID-идентификатора выбранной для звонка линии. Если звонок не произведен, в переменную заносится пустота.
|-
|Фильтровать по правам
|Доступно только при наборе номера во внешнюю сеть в режиме обслуживания в управляющем модуле.
Да/нет. При задействовании режима в случае, если осуществляется обработка канала пользователя системы, может быть осуществлена дополнительная фильтрация перечисленных в компоненте линий в соответствии с настройками [[Права#Исходящие|прав выхода на внешние линии]] для пользователя. По умолчанию «Да» - фильтровать.
|-
|CallerId
|Подставляемый для звонка номер. При отсутствии или некорректном значении будет взят номер по умолчанию для канала.
|-
|CallerName
|Подставляемый для звонка имя.
|-
|Сценарий IVR
|Доступно только в режиме обслуживания в IVR (внешние и внутренние вызовы).
Название сценария, который будет запущен после снятия трубки абонентом.
|-
|Очередь ожидания
|Активировать ли очередь ожидания для внутреннего переключения в случае, если номер занят.
Поле доступно только при выборе значения «Внутренний номерной план» в свойстве «Среда».
|-
|Параметр запуска IVR
|Доступно только в режиме обслуживания в IVR (внешние и внутренние вызовы).
Параметр, который будет передан на старт сценария IVR.
|-
|Время ожидания, сек
|Аргумент определяет, сколько секунд необходимо ожидать соединения перед отбоем.
|-
|Код отказа SIP в переменную
|Доступно только в режиме обслуживания в IVR или ожидания ответа в сценарии.
Переменная сценария, куда сохраняется числовой код отказа SIP (например 486 или 500).
|-
|Переход
|Компонент, на который передается управление в случае успешного выполнения поставленной задачи (в соответствии с режимом - либо ответ абонента и соединение со сценарием IVR, либо отправка команды на набор и передача линии на обслуживание в управляющий модуль).
|-
|Переход, занято
|Доступно только в режиме обслуживания в IVR (внешние и внутренние вызовы).
Компонент, на который передается управление, если номер занят.
Свойство доступно только если установлен режим обслуживания в сценарии IVR.
|-
|Переход, не отвечает
|Доступно только в режиме обслуживания в IVR (внешние и внутренние вызовы).
Компонент, на который передается управление, если время ожидания ответа истекло.
Свойство доступно только если установлен режим обслуживания в сценарии IVR.
|-
|Переход, линия не найдена
|Доступно только в режиме обслуживания в IVR (внешние вызовы).
Компонент, на который передается управление, если не обнаружена доступная для совершения вызова внешняя линия из списка направлений.
|-
|Переход, ошибка
|Доступно только в режиме обслуживания в IVR (внешние и внутренние вызовы).
Компонент, на который передается управление, если в ходе проверки корректности установки свойств, набора номера, ожидания событий или передачи управления возникли сбои.
|-
|Имя
|Название компонента для отображения в визуальной среде и выбора в списке.
|}

<div id="Connector"></div>
[[Файл:cl_cc_scr_i94.png|left]]
===Коммутатор===

Компонент осуществляет вызов двух абонентов и соединяет их между собой в коммутацию. Имеет возможность вызывать сразу группу, из которых в качестве абонента принимается первый ответивший. Поддерживает вызовы внутренних пользователей, внешних номеров, быстрых и экстренных номеров, внутренних номеров, IVR-сценариев. При вызове внешних номеров использует [[Сценарии АТС#SvcDialExt|сценарий набора внешних/быстрых номеров]], если тот установлен в разделе общих настроек.

'''Свойства''':

{|cellpadding="10" cellspacing="0" border="1"
|Детальная настройка
|Да/нет.
Позволяет включить режим детальной настройки параметров вызова с помощью XML.
По умолчанию «Нет».
|-
|Абоненты А
|Недоступно, если включена детальная настройка.
Аргумент, определяющий первого абонента предстоящей коммутации. В качестве абонента может выступать ключ пользователя (идентификатор, имя, логин), ключ линии (идентификатор, номер), внутренний стандартный номер, быстрый/экстренный номер, внешний номер, а также любая их комбинация через запятую. В случае указания группы или нескольких абонентов в предстоящей коммутации будет участвовать первый ответивший абонент среди перечисленных.
|-
|Абоненты Б
|Недоступно, если включена детальная настройка.
Аргумент, определяющий второго абонента предстоящей коммутации. Указание аналогично абоненту А.
|-
|Последовательность
|Недоступно, если включена детальная настройка.
* Сначала А, потом Б. Система вызывает абонентов А, дожидается ответа первого из них, обрывает дозвон до остальных, после чего запускает дозвон до абонентов Б.
* Сначала Б, потом А. Наоборот.
* Одновременно А и Б. Система вызывает одновременно всех абонентов, при этом гарантирует соединение одного из группы А с одним из группы Б.
На время ожидания запускается [[Музыкальное_сопровождение#Alternative|альтернативная мелодия]].
|-
|CallerId для А
|Недоступно, если включена детальная настройка.
Аргумент, определяющий CallerId, с указанием которого осуществляется вызов абонентов группы А
|-
|CallerId для Б
|Недоступно, если включена детальная настройка.
Аргумент, определяющий CallerId, с указанием которого осуществляется вызов абонентов группы Б
|-
|Запись
|Недоступно, если включена детальная настройка.
Параметр, определяющий необходимость записи. По умолчанию выбран вариант «Согласно настройкам», при котором используется стандартная процедура поиска правил записи для звонка. Также доступны варианты «Записывать» и «Не записывать», производящие соответствующие безусловные действия.
|-
|Параметры
|Доступно, если включена детальная настройка.
Аргумент (по умолчанию выражение), определяющий все параметры осуществления коммутации. При начальной настройке выражение содержит полный перечень возможных тегов, часть из которых может быть удалена безболезненно. Обязательны к указанию только группы абонентов (agroup и bgroup) и режим (mode). Установке/изменению доступны:
* taskid - идентификатор задачи.
* taskcode - код задачи.
* sessionid - идентификатор цепочки коммутаций.
* projectid - идентификатор проекта.
* mode - последовательность вызова (0 - А, затем Б; 1 - Б, затем А; 2 - одновременно).
* svcownertext - владелец для служебных сценариев дозвона.
* agroup - перечень абонентов группы А. Каждый в отдельном теге.
* a - отдельный абонент из группы А.
* bgroup - перечень абонентов группы Б. Каждый в отдельном теге.
* b - отдельный абонент из группы Б.
* a_callerid - CallerId используемый при дозвоне до абонентов группы А.
* a_callername - CallerName используемый при дозвоне до абонентов группы А. По умолчанию пусто.
* a_music - мелодия ожидания для абонентов группы А. По умолчанию [[Музыкальное_сопровождение#Alternative|альтернативная мелодия]].
* a_queuepriority - приоритет очереди при вызове внутренних абонентов группы А. По умолчанию [[Менеджер_очередей#DefaultPriorityInt|стандартный приоритет внутренних вызовов]].
* a_usequeue - разрешение/запрет использования очереди при вызове внутренних абонентов группы А. По умолчанию разрешено.
* a_timeoutsec - максимально допустимое время ожидания ответа абонента группы А (в соответствии с настройкой [[Менеджер_очередей#QueueLimitIvr|активации ограничения при переключении из IVR вовнутрь]]).
* b_callerid - аналогично a_callerid
* b_callername - аналогично a_callername
* b_music - аналогично a_music
* b_queuepriority - аналогично a_queuepriority
* b_usequeue - аналогично a_usequeue
* b_timeoutsec - аналогично a_timeoutsec
* recordmode - режим записи (0 - согласно настройкам; 1 - да; 2 - нет)
|-
|Переход
|Компонент, на который передается управление после успешного завершения работы компонента.
|-
|Ожидать отчета
|
* Да, полный отчет. Компонент ожидает коммутации или неудачи, после чего сохраняет отчет в переменную.
* Да, только результат. Компонент ожидает коммутации или неудачи, после чего сохраняет результат в переменную.
* Нет. Компонент осуществляет корректность настройки и запускает вызов абонентов, после чего возвращает управление по успешной ветке. Ошибка возможна лишь в случае некорректного задания настроек или недоступности всех абонентов хотя бы одной из групп.
|-
|Отчет в переменную
|Доступно, если активировано ожидание отчета или результата.
Переменная, в которую сохраняется результат в зависимости от выбранного типа.
* только результат (1-коммутация/0-неудача)
* полный отчет в XML структуре (коммутация/неудача, описание абонента А, описание абонента Б, осуществляется ли запись, в какой каталог, в какой файл, время начала, идентификатор цепочки).
|-
|Переход
|Компонент, на который передается управление после успешного завершения работы компонента.
|-
|Переход, ошибка
|Доступно, если не активировано ожидание отчета или результата.
Компонент, на который передается управление после неудачи запуска. Ограничивается только начальной проверкой, корректным заданием настроек.
|-
|Имя
|Название компонента для отображения в визуальной среде и выбора в списке.
|}

<div id="CliProcess"></div>
[[Файл:cli_svcs_exec.png|left]]

===Запуск процесса на клиенте===

Запускает процесс на клиенте. Может запускать исполняемое приложение с обменом данными через консоль, а также открывать указанный документ в сопоставленном ему операционной системой приложении. На рабочем месте пользователя могут быть запущены внешние программы-подсказки, анализаторы, web-сценарии, не требующие связи со сценарием после запуска и пр. При этом служебный сценарий может дожидаться завершения работы запущенного таким образом приложения перед продолжением работы.

'''Свойства''':

{|cellpadding="10" cellspacing="0" border="1"
|Ключ пользователя
|Аргумент, определяющий пользователя, на рабочем месте которого будет запущен процесс. В качестве ключа может выступать идентификатор пользователя, его имя или логин.
|-
|Файл
|Строковый аргумент, определяющий имя или путь к файлу, который необходимо запустить.
|-
|Путь
|Относительный/абсолютный. Определяет, какой путь будет подставляться впереди к имени файла. Относительный – от папки запуска приложения Oktell.
|-
|Параметры командной строки
|Строковый аргумент, определяющий параметры запуска для командной строки, если необходимо.
|-
|Режим запуска
|Определяет способ исполнения указанного файла
* С помощью оболочки. В качестве файла можно указывать документы - их открытие будет осуществляться автоматически в зарегистрированных приложениях, однако становится недоступным использование консоли для ввода/вывода.
* Скрыть окно. Приложение не отображает свое консольное окно.
* Не скрывать окно. Приложение ведет себя стандартным образом.
|-
|Контроль запуска
|Да/нет. При выборе «да» производится асинхронный запуск указанного приложения и мгновенный возврат управления по ветке «успех». При выборе «нет» запуск производится в синхронном режиме. Управление в сценарий возвращается после непосредственного выполнения команды и получения кода возврата. В зависимости от успешности запуска возврат происходит по ветке «успех» или «неудача».

ВНИМАНИЕ! Некоторые программы могут запускаться достаточно долго, это неизбежно будет сказываться при выборе «да» на задержке выполнения других компонентов служебного сценария.
|-
|Ожидание завершения
|Да/нет. При выборе «да» запуск указанного приложения будет произведен в синхронном режиме вне зависимости от установки свойства «контроль запуска», управление в сценарий будет передано только после того, как запущенный процесс окончит работу и завершится. В этом случае выход происходит по ветке «успех». Если при запуске возникают ошибки, возврат происходит по ветке «неудача». Значение «да» может быть использовано при специфической интеграции компонентов сценария с различными внешними приложениями в случае, когда после выполнения приложений сценарий должен получить доступ к результатам.
|-
|Консольный ввод/вывод
|Доступно только при ожидании завершения процесса, запущенном в обычном режиме (не с помощью оболочки).
* Нет.
* Только ввод. Позволяет передать произвольные текстовые данные в консоль приложения сразу после старта.
* Только вывод. Позволяет считать произвольные текстовые данные из консоли приложения сразу после завершения.
* Ввод и вывод. Позволяет передать и считать данные.
|-
|Консольный ввод
|Доступно только при ожидании завершения процесса, запущенном в консольном режиме (не с помощью оболочки).
Строковый аргумент, значение которого передается в консоль сразу после запуска приложения.

ВНИМАНИЕ! При передаче сложных данных для простоты реализации чтения из консоли рекомендуется компоновать данные общим размером в самом начале.
|-
|Консольный вывод в переменную
|Доступно только при ожидании завершения процесса, запущенном в консольном режиме (не с помощью оболочки).
Строковая переменная, в которую полностью сохраняется консольный вывод исполненного приложения.
|-
|Переход, успех
|Если приложение успешно стартовало.
|-
|Переход, неудача
|Если файл не найден, отсутствует доступ, или по другой причине не удалось запустить приложение.
|-
|Имя
|Название компонента для отображения в визуальной среде и выбора в списке.
|}

Захват DTMF-сигналов во время разговора

2023-03-31T12:08:35Z

Oktell Support: /* Установка готовых сценариев в систему */

[[Практики|Наверх]]

__TOC__

==Введение==

'''Задача:''' Определять во время разговора введенные DTMF-символы на внешней и внутренней линии. В зависимости от линии и введенного на ней символа запускать различные процессы на сервере и клиентском приложении сотрудника. Например, при нажатии сотрудником на 1 — открыть в браузере сайт oktell.ru, при нажатии на 2 — привязать звонок к задаче Call-центра.

На самом деле Oktell уже имеет похожие возможности в виде служебных номеров флеша и управления конференцией. Набрав во время разговора эти номера, система выполняет определенные действия. Например, нажав служебный номер флеш — система ставит абонента на удержание. Для управления конференцией существуют даже комбинации, которые добавляют или удаляют пользователя из конференции. К сожалению, на момент написания статьи в интерфейсе системы нельзя добавить свой служебный номер для выполнения особых действий.

Однако, проблема решается с помощью самостоятельного перехвата DTMF-сигналов во время разговора. В системе есть возможность с помощью сценариев получить введенные символы как с внешней, так и с внутренней линии. В процессе настройки сценариев вы сами определяете какие действия должна выполнить система при нажатии того или иного символа (или их комбинации). Таким образом, в Oktell можно реализовать неограниченное количество "служебных комбинаций".

Функционал полезен в случаях, когда операторы часто проделывают одни и те же действия: добавляют текущий контакт в CRM-систему, открывают карточку клиента в браузере. С помощью определенных символов сотрудник может пометить клиента, чтобы система, к примеру, отправила ему SMS после разговора. Введенные символы на внешней стороне применяются для ввода скрытых данных, например, пароля во время разговора. Это может быть использовано для подтверждения операций в банковской сфере, не сообщая оператору личной информации.

==Основная идея==

Чтобы перехватывать DTMF-сигналы с любой линии, необходимо в IVR-сценарии после успешного переключения зациклить компонент '''Ввод значения'''. В таком случае на линии параллельно с разговором будет работать IVR сценарий, фиксирующий все введенные символы.

[[Файл:Перехват DTMF-001.png|center]]

<div id="out"></div>
Дополнительно все введенные DTMF сохраняются в таблице <code>[oktell]..[a_stat_dtmf]</code>. Для этого необходимо включить соответствующие настройки в разделе Администрирование/Общие настройки/Управление базами данных — ''Сохранять в БД все получаемые по внешним/внутренним линиям DTMF-символы''. Для считывания DTMF потребуется отдельный служебный сценарий, который будет циклично мониторить таблицу на предмет ввода новых символов.

[[Файл:Перехват DTMF-002.png|center|600px]]

==Главный IVR сценарий==

Поскольку в главный IVR сценарий попадает внешняя линия, установленный "Ввод значения" будет принимать DTMF только на этой внешней линии. В рамках задачи необходимо принимать DTMF и с внутренней линии, следовательно нужно дозвониться до нее и также запустить на ней IVR сценарий. Такая операция реализуется через дозвон и конференцию с моделью поведению "Преобразовать в коммутацию".

[[Файл:Перехват DTMF-003.png|center]]

Компонент "'''Начальные параметры'''". Определяет параметры клиента и сохраняет в переменные:
* сессионной переменной '''phone''' (строковая) присваивается внутренний номер, на который происходит переключение. В примере, строка "900".
* сессионной переменной '''key''' (строковая) присваивается значение выражения <code>RANDOM(999999)</code>. Переменная используется в качестве ключа конференции.
* сессионной переменной '''CallerId''' (строковая) присваивается значение функции Номер абонента (CallerId). Переменная хранит номер абонента.

[[Файл:Перехват DTMF-005.png|center]]

Компонент "'''В конференцию'''". Отправляет клиента в конференцию с моделью поведения "Преобразовать в коммутацию". Как только в эту коммутацию присоединится второй участник она преобразуется в обычный разговор. Ключ конференции предварительно генерируется случайным образом.
*Ключ конференции — переменная '''key'''
*Создать, если отсутствует - да
*Расширенная настройка — да
*Модель поведения - Преобразовать в коммутацию

Компонент "'''На дозвон'''". Запускает сценарий дозвона до внутреннего номера с последующим добавлением в конференцию. Все сессионные переменные будут переданы в этот сценарий автоматически.
*Тип запуска — асинхронный служебный
*Сценарий - Перехват DTMF (служебный сценарий дозвона)

Компонент "'''Перехват DTMF'''". Запускает сценарий для считывания DTMF-сигналов с данной внешней линии. Параметр запуска '''0''' означает, что сценарий запускается для внешней линии (рассматривается ниже).
* Тип запуска - вложенный
* Сценарий - Перехват DTMF (IVR сценарий перехвата DTMF)
* Параметр запуска - строка "0"

[[Файл:Перехват DTMF-004.png|center]]

==Служебный сценарий дозвона==

Сценарий дозванивается до внутреннего пользователя и запускает на его линии IVR сценарий добавления в конференцию. В сценарии не предусмотрен случай, когда внутренний абонент не берет трубку.

[[Файл:Перехват DTMF-006.png|center]]

Компонент "'''Дозвон'''". Все используемые сессионные переменные должны строго иметь такие же наименования, как и в главном сценарии.
* Номер/команда - сессионная переменная '''phone''' (строковая)
* Среда - внутренний номерной план
* Обслуживание - IVR
* Сценарий IVR - Перехват DTMF (IVR сценарий входа в конференцию)
* Параметр запуска - сессионная переменная '''key''' (строковая)
* CallerId - сессионная переменная '''CallerId''' (строковая)

==IVR сценарий входа в конференцию==

Сценарий запускается после ответа внутреннего сотрудника и добавляет его в конференцию, которая сразу же преобразовывается в коммутацию. После этого начинает считывать вводимые DTMF с данной внутренней линии.

[[Файл:Перехват_DTMF-007.png|center]]

Компонент "'''Старт'''". На вход сценария передается номер конференции, в которую следует добавить внутреннего сотрудника. Параметр запуска сохраняется в переменную '''key'''.
*Параметр запуска - переменная '''key''' (строковая)

Компонент "'''В конференцию'''". Добавляет сотрудника в конференцию с указанным ключом.
*Ключ конференции — переменная '''key'''
*Создать, если отсутствует - да
*Расширенная настройка — да
*Модель поведения - Преобразовать в коммутацию

Компонент "'''Перехват DTMF'''". Запускает сценарий для считывания DTMF-сигналов с текущей внутренней линии. Параметр запуска '''1''' означает, что сценарий запускается для внутренней линии (рассматривается ниже).
* Тип запуска - вложенный
* Сценарий - Перехват DTMF (IVR сценарий перехвата DTMF)
* Параметр запуска - строка "1"

[[Файл:Перехват DTMF-008.png|center]]

==IVR сценарий перехвата DTMF==

Основной сценарий для захвата DTMF и выполнения служебных действий. Главная идея — зациклить компонент "Ввод значения", анализируя введенные значения. Напомним, что этот сценарий — единый для внешних и внутренних линий, поэтому на старт передавался флаг, поясняющий тип линии: 0 - внешняя линия, 1 - внутренняя. Такое разделение помогает реализовать различный функционал для сотрудников и клиентов.

[[Файл:Перехват DTMF-009.png|center]]

Компонент "'''Старт'''". На вход сценария передается тип линии. Компонент сохраняет параметр запуска в переменную '''startParam'''.
*Параметр запуска - переменная '''startParam''' (строковая)

Компонент "'''Внутренняя линия?'''". Определяет тип линии и направляет сценарий на соответствующую ветку.
*Аргумент 1 — переменная '''startParam'''
*Аргумент 2 — строка '''1'''
*Тип сравнения — "="
*Переход, если правда — на компонент "Ввод с внутренней линии"
*Переход, если ложь — на компонент "Ввод с внешней линии"

Компонент "'''Ввод с внутренней линии'''". Ожидает ввода одного символа с внутренней линии, затем сохраняет введенный символ в переменную '''DTMF'''. Переход к анализу происходит только если символ введен.
*Буфер для DTMF - переменная '''DTMF''' (строковая)
*Очистить буфер - Да
*Макс время, с - 20
*Количество символов - 1
*Переход - на компонент "Ув2"
*Переход, таймаут - на компонент "->"

[[Файл:Перехват DTMF-010.png|center]]

Компонент "'''Ув2'''". Отладочное уведомление для вывода захваченного символа
* Текст — выражение <code>ScriptFunc( 'Имя пользователя' )+' набрал символ '+[DTMF]</code>
* Способ оповещения — Всплывающее уведомление
* Ключ получателя — введите внутренний номер вашего пользователя

Компонент "'''Определение символа'''". Анализирует введенный символ — по нажатию на 1 у сотрудника должна открыться веб-страница в браузере, а по нажатию на 2 звонок должен прикрепиться к задаче.
* Аргумент - переменная '''DTMF'''
* Значения -
: 1 - на компонент "Ув3"
: 2 - на компонент "Ув4"
* Переход, прочее — на компонент "->"

[[Файл:Перехват DTMF-011.png|center]]

Компоненты "'''Ув3 и Ув4'''". Отладочные уведомления о выбранных действиях.

Компонент "'''Действие 1'''". Запускает сценарий для открытия страницы Oktell.ru в браузере. На вход сценария передается идентификатор оператора, для которого нужно это выполнить.
* Тип запуска - Асинхронный служебный
* Сценарий - Перехват DTMF (Служебный сценарий для открытия сайта)
* Параметр запуска - функция "Guid-идентификатор пользователя".

Компонент "'''Действие 2'''". Запускает сценарий для привязки звонка к задаче. На вход сценария передается идентификатор оператора, для которого нужно это выполнить.
* Тип запуска - Асинхронный служебный
* Сценарий - Перехват DTMF (Служебный сценарий для привязки звонка к задаче)
* Параметр запуска - функция "Guid-идентификатор пользователя".

[[Файл:Перехват DTMF-012.png|center]]

Компонент "'''->'''". Не имеет функционального предназначения, используется для связки компонентов.
* Время задержки, мс - 0

Компонент "'''Ввод с внешней линии'''". Аналогичные действия выполняются для внешней линии. Компонент считывает DTMF, введенные на внешней линии.
*Буфер для DTMF - переменная '''DTMF''' (строковая)
*Очистить буфер - Да
*Макс время, с - 20
*Количество символов - 1
*Переход - на компонент "Ув1"
*Переход, таймаут - на компонент "->"

Компонент "'''Ув1'''". Отладочное уведомление для вывода захваченного символа. После компонента вы можете аналогично реализовать функционал для внешних линий.
* Текст — выражение <code>'Линия '+ScriptFunc( 'Номер линии' )+' набрал символ '+[DTMF]</code>
* Способ оповещения — Всплывающее уведомление
* Ключ получателя — введите внутренний номер вашего пользователя

[[Файл:Перехват DTMF-013.png|center]]

==Служебный сценарий для открытия сайта==

Сценарий выполняется после нажатия на внутренней линии символа "1". Открывает страницу <nowiki>https://oktell.ru</nowiki> в браузере на компьютере сотрудника. Ключ сотрудника передается на вход сценария.

[[Файл:Перехват DTMF-014.png|center]]

Компонент "'''Старт'''". На вход сценария передается идентификатор пользователя. Компонент сохраняет параметр запуска в переменную '''GUID пользователя'''.
*Параметр запуска - переменная '''GUID пользователя''' (строковая)

Компонент "'''Открыть веб-страницу'''". Открывает указанную веб-страницу в браузере по умолчанию на компьютере пользователя.
*Ключ пользователя - переменная '''GUID пользователя'''
*Файл - строка "''https://oktell.ru''"
*Путь - Абсолютный
*Режим запуска - С помощью оболочки

[[Файл:Перехват DTMF-016.png|center]]

==Служебный сценарий для привязки звонка к задаче==

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

[[Файл:Перехват DTMF-015.png|center]]

Компонент "'''Старт'''". На вход сценария передается идентификатор пользователя. Компонент сохраняет параметр запуска в переменную '''GUID пользователя'''.
*Параметр запуска - переменная '''GUID пользователя''' (строковая)

Компонент "'''Привязать звонок к задаче'''". Прикрепляет текущий звонок пользователя к указанной задаче.
*Действие - Установить
*Тип объекта - Задача
*Задача - выберите задачу Call-центра
*Свойство/действие - Привязать к звонку оператора
*Значение - переменная '''GUID пользователя'''

[[Файл:Перехват DTMF-017.png|center]]

==IVR сценарий исходящей маршрутизации==

Ранее мы подробно рассмотрели перехват DTMF во время входящего звонка. В данном параграфе рассматривается перехват DTMF во время исходящего звонка. Для реализации функционала потребуется модифицировать сценарий исходящей маршрутизации.

Поскольку этот сценарий запускается на внутренней линии, изначально мы сможем перехватывать только сигналы с внутренних линий. Как говорилось ранее, нам для перехвата DTMF нужно запустить IVR сценарий на требуемой линии. Вы можете воспользоваться указанным выше алгоритмом через создание конференции, однако мы рассмотрим альтернативный способ считывания сигналов непосредственно из БД. Для работы данного сценария необходимо [[Захват_DTMF-сигналов_во_время_разговора#out|установить]] флажок "''Сохранять в БД все получаемые по внешним/внутренним линиям DTMF-символы''" в модуле ''Администрирование/Общие настройки/Управление базами данных''.

В сценарии исходящей маршрутизации после успешного соединения нужно установить запуск служебного сценария для получения DTMF из БД и IVR сценарий для захвата сигналов с данной линии. Также чтобы получать DTMF с нужной внешней линии, необходимо сохранить ее идентификатор в компоненте "'''ВНЕШНИЕ'''".

[[Файл:Перехват DTMF-018.png|center]]

Компонент "'''ВНЕШНИЕ'''". В компоненте необходимо сохранить идентификатор выбранной линии в сессионную переменную "'''Line'''" (строковая)
*Идентификатор выбранной линии - сессионная переменная "'''Line'''" (строковая)

Компонент "'''Получение DTMF из БД'''". Запускает сценарий для мониторинга таблицы <code>a_stat_dtmf</code>
* Тип запуска - Асинхронный служебный
* Сценарий - Перехват DTMF (Служебный сценарий для получения DTMF из БД)

Компонент "'''Перехват DTMF'''". Запускает сценарий для считывания DTMF-сигналов с текущей внутренней линии. Параметр запуска '''1''' означает, что сценарий запускается для внутренней линии. Сценарий рассмотрен выше.
* Тип запуска - вложенный
* Сценарий - Перехват DTMF (IVR сценарий перехвата DTMF)
* Параметр запуска - строка "1"

[[Файл:Перехват DTMF-019.png|center]]

==Служебный сценарий для получения DTMF из БД==
Основная идея сценария - циклично осуществлять запросы в таблицу <code>[oktell]..[a_stat_dtmf]</code> и последовательно считывать все введенные символы с внешней линии. На каждой итерации символы анализируются и производятся заранее настроенные действия. Через сессионную переменную '''Line''' сценарий получает идентификатор линии, по которой нужно захватывать DTMF.

[[Файл:Перехват DTMF-020.png|center]]

Компонент "'''Текущее время'''". Сохраняет текущее время в переменную '''dt'''. Используется в качестве начального параметра для поиска DTMF в таблице.
* переменной '''dt''' (дата/время) присваивается значение функции "''Текущие дата и время''"

Компонент "'''idchain'''". Определяет текущий идентификатор цепочки коммутаций на внешней линии. Требуется для поиска DTMF в таблице, а также для проверки существования коммутации.
*Действие - Определить
*Тип объекта - Линия
*Ключ линии - сессионная переменная '''Line''' (строковая)
*Значение в переменную - переменная '''idchain''' (строковая)

Компонент "'''Ув1'''". Отладочное уведомление для вывода значения переменной '''idchain'''.
*Отладочный режим - Да
*Текст - переменная '''idchain'''
*Ключ получателя - введите ваш внутренний номер

[[Файл:Перехват DTMF-021.png|center]]

Компонент "'''Не в коммутации?'''". Проверяет существование сессии (цепочки коммутаций) на линии. Если текущая цепочка коммутаций равна строке "''00000000-0000-0000-0000-000000000000''" заканчивает служебный сценарий.
*Аргумент 1 - переменная '''idchain'''
*Аргумент 2 - строка ''00000000-0000-0000-0000-000000000000''
*Тип сравнения - "="
*Переход, если правда - на компонент "Ув2".
*Переход, если ложь - на компонент "получить DTMF"

Компонент "'''Ув2'''". Уведомляет администратора о завершении сценарии.
*Текст - строка ''Сценарий получения DTMF завершен''
*Ключ получателя - введите ваш внутренний номер

Компонент "'''Получить DTMF'''". Выполняет SQL-запрос в таблицу <code>[oktell]..[a_stat_dtmf]</code> для получения последнего DTMF по текущей цепочки коммутаций на данной линии. Запрос построен таким образом, что последовательно считывает введенные символы, сохраняя каждый раз временную метку. Таким образом, вне зависимости от скорости ввода символов запрос гарантирует их последовательный перебор.

select top 1 @dt=dt, @symbol = symbol from a_stat_dtmf
where idchain = @idchain
and dt > @dt
order by dt asc
где
*@dt - переменная '''dt'''
*@idchain - переменная '''idchain'''
*@symbol - переменная '''symbol''' (строковая)

[[Файл:Перехват DTMF-022.png|center]]

Компонент "'''пусто'''". Проверяет был ли введен символ.
*Аргумент 1 - переменная '''symbol'''
*Аргумент 2 - пустая строка
*Тип сравнения - "="
*Переход, если правда - на компонент "1000ms".
*Переход, если ложь - на компонент "Ув3"

Компонент "'''Ув3'''". Выводит на экран принятый DTMF-символ. После компонента вы можете реализовать функционал для внешних линий, аналогично вышеописанному сценарию перехвата символов.
*Отладочный режим - Нет
*Текст - выражение <code>'Линия '+[NumLine]+' набрала символ '+[symbol]</code>
*Ключ получателя - введите ваш внутренний номер.

Компонент "'''1000ms'''". Пауза перед следующей итерацией. Во избежание загрузки базы данных не рекомендуется ставить интервал менее 500 мс.
*Время задержки, мс - 1000

[[Файл:Перехват DTMF-023.png|center]]

Компонент "'''->'''". Не имеет функционального предназначения, используется для связки компонентов.
* Время задержки, мс - 0

Компонент "'''Обнуляем'''". Очищает переменную '''symbol''' перед новой итерацией.
* переменной '''symbol''' присваивается пустая строка.

[[Файл:Перехват DTMF-024.png|center]]

==Установка готовых сценариев в систему==
* Скачайте и импортируйте сценарии из архива: [[Media:%D0%9F%D0%B5%D1%80%D0%B5%D1%85%D0%B2%D0%B0%D1%82_DTMF.zip|Перехват DTMF.zip]] (''собраны на версии 2.12.0.150423'')
* Установите сценарий ''Перехват DTMF (Главный IVR сценарий)'' в качестве главного IVR сценария. Присвойте переменной '''phone''' - внутренний номер для переключения.
* Установите ''Перехват DTMF (IVR сценарий исходящей маршрутизации)'' в качестве IVR сценария исходящей маршрутизации.
* Реализуйте нужный функционал с помощью служебных сценариев и назначьте их в сценарии ''Перехват DTMF (IVR сценарий перехвата DTMF)''

Улучшенный алгоритм распознавания с помощью Yandex SpeechKit Cloud

2023-03-31T12:04:49Z

Oktell Support: /* Реализация сценария */

[[Практики|Наверх]]

__TOC__

==Введение==

В данной статье показывается пример улучшения анализа распознанной речи с помощью сервиса выделения смысла.

На данный момент анализ текста проводится в компоненте "'''Распознавание речи'''" с помощью свойства "Предопределенные значения". Это может быть неудобным для анализа длинных выражений, так как чтобы получить код группы должно быть полное совпадение распознанного выражения с одним из предопределенных. Например, чтобы соединиться с инженерами техподдержкой, клиент может сказать:
*''Соедините меня с отделом технической поддержки''
*''Переключите меня на инженеров''
*''Мне срочно нужны ваши программисты''
Очевидно, что одна и та же фраза может содержать существительные в разных падежах, иметь разную длину и предугадать все возможные комбинации почти невозможно. Отметим однако, что встроенные возможности компонента легко решают задачу распознавания одного слова.

Идея улучшения анализа заключается в применении сервиса выделения смысла. Сервис разбивает фразу на отдельные слова (леммы), преобразовывая существительные в именительный падеж, а глаголы в инфинитив. После этого сценарий в цикле просматривает каждую лемму и ищет совпадение с ключевым словом. В каком бы падеже не стояло искомое слово, если оно есть во фразе, алгоритм найдет его. Как только совпадение сработает происходит переключение на требуемый отдел.

'''Скачать файл:''' [[Media:Yandex_SpeechKit_Cloud_%D1%83%D0%BB%D1%83%D1%87%D1%88%D0%B5%D0%BD%D0%BD%D1%8B%D0%B9_%D0%B0%D0%BB%D0%B3%D0%BE%D1%80%D0%B8%D1%82%D0%BC.oscr|Yandex_SpeechKit_Cloud_улучшенный_алгоритм.oscr]] (собрано на версии 2.11.2.141230)

==Реализация сценария==

Рассмотрим алгоритм на примере сценария входящей маршрутизации. Позвонив в компанию, система спрашивает абонента с кем он хочет соединиться. Ответ клиента распознается, а дальше анализируется согласно вышеописанному алгоритму.

Сценарий выглядит следующим образом:

[[Файл:Алгоритм распознавания - 001.png|center]]

Компонент "'''API ключ'''". Определяет ключ для использования сервиса выделения смысла в web-запросе.
* переменной '''key''' (строковая) присвойте строку с вашим API-ключом.

Компонент "'''Приветствие'''". Воспроизводит приветствие и задает вопрос абоненту, с кем его соединить. Используется синтез речи Yandex.
* Режим - Воспроизвести
* Текст - Здравствуйте. С кем вас соединить
* Голос - Zahar
* Эмоция - по умолчанию
* Кэш - использовать

Компонент "'''ding'''". Воспроизводит короткий сигнал для абонента, соответствующий началу записи.
* Режим - Файл полностью
* Файл - ding.wav

ВНИМАНИЕ: Вместо компонентов "Приветствие" и "ding" вы можете использовать свой звуковой файл с записанной информацией. Синтез речи приведен в сценарии для примера.

[[Файл:Алгоритм распознавания - 002.png|center|800px]]

Компонент "'''Распознавание речи'''". Записывает и распознает речь абонента. После 1 секунды тишины воспроизводит ding.wav и переходит к следующему компоненту.
* Режим - Записать
* Символы прерывания - *
* Прервать при обнаружении тишины - Включить
* Интервал тишины, с - 1
* Настройки голосового детектора - по умолчанию
* Сигнал окончания записи - ding.wav
* Сохранение файла записи - Не сохранять
* Тема - queries
* Текст в переменную - переменная '''parse_bestText''' (строковая)

Компонент "'''Запрос на выделение смысла'''". Отправляет распознанный текст на сервис Yandex и получает размеченную JSON-структуру.
* URL - выражение
<nowiki>'https://vins-markup.voicetech.yandex.net/markup/0.x/?text='+[parse_bestText]+'&layers=Fio,Morph,GeoAddr&key='+[key]</nowiki>
* Метод - GET
* Режим работы - Обрыв по таймауту
* Таймаут, сек - 30
* Ответ в переменную - переменная '''response''' (строковая)

ВНИМАНИЕ: Если по истечению таймаута сервис Yandex не ответит на запрос произойдет обрыв связи. Вам нужно самостоятельно обработать этот момент.</span

Компонент "'''Ув1'''". Отладочное уведомление с выводом полученной JSON структуры.
*Отладочный режим - Да
*Текст - выражение:
'Текст '+[parse_bestText]+endline+'Смысл '+[response]
*Адресат - выберите вашего пользователя

Компонент "'''id_morph=0'''". Задает начальное значение для счетчика морфем.
* переменой id_morph (строковая) присваивается число 0

[[Файл:Алгоритм распознавания - 003.png|center|800px]]

Компонент "'''count_morph'''". Определяет число морфем в полученной JSON-структуре.
* Документ - переменная '''response'''
* Алгоритм - Парсер JSON
* Поисковый запрос - строка ''"Morph"''
* Функция - Количество элементов
* Результат в переменную - переменная '''count_morph''' (строковая)

Компонент "'''morph'''". Определяет рассмотрены ли все морфемы и заканчивает основной цикл.
* Аргумент 1 - переменная '''id_morph'''
* Аргумент 2 - переменная '''count_morph'''
* Тип сравнения - >=
* Переход, если правда - компонент "'''Ув3'''"
* Переход, если ложь - компонент "'''morph'''"

Компонент "'''count_lemmas'''". Определяет число лемм для выбранной морфемы. Это связано с тем, что сервис может прислать несколько лемм для одной морфемы, часто такая ситуация встречается с глаголами. Существительные, как показывает практика, имеют одну лемму. Теоретически, цикл по леммам можно убрать и брать самую первую, но это решение мы оставляем за администратором вашей системы.
* Документ - переменная '''response'''
* Алгоритм - Парсер JSON
* Поисковый запрос - выражение ''<nowiki>'"Morph"/'+[id_morph]+'/"Lemmas"'</nowiki>''
* Функция - Количество элементов
* Результат в переменную - переменная '''count_lemmas''' (строковая)

[[Файл:Алгоритм распознавания - 004.png|center|800px]]

Компонент "'''id_lemmas=0'''". Задает начальное значение для счетчика лемм.
* переменой id_lemmas (строковая) присваивается число 0

Компонент "'''lemmas'''". Проверяет пересмотрены ли все леммы и заканчивает второй цикл.
* Аргумент 1 - переменная '''id_lemmas'''
* Аргумент 2 - переменная '''count_lemmas'''
* Тип сравнения - >=
* Переход, если правда - компонент "'''->'''"
* Переход, если ложь - компонент "'''text'''"

Компонент "'''text'''". Определяет и сохраняет лемму в переменную для дальнейшего анализа.
* Документ - переменная '''response'''
* Алгоритм - Парсер JSON
* Поисковый запрос - выражение ''<nowiki>'"Morph"/'+[id_morph]+'/"Lemmas"/'+[id_lemmas]+'/"Text"'</nowiki>''
* Функция - Восстановленное содержимое
* Результат в переменную - переменная '''text''' (строковая)

[[Файл:Алгоритм распознавания - 005.png|center|800px]]

Компонент "'''Ув2'''". Отладочное уведомление администратору с выводом текущей леммы.
*Отладочный режим - Да
*Текст - переменная '''text'''
*Адресат - выберите вашего пользователя

Компонент "'''Выбор варианта'''". Проверяет является ли слово одним из ключевых. В случае совпадения выходит из цикла и направляет на нужную ветку.
* Аргумент - переменная '''text'''
* Значения - соотнесите ключевые слова с компонентами, на которые следует отправить сценарий. Например, по словам "секретарь", "директор" происходит переход на компонент "Секретарь"
ВНИМАНИЕ: Ключевые слова пишите с маленькой буквы.

Компонент "'''id_lemmas++'''". Если текущая лемма не является ключевым словом, то переходит к следующей лемме.
* переменной id_lemmas присваивается значение выражения ''num([id_lemmas])+1''

Компонент "'''Секретарь'''". Отладочное уведомление администратору с выводом выбранного направления.
*Отладочный режим - Да
*Текст - строка '''Секретарь'''
*Адресат - выберите вашего пользователя

Компонент "'''Сообщение 1'''". Воспроизводит абоненту, что соединяет его с секретарем.
* Режим - Воспроизвести
* Текст - Секретарь. Соединяю.
* Голос - Zahar
* Эмоция - по умолчанию
* Кэш - использовать

Компонент "'''на секретаря'''". Переключает на требуемого сотрудника.
* Назначение - Внутрь
* Номер - 601
* Тип вызова - Обычный

[[Файл:Алгоритм распознавания - 006.png|center|800px]]

Компоненты "'''Техподдержка'''", "'''Сообщение 2'''", "'''на техподдержку'''" настраиваются аналогично ветке "'''Секретарь'''" - "'''на секретаря'''".

Компонент "'''->'''". Визуальный элемент, служит для удобного восприятия сценария.
*Время задержки, мс - 0

Компонент "'''id_morph++'''". После того как текущая морфема проанализирована, переходит к следующей.

Компонент "'''Ув3'''". Отладочное уведомление администратору о том, что сервис не нашел ключевых слов во фразе.
*Отладочный режим - Да
*Текст - строка ''Не определил''
*Адресат - выберите вашего пользователя

Компонент "'''Неизвестная фраза'''". Воспроизводит абоненту сообщение, что не смог разобрать его фразу.
* Режим - Воспроизвести
* Текст - Я вас не понял, повторите еще раз пожалуйста
* Голос - Zahar
* Эмоция - по умолчанию
* Кэш - использовать

[[Файл:Алгоритм распознавания - 007.png|center|800px]]

Компонент "'''ding2'''". Воспроизводит короткий сигнал для абонента, соответствующий началу записи.
* Режим - Файл полностью
* Файл - ding.wav

ВНИМАНИЕ: Чтобы не зацикливать распознавание и тратить время клиента, вместо компонентов "Неизвестная фраза" и "ding2" рекомендуется переключить на секретаря. Как вариант, установить счетчик и по истечению двух-трех неудачных попыток распознавания переключать на ответственного оператора.

'''Скачать файл:''' [[Media:Yandex_SpeechKit_Cloud_%D1%83%D0%BB%D1%83%D1%87%D1%88%D0%B5%D0%BD%D0%BD%D1%8B%D0%B9_%D0%B0%D0%BB%D0%B3%D0%BE%D1%80%D0%B8%D1%82%D0%BC.oscr|Yandex_SpeechKit_Cloud_улучшенный_алгоритм.oscr]] (собрано на версии 2.11.2.141230)

Улучшенный алгоритм распознавания с помощью Yandex SpeechKit Cloud

2023-03-31T12:04:06Z

Oktell Support: /* Введение */

[[Практики|Наверх]]

__TOC__

==Введение==

В данной статье показывается пример улучшения анализа распознанной речи с помощью сервиса выделения смысла.

На данный момент анализ текста проводится в компоненте "'''Распознавание речи'''" с помощью свойства "Предопределенные значения". Это может быть неудобным для анализа длинных выражений, так как чтобы получить код группы должно быть полное совпадение распознанного выражения с одним из предопределенных. Например, чтобы соединиться с инженерами техподдержкой, клиент может сказать:
*''Соедините меня с отделом технической поддержки''
*''Переключите меня на инженеров''
*''Мне срочно нужны ваши программисты''
Очевидно, что одна и та же фраза может содержать существительные в разных падежах, иметь разную длину и предугадать все возможные комбинации почти невозможно. Отметим однако, что встроенные возможности компонента легко решают задачу распознавания одного слова.

Идея улучшения анализа заключается в применении сервиса выделения смысла. Сервис разбивает фразу на отдельные слова (леммы), преобразовывая существительные в именительный падеж, а глаголы в инфинитив. После этого сценарий в цикле просматривает каждую лемму и ищет совпадение с ключевым словом. В каком бы падеже не стояло искомое слово, если оно есть во фразе, алгоритм найдет его. Как только совпадение сработает происходит переключение на требуемый отдел.

'''Скачать файл:''' [[Media:Yandex_SpeechKit_Cloud_%D1%83%D0%BB%D1%83%D1%87%D1%88%D0%B5%D0%BD%D0%BD%D1%8B%D0%B9_%D0%B0%D0%BB%D0%B3%D0%BE%D1%80%D0%B8%D1%82%D0%BC.oscr|Yandex_SpeechKit_Cloud_улучшенный_алгоритм.oscr]] (собрано на версии 2.11.2.141230)

==Реализация сценария==

Рассмотрим алгоритм на примере сценария входящей маршрутизации. Позвонив в компанию, система спрашивает абонента с кем он хочет соединиться. Ответ клиента распознается, а дальше анализируется согласно вышеописанному алгоритму.

Сценарий выглядит следующим образом:

[[Файл:Алгоритм распознавания - 001.png|center]]

Компонент "'''API ключ'''". Определяет ключ для использования сервиса выделения смысла в web-запросе.
* переменной '''key''' (строковая) присвойте строку с вашим API-ключом.

Компонент "'''Приветствие'''". Воспроизводит приветствие и задает вопрос абоненту, с кем его соединить. Используется синтез речи Yandex.
* Режим - Воспроизвести
* Текст - Здравствуйте. С кем вас соединить
* Голос - Zahar
* Эмоция - по умолчанию
* Кэш - использовать

Компонент "'''ding'''". Воспроизводит короткий сигнал для абонента, соответствующий началу записи.
* Режим - Файл полностью
* Файл - ding.wav

ВНИМАНИЕ: Вместо компонентов "Приветствие" и "ding" вы можете использовать свой звуковой файл с записанной информацией. Синтез речи приведен в сценарии для примера.

[[Файл:Алгоритм распознавания - 002.png|center|800px]]

Компонент "'''Распознавание речи'''". Записывает и распознает речь абонента. После 1 секунды тишины воспроизводит ding.wav и переходит к следующему компоненту.
* Режим - Записать
* Символы прерывания - *
* Прервать при обнаружении тишины - Включить
* Интервал тишины, с - 1
* Настройки голосового детектора - по умолчанию
* Сигнал окончания записи - ding.wav
* Сохранение файла записи - Не сохранять
* Тема - queries
* Текст в переменную - переменная '''parse_bestText''' (строковая)

Компонент "'''Запрос на выделение смысла'''". Отправляет распознанный текст на сервис Yandex и получает размеченную JSON-структуру.
* URL - выражение
<nowiki>'https://vins-markup.voicetech.yandex.net/markup/0.x/?text='+[parse_bestText]+'&layers=Fio,Morph,GeoAddr&key='+[key]</nowiki>
* Метод - GET
* Режим работы - Обрыв по таймауту
* Таймаут, сек - 30
* Ответ в переменную - переменная '''response''' (строковая)

ВНИМАНИЕ: Если по истечению таймаута сервис Yandex не ответит на запрос произойдет обрыв связи. Вам нужно самостоятельно обработать этот момент.</span

Компонент "'''Ув1'''". Отладочное уведомление с выводом полученной JSON структуры.
*Отладочный режим - Да
*Текст - выражение:
'Текст '+[parse_bestText]+endline+'Смысл '+[response]
*Адресат - выберите вашего пользователя

Компонент "'''id_morph=0'''". Задает начальное значение для счетчика морфем.
* переменой id_morph (строковая) присваивается число 0

[[Файл:Алгоритм распознавания - 003.png|center|800px]]

Компонент "'''count_morph'''". Определяет число морфем в полученной JSON-структуре.
* Документ - переменная '''response'''
* Алгоритм - Парсер JSON
* Поисковый запрос - строка ''"Morph"''
* Функция - Количество элементов
* Результат в переменную - переменная '''count_morph''' (строковая)

Компонент "'''morph'''". Определяет рассмотрены ли все морфемы и заканчивает основной цикл.
* Аргумент 1 - переменная '''id_morph'''
* Аргумент 2 - переменная '''count_morph'''
* Тип сравнения - >=
* Переход, если правда - компонент "'''Ув3'''"
* Переход, если ложь - компонент "'''morph'''"

Компонент "'''count_lemmas'''". Определяет число лемм для выбранной морфемы. Это связано с тем, что сервис может прислать несколько лемм для одной морфемы, часто такая ситуация встречается с глаголами. Существительные, как показывает практика, имеют одну лемму. Теоретически, цикл по леммам можно убрать и брать самую первую, но это решение мы оставляем за администратором вашей системы.
* Документ - переменная '''response'''
* Алгоритм - Парсер JSON
* Поисковый запрос - выражение ''<nowiki>'"Morph"/'+[id_morph]+'/"Lemmas"'</nowiki>''
* Функция - Количество элементов
* Результат в переменную - переменная '''count_lemmas''' (строковая)

[[Файл:Алгоритм распознавания - 004.png|center|800px]]

Компонент "'''id_lemmas=0'''". Задает начальное значение для счетчика лемм.
* переменой id_lemmas (строковая) присваивается число 0

Компонент "'''lemmas'''". Проверяет пересмотрены ли все леммы и заканчивает второй цикл.
* Аргумент 1 - переменная '''id_lemmas'''
* Аргумент 2 - переменная '''count_lemmas'''
* Тип сравнения - >=
* Переход, если правда - компонент "'''->'''"
* Переход, если ложь - компонент "'''text'''"

Компонент "'''text'''". Определяет и сохраняет лемму в переменную для дальнейшего анализа.
* Документ - переменная '''response'''
* Алгоритм - Парсер JSON
* Поисковый запрос - выражение ''<nowiki>'"Morph"/'+[id_morph]+'/"Lemmas"/'+[id_lemmas]+'/"Text"'</nowiki>''
* Функция - Восстановленное содержимое
* Результат в переменную - переменная '''text''' (строковая)

[[Файл:Алгоритм распознавания - 005.png|center|800px]]

Компонент "'''Ув2'''". Отладочное уведомление администратору с выводом текущей леммы.
*Отладочный режим - Да
*Текст - переменная '''text'''
*Адресат - выберите вашего пользователя

Компонент "'''Выбор варианта'''". Проверяет является ли слово одним из ключевых. В случае совпадения выходит из цикла и направляет на нужную ветку.
* Аргумент - переменная '''text'''
* Значения - соотнесите ключевые слова с компонентами, на которые следует отправить сценарий. Например, по словам "секретарь", "директор" происходит переход на компонент "Секретарь"
ВНИМАНИЕ: Ключевые слова пишите с маленькой буквы.

Компонент "'''id_lemmas++'''". Если текущая лемма не является ключевым словом, то переходит к следующей лемме.
* переменной id_lemmas присваивается значение выражения ''num([id_lemmas])+1''

Компонент "'''Секретарь'''". Отладочное уведомление администратору с выводом выбранного направления.
*Отладочный режим - Да
*Текст - строка '''Секретарь'''
*Адресат - выберите вашего пользователя

Компонент "'''Сообщение 1'''". Воспроизводит абоненту, что соединяет его с секретарем.
* Режим - Воспроизвести
* Текст - Секретарь. Соединяю.
* Голос - Zahar
* Эмоция - по умолчанию
* Кэш - использовать

Компонент "'''на секретаря'''". Переключает на требуемого сотрудника.
* Назначение - Внутрь
* Номер - 601
* Тип вызова - Обычный

[[Файл:Алгоритм распознавания - 006.png|center|800px]]

Компоненты "'''Техподдержка'''", "'''Сообщение 2'''", "'''на техподдержку'''" настраиваются аналогично ветке "'''Секретарь'''" - "'''на секретаря'''".

Компонент "'''->'''". Визуальный элемент, служит для удобного восприятия сценария.
*Время задержки, мс - 0

Компонент "'''id_morph++'''". После того как текущая морфема проанализирована, переходит к следующей.

Компонент "'''Ув3'''". Отладочное уведомление администратору о том, что сервис не нашел ключевых слов во фразе.
*Отладочный режим - Да
*Текст - строка ''Не определил''
*Адресат - выберите вашего пользователя

Компонент "'''Неизвестная фраза'''". Воспроизводит абоненту сообщение, что не смог разобрать его фразу.
* Режим - Воспроизвести
* Текст - Я вас не понял, повторите еще раз пожалуйста
* Голос - Zahar
* Эмоция - по умолчанию
* Кэш - использовать

[[Файл:Алгоритм распознавания - 007.png|center|800px]]

Компонент "'''ding2'''". Воспроизводит короткий сигнал для абонента, соответствующий началу записи.
* Режим - Файл полностью
* Файл - ding.wav

ВНИМАНИЕ: Чтобы не зацикливать распознавание и тратить время клиента, вместо компонентов "Неизвестная фраза" и "ding2" рекомендуется переключить на секретаря. Как вариант, установить счетчик и по истечению двух-трех неудачных попыток распознавания переключать на ответственного оператора.

'''Скачать файл:''' [http://wiki.oktell.ru/images/2/2f/Yandex_SpeechKit_Cloud_%D1%83%D0%BB%D1%83%D1%87%D1%88%D0%B5%D0%BD%D0%BD%D1%8B%D0%B9_%D0%B0%D0%BB%D0%B3%D0%BE%D1%80%D0%B8%D1%82%D0%BC.oscr Yandex_SpeechKit_Cloud_улучшенный_алгоритм.oscr] (собрано на версии 2.11.2.141230)

Синтез речи на базе Yandex SpeechKit Cloud

2023-03-31T11:56:01Z

Oktell Support: /* Использование компонента */

[[Практики|Наверх]] <nowiki>[Oktell 2.7+]</nowiki>

__TOC__

==Введение==

[https://cloud.yandex.ru/services/speechkit '''Yandex SpeechKit '''] – сервис распознавания и синтеза речи платформы Яндекс.Облако, открывающий разработчикам доступ к речевым технологиям Яндекса. В этой статье мы поговорим про синтез речи.

Технология синтеза речи позволяет переводить текст в речь (звуковой файл). Задача актуальна для озвучивания динамически обновляемой информации или быстро меняющихся данных, таких как остаток товаров на складе, репертуар кинотеатров и так далее. Технология синтеза речи Яндекса построена на базе скрытых марковских моделей (HMM). За счет применения статистического подхода в акустическом моделировании удается достичь естественных плавных интонаций. Технология позволяет достаточно быстро создавать новые голоса и синтезировать различные эмоции.

Синтез речи Яндекса позволяет выбрать:
*мужской или женский голос для озвучивания;
*эмоции: добрый, злой, нейтральный голос.

Документация по API распознавания и синтеза речи Yandex SpeechKit доступна на сайте https://cloud.yandex.ru/docs/speechkit/

==Использование компонента==

Начиная с версии Oktell 2.12, в служебных и IVR сценариях появился компонент "Синтез речи". Компонент озвучивает заданную фразу (синтезирует речь) с помощью сервиса Yandex SpeechKit. Позволяет сразу воспроизвести файл в линию, либо сгенерировать файл для последующего использования. В компоненте можно включить кэш, тем самым сохраняя все сгенерированные файлы в папку \Oktell\Server\LocalStorage\SynthesisCache. Так как каждый запрос к сервису Яндекс платный, то включенный кэш позволяет сэкономить ваши средства.

Техническая документация по компоненту: [[Компоненты_сценариев_IVR#.D0.A1.D0.B8.D0.BD.D1.82.D0.B5.D0.B7_.D1.80.D0.B5.D1.87.D0.B8|Синтез речи]]

Для использования системы синтеза речи Yandex SpeechKit выполните следующие действия:

'''Шаг 1.''' Получить авторизационные данные на использование сервиса Yandex SpeechKit.
* Выполните шаги 1-5 [https://cloud.yandex.ru/docs/speechkit/concepts/auth инструкции] по авторизации в API для получения идентификатора каталога
* [https://passport.yandex.ru/auth Войдите] в ваш аккаунт на Яндексе или Яндекс.Коннекте
* Получите OAuth-токен в сервисе Яндекс.OAuth. Для этого перейдите по [https://oauth.yandex.ru/authorize?response_type=token&client_id=1a6990aa636648e9b2ef855fa7bec2fb ссылке], нажмите '''Разрешить''' и скопируйте полученный OAuth-токен.

'''Шаг 2.''' Перейдите в '''Администрирование''' / '''Общие настройки''' / '''Распознавание речи Yandex SpeechKit Cloud'''. Введите полученные значения '''OAuth-токен''' и '''Идентификатор каталога''' в соответствующие поля

[[Файл:Yandex ASR Cloud 001.png|center|600px]]

Нажмите "'''Сохранить'''". Теперь вы можете использовать синтез речи в сценариях.

'''Шаг 3'''. Рассмотрим пример использования синтеза речи в IVR сценарии.

[[Файл:Синтез речи 001.png|center]]

Компонент "'''Синтез речи'''". Озвучивает приветствие абоненту и сохраняет выбор абонента в переменную.
*Режим — Воспроизвести. В этом режиме компонент сразу воспроизводит сгенерированный файл в текущую линию.
*Текст — строка "''Здравствуйте! Вас приветствует компания Телефонные Системы! Для соединения с менеджерами нажмите 1. Для соединения с сотрудниками технической поддержки нажмите 2.''". Введенный текст будет передан на сервера Yandex для озвучивания.
*Голос — Zahar. Настройка отвечает за синтезируемый голос: Zahar - мужской голос, Jane -женский. Возможно указание другого значения, если оно поддерживается сервисом Yandex SpeechKit.
*Эмоция — По умолчанию. Настройка отвечает за используемую окраску голоса. Возможные варианты: good, neutral, evil, mixed.
*Кэш — Использовать. Если использовать кэш, то система попытается найти файл с озвученным текстом среди сгенерированных ранее (находятся в папке \Oktell\Server\LocalStorage\SynthesisCache). Рекомендуется всегда включать в целях экономии средств.
*Таймаут ожидания ответа, с — 5. Максимальное время ожидания ответа от серверов Яндекс.
*Символы прерывания — строка "''1, 2''". Если абонент нажмет на указанные символы прерывания, компонент сохранит их в буфер и перейдет к следующему блоку.
*Буфер для DTMF — переменная '''ввод''' (строковая). Переменная, в которую сохранится введенный символ прерывания.
*Очистить буфер — Да. Указывает на то, что буфер предварительно будет очищен.

Компонент "'''Меню'''". Маршрутизирует абонента на выбранную группу операторов.
*Аргумент — переменная '''Ввод'''
*Значения —
: 1 — на компонент "Переключение 1"
: 2, прочее - на компонент "Переключение 2"

Настройка дальнейшей маршрутизации не рассматривается.

Чтобы использовать синтез речи для преднабора необходимо вначале сгенерировать файл с помощью компонента "Синтез речи" и сохранить путь к этому файлу в переменную (в соответствующем свойстве). Далее указать этот файл в компоненте "Воспроизведение с преднабором".

Синтез речи на базе Yandex SpeechKit Cloud

2023-03-31T11:55:34Z

Oktell Support: /* Использование компонента */

[[Практики|Наверх]] <nowiki>[Oktell 2.7+]</nowiki>

__TOC__

==Введение==

[https://cloud.yandex.ru/services/speechkit '''Yandex SpeechKit '''] – сервис распознавания и синтеза речи платформы Яндекс.Облако, открывающий разработчикам доступ к речевым технологиям Яндекса. В этой статье мы поговорим про синтез речи.

Технология синтеза речи позволяет переводить текст в речь (звуковой файл). Задача актуальна для озвучивания динамически обновляемой информации или быстро меняющихся данных, таких как остаток товаров на складе, репертуар кинотеатров и так далее. Технология синтеза речи Яндекса построена на базе скрытых марковских моделей (HMM). За счет применения статистического подхода в акустическом моделировании удается достичь естественных плавных интонаций. Технология позволяет достаточно быстро создавать новые голоса и синтезировать различные эмоции.

Синтез речи Яндекса позволяет выбрать:
*мужской или женский голос для озвучивания;
*эмоции: добрый, злой, нейтральный голос.

Документация по API распознавания и синтеза речи Yandex SpeechKit доступна на сайте https://cloud.yandex.ru/docs/speechkit/

==Использование компонента==

Начиная с версии Oktell 2.12, в служебных и IVR сценариях появился компонент "Синтез речи". Компонент озвучивает заданную фразу (синтезирует речь) с помощью сервиса Yandex SpeechKit. Позволяет сразу воспроизвести файл в линию, либо сгенерировать файл для последующего использования. В компоненте можно включить кэш, тем самым сохраняя все сгенерированные файлы в папку \Oktell\Server\LocalStorage\SynthesisCache. Так как каждый запрос к сервису Яндекс платный, то включенный кэш позволяет сэкономить ваши средства.

Техническая документация по компоненту: [[Компоненты_сценариев_IVR#.D0.A1.D0.B8.D0.BD.D1.82.D0.B5.D0.B7_.D1.80.D0.B5.D1.87.D0.B8|Синтез_речи]]

Для использования системы синтеза речи Yandex SpeechKit выполните следующие действия:

'''Шаг 1.''' Получить авторизационные данные на использование сервиса Yandex SpeechKit.
* Выполните шаги 1-5 [https://cloud.yandex.ru/docs/speechkit/concepts/auth инструкции] по авторизации в API для получения идентификатора каталога
* [https://passport.yandex.ru/auth Войдите] в ваш аккаунт на Яндексе или Яндекс.Коннекте
* Получите OAuth-токен в сервисе Яндекс.OAuth. Для этого перейдите по [https://oauth.yandex.ru/authorize?response_type=token&client_id=1a6990aa636648e9b2ef855fa7bec2fb ссылке], нажмите '''Разрешить''' и скопируйте полученный OAuth-токен.

'''Шаг 2.''' Перейдите в '''Администрирование''' / '''Общие настройки''' / '''Распознавание речи Yandex SpeechKit Cloud'''. Введите полученные значения '''OAuth-токен''' и '''Идентификатор каталога''' в соответствующие поля

[[Файл:Yandex ASR Cloud 001.png|center|600px]]

Нажмите "'''Сохранить'''". Теперь вы можете использовать синтез речи в сценариях.

'''Шаг 3'''. Рассмотрим пример использования синтеза речи в IVR сценарии.

[[Файл:Синтез речи 001.png|center]]

Компонент "'''Синтез речи'''". Озвучивает приветствие абоненту и сохраняет выбор абонента в переменную.
*Режим — Воспроизвести. В этом режиме компонент сразу воспроизводит сгенерированный файл в текущую линию.
*Текст — строка "''Здравствуйте! Вас приветствует компания Телефонные Системы! Для соединения с менеджерами нажмите 1. Для соединения с сотрудниками технической поддержки нажмите 2.''". Введенный текст будет передан на сервера Yandex для озвучивания.
*Голос — Zahar. Настройка отвечает за синтезируемый голос: Zahar - мужской голос, Jane -женский. Возможно указание другого значения, если оно поддерживается сервисом Yandex SpeechKit.
*Эмоция — По умолчанию. Настройка отвечает за используемую окраску голоса. Возможные варианты: good, neutral, evil, mixed.
*Кэш — Использовать. Если использовать кэш, то система попытается найти файл с озвученным текстом среди сгенерированных ранее (находятся в папке \Oktell\Server\LocalStorage\SynthesisCache). Рекомендуется всегда включать в целях экономии средств.
*Таймаут ожидания ответа, с — 5. Максимальное время ожидания ответа от серверов Яндекс.
*Символы прерывания — строка "''1, 2''". Если абонент нажмет на указанные символы прерывания, компонент сохранит их в буфер и перейдет к следующему блоку.
*Буфер для DTMF — переменная '''ввод''' (строковая). Переменная, в которую сохранится введенный символ прерывания.
*Очистить буфер — Да. Указывает на то, что буфер предварительно будет очищен.

Компонент "'''Меню'''". Маршрутизирует абонента на выбранную группу операторов.
*Аргумент — переменная '''Ввод'''
*Значения —
: 1 — на компонент "Переключение 1"
: 2, прочее - на компонент "Переключение 2"

Настройка дальнейшей маршрутизации не рассматривается.

Чтобы использовать синтез речи для преднабора необходимо вначале сгенерировать файл с помощью компонента "Синтез речи" и сохранить путь к этому файлу в переменную (в соответствующем свойстве). Далее указать этот файл в компоненте "Воспроизведение с преднабором".

Синтез речи на базе Yandex SpeechKit Cloud

2023-03-31T11:52:05Z

Oktell Support: /* Использование компонента */

[[Практики|Наверх]] <nowiki>[Oktell 2.7+]</nowiki>

__TOC__

==Введение==

[https://cloud.yandex.ru/services/speechkit '''Yandex SpeechKit '''] – сервис распознавания и синтеза речи платформы Яндекс.Облако, открывающий разработчикам доступ к речевым технологиям Яндекса. В этой статье мы поговорим про синтез речи.

Технология синтеза речи позволяет переводить текст в речь (звуковой файл). Задача актуальна для озвучивания динамически обновляемой информации или быстро меняющихся данных, таких как остаток товаров на складе, репертуар кинотеатров и так далее. Технология синтеза речи Яндекса построена на базе скрытых марковских моделей (HMM). За счет применения статистического подхода в акустическом моделировании удается достичь естественных плавных интонаций. Технология позволяет достаточно быстро создавать новые голоса и синтезировать различные эмоции.

Синтез речи Яндекса позволяет выбрать:
*мужской или женский голос для озвучивания;
*эмоции: добрый, злой, нейтральный голос.

Документация по API распознавания и синтеза речи Yandex SpeechKit доступна на сайте https://cloud.yandex.ru/docs/speechkit/

==Использование компонента==

Начиная с версии Oktell 2.12, в служебных и IVR сценариях появился компонент "Синтез речи". Компонент озвучивает заданную фразу (синтезирует речь) с помощью сервиса Yandex SpeechKit. Позволяет сразу воспроизвести файл в линию, либо сгенерировать файл для последующего использования. В компоненте можно включить кэш, тем самым сохраняя все сгенерированные файлы в папку \Oktell\Server\LocalStorage\SynthesisCache. Так как каждый запрос к сервису Яндекс платный, то включенный кэш позволяет сэкономить ваши средства.

Техническая документация по компоненту: [Компоненты_сценариев_IVR#.D0.A1.D0.B8.D0.BD.D1.82.D0.B5.D0.B7_.D1.80.D0.B5.D1.87.D0.B8 Синтез_речи]

Для использования системы синтеза речи Yandex SpeechKit выполните следующие действия:

'''Шаг 1.''' Получить авторизационные данные на использование сервиса Yandex SpeechKit.
* Выполните шаги 1-5 [https://cloud.yandex.ru/docs/speechkit/concepts/auth инструкции] по авторизации в API для получения идентификатора каталога
* [https://passport.yandex.ru/auth Войдите] в ваш аккаунт на Яндексе или Яндекс.Коннекте
* Получите OAuth-токен в сервисе Яндекс.OAuth. Для этого перейдите по [https://oauth.yandex.ru/authorize?response_type=token&client_id=1a6990aa636648e9b2ef855fa7bec2fb ссылке], нажмите '''Разрешить''' и скопируйте полученный OAuth-токен.

'''Шаг 2.''' Перейдите в '''Администрирование''' / '''Общие настройки''' / '''Распознавание речи Yandex SpeechKit Cloud'''. Введите полученные значения '''OAuth-токен''' и '''Идентификатор каталога''' в соответствующие поля

[[Файл:Yandex ASR Cloud 001.png|center|600px]]

Нажмите "'''Сохранить'''". Теперь вы можете использовать синтез речи в сценариях.

'''Шаг 3'''. Рассмотрим пример использования синтеза речи в IVR сценарии.

[[Файл:Синтез речи 001.png|center]]

Компонент "'''Синтез речи'''". Озвучивает приветствие абоненту и сохраняет выбор абонента в переменную.
*Режим — Воспроизвести. В этом режиме компонент сразу воспроизводит сгенерированный файл в текущую линию.
*Текст — строка "''Здравствуйте! Вас приветствует компания Телефонные Системы! Для соединения с менеджерами нажмите 1. Для соединения с сотрудниками технической поддержки нажмите 2.''". Введенный текст будет передан на сервера Yandex для озвучивания.
*Голос — Zahar. Настройка отвечает за синтезируемый голос: Zahar - мужской голос, Jane -женский. Возможно указание другого значения, если оно поддерживается сервисом Yandex SpeechKit.
*Эмоция — По умолчанию. Настройка отвечает за используемую окраску голоса. Возможные варианты: good, neutral, evil, mixed.
*Кэш — Использовать. Если использовать кэш, то система попытается найти файл с озвученным текстом среди сгенерированных ранее (находятся в папке \Oktell\Server\LocalStorage\SynthesisCache). Рекомендуется всегда включать в целях экономии средств.
*Таймаут ожидания ответа, с — 5. Максимальное время ожидания ответа от серверов Яндекс.
*Символы прерывания — строка "''1, 2''". Если абонент нажмет на указанные символы прерывания, компонент сохранит их в буфер и перейдет к следующему блоку.
*Буфер для DTMF — переменная '''ввод''' (строковая). Переменная, в которую сохранится введенный символ прерывания.
*Очистить буфер — Да. Указывает на то, что буфер предварительно будет очищен.

Компонент "'''Меню'''". Маршрутизирует абонента на выбранную группу операторов.
*Аргумент — переменная '''Ввод'''
*Значения —
: 1 — на компонент "Переключение 1"
: 2, прочее - на компонент "Переключение 2"

Настройка дальнейшей маршрутизации не рассматривается.

Чтобы использовать синтез речи для преднабора необходимо вначале сгенерировать файл с помощью компонента "Синтез речи" и сохранить путь к этому файлу в переменную (в соответствующем свойстве). Далее указать этот файл в компоненте "Воспроизведение с преднабором".

Определение момента переключения на сотрудника во время перевода звонка

2023-03-31T11:51:10Z

Oktell Support: /* Служебный сценарий определения момента переключения */

[[Практики|Наверх]]

__TOC__

==Введение==

Представим ситуацию, когда абонент А просит оператора Б переключить его на другого сотрудника В. Например, клиент, разговаривая с менеджером по продажам, хочет обсудить технический вопрос с инженерами технической поддержки. Менеджер по продажам может переключить абонента сразу напрямую (выполнить Transfer-переключение, неконсультативный перевод) или предварительно предупредить инженера о переводе (консультативный перевод). В каждом из этих случаев стоит задача воспроизвести в коммутацию сообщение "''Вы переключены на сотрудника''", как только установилось успешное соединение.

Такое звуковое сообщение помогает, во-первых, соориентировать клиента, что его звонок успешно переведен. Во-вторых, часто при переводе звонка принимающая сторона, в нашем случае инженер, не слышит как менеджер положил трубку, и не может понять переключили на него или еще нет. Звуковое сообщение в коммутацию облегчает сложившуюся ситуацию.

==Установка готовых сценариев в систему==

'''1.''' Скачайте и импортируйте сценарии:
* [[Media:%D0%9E%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5_%D0%BC%D0%BE%D0%BC%D0%B5%D0%BD%D1%82%D0%B0_%D0%BF%D0%B5%D1%80%D0%B5%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D1%8F.oscr|Определение момента переключения.oscr]] ''(собрано на версии 2.11.2.141125)''

*[[Media:%D0%9E%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5_%D0%BC%D0%BE%D0%BC%D0%B5%D0%BD%D1%82%D0%B0_%D0%BF%D0%B5%D1%80%D0%B5%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%28%D1%81%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D1%8B%D0%B9%29.oscr|Определение момента переключения (служебный).oscr]] ''(собрано на версии 2.11.2.141125)''

'''2.''' Настройте внешние линии в сценарии переключения "'''Определение момента переключения'''".

'''3.''' Назначьте сценарии в качестве системных сценариев переключения. Смотрите пункт [[Определение момента переключения на сотрудника во время перевода звонка#Назначение сценария переключения | Назначение сценария переключения]]

==Реализация сценария==

Для определенности введем следующие понятия: А - переключаемый клиент, Б - переключающий оператор, В - пользователь, на которого переводят звонок.

Основная идея алгоритма - запустить служебный сценарий, после того как сотрудник В возьмет трубку. Этот служебный сценарий в асинхронном режиме проверяет состояние переключения и после переключения клиента А на сотрудника В запускает воспроизведение файла в коммутацию. Все номера линий участвующие в переключении собираются в IVR сценарии переключения и передаются служебному сценарию на вход.

===Модификация IVR сценария переключения===

Модификация сценария заключается в сборе данных о линиях, участвующих в переводе звонка и запуске служебного сценария. Модифицированный сценарий выглядит следующим образом:

[[Файл:Определение момент переключения-002.png|center]]

'''1. Правка входного каскада.'''

Компонент "'''Старт 1'''". Во время Sip-transfer переключения получает номер, на который выполнен перевод звонка. Во время обычного переключения на вход ничего не передается.
* Параметр запуска - переменная "'''Номер'''" (строковая)

Компонент "'''Режим Flash'''". Присваивает служебной переменной "'''(сл) Режим Flash'''" - число '''1'''. Таким образом, если оператор Б положит трубку во время дозвона до сотрудника В, клиент А заменит его и самостоятельно будет ожидать соединения.

Компонент "'''Параметр запуска пусто?'''". Определяет передался ли номер на вход сценария во время SIP-transfer переключения.
* Аргумент 1 - переменная "'''Номер'''"
* Аргумент 2 - пустая строка
* Тип сравнения - "'''='''"
* Переход, правда - компонент "'''НОМЕР=CallerID'''".
* Переход, ложь - компонент "'''Пауза 1'''". Таким образом, номер отправляется сразу в набор.

[[Файл:Определение момент переключения-004.png |center]]

Компоненты "'''Номер=CallerID'''", "'''Номер пусто?'''" и все компоненты блока сборки номера (выделен зеленым) не изменяются.

Обратите внимание, что ветка по таймауту компонента "'''+1 цифра'''" в сценарии переведена на компонент "'''Пауза 1'''".

'''2.''' Компонент "'''Определение линий'''". Сохраняет номер линии абонента А (переключаемого, линия буфера) и линии пользователя Б (переключающего) в соответствующие переменные.
* Переменной "'''ЛинияБуфера'''" (строковая) присваивается значение функции "'''Номер линии, ожидающей во Flash-буфере'''".
* Переменной "'''ЛинияПользователя'''" (строковая) присваивается значение функции "'''Номер линии'''"

[[Файл:Определение момент переключения-005.png |center]]

'''3. Запуск служебного сценария'''. Блок определяет линию сотрудника В, записывает ее в переменную, а затем передает все три найденные линии (А, Б, В) на вход служебного сценария.

В зависимости от типа набранного номера отрабатывают те или иные компоненты. Для внешнего номера:

Компонент "'''ВНЕШНИЕ'''". Если переключают на внешний номер, то необходимо сохранить выбранную линию в переменную.
* Номер - переменная "'''Номер'''".
* Тип вызова - Обычный
* Направления - выберите направления для вызова
* Идентификатор выбранной линии - переменная "ЛинияПереключения" (строковая)
* Коммутировать сразу - Нет, прослушивать медиа-поток".

Компонент "'''Линия переключения'''". Определяет номер линии по ее идентификатору и сохраняет его в ту же переменную.
* Действие - Определить
* Тип объекта - Линия
* Ключ линии - переменная "'''ЛинияПереключения'''"
* Функция - Номер линии
* Значение в переменную - переменная "'''ЛинияПереключения'''"

Для внутреннего номера:

Компонент "'''ВНУТРЕННИЕ'''". Остается без изменения.
* Назначение - Внутрь
* Номер - переменная "'''Номер'''"
* Тип вызова - Обычный

[[Файл:Определение момент переключения-006.png |center]]

Компонент "'''Пауза 200мс'''". Необходим для корректной отработки переключения и записи всех значений в базу данных.
* Время задержки, мс - 200

Компонент "'''Линия переключения (2)'''". По номеру активной линии, определяет номер скоммутированной линии. Активной линией будет линия пользователя Б, если он ожидал соединения сотрудника В и тот взял трубку. Если пользователь Б, бросил трубку, то активной линией будет линия клиента А.
* Действие - Определить
* Тип объекта - Линия
* Ключ линии - функция "'''Номер линии'''"
* Функция - Номер скоммутированной линии/конференции
* Значение в переменную - переменная '''ЛинияПереключения'''

Компонент "'''XML'''". Для передачи трех значений в служебный сценарий, компонент объединяет их в единую XML структуру. Такой прием часто используется для передачи нескольких значений в качестве одного параметра запуска.
* Переменной "'''XML'''" (строковая) присваивается выражение
<pre>'<bufferLine>'+[ЛинияБуфера]+'</bufferLine>'+endline+
'<switchingLine>'+[ЛинияПереключения]+'</switchingLine>'+endline+
'<userLine>'+[ЛинияПользователя]+'</userLine>'</pre>
ВНИМАНИЕ: Можно и не использовать объединение переменных в XML, а передавать их как сессионные, однако удостоверьтесь, что у вас уже не используется одноименные переменные в других пересекающихся сценариях.

[[Файл:Определение момент переключения-007.png |center]]

Компонент "'''Ув1'''". Отладочное уведомления для вывода XML структуры.
* Отладочный режим - Да
* Текст - переменная "'''XML'''"
* Адресат - выберите администрирующего пользователя.

Компонент "'''Запуск сценария'''". Запускает асинхронный сценарий, который будет проверять соединение линии клиента А и сотрудника В.
* Тип запуска - Асинхронный служебный
* Режим выбора сценария - Из списка
* Сценарий - Определение момента переключения (служебный)
* Параметр запуска - переменная "'''XML'''"

[[Файл:Определение момент переключения-008.png |center]]

===Служебный сценарий определения момента переключения===

Служебный сценарий мониторит состояние линии А и определяет итог переключения. Сценарий выглядит следующим образом:

[[Файл:Определение момент переключения-001.png]]

Компонент "'''Старт 1'''". Получает переданную XML-структуру на вход сценария и записывает ее в переменную XML.
* Параметр запуска - переменная "'''XML'''" (строковая)

Компонент "'''Ув XML'''". Отладочное уведомление для вывода полученной XML.
* Отладочный режим - Да
* Текст - переменная "'''XML'''"
* Адресат - выберите администрирующего пользователя.

Компонент "'''Линия буфера'''". Выделяет линию буфера (клиента А) из XML-структуры.
* Документ - переменная "'''XML'''"
* Алгоритм - Язык OQuery для HTML
* Поисковый запрос - строка ''bufferLine''
* Функция - Содержимое
* Номер элемента - 0
* Результат в переменную - переменная "'''ЛинияБуфера'''" (строковая)

Компонент "'''Линия переключения'''". Выделяет линию сотрудника В, на которого переключают звонок, из XML-структуры.
* Документ - переменная "'''XML'''"
* Алгоритм - Язык OQuery для HTML
* Поисковый запрос - строка ''switchingLine''
* Функция - Содержимое
* Номер элемента - 0
* Результат в переменную - переменная "'''ЛинияПереключения'''" (строковая)

[[Файл:Определение момент переключения-009.png |center]]

Компонент "'''Линия пользователя'''". Выделяет линию переключающего сотрудника Б из XML-структуры.
* Документ - переменная "'''XML'''"
* Алгоритм - Язык OQuery для HTML
* Поисковый запрос - строка ''userLine''
* Функция - Содержимое
* Номер элемента - 0
* Результат в переменную - переменная "'''ЛинияПользователя'''" (строковая)

Компонент "'''Трансфер?'''". Определяет произошло ли трансфер-переключение. Если это так, то линия буфера будет пустая, вследствие того, что она была активной и содержится в переменной "'''ЛинияПользователя'''".
* Аргумент 1 - переменная "'''ЛинияБуфера'''"
* Аргумент 2 - пустая строка
* Тип сравнения - "'''='''"
* Переход, если правда - компонент "'''Трансфер'''"
* Переход, если ложь - компонент "'''Скоммутированная с буфером'''"

----
''Случай обычного переключения''
----

Компонент "'''Скоммутированная с буфером'''". Определяет номер скоммутированной линии с линией буфера (клиента А). В зависимости от того, какую линию вернет компонент, будет решаться соединилась ли линия буфера с пользователем В или вернулась обратно.
* Действие - Определить
* Тип объекта - Линия
* Ключ линии - переменная "'''ЛинияБуфера'''"
* Функция - Номер скоммутированной линии/конференции
* Значение в переменную - переменная "'''СкоммутированнаяСБуфером'''" (строковая)

[[Файл:Определение момент переключения-010.png |center]]

Компонент "'''Ув1'''". Отладочное уведомление для вывода номеров участвующих линий, а также линии, которая скоммутирована с буфером.
* Отладочный режим - Да
* Текст - выражение
<pre>'[ЛинияБуфера] '+[ЛинияБуфера]+endline+
'[ЛинияПереключения] '+[ЛинияПереключения]+endline+
'[ЛинияПользователя] '+[ЛинияПользователя]+endline+endline+
'[СкоммутированнаяСБуфером] '+[СкоммутированнаяСБуфером]</pre>
* Адресат - выберите администрирующего пользователя.

Компонент "'''Буфер не скоммутирован?'''". Определяет скоммутирована ли линия буфера. Если переменная "'''СкоммутированнаяСБуфером'''" равна "'''-1'''", значит линия пока не скоммутирована.
* Аргумент 1 - переменная "'''СкоммутированнаяСБуфером'''"
* Аргумент 2 - число "'''-1'''"
* Тип сравнения - "'''='''"
* Переход, если правда" - компонент "'''IdChain'''"
* Переход, если ложь - "'''Буфер переключился?'''". Переход отрабатывает, если линия буфера соединена с какой-либо другой линией.

Компонент "'''IdChain'''". Если линия пока не скоммутирована, есть вероятность, что она разорвала связь. Такое бывает в условиях плохого соединения, например клиент зашел в метро, или клиент просто повесил трубку в следствие долгого ожидания. Чтобы определить это, нам потребуется знать идентификатор цепочки коммутаций.
* Действие - Определить
* Тип объекта - Линия
* Ключ линии - переменная "'''ЛинияБуфера'''"
* Функция - Идентификатор цепочки коммутаций
* Значение в переменную - переменная "'''idChainuser'''" (строковая)

Компонент "'''Ув2'''". Отладочное уведомление для вывода Id цепочки коммутаций.
* Отладочный режим - Да
* Текст - переменная "'''idChainuser'''"
* Адресат - выберите администрирующего пользователя.

Компонент "'''Обрыв внешней линии'''". Если Id цепочки коммутаций равен "''00000000-0000-0000-0000-000000000000''", значит на данный момент активной коммутации на линии нет, то есть соединение с клиентом оборвалось.
* Аргумент 1 - переменная "'''idChainuser'''"
* Аргумент 2 - строка "''00000000-0000-0000-0000-000000000000''"
* Тип сравнения - "'''='''"
* Переход, если правда" - компонент "'''Линия повесила трубку'''"
* Переход, если ложь - "'''Пока линия не скоммутирована'''".

[[Файл:Определение момент переключения-011.png |center]]

Компонент "'''Линия повесила трубку'''". Отладочное уведомление, о том, что линия повесила трубку.
* Отладочный режим - Нет. После успешных тестов можно выставить Да.
* Текст - строка ''Внешняя линия повесила трубку''
* Адресат - выберите администрирующего пользователя.

Компонент "'''Пока линия не скоммутирована'''". Отладочное уведомление, о том, что линия пока ни с кем не скоммутирована.
* Отладочный режим - Да
* Текст - строка ''Линия пока не скоммутирована''
* Адресат - выберите администрирующего пользователя.

Компонент "'''Буфер переключился?'''". Если линия буфера соединена с какой-либо линией, то компонент проверяет соединена ли линия буфера с линией сотрудника, на которого переключали.
* Аргумент 1 - переменная "'''СкоммутированнаяСБуфером'''"
* Аргумент 2 - переменная "'''ЛинияПереключения'''"
* Тип сравнения - "'''='''"
* Переход, если правда - компонент "'''Линии скоммутированы'''"
* Переход, если ложь - компонент "'''Линия вернулась?'''"

Компонент "'''Линия скоммутированы'''". Уведомляет администратора, что линии А и В скоммутировались.
* Отладочный режим - Нет. После успешных тестов можно выставить Да.
* Текст - строка ''Линии успешно скоммутировались''
* Адресат - выберите администрирующего пользователя.

Компонент "'''Воспроизведение файла'''". Воспроизводит в коммутацию звуковой файл "''Вы переключены на сотрудника''", уведомляя обе стороны об успешном переключении.
* Действие - Установить
* Тип объекта - Линия
* Ключ линии - переменная "'''ЛинияБуфера'''"
* Свойство/действие - Воспроизвести файл в коммутацию/конференцию
* Звуковой файл - выберите файл "''Вы переключены на сотрудника.mp3''"
* Значение - 0. Означает полную громкость воспроизведения.

Компонент "'''Линия вернулась?'''". Линия буфера может быть скоммутирована с линией переключающего Б. В этом случае, мы делаем вывод, что линия вернулась обратно переключающему. Это могло произойти, после того, как Б и В поговорили, но первым положил трубку В. Тогда А соединяется обратно с Б.
* Аргумент 1 - переменная "'''СкоммутированнаяСБуфером'''"
* Аргумент 2 - переменная "'''ЛинияПользователя'''"
* Тип сравнения - "'''='''"
* Переход, если правда - компонент "'''Возврат буфера'''"
* Переход, если ложь - компонент "'''Пока линия не скоммутирована'''".
ВНИМАНИЕ: Фактически, этот переход может произойти только вследствие ошибочной логики, поэтому обратите на него внимание во время отладки. Имеет смысл, убрать переход или поставить уведомление.

[[Файл:Определение момент переключения-012.png |center]]

Компонент "'''Возврат буфера'''".
* Отладочный режим - Нет. После успешных тестов можно выставить Да.
* Текст - строка ''Линия вернулась обратно''
* Адресат - выберите администрирующего пользователя.

Компонент "'''500мс'''". Если линия пока не соединена, компонент осуществляет задержку перед следующей итерацией анализа состояния линий. Эта задержка по сути является разрешающей способностью сценария. Если выставить слишком много - возможны перекрестные ошибки, если выставить мало - система будет сильно нагружаться. Вам следует поэкспериментировать с этим значением. Во время тестов было использовано значение 500 мс.
* Время задержки, мс - 500

----
'''''SIP-трансфер переключение.''' Отличие этого блока от предыдущего в том, что линия переключаемого клиента А будет располагаться в переменной "ЛинияПользователя", так как в сценарии переключения именно она была активной.''
----

Компонент "'''Трансфер'''".
* Отладочный режим - Нет. После успешных тестов можно выставить Да.
* Текст - строка ''ТРАНСФЕР''
* Адресат - выберите администрирующего пользователя.

Компонент "'''Скоммутированная с буфером 2'''". Определяет номер скоммутированной линии с линией клиента А. В зависимости от того, какую линию вернет компонент, будет решаться соединилась ли линия буфера с пользователем В или нет.
* Действие - Определить
* Тип объекта - Линия
* Ключ линии - переменная "'''ЛинияПользователя'''"
* Функция - Номер скоммутированной линии/конференции
* Значение в переменную - переменная "'''СкоммутированнаяСБуфером'''"

Компонент "'''Произошло соединение?'''". Определяет произошло ли соединение линии клиента А и пользователя В.
* Аргумент 1 - переменная "'''СкоммутированнаяСБуфером'''"
* Аргумент 2 - переменная "'''ЛинияПользователя'''"
* Тип сравнения - "'''='''"
* Переход, если правда - компонент "'''Линии соединены'''"
* Переход, если ложь - компонент "'''Пауза2'''".
ВНИМАНИЕ: Переход по ветке "Ложь" является некорректным и может произойти только вследствие системной ошибки или высокой загрузки процессора. Если этот переход выполнился, то вам следует обратить на это пристальное внимание.

Компонент "'''Линии соединены'''".
* Отладочный режим - Нет. После успешных тестов можно выставить Да.
* Текст - строка ''Линии успешно скоммутировались''
* Адресат - выберите администрирующего пользователя.

Компонент "'''Воспроизведение файла 2'''". Воспроизводит в коммутацию звуковой файл "''Вы переключены на сотрудника''", уведомляя обе стороны об успешном переключении.
* Действие - Установить
* Тип объекта - Линия
* Ключ линии - переменная "'''ЛинияПользователя'''"
* Свойство/действие - Воспроизвести файл в коммутацию/конференцию
* Звуковой файл - выберите файл "''Вы переключены на сотрудника.mp3''"
* Значение - 0. Означает полную громкость воспроизведения.

[[Файл:Определение момент переключения-013.png |center]]

Компонент "'''Пауза 2'''". Переход на этот компонент, если переходные процессы заняли длительное время (большая загрузка процессора). В этом случае мы установили дополнительную задержку 200 мс для завершения всех переходных процессов.
* Время задержки, мс - 200

Компонент "'''Линия не соединилась'''". Если линия пока не соединилась с линией сотрудника В, то ее состояние должно быть равно "'''-1'''". Если это не так, то произошла ошибочная ситуация.
* Аргумент 1 - переменная "'''СкоммутированнаяСБуфером'''"
* Аргумент 2 - число"'''-1'''"
* Тип сравнения - "'''='''"
* Переход, если правда - компонент "'''IdChain 2'''"
* Переход, если ложь - компонент "'''Неизвестная ситуация'''"

Компонент "'''Неизвестная ситуация'''". Уведомляет, что произошла неизвестная ситуация во время трансфер-переключения. Линия во время sip-трансфер переключения внезапно соединилась с другой линией, и следует подробно выяснить как такое могло произойти.
* Отладочный режим - Нет. После успешных тестов можно выставить Да.
* Текст - строка ''Неизвестная ситуация''
* Адресат - выберите администрирующего пользователя.

Компонент "'''IdChain 2'''". Если линия клиента А не соединилась с линией пользователя В, то есть вероятность, что мог произойти обрыв связи. Проверить это поможет идентификатор цепочки коммутаций.
* Действие - Определить
* Тип объекта - Линия
* Ключ линии - переменная "'''ЛинияПользователя'''"
* Функция - Идентификатор цепочки коммутаций
* Значение в переменную - переменная "'''idChainuser'''"

[[Файл:Определение момент переключения-014.png |center]]

Компонент "'''Ув3'''". Отладочное уведомление, с выводом полученного идентификатора цепочки коммутаций.
* Отладочный режим - Да.
* Текст - выражение '''[idChainuser] '+[idChainuser]''
* Адресат - выберите администрирующего пользователя.

Компонент "'''Линия повесила трубку?'''". Если Id цепочки коммутаций равен "''00000000-0000-0000-0000-000000000000''", значит на данный момент активной коммутации на линии нет, то есть соединение с клиентом оборвалось.
* Аргумент 1 - переменная "'''idChainuser'''"
* Аргумент 2 - строка "''00000000-0000-0000-0000-000000000000''"
* Тип сравнения - "'''='''"
* Переход, если правда" - компонент "'''Линия оборвалась'''"
* Переход, если ложь - "'''Пауза 500 мс'''".

Компонент "'''Линия оборвалась'''". Сообщает администратору, что на линии клиента А произошел обрыв связи.
* Отладочный режим - Нет. После успешных тестов можно выставить Да.
* Текст - строка ''Внешняя линия повесила трубку''
* Адресат - выберите администрирующего пользователя.

Компонент "'''Пауза 500мс'''". Если линия пока не соединена, компонент осуществляет задержку перед следующей итерацией.
* Время задержки, мс - 500

[[Файл:Определение момент переключения-015.png |center]]

Скачать сценарии:
* [[Media:%D0%9E%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5_%D0%BC%D0%BE%D0%BC%D0%B5%D0%BD%D1%82%D0%B0_%D0%BF%D0%B5%D1%80%D0%B5%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D1%8F.oscr|Определение момента переключения.oscr]] ''(собрано на версии 2.11.2.141125)''

*[[Media:%D0%9E%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5_%D0%BC%D0%BE%D0%BC%D0%B5%D0%BD%D1%82%D0%B0_%D0%BF%D0%B5%D1%80%D0%B5%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%28%D1%81%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D1%8B%D0%B9%29.oscr|Определение момента переключения (служебный).oscr]] ''(собрано на версии 2.11.2.141125)''

==Назначение сценария переключения==

Перейдите в Администрирование/Общие настройки/Сценарии АТС. Сценарий "'''Определение момента переключения'''" следует назначить в качестве "'''Сценария IVR маршрутизации при переводе звонка'''", а также как "'''Сценарий IVR sip-трансфер переключения'''".

[[Файл:Определение момент переключения-003.png|800px|center]]

Определение момента переключения на сотрудника во время перевода звонка

2023-03-31T11:49:45Z

Oktell Support: /* Установка готовых сценариев в систему */

[[Практики|Наверх]]

__TOC__

==Введение==

Представим ситуацию, когда абонент А просит оператора Б переключить его на другого сотрудника В. Например, клиент, разговаривая с менеджером по продажам, хочет обсудить технический вопрос с инженерами технической поддержки. Менеджер по продажам может переключить абонента сразу напрямую (выполнить Transfer-переключение, неконсультативный перевод) или предварительно предупредить инженера о переводе (консультативный перевод). В каждом из этих случаев стоит задача воспроизвести в коммутацию сообщение "''Вы переключены на сотрудника''", как только установилось успешное соединение.

Такое звуковое сообщение помогает, во-первых, соориентировать клиента, что его звонок успешно переведен. Во-вторых, часто при переводе звонка принимающая сторона, в нашем случае инженер, не слышит как менеджер положил трубку, и не может понять переключили на него или еще нет. Звуковое сообщение в коммутацию облегчает сложившуюся ситуацию.

==Установка готовых сценариев в систему==

'''1.''' Скачайте и импортируйте сценарии:
* [[Media:%D0%9E%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5_%D0%BC%D0%BE%D0%BC%D0%B5%D0%BD%D1%82%D0%B0_%D0%BF%D0%B5%D1%80%D0%B5%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D1%8F.oscr|Определение момента переключения.oscr]] ''(собрано на версии 2.11.2.141125)''

*[[Media:%D0%9E%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5_%D0%BC%D0%BE%D0%BC%D0%B5%D0%BD%D1%82%D0%B0_%D0%BF%D0%B5%D1%80%D0%B5%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%28%D1%81%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D1%8B%D0%B9%29.oscr|Определение момента переключения (служебный).oscr]] ''(собрано на версии 2.11.2.141125)''

'''2.''' Настройте внешние линии в сценарии переключения "'''Определение момента переключения'''".

'''3.''' Назначьте сценарии в качестве системных сценариев переключения. Смотрите пункт [[Определение момента переключения на сотрудника во время перевода звонка#Назначение сценария переключения | Назначение сценария переключения]]

==Реализация сценария==

Для определенности введем следующие понятия: А - переключаемый клиент, Б - переключающий оператор, В - пользователь, на которого переводят звонок.

Основная идея алгоритма - запустить служебный сценарий, после того как сотрудник В возьмет трубку. Этот служебный сценарий в асинхронном режиме проверяет состояние переключения и после переключения клиента А на сотрудника В запускает воспроизведение файла в коммутацию. Все номера линий участвующие в переключении собираются в IVR сценарии переключения и передаются служебному сценарию на вход.

===Модификация IVR сценария переключения===

Модификация сценария заключается в сборе данных о линиях, участвующих в переводе звонка и запуске служебного сценария. Модифицированный сценарий выглядит следующим образом:

[[Файл:Определение момент переключения-002.png|center]]

'''1. Правка входного каскада.'''

Компонент "'''Старт 1'''". Во время Sip-transfer переключения получает номер, на который выполнен перевод звонка. Во время обычного переключения на вход ничего не передается.
* Параметр запуска - переменная "'''Номер'''" (строковая)

Компонент "'''Режим Flash'''". Присваивает служебной переменной "'''(сл) Режим Flash'''" - число '''1'''. Таким образом, если оператор Б положит трубку во время дозвона до сотрудника В, клиент А заменит его и самостоятельно будет ожидать соединения.

Компонент "'''Параметр запуска пусто?'''". Определяет передался ли номер на вход сценария во время SIP-transfer переключения.
* Аргумент 1 - переменная "'''Номер'''"
* Аргумент 2 - пустая строка
* Тип сравнения - "'''='''"
* Переход, правда - компонент "'''НОМЕР=CallerID'''".
* Переход, ложь - компонент "'''Пауза 1'''". Таким образом, номер отправляется сразу в набор.

[[Файл:Определение момент переключения-004.png |center]]

Компоненты "'''Номер=CallerID'''", "'''Номер пусто?'''" и все компоненты блока сборки номера (выделен зеленым) не изменяются.

Обратите внимание, что ветка по таймауту компонента "'''+1 цифра'''" в сценарии переведена на компонент "'''Пауза 1'''".

'''2.''' Компонент "'''Определение линий'''". Сохраняет номер линии абонента А (переключаемого, линия буфера) и линии пользователя Б (переключающего) в соответствующие переменные.
* Переменной "'''ЛинияБуфера'''" (строковая) присваивается значение функции "'''Номер линии, ожидающей во Flash-буфере'''".
* Переменной "'''ЛинияПользователя'''" (строковая) присваивается значение функции "'''Номер линии'''"

[[Файл:Определение момент переключения-005.png |center]]

'''3. Запуск служебного сценария'''. Блок определяет линию сотрудника В, записывает ее в переменную, а затем передает все три найденные линии (А, Б, В) на вход служебного сценария.

В зависимости от типа набранного номера отрабатывают те или иные компоненты. Для внешнего номера:

Компонент "'''ВНЕШНИЕ'''". Если переключают на внешний номер, то необходимо сохранить выбранную линию в переменную.
* Номер - переменная "'''Номер'''".
* Тип вызова - Обычный
* Направления - выберите направления для вызова
* Идентификатор выбранной линии - переменная "ЛинияПереключения" (строковая)
* Коммутировать сразу - Нет, прослушивать медиа-поток".

Компонент "'''Линия переключения'''". Определяет номер линии по ее идентификатору и сохраняет его в ту же переменную.
* Действие - Определить
* Тип объекта - Линия
* Ключ линии - переменная "'''ЛинияПереключения'''"
* Функция - Номер линии
* Значение в переменную - переменная "'''ЛинияПереключения'''"

Для внутреннего номера:

Компонент "'''ВНУТРЕННИЕ'''". Остается без изменения.
* Назначение - Внутрь
* Номер - переменная "'''Номер'''"
* Тип вызова - Обычный

[[Файл:Определение момент переключения-006.png |center]]

Компонент "'''Пауза 200мс'''". Необходим для корректной отработки переключения и записи всех значений в базу данных.
* Время задержки, мс - 200

Компонент "'''Линия переключения (2)'''". По номеру активной линии, определяет номер скоммутированной линии. Активной линией будет линия пользователя Б, если он ожидал соединения сотрудника В и тот взял трубку. Если пользователь Б, бросил трубку, то активной линией будет линия клиента А.
* Действие - Определить
* Тип объекта - Линия
* Ключ линии - функция "'''Номер линии'''"
* Функция - Номер скоммутированной линии/конференции
* Значение в переменную - переменная '''ЛинияПереключения'''

Компонент "'''XML'''". Для передачи трех значений в служебный сценарий, компонент объединяет их в единую XML структуру. Такой прием часто используется для передачи нескольких значений в качестве одного параметра запуска.
* Переменной "'''XML'''" (строковая) присваивается выражение
<pre>'<bufferLine>'+[ЛинияБуфера]+'</bufferLine>'+endline+
'<switchingLine>'+[ЛинияПереключения]+'</switchingLine>'+endline+
'<userLine>'+[ЛинияПользователя]+'</userLine>'</pre>
ВНИМАНИЕ: Можно и не использовать объединение переменных в XML, а передавать их как сессионные, однако удостоверьтесь, что у вас уже не используется одноименные переменные в других пересекающихся сценариях.

[[Файл:Определение момент переключения-007.png |center]]

Компонент "'''Ув1'''". Отладочное уведомления для вывода XML структуры.
* Отладочный режим - Да
* Текст - переменная "'''XML'''"
* Адресат - выберите администрирующего пользователя.

Компонент "'''Запуск сценария'''". Запускает асинхронный сценарий, который будет проверять соединение линии клиента А и сотрудника В.
* Тип запуска - Асинхронный служебный
* Режим выбора сценария - Из списка
* Сценарий - Определение момента переключения (служебный)
* Параметр запуска - переменная "'''XML'''"

[[Файл:Определение момент переключения-008.png |center]]

===Служебный сценарий определения момента переключения===

Служебный сценарий мониторит состояние линии А и определяет итог переключения. Сценарий выглядит следующим образом:

[[Файл:Определение момент переключения-001.png]]

Компонент "'''Старт 1'''". Получает переданную XML-структуру на вход сценария и записывает ее в переменную XML.
* Параметр запуска - переменная "'''XML'''" (строковая)

Компонент "'''Ув XML'''". Отладочное уведомление для вывода полученной XML.
* Отладочный режим - Да
* Текст - переменная "'''XML'''"
* Адресат - выберите администрирующего пользователя.

Компонент "'''Линия буфера'''". Выделяет линию буфера (клиента А) из XML-структуры.
* Документ - переменная "'''XML'''"
* Алгоритм - Язык OQuery для HTML
* Поисковый запрос - строка ''bufferLine''
* Функция - Содержимое
* Номер элемента - 0
* Результат в переменную - переменная "'''ЛинияБуфера'''" (строковая)

Компонент "'''Линия переключения'''". Выделяет линию сотрудника В, на которого переключают звонок, из XML-структуры.
* Документ - переменная "'''XML'''"
* Алгоритм - Язык OQuery для HTML
* Поисковый запрос - строка ''switchingLine''
* Функция - Содержимое
* Номер элемента - 0
* Результат в переменную - переменная "'''ЛинияПереключения'''" (строковая)

[[Файл:Определение момент переключения-009.png |center]]

Компонент "'''Линия пользователя'''". Выделяет линию переключающего сотрудника Б из XML-структуры.
* Документ - переменная "'''XML'''"
* Алгоритм - Язык OQuery для HTML
* Поисковый запрос - строка ''userLine''
* Функция - Содержимое
* Номер элемента - 0
* Результат в переменную - переменная "'''ЛинияПользователя'''" (строковая)

Компонент "'''Трансфер?'''". Определяет произошло ли трансфер-переключение. Если это так, то линия буфера будет пустая, вследствие того, что она была активной и содержится в переменной "'''ЛинияПользователя'''".
* Аргумент 1 - переменная "'''ЛинияБуфера'''"
* Аргумент 2 - пустая строка
* Тип сравнения - "'''='''"
* Переход, если правда - компонент "'''Трансфер'''"
* Переход, если ложь - компонент "'''Скоммутированная с буфером'''"

----
''Случай обычного переключения''
----

Компонент "'''Скоммутированная с буфером'''". Определяет номер скоммутированной линии с линией буфера (клиента А). В зависимости от того, какую линию вернет компонент, будет решаться соединилась ли линия буфера с пользователем В или вернулась обратно.
* Действие - Определить
* Тип объекта - Линия
* Ключ линии - переменная "'''ЛинияБуфера'''"
* Функция - Номер скоммутированной линии/конференции
* Значение в переменную - переменная "'''СкоммутированнаяСБуфером'''" (строковая)

[[Файл:Определение момент переключения-010.png |center]]

Компонент "'''Ув1'''". Отладочное уведомление для вывода номеров участвующих линий, а также линии, которая скоммутирована с буфером.
* Отладочный режим - Да
* Текст - выражение
<pre>'[ЛинияБуфера] '+[ЛинияБуфера]+endline+
'[ЛинияПереключения] '+[ЛинияПереключения]+endline+
'[ЛинияПользователя] '+[ЛинияПользователя]+endline+endline+
'[СкоммутированнаяСБуфером] '+[СкоммутированнаяСБуфером]</pre>
* Адресат - выберите администрирующего пользователя.

Компонент "'''Буфер не скоммутирован?'''". Определяет скоммутирована ли линия буфера. Если переменная "'''СкоммутированнаяСБуфером'''" равна "'''-1'''", значит линия пока не скоммутирована.
* Аргумент 1 - переменная "'''СкоммутированнаяСБуфером'''"
* Аргумент 2 - число "'''-1'''"
* Тип сравнения - "'''='''"
* Переход, если правда" - компонент "'''IdChain'''"
* Переход, если ложь - "'''Буфер переключился?'''". Переход отрабатывает, если линия буфера соединена с какой-либо другой линией.

Компонент "'''IdChain'''". Если линия пока не скоммутирована, есть вероятность, что она разорвала связь. Такое бывает в условиях плохого соединения, например клиент зашел в метро, или клиент просто повесил трубку в следствие долгого ожидания. Чтобы определить это, нам потребуется знать идентификатор цепочки коммутаций.
* Действие - Определить
* Тип объекта - Линия
* Ключ линии - переменная "'''ЛинияБуфера'''"
* Функция - Идентификатор цепочки коммутаций
* Значение в переменную - переменная "'''idChainuser'''" (строковая)

Компонент "'''Ув2'''". Отладочное уведомление для вывода Id цепочки коммутаций.
* Отладочный режим - Да
* Текст - переменная "'''idChainuser'''"
* Адресат - выберите администрирующего пользователя.

Компонент "'''Обрыв внешней линии'''". Если Id цепочки коммутаций равен "''00000000-0000-0000-0000-000000000000''", значит на данный момент активной коммутации на линии нет, то есть соединение с клиентом оборвалось.
* Аргумент 1 - переменная "'''idChainuser'''"
* Аргумент 2 - строка "''00000000-0000-0000-0000-000000000000''"
* Тип сравнения - "'''='''"
* Переход, если правда" - компонент "'''Линия повесила трубку'''"
* Переход, если ложь - "'''Пока линия не скоммутирована'''".

[[Файл:Определение момент переключения-011.png |center]]

Компонент "'''Линия повесила трубку'''". Отладочное уведомление, о том, что линия повесила трубку.
* Отладочный режим - Нет. После успешных тестов можно выставить Да.
* Текст - строка ''Внешняя линия повесила трубку''
* Адресат - выберите администрирующего пользователя.

Компонент "'''Пока линия не скоммутирована'''". Отладочное уведомление, о том, что линия пока ни с кем не скоммутирована.
* Отладочный режим - Да
* Текст - строка ''Линия пока не скоммутирована''
* Адресат - выберите администрирующего пользователя.

Компонент "'''Буфер переключился?'''". Если линия буфера соединена с какой-либо линией, то компонент проверяет соединена ли линия буфера с линией сотрудника, на которого переключали.
* Аргумент 1 - переменная "'''СкоммутированнаяСБуфером'''"
* Аргумент 2 - переменная "'''ЛинияПереключения'''"
* Тип сравнения - "'''='''"
* Переход, если правда - компонент "'''Линии скоммутированы'''"
* Переход, если ложь - компонент "'''Линия вернулась?'''"

Компонент "'''Линия скоммутированы'''". Уведомляет администратора, что линии А и В скоммутировались.
* Отладочный режим - Нет. После успешных тестов можно выставить Да.
* Текст - строка ''Линии успешно скоммутировались''
* Адресат - выберите администрирующего пользователя.

Компонент "'''Воспроизведение файла'''". Воспроизводит в коммутацию звуковой файл "''Вы переключены на сотрудника''", уведомляя обе стороны об успешном переключении.
* Действие - Установить
* Тип объекта - Линия
* Ключ линии - переменная "'''ЛинияБуфера'''"
* Свойство/действие - Воспроизвести файл в коммутацию/конференцию
* Звуковой файл - выберите файл "''Вы переключены на сотрудника.mp3''"
* Значение - 0. Означает полную громкость воспроизведения.

Компонент "'''Линия вернулась?'''". Линия буфера может быть скоммутирована с линией переключающего Б. В этом случае, мы делаем вывод, что линия вернулась обратно переключающему. Это могло произойти, после того, как Б и В поговорили, но первым положил трубку В. Тогда А соединяется обратно с Б.
* Аргумент 1 - переменная "'''СкоммутированнаяСБуфером'''"
* Аргумент 2 - переменная "'''ЛинияПользователя'''"
* Тип сравнения - "'''='''"
* Переход, если правда - компонент "'''Возврат буфера'''"
* Переход, если ложь - компонент "'''Пока линия не скоммутирована'''".
ВНИМАНИЕ: Фактически, этот переход может произойти только вследствие ошибочной логики, поэтому обратите на него внимание во время отладки. Имеет смысл, убрать переход или поставить уведомление.

[[Файл:Определение момент переключения-012.png |center]]

Компонент "'''Возврат буфера'''".
* Отладочный режим - Нет. После успешных тестов можно выставить Да.
* Текст - строка ''Линия вернулась обратно''
* Адресат - выберите администрирующего пользователя.

Компонент "'''500мс'''". Если линия пока не соединена, компонент осуществляет задержку перед следующей итерацией анализа состояния линий. Эта задержка по сути является разрешающей способностью сценария. Если выставить слишком много - возможны перекрестные ошибки, если выставить мало - система будет сильно нагружаться. Вам следует поэкспериментировать с этим значением. Во время тестов было использовано значение 500 мс.
* Время задержки, мс - 500

----
'''''SIP-трансфер переключение.''' Отличие этого блока от предыдущего в том, что линия переключаемого клиента А будет располагаться в переменной "ЛинияПользователя", так как в сценарии переключения именно она была активной.''
----

Компонент "'''Трансфер'''".
* Отладочный режим - Нет. После успешных тестов можно выставить Да.
* Текст - строка ''ТРАНСФЕР''
* Адресат - выберите администрирующего пользователя.

Компонент "'''Скоммутированная с буфером 2'''". Определяет номер скоммутированной линии с линией клиента А. В зависимости от того, какую линию вернет компонент, будет решаться соединилась ли линия буфера с пользователем В или нет.
* Действие - Определить
* Тип объекта - Линия
* Ключ линии - переменная "'''ЛинияПользователя'''"
* Функция - Номер скоммутированной линии/конференции
* Значение в переменную - переменная "'''СкоммутированнаяСБуфером'''"

Компонент "'''Произошло соединение?'''". Определяет произошло ли соединение линии клиента А и пользователя В.
* Аргумент 1 - переменная "'''СкоммутированнаяСБуфером'''"
* Аргумент 2 - переменная "'''ЛинияПользователя'''"
* Тип сравнения - "'''='''"
* Переход, если правда - компонент "'''Линии соединены'''"
* Переход, если ложь - компонент "'''Пауза2'''".
ВНИМАНИЕ: Переход по ветке "Ложь" является некорректным и может произойти только вследствие системной ошибки или высокой загрузки процессора. Если этот переход выполнился, то вам следует обратить на это пристальное внимание.

Компонент "'''Линии соединены'''".
* Отладочный режим - Нет. После успешных тестов можно выставить Да.
* Текст - строка ''Линии успешно скоммутировались''
* Адресат - выберите администрирующего пользователя.

Компонент "'''Воспроизведение файла 2'''". Воспроизводит в коммутацию звуковой файл "''Вы переключены на сотрудника''", уведомляя обе стороны об успешном переключении.
* Действие - Установить
* Тип объекта - Линия
* Ключ линии - переменная "'''ЛинияПользователя'''"
* Свойство/действие - Воспроизвести файл в коммутацию/конференцию
* Звуковой файл - выберите файл "''Вы переключены на сотрудника.mp3''"
* Значение - 0. Означает полную громкость воспроизведения.

[[Файл:Определение момент переключения-013.png |center]]

Компонент "'''Пауза 2'''". Переход на этот компонент, если переходные процессы заняли длительное время (большая загрузка процессора). В этом случае мы установили дополнительную задержку 200 мс для завершения всех переходных процессов.
* Время задержки, мс - 200

Компонент "'''Линия не соединилась'''". Если линия пока не соединилась с линией сотрудника В, то ее состояние должно быть равно "'''-1'''". Если это не так, то произошла ошибочная ситуация.
* Аргумент 1 - переменная "'''СкоммутированнаяСБуфером'''"
* Аргумент 2 - число"'''-1'''"
* Тип сравнения - "'''='''"
* Переход, если правда - компонент "'''IdChain 2'''"
* Переход, если ложь - компонент "'''Неизвестная ситуация'''"

Компонент "'''Неизвестная ситуация'''". Уведомляет, что произошла неизвестная ситуация во время трансфер-переключения. Линия во время sip-трансфер переключения внезапно соединилась с другой линией, и следует подробно выяснить как такое могло произойти.
* Отладочный режим - Нет. После успешных тестов можно выставить Да.
* Текст - строка ''Неизвестная ситуация''
* Адресат - выберите администрирующего пользователя.

Компонент "'''IdChain 2'''". Если линия клиента А не соединилась с линией пользователя В, то есть вероятность, что мог произойти обрыв связи. Проверить это поможет идентификатор цепочки коммутаций.
* Действие - Определить
* Тип объекта - Линия
* Ключ линии - переменная "'''ЛинияПользователя'''"
* Функция - Идентификатор цепочки коммутаций
* Значение в переменную - переменная "'''idChainuser'''"

[[Файл:Определение момент переключения-014.png |center]]

Компонент "'''Ув3'''". Отладочное уведомление, с выводом полученного идентификатора цепочки коммутаций.
* Отладочный режим - Да.
* Текст - выражение '''[idChainuser] '+[idChainuser]''
* Адресат - выберите администрирующего пользователя.

Компонент "'''Линия повесила трубку?'''". Если Id цепочки коммутаций равен "''00000000-0000-0000-0000-000000000000''", значит на данный момент активной коммутации на линии нет, то есть соединение с клиентом оборвалось.
* Аргумент 1 - переменная "'''idChainuser'''"
* Аргумент 2 - строка "''00000000-0000-0000-0000-000000000000''"
* Тип сравнения - "'''='''"
* Переход, если правда" - компонент "'''Линия оборвалась'''"
* Переход, если ложь - "'''Пауза 500 мс'''".

Компонент "'''Линия оборвалась'''". Сообщает администратору, что на линии клиента А произошел обрыв связи.
* Отладочный режим - Нет. После успешных тестов можно выставить Да.
* Текст - строка ''Внешняя линия повесила трубку''
* Адресат - выберите администрирующего пользователя.

Компонент "'''Пауза 500мс'''". Если линия пока не соединена, компонент осуществляет задержку перед следующей итерацией.
* Время задержки, мс - 500

[[Файл:Определение момент переключения-015.png |center]]

Скачать сценарии:
* [http://wiki.oktell.ru/images/5/56/%D0%9E%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5_%D0%BC%D0%BE%D0%BC%D0%B5%D0%BD%D1%82%D0%B0_%D0%BF%D0%B5%D1%80%D0%B5%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D1%8F.oscr Определение момента переключения.oscr] ''(собрано на версии 2.11.2.141125)''

*[http://wiki.oktell.ru/images/8/85/%D0%9E%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5_%D0%BC%D0%BE%D0%BC%D0%B5%D0%BD%D1%82%D0%B0_%D0%BF%D0%B5%D1%80%D0%B5%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%28%D1%81%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D1%8B%D0%B9%29.oscr Определение момента переключения (служебный).oscr] ''(собрано на версии 2.11.2.141125)''

==Назначение сценария переключения==

Перейдите в Администрирование/Общие настройки/Сценарии АТС. Сценарий "'''Определение момента переключения'''" следует назначить в качестве "'''Сценария IVR маршрутизации при переводе звонка'''", а также как "'''Сценарий IVR sip-трансфер переключения'''".

[[Файл:Определение момент переключения-003.png|800px|center]]

Воспроизведение файла в коммутацию

2023-03-31T11:41:13Z

Oktell Support: /* Пример сценария */

[[Практики|Наверх]] <nowiki>[Oktell 2.11.140813+]</nowiki>

__TOC__

==Введение==

Начиная с версии 2.11.1.140813, появилась возможность проигрывать музыкальные файлы абонентам во время разговора или конференции. Возможность не предназначена для коммутации абонента с IVR. Функционал доступен в компоненте '''Cтатус объекта''' и может быть использован во всех видах сценариев.

Для линии, сессии или конференции в статусе объекта существует свойство ''Воспроизвести файл в коммутацию/конференцию'' для воспроизведения файла сразу всем участникам разговора. Если абонент соединен с IVR сценарием, файл ему не будет воспроизводится. В качестве значений указать воспроизводимый звуковой файл в формате mp3 и уровень понижения громкости, где
* 0 - без понижения
* 8 - максимальное снижение громкости, почти не слышно.
По умолчанию, используется 4.

Начиная с версии 2.11.3.150318, для линии существует дополнительное свойство ''Воспроизвести файл в линию'' для воспроизведения файла конкретному участнику разговора. В качестве значения указывается звуковой файл в формате mp3. Такое действие работает по следующей логике:
*Если абонент соединен с IVR сценарием — музыкальный файл не воспроизводится
*Если абонент находится в коммутации - музыкальный файл воспроизводится только в его линию
*Если абонент находится в конференции - на время воспроизведения файла данный участник перестает слышать остальных. Это называется "''исключающее воспроизведение''".

Пример настройки компонента:

[[Файл:Воспроизведение файла в коммутацию -001.png|center]]

ВНИМАНИЕ: Следует учитывать, что запись воспроизводимого файла ведется только в режиме конференции. Для коммутации воспроизводимый файл на запись разговора не попадает.

Возможное применение:
* Воспроизведение в начале коммутации приветствия или предупреждения о включенной записи разговора.
* Воспроизведение в линию сигнала о превышении допустимого времени разговора.
* Оповещение оператора о наличии ожидающих абонентов в очереди.
* Создание полностью автоматизированного сервиса с заранее записанными ответами оператора, например в виде диалоговой формы.

==Пример сценария==

'''Задача:''' В самом начале разговора с оператором предупредить клиента о том, что все разговоры записываются.

Сценарий выглядит следующим образом:

[[Файл:Воспроизведение файла в коммутацию.png|center]]

Компонент "'''На оператора'''". Соединяет абонента с пользователем системы Oktell.
*Назначение - Внутрь
*Номер - 502
*Тип вызова - Обычный

Компонент "'''Пауза 500мс'''". Нужен для того, чтобы после успешного соединения в системе отработали переходные процессы и с помощью функций можно было определить номер линии или Id цепочки коммутаций.
*Время задеркжи, мс - 500

Компонент "'''Воспроизвести в сессию'''". Воспроизводит звуковой файл в разговоре.
*Действие - Установить
*Тип объекта - Сессия
*Идентификатор сессии - функция "'''Id цепочки коммутаций'''". Также здесь можно выбрать функцию "'''Id сессии сценария'''".
*Свойство - Воспроизвести файл в коммутацию/конференцию.
*Звуковой файл - выберите проигрываемый файл. В примере, "'''Ваш разговор записывается.mp3'''"
*Значение - выберите уровень понижения громкости. В примере, '''0''', т.е. без уменьшения.

'''Скачать сценарий:''' [[Media:%D0%92%D0%BE%D1%81%D0%BF%D1%80%D0%BE%D0%B8%D0%B7%D0%B2%D0%B5%D0%B4%D0%B5%D0%BD%D0%B8%D0%B5_%D1%84%D0%B0%D0%B9%D0%BB%D0%B0_%D0%B2_%D0%BA%D0%BE%D0%BC%D0%BC%D1%83%D1%82%D0%B0%D1%86%D0%B8%D1%8E.oscr|Воспроизведение файла в коммутацию.oscr]]

Синтез речи на базе Google Voice

2023-03-31T11:36:21Z

Oktell Support: /* Быстрый старт */

[[Практики|Наверх]]

__TOC__

==Введение==

'''Google Voice''' - сервис синтеза речи.

Технология синтеза речи text-to-speech позволяет генерировать звуковой файл напрямую из печатного текста. Такая задача часто встречается для озвучивание динамической информации, которая для каждого клиента индивидуальна. Озвучивание звуковых роликов синтезированным голосом будет также полезно в случае быстро меняющейся информации – это остаток товаров на складе, репертуар кинотеатров, аварийные ситуации и так далее. Синтез речи может понадобится в организации голосового меню с автоматически настраиваемыми пунктами навигации.

==Быстрый старт==

Для использования системы синтеза речи''' Google Voice''' выполните следующие действия:

'''Шаг 1.''' Скачайте и импортируйте следующий сценарий.

'''Скачать сценарий:''' [[Media:%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D0%B7_%D1%80%D0%B5%D1%87%D0%B8_Google.oscr|Синтез речи Google.oscr]] (для версий '''Oktell''' старше 2.9)

Сценарий позволяет преобразовывать текст в звуковой файл, и воспроизводить его абоненту.

После импорта сценария сохраните его "'''На сервер'''"

'''Шаг 2.''' Для использования сервиса используйте компонент "'''Запуск сценария'''" в IVR сценарии. В свойствах компонента выберите
* '''Тип запуска''' - Вложенный
* '''Сценарий''' - выберите сценарий "'''Синтез речи Google'''"
* '''Параметр запуска''' - введите ваш текст для воспроизведения. В примере, строка "''Здравствуйте! Вас приветствует компания Телефонные Системы!''"
* '''Возврат управления''' - Да

[[Файл:Синтез речи Google -001.png|center]]

Распознавание речи с помощью Google Speech API

2023-03-31T11:31:11Z

Oktell Support:

[[Практики|Наверх]]

'''Google Speech API''' - сервис распознавания голоса Google.

Распознавание речи позволяет создавать системы автоматического обслуживания клиентов в тех случаях, когда не применимо управление с помощью тонального набора. В качестве примера можно рассмотреть сервис бронирования авиабилетов, который подразумевает выбор их большого числа городов. Тональное меню в таком сервисе не удобно, поэтому голосовое управление будет самым эффективным. Диалог между системой и абонентом может выглядеть следующим образом:

Система: Здравствуйте. Куда вы хотите лететь?
Абонент: Казань
Система: Откуда вы хотите лететь?
Абонент: Москва
Система: Назовите дату вылета
Абонент: 10 апреля

Общение с таким голосовым порталом становится приближенным к обслуживанию оператором.

Система распознавания голосовых запросов применяется во многих системах, например, для:
* Голосовой навигации в многоуровневых меню IVR и автоматического соединения с нужным сотрудником
* Распознавания адреса для доставки
* Автоматической голосовой аутентификации пользователей при запросе персонализированной или конфиденциальной информации по телефону или через интернет
* Справочной системы информационного обслуживания
* Корпоративной системы голосового самообслуживания клиентов (запрос баланса, проверка лицевого счета, бронирование билетов)

Система распознавания речи, как правило, состоит из следующих частей:
* Запись сообщения от абонента
* Распознавание голоса и прием текстовых данных от сервиса
* Анализ полученной информации и выполнение необходимых действий

Для использования '''Google Speech API''' в вашей системе выполните следующие действия:

'''Шаг 1.''' Скачайте и импортируйте сценарии в вашу систему '''Oktell'''.

'''Скачать сценарий:''' [[Media:Google_Speech_API.zip|Google_Speech_API.zip]] (для версий '''Oktell''' старше 2.10)

В архиве располагаются два сценария:
*'''Google_Speech_API_main''' - сценарий для записи голосового сообщения, является примером правильного использования сервиса распознавания в главном сценарии.
*'''Google_Speech_API''' - сценарий для отправки записи на сервис Google и приема распознанного сообщения.

После импорта сценариев в '''Oktell''', сохраните их "'''На сервер'''"

ВНИМАНИЕ: Google Speech API — это платный продукт. В сценарии (компонент Web-запроса '''GoogleVoice''') используется пробный ключ, который может быть заблокирован в следствие определенного числа запросов. При тестах максимальное количество запросов не обнаружено. Если вы хотите приобрести платную версию Google Speech API обратитесь в поддержку Google.

[[Файл:Google Speech API 3.png|center]]

'''Шаг 2.''' В модуле "'''Администрирование'''" - "'''Внутренние номера'''" добавьте внутренний номер с типом "'''Запуск IVR'''". Выберите IVR-сценарий '''Google_Speech_API_main'''.

[[Файл:Google Speech API-001.png|center]]

Нажмите "'''Сохранить'''". Затем "'''Применить'''".

'''Шаг 3.''' При звонке на заданный номер (в примере, '''456'''), проговорите сообщение. В конце нажмите "'''*'''". Через несколько секунд появятся уведомления с распознанным текстом.

[[Файл:Google Speech API-002.png|center]]

Полученный текст передается в переменной '''text''', которую затем можно проанализировать и выполнить необходимые действия. Используйте пример '''Google_Speech_API_main''' для использования сервиса распознавания в главном сценарии.

[[Файл:Google Speech API 4.png|center]]

Распознавание речи с помощью Yandex SpeechKit Сloud

2023-03-31T11:30:12Z

Oktell Support:

[[Практики|Наверх]]

[[Файл:Yandex_ASR_Cloud.png|500px]]

[https://cloud.yandex.ru/services/speechkit '''Yandex SpeechKit '''] – сервис распознавания и синтеза речи платформы Яндекс.Облако, который позволяет оптимизировать обработку звонков абонентов с помощью голосового управления IVR сценариями. Работает на базе разработанной в Яндексе технологии распознавания речи

Это платный модуль, для использования которого необходимо заключить договор с Яндексом. Стоимость зависит от количества запросов в сутки. Ознакомьтесь с [https://cloud.yandex.ru/docs/speechkit/pricing Правилами тарификации для Yandex SpeechKit]

Документация по API распознавания и синтеза речи Yandex SpeechKit доступна на сайте [https://cloud.yandex.ru/docs/speechkit/ Yandex SpeechKit]

Распознавание речи позволяет создавать системы автоматического обслуживания клиентов в тех случаях, когда управление с помощью тонального набора неудобно. В качестве примера можно рассмотреть сервис бронирования авиабилетов, который подразумевает выбор из большого числа городов. Тональное меню в таком сервисе не удобно, поэтому голосовое управление будет самым эффективным. Диалог между системой и абонентом может выглядеть следующим образом:

Система: Здравствуйте. Куда вы хотите лететь?
Абонент: Казань
Система: Откуда вы хотите лететь?
Абонент: Москва
Система: Назовите дату вылета
Абонент: 10 апреля

Общение с таким голосовым порталом становится приближенным к обслуживанию оператором.

Распознавание голосовых запросов применяется во многих системах, например, для:
* Голосовой навигации в многоуровневых меню IVR и автоматического соединения с нужным сотрудником
* Распознавания адреса для доставки
* Автоматической голосовой аутентификации пользователей при запросе персонализированной или конфиденциальной информации по телефону или через интернет
* Справочной системы информационного обслуживания
* Корпоративной системы голосового самообслуживания клиентов (запрос баланса, проверка лицевого счета, бронирование билетов)

Внедрение такой системы позволит автоматизировать определенные задачи по обработке входящих звонков, упростит взаимодействие клиента с системой и сократит суммарное время ожидания клиента на линии. Тем самым в вашей компании будут высвобождены значительные ресурсы операторов, что позволит распределить на другие не менее важные задачи.

Система распознавания речи, как правило, состоит из следующих частей:
# Запись сообщения от абонента
# Распознавание речи и прием текстовых данных от сервиса
# Анализ полученной информации и выполнение необходимых действий

<center>
----
'''''По вопросам реализации данной функции на базе вашей АТС, а также приобретения продуктов Oktell

'''''обращайтесь в отдел продаж ООО "Телефонные Системы": +7 (495) 229-49-89, mail@oktell.ru.
----
</center>

Для использования '''Yandex SpeechKit''' в вашей системе выполните следующие действия:

'''Шаг 1.''' Получить авторизационные данные на использование сервиса Yandex SpeechKit.
* Выполните шаги 1-5 [https://cloud.yandex.ru/docs/speechkit/concepts/auth инструкции] по авторизации в API для получения идентификатора каталога
* [https://passport.yandex.ru/auth Войдите] в ваш аккаунт на Яндексе или Яндекс.Коннекте
* Получите OAuth-токен в сервисе Яндекс.OAuth. Для этого перейдите по [https://oauth.yandex.ru/authorize?response_type=token&client_id=1a6990aa636648e9b2ef855fa7bec2fb ссылке], нажмите '''Разрешить''' и скопируйте полученный OAuth-токен.

'''Шаг 2.''' Перейдите в '''Администрирование''' / '''Общие настройки''' / '''Распознавание речи Yandex SpeechKit Cloud'''. Введите полученные значения '''OAuth-токен''' и '''Идентификатор каталога''' в соответствующие поля

[[Файл:Yandex ASR Cloud 001.png|center|600px]]

Нажмите "'''Сохранить'''". Теперь вы можете использовать распознавание речи в сценариях.

'''Шаг 3.''' Для примера покажем простейшую маршрутизацию, основанную на распознавании речи. Сценарий выглядит следующим образом:

[[Файл:Yandex ASR Cloud 002.png|center]]

Компонент "'''Приветствие'''" - проигрывает приветственную фразу для абонента и спрашивает с кем он желает поговорить. В примере, для простоты, используется "'''ding.wav'''".
*'''Режим''' - Файл полностью
*'''Файл''' - ding.wav

Компонент "'''Распознавание речи'''" - новый компонент в IVR-сценариях, использующий систему Yandex SpeechKit Cloud. Позволяет распознавать речь как из заранее записанного файла, так и непосредственно из линии абонента. В примере, используется именно второй вариант. Рассмотрим настройки детальнее:
* '''Режим''' - Распознавание может происходить сразу из речи абонента, либо из файла. В примере, используется режим "'''Запись'''".
* '''Символы прерывания''' - При нажатии на символ прерывания, введенные символы запишутся в переменную. Распознавание производиться не будет. В примере "'''*'''".
* '''Буфер для DTMF''' - В компоненте можно ввести некоторое заданное количество DTMF-символов, аналогично компоненту "'''Преднабор'''", после чего компонент прекратит распознавать текст, а сразу вернет полученную строку. В примере для введенных DTMF используется переменная '''number''' (строковая).
* '''Очистить буфер DTMF''' - Если да, то переменная для буфера будет заранее очищена от предыдущих значений. В примере '''Да'''.
* '''Макс время записи, с''' - В течении заданного количества секунд абонент должен будет либо произнести фразу, либо ввести заданное количество DTMF-символов. В примере '''5''' секунд.
* '''Количество символов''' - Необходимое количество DTMF-символов, которое нужно ввести. В примере, '''3''', так как предполагается, что в компании трехзначный номерной план
* '''Сигнал окончания''' - Сигнал, который будет воспроизведен после окончания распознавания. В примере, проигрывается файл "'''ding.wav'''".
* '''Тема''' - настройка, отвечающая за тематику речи. Мы рекомендуем использовать '''queries'''. Эта тема применяется для поисковых запросов и коротких фраз (3–5 слов) на различную тематику, например "''а где ближайший банкомат''", "''мне нужно заблокировать карту''" или "''соедините меня с оператором''". В примере '''queries'''
* '''Предопределенные значения''' - компонент позволяет заранее предустановить код для распознанной фразы. В примере, это будут номера телефонов сотрудников. Таким образом, если будет произнесено "''Директор''" или "''С директором''", определится код ответа "'''401'''".
* '''Текст в переменную''' - распознанный текст может быть присвоен переменной. В примере, переменная '''parse_bestText''' (строковая).
* '''Код группировки в переменную''' - если распознанное выражение совпадает с каким-либо '''предопределенным значением''' (см. выше), то вы можете сохранить этот код в переменную. В примере, переменная '''group''' (строковая).
* '''Вероятность совпадения в переменную''' - выберите переменную для сохранения вероятности совпадения с одним из предопределенных выражений. В примере, переменная '''parse_bestConfidence''' (строковая)

[[Файл:Yandex ASR Cloud 003.png|center]]

Компонент "'''Результаты'''" - выводит на экран результаты работы компонента "'''Распознавание речи'''". Используется выражение
'Точность '+[parse_bestConfidence]+endline+
'Текст '+[parse_bestText]+endline+
'Код группировки '+[group]+endline+
'Введенный номер '+[number]

Все компоненты ниже отвечают за маршрутизацию звонка, на основании полученных результатов.

Компонент "'''Ввели номер?'''" - определяет была ли введена DTMF-последовательность (внутренний номер сотрудника).
*Аргумент 1 - переменная '''number'''
*Аргумент 2 - пустая строка
*Тип сравнения - "'''='''"

Компонент "'''Определилась группа?'''" - если номер не был введен вручную с помощью DTMF, то проверяется определился ли код распознанного текста.
*Аргумент 1 - переменная '''group'''
*Аргумент 2 - пустая строка
*Тип сравнения - "'''='''"

Компонент "'''number=group'''" - если код распознался, то переменной number присваивается значение переменной group.

[[Файл:Yandex ASR Cloud 005.png|center]]

Компонент "'''Секретарь по умолчанию'''" - если номер, на который нужно переключить не был ни введен, ни распознан, то по умолчанию, звонок будет переключен на секретаря. Переменной '''number''' присваивается значение '''100'''.

Компонент "'''На секретаря'''" - отладочное уведомление для администратора, которое показывает, что был присвоен номер по умолчанию.

Компонент "'''Переключение на сотрудника'''" - компонент осуществляет переключение на сотрудника по номеру, определенному в переменной '''number'''.

[[Файл:Yandex ASR Cloud 007.png|center]]

'''Шаг.4.''' В модуле "'''Администрирование'''" - "'''Внутренние номера'''" добавьте внутренний номер с типом "'''Запуск IVR'''". Выберите IVR-сценарий '''Yandex_SpeechKit_Cloud'''.

Нажмите "'''Сохранить'''". Затем "'''Применить'''".

[[Файл:Yandex ASR Cloud 010.png|center|600px]]

'''Шаг 5.''' При звонке на заданный номер, проговорите сообщение. В конце нажмите "'''*'''". Через несколько секунд появятся уведомления с распознанным текстом. Также можете проверить остальные случаи.

'''Информация для отладки:''' Все нераспознанные фразы рекомендуется сохраняться в отдельную таблицу, а затем включать в "'''Предопределенные значения'''". Тем самым, вы сможете распознавать большинство фраз, которые говорят ваши клиенты.

'''Шаг 6.''' Если Вас устраивает тест, Вы заключаете договор с Яндексом. Отчетный период начинается с даты подписания договора. Оплата происходит по окончанию отчетного периода на основании подписанного акта.

'''Скачать сценарий:''' [[Media:Yandex_SpeechKit_Cloud.oscr|Yandex_SpeechKit_Cloud.oscr]]

'''Описание компонента:''' [[Компоненты_сценариев_IVR#.D0.A0.D0.B0.D1.81.D0.BF.D0.BE.D0.B7.D0.BD.D0.B0.D0.B2.D0.B0.D0.BD.D0.B8.D0.B5_.D1.80.D0.B5.D1.87.D0.B8|Распознавание речи]]

<center>
----
'''''По вопросам реализации данной функции на базе вашей АТС, а также приобретения продуктов Oktell

'''''обращайтесь в отдел продаж ООО "Телефонные Системы": +7 (495) 229-49-89, mail@oktell.ru.
----
</center>

Перехват звонков из очереди

2023-03-31T11:28:37Z

Oktell Support: /* Результаты работы */

[[Практики|Наверх]]

__TOC__

'''Цель:''' Настроить внешний модуль с возможностью перехвата любого звонка, находящегося в очереди ожидания в системе '''Oktell'''.

Задача актуальна в целях разгрузки очереди. Известно, что в часы наибольшей нагрузки в систему поступает большое количество звонков и часто доступные операторы не способны справиться с поступающим потоком абонентов. В эти моменты, супервизору может быть удобен мониторинг текущих очередей в системе и возможность перехватить абонента, который находится в очереди дольше всех.

Функционал реализовывается во внешнем модуле с частотой обновления раз в 2 секунды. При создании сценариев было обращено особое внимание на минимальное количество обращений в базу данных с целью снижения нагрузки на сервер баз данных.

Рассмотрим детальнее процесс реализации данной задачи.

=== Сценарий получения списка внешних линий===

Сценарий предназначен для записи в '''глобальную''' переменную xml-структуры со списком всех внешних линий. Это нужно для того, чтобы не нагружать сервер БД при мониторинге, запрашивая их список. Глобальная переменная доступна во всех запускаемых сценариях.

Сценарий рекомендуется один раз в день, например, при запуске системы (при условии, что список внешних линий не меняется в течении дня).

Вид сценария представлен на рисунке:

[[Файл:Перехват звонков 001.png|center]]

*Компонент "'''Получение списка линий'''" - делает запрос в БД '''Oktell''' на получение списка внешних линий в XML-формате. Используется следующий SQL-запрос:

<nowiki>declare @lines xml</nowiki>
<nowiki>set @lines = ( select SystemNumStr from A_ServerExtLines for XML path (''))</nowiki>
<nowiki>select @lines as "lines_queus"</nowiki>

В параметрах SQL-запроса переменные не указываются. Запрос возвращает результат в столбце '''lines_queus''', поэтому для передачи значения в сценарии создается '''глобальная переменная''' '''lines_queus'''. Результат SQL-запроса '''lines_queus''' будет автоматически присвоен переменной сценария '''lines_queus'''.

ВНИМАНИЕ: Если имя переменной сценария не будет совпадать с именем возвращаемого столбца в SQL-запросе, то значение не будет передано.

ВНИМАНИЕ: Замечено, что SQL-запрос не работает для версий MSSQL 2000 и ниже. Используйте следующий SQL-запрос, однако максимальный размер возвращаемой строки не более 2000 символов:
declare @lines nVARCHAR(4000)
SET @lines = ''
select @lines = @lines +'<SystemNumStr>'+ SystemNumStr + '</SystemNumStr>'from A_ServerExtLines
select @lines as "lines_queus"

*Компонент "'''Ув1'''" - отладочное уведомление для вывода на экран значения в переменной '''lines_queus'''.

=== Настройка служебной задачи===

Для того, чтобы сценарий получения списка внешних линий запускался каждый раз при запуске системы, его необходимо назначить в служебную задачу.
*Перейдите в "'''Администрирование'''" - "'''Общие настройки'''"
*Перейдите на вкладку "'''Служебные задачи'''"
*Нажмите "'''Добавить'''"
*Настройте служебную задачу
:*'''Служебный сценарий''' - выберите служебный сценарий получения списка внешних линий. В примере, '''Очередь_Список внешних линий'''
:*'''Тип запуска''' - При запуске сервера
*Нажмите "'''Сохранить'''"
*Активируйте созданную служебную задачу

ВНИМАНИЕ: Для того, чтобы глобальная переменная '''lines_queus''' получила список внешних линий, перезапустите сервер '''Oktell''', либо вручную запустите служебный сценарий получения списка внешних линий.

[[Файл:Перехват звонков 007.png|center|600px]]

=== Модификация главного сценария===

Модификация сценария заключается в добавлении в контент линии информации о переключении. Эта информация позволяет разделять абонентов в списке, видеть на какую группу операторов звонит тот или иной абонент.

Рассмотрим упрощенный вид главного сценария. В примере перед переключением на номер отдела менеджеров (105), в контент линии абонента заносится строка "'''Менеджеры'''".

[[Файл:Перехват звонков 002.png |center]]

*Компонент "'''Контент линии'''" - добавляет информацию в контент линии. Установлены следующие настройки:
**'''Действие''' - Установить
**'''Тип объекта''' - Линия
**'''Ключ линии''' - Функция "'''Номер линии'''"
**'''Свойство/действие''' - Поле контента линии
**'''Значение''' - строка, например, "'''Менеджеры'''".

*Компонент "'''Переключение'''" - переключает абонента на пользователя или группу пользователей. Из основных настроек:
**'''Назначение''' - Внутрь
**'''Номер''' - например, '''105'''
**'''Очередь ожидания''' - Да

ВНИМАНИЕ: Добавляйте или изменяйте информацию в контенте линии перед каждым переключением в вашей системе. Данная модификация также в некоторых случаях может применяться к сценарию переключения.

=== Сценарий мониторинга для внешнего модуля===

Сценарий опрашивает каждую внешнюю линию из списка в глобальной переменной '''lines_queus''' и определяет находится ли линия в очереди. Если линия находится в очереди, то с помощью контента линии определяются все характеристики абонента (номер телефона, время в очереди, информации о переключении). Полученная информация в виде html-страницы выводится на экран в настроенном внешнем модуле.

Вид сценария представлен на рисунке:

[[Файл:Перехват звонков 003.png |center]]

*Компонент "'''Старт 1'''" - в качестве параметра запуска используется переменная '''user''' (строковая). В этой переменной будет храниться ID пользователя, от имени которого запущен данный сценарий.

*Компонент "'''URL'''" - присвоение переменной URL (строковая) строки с подключением '''к вашему Web-серверу'''. Строка должна содержать
**базовую авторизацию (для версий '''Oktell''' старше 2.9).
**IP-адрес сервера '''Oktell'''
**Порт для подключений к Web-серверу '''Oktell'''
Подробнее о настройке можно прочитать в статье: [[Настройка Web-сервера Oktell]]. В примере, '''http://user1:1@192.168.0.82:4055'''.

*Компонент "'''Ув1'''" - отладочное уведомление с выводом значения глобальной переменной '''lines_queus''' и переменной '''user'''

*Компонент "'''Id=1'''" - присваивает переменной '''id''' (число) значение '''1'''. Переменная '''id''' будет счетчиком в цикле.

*Компонент "'''HTML-1'''" - присваивает переменной '''html''' (строковая) выражение:

<nowiki>'<html></nowiki>
<nowiki><head></nowiki>
<nowiki><meta charset="utf-8"></nowiki>
<nowiki><title>Очереди</title></nowiki>

<nowiki><script type="text/javascript"></nowiki>
<nowiki>function locs()</nowiki>
<nowiki>{</nowiki>
<nowiki> document.location.href="";</nowiki>
<nowiki>}</nowiki>
<nowiki>setTimeout("locs()", 2000);</nowiki>
<nowiki></script></nowiki>

<nowiki></head></nowiki>
<nowiki><body ></nowiki>

<nowiki><iframe name="invisible" style="display:none"></iframe></nowiki>

<nowiki><table border="1" align="center" style="font: 20px arial;"></nowiki>
<nowiki><tr></nowiki>
<nowiki><td>Абонент</td></nowiki>
<nowiki><td>Набранный номер</td></nowiki>
<nowiki><td>Описание</td></nowiki>
<nowiki><td>Время в ожидании</td></nowiki>
<nowiki><td>Порядок в очереди</td></nowiki>
<nowiki><td>Перехватить</td></nowiki>
<nowiki></tr>'</nowiki>

В переменной '''html''' будет содержаться html-страница, которая будет показываться во внешнем модуле. Некоторые особенности:
:* в строке '''''setTimeout("locs()", 2000);''''' вы можете поменять период автообновления страницы. Для этого замените число '''2000''' на время в миллисекундах.
:* в строке '''''<nowiki><table border="1" align="center" style="font: 20px arial;"></nowiki>''''' вы можете поменять размер шрифта. Для этого измените выражение '''20px'''.
:* с помощью тега '''<nowiki><td></nowiki>''' вы сможете добавить или удалить столбцы в показываемой форме

*Компонент "'''Rowcount'''" - определяет количество внешних линий (тег ''<SystemNumStr>'') в XML-структуре '''lines_queues'''. В парсере определяются следующие настройки:
:* '''Документ''' - глобальная переменная '''lines_queus'''
:* '''Алгоритм''' - Язык OQuery для HTML
:* '''Поисковый запрос''' - '''SystemNumStr'''
:* '''Функция''' - Количество элементов
:* '''Результат в переменную''' - переменная '''rowcount''' (число)

*Компонент "'''Id>Rowcount'''" - определяет просмотрены ли все линии в XML-структуре. Происходит сравнение:
**'''Аргумент 1''' - переменная "'''id'''"
**'''Аргумент 2''' - переменная "'''rowcount'''"
**'''Тип сравнения''' - "'''>'''"

*Компонент "'''Line'''" - определяет содержимое тега ''<SystemNumStr>'' с номером id из XML-структуры. Результатом является номер линии.
:* '''Документ''' - глобальная переменная '''lines_queus'''
:* '''Алгоритм''' - Язык OQuery для HTML
:* '''Поисковый запрос''' - '''SystemNumStr'''
:* '''Функция''' - Содержимое
:* '''Номер элемента''' - переменная '''id'''
:* '''Результат в переменную''' - переменная '''line''' (строковая)

*Компонент "'''Позиция в очереди'''" - определяется текущая позиция в очереди у выбранной линии.
**'''Действие''' - Определить
**'''Тип объекта''' - Линия
**'''Ключ линии''' - переменная "'''line'''"
**'''Функция''' - Текущая позиция в очереди
**'''Значение в переменную''' - переменная "'''prioritet'''"

:Линии, которые не участвуют в коммутации имеют значение позиции "-1". Значение позиции "0" обозначает, что в данный момент линия коммутируется с конкретным объектом (например, групповой номер менеджеров). Значение позиции "1", "2" и т.д. обозначают, что линия находится в очереди и ожидает освобождения объекта.

*Компонент "'''Позиция >=0'''" - производит отсев линий, которые не участвуют в коммутации. Происходит сравнение:
**'''Аргумент 1''' - переменная "'''prioritet'''"
**'''Аргумент 2''' - число "'''0'''"
**'''Тип сравнения''' - "'''>='''"

*Компонент "'''Контент линии'''" - определяет контент выбранной линии в XML-формате. С помощью контента линии можно определить все параметры соединения.
**'''Действие''' - Определить
**'''Тип объекта''' - Линия
**'''Ключ линии''' - переменная "'''line'''"
**'''Функция''' - Контент линии (XML)
**'''Значение в переменную''' - переменная "'''content_of_line'''" (строковая)

ВНИМАНИЕ: Замечено, что на версиях 2.9 и ниже контент линии сохраняется в виде, например <![CDATA[Менеджеры]]>. Чтобы выделить нужную информацию используйте компонент с выражением: 
Remove( Remove( [content_of_line], Len( [content_of_line] )-3, 3 ),0 , 9 )

*Компонент "'''Ув2'''" - отладочное уведомление для вывода значения переменной "'''content_of_line'''"

*Компонент "'''Description'''" - определяет из контента линии информацию по соединению, которая задается в главном сценарии (см.выше) и помещает значение в переменную '''description'''.
:* '''Документ''' - переменная '''content_of_line'''
:* '''Алгоритм''' - Язык OQuery для HTML
:* '''Поисковый запрос''' - '''call>property_cdata[key="custominfo"]'''
:* '''Функция''' - Содержимое
:* '''Номер элемента''' - не указан
:* '''Результат в переменную''' - переменная '''description''' (строковая)

*Компонент "'''Timestart'''" - определяет из контента линии время постановки в очередь.
:* '''Документ''' - переменная '''content_of_line'''
:* '''Алгоритм''' - Язык OQuery для HTML
:* '''Поисковый запрос''' - '''commutation:last>property_simple[key="timestart"]'''
:* '''Функция''' - Значение атрибута
:* '''Номер элемента''' - не указан
:* '''Атрибут''' - строка "'''value'''"
:* '''Результат в переменную''' - переменная '''timestart''' (строковая)

*Компонент "'''CallerID'''" - определяет из контента линии номер абонента (CallerID)
:* '''Документ''' - переменная '''content_of_line'''
:* '''Алгоритм''' - Язык OQuery для HTML
:* '''Поисковый запрос''' - '''call>property_simple[key="callerid"]'''
:* '''Функция''' - Значение атрибута
:* '''Номер элемента''' - не указан
:* '''Атрибут''' - строка "'''value'''"
:* '''Результат в переменную''' - переменная '''callerid''' (строковая)

*Компонент "'''CalledID'''" - определяет из контента линии набранный номер (CalledID)
:* '''Документ''' - переменная '''content_of_line'''
:* '''Алгоритм''' - Язык OQuery для HTML
:* '''Поисковый запрос''' - '''call>property_simple[key="calledid"]'''
:* '''Функция''' - Значение атрибута
:* '''Номер элемента''' - не указан
:* '''Атрибут''' - строка "'''value'''"
:* '''Результат в переменную''' - переменная '''calledid''' (строковая)

*Компонент "'''TimeInQueu'''" - определение продолжительности нахождения абонента в очереди. В компоненте переменной '''timeinqueu''' присваивается выражение '''datediff(ss,datetime([timestart]),now)'''

*Компонент "'''Ув3'''" - отладочное уведомление для вывода всех найденных значений из контента линии.

*Компонент "'''HTML-2'''" - добавляет в HTML страницу строку с информацией об абоненте. В компоненте происходит присвоение переменной '''html''' выражения

<nowiki>[html]+endline+</nowiki>
<nowiki>'<tr></nowiki>
<nowiki><td>'+[callerid]+'</td></nowiki>
<nowiki><td>'+[calledid]+'</td></nowiki>
<nowiki><td>'+[description]+'</td></nowiki>
<nowiki><td>'+[timeinqueu]+'</td></nowiki>
<nowiki><td>'+[prioritet]+'</td></nowiki>
<nowiki><td><a target="invisible" href="'+[URL]+'/execsvcscriptplain?name=Очередь_Перехват&startparam1='+[line]+'&startparam2='+[user]+'&async=0&timeout=10">Перехватить</a></td></nowiki>
<nowiki></tr>'</nowiki>

В последней колонке используется метод '''execsvcscriptplain''' серверного HTTP интерфейса, который запускает служебный сценарий для вывода звонка из очереди с последующим перехватом. Этому сценарию передаются два стартовых параметра - '''line''' (какую линию надо перехватить) и '''user''' (на какого пользователя переключить).

*Компонент "'''Id++'''" - инкрементирует счетчик '''Id'''. На следующей ветке цикла происходят те же действия со следующей линией.

*Компонент "'''HTML-3'''" - завершает генерацию HTML-страницы. Переменной '''html''' присваивается выражение

<nowiki>[html]+endline+'</table></nowiki>
<nowiki></body></nowiki>
<nowiki></html>'</nowiki>

*Компонент "'''Ув4'''" - отладочное уведомление для вывода сгенерированной html-страницы.

*Компонент "'''Возвращаемое значение'''" - передача html-страницы во внешний модуль. В компоненте служебной переменной '''Возвращаемое значение 1 (строка)''' присваивается значение '''html'''.

=== Настройка внешнего модуля ===

Сценарий мониторинга назначается на запуск внешнего модуля с помощью серверного HTTP-интерфейса.

* Перейдите в раздел "'''Администрирование'''" - "'''Внешние модули'''".
* Перейдите на вкладку "'''Разделы меню'''"
* Нажмите кнопку "'''Добавить'''"
* Настройте свойства внешнего модуля. Основные настройки:
:*'''Тип:''' Веб-страница
:*'''Адрес страницы веб-сервиса:''' Используется метод '''execsvcscriptplain''', на вход которого передается параметр '''[user_guid]''' (ID пользователя). Укажите базовую авторизацию и IP-адрес Web-сервера '''Oktell'''.

<nowiki>http://user1:1@192.168.0.82:4055/execsvcscriptplain?name=Очередь_Мониторинг&startparam1=[user_guid]&async=0&timeout=10</nowiki>

*Назначьте права доступа на соответствующей вкладке
*Нажмите "'''Сохранить'''"

ВНИМАНИЕ: Для появления внешнего модуля, необходимо перезапустить клиентское приложение.

[[Файл:Перехват звонков 006.png|center|1000px]]

=== Сценарий перехвата===

Сценарий перехвата запускается, когда пользователь системы нажал кнопку "'''Перехватить'''" во внешнем модуле. Данный служебный сценарий предназначен для вывода линии из очереди с помощью "Мягкого сброса". В процессе работы сценарий добавляет отличительную информацию в контент линии. После работы мягкого сброса, линия попадает в ''сценарий вместо отбоя внешней линии''.

Ниже представлен вид сценария:

[[Файл:Перехват звонков 004.png|center]]

*Компонент "'''Старт 1'''" - в качестве входного параметра используется переменная '''line''' (строковая). В переменной будет содержаться номер линии, которую нужно перехватить.

*Компонент "'''user'''" - присваивает переменной '''user''' (строковая) значение функции "'''Входной параметр 2'''".

ВНИМАНИЕ: Все входные параметры передаются в web-запросе при нажатии на кнопку "'''Перехватить'''" (см.выше)

*Компонент "'''Ув1'''" - отладочное уведомление с выводом стартовых параметров '''line''' и '''user'''.

*Компонент "'''Получить Content'''" - определяет контент линии для последующего добавления служебной информации.
**'''Действие''' - Определить
**'''Тип объекта''' - Линия
**'''Ключ линии''' - переменная "'''line'''"
**'''Функция''' - Поле контента линии
**'''Значение в переменную''' - переменная "'''content'''" (строковая)

*Компонент "'''Ув2'''" - отладочное уведомление для вывода содержание переменной '''content'''.

*Компонент "'''Добавление ключа'''" - добавляет в контент линии ключ и информацию о пользователе. Ключ нужен для того, чтобы в сценарии вместо отбоя внешней линии определить, что это именно тот абонент, которого нужно перехватить. Таким образом добавляется уникальный признак в контент линии, позволяющий отделить ее от остальной массы линий, которые попадают в сценарий. В сценарии используется '''Ключ:Перехват'''. Для удобства парсинга все данные в контенте разделяются знаком дефиса.
**'''Действие''' - Установить
**'''Тип объекта''' - Линия
**'''Ключ линии''' - переменная "'''line'''"
**'''Свойство/действие''' - Поле контента линии
**'''Значение''' - выражение '''[content]+'-Ключ:Перехват-Пользователь:'+[user]'''

*Компонент "'''Мягкий сброс'''" - производит действие "'''мягкий сброс'''" на линии '''line'''.
**'''Действие''' - Установить
**'''Тип объекта''' - Линия
**'''Ключ линии''' - переменная "'''line'''"
**'''Свойство/действие''' - Мягкий сброс

=== Сценарий вместо отбоя внешней линии ===

Сценарий IVR вместо отбоя внешней линии в данном кейсе запускается после применения действия "'''Мягкий сброс'''" к линии. Основная цель сценария - определить, что линия пришла из перехвата и переключить ее на того пользователя, который нажал кнопку "'''Перехватить'''". Определение линии на принадлежность к перехвату определяется путем парсинга контента линии.

Сценарий выглядит следующим образом:

[[Файл:Перехват звонков 005.png | center]]

ВНИМАНИЕ: В данном примере, если линия не относится к перехвату то отрабатывает компонент "'''Обрыв связи'''". Если ваш ''сценарий вместо отбоя внешней линии'' сложнее, то вместо ''обрыва связи'' производите другие действия с линией.

*Компонент "'''Контент линии'''" - определяет контент линии
**'''Действие''' - Определить
**'''Тип объекта''' - Линия
**'''Ключ линии''' - функция "'''Номер линии'''"
**'''Функция''' - Поле контента линии
**'''Значение в переменную''' - переменная "'''Контент'''" (строковая)

*Компонент "'''Ув1'''" - отладочное уведомление для вывода значения переменной "'''Контент'''"

*Компонент "'''Контент пустой?'''" - если переменная "'''Контент'''" пустая, то линия не относится к перехвату. В компоненте происходит сравнение:
**'''Аргумент 1''' - переменная "'''Контент'''"
**'''Аргумент 2''' - пустая строка
**'''Тип сравнения''' - "'''<nowiki>=</nowiki>'''"

*Компонент "'''Определить ключ'''" - если контент линии не пустой, это еще не означает, что линия относится к перехвату. В данном компоненте определяется ключ, находящийся в линии. Используются регулярные выражения.
:* '''Документ''' - переменная '''Контент'''
:* '''Алгоритм''' - Регулярные выражения
:* '''Поисковый запрос''' - '''-Ключ:([^/-]+)'''
:* '''Функция''' - Содержимое
:* '''Номер элемента''' - 0
:* '''Результат в переменную''' - переменная '''Ключ''' (строковая)

*Компонент "'''Ключ=Перехват?'''" - определяет содержится ли в переменной "'''Ключ'''" значение "Перехват".
**'''Аргумент 1''' - переменная "'''Ключ'''"
**'''Аргумент 2''' - строка "'''Перехват'''"
**'''Тип сравнения''' - "'''='''"

*Компонент "'''Определить user'''" - определяет из контента линии ID пользователя, на которого нужно переключить.
:* '''Документ''' - переменная '''Контент'''
:* '''Алгоритм''' - Регулярные выражения
:* '''Поисковый запрос''' - '''-Пользователь:([^/r/n]+)'''
:* '''Функция''' - Содержимое
:* '''Номер элемента''' - 0
:* '''Результат в переменную''' - переменная '''user''' (строковая)

*Компонент "'''Имя пользователя'''" - определяет по ID пользователя его имя.
**'''Действие''' - Определить
**'''Тип объекта''' - Пользователь
**'''Ключ пользователя''' - переменная "'''user'''"
**'''Функция''' - Имя пользователя
**'''Значение в переменную''' - переменная "'''user'''" (строковая)

*Компонент "'''Замена контента'''" - Очищает пользовательский контент линии и записывает в него имя пользователя.
**'''Действие''' - Установить
**'''Тип объекта''' - Линия
**'''Ключ линии''' - функция "'''Номер линии'''"
**'''Свойство/действие''' - Поле контента линии
**'''Значение''' - переменная "'''user'''" (строковая)

*Компонент "'''Пользователь на месте'''" - нужен для тех ситуаций, когда перехватывающий находится в состоянии "'''Перерыв'''". С помощью данного компонента пользователь принудительно ставится в состоянии "'''На месте'''".
**'''Действие''' - Установить
**'''Тип объекта''' - Пользователь
**'''Ключ пользователя''' - переменная "'''user'''"
**'''Свойство/действие''' - Изменить статус
**'''Значение''' - '''1'''

*Компонент "'''Номер пользователя'''" - определяет внутренний номер пользователя, на который затем будет переключаться абонент.
**'''Действие''' - Определить
**'''Тип объекта''' - Пользователь
**'''Ключ пользователя''' - переменная "'''user'''"
**'''Функция''' - Внутренний номер
**'''Значение в переменную''' - переменная "'''Номер'''" (строковая)

*Компонент "'''Ув2'''" - отладочное уведомление для вывода на экран "'''Номер'''" и "'''user'''"

*Компонент "'''На пользователя '''" - соединение абонента и перехватывающего пользователя.
** '''Назначение''' - Внутрь
** '''Номер''' - Номер
** '''Очередь ожидания''' - Да

ВНИМАНИЕ: Включенная очередь ожидания позволяет перехватывать неограниченное количество абонентов. Все абоненты попадут в очередь к перехватывающему.

ВНИМАНИЕ: В сценарии не рассматривается обработка неудачного соединения. Вы можете самостоятельно назначить соответствующие переходы (Занято, Не отвечает, Отсутствует и т.д.), если в этом возникнет необходимость

=== Результаты работы ===

При открытии внешнего модуля пользователь видит таблицу со всеми абонентами, ожидающими в очередях:

[[Файл:Перехват звонков 008.png|center|600px]]

При нажатии на кнопку "'''Перехватить'''" пользователь соединяется с абонентом. При этом пользователь может находиться в состоянии "'''Перерыв'''"

Пользователь '''Oktell''' во время разговора может добавить в свою очередь ожидания еще несколько абонентов. В описании будет отмечено к какому пользователю относится очередь.

[[Файл:Перехват звонков 009.png|center|600px]]

Сценарий можно доработать таким образом, чтобы пользователи '''Oktell''' могли видеть только определенные очереди ожидания. Например, супервизор А видит всех абонентов кто звонит в отдел менеджеров, а супервизор Б только тех, кто звонит в отдел технической поддержки. Для этого необходимо внести дополнительные условия в сценарий мониторинга.

Внешний модуль может быть доступен только определенным пользователям. Для этого необходимо настроить права доступа для модуля.

'''Скачать сценарии:''' [[Media:%D0%9F%D0%B5%D1%80%D0%B5%D1%85%D0%B2%D0%B0%D1%82_%D0%B8%D0%B7_%D0%BE%D1%87%D0%B5%D1%80%D0%B5%D0%B4%D0%B8.zip|Перехват из очереди.zip]]

Основные моменты при установке:
#Импортируйте сценарии
#Модифицируйте главный сценарий, согласно примеру
#Настройте служебную задачу получения списка внешних линий
#Добавьте в сценарий мониторинга ваш URL для подключения к '''Web-серверу Oktell'''
#Настройте внешний модуль, согласно инструкции (см.выше)
#Перезагрузите сервер '''Oktell'''

Определение графика работы офиса

2023-03-31T11:27:34Z

Oktell Support: /* Реализация для версий Oktell ниже 2.9 */

[[Практики|Наверх]]

__TOC__

== Введение ==

В общих настройках есть следующий пункт: '''Общие настройки'''->'''График работы офиса'''.

[[Файл:ГрафикОфиса.PNG|center]]

Часто возникает вопрос как можно проверить, например, в главном IVR сценарии, соответствует ли текущее время графику работы офиса или нет.

Сами данные по графику хранятся в таблице '''[oktell_settings].[dbo].[A_Settings]''' в виде xml-структур в строках с ключами:
*<nowiki>us~~~~o_WorkTime</nowiki> (рабочее время),
*<nowiki>usd~~~o_Holidays</nowiki> (праздники)

==Реализация с помощью статуса объекта ==

Для версий '''Oktell''' старше '''2.9 131126''' определение рабочего времени доступно в сценариях с помощью компонента "'''Статус объекта'''".

[[Файл:График работы офиса -002.png|center]]

В компоненте настраиваются следующие параметры:
*'''Действие''' - Определить
*'''Тип объекта''' - Сервер
*'''Функция''' - Рабочее время по графику офиса
*'''Параметр''' - текущее время (или время, за которое проверяем график работы офиса). В примере используется функция "'''Текущие дата и время'''".
*'''Значение в переменную''' - выберите переменную для хранения результата.

Результатом является число '''1''', если время в параметре соответствует графику работы офиса и '''0''' - если не соответствует. Функция проверяет график работы офиса и праздничные дни.

==Реализация для версий Oktell ниже 2.9==

Для версий ниже 2.9 131126 можно создать сценарий, возвращающий '''1''' - время соответствует графику офиса, '''0''' - не соответствует и запускать его как вложенный. Сами xml-структуры разбираются парсером '''Oktell'''. Для графика работы офиса (в сценарии-примере):

Количество записей для дня недели: ''''>Period[WeekDay='+[деньнедели]+']'''', где '''[деньнедели]''' - переменная содержащая день недели в числовой форме: Понедельник=1, Вторник=2,.. Суббота=6, Воскресенье=0.

Период работы офиса в течении дня: ''''>Period[WeekDay='+[деньнедели]+']:eq('+Str( [количество] )+')'''', где '''[количество]''' - номер по порядку периода работы офиса в течении дня (например, офис работает с 9.00 до 12.00 и с 13.00 до 18.00 - имеем 2 периода).

В нижеприведенном примере проверяется только график, праздники не проверяются):

[[Файл:График работы офиса -001.png|center]]

ВНИМАНИЕ: Представленный сценарий является служебным. Чтобы использовать его в главном сценарии используйте IVR-версию

'''Скачать служебный сценарий:''' [[Media:ГрафикРаботыОфиса.oscr|ГрафикРаботыОфиса.oscr]] (для версий '''Oktell''' старше 2.6)

'''Скачать IVR сценарий:''' [[Media:%D0%93%D1%80%D0%B0%D1%84%D0%B8%D0%BA%D0%A0%D0%B0%D0%B1%D0%BE%D1%82%D1%8B%D0%9E%D1%84%D0%B8%D1%81%D0%B0IVR.oscr|ГрафикРаботыОфисаIVR.oscr‎]] (для версий '''Oktell''' старше 2.9 131007)

Определение графика работы офиса

2023-03-31T11:26:19Z

Oktell Support: /* Реализация для версий Oktell ниже 2.9 */

[[Практики|Наверх]]

__TOC__

== Введение ==

В общих настройках есть следующий пункт: '''Общие настройки'''->'''График работы офиса'''.

[[Файл:ГрафикОфиса.PNG|center]]

Часто возникает вопрос как можно проверить, например, в главном IVR сценарии, соответствует ли текущее время графику работы офиса или нет.

Сами данные по графику хранятся в таблице '''[oktell_settings].[dbo].[A_Settings]''' в виде xml-структур в строках с ключами:
*<nowiki>us~~~~o_WorkTime</nowiki> (рабочее время),
*<nowiki>usd~~~o_Holidays</nowiki> (праздники)

==Реализация с помощью статуса объекта ==

Для версий '''Oktell''' старше '''2.9 131126''' определение рабочего времени доступно в сценариях с помощью компонента "'''Статус объекта'''".

[[Файл:График работы офиса -002.png|center]]

В компоненте настраиваются следующие параметры:
*'''Действие''' - Определить
*'''Тип объекта''' - Сервер
*'''Функция''' - Рабочее время по графику офиса
*'''Параметр''' - текущее время (или время, за которое проверяем график работы офиса). В примере используется функция "'''Текущие дата и время'''".
*'''Значение в переменную''' - выберите переменную для хранения результата.

Результатом является число '''1''', если время в параметре соответствует графику работы офиса и '''0''' - если не соответствует. Функция проверяет график работы офиса и праздничные дни.

==Реализация для версий Oktell ниже 2.9==

Для версий ниже 2.9 131126 можно создать сценарий, возвращающий '''1''' - время соответствует графику офиса, '''0''' - не соответствует и запускать его как вложенный. Сами xml-структуры разбираются парсером '''Oktell'''. Для графика работы офиса (в сценарии-примере):

Количество записей для дня недели: ''''>Period[WeekDay='+[деньнедели]+']'''', где '''[деньнедели]''' - переменная содержащая день недели в числовой форме: Понедельник=1, Вторник=2,.. Суббота=6, Воскресенье=0.

Период работы офиса в течении дня: ''''>Period[WeekDay='+[деньнедели]+']:eq('+Str( [количество] )+')'''', где '''[количество]''' - номер по порядку периода работы офиса в течении дня (например, офис работает с 9.00 до 12.00 и с 13.00 до 18.00 - имеем 2 периода).

В нижеприведенном примере проверяется только график, праздники не проверяются):

[[Файл:График работы офиса -001.png|center]]

ВНИМАНИЕ: Представленный сценарий является служебным. Чтобы использовать его в главном сценарии используйте IVR-версию

'''Скачать служебный сценарий:''' [[Media:%D0%93%D1%80%D0%B0%D1%84%D0%B8%D0%BA%D0%A0%D0%B0%D0%B1%D0%BE%D1%82%D1%8B%D0%9E%D1%84%D0%B8%D1%81%D0%B0.oscr|ГрафикРаботыОфиса.oscr]‎] (для версий '''Oktell''' старше 2.6)

'''Скачать IVR сценарий:''' [[Media:http://wiki.oktell.ru/images/e/e0/%D0%93%D1%80%D0%B0%D1%84%D0%B8%D0%BA%D0%A0%D0%B0%D0%B1%D0%BE%D1%82%D1%8B%D0%9E%D1%84%D0%B8%D1%81%D0%B0IVR.oscr|ГрафикРаботыОфисаIVR.oscr‎]] (для версий '''Oktell''' старше 2.9 131007)

Обратный звонок с мобильного в ответ на пропущенный от Oktell

2023-03-31T11:25:26Z

Oktell Support: /* Дополнение */

[[Практики|Наверх]]

__TOC__

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

Решение задачи состоит из следующих этапов:
* При звонке клиента, находится и анализируется информация по его последней коммутации.
* Если обнаруживается, что это был неудачный исходящий звонок, клиенту предлагается соединиться с оператором, который совершал звонок.

 ВНИМАНИЕ: Если вы не используете сценарий автодозвона, вы можете пропустить следующие три пункта и переходить к модифицированию главного сценария. Это связано с тем, что в базе данных '''Oktell''' не хранится информация по неудачным исходящим звонкам с использованием сервиса автодозвона, поэтому надо самостоятельно заносить данные в отдельную таблицу.

=== Создание таблицы учета неудачных исходящих по автодозвону ===

В базе данных '''oktell''' для решения задачи используются следующие таблицы:
* таблица '''[oktell].[dbo].[A_Stat_Connections_1x1]'''. В ней можно найти все удачные исходящие звонки.
* таблица '''[oktell].[dbo].[A_Stat_FailedCalls]'''. В ней можно найти в том числе все неудачные исходящие звонки, набранные в ручном режиме.

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

Для хранения информации по всем неудачным исходящих автодозвонам создана таблица "'''FailedCalls_ACM'''" со следующими полями:
:*'''Id''' - номер записи в списке. Тип '''Int''', создается автоматически.
:*'''number''' -набираемый телефон клиента. Тип '''Nvarchar (auto)'''.
:*'''calldate''' - дата звонка. Тип '''Datetime'''.
:*'''operator''' - внутренний номер пользователя внутри АТС. '''Тип Nvarchar (auto)'''.

=== Модификация сценария автодозвона ===

В сценарий автодозвона необходимо добавить SQL-запрос с добавлением записи о исходящем звонке в таблицу '''FailedCalls_ACM'''. По умолчанию, каждый звонок считается неудачным, проверка происходит в сценарии обработки контента по ID цепочки коммутаций. Если определяется, что это был успешный звонок, то строка удаляется из таблицы.

[[Файл:ОбратныйЗвонок-001.png |center]]

Компонент "Старт 1" - в качестве параметра запуска переменная '''Номер''' (строковая). Переменная содержит набираемый номер.

Компонент "'''idchain_ACM, operator'''" - присваивает
* сессионной переменной '''idchain_ACM''' (строковая) значение функции "'''Id сессии сценария'''". Это нужно для того, чтобы определить в сценарии контента были ли коммутации по данной цепочке.
* переменной '''operator''' (строковая) значение функции '''Инициатор дозвона.Внутренний номер(пользователь).'''

Компонент "'''Дозвон'''" - производит дозвон на указанный номер. В компоненте установлены свойства:
:*'''Номер/команда''' - переменная '''Номер'''
:*'''Среда''' - Внешняя сеть
:*'''Обслуживание''' - Управляющий модуль
:*'''Направления''' - выберите направления

 ВНИМАНИЕ: Успешный переход не обозначает, что оператор дозвонился до абонента. Абонент может не взять трубку, однако сценарий автодозвона будет завершен, требуется дальнейший анализ в сценарии обработки контента. 

Компонент SQL-запроса "'''INSERT FailedCalls_ACM'''" ставится по всем неудачным веткам от компонента "'''Дозвон'''" и использует следующий текст запроса:

update FailedCalls_ACM
set calldate=getdate(),
operator=@operator,
idchain=@idchain
where number=@number

if @@rowcount=0
begin
insert into FailedCalls_ACM (number,calldate, operator, idchain)
values (@number, getdate(), @operator, @idchain)
end

где

*'''@idchain''' - переменная '''idchain_ACM''' (строковая).
*'''@number''' - переменная '''Номер''' (строковая).
*'''@operator''' - переменная '''operator''' (строковая).

Запрос позволяет использовать одну строку для одного абонента.

Если у вас более сложный сценарий, SQL-запрос добавления данных в таблицу надо поставить по неудачным веткам после каждого компонента "'''Дозвон'''"

Компонент "'''Отладочное уведомление'''" - оповещает администратора о добавленных значениях в таблицу '''FailedCalls_ACM'''. Текст уведомления - выражение:

'добавил в базу '+endline+ '[operator] '+[operator]+endline+ '[Номер] '+[Номер]+endline+ '[idchain] '+[idchain_ACM]

=== Служебный сценарий обработки контента ===

В сценарии обработки контента необходимо определить были ли коммутации по автодозвону. Если коммутации были, необходимо удалить запись о неуспешном дозвоне из таблицы '''FailedCalls_ACM'''. Сценарий выглядит следующим образом:

[[Файл:ОбратныйЗвонок-002.png |center]]

Компонент "'''Старт 1'''" - в качестве параметра запуска переменная '''content''' (строковая). Переменная содержит контент цепочки коммутаций.

Компонент "'''id chain'''" - сравнивает сессионную переменную '''idchain_ACM''' с пустой строкой. Если переменная не пустая, значит это анализ ситуации, связанной с автодозвоном.
:*'''Аргумент 1''' - переменная '''idchain_ACM'''
:*'''Аргумент 2''' - пустая строка
:*'''Тип сравнения''' - "'''='''"

Компонент "'''Количество коммутаций'''" - парсер определяет количество коммутаций по контенту.
:*'''Документ''' - переменная '''content'''
:*'''Алгоритм''' - язык OQuery для HTML
:*'''Поисковый запрос''' - строка
commutation:has([name=abonent])>[key=idconnection]
:*'''Функция''' - количество элементов
:*'''Результат в переменную''' - переменная '''comcount'''(строковая)

[[Файл:ОбратныйЗвонок-003.png |center]]

Переход к следующему компоненту происходит по основной ветке и по ветке "'''Ошибка'''".

Компонент "'''Есть коммутации?'''" - определяет были ли коммутации по автодозвону. Сравнивает переменную '''comcount''' и '''0'''.
:*'''Аргумент 1''' - переменная '''comcount'''
:*'''Аргумент 2''' - строка "'''0'''"
:*'''Тип сравнения''' - "'''>'''"

По ветке '''Ложь''', сценарий заканчивается. Это обозначает, что если коммутаций не было, их не надо удалять из таблицы. По ветке '''Правда''', необходимо удалить записи из таблицы '''FailedCalls_ACM'''.

Для этого используется компонент "'''delete failedcalls_acm'''". Выполняется следующий SQL-запрос.

delete from failedcalls_acm where idchain=@idchain

где

:*@idchain - сессионная переменная '''idchain_ACM'''.

Компонент "'''Отладочное уведомление'''" сообщает администратору об удалении записи из таблицы.

=== Модификация главного сценария ===

В начало главного сценария добавляется проверка, был ли неудачный исходящий звонок на номер абонента. Если действительно был, абоненту предлагается нажать "'''1'''" для соединения с тем сотрудником, который ему звонил.

Ниже представлена только процедура проверки. Сценарий выглядит следующим образом:

[[Файл:ОбратныйЗвонок-004.png |center]]

Компонент "'''callerid'''" - присваивает переменной '''callerid''' значение функции '''Номер абонента (CallerId)'''.

Компонент "'''Поиск внутреннего номера'''" - определяет был ли неудачный звонок абоненту. Выполняется следующий SQL-запрос:

declare @dt1 datetime
declare @dt2 datetime
declare @dt3 datetime
declare @u1 nvarchar(100)
declare @u3 nvarchar(100)

set @dt1=cast ('1900-01-01' as datetime)
set @dt2=cast ('1900-01-01' as datetime)
set @dt3=cast ('1900-01-01' as datetime)

SELECT TOP 1 @dt1=[TimeStart], @u1=[AOutNumber]
FROM [oktell].[dbo].[A_Stat_FailedCalls]
where ANumberdialed='{'+@tel+'}'
order by TimeStart desc

SELECT TOP 1 @dt2=[TimeStart]
FROM [oktell].[dbo].[A_Stat_Connections_1x1]
where (bstr=@tel and astr!='IVR') or (Astr=@tel and bstr!='IVR')
order by TimeStart desc

SELECT TOP 1 @dt3=[calldate], @u3=[operator]
FROM [oktell].[dbo].[FailedCalls_ACM]
where number=@tel
order by calldate desc

IF @dt1>@dt2 and @dt1>@dt3 begin set @u=@u1 return end
IF @dt2>@dt1 and @dt2>@dt3 begin set @u='-1' return end
IF @dt3>@dt1 and @dt3>@dt1 begin set @u=@u3 return end

где

:*@tel - переменная '''callerid'''
:*@u - переменная '''number''' (строковая)

Компонент "'''Номер не нашелся?'''" - определяет, нашелся или нет внутренний номер. Сравнивает переменную '''number''' и строку '''-1'''.
:*'''Аргумент 1''' - переменная '''number'''
:*'''Аргумент 2''' - строка "'''-1'''"
:*'''Тип сравнения''' - "'''='''"

Если номер не найден, то произойдет переход по ветке '''Правда''' далее на главный сценарий.

Если номер найден, то абоненту предлагается ввести '''1''', чтобы соединиться с тем оператором, кто ему звонил.

Используется компонент преднабора "Введите 1". Компонент имеет следующие свойства:
:* '''Файл''' - выберите звуковой файл, который будет проигрываться клиенту.
:* '''Символы прерывания''' - "1"
:* '''Макс время, с''' - максимальное время, в течении которого необходимо ввести число. В примере, '''5''' секунд.

Если клиент не хочет соединиться с оператором, то через 5 секунд, произойдет переход по ветке "'''Таймаут'''".

Если клиент нажал '''1''', то произойдет переключение на оператора с номером number.

Для этого служит компонент "'''Переключение на оператора'''"
:* '''Назначение''' - '''Внутрь'''
:* '''Номер''' - переменная '''number'''

=== Дополнение ===

При желании учитывать неудачные исходящие вызовы по задачам, необходимо использовать таблицу '''[oktell_cc_temp].[dbo].[A_Cube_CC_EffortConnections]''' по полю '''AbonentNumber'''. К сожалению, информацию по оператору вы не получите, но сможете перевести на группу ответственных менеджеров, которые объяснят почему они звонили данному абоненту.

В этом случае необходимо изменить SQL-запрос "Номер не нашелся?".

Если вы не используете автодозвон, ситуация облегчается. В этом случае необходимо только модифицировать главный сценарий.

'''Скачать файлы сценариев:''' [[Media:%D0%9E%D0%B1%D1%80%D0%B0%D1%82%D0%BD%D1%8B%D0%B9_%D0%B7%D0%B2%D0%BE%D0%BD%D0%BE%D0%BA.zip|Обратный звонок.zip]]

Запрос для создания таблицы '''FailedCalls_ACM''':

USE [oktell]
GO
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
CREATE TABLE [dbo].[FailedCalls_ACM](
[Id] [int] IDENTITY(1,1) NOT NULL,
[number] [nvarchar](2000) NULL,
[calldate] [datetime] NULL,
[operator] [nvarchar](2000) NULL,
[idchain] [nvarchar](2000) NULL,
PRIMARY KEY CLUSTERED
(
[Id] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]
GO

Отправка записей разговоров на e-mail

2023-03-31T11:24:44Z

Oktell Support: /* Установка сценария */

[[Практики|Наверх]]

__TOC__

'''Задача:''' Отправить записи разговора клиента с операторами на почту. Учесть переключения клиента между операторами.

Руководителям всех отделов, подразделений и целых предприятий бывает полезно знать как их сотрудники общаются с клиентами, верно ли они преподносят информацию о продукте, правильно ли предлагают услуги. Если не контролировать этот процесс, лояльность ваших клиентов, и их отношение к организации в целом, может упасть.

Отследить качество клиентского обслуживания и разрешить спорные ситуации, возникающие при телефонных контактах с клиентами, поможет прослушивание аудиозаписей телефонных разговоров. В '''Oktell''' все разговоры сотрудников с клиентами записываются по умолчанию.

Вы так же можете настроить автоматическую отправку отчета о разговорах на вашу электронную почту. В тексте письма вы получите дату и время звонка, имя оператора, продолжительность разговора, номер телефона клиента и его оценку разговора.

При большом количестве звонков, ваша почта может быстро переполниться, поэтому советуем настроить оповещение только в крайних случаях. Например, когда клиент поставил сотруднику оценку “'''2'''” за обслуживание.

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

Для отправки записей разговоров в сценарии используется компонент "'''Отправка Email'''". В этом компоненте возможно прикрепить до 5 вложений. Однако встает вопрос - что делать, если клиент общался больше чем с пятью операторами (суммарное количество переключение превышает 4). Существует несколько способов решения данной задачи.

'''Способ 1:''' В сценарии отправляются 5 записей разговора - это могут быть последние пять коммутаций клиента с оператором, или, например, первая и четыре последних коммутации.

*'''Достоинства:''' Такие сервисы как mail.ru или gmail.com позволяют сразу проигрывать вложенные звуковые файлы, не скачивая их. Это позволяет руководителю быстро прослушать записи разговоров прямо из окна браузера, что очень удобно.

*'''Недостатки:''' По сути, если количество коммутаций больше 5, то мы теряем часть из них. Все зависит от максимального количества переключений, которое может быть в вашей компании.

[[Файл:Отправка записей на почту 015.png |center]]

'''Способ 2:''' В сценарии все найденные записи разговоров запаковываются в zip-архив, который затем отправляется одним вложением в элекронном письме.

*'''Достоинства:''' В электронном письме может быть отправлено неограниченное количество записей (ограничение идет уже от Smtp-провайдера по максимальному размеру вложений). Если клиента переключали 10 раз между различными операторами - вы получите полную историю разговоров клиента.

*'''Недостатки:''' В отличии от первого способа, архив придется скачать и распаковать. Этот процесс может занимать некоторое время.

[[Файл:Отправка записей на почту 016.png |center]]

'''Способ 3:''' Комбинация первого и второго способов. Если количество найденных коммутаций больше пяти - они запаковываются в архив, если их пять или меньше - отправляются в электронном письме напрямую.

 Рекомендуется использовать третий способ как наиболее удобный. В статье данный способ рассматривается по частям на примере первого и второго способов.

=== Сценарий прямой отправки на email ===

Для решения задачи используется '''сценарий обработки контента'''. Сценарий выглядит следующим образом:

[[Файл:Отправка записей на почту 001.png |center]]

Компонент "'''Старт 1'''" - в качестве параметра запуска переменная '''content''' (строковая). В этой переменной будет храниться контент цепочки коммутаций.

Компонент "'''Вывод контента'''" - отладочное уведомление, выводит переменную '''content'''.

Компонент "'''Количество коммутаций'''" - Парсер, определяет количество коммутаций с операторами (исключает соединение с IVR-сценариями).
* '''Документ''' - переменная content
* '''Алгоритм''' - Язык OQuery для HTML
* '''Поисковый запрос''' - используется следующее выражение:

commutation:has([name=abonent])>[key=idconnection]

* '''Функция''' - Количество элементов
* '''Результат в переменную''' - переменная '''com_count''' ('''число'''). В переменной будет храниться количество коммутаций.

Если парсер не находит таких коммутаций, он переходит по ветке "'''Ошибка'''". Так как в сценарии специально не задается обработка ошибки, то сценарий просто заканчивает свое выполнение.

[[Файл:Отправка записей на почту 002.png |center]]

Компонент "'''Ув1'''" - отладочное уведомление, выводит переменную '''com_count'''.

Компонент "'''Счетчик'''" - присвоение переменной '''i''' (строковая) значения '''1''' (строка).

Компонент "'''Id записи'''" - парсер, определяет i-й Id коммутации, по которой в дальнейшем восстанавливается путь к файлу записи. Счетчик i в дальнейшем инкрементируется, таким образом пробегаются все коммутации клиента с операторами.

* '''Документ''' - переменная content
* '''Алгоритм''' - Язык OQuery для HTML
* '''Поисковый запрос''' - используется следующее '''выражение''':

'commutation:has([name=abonent])>[key=idconnection]:eq('+[i]+')'

* '''Функция''' - Значение атрибута
* '''Атрибут''' - value
* '''Результат в переменную''' - переменная '''id''' (строковая). В переменной будет храниться id коммутации.

[[Файл:Отправка записей на почту 003.png |center]]

Компонент "'''Путь к файлу'''" - В SQL-запросе явно прописывается в какой папке располагаются записи разговоров. Рекомендуется проверить запрос на предмет использования в вашей системе (возможно, стоит убрать ''(x86)''). Используется следующий SQL-запрос:

declare @aln nvarchar(10)
declare @bln nvarchar(10)
declare @idrecdir int
declare @ts nvarchar(50)
declare @path nvarchar(1000)
select top 1 @aln=case when alinenum<blinenum then alinenum else blinenum end,
@bln=case when blinenum>alinenum then blinenum else alinenum end,
@idrecdir=idrecdir,
@ts=replace(convert(nvarchar(10), TimeStart, 121),'-','_')+'__'+
replace(convert(nvarchar(20), TimeStart, 114),':','_') from A_Stat_Connections_1x1
where Id=@id and isrecorded=1
set @path='C:\Program Files (x86)\oktell\Server\RecordedFiles\'
if (@idrecdir>0)
select @path=path from A_Stat_RecordDirectories where id=@idrecdir
<nowiki>set @filename=@path+replace(substring(@ts, 1, 10),'_','')+'\'+substring(@ts, 13, 2)</nowiki>
+substring(@ts, 16, 2)+'\mix_'+@aln+'_'+@bln+'__'+@ts+'.mp3'

где

*'''@filename''' - переменная file (строковая)
*'''@id''' - переменная id.

Компонент "'''Вывод пути'''" - отладочное уведомление, выводит переменную '''file'''.

Компонент "'''file?'''" - Компонент меню производит циклическую запись в переменные '''file1''', '''file2''', '''file3''', '''file4''' и '''file5'''.

'''Пояснение:''' Все записи разговоров требуется отправить в компоненте '''Отправка Email'''. Компонент поддерживает до 5 вложений и эти вложения необходимо каким-либо образом указывать. Поэтому используются 5 строковых переменных '''file1'''...'''file5''', в каждую из которых в ходе цикла записывается путь к записи разговора. Путь к первой записи разговора ('''i=1''') будет записан в переменную '''file1''', путь к пятой ('''i=5''') в '''file5'''. Путь к шестой записи разговора будет перезаписан в переменную '''file1''' и так далее. Таким образом при отправке электронного письма, к нему будут прикреплены последние пять коммутаций клиента.

У компонента используются следующие настройки:

* Аргумент - выражение "'''[i]%5'''". Выражение возвращает остаток от деления переменной i на 5.
* Значения - 0, 1, 2, 3, 4.

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

* по ветке 0 - путь записывается в переменную file5 (т.к. это выполнится при i=5, 10...)
* по ветке 1 - путь записывается в переменную file1
* по ветке 2 - путь записывается в переменную file2
* по ветке 3 - путь записывается в переменную file3
* по ветке 4 - путь записывается в переменную file4

[[Файл:Отправка записей на почту 004.png |center]]

Компонент "'''Обнуление имени файла'''" - переменной "'''file'''" присваивается пустая строка.

Компонент "'''i++'''" - переменной '''i''' присваивается выражение "'''[i]+1'''"

Компонент "'''Проверка на завершение'''" - значение счетчика '''i''' после инкремента сравнивается с количеством коммутаций '''com_count'''.
* '''Аргумент 1''' - переменная '''i'''
* '''Аргумент 2''' - переменная '''com_count'''
* '''Тип сравнения''' - '''<='''

Если '''правда''', то производится еще одна итерация. Переход на компонент Id записи.

Если '''ложь''', то переход на компонент "'''Ув2'''" и в дальнейшем на отправку электронного письма.

Компонент "'''Ув2'''" - отладочное уведомление, показывает значения переменных '''file1'''..'''file5'''.

Компонент "'''Количество вложений'''" - нужен для того, чтобы правильно задать отправку e-mail письма. Если имеется 1 коммутация, то прикрепляется только переменная '''file1'''; если 4 коммутации, то соответственно настраиваются 4 вложения. Если коммутаций 5 и больше, то отправляются 5 вложений.

Компоненты '''отправка e-mail''' настраиваются одинаковым образом:
* '''Способ отправки''' - настраивается smtp-сервер, данные для авторизации.
* '''Кому''' - адрес получателя
* '''От кого''' - адрес отправителя
* '''Тема''', '''Содержание письма''' - генерируется соответствующая информация. В содержании письма можно указать с какого номера на какой номер звонил клиент, сколько времени ожидал на линии, с какими операторами разговаривал. В данном сценарии не рассматривается.
* '''Вложение 1'''..'''Вложение 5''' - указываются соответствующие переменные '''file 1'''... '''file 5'''.

[[Файл:Отправка записей на почту 006.png |center]]

===Сценарий отправки записей в zip-архиве ===

Для решения задачи используется '''сценарий обработки контента'''. Сценарий выглядит следующим образом:

[[Файл:Отправка записей на почту 007.png |center]]

В сценарии используется внешний процесс '''7za.exe''' - консольное приложение от 7-zip (скачано по ссылке [http://www.7-zip.org/download.html http://www.7-zip.org/download.html]). Данное консольное приложение предварительно скопировано на диск '''C:\'''.

'''Скачать приложение:''' [[Media:7za.zip|7za.zip]]

'''Пример''' архивации двух файлов '''C:\1.mp3''' и '''C:\2.mp3''' в архив '''С:\archive.zip''':

C:\7za.exe a -tzip c:\archive.zip "C:\1.mp3" "C:\2.mp3"

Далее рассматриваются компоненты сценария:

Компонент "'''Старт 1'''" - в качестве параметра запуска переменная '''content''' (строковая). В этой переменной будет храниться контент цепочки коммутаций.

Компонент "'''Вывод контента'''" - отладочное уведомление, выводит переменную '''content'''.

Компонент "'''Количество коммутаций'''" - Парсер, определяет количество коммутаций с операторами (исключает соединение с IVR-сценариями).
* '''Документ''' - переменная content
* '''Алгоритм''' - Язык OQuery для HTML
* '''Поисковый запрос''' - используется следующее выражение:

commutation:has([name=abonent])>[key=idconnection]

* '''Функция''' - Количество элементов
* '''Результат в переменную''' - переменная '''com_count''' ('''число'''). В переменной будет храниться количество коммутаций.

Если парсер не находит таких коммутаций, он переходит по ветке "'''Ошибка'''". Так как в сценарии специально не задается обработка ошибки, то сценарий просто заканчивает свое выполнение.

[[Файл:Отправка записей на почту 002.png |center]]

Компонент "'''Ув1'''" - отладочное уведомление, выводит переменную '''com_count'''.

Компонент "'''cmd'''" - создание командной строки для консоли '''7za.exe'''. В компоненте задано:

* Присвоение переменной '''path'''(строковая) - выражения
'c:\temp\archive'+substr(now,0,2)+substr(now,3,2)+ substr(now,8,2)+'-'+substr(now,11,2)+
substr(now,14,2)+substr(now,17,2)+'.zip'

:Переменная '''path''' содержит путь к zip-архиву. В примере, все созданные архивы будут храниться в папке "'''c:\temp'''", ее нужно будет очищать либо вручную либо автоматически с помощью сценария.

* Присвоение переменной '''cmd'''(строковая) - выражения
'a -tzip '+[path]

: В переменной '''cmd''' будут храниться все параметры командной строки, которые в конце сценария будут переданы программе '''7za.exe'''.

Компонент "'''Счетчик'''" - присвоение переменной '''i''' (строковая) значения '''1''' (строка).

Компонент "'''Id записи'''" - парсер, определяет i-й Id коммутации, по которой в дальнейшем восстанавливается путь к файлу записи. Счетчик i в дальнейшем инкрементируется, таким образом пробегаются все коммутации клиента с операторами.

* '''Документ''' - переменная content
* '''Алгоритм''' - Язык OQuery для HTML
* '''Поисковый запрос''' - используется следующее '''выражение''':

'commutation:has([name=abonent])>[key=idconnection]:eq('+[i]+')'

* '''Функция''' - Значение атрибута
* '''Атрибут''' - value
* '''Результат в переменную''' - переменная '''id''' (строковая). В переменной будет храниться id коммутации.

[[Файл:Отправка записей на почту 011.png|center]]

Компонент "'''Путь к файлу'''" - В SQL-запросе явно прописывается в какой папке располагаются записи разговоров. Рекомендуется проверить запрос на предмет использования в вашей системе (возможно, стоит убрать ''(x86)''). Используется следующий SQL-запрос:

declare @aln nvarchar(10)
declare @bln nvarchar(10)
declare @idrecdir int
declare @ts nvarchar(50)
declare @path nvarchar(1000)
select top 1 @aln=case when alinenum<blinenum then alinenum else blinenum end,
@bln=case when blinenum>alinenum then blinenum else alinenum end,
@idrecdir=idrecdir,
@ts=replace(convert(nvarchar(10), TimeStart, 121),'-','_')+'__'+
replace(convert(nvarchar(20), TimeStart, 114),':','_') from A_Stat_Connections_1x1
where Id=@id and isrecorded=1
set @path='C:\Program Files (x86)\oktell\Server\RecordedFiles\'
if (@idrecdir>0)
select @path=path from A_Stat_RecordDirectories where id=@idrecdir
<nowiki>set @filename=@path+replace(substring(@ts, 1, 10),'_','')+'\'+substring(@ts, 13, 2)</nowiki>
+substring(@ts, 16, 2)+'\mix_'+@aln+'_'+@bln+'__'+@ts+'.mp3'

где

*'''@filename''' - переменная file (строковая, выходная)
*'''@id''' - переменная id (входная, содержит ID коммутации).

Компонент "'''Вывод пути'''" - отладочное уведомление, выводит переменную '''file'''.

Компонент "'''cmd+file'''" - добавляет найденный файл к параметрам командной строки. В компоненте переменной '''cmd''' присваивается выражение

[cmd]+' "'+[file]+'"'

Компонент "'''Обнуление имени файла'''" - переменной "'''file'''" присваивается пустая строка.

Компонент "'''i++'''" - переменной '''i''' присваивается выражение "'''[i]+1'''"

Компонент "'''Проверка на завершение'''" - значение счетчика '''i''' после инкремента сравнивается с количеством коммутаций '''com_count'''.
* '''Аргумент 1''' - переменная '''i'''
* '''Аргумент 2''' - переменная '''com_count'''
* '''Тип сравнения''' - '''<='''

Если '''правда''', то производится еще одна итерация. Переход на компонент Id записи.

Если '''ложь''', то переход на компонент "'''Ув2'''" и в дальнейшем на отправку электронного письма.

Компонент "'''Ув2'''" - отладочное уведомление, показывает значения переменных '''file1'''..'''file5'''.

Компонент "'''Создание архива'''" - запускает внешний процесс '''C:\7za.exe''' с параметрами '''cmd'''.

* '''Файл''' - указывается путь к приложению. В примере, '''C:\7za.exe'''
* '''Путь''' - абсолютный
* '''Параметры командной строки''' командной строки - переменная '''cmd'''
* '''Ожидание завершения''' - Да

[[Файл:Отправка записей на почту 008.png|center]]

Компонент "'''Отправка e-mail'''" - отправляет архив с записями разговоров на электронную почту:
* '''Способ отправки''' - настраивается smtp-сервер, данные для авторизации.
* '''Кому''' - адрес получателя
* '''От кого''' - адрес отправителя
* '''Тема''', '''Содержание письма''' - генерируется соответствующая информация. В содержании письма можно указать с какого номера на какой номер звонил клиент, сколько времени ожидал на линии, с какими операторами разговаривал. В данном сценарии не рассматривается.
* '''Вложение 1''' - переменная '''path'''

[[Файл:Отправка записей на почту 010.png|center]]

=== Комбинированный метод===

На основании выше сказанного можно создать сценарий, в котором анализируется количество записей разговоров '''com_count'''. Если их больше 5, то отправка реализуется с помощью zip-архива, если 5 или меньше - отправляются вложениями.

Сценарий выглядит следующим образом:

[[Файл:Отправка записей на почту 012.png|center]]

=== Установка сценария===

Перейдите в '''Администрирование''' - '''Общие настройки''' - '''Сценарии АТС''' и укажите созданный сценарий в качестве ''Служебного сценария обработки контента''. Нажмите "'''Сохранить'''".

[[Файл:Отправка записей на почту 013.png|center]]

Также установите следующие настройки в разделе '''Администрирование''' - '''Общие настройки''' - "Управление записями разговоров". После установки нажмите "'''Сохранить'''".

[[Файл:Отправка записей на почту 014.png|center]]

При создании сценариев использовалась статья: [[Получить путь к записи разговора по завершению коммутации]]

'''Скачать файлы сценариев:''' [[Media:%D0%9A%D0%BE%D0%BD%D1%82%D0%B5%D0%BD%D1%82_%D0%97%D0%B0%D0%BF%D0%B8%D1%81%D1%8C_%D0%A0%D0%B0%D0%B7%D0%B3%D0%BE%D0%B2%D0%BE%D1%80%D0%B0.zip|Контент_Запись_Разговора.zip]]

Для использования необходимо 
'''1)''' Файл '''7za.exe''' поместить на диск '''C:'''\ 
'''2)''' Во всех компонентах отправки email поменять настройки smtp-сервера, адреса получателя и отправителя, текст письма. 
'''3)''' Обозначить сценарий в качестве служебного сценария обработки контента

Отправка записей разговоров на e-mail

2023-03-31T11:24:07Z

Oktell Support: /* Сценарий отправки записей в zip-архиве */

[[Практики|Наверх]]

__TOC__

'''Задача:''' Отправить записи разговора клиента с операторами на почту. Учесть переключения клиента между операторами.

Руководителям всех отделов, подразделений и целых предприятий бывает полезно знать как их сотрудники общаются с клиентами, верно ли они преподносят информацию о продукте, правильно ли предлагают услуги. Если не контролировать этот процесс, лояльность ваших клиентов, и их отношение к организации в целом, может упасть.

Отследить качество клиентского обслуживания и разрешить спорные ситуации, возникающие при телефонных контактах с клиентами, поможет прослушивание аудиозаписей телефонных разговоров. В '''Oktell''' все разговоры сотрудников с клиентами записываются по умолчанию.

Вы так же можете настроить автоматическую отправку отчета о разговорах на вашу электронную почту. В тексте письма вы получите дату и время звонка, имя оператора, продолжительность разговора, номер телефона клиента и его оценку разговора.

При большом количестве звонков, ваша почта может быстро переполниться, поэтому советуем настроить оповещение только в крайних случаях. Например, когда клиент поставил сотруднику оценку “'''2'''” за обслуживание.

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

Для отправки записей разговоров в сценарии используется компонент "'''Отправка Email'''". В этом компоненте возможно прикрепить до 5 вложений. Однако встает вопрос - что делать, если клиент общался больше чем с пятью операторами (суммарное количество переключение превышает 4). Существует несколько способов решения данной задачи.

'''Способ 1:''' В сценарии отправляются 5 записей разговора - это могут быть последние пять коммутаций клиента с оператором, или, например, первая и четыре последних коммутации.

*'''Достоинства:''' Такие сервисы как mail.ru или gmail.com позволяют сразу проигрывать вложенные звуковые файлы, не скачивая их. Это позволяет руководителю быстро прослушать записи разговоров прямо из окна браузера, что очень удобно.

*'''Недостатки:''' По сути, если количество коммутаций больше 5, то мы теряем часть из них. Все зависит от максимального количества переключений, которое может быть в вашей компании.

[[Файл:Отправка записей на почту 015.png |center]]

'''Способ 2:''' В сценарии все найденные записи разговоров запаковываются в zip-архив, который затем отправляется одним вложением в элекронном письме.

*'''Достоинства:''' В электронном письме может быть отправлено неограниченное количество записей (ограничение идет уже от Smtp-провайдера по максимальному размеру вложений). Если клиента переключали 10 раз между различными операторами - вы получите полную историю разговоров клиента.

*'''Недостатки:''' В отличии от первого способа, архив придется скачать и распаковать. Этот процесс может занимать некоторое время.

[[Файл:Отправка записей на почту 016.png |center]]

'''Способ 3:''' Комбинация первого и второго способов. Если количество найденных коммутаций больше пяти - они запаковываются в архив, если их пять или меньше - отправляются в электронном письме напрямую.

 Рекомендуется использовать третий способ как наиболее удобный. В статье данный способ рассматривается по частям на примере первого и второго способов.

=== Сценарий прямой отправки на email ===

Для решения задачи используется '''сценарий обработки контента'''. Сценарий выглядит следующим образом:

[[Файл:Отправка записей на почту 001.png |center]]

Компонент "'''Старт 1'''" - в качестве параметра запуска переменная '''content''' (строковая). В этой переменной будет храниться контент цепочки коммутаций.

Компонент "'''Вывод контента'''" - отладочное уведомление, выводит переменную '''content'''.

Компонент "'''Количество коммутаций'''" - Парсер, определяет количество коммутаций с операторами (исключает соединение с IVR-сценариями).
* '''Документ''' - переменная content
* '''Алгоритм''' - Язык OQuery для HTML
* '''Поисковый запрос''' - используется следующее выражение:

commutation:has([name=abonent])>[key=idconnection]

* '''Функция''' - Количество элементов
* '''Результат в переменную''' - переменная '''com_count''' ('''число'''). В переменной будет храниться количество коммутаций.

Если парсер не находит таких коммутаций, он переходит по ветке "'''Ошибка'''". Так как в сценарии специально не задается обработка ошибки, то сценарий просто заканчивает свое выполнение.

[[Файл:Отправка записей на почту 002.png |center]]

Компонент "'''Ув1'''" - отладочное уведомление, выводит переменную '''com_count'''.

Компонент "'''Счетчик'''" - присвоение переменной '''i''' (строковая) значения '''1''' (строка).

Компонент "'''Id записи'''" - парсер, определяет i-й Id коммутации, по которой в дальнейшем восстанавливается путь к файлу записи. Счетчик i в дальнейшем инкрементируется, таким образом пробегаются все коммутации клиента с операторами.

* '''Документ''' - переменная content
* '''Алгоритм''' - Язык OQuery для HTML
* '''Поисковый запрос''' - используется следующее '''выражение''':

'commutation:has([name=abonent])>[key=idconnection]:eq('+[i]+')'

* '''Функция''' - Значение атрибута
* '''Атрибут''' - value
* '''Результат в переменную''' - переменная '''id''' (строковая). В переменной будет храниться id коммутации.

[[Файл:Отправка записей на почту 003.png |center]]

Компонент "'''Путь к файлу'''" - В SQL-запросе явно прописывается в какой папке располагаются записи разговоров. Рекомендуется проверить запрос на предмет использования в вашей системе (возможно, стоит убрать ''(x86)''). Используется следующий SQL-запрос:

declare @aln nvarchar(10)
declare @bln nvarchar(10)
declare @idrecdir int
declare @ts nvarchar(50)
declare @path nvarchar(1000)
select top 1 @aln=case when alinenum<blinenum then alinenum else blinenum end,
@bln=case when blinenum>alinenum then blinenum else alinenum end,
@idrecdir=idrecdir,
@ts=replace(convert(nvarchar(10), TimeStart, 121),'-','_')+'__'+
replace(convert(nvarchar(20), TimeStart, 114),':','_') from A_Stat_Connections_1x1
where Id=@id and isrecorded=1
set @path='C:\Program Files (x86)\oktell\Server\RecordedFiles\'
if (@idrecdir>0)
select @path=path from A_Stat_RecordDirectories where id=@idrecdir
<nowiki>set @filename=@path+replace(substring(@ts, 1, 10),'_','')+'\'+substring(@ts, 13, 2)</nowiki>
+substring(@ts, 16, 2)+'\mix_'+@aln+'_'+@bln+'__'+@ts+'.mp3'

где

*'''@filename''' - переменная file (строковая)
*'''@id''' - переменная id.

Компонент "'''Вывод пути'''" - отладочное уведомление, выводит переменную '''file'''.

Компонент "'''file?'''" - Компонент меню производит циклическую запись в переменные '''file1''', '''file2''', '''file3''', '''file4''' и '''file5'''.

'''Пояснение:''' Все записи разговоров требуется отправить в компоненте '''Отправка Email'''. Компонент поддерживает до 5 вложений и эти вложения необходимо каким-либо образом указывать. Поэтому используются 5 строковых переменных '''file1'''...'''file5''', в каждую из которых в ходе цикла записывается путь к записи разговора. Путь к первой записи разговора ('''i=1''') будет записан в переменную '''file1''', путь к пятой ('''i=5''') в '''file5'''. Путь к шестой записи разговора будет перезаписан в переменную '''file1''' и так далее. Таким образом при отправке электронного письма, к нему будут прикреплены последние пять коммутаций клиента.

У компонента используются следующие настройки:

* Аргумент - выражение "'''[i]%5'''". Выражение возвращает остаток от деления переменной i на 5.
* Значения - 0, 1, 2, 3, 4.

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

* по ветке 0 - путь записывается в переменную file5 (т.к. это выполнится при i=5, 10...)
* по ветке 1 - путь записывается в переменную file1
* по ветке 2 - путь записывается в переменную file2
* по ветке 3 - путь записывается в переменную file3
* по ветке 4 - путь записывается в переменную file4

[[Файл:Отправка записей на почту 004.png |center]]

Компонент "'''Обнуление имени файла'''" - переменной "'''file'''" присваивается пустая строка.

Компонент "'''i++'''" - переменной '''i''' присваивается выражение "'''[i]+1'''"

Компонент "'''Проверка на завершение'''" - значение счетчика '''i''' после инкремента сравнивается с количеством коммутаций '''com_count'''.
* '''Аргумент 1''' - переменная '''i'''
* '''Аргумент 2''' - переменная '''com_count'''
* '''Тип сравнения''' - '''<='''

Если '''правда''', то производится еще одна итерация. Переход на компонент Id записи.

Если '''ложь''', то переход на компонент "'''Ув2'''" и в дальнейшем на отправку электронного письма.

Компонент "'''Ув2'''" - отладочное уведомление, показывает значения переменных '''file1'''..'''file5'''.

Компонент "'''Количество вложений'''" - нужен для того, чтобы правильно задать отправку e-mail письма. Если имеется 1 коммутация, то прикрепляется только переменная '''file1'''; если 4 коммутации, то соответственно настраиваются 4 вложения. Если коммутаций 5 и больше, то отправляются 5 вложений.

Компоненты '''отправка e-mail''' настраиваются одинаковым образом:
* '''Способ отправки''' - настраивается smtp-сервер, данные для авторизации.
* '''Кому''' - адрес получателя
* '''От кого''' - адрес отправителя
* '''Тема''', '''Содержание письма''' - генерируется соответствующая информация. В содержании письма можно указать с какого номера на какой номер звонил клиент, сколько времени ожидал на линии, с какими операторами разговаривал. В данном сценарии не рассматривается.
* '''Вложение 1'''..'''Вложение 5''' - указываются соответствующие переменные '''file 1'''... '''file 5'''.

[[Файл:Отправка записей на почту 006.png |center]]

===Сценарий отправки записей в zip-архиве ===

Для решения задачи используется '''сценарий обработки контента'''. Сценарий выглядит следующим образом:

[[Файл:Отправка записей на почту 007.png |center]]

В сценарии используется внешний процесс '''7za.exe''' - консольное приложение от 7-zip (скачано по ссылке [http://www.7-zip.org/download.html http://www.7-zip.org/download.html]). Данное консольное приложение предварительно скопировано на диск '''C:\'''.

'''Скачать приложение:''' [[Media:7za.zip|7za.zip]]

'''Пример''' архивации двух файлов '''C:\1.mp3''' и '''C:\2.mp3''' в архив '''С:\archive.zip''':

C:\7za.exe a -tzip c:\archive.zip "C:\1.mp3" "C:\2.mp3"

Далее рассматриваются компоненты сценария:

Компонент "'''Старт 1'''" - в качестве параметра запуска переменная '''content''' (строковая). В этой переменной будет храниться контент цепочки коммутаций.

Компонент "'''Вывод контента'''" - отладочное уведомление, выводит переменную '''content'''.

Компонент "'''Количество коммутаций'''" - Парсер, определяет количество коммутаций с операторами (исключает соединение с IVR-сценариями).
* '''Документ''' - переменная content
* '''Алгоритм''' - Язык OQuery для HTML
* '''Поисковый запрос''' - используется следующее выражение:

commutation:has([name=abonent])>[key=idconnection]

* '''Функция''' - Количество элементов
* '''Результат в переменную''' - переменная '''com_count''' ('''число'''). В переменной будет храниться количество коммутаций.

Если парсер не находит таких коммутаций, он переходит по ветке "'''Ошибка'''". Так как в сценарии специально не задается обработка ошибки, то сценарий просто заканчивает свое выполнение.

[[Файл:Отправка записей на почту 002.png |center]]

Компонент "'''Ув1'''" - отладочное уведомление, выводит переменную '''com_count'''.

Компонент "'''cmd'''" - создание командной строки для консоли '''7za.exe'''. В компоненте задано:

* Присвоение переменной '''path'''(строковая) - выражения
'c:\temp\archive'+substr(now,0,2)+substr(now,3,2)+ substr(now,8,2)+'-'+substr(now,11,2)+
substr(now,14,2)+substr(now,17,2)+'.zip'

:Переменная '''path''' содержит путь к zip-архиву. В примере, все созданные архивы будут храниться в папке "'''c:\temp'''", ее нужно будет очищать либо вручную либо автоматически с помощью сценария.

* Присвоение переменной '''cmd'''(строковая) - выражения
'a -tzip '+[path]

: В переменной '''cmd''' будут храниться все параметры командной строки, которые в конце сценария будут переданы программе '''7za.exe'''.

Компонент "'''Счетчик'''" - присвоение переменной '''i''' (строковая) значения '''1''' (строка).

Компонент "'''Id записи'''" - парсер, определяет i-й Id коммутации, по которой в дальнейшем восстанавливается путь к файлу записи. Счетчик i в дальнейшем инкрементируется, таким образом пробегаются все коммутации клиента с операторами.

* '''Документ''' - переменная content
* '''Алгоритм''' - Язык OQuery для HTML
* '''Поисковый запрос''' - используется следующее '''выражение''':

'commutation:has([name=abonent])>[key=idconnection]:eq('+[i]+')'

* '''Функция''' - Значение атрибута
* '''Атрибут''' - value
* '''Результат в переменную''' - переменная '''id''' (строковая). В переменной будет храниться id коммутации.

[[Файл:Отправка записей на почту 011.png|center]]

Компонент "'''Путь к файлу'''" - В SQL-запросе явно прописывается в какой папке располагаются записи разговоров. Рекомендуется проверить запрос на предмет использования в вашей системе (возможно, стоит убрать ''(x86)''). Используется следующий SQL-запрос:

declare @aln nvarchar(10)
declare @bln nvarchar(10)
declare @idrecdir int
declare @ts nvarchar(50)
declare @path nvarchar(1000)
select top 1 @aln=case when alinenum<blinenum then alinenum else blinenum end,
@bln=case when blinenum>alinenum then blinenum else alinenum end,
@idrecdir=idrecdir,
@ts=replace(convert(nvarchar(10), TimeStart, 121),'-','_')+'__'+
replace(convert(nvarchar(20), TimeStart, 114),':','_') from A_Stat_Connections_1x1
where Id=@id and isrecorded=1
set @path='C:\Program Files (x86)\oktell\Server\RecordedFiles\'
if (@idrecdir>0)
select @path=path from A_Stat_RecordDirectories where id=@idrecdir
<nowiki>set @filename=@path+replace(substring(@ts, 1, 10),'_','')+'\'+substring(@ts, 13, 2)</nowiki>
+substring(@ts, 16, 2)+'\mix_'+@aln+'_'+@bln+'__'+@ts+'.mp3'

где

*'''@filename''' - переменная file (строковая, выходная)
*'''@id''' - переменная id (входная, содержит ID коммутации).

Компонент "'''Вывод пути'''" - отладочное уведомление, выводит переменную '''file'''.

Компонент "'''cmd+file'''" - добавляет найденный файл к параметрам командной строки. В компоненте переменной '''cmd''' присваивается выражение

[cmd]+' "'+[file]+'"'

Компонент "'''Обнуление имени файла'''" - переменной "'''file'''" присваивается пустая строка.

Компонент "'''i++'''" - переменной '''i''' присваивается выражение "'''[i]+1'''"

Компонент "'''Проверка на завершение'''" - значение счетчика '''i''' после инкремента сравнивается с количеством коммутаций '''com_count'''.
* '''Аргумент 1''' - переменная '''i'''
* '''Аргумент 2''' - переменная '''com_count'''
* '''Тип сравнения''' - '''<='''

Если '''правда''', то производится еще одна итерация. Переход на компонент Id записи.

Если '''ложь''', то переход на компонент "'''Ув2'''" и в дальнейшем на отправку электронного письма.

Компонент "'''Ув2'''" - отладочное уведомление, показывает значения переменных '''file1'''..'''file5'''.

Компонент "'''Создание архива'''" - запускает внешний процесс '''C:\7za.exe''' с параметрами '''cmd'''.

* '''Файл''' - указывается путь к приложению. В примере, '''C:\7za.exe'''
* '''Путь''' - абсолютный
* '''Параметры командной строки''' командной строки - переменная '''cmd'''
* '''Ожидание завершения''' - Да

[[Файл:Отправка записей на почту 008.png|center]]

Компонент "'''Отправка e-mail'''" - отправляет архив с записями разговоров на электронную почту:
* '''Способ отправки''' - настраивается smtp-сервер, данные для авторизации.
* '''Кому''' - адрес получателя
* '''От кого''' - адрес отправителя
* '''Тема''', '''Содержание письма''' - генерируется соответствующая информация. В содержании письма можно указать с какого номера на какой номер звонил клиент, сколько времени ожидал на линии, с какими операторами разговаривал. В данном сценарии не рассматривается.
* '''Вложение 1''' - переменная '''path'''

[[Файл:Отправка записей на почту 010.png|center]]

=== Комбинированный метод===

На основании выше сказанного можно создать сценарий, в котором анализируется количество записей разговоров '''com_count'''. Если их больше 5, то отправка реализуется с помощью zip-архива, если 5 или меньше - отправляются вложениями.

Сценарий выглядит следующим образом:

[[Файл:Отправка записей на почту 012.png|center]]

=== Установка сценария===

Перейдите в '''Администрирование''' - '''Общие настройки''' - '''Сценарии АТС''' и укажите созданный сценарий в качестве ''Служебного сценария обработки контента''. Нажмите "'''Сохранить'''".

[[Файл:Отправка записей на почту 013.png|center]]

Также установите следующие настройки в разделе '''Администрирование''' - '''Общие настройки''' - "Управление записями разговоров". После установки нажмите "'''Сохранить'''".

[[Файл:Отправка записей на почту 014.png|center]]

При создании сценариев использовалась статья: [[Получить путь к записи разговора по завершению коммутации]]

'''Скачать файлы сценариев:''' [http://wiki.oktell.ru/images/7/7e/%D0%9A%D0%BE%D0%BD%D1%82%D0%B5%D0%BD%D1%82_%D0%97%D0%B0%D0%BF%D0%B8%D1%81%D1%8C_%D0%A0%D0%B0%D0%B7%D0%B3%D0%BE%D0%B2%D0%BE%D1%80%D0%B0.zip Контент_Запись_Разговора.zip]

Для использования необходимо 
'''1)''' Файл '''7za.exe''' поместить на диск '''C:'''\ 
'''2)''' Во всех компонентах отправки email поменять настройки smtp-сервера, адреса получателя и отправителя, текст письма. 
'''3)''' Обозначить сценарий в качестве служебного сценария обработки контента

Учет опозданий сотрудников

2023-03-31T11:21:57Z

Oktell Support: /* Результат работы */

[[Практики|Наверх]]

__TOC__

'''Задача:''' вести статистику по опозданиям сотрудников.

Каждый руководитель хочет быть уверен в соблюдении правил внутреннего распорядка своими сотрудниками. Одним из критериев ответственности сотрудника является время появления на работе. '''Oktell''' позволяет автоматизировать эту проверку.

=== Способы проверки ===

Существует несколько способов проверки появления сотрудника на работе. Рассмотрим их на примере. Пусть компания начинает работу в 9-00.

'''Способ 1. Проверка дозвоном.'''

Каждый день в 9-05 производится обзвон всех сотрудников. Если сотрудник снимает трубку, то считается, что он на рабочем месте.

Достоинства:
* Проверяет наличие сотрудника на рабочем месте

Недостатки:
* Вместо проверяемого сотрудника, трубку может снять его коллега.
* Возможность установить софтфон на телефоне, используя технологию SIP Forking, позволяет сотруднику взять трубку где угодно при наличии интернета. Однако, чаще всего сотрудники не знают паролей от своих устройств.

'''Способ 2. Проверка по клиентскому приложению.'''

В 9-05 служебный сценарий обращается в таблицу '''[oktell].[dbo].[A_CallCenter_UserStateHistory]'''. В этой таблице хранится время запуска клиентского приложения (столбец '''TimeEnter''') и время, когда клиентское приложение было закрыто (столбец '''TimeLeave'''). Для того, чтобы использовать эту идею необходимо включенное клиентское приложение.

Достоинства:
* Не отвлекает сотрудника от работы

Недостатки:
* Клиентское приложение должно быть обязательно включено
* При наличии домена для веб-клиента или веб-оператора, сотрудник может отметиться, зайдя на веб-сервис со своего смартфона.

'''Способ 3. Смешанный вариант.'''

Если при проверке SQL-запросом сотрудник показан, как отсутствующий в системе (не включено клиентское приложение), то вполне возможно, что он забыл включить клиентское приложение или возникли технические неполадки. Если сотрудник отмечен как пользователь по умолчанию для своего телефона, то ему можно сделать дозвон и проверить на месте ли он находится.

Достоинства:
* Если у сотрудника не включено клиентское приложение, система пытается дозвонится до сотрудника.

Недостатки:
* Такие же, как у '''варианта 1''' - трубку могут поднять другие сотрудники. Однако, этот вариант можно обработать отдельно и записать в отчет с особой пометкой.

В этой статье рассматривается смешанный вариант учета опозданий.

=== Создание таблицы ===

Предварительно создается таблица '''latecomers''', в которой будет храниться вся информация по сотрудникам. Таблица имеет следующие поля:

* '''Id''' - номер записи в списке. Тип '''Int''', создается автоматически.
* '''date''' - дата и время проверки. Тип '''Datetime'''.
* '''user''' - имя пользователя. Тип '''NVarchar (auto)'''.
* '''status''' - результат проверки. Тип '''NVarchar (auto)'''.
* '''time''' - время, с которого у пользователя включено клиентское приложение. Тип '''Datetime'''.
* '''iduser''' - идентификатор пользователя. Нужен для нахождения внутреннего номера. Тип '''NVarchar (auto)'''.

=== Реализация сценария ===

Сценарий выглядит следующим образом:

[[Файл:Учет опозданий-001.png | center ]]

Структурно сценарий состоит из
* SQL-запроса проверки включенных клиентских приложений
* Цикла по пользователям. Блок взят из статьи [[Построковая обработка sql выборки в сценарии]] (Вариант 1)
* Дозвон до пользователя и занесение результата

Компонент "'''Проверка по таблице'''" - SQL-запрос определяет запущено ли клиентское приложение у сотрудника и записывает результаты в таблицу.

with ausers as
(
select getdate() ddt,us.Name,'На месте' status,uh.TimeEnter, us.ID
from [oktell].[dbo].[A_CallCenter_UserStateHistory] uh
inner join A_Users us
on uh.operatorid=us.ID
where GETDATE()>TimeEnter
and (GETDATE()<TimeLeave or TimeLeave is null)
and uh.State =0
)

insert into latecomers (date,[user],status,time,iduser)
select * from ausers
union all
select getdate(),Name,'0',null, ID
from A_Users
where id not in (select id from ausers)

Компонент "'''id_before'''" - присваивает переменной '''id_before''' (строковая) значение "'''-1000'''". Нужен для перебора сотрудников в таблице latecomers, у которых еще нет статуса (не определены с прошлого шага).

Компонент "'''Определяем следующего'''" - SQL-запрос определяет следующего пользователя в таблице latecomers, которому нужно позвонить.

select top 1 @id=id, @iduser=iduser, @user=[user]
from latecomers
where id > @id_before
and status='0'
and cast(floor(cast(getdate() as float)) as datetime) = cast(floor(cast(date as float)) as datetime)

set @rowcount=@@rowcount

где

*'''@id''' - переменная id_after (строковая). Переменная содержит номер найденного пользователя в таблице latecomers.
*'''@id_before''' - переменная id_before.
*'''@iduser''' - переменная iduser (строковая). Переменная содержит id пользователя.
*'''@rowcount''' - переменная rowcount (строковая). Переменная содержит количество найденных строк.
*'''@user''' - переменная user (строковая). Переменная содержит имя пользователя.

Компонент "'''Проверка на завершение'''" - определяет завершен ли перебор по пользователям. Сравнение переменной rowcount с "'''0'''".

Компонент "'''id_before=id_after'''" - переприсваивает переменную '''id_before''', чтобы найти следующего пользователя. Также обнуляет переменную '''prefix'''.
* переменной '''idbefore''' присваивает переменную id_after
* переменной '''prefix''' присваивает пустую строку

Компонент "'''Внутренний номер по id'''" - SQL-запрос находит по таблице внутренний номер пользователя по его идентификатору iduser.

 ВНИМАНИЕ: У пользователя должен быть "нативный" номер, то есть такой стандартный внутренний номер, в котором только один объект - данный пользователь. Иначе запрос не найдет внутренний номер этого пользователя.

SELECT TOP 1 @prefix=np.Prefix FROM A_NumberPlan np
INNER JOIN A_NumberPlanAction npa ON np.ID=npa.NumID AND npa.ExtraId IN
(SELECT RuleID FROM A_RuleRecords
WHERE reactid=@userid AND InnerAddressType=0
AND RuleID IN
(SELECT RuleID FROM A_RuleRecords
GROUP BY RuleID HAVING COUNT(*)=1))
ORDER BY np.Prefix

где

*'''@prefix''' - переменная prefix, содержит внутренний номер пользователя
*'''@userid''' - переменная iduser

Компонент "'''Дозвон'''" - происходит дозвон до пользователя. Если пользователь поднимет трубку или занят (в разговоре) - считается, что он на месте.

* '''Номер/команда''' - prefix
* '''Среда''' - Внутренний номерной план
* '''Обслуживание''' - IVR
* '''Сценарий IVR''' - предварительно созданный IVR сценарий "Учет опозданий IVR". Сценарий достаточно простой - после того, как сотрудник берет трубку, связь обрывается. Здесь можно поставить звуковое оповещение сотрудника о том, что это проверка.

[[Файл:Учет опозданий-002.png | center]]

* '''Caller ID''' - "Proverka" (устанавливается по желанию, сотрудники будут видеть это название на табло телефона)
* '''Caller Name''' - "Proverka" (аналогично полю Caller ID)
* '''Очередь ожидания''' - Нет
* '''Время ожидания''' - 40 секунд. Максимальное время за которое сотрудник должен поднять трубку, чтобы система отметила его как на месте.

Компоненты "'''На месте'''" , "'''Занято'''" или "'''Нет на месте'''" - SQL-запросы для обновления статуса в таблице '''latecomers'''. Переход к этим компонентам происходит по веткам от предыдущего компонента "'''Дозвон'''". Соответственно:

update latecomers
set status = 'На месте (Взял трубку)'
where iduser=@iduser

update latecomers
set status = 'На месте (Занято)'
where iduser=@iduser

update latecomers
set status = 'Нет на месте'
where iduser=@iduser

где

*'''@iduser''' - переменная iduser (во всех запросах).

=== Создание служебной задачи===

Данный сценарий необходимо назначить на служебную задачу. Переходим «'''Администрирование'''» - «'''Общие настройки'''» - вкладка «'''Служебные задачи'''» - «'''Добавить'''»

* Выбираем для запуска данный сценарий.
* Указываем расписание - с понедельника по пятницу, с 9:05 до 9:10.
* Тип запуска - периодический, раз в сутки.
* Нажимаем «'''Сохранить'''» и активируем служебную задачу.

 Служебный сценарий не рекомендуется отдельно запускать, так как служебная задача не будет работать. Если вы запустили отдельно служебный сценарий, то вам надо переактивировать служебную задачу.

[[Файл:Учет опозданий-004.png | center | 600px]]

=== Результат работы ===

В таблице latecomers формируется следующая информация:

[[Файл:Учет опозданий-003.png|center]]

'''Файл сценария:''' [[Media:%D0%A3%D1%87%D0%B5%D1%82_%D0%BE%D0%BF%D0%BE%D0%B7%D0%B4%D0%B0%D0%BD%D0%B8%D0%B9.zip|Учет опозданий.zip]]

'''Запрос для создания таблицы:'''

USE [oktell]
GO
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
CREATE TABLE [dbo].[latecomers](
[Id] [int] IDENTITY(1,1) NOT NULL,
[date] [datetime] NULL,
[user] [nvarchar](2000) NULL,
[status] [nvarchar](2000) NULL,
[time] [datetime] NULL,
[iduser] [nvarchar](2000) NULL,
PRIMARY KEY CLUSTERED
(
[Id] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]
GO

Определение CallerID и CalledID

2023-03-31T11:20:48Z

Oktell Support: /* Шаг. Установка сценария */

[[Практики|Наверх]]

__TOC__

Идентификация абонента в системе '''Oktell''' при входящем звонке часто происходит по таким характеристикам, как '''CallerId''' и '''CalledId'''.
* '''CallerId''' - номер звонящего.
* '''CalledId''' - набранный номер.

'''Пример''': Клиент '''89171234567''' набрал номер компании Телефонные Системы '''84952294989'''. '''Oktell''' определяет ''CallerId = 89171234567'' и ''CalledId = 84952294989''.

В этой статье разбираются случаи, если эти параметры не соответствуют действительности, их значения отличны от реальных. Неправильное определение полностью зависит от вида SIP-пакета с INVITE-запросом от внешнего шлюза (провайдер, оборудование).

== Источник определения CallerId ==

Если при работе в '''Oktell''' замечено некорректное распознавание '''CallerId''', вы можете попробовать изменить '''Источник определения CallerId''' в SIP-пакете.

* Зайдите в '''Администрирование''' - '''Параметры аппаратуры'''.
* Перейдите настройки шлюза. Измените параметр "'''Источник определения CallerId'''". Параметр влияет на распознавание '''CallerId''' в принятом INVITE-пакете. Выберите одно из трех значений (каждое значение - это поле в пакете INVITE):
:* '''From: Uri'''
:* '''From: DispayName'''
:* '''Contact: Uri'''

Нажмите "'''Сохранить'''".

[[Файл:Сценарий преобразования CallerID-001.png |center | 700px]]

В случае, если ни один из этих вариантов не обеспечивает нужного результата, необходимо использовать ''Служебный сценарий преобразования CallerId''.

== Сценарий преобразования CallerId ==

===Шаг. Разбор SIP-пакета===

Определите, что во входящем SIP-пакете вообще присутствует искомый '''CallerId''' или '''CalledId'''.

Все поступающие SIP-пакеты записываются в '''trn'''-лог. Лог располагается по пути '''server\log\hardware\sip'''. Откройте лог за текущую дату и найдите вид INVITE-пакета.

'''Ключевые слова:''' RECV, FROM {Внешний IP-адрес}, INVITE

По виду '''INVITE'''-пакета вы сможете определить:
* приходит ли правильная информация
* в каком поле располагается '''CallerID''' и корректно определить его в модуле "Параметры аппаратуры"
* в каком поле располагается '''CalledID''' и программно переопределить его.

На рисунке показан пример SIP-пакета, в котором в поле '''INVITE''' подставлен некорректный '''CalledId'''. Необходимо программно переопределить '''CalledId'''.

[[Файл:Сценарий преобразования CallerID-002.png |center ]]

===Шаг. Сохранение SIP-сообщения===

В модуле "'''Параметры аппаратуры'''" в настройках шлюза (см. выше) установите параметру "'''Источник определения CallerId'''" в значение "'''Сообщение полностью'''". Нажмите "'''Сохранить'''".

[[Файл:Сценарий преобразования CallerID-003.png |center | 700px]]

===Шаг. Создание сценария===

Перейдите в '''Администрирование''' - '''Сценарии'''. Создайте служебный сценарий "'''Преобразование CallerId и CalledId'''". Вид сценария показан ниже:

[[Файл:Сценарий преобразования CallerID-004.png |center ]]

'''1.''' Компонент "'''Старт'''". Задан параметр запуска - переменная '''CallerID''' (строковая). В нее будет записан полностью весь текст SIP пакета.

'''2.''' Компонент "'''CalledID'''" - парсит SIP-пакет и определяет значение '''CalledID''' (строковая) из поля "'''To:'''". Используются регулярные выражения:

To:\s<sip:([^@]+)

'''3.''' Компонент "'''CallerID'''" - определяет '''CallerID''' из поля "'''Contact:'''". Используются регулярные выражения:

Contact:\s<sip:([^@]+)

ВНИМАНИЕ:Не обязательно использовать только поле Contact. Вы также можете самостоятельно найти DisplayName и Uri и использовать их.

Как видим, хоть '''CallerID''' изначально правильно определялся в системе, но нам пришлось заново его определять, так как система записала полностью сообщение в эту переменную. Важно, что вначале определяется '''CalledId''', а затем '''CallerId'''.

[[Файл:Сценарий преобразования CallerID-006.png | center]]

'''4.''' Компонент "'''8+Called'''" - фактически, приводит '''CalledId''' к общепринятому 11-значному формату. Добавляет "'''8'''" к началу номера с помощью выражения:

'8'+[CalledID]

'''5.''' Компонент "'''8+Called'''" - действие, аналогично предыдущему. Компонент

'8'+[CalledID]

'''6.''' Компонент "'''Возвращаемые значения'''" нужен чтобы ввести в систему найденные значения присваиваем
* служебной переменной "'''Возвращаемое значение'''" значение переменной '''CallerID'''
* служебной переменной "'''Возвращаемое значение 2'''" значение переменной '''CalledID'''

'''7.''' Компонент "'''Отладочное уведомление'''" выводит информацию о найденных значениях на экран.

'[CalledID] '+[CalledID]+endline+
'[CallerID] '+[CallerID]

'''8.''' Перейдите на вкладку '''Сохранение''' и сохраните сценарий с помощью кнопки "'''На сервер'''".

===Шаг. Установка сценария===

Перейдите в '''Администрирование''' - '''Общие настройки''' - '''Сценарии АТС''' и укажите созданный сценарий в качестве ''Служебного сценария преобразования CallerID''. Нажмите "'''Сохранить'''".

[[Файл:Сценарий преобразования CallerID-005.png |center ]]

'''Скачать сценарий:''' [[Media:%D0%9F%D1%80%D0%B5%D0%BE%D0%B1%D1%80%D0%B0%D0%B7%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5_CallerId_%D0%B8_CalledId.zip|Преобразование CallerId и CalledId.zip]]

'''Техническая документация:''' [[Сценарии_АТС#SvcCallerIdModify|Служебный сценарий преобразования CallerId]]

Про компонент '''Парсер''' написано в статье: [[Компонент Парсер]]

Компонент Парсер

2023-03-31T11:19:13Z

Oktell Support: /* Язык OQuery для HTML */

[[Практики | Наверх ]]

__TOC__

Компонент "'''Парсер'''" предназначен для разбора текстовых структур.

* Для разбора обычного текста применяются '''регулярные выражения'''
* Для разбора гипертекста или XML-структуры применяется '''парсер OQuery'''
* Для разбора JSON-структура применяется '''парсер JSON'''

Входным аргументом для парсера является '''Документ''' (структура, подлежащая разбору). '''Документ''' может быть задан текстом, через переменную или выражение, с помощью функции. Далее, в зависимости от документа, задается алгоритм поиска и поисковый запрос. При необходимости задаются дополнительные параметры: '''Функция''' и '''Номер элемента'''. Результат разбора документа ("парсинга") сохраняется в переменную (поле "'''Результат в переменную'''").

Если с помощью одного парсера невозможно определить искомое выражение, необходимо использовать последовательность из таких компонентов. Каждый следующий парсер получает на вход результат от предыдущего компонента. Таким образом, возможен сколь угодно глубокий поиск нужной информации.

В этой статье подробно рассматривается применение каждого алгоритма и примеры использования парсера.

[[Файл:Парсер-001.png | center | 500 px]]

=== Язык OQuery для HTML ===

'''Язык OQuery''' применяется для разбора гипертекста или XML-структуры.

Для тестирования запросов применяется программа [[Media:OQuery-tester.zip|'''OQuery-tester.exe''']].

Рассмотрим следующую XML-структуру:

<?xml version="1.0" encoding="utf-16"?>
<info>
<list index="1" name="matrix33">
<row id="1" name="aaa">
<col id="1" name="r1c1" />
<col id="2" name="r1c2" />
<col id="3" name="r1c3" />
</row>
<row id="2" name="bbb">
<col id="1" name="r2c1" />
<col id="2" name="r2c2" />
<col id="3" name="r2c3" />
</row>
<row id="3" name="ccc">
<col id="1" name="r3c1" />
<col id="2" name="r3c2" />
<col id="3" name="r3c3" />
</row>
</list>
<list index="2" name="matrix22">
<row id="1" name="ddd">
<col id="1" name="element11" />
<col id="2" name="element12" />
</row>
<row id="2" name="eee">
<col id="1" name="element21" />
<col id="2" name="element22" />
</row>
</list>
<list index="3" name="matrixnull">
</list>
</info>

XML-структура представляет из себя два листа, на первом листе матрица 3x3, на другом матрица 2x2. Ниже приведены запросы как можно добраться до каждого компонента в представленной структуре.

* '''info''' - запрос отображает все теги ''<info>'' и их содержимое.

* '''list''' - запрос отображает все теги ''<list>'' и их содержимое. В примере, информация по двум листам.

* '''list[index="2"]''' - запрос отображает все теги ''<list index="2">'' (у которых атрибут index=2) и их содержимое. В примере, вся информация во втором листе.

* '''col[id="2"]''' - запрос отображает все теги ''<col id="2">'' (у которых атрибут id="2"). В примере, все элементы во втором столбце в обеих матрицах.

* '''list[index="2"] col[id="2"]''' - запрос отображает все теги ''<col id="2">'', которые находятся в ''<list index="2">''. В примере, это все элементы во втором столбце, которые находятся на втором листе.

* '''col[id="2"][name="element22"]''' - запрос отображает все теги ''<col id="2" name="element22" />''

* '''(col[id="1"]):last:parent''' - запрос отображает родительский тег ('':parent'') у последнего тега ('':last'')'' <col id="1"''>.

После того, как вы доберетесь до нужного тега, например ''<col id="1" name="element21" />'' вы можете определить значение каждого атрибута (id, name). Для этого воспользуйтесь свойством компонента "'''Функция'''" и выберите "'''Значения атрибута'''", а в поле "'''Атрибут'''" введите название, например name.

Если запрос возвращает несколько тегов, вы можете перебрать каждый в цикле, воспользовавшись полем "'''Номер элемента'''". Количество найденных тегов можно найти с помощью функции "'''Количество элементов'''".

Синтаксис языка '''OQuery''' также описан в технической документации: [[Общие_компоненты_сценариев#.D0.9F.D0.B0.D1.80.D1.81.D0.B5.D1.80_.D1.82.D0.B5.D0.BA.D1.81.D1.82.D0.B0 | Парсер]]

Пример использования: [[Служебный_сценарий_обработки_контента]]

[[Файл:Парсер-002.png | center | 700 px]]

=== Регулярные выражения ===

'''Регулярные выражения''' - формальный язык поиска и осуществления манипуляций с подстроками в тексте, основанный на использовании метасимволов. В Oktell регулярные выражения можно использовать для того, чтобы найти в тексте отдельно стоящее слово или найти все слова после заданного.

Тестировать регулярные выражение можно с помощью сервиса [http://www.regexr.com/ http://www.regexr.com/]

Регулярные выражения могут применяться, например, в задаче распознавания '''mailer-daemon''' (электронные письма о неудачной доставке). Например, вы делаете рассылку электронных писем, однако некоторые электронные адреса являются не валидными. При попытке отправки на такой адрес, на почту приходит письмо о неудачной доставке. Часть такого письма показана ниже:

Delivery to the following recipient failed permanently:

oktell@mail.ru

Technical details of permanent failure:
Google tried to deliver your message, but it was rejected by the server for the recipient domain mail.ru by mxs.mail.ru. [94.100.176.20].

The error that the other server returned was:
550 spam message rejected. Please visit http://help.mail.ru/notspam-support/id?c=8JqX
A-SgNbLWePr06WQuKoX2oyRiVZYKKcj1vWDyM~ or report details to abuse@corp.mail.ru.
Error code: 03979AF0B235A0E4FFFA78D642964EA76A5FA8E2592546328F9CA260D04BD65B. ID: 0000000B000054D5230F090F.

----- Original message -----

X-Received: by 10.194.94.137 with SMTP id dc9mr4910734wjb.38.1380271480979;
Fri, 27 Sep 2013 01:44:40 -0700 (PDT)
X-Forwarded-To: oktell@mail.ru
X-Forwarded-For: oktell@gmail.com oktell@mail.ru
Delivered-To: oktell@gmail.com
Received: by 10.216.42.200 with SMTP id j50csp355274web;
Fri, 27 Sep 2013 01:44:38 -0700 (PDT)
X-Received: by 10.58.100.144 with SMTP id ey16mr5269098veb.25.1380271477282;
Fri, 27 Sep 2013 01:44:37 -0700 (PDT)
Return-Path: <576@oktell.ru>
Received: from mail-ve0-f179.google.com (mail-ve0-f179.google.com [209.85.128.179])
by mx.google.com with ESMTPS id om2si1573076vec.37.1969.12.31.16.00.00
(version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128);
Fri, 27 Sep 2013 01:44:37 -0700 (PDT)
Received-SPF: neutral (google.com: 209.85.128.179 is neither permitted nor denied by best guess record
for domain of 576@oktell.ru) client- ip=209.85.128.179;
Authentication-Results: mx.google.com;
spf=neutral (google.com: 209.85.128.179 is neither permitted nor denied by best guess record for domain
of 576@oktell.ru) smtp.mail=576@oktell.ru
Received: by mail-ve0-f179.google.com with SMTP id c14so1802657vea.10
for <oktell@gmail.com>; Fri, 27 Sep 2013 01:44:36 -0700 (PDT)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;

Ниже показаны примеры регулярных выражений:

* '''\S+''' - все целые слова

* '''[A-Z][A-Za-z]+''' - все слова, начинающиеся на прописную букву, за которой идет либо прописная либо строчная буква несколько раз.

* '''X\-Forwarded\-For\:\s*(\S+(?:[^\r\n]+\S+)*)''' - находит все электронные почты, после ''X-Forwarded-For:'' до переноса строки.

* '''(?:[a-zA-Z0-9][a-zA-Z0-9\-\.]*@)?(?:[a-zA-Z0-9][a-zA-Z0-9\-]*\.)+[a-zA-Z]{2,999}''' - находит все электронные адресы и электронные почты в тексте.

Перед группой рекомендуется ставить знак '''?:''' , чтобы возвратить значение в '''Oktell'''

Если запрос возвращает несколько значений, перебор возможен с помощью цикла. Количество найденных значений можно найти с помощью функции "'''Количество элементов'''".

[[Файл:Парсер-003.png | center | 700 px]]

=== Парсер JSON ===

'''JSON''' - текстовый формат обмена данными, основанный на '''JavaScript''' и обычно используемый именно с этим языком.

Посмотреть структуру '''JSON'''-документа позволяет сервис [http://www.jsoneditoronline.org/ http://www.jsoneditoronline.org/]

Рассмотрим следующий документ:

{
"info": {
"list1": {
"index": 1,
"name": "matrix",
"rows": [
{
"id": 1,
"name": "row1",
"cols": [
{
"id": "1",
"name": "element11"
},
{
"id": "2",
"name": "element12"
}
]
},
{
"id": 2,
"name": "row2",
"cols": [
{
"id": "1",
"name": "element21"
},
{
"id": "2",
"name": "element22"
}
]
}
]
}
}
}

В документе описана матрица 2x2, которая находится на первом листе в ''info''.

'''Oktell''' имеет собственный синтаксис разбора '''JSON'''-объектов. В принципе синтаксис простейший: доступ к значению идет по имени в кавычках, доступ к вложенным объектам — через /, доступ к элементу массива по индексу. В качестве примера, рассмотрим следующие запросы:

* '''"info"/"list1"/"name"''' - получить значение по имени name у объекта ''list1'' в объекте ''info''. Запрос вернет: '''"matrix"'''.
* '''"info"/"list1"/"rows"/1/"name"''' - получить значение по имени name у второго элемента (отсчет элемент начинается с нуля) в массиве ''rows''. Запрос вернет '''"row2"'''.
* '''"info"/"list1"/"rows"/1/"cols"/0/"name"''' - получить значение по имени ''name'' у первого элемента в массиве ''cols'' у второй строки на первом листе. Запрос вернет '''"element21"'''

'''Техническая документация:''' [[Общие_компоненты_сценариев#json | Парсер JSON]]

[[Файл:Парсер-004.png | center | 700 px]]