/domain/<DOMAIN>/teleconference/template/ - команды управления шаблонами телеконференций
В данном разделе описываются команды по управлению шаблонами телеконференций.
<DOMAIN> - имя виртуальной АТС.
declare
Команда декларирования шаблона телеконференции.
Путь команды:
/domain/<DOMAIN>/teleconference/template/declare
Синтаксис:
declare <NAME>
Параметры:
<NAME> - имя шаблона(строка до 64 символов). Имя, содержащее пробелы, заключаются в двойные кавычки. Формат: --name <name>
Примеры:
Создание нового шаблона:
admin@mycelium1@ecss1:/$ domain/biysk.local/teleconference/template/declare "IT service template" Template IT service template successfully declared with id 06250c03397b8903. [exec at: 06.11.2019 21:06:43, exec time: 75ms, nodes: core1@ecss1
Вывод ошибки:
admin@mycelium1@ecss1:/$ domain/biysk.local/teleconference/template/declare "IT service template" Error: Template with name IT service template already exists. [exec at: 06.11.2019 21:27:07, exec time: 83ms, nodes: core1@ecss1] admin@mycelium1@ecss1:/$ admin@mycelium1@ecss1:/$ domain/biysk.local/teleconference/template/declare 0123456789_0123456789_0123456789_0123456789_0123456789_0123456789_0123456789_0123456789 Error: Invalid command's arguments: "0123456789_0123456789_0123456789_0123456789_0123456789_0123456789_0123456789_0123456789". [exec at: 06.11.2019 21:28:06, exec time: 66ms, nodes: core1@ecss1]
list
Команда просмотра списка шаблонов телеконференции.
Путь команды:
/domain/<DOMAIN>/teleconference/template/list
Синтаксис:
list
Параметры:
Команда без параметров
admin@mycelium1@ecss1:/$ domain/test.domain/teleconference/template/list ┌──┬────────────────┬───────────────────────────────────────┬──────┐ │# │ id │ Name │Number│ ├──┼────────────────┼───────────────────────────────────────┼──────┤ │1 │06324d6eaa80eb9c│weekly meeting │ │ │2 │0620ab03f231a185│Проверка совещания на кириллице │8890 │ │3 │0632283e74492505│check conference-info subscribe │8891 │ │4 │0632285b01810d4b│check conference-info subscribe 2 │8892 │ │5 │06202d95f1f89a46│тестовое имя шаблона/test template name│ │ │6 │06304f1670089241│timo2 │ │ │7 │062099675bf63479│timo │ │ │8 │061f7b05918d888e│test_template_name │ │ │9 │061f7a7b138edffd│test6 │ │ │10│0620ab05832b04ac│test_template_without_number │ │ │11│061f79bcb57fb765│test4 │ │ │12│061fe494fc4491a0│media │ │ │13│0621cc67c7a0523e│template with group second │ │ └──┴────────────────┴───────────────────────────────────────┴──────┘ [exec at: 06.11.2019 23:08:43, exec time: 66ms, nodes: core1@ecss1]
clean
Команда выставляет свойство шаблона телеконференции в значение по умолчанию.
Путь команды:
/domain/<DOMAIN>/teleconference/template/clean
Синтаксис:
clean <TEMPLATE> <OPTIONS>
Параметры:
<TEMPLATE> - группа телеконференции, должна выглядеть в одном из форматов:
- --id <template id> - идентификатор шаблона телеконференции;
- <template name> - имя шаблона телеконференции.
<OPTIONS> - свойство шаблона:
- --description - Выставить описание шаблона телеконференции в пустую строку;
- --number - Удалить номер шаблона телеконференции;
- --destroy_by_no_initiator - Выставить destroy_by_no_initiator в false;
- --destroy_when_only_one_member_left - Выставить destroy_when_only_one_member_left в false;
- --auto_collect - Выставить auto_collect в false;
- --conversation_record - Выставить conversation_record в false;
- --private - Выставить private в false;
- --conversation_timeout - Очистить значение conversation_timeout;
- --no_answer_timeout - Очистить значение no_answer_timeout;
- --greeting_of_incoming_call - Выставить значение greeting_of_incoming_call в дефолтное;
- --greeting_of_outgoing_call - Выставить значение greeting_of_outgoing_call в дефолтное;
- --greeting_of_outgoing_call_by_auto_collect - Выставить значение greeting_of_outgoing_call_by_auto_collect в дефолтное;
- --farewell - Выставить значение farewell в дефолтное;
- --notification_of_join_subscriber - Выставить значение notification_of_join_subscriber в дефолтное;
- --notification_of_leave_subscriber - Выставить значение notification_of_leave_subscriber в дефолтное;
- --display_name_prefix - Выставить display_name_prefix в пустую строку;
- --answer_to_initiator_when_success_outgoing_call - Выставить answer_to_initiator_when_success_outgoing_call в false;
- --pin-disable - Выключить pin для шаблона телеконференции.
Пример:
admin@mycelium1@ecss1:/$ domain/biysk.local/teleconference/template/property-clean energo_tc farewell Property farewell successfully cleaned. [exec at: 06.11.2019 23:01:25, exec time: 75ms, nodes: core1@ecss1]
admin@mycelium1@ecss1:/$ domain/biysk.local/teleconference/template/property-clean energo_tc display_name_prefix Property display_name_prefix successfully cleaned. [exec at: 06.11.2019 23:01:42, exec time: 101ms, nodes: core1@ecss1]
set
Команда для изменения свойств шаблона телеконференции.
Путь команды:
/domain/<DOMAIN>/teleconference/template/set
Синтаксис:
set <TEMPLATE> <OPTIONS>
Параметры:
<TEMPLATE> - группа телеконференции, должна выглядеть в одном из форматов:
- --id <template id> - идентификатор шаблона телеконференции;
- <template name> - имя шаблона телеконференции.
<OPTIONS> - свойство шаблона:
- --description - Выставить описание шаблона телеконференции. Содержит слово или строку в двойных кавычках. Пример: --description "Sales department";
- --name - Выставить имя шаблона телеконференции. Содержит слово или строку в двойных кавычках. Пример: --name Support;
- --destroy_by_no_initiator - Завершить после выхода инициатора. Формат: --destroy_by_no_initiator true|false;
- --destroy_when_only_one_member_left - Завершить, если остался один участник. Формат: --destroy_when_only_one_member_left true|false. Это свойство не работает в том случае, когда менеджер селекторного совещания управляет активной телеконференцией ;
- --auto_collect - Совершает вызов на участников(номера) после старта шаблона конференции. Формат: --auto_collect true|false;
- --conversation_record - Включить или выключить запись разговора телеконференции. Формат: --conversation_record true|false. Запись разговора телеконференции пишется в call_record_peer по пути domain/<domain>/tc/<template id>/records/<meeting_id>_<year>-<month>-<day>_<hour>-<min>-<sec>.wav;
- --private - Только задекларированные участники могут присоединиться к телеконференции. Формат: --private true|false;
- --conversation_timeout - Максимальное время пребывания участника в конференции. Формат: --conversation_timeout <timeout>. Где <timeout> число от 0 до 86400000, мс. Данный параметр прекрывает таймер conversation_timeout на домене(/domain/<domain>/timers/core/... ;
- --no_answer_timeout - Таймаут ожидания ответа абонента. Формат: --no_answer_timeout <timeout>. Где <timeout> число от 5000 до 300000 мс;
- --greeting_of_incoming_call - Голосовое оповещение участников телеконференции для входящего вызова. Формат: --greeting_of_incoming_call [<path>, <path 2>, ..., <path N>]. Где <path> путь до медиа ресурсов;
- --greeting_of_outgoing_call - Голосовое оповещение участников телеконференции для исходящего вызова. Формат: --greeting_of_outgoing_call [<path>, <path 2>, ..., <path N>]. Где <path> путь до медиа ресурсов;
- --greeting_of_outgoing_call_by_auto_collect - Голосовое оповещение участников телеконференции для исходящего вызова с автоматическим сбором участников. Формат: --greeting_of_outgoing_call_by_auto_collect [<path>, <path 2>, ..., <path N>]. Где <path> путь до медиа ресурсов;
- --farewell - Прощальный лист извещений телеконференции. Формат: --farewell [<path>, <path 2>, ..., <path N>]. Где <path> путь до медиа ресурсов;
- --notification_of_join_subscriber - Лист извещения о присоединении к телеконференции. Формат: --notification_of_join_subscriber [<path>, <path 2>, ..., <path N>]. Где <path> путь до медиа ресурсов;
- --notification_of_leave_subscriber - Лист извещения о выходе участника из телеконференции. Формат: --notification_of_leave_subscriber [<path>, <path 2>, ..., <path N>]. Где <path> путь до медиа ресурсов;
- --display_name_prefix - отображаемый префикс конференции для конференций, созданных по feature-коду. Окончательный display name формируется из prefix + display name. Формат: --display_name_prefix <prefix>. Где <prefix> слово или строка в двойных кавычках. Пример: --display_name_prefix "Mine number 5"
- --answer_to_initiator_when_success_outgoing_call - Ответить инициатору после успешного исходящего вызова(только, если включен автосбор). Формат: --answer_to_initiator_when_success_outgoing_call true|false;
- --pin - Настройка pin-кода для шаблона телеконференции. Формат: --pin <pin>. Где <pin> число из 4 цифр от 0 до 9.
- --pin-enable - включить использование pin-кода в шаблоне телеконференции. Конфликтует с --pin-disable;
- --pin-disable - выключить использование pin-кода в шаблоне телеконференции. Конфликтует с --pin-enable;
- --pin-for-all - использовать pin-код для всех участников и внешних номеров в шаблоне телеконференции. Конфликтует с --pin-for-numbers;
- --pin-for-numbers - использовать pin-код только для внешних номеров в шаблоне телеконференции. Конфликтует с --pin-for-all.
Примеры:
Не завершать конференцию после выхода инициатора:
admin@mycelium1@ecss1:/$ domain/biysk.local/teleconference/template/set energo_tc --destroy_by_no_initiator false Propery destroy_by_no_initiator successfully updated. [exec at: 06.11.2019 22:35:54, exec time: 75ms, nodes: core1@ecss1]
Установить звуковой файл оповещения участников о завершении конференции:
admin@mycelium1@ecss1:/$ domain/biysk.local/teleconference/template/set energo_tc --farewell [system sounds/ai_conference_destroyed.wav ] Propery farewell successfully updated. [exec at: 06.11.2019 22:39:13, exec time: 175ms, nodes: core1@ecss1]
Установка тона оповещения о выходе участника:
admin@mycelium1@ecss1:/$ domain/biysk.local/teleconference/template/set "managers template" --notification_of_leave_subscriber [tone 400 200 500 0 100 ] Propery notification_of_leave_subscriber successfully updated. [exec at: 06.11.2019 23:25:32, exec time: 108ms, nodes: core1@ecss1]
Примеры ввода некорректных значений:
admin@mycelium1@ecss1:/$ domain/biysk.local/teleconference/template/set energo_tc --no_answer_timeout 2s
Error: Invalid command's result: {error,{bad_value,"2s"}}.
[exec at: 06.11.2019 22:53:14, exec time: 100ms, nodes: core1@ecss1]
Установка таймера пребывания в конференции.
admin@mycelium1@ecss1:/$ domain/biysk.local/teleconference/set 100 --conversation_timeout 2m Property has been set [exec at: 18.03.2020 14:46:45, exec time: 29ms, nodes: core1@ecss1]
remove
Команда удаления шаблона телеконференции.
Путь команды:
/domain/<DOMAIN>/teleconference/template/remove
Синтаксис:
remove <TEMPLATE>
Параметры:
<TEMPLATE> - группа телеконференции, должна выглядеть в одном из форматов:
- --id <template id> - идентификатор шаблона телеконференции;
- <template name> - имя шаблона телеконференции.
Пример:
admin@mycelium1@ecss1:/$ domain/test.domain/teleconference/template/remove "monthly meeting"
[remove] You are going to remove template with name "monthly meeting". It will delete the
template folder (The folder may be contains audio files which were uploaded by
user and conversations records which were created by teleconference meetings).
Are you sure?: yes/no ?> yes
Success: Template has been removed.
[exec at: 06.11.2019 23:05:09, exec time: 75ms, nodes: core1@ecss1]
admin@mycelium1@ecss1:/$
info
Команда просмотра шаблона телеконференции.
Путь команды:
/domain/<DOMAIN>/teleconference/template/info
Синтаксис:
info <TEMPLATE> [<OPTIONS>]
Параметры:
<TEMPLATE> - группа телеконференции, должна выглядеть в одном из форматов:
- --id <template id> - идентификатор шаблона телеконференции;
- <template name> - имя шаблона телеконференции.
<OPTIONS> - параметры шаблона.
- --show-members - показать информацию об участниках (default: false)
- --show-groups - показать информацию о группах в шаблоне (default: false)
- --show-numbers - показать информацию о внешних номерах (default: false)
Пример:
admin@mycelium1@ecss1:/$ domain/test.domain/teleconference/template/info "weekly meeting"
===================================================
Template: weekly meeting (06324d6eaa80eb9c)
Template properties:
┌──────────────────────────────────────────────────┬────────────────────────────────────────────────────────┐
│ Key │ Value │
├──────────────────────────────────────────────────┼────────────────────────────────────────────────────────┤
│description │Еженедельное совещание для проведения отчетности │
│number │ │
│answer_to_initiator_when_success_outgoing_call │false │
│auto_collect │false │
│conversation_record │false │
│destroy_by_no_initiator │true │
│destroy_when_only_one_member_left │false │
│display_name_prefix │"Teleconference " │
│farewell │system://sounds/ai_conference_destroyed.wav │
│greeting_of_incoming_call │system://sounds/ai_conference_prompt.wav │
│ │system://sounds/ai_conference_prompt.wav │
│greeting_of_outgoing_call │system://sounds/ai_conference_prompt.wav │
│greeting_of_outgoing_call_by_auto_collect │system://sounds/ai_conference_prompt.wav │
│no_answer_timeout │4m │
│notification_of_join_subscriber │tone://?f1=490&f2=0&on_msec=200&off_msec=100&duration=30│
│ │0 │
│notification_of_leave_subscriber │tone://?f1=390&f2=0&on_msec=200&off_msec=100&duration=30│
│ │0 │
│pin │--pin 1234 --pin-enable --pin-for-numbers │
│private │true │
└──────────────────────────────────────────────────┴────────────────────────────────────────────────────────┘
[exec at: 14.04.2020 10:46:08, exec time: 30ms, nodes: core1@IBM