Для администратора виртуальной АТС команды выполняются на уровне виртуальной АТС в разделе domain/<DOMAIN>/alias/profiles/ и применяются только для определенной виртуальной АТС.

<DOMAIN> - имя виртуальной АТС.

clean

Команда для удаления определенных свойств профиля.

Путь команды:

domain/<DOMAIN>/alias/profile/clean

Синтаксис

clean <ProfileName> [<PropertyName>] [--force]

Параметры:

<ProfileName> - название профиля алиаса;
<PropertyName> - название параметра алиаса;

--force - выполнение команды без запроса подтверждения.

Описание параметров алиаса приведено в Приложении А. Набор параметров алиасов или во вкладке ниже.

Приложение А. Набор параметров алиасов

Таблица 1 — Описание параметров алиаса

Название параметра	Описание	Значения
access_group	группа доступа	значения берутся из таблицы групп доступа (список групп доступа можно посмотреть по команде domain/<some_domain>/access-group/ls-groups)
access_type	тип доступа для абонента (долговременные ограничения, которые вводятся при подключении абонента). Описание настройки содержится на этой странице /domain/<DOMAIN>/access-type- команды управления типами доступа.	значения берутся из таблицы типов доступа (список типов доступа можно посмотреть по команде domain/<some_domain>/access-type/info)
ai_<идентификатор тона>	автоинформатор	<Номер автоинформатора> [Идентификатор тона]
apri	индикатор ограничения предоставления номера вызывающего абонента	presentationAllowed
		presentationRestricted
		addressNotAvailable
		spare
billing_id	индикатор установки User-Name(1) при использовании RADIUS	string
billing_password	индикатор установки User-Password(2) при использовании RADIUS	string
category_override	режим переопределения категории вызова	Если параметр выставлен в true — то категория вызова всегда переопределяется на ту категорию, что выставлена на уровне интерфейса (свойство category).
category_override	режим переопределения категории вызова	Если параметр выставлен в false — то категория вызова не переопределяется на ту категорию, что выставлена на уровне интерфейса (свойство category).
category	категория вызывающего абонента	unknownAtThisTime — 0
		operatorFrench — 1
		operatorEngish — 2
		operatorGerman — 3
		operatorRussian — 4
		operatorSpanish — 5
		reserved — 9
		ordinarySubscriber — 10 (АОН категория 1 — ОАО "Ростелеком")
		subscriberWithPriority — 11 (АОН категория 4 — ООО "Эквант")
		dataCall — 12 (АОН категория 8 — ОАО "АРКТЕЛ")
		testCall — 13
		spare — 14
		payphone — 15 (АОН категория 6 — ЗАО "Компания ТрансТелеКом")
		category0 — 224
		hotelsSubscriber — 225 (АОН категория 2 — ОАО "КОМСТАР-ОТС")
		freeSubscriber — 226
		paidSubscriber — 227 (АОН категория 7 — ЗАО "Синтерра")
		localSubscriber — 228 (АОН категория 3 — ОАО "Вымпелком" (ранее ООО "СЦС Совинтел"))
		localTaksofon — 229 (АОН категория 9 — ОАО "Межрегиональный Транзит Телеком")
		autoCallI — 240
		semiautoCallI — 241
		autoCallII — 242
		semiautoCallII — 243
		autoCallIII — 244
		semiautoCallIII — 245
		autoCallIV — 246
		semiautoCallIV — 247
