Компонент Модификация сессии

Описание

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

Table 1. Системные характеристики

Индекс

307

Краткое название

modify_get_session

Типы сценариев

chatbot

Стартовый модуль

r_script_chatbot_component_modify_get_session

Режим

Асинхронный

Иконка

307

Характер разветвления

Разветвляющий, замыкающий

Свойства

Table 2. Свойства
Спецификация Описание

Название: Действие
Код: action
Усл. видимости: нет
По умолчанию: — 

Выбор действия.
Возможные варианты:

  • Получить (get, 0) – Возвращает значение указанного атрибута.

  • Установить (set, 1) – Устанавливает значение для указанного атрибута.

  • Отправить событие (event, 2) – Отправляет команду в текующую сессию.

Название: Параметр
Код: parametersGet
Усл. видимости: да
По умолчанию: — 

Выбор команды для действия Получить.
Возможные варианты:

  • Приоритет ротации (rot_priority, 0) – Возвращает текущее значение приоритета в ротации.

  • Приоритет очереди (hunt_priority, 1) – Возвращает текущее значение приоритета в очереди.

  • Таймер ответа оператора, с (timersec, 3) – Возвращает устанавленное значение – количество секунд, передаваемое в websocket-API для приложения АРМ оператора с целью отображения таймера времени ответа. На работу системы не влияет.

  • Пользовательское свойство (custom_prop, 2) – Возвращает значение указанного пользовательского свойства.

  • Id канала абонента (channel_id, 4) – Возвращает идентификатор канала абонента. Задается при создании сессии компонентом (Операция с текстовой сессией).

  • Id абонента (abon_id, 5) – Возвращает идентификатор абонента. Задается при создании сессии компонентом (Операция с текстовой сессией)

  • Доп. параметры абонента (extparams, 6) – Возвращает доп.параметры идентификации абонента. Задается при создании сессии компонентом (Операция с текстовой сессией)

  • Последнее сообщение от (last_msg_from, 7) – Возвращает строку abonent или operator в зависимости от того, от кого поступило последнее текстовое сообщение в очередь сессии. Сервисные сообщения от бота игнорируются.

  • Id сессии (sess_id, 8) – Возвращает идентификатор сессии, связанной с указанными идентификаторами абонента.

Название: Параметр
Код: parametersSet
Усл. видимости: да
По умолчанию: — 

Выбор команды для действия Установить.
Возможные варианты:

  • Приоритет ротации (rot_priority, 0) – Устанавливает новое значение приоритета в ротации.

  • Приоритет очереди (hunt_priority, 1) – Устанавливает новое значение приоритета в очереди.

  • Таймер ответа оператора, с (timersec, 3) – Устанавливает значение – количество секунд, передаваемое в websocket-API для приложения АРМ оператора с целью отображения таймера времени ответа. На работу системы не влияет.

  • Пользовательское свойство (custom_prop, 2) – Устанавливает значение указанному пользовательскому свойству.

  • Переход, ошибка (on_error_goto, 4) – Устанавливает режим работы сессии при возникновении ошибки, в какое состояние переходить. Использует значение поля paramOnErrVal.

Название: Параметр
Код: parametersEvent
Усл. видимости: да
По умолчанию: — 

Выбор команды для действия Отправить событие.
Возможные варианты:

  • Установить флаг перехода (is_allow_arm_act, 0) – Включить/выключить режим отложенного применения команд сворачивания или завершения сессии.

  • Отправить реактивацию в АРМ (send_reactivate, 1) – Отправляет команду реактивации сессии в websocket-API для приложения АРМ оператора.

  • Финализировать сессию (finalize, 2) – Переводит сессию в состояние final с прерыванием текущих активностей.

  • Завершить сессию (terminate, 3) – Останавливает сессию.

Название: Ключ параметра
Код: custKey
Усл. видимости: да
По умолчанию: — 

Аргумент, содержащий ключ – название пользовательского свойства.
Применяется для действий Получить и Установить при работе с пользовательскими свойствами.

Название: Значение
Код: paramVal
Усл. видимости: да
По умолчанию: — 

Аргумент, содержащий устанавливаемое значение для указанного атрибута.
Применяется для действия Установить.

Название: Значение
Код: paramOnErrVal
Усл. видимости: да
По умолчанию: — 

Выбор значения для установки атрибута Переход, ошибка.
Возможные варианты:

  • auto (0) – Перезапускать сессию с самого начала, состояние auto.

  • final (1) – Переводить сессию в состояние final.

Название: Id абонента
Код: paramAbonId
Усл. видимости: да
По умолчанию: — 

Аргумент, содержащий идентификатор абонента.
При создании сессии задается компонентом (Операция с текстовой сессией).
Применяется для операции Получить Id сессии.

Название: Id канала
Код: paramChId
Усл. видимости: да
По умолчанию: — 

Аргумент, содержащий идентификатор канала.
При создании сессии задается компонентом (Операция с текстовой сессией).
Применяется для операции Получить Id сессии.

Название: Доп. параметры
Код: paramAbonExt
Усл. видимости: да
По умолчанию: — 

Аргумент, содержащий дополнительные идентификаторы абонента.
При создании сессии задается компонентом (Операция с текстовой сессией).
Применяется для операции Получить Id сессии.

Название: Значение
Код: flagArmActionVal
Усл. видимости: да
По умолчанию: — 

Возможные варианты:

  • 0 (param0, 0) – Включает режим откладывания применения команд сворачивания или завершения сессии через API (websocket или из сценариев) вплоть до установки значения 1, после чего все поступившие и отложенные команды последовательно применяются.

  • 1 (param1, 1) – Разрешает применение сворачивания или завершения сессии через API (websocket или из сценариев), откладывание применения события не производится.

В сессии по умолчанию значение 1.

Название: Значение в переменную
Код: respVariable
Усл. видимости: да
По умолчанию: — 

Переменная для сохранения результата выполнения операции чтения данных.

Название: Код ошибки в переменную
Код: errCode
Усл. видимости: нет
По умолчанию: — 

Переменная для сохранения кода ошибки.

Название: Переход
Код: transfer
Усл. видимости: да
По умолчанию: — 

Компонент, которому передается управление при успешном выполнении операции кроме случая завершения сессии.

Название: Переход, ошибка
Код: transferError
Усл. видимости: нет
По умолчанию: — 

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

См. также

  • Функциональная роль scr

  • Функциональная роль sess