cdr_group	имя группы, используется для группировки cdr. Описание настройки содержится на этой странице /domain/<DOMAIN>/cdr/ — команды управления режимами генерации CDR	atom
displayName	имя абонента, которое будет передано на вызываемую сторону и отобразится у абонента при передаче CallerID	string
email	Email-адрес абонента, на который будет приходить письмо с нотификацией о пропущенном вызове.	string
cn\email\release_call\enabled	флаг, показывающий, активирована или нет отправка сообщения о пропущенном вызове через email	boolean
cn\email\release_call\template	Шаблон письма-нотификации о пропущенном вызове по email. В шаблоне письма можно использовать макропеременные: %CALLING%, %CALLED%, %TIME%, %DATE%, %CAUSE%, %DURATION%, %CALLERID%, %DISPLAYNAME%	string
jabber\id	JID (Jabber-идентификатор) абонента, на который будет приходить сообщение с нотификацией о пропущенном вызове.	string
cn\jabber\release_call\enabled	флаг, показывающий, активирована или нет отправка сообщения о пропущенном вызове через jabber	boolean
cn\jabber\release_call\template	Шаблон сообщения-нотификации о пропущенном вызове. В шаблоне сообщения можно использовать макропеременные: %CALLING%, %CALLED%, %TIME%, %DATE%, %CAUSE%, %DURATION%, %CALLERID%, %DISPLAYNAME%	string
cn\jabber\incomming_call\enabled	флаг, показывающий, активирована или нет отправка сообщения о входящем вызове через jabber	boolean
cn\jabber\incomming_call\template	Шаблон сообщения-нотификации о входящем вызове. В шаблоне сообщения можно использовать макропеременные: %CALLING%, %CALLED%, %TIME%, %DATE%, %CAUSE%, %DURATION%, %CALLERID%, %DISPLAYNAME%	string
isActive	состояние алиаса	false — алиас не активен true — алиас активен
nai	идентификатор типа адреса	spare
		subscriberNumber
		unknown
		nationalNumber
		internationNumber
ni	индикатор номера	emergency — экстренные службы
		intercity — абоненты междугородной сети
		international — абоненты международной сети
		local — абоненты местной сети
		private — абоненты "своей" АТС
		zone — абоненты зоновой сети
npi	индикатор плана нумерации	spare
		isdnTelephony
		dataNumberingPlan
		telexNumberingPlan
		reserved1
		reserved2
		reserved3
conversation_timeout	длительность разговорного соединения	(disabled \| [0ms; 1d] (например: 23h 59m 59s 999ms) )
no_answer_timeout	время ожидания ответа данного абонента	(disabled \| [0ms; 1d] (например: 23h 59m 59s 999ms) )
o_response_timeout	тайм-аут подтверждения завершения номера	(disabled \| [0ms; 1d] (например: 23h 59m 59s 999ms) )
provider	код провайдера	[0-9]
regime	режим обслуживания для абонента (временные ограничения). Описание настройки содержится на этой странице /domain/<DOMAIN>/regime/ — команды управления режимами обслуживания абонентов	значения берутся из таблицы режимов обслуживания (список режимов обслуживания можно посмотреть по команде domain/<some_domain>/regime/info)
screening	индикатор контроля номера вызывающего абонента	userProvidedNotVerified
		userProvidedVerifiedAndPassed
		userProvidedVerifiedAndFailed
		networkProvided
support_encoding	Отображение Display Name в зависимости от типа кодировки	utf-8
		latin1
		cp-1251
line_count	Количество одновременных телефонных занятий, которые можно сделать с/на данного абонента. Значение данного параметра может быть перекрыто значениями параметров "line_count\in", "line_count\out".	positive integer
line_count\in	Количество одновременных входящих телефонных занятий, которые можно сделать на данного абонента (алиас).	positive integer
line_count\out	Количество одновременных исходящих телефонных занятий, которые можно сделать с данного абонента (алиаса).	positive integer
ss\mgm\telephone	Возможность управлять услугами с ТА (активировать, деактивировать, проверять). По умолчанию — enabled	disabled `\|` enabled
s4b\email	Email адрес учетной записи Skype for business	string
s4b\username	Username учетной записи Skype for business	string
s4b\password	Пароль от учетной записи Skype for business	string
pulse_telephone	Признак того, что данный ТА работает в импульсном режиме набора. По умолчанию — false.	boolean
placement	территориальный признак номера	string
language	Язык локали абонента	string (`ru\|en\|de\|fr\|es`)
api\call\enabled	активировать возможность управлять данным ТА через Call API. По умолчанию — false.	boolean
password	Пароль, используемый для входа в Phone desktop assistant	string

Пример:

ssw@[mycelium@ecss3]:/$> domain/d.local/alias/profiles/clean test nai
Property [nai] successfully removed from the profile "test", domain "d.local".

declare

Команда предназначена для создания нового профиля алиаса.

Путь команды:

domain/<DOMAIN>/alias/profile/declare

Синтаксис:

declare <ProfileName> [<Descriptions>]

Параметры:

<ProfileName> - название профиля алиаса;
<Descriptions> - описание профиля алиаса.

Пример:

admin@[mycelium1@ecss1]:/$ domain/biysk.local/alias/profiles/declare work newprofile 
Profile "work" successfully declared in the domain "biysk.local".

[exec at: 27.02.2019 13:38:21, exec time: 91ms, nodes: ds1@ecss2]

info

Команда предназначена для просмотра информации о параметрах профиля алиаса.

Путь команды:

domain/<DOMAIN>/alias/profile/info

Синтаксис:

info [<ProfileName>]

Параметры:

<ProfileName> - название профиля алиаса. Опциональный параметр;

Пример:

admin@[mycelium1@ecss1]:/$ domain/biysk.local/alias/profiles/info   
Profiles info:
┌───────────┬────────────┬─────────────────────────────┬────────────────────┐
│  Domain   │    Name    │         Properties          │    Description     │
├───────────┼────────────┼─────────────────────────────┼────────────────────┤
│biysk.local│energo      │language = ru                │Для Алтайкрайэнерго │
│biysk.local│user_default│access_group = all           │Default user profile│
│           │            │category = ordinarySubscriber│                    │
│           │            │nai = subscriberNumber       │                    │
│           │            │npi = isdnTelephony          │                    │
│           │            │ni = private                 │                    │
│           │            │screening = networkProvided  │                    │
└───────────┴────────────┴─────────────────────────────┴────────────────────┘
Total: 2

[exec at: 27.02.2019 09:58:28, exec time: 83ms, nodes: ds1@ecss1]

list

Команда для просмотра списка существующих в системе профилей алиасов.

Путь команды:

domain/<DOMAIN>/alias/profile/list

Синтаксис:

list

Параметры:

<DOMAIN> - имя виртуальной АТС.

Пример:

admin@[mycelium1@ecss1]:/$ domain/biysk.local/alias/profiles/list 
Profiles' list:
┌───────────┬────────────┬────────────────────┐
│ Domain │ Name │ Description │
├───────────┼────────────┼────────────────────┤
│biysk.local│energo │Для Алтайкрайэнерго │
│biysk.local│user_default│Default user profile│
└───────────┴────────────┴────────────────────┘
Total: 2

[exec at: 27.02.2019 10:32:23, exec time: 75ms, nodes: ds1@ecss2]

remove

Команда предназначена для удаления профиля алиасов.

Путь команды:

domain/<DOMAIN>/alias/profile/remove

Синтаксис:

remove <ProfileName>

Параметры:

<ProfileName> - название профиля алиаса.

Пример:

ssw@[mycelium@ecss3]:/$> domain/d.local/alias/profiles/remove test
Profile "test" successfully removed from the domain "d.local".

set

Команда предназначена для настройки параметров профиля алиасов.

Путь команды:

domain/<DOMAIN>/alias/profile/set

Синтаксис:

set <ProfileName> <PropertyName> <PropertyValue>

Параметры:

<ProfileName> - название профиля алиаса;
<PropertyName> - название параметра алиаса;
<PropertyValue> - значение параметра.

Описание параметров алиаса и их значения приведены в Приложении А. Набор параметров алиасов или во вкладке ниже.

Приложение А. Набор параметров алиасов

Таблица 1 — Описание параметров алиаса

Название параметра	Описание	Значения
access_group	группа доступа	значения берутся из таблицы групп доступа (список групп доступа можно посмотреть по команде domain/<some_domain>/access-group/ls-groups)
access_type	тип доступа для абонента (долговременные ограничения, которые вводятся при подключении абонента). Описание настройки содержится на этой странице /domain/<DOMAIN>/access-type- команды управления типами доступа.	значения берутся из таблицы типов доступа (список типов доступа можно посмотреть по команде domain/<some_domain>/access-type/info)
ai_<идентификатор тона>	автоинформатор	<Номер автоинформатора> [Идентификатор тона]
apri	индикатор ограничения предоставления номера вызывающего абонента	presentationAllowed
		presentationRestricted
		addressNotAvailable
		spare
billing_id	индикатор установки User-Name(1) при использовании RADIUS	string
billing_password	индикатор установки User-Password(2) при использовании RADIUS	string
category_override	режим переопределения категории вызова	Если параметр выставлен в true — то категория вызова всегда переопределяется на ту категорию, что выставлена на уровне интерфейса (свойство category).
category_override	режим переопределения категории вызова	Если параметр выставлен в false — то категория вызова не переопределяется на ту категорию, что выставлена на уровне интерфейса (свойство category).
category	категория вызывающего абонента	unknownAtThisTime — 0
		operatorFrench — 1
		operatorEngish — 2
		operatorGerman — 3
		operatorRussian — 4
		operatorSpanish — 5
		reserved — 9
		ordinarySubscriber — 10 (АОН категория 1 — ОАО "Ростелеком")
		subscriberWithPriority — 11 (АОН категория 4 — ООО "Эквант")
		dataCall — 12 (АОН категория 8 — ОАО "АРКТЕЛ")
		testCall — 13
		spare — 14
		payphone — 15 (АОН категория 6 — ЗАО "Компания ТрансТелеКом")
		category0 — 224
		hotelsSubscriber — 225 (АОН категория 2 — ОАО "КОМСТАР-ОТС")
		freeSubscriber — 226
		paidSubscriber — 227 (АОН категория 7 — ЗАО "Синтерра")
		localSubscriber — 228 (АОН категория 3 — ОАО "Вымпелком" (ранее ООО "СЦС Совинтел"))
		localTaksofon — 229 (АОН категория 9 — ОАО "Межрегиональный Транзит Телеком")
		autoCallI — 240
		semiautoCallI — 241
		autoCallII — 242
		semiautoCallII — 243
		autoCallIII — 244
		semiautoCallIII — 245
		autoCallIV — 246
		semiautoCallIV — 247
cdr_group	имя группы, используется для группировки cdr. Описание настройки содержится на этой странице /domain/<DOMAIN>/cdr/ — команды управления режимами генерации CDR	atom
displayName	имя абонента, которое будет передано на вызываемую сторону и отобразится у абонента при передаче CallerID	string
email	Email-адрес абонента, на который будет приходить письмо с нотификацией о пропущенном вызове.	string
cn\email\release_call\enabled	флаг, показывающий, активирована или нет отправка сообщения о пропущенном вызове через email	boolean
cn\email\release_call\template	Шаблон письма-нотификации о пропущенном вызове по email. В шаблоне письма можно использовать макропеременные: %CALLING%, %CALLED%, %TIME%, %DATE%, %CAUSE%, %DURATION%, %CALLERID%, %DISPLAYNAME%	string
jabber\id	JID (Jabber-идентификатор) абонента, на который будет приходить сообщение с нотификацией о пропущенном вызове.	string
cn\jabber\release_call\enabled	флаг, показывающий, активирована или нет отправка сообщения о пропущенном вызове через jabber	boolean
cn\jabber\release_call\template	Шаблон сообщения-нотификации о пропущенном вызове. В шаблоне сообщения можно использовать макропеременные: %CALLING%, %CALLED%, %TIME%, %DATE%, %CAUSE%, %DURATION%, %CALLERID%, %DISPLAYNAME%	string
cn\jabber\incomming_call\enabled	флаг, показывающий, активирована или нет отправка сообщения о входящем вызове через jabber	boolean
cn\jabber\incomming_call\template	Шаблон сообщения-нотификации о входящем вызове. В шаблоне сообщения можно использовать макропеременные: %CALLING%, %CALLED%, %TIME%, %DATE%, %CAUSE%, %DURATION%, %CALLERID%, %DISPLAYNAME%	string
isActive	состояние алиаса	false — алиас не активен true — алиас активен
nai	идентификатор типа адреса	spare
		subscriberNumber
		unknown
		nationalNumber
		internationNumber
ni	индикатор номера	emergency — экстренные службы
		intercity — абоненты междугородной сети
		international — абоненты международной сети
		local — абоненты местной сети
		private — абоненты "своей" АТС
		zone — абоненты зоновой сети
npi	индикатор плана нумерации	spare
		isdnTelephony
		dataNumberingPlan
		telexNumberingPlan
		reserved1
		reserved2
		reserved3
conversation_timeout	длительность разговорного соединения	(disabled \| [0ms; 1d] (например: 23h 59m 59s 999ms) )
no_answer_timeout	время ожидания ответа данного абонента	(disabled \| [0ms; 1d] (например: 23h 59m 59s 999ms) )
o_response_timeout	тайм-аут подтверждения завершения номера	(disabled \| [0ms; 1d] (например: 23h 59m 59s 999ms) )
provider	код провайдера	[0-9]
regime	режим обслуживания для абонента (временные ограничения). Описание настройки содержится на этой странице /domain/<DOMAIN>/regime/ — команды управления режимами обслуживания абонентов	значения берутся из таблицы режимов обслуживания (список режимов обслуживания можно посмотреть по команде domain/<some_domain>/regime/info)
screening	индикатор контроля номера вызывающего абонента	userProvidedNotVerified
		userProvidedVerifiedAndPassed
		userProvidedVerifiedAndFailed
		networkProvided
support_encoding	Отображение Display Name в зависимости от типа кодировки	utf-8
		latin1
		cp-1251
line_count	Количество одновременных телефонных занятий, которые можно сделать с/на данного абонента. Значение данного параметра может быть перекрыто значениями параметров "line_count\in", "line_count\out".	positive integer
line_count\in	Количество одновременных входящих телефонных занятий, которые можно сделать на данного абонента (алиас).	positive integer
line_count\out	Количество одновременных исходящих телефонных занятий, которые можно сделать с данного абонента (алиаса).	positive integer
ss\mgm\telephone	Возможность управлять услугами с ТА (активировать, деактивировать, проверять). По умолчанию — enabled	disabled `\|` enabled
s4b\email	Email адрес учетной записи Skype for business	string
s4b\username	Username учетной записи Skype for business	string
s4b\password	Пароль от учетной записи Skype for business	string
pulse_telephone	Признак того, что данный ТА работает в импульсном режиме набора. По умолчанию — false.	boolean
placement	территориальный признак номера	string
language	Язык локали абонента	string (`ru\|en\|de\|fr\|es`)
api\call\enabled	активировать возможность управлять данным ТА через Call API. По умолчанию — false.	boolean
password	Пароль, используемый для входа в Phone desktop assistant	string

Пример:

admin@[mycelium1@ecss1]:/$ domain/biysk.local/alias/profiles/set work nai nationalNumber
All properties successfully set to the profile "work", domain "biysk.local".

[exec at: 27.02.2019 13:43:12, exec time: 124ms, nodes: ds1@ecss1]

Дерево страниц

/domain/<DOMAIN>/alias/profiles-команды управления конфигурацией профилей алиасов.

clean

declare

info

list

remove

set