В этом разделе описываются команды для управления конфигурацией интерфейсов.

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

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

Описание параметров (свойств) SIP-интерфейса приведено в разделе  Приложение Б. Набор параметров интерфейса SIP или во вкладке ниже.

 Нажмите здесь для раскрытия описания параметров SIP-интерфейса


Приложение Б. Набор параметров интерфейса SIP

В данном разделе описываются параметры SIP-интерфейсов.

Различают:

  • параметры SIP-транка (TR) — просмотр и установка командами /domain/DOMAIN/trunk/sip/...
  • параметры локального SIP-абонента (SUB) — просмотр и установка командами /domain/DOMAIN/sip/user/...
  • параметры интерфейса SIP (IF) — просмотр и установка командами /domain/DOMAIN/iface/user-set/...
    Пометка "info" означает, что параметр не имеет возможности настройки командами адаптера (формируется на основе других параметров или внешних воздействий/событий).
    Пометка "rt" означает realm-time параметр, не имеющий хранения в общей базе интерфейсов.

При отображении значения, все значения параметров приводятся к "читаемому" виду адаптером. В "сыром" виде, хранимом в базе, значениями параметров можно оперировать командами /domain/DOMAIN/iface/... Если рабочее имя параметра отличается от хранимого в базе, что второе указывается дополнительно в скобках.

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

Также может отличаться состав параметров. Так не все рабочие параметры могут быть отображены в базе (в частности, параметры, используемые "по умолчанию"). Или в базе могут присутствовать устаревшие параметры (не всегда импорт данных при переходе на новую версию может автоматически зачистить неиспользуемые данные).

Если в таблице не указано значение по умолчанию ("-"), то значение по умолчанию не определено и устанавливается протокол-адаптером SIP.

Таблица — Описание параметров SIP-интерфейса

Название параметраТипОписаниеЗначение по умолчанию
access_groupTR, SUBГруппа, которая определяет правила доступа для этого пользователяall
alarm_enableTR, SUB

Отправка предупреждений при переходе интерфейса в неактивное состояние. 

Для транков/абонентов: если включена опция периодического опроса (см. настройку options_control).

Значения:

  • true — отправка оповещения включена;
  • false — отправка оповещения выключена.
true
alias (aliases_list)SUBCписок алиасов, если пользователь был задекларирован с логическим, а не цифровым номером.-
aliases activitiesSUB (info)Cписок алиасов с указанием их состояния.-
allowSUB (info,rt)Параметр хранит для абонента запросы, поддерживаемые пользовательским шлюзом, которые были получены в запросе регистрации (используется, чтобы знать, чем отправить запрос "check OPTIONS" или "INVITE"). Устанавливается протокол-адаптером SIP.-
allow eventsSUB (info)Расширения (Allow-Events), поддерживаемые терминалом SIP-пользователя.-
authenticationSUB (info)Параметры аутентификации SIP-пользователя: логин, пароль, требование qop.none
auto-answer-versionSUB

Автоматический ответ терминала вызываемому абоненту (позволяет средствами протокола SIP установить диалог, не дожидаясь ответа стороной Б).

Значения:

  • default — используется настройка на уровне виртуальной АТС;
  • answermode — заголовки Auto-Answer: auto, Require: answermode (терминалы, поддерживающие RFC5373);
  • сall-info — шаблон заголовка Call-Info: <sip:PBX_NAME>; answer-after=0 (Broadsoft, Yealink, Snom);
  • call-info — шаблон заголовка Call-Info: =\; answer-after=0 (Lynksys, Yealink);
  • call-info — по необходимости возможна строка в произвольном формате;
  • alert-info — шаблон заголовка Alert-Info: Auto Answer (Polycom, Yealink);
  • alert-info — шаблон заголовка Alert-Info: info=alert-autoanswer (Aastra);
  • alert-info — по необходимости возможна строка в произвольном формате;
  • none — не отправлять команду (терминал не поддерживает ни одну из реализаций авто-ответа).
Alert-Info: Auto Answer
category_to_sipTR, SUB

Выбор режима передачи категории вызывающей стороны средствами протокола SIP (для обеспечения совместимости с встречными системами различных производителей). Режим передачи может быть задан на уровне домена (Pbx), группы SIP-юзеров, SIP-интерфейса (транка или юзера).

В зависимости от уровня, имеются следующие режимы:

  • default — использовать режим, выставленный на уровне домена;
  • category — отправка и прием категории вызывающего абонента в отдельном SIP-заголовке Сategory инициирующего запроса INVITE, в этом случае передается категория ОКС-7 со значениями 0 – 255;
  • сpc — категория передается при помощи тега «cpc=», передаваемого в SIP-заголовке From, в этом случае передается категория АОН со значениями 1-10;
  • сpc-rus — категория передается при помощи тега «cpc-rus=», передаваемого в SIP-заголовке From, в этом случае передается категория АОН со значениями 1-10;
  • none — не передавать категорию средствами SIP.
default
cdpn-transformationTR

Подмена CDPN в сообщении SetupInd от SIP-адаптера к ядру значением из ACDPN или Redirecting

Значения:

  • none — не изменять;
  • by-redirection — подмена номера из Redirecting Number;
  • by-generic-cdpn — подмена из Generic Number, имеющего Number qualifier indicator = 00000001 additional called number; 
  • by-generic — подмена из Generic Number, имеющего любой Number qualifier indicator.
none
channel-contact-mapTRПараметр связывает номер канала с контактом, который уже должен быть создан. Если канал не существует, то он будет создан.

Значения:

  • add — добавить;
  • remove — удалить;
  • channel_range — диапазон каналов;
  • contact_range — диапазон контактов.
-
client-profileSUBИдентификатор профиля SIP-клиента. Позволяет включать опции специфичные терминалам конкретного производителя или модели (см. настройку профиля абонентов SIP).
  • none — стандартная работа без специфичных опций;
  • auto — клиентский терминал определяется в ходе процедуры регистрации по заданным правилам;
  • ИМЯ_ПРОФИЛЯ — прямое назначение профиля или выбор предустановленного.
none
compact-formTR, SUBИспользование SIP-заголовков компактной формы.
  • default — автоматический выбор;
  • true — всегда использовать компактную форму;
  • false — всегда использовать полную форму.
-
connect timeTR (info)Время последнего соединения с транком (либо после пропадания ответов на периодический опрос доступности, либо с момента старта или декларации.-
contacts definitionSUB (info,rt)Список зарегистрированных контактов с сопутствующей им информацией: время истечения регистрации, локальная точка регистрации, заголовков Via, User-Agetnt.-
content_encodingTR

Кодирование тела SIP-запроса (ответа).
В текущей версии ПО поддерживается только один формат кодирования.

Значения:

  • gzip — кодирование (сжатие) в формате ZIP;
  • none — кодирование не используется.
none
declared byTR, SUB (info,rt)Дата декларации интерфейса и оператор, выполнивший ее.-
digestSUBТребование аутентификации. Для частной сети при настроенных trusted-ip аутентификация может быть излишней.true
disconnections numberTR (info)Количество потерь связи с транком (прекращение ответов на периодический опрос доступности).-
disable-remote-port-controlTR, SUBОтключение проверки удаленного порта при входящем вызове от абонента. Значения:
  • true — проверка включена;
  • false — проверка выключена.
false
display-name-encoding
Тип схемы для кодирования/декодирования sip url.win1251
dtmf-durationTR, SUBДлительность DTMF-сигнала, передаваемая в исходящем сообщении SIP INFO.100
dtmf-relayTR, SUBВыбор типа MIME для передачи DTMF в теле запроса SIP INFO. При значении "true" используется тип "application/dtmf-relay", иначе "application/dtmf".false
expand-destinationsTRПозволяет ввести несколько IP адресов для транка, с которых разрешается принимать входящие вызовы.-
fork-modeSUBРегистрация нескольких контактов SIP-абонента.
  • all-contacts — одновременный запрос на все контакты;
  • find-me-one-by-one — последовательный перебор контактов по списку;
  • find-me-with-q — последовательный перебор с учетом приоритета;
  • disable — отключение исходящего форкинга.

Allow-repeat-ip — разрешить перезапись контактов с одного IP-адреса, но разных портов:

  • allow-repeat-ip — существующий контакт будет сохраняться;
  • disallow-repeat-ip — существующий контакт будет перезаписываться.

При последовательном переборе контактов (режимы find-me) возможно переключение: 

  • previous-continue — при переходе к следующему контакту вызов предыдущего продолжается;
  • previous-stop — при переходе к следующему контакту вызов предыдущего отменяется.
disable
gateTR, SUB (info)Имя инициирующей очереди и ключ маршрутизации адаптера на внутреннем транспорте (AMQP). Параметры являются служебными, назначаются всегда автоматически при декларации или регистрации в зависимости от типа транка или юзера.-
groupTR,SUBГруппа интерфейсов, которой принадлежит SIP-пользователь.-
history_infoTRВключение оригинальной информации о переадресации в заголовок History-Info в исходящий INVITE.false
hostTRIP-адрес или имя хоста сервера.-

host-to-invite

SUB

registered-domain — в исходящем INVITE в заголовке To используется домен, полученный в запросе регистрации.

sip-domain — в исходящем INVITE в заголовке To используется SIP-домен пользователя.

registered-domain
ice/enabledIF
Включается, когда необходимо обеспечить корректную работу web-клиента, чтобы вызов уходил с SDP, понятным WebRTC. Значения:
  • false — решётка передается в hex-формате (%23);
  • true — решётка передается символом '#'.

Вместе с данным параметром нужно включить nat-traversal.

Данный параметр в своей работе конфликтует с core_forking, являясь менее приоритетным.


core_forkingIF

Включается, когда необходимо обеспечить одновременное использование абонентом телефонного аппарата и WebRTC-клиента, работающего по протоколу ice. На все контакты такого пользователя делаются параллельные вызовы. Контакт, ответивший раньше остальных, будет проключен с вызывающим абонентом.

Данный параметр в своей работе конфликтует с ice/enabled, являясь более приоритетным.

none
inc_authenticationTRТребование прокси авторизации со стороны транка. Принимает значения:
  • false — авторизация не требуется;
  • true — авторизация необходима.
false
inc_authentication_typeTRТип запроса авторизации: user — в ответе 401, proxy — в ответе 407.user
inc_authentication_loginTRЛогин для входящей прокси авторизации. Используется, если требуется прокси-авторизация для транка при входящем занятии.-
inc_authentication_passwordTRПароль для входящей прокси авторизации. Используется, если требуется прокси-авторизация для транка при входящем занятии.-
internal iface nameSUB (info)Идентификатор интерфейса внутри системы.-
inc-loginTRлогин встречной стороны для аутентификации входящего вызова.LOGIN
inc-passwordTRпароль встречной стороны для аутентификации входящего вызова.PASSWORD
ip-setTRПривязка транка к локальному адресу (набору адресов). Настроенные ip-set смотри: cluster/adapter/sip1/sip/network/info.-
isActiveTR, SUB (info)

Состояние интерфейса в данный момент.

Значения:

  • true — интерфейс активен (направление доступно или абонент зарегистрирован);
  • false — интерфейс неактивен (определено автоматически или интерфейс выведен из работы целенаправленно). Служебный параметр.
false
isup_r_ccl_sendTR

Поддержка сообщения CCL ISUP-R.

При отбое со стороны вызывающего абонента (далее абонента А) на сторону вызываемого абонента (далее абонента Б) 
вместо SIP/BYE уходит SIP/INFO с инкапсулированным ISUP-R/CCL.

Актуально только для режимов с инкапсуляцией ISUP (см. настройку mode).

Значения:

  • true — отправка CCL включена;
  • false — отправка CCL выключена.
false
isup-cause-locationTR, SUBЛокализация транка на сети. Используется для определения инициатора разъединения, в частности, при инкапсуляции ISUP/REL. 
Данная локализация описана в рекомендации ITU Q.850:
  • см. Figure 4/Q.850 — Reference configuration for location field generation;
  • см. Table 4/Q.850 — The setting of location fields by events at nodes of the reference configuration and values expected to be received by user A.

Реальные значения (при отображении параметров интерфейсов):

  • user (U);
  • local_private_network (LPN);
  • local_network (LN);
  • transit_network (TN);
  • international_network (INTL);
  • remote_network (RLN);
  • remote_private_network (RPN);

Разрешенные значения для ввода (при вводе с терминала используются сокращения):

  • INTL_(International_network);
  • LN___(Public_network_serving_the_local_user;
  • LPN__(Private_network_serving_the_local_user;
  • RLN__(Public_network_serving_the_remote_user;
  • RPN__(Private_network_serving_the_remote_user;
  • TN___(Transit_network);
  • U____(User).

По [TAB] параметры разворачиваются в указанном выше виде с подсказкой после символа подчеркивания. 
К установке применяются только первые значащие символы (до "_"). Например, значения LPN и LPN__(Private_network_serving_the_local) равнозначны.

local_network
last viaSUB (info)Информация о прохождении запроса регистрации.-
listen_portTRПорт для SIP-сигнализации с транка на стороне SSW. Если на адаптере открыто несколько слушающих портов, то можно различать транки по получению сообщений с одного адреса одной сети, но с разных портов. Номер порта всегда должен быть выбран из имеющегося списка.-
local-end-pointTRТранспортные параметры включения транка на стороне ECSS. Включают в себя: ip-set, listen-port, node-control. Node-control включается при необходимости обслуживания вызовов только одним определенным IP-адресом. На локальной стороне.
maddrTR

Отправка запросов на номер массовой рассылки.

Значения:

  • адрес сервера массовой рассылки;
  • "none" (обычная работа — отправка на прямой адрес).
none
modeTRРежим инкапсуляции ISUP. Принимает значения:
  • sip-proxy — направление на SIP (прокси,RFC 3261 );
  • sip-t — направление на SIP-T (RFC 3372);
  • sip-i — направление на SIP-I (ITU Q.1912-5;
  • sip-q — направление на QSIG.
-
my_fromTR, SUB

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

Необходимо для обеспечения возможности установки в заголовок "From" (при исходящих запросах на данную транковую группу или абонентов) 
коллективного адреса нод кластера. 

Значения: 

  • коллективное доменное имя кластера;
  • кастомное имя, из списка public_names (определяется на уровне параметров домена);
  • default — использовать локальное имя хоста, назначенного параметром конфигурации sip.transport/my_sip_address.

Опциональные параметры:

  • - --use_login - использовать логин вместо Cgpn в заголовке From
  • - --use number - использовать Cgpn в заголовке From (по умолчанию)
default
nat_traversalTR, SUB

Включение режима обхода NAT. Опция применима к SIP-пользователям и динамическим SIP-транкам (для которых требуется регистрация на ECSS).

Значения:

  • true — опция включена;
  • false — опция выключена.

Общий принцип режима NAT-traversal:

При включении этого параметра SSW игнорирует поле "Contact" в SIP-сообщениях и отправляет сигнализацию, используя адрес источника (source).

Для работы режима необходимо дополнительно настроить параметр udp-src-check на MSR, данный параметр работает аналогично параметру NAT-traversal, но уже не для SIP-сигнализации, а для RTP-потока, он позволяет SSW игнорировать данные источника в SDP и отправлять медиа на адрес источника (см. раздел Настройка программного медиасервера).

false
no_videoIFНа уровне интерфейса добавлено свойство no_video.

Возможные значения опции no_video:
  • false — опция включена, значение по умолчанию;
  • if_no_video_from_a — опция отключена.

Чтобы в SDP отсутствовала секция видео для исходящего вызова на номер Б, нужно чтобы:
  • на интерфейсе Б свойство no_video было выставлено в if_no_video_from_a;
  • отсутствовала секция видео в SDP входящем вызова от номера А (в рамках вызова с номера А на номер Б);
  • вызов с номера А на номер Б был прямой, т. е. вызов не через IVR, trunk;
  • Б может быть алиасом или транком.
Если условия выше были выполнены, то в рамках вызова из медиа профиля абонента Б удаляется секция видео.
На основе получившего медиа профиля формируется sdp-template, который засылается на msr в SIP-сообщении INVITE. В результате msr отдает OfferSDP без секции видео в SIP-сообщении 200 OK.
false
options_controlTR, SUB

Периодический контроль доступности направления (транка или контактов юзера).

При включении данной опции на транк с заданным интервалом отправляется запрос "SIP/OPTIONS". Если ответа не получено, то направление (контакт) переводится в неактивное состояние и шлется соответствующий alarm (см. настройку alarm_enable).

При этом периодический опрос не прекращается. При получении ответа направление (контакт) возвращается (если было неактивно) в активное состояние. Если опция выключена, то контроля доступности нет — считаем направление (контакт) доступным Кроме проверки доступности, результатом запроса "OPTIONS" является информация о параметрах встречной стороны, например, поддержка 100rel (надежная доставка предварительных ответов), timers (session-expire по RFC 4028).

0
original-cdpn-toTR, SUBПереключение подстановки CDPN на основе Original CDPN на основе принятых заголовков To либо Diversion.true
out_login (proxy_out_login)TR, SUBЛогин для исходящей авторизации. Необходим, если встречная сторона (транк) требует авторизации исходящих от нас запросов.-
out_password (proxy_out_password)TR, SUBПароль для исходящей авторизации. Необходим, если встречная сторона (транк) требует авторизации исходящих от нас запросов.-
published presenceSUB (info)Состояние, опубликованное терминалом SIP-пользователь (PUBLISH, Event: presence). Транслируется подписчикам услуги presence.-
play-rbtIF

Переопределение КПВ.

где MODE:

  • always — будет генерироваться всегда локальный КПВ
  • early-media — генерация КПВ на получение 180+SDP (Переопределение early-media)
  • ringing — генерация КПВ на получение 180
  • none — нет переопределения

Если данное свойство выставлено на интерфейсе, и произошел вызов на транк, то будет КПВ будет переопределяться.

none
portTRПорт назначения для транка.-
qop-authentication (aut_qop)SUB

Использование расширенной QOP-авторизации (повышенный уровень защиты).

Значения:

  • true — опция включена;
  • false — опция выключена.
false
realUriTR

Описание параметров удаленной стороны.

Формат: {MODE,ISUP,DEST_HOST,DEST_PORT}

  • MODE — режим: sipproxy, sipt (инкапсуляция ISUP по RFC 3372), sipi (инкапсуляция ISUP по ITU Q.1912-5);
  • ISUP — инкапсуляция ISUP: sub (без инкапсуляции), far (с инкапсуляцией);
  • DEST_HOST — адрес удаленной стороны (IP или доменное имя);
  • DEST_PORT — порт удаленной стороны (числовое значение, например, 5060).

Служебный параметр формируется автоматически при декларации или смене одного из параметров.

-
referred-by-as-cgpnTR, SUBНомер и поля user заголовка Referred-By используется в качестве Cgpn при отправке в ядро SetupInd.false
register-expire-minSUBМинимальное значение периода перерегистрации.90
register-expire-maxSUBМаксимальное значение периода перерегистрации.3600
registratorSUB (info)Имя и транспортные параметры ноды, которой была обработана регистрация. Выставляется протокол-адаптером SIP.-
regs_timeSUB (info)Время регистрации. Устанавливается протокол-адаптером SIP.-
rel_to_cancelTR

Включение инкапсуляции ISUP/REL в "SIP/CANCEL". Актуально для режимов с инкапсуляцией ISUP (см. настройку mode).
В зависимости от сети, на которой установлен SSW, либо от встречной стороны инкапсуляция может требоваться или быть неподдерживаемой.

Значения:

  • false — "CANCEL" без инкапсуляции ISUP/REL;
  • true — "CANCEL" с инкапсуляцией ISUP/REL.
false
remote-clientTRВыбор предустановленного профиля встречного сервера. Позволяет включать опции специфичные серверам конкретного производителя (см. настройку профиля абонентов SIP).
  • coral — Поддержка сервера CORAL;
  • default — стандартная работа.
default
remote-ctr-indicationTR, SUBЗаголовок для указания об удаленном CTR:
  • rpi — REMOTE-PARTY-ID;
  • pai — P-ASSERTED-IDENTITY;
  • both — одновременное включение REMOTE-PARTY-ID и P-ASSERTED-IDENTITY;
  • none.
rpi
remote-end-pointTRТранспортные параметры включения транка на встречной стороне. Включают в себя: ip-адрес/доменное имя и порт.
remote-network-typeTR

Тип удаленной сети. Используется для определения инициатора разъединения, в частности, при инкапсуляции ISUP/REL.

Значения:

  • private;
  • local;
  • transit;
  • international.
local
req100relTR

Требование надежных промежуточных ответов. Надежность обеспечивается 
отправкой запроса "PRACK" в ответ на соответствующий 1хх (RFC 3262).

Значения:

  • true — при отправке ответов группы 1хх включать "Require: 100rel";
  • false — требование надежности не отправляется;
  • supported — требование надежности не отправляется. 

Удаленная сторона поддерживает данную опцию, 
но требование надежности ему не отправляется;

  • unsupported — требование надежности не отправляется. 

Удаленная сторона не поддерживает данную опцию, но при настройке было задано "требовать надежность". 

В этом случае требование отправляться не будет, но если в дальнейшем (например, после очередного ответа на "OPTIONS") определится поддержка, то требование начнет ставиться, в этом случае данный параметр поменяет значение на "true".

false
rfc-4028-controlTR, SUB

Поддержка контроля сессии по RFC 4028, даже в случае, если удаленная сторона его не поддерживает. К настройке доступны значения "true" и "false".

Значения:

  • true — включено. Обновление сессии производится только в случае если встречная сторона поддерживает timer;
  • false — выключено;
  • force — включено. Обновление сессии производится не зависимо от поддержки timer встречной стороной.
true
route-by-viaTR

Настройка актуальна для динамического транка. Позволяет подставлять в Request-URI информацию из поля Contact, полученную при регистрации.

Значения:

  • true;
  • false.
false
routing.contextTR, SUB,IFКонтекст маршрутизации.-
sip-modificationsTR, SUB

Настройка модификации заголовков SIP в исходящих запросах и ответах. Кроме модификации текста доступно полное исключение заголовка из сообщения.

Формат: 

  • sip-modifications ignore headers = [HEADER1, HEADER2, ...] — исключение заголовка при отправке сообщения;
  • sip-modifications set PARAMETERS SET header = HEADER, key1 = val1, key2 = val2, ... — правило модификации; 
  • sip-modifications clean HEADER — сброс модификации.
  • Описание правил модификации:
  • add_new = TEXT — добавить новый заголовок с TEXT;
  • add_start = STRING — вставить текст в начало;
  • add_end = STRING — добавить текст в конец;
  • delete = STRING — найти и удалить указанный текст;
  • insert = STRING — вставить текст вместо удаленного предыдущей командой.
-
sip-transitTR, SUB

При звонке SIP/SIP есть возможность транзита отдельных заголовков

Формат: 

  • sip-transit set PARAMETERS SET key1 = val1, key2 = val2, ...

Параметры:

  • headers = [HEADER1, HEADER2, ...] — транзит SIP заголовков в исходящих запросах и ответах на вторую сторону;
  • clean — сброс всех настроек транзита.
-
sip-domainTR, SUBSIP-домен в "Request URI", заголовках From, To исходящего от нас запроса. Значения: 
  • имя домена;
  • "undefined".
-
supportedSUB (info)Функции (Supported), поддерживаемые терминалом SIP-пользователя.-
support_encodingSUB (info),IF

Отображение Display Name в зависимости от типа кодировки

Значения:

  • utf-8 — использование кодировки UTF-8 для данного абонента;
  • latin1 — использование кодировки latin1 для данного абонента;
  • cp1251 — использование кодировки cp1251 для данного абонента.
-
symbol_hash_as_isTR, SUBПередача символа '#' не в Hex-формате (%23). Значения:
  • false — решётка передаётся в hex-формате (%23);
  • true — решётка передаётся символом '#'.
false
trunk (trunk name) TRЛогическое объединение транков (направление). Необходим для группировки SIP-направлений в целях контроля, статистики, СОРМ и т.д. Значением является имя.-
trusted-ipSUBСписок доверенных IP-адресов, запросы REGISTER и INVITE, полученные с IP-адреса из этого списка, обрабатываются без аутентификации.none
tel-uri-in-diversionTR, SUBИспользование формата "tel:" вместо "sip:" в заголовке Diversion при переадресации звонка.false
uptimeTR (info)Длительность последнего соединения с транком (либо после пропадания ответов на периодический опрос доступности, либо с момента старта или декларации.-
user agentSUB (info)Название терминала SIP-пользователя (User-Agent).-
use-global-callrefTRИспользование GLOBAL CALL REF для ISUP-ETSI. Параметр работает для адаптации диалектов национальных стандартов ОКС-7 при пропускании международного трафика.false
user-nameTRИмя юзера при исходящей регистрации транка. Если не назначено (значение none), используется имя транка.none

Описание параметров (свойств) MEGACO-интерфейса приведено в разделе Приложении В. Набор параметров интерфейса MEGACO или во вкладке ниже.

 Нажмите здесь для раскрытия описания параметров интерфейса MEGACO


Приложение В. Набор параметров интерфейса MEGACO

В данном разделе описываются параметры (свойства) интерфейсов MEGACO.

Тип терминала (свойство sip-интерфейса):

  • smart — терминал, который выполняет постановку на удержание (HOLD) методом Send-Only. Поддерживает работу с несколькими линиями и работу основных услуг. Например: перевод вызова, переадресация, удержание и др.
  • basic — терминал, который поддерживает работу только с одной линией. Для постановки на удержание (HOLD) использует flash.

Тип терминала устанавливается командой:

/domain/p.city/iface/user-set pa_sip pa_sip 720@p.city terminal_type smart

Если тип терминала не задан, то система ECSS-10 работает с таким интерфейсом в режиме smart.

  • Если в таблице не указано значение по умолчанию ("-"), это значит, что оно не определено и устанавливается протокол-адаптером MEGACO.
  • Если в таблице указано значение по умолчанию ("не определен"), это значит, что параметр необходимо настроить вручную.

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

НазваниеОписаниеЗначение по умолчанию
adapter_typeТип протокол-адаптера. Может принимать значения: megaco, sip. Устанавливается протокол-адаптером MEGACO.-
bind_toIP-адрес на сервере, который будет использован для протокола megaco.не определен
core\fixationИмя кластера или фермы кластеров ядра, к которому будет идти тяготение данного интерфейса. Имеет строковое значение.не определен
encodingФормат кодирования сообщений megaco, принимает значения:
  • binary — бинарный;
  • compact_text — сокращенный;
  • pretty_text — полный;
  • text — ссылка на pretty_text (полный).
text
fax_detectКонфигурация стороны детектирования факса, принимает значения:
  • callee — на вызываемой стороне;
  • caller — на вызывающей стороне;
  • both — на обеих сторонах;
  • none — детектирование выключено.
callee
groupНазвание группы. Соответствует названию шлюза MEGACO. Устанавливается протокол-адаптером MEGACO.-
isActive

Флаг, определяющий состояние интерфейса.

Значения:

  • true — интерфейс активирован;
  • false — интерфейс деактивирован.

Устанавливается протокол-адаптером MEGACO.

-
listen_portСлушающий порт для входящих запросов по MEGACO протоколу.2944
mq.init\exchageНазвание "exchange" для инициирующих сообщений на AMQP брокере. Устанавливается протокол-адаптером MEGACO.-
mq.init\routing_keyКлюч маршрутизации для инициирующих сообщений на AMQP брокере. Устанавливается протокол-адаптером MEGACO.-
ownerВладелец интерфейса. Соответствует названию кластера протокол-адаптеров MEGACO. Устанавливается протокол-адаптером MEGACO.-
pkg_adid_dtВремя детектирования прекращения трафика RTP или RTCP.disabled
routing.contextКонтекст маршрутизации по умолчанию. Устанавливается протокол-адаптером MEGACO. Может быть изменен через команду:
cluster/adapter/_ИМЯ_КЛАСТЕРА_/set routing_context
-
send_release_ackФлаг, определяющий необходимость отправки сообщения 'ReleaseReqAck'. Это служебный параметр, устанавливается по требованию сервисного центра.
  • true — разрешено;
  • false — запрещено.
false
subtypeМожет принимать значения: dynamic, subscription, trunk, user. Устанавливается протокол-адаптером MEGACO.-
transportТранспортный протокол, который будет использован по умолчанию. Может принимать значения:
  • udp;
  • tcp.
udp
use_rtcpФлаг использования RTCP:
  • true — использование включено;
  • false — использование выключено.
false

Команды управления конфигурацией определенного интерфейса

info

Команда для вывода на экран информации о свойствах (свойстве) определенного интерфейса.

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

/domain/<DOMAIN>/iface/info

Синтаксис:

info *|<OWNER> *|<GROUP> <NAME RANGE> [<PROPERTY>]

Параметры:

<OWNER> - название владельца (символ "*" используется для указания всех владельцев);
<GROUP> - название группы (символ "*" используется для указания всех групп);
<NAME RANGE> - название интерфейса;
<PROPERTY> - свойство (опциональный параметр, если параметр не задан, то будет отображена информация о всех свойствах данного интерфейса).

Примеры:

Просмотр параметров интерфейса абонента:

admin@ds1@ecss1:/$ domain/biysk.local/iface/info * loc.gr 240006@biysk.local 
┌──────────────────┬─┬───────────────┬────────────────────────────────────────────────────────────────────────────────┐
│    Interface     │W│   Property    │                                     Value                                      │
├──────────────────┼─┼───────────────┼────────────────────────────────────────────────────────────────────────────────┤
│240006@biysk.local│i│account        │{"...50-52-48-48-48-54","...66-115-107-95-48-48-54-45-116-101-115-116"}         │
│                  │i│adapter\version│"3.14.7.525"                                                                    │
│                  │i│alias          │"alias-as-user"                                                                 │
│                  │i│aliases_list   │["240006"]                                                                      │
│                  │i│auth_qop       │true                                                                            │
│                  │i│declaration    │{"admin",{1611,824911,432238}}                                                  │
│                  │i│gate           │{gate_amqp,<<"acp.adapter.init.ex">>,<<"acp.sip.sip1.ipset1.init.rk">>}         │
│                  │i│group          │"loc.gr"                                                                        │
│                  │i│id             │<<"064bc964f6513fd8">>                                                          │
│                  │i│isActive       │true                                                                            │
│                  │i│media-profile  │{media_profile,"default",user,                                                  │
│                  │ │               │    [{media_profile_codecs,'<other>',                                           │
│                  │ │               │         [{media_profile_codec,<<"<other>">>,<<"*">>,true,#{}}],                │
│                  │ │               │         #{offroad => false,'rtcp-enabled' => true}},                           │
│                  │ │               │     {media_profile_codecs,audio,                                               │
│                  │ │               │         [{media_profile_codec,<<"G722">>,<<"*">>,true,#{}},                    │
│                  │ │               │          {media_profile_codec,<<"PCMA">>,<<"*">>,true,#{}},                    │
│                  │ │               │          {media_profile_codec,<<"PCMU">>,<<"*">>,true,#{}},                    │
│                  │ │               │          {media_profile_codec,<<"G729">>,<<"*">>,true,#{}},                    │
│                  │ │               │          {media_profile_codec,<<"telephone-event">>,<<"*">>,true,#{}}],        │
│                  │ │               │         #{offroad => false,'rtcp-enabled' => true}}],                          │
│                  │ │               │    #{'dtmf-receive-type' => auto,'dtmf-transmit-type' => transit}}             │
│                  │i│my_from        │none                                                                            │
│                  │i│owner          │"sip1"                                                                          │
│                  │i│profile        │undefined                                                                       │
│                  │i│routing.context│ctx_from_local                                                                  │
│                  │i│sip_domain     │"biysk.local"                                                                   │
│                  │D│site           │<<"local">>                                                                     │
│                  │i│subtype        │user                                                                            │
│                  │D│terminal_type  │smart                                                                           │
│                  │i│type           │sip                                                                             │
│                  │i│user_agent     │"VP-15P/2.5.0.203 sofia-sip/1.12.10"                                            │
│                  │i│user_name      │"240006"                                                                        │
│                  │D│zone           │<<"default">>                                                                   │
└──────────────────┴─┴───────────────┴────────────────────────────────────────────────────────────────────────────────┘

Legend:
W: Where property is set:
   D: This is default property
   G: This is global property
   g: This is group property
   O: This is owner property
   B: This is group+owner property
   i: This is interface property
   ?: Unknown property level
Note: * char in W column means "Can't read iface resource info". Error reason in value column in this case

[exec at: 16.02.2021 15:03:03, exec time: 20ms, nodes: ds1@ecss1 v.3.14.7.585


Просмотр установленного значения временной зоны для транка:

admin@ds1@ecss1:/$ domain/biysk.local/iface/info * * trunk timezone
┌─────────┬─┬────────┬───────────┐
│Interface│W│Property│   Value   │
├─────────┼─┼────────┼───────────┤
│trunk    │i│timezone│'UTC+07:00'│
└─────────┴─┴────────┴───────────┘

Legend:
W: Where property is set:
   D: This is default property
   G: This is global property
   g: This is group property
   O: This is owner property
   B: This is group+owner property
   i: This is interface property
   ?: Unknown property level
Note: * char in W column means "Can't read iface resource info". Error reason in value column in this case

[exec at: 03.11.2023 16:48:18, exec time: 7ms, nodes: ds1@ecss1 v.3.14.14.600]

list

Команда для просмотра списка интерфейсов ECSS-10 для определенного профиля группы, владельца.

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

/domain/<DOMAIN>/iface/list

Синтаксис:

list [*|<OWNER> [*|<GROUP>]] [<PROPERTY> <OPERATOR> <VALUE>]]

Параметры:

  • <OWNER> - название владельца (символ "*" используется для указания всех владельцев);
  • <GROUP> - название группы (символ "*" используется для указания всех групп).
  • <PROPERTY> - свойство интерфейса, возможные значения приведены в таблице 1.;
  • <OPERATOR> - оператор сравнения : '==' | '<>' | '>' | '<' | '>=' | '=<' | '~'; 
    • '==' - равно;
    • '<>' - не равно;
    • '>'  - больше;
    • '>=' - больше или равно;
    • '<'  - меньше;
    • '<=' - меньше или равно;
    • '~'  - содержит.
  • <VALUE>  - значение свойства.

Пример:

admin@ds1@ecss1:/$ domain/biysk.local/iface/list sip1 loc.gr terminal_type == basic
┌───────────┬───────────────────────────────────────────────┬───────────────────────────────────────────────────────────────┬───────────────────────────────┬───────────────────────────────┬───────────┐
│   Type    │                     Iface                     │                             Name                              │             Owner             │             Group             │  Active   │
├───────────┼───────────────────────────────────────────────┼───────────────────────────────────────────────────────────────┼───────────────────────────────┼───────────────────────────────┼───────────┤
│sip        │064bc964febdde57                               │240470@biysk.local                                             │sip1                           │loc.gr                         │true       │
│sip        │064bc9653cd7615b                               │240475@biysk.local                                             │sip1                           │loc.gr                         │false      │
│sip        │064bc965007abdf0                               │240474@biysk.local                                             │sip1                           │loc.gr                         │true       │
│sip        │064bc964fbacf7eb                               │240465@biysk.local                                             │sip1                           │loc.gr                         │true       │
│sip        │064bc96537760556                               │240471@biysk.local                                             │sip1                           │loc.gr                         │false      │
│sip        │064bc964face07a5                               │240464@biysk.local                                             │sip1                           │loc.gr                         │true       │
│sip        │064bc9653aef6a3b                               │240473@biysk.local                                             │sip1                           │loc.gr                         │false      │
└───────────┴───────────────────────────────────────────────┴───────────────────────────────────────────────────────────────┴───────────────────────────────┴───────────────────────────────┴───────────┘
Ifaces for domain: "biysk.local"
Ifaces in table: 7

[exec at: 16.02.2021 15:07:11, exec time: 32ms, nodes: ds1@ecss1 v.3.14.7.585]

user-set

Данной командой настраиваются свойства интерфейса. Описание свойств, которые настраиваются на определенном  интерфейсе приведено выше.

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

/domain/<DOMAIN>/iface/user-set

Синтаксис:

user-set <OWNER> <GROUP> <IFACE RANGE> <PROPERTY> <VALUE>

Параметры:

<OWNER> - название владельца (символ "*" используется для указания всех владельцев);
<GROUP> - название группы (символ "*" используется для указания всех групп);
<IFACE RANGE> - название интерфейса;
<PROPERTY> - свойство интерфейса, значение которого требуется установить, описание приведено в таблице 1
<VALUE> - значение свойства.

Примеры:

Установка кодировки:

admin@ds1@ecss1:/$ domain/biysk.local/iface/user-set sip1 loc.gr 240530@biysk.local support-encoding utf8
Property 'support-encoding' successfully changed to 'utf8' for interfaces:
240530@biysk.local

[exec at: 16.02.2021 15:08:04, exec time: 18ms, nodes: ds1@ecss1 v.3.14.7.585]

Установка контекста маршрутизации:

admin@ds1@ecss1:/$ domain/biysk.local/iface/user-set .system * system:ivr routing.context ctx_from_local
Property 'routing.context' successfully changed to 'ctx_from_local' for interfaces:
system:ivr

[exec at: 16.02.2021 15:08:33, exec time: 28ms, nodes: ds1@ecss1 v.3.14.7.585]


Установка предпочитаемого сайта для абонента:

admin@ds1@ecss1:/$ domain/biysk.local/iface/user-set sip1 loc.gr 240606@biysk.local site remote
Property 'site' successfully changed to 'remote' for interfaces:
240606@biysk.local

[exec at: 16.02.2021 15:12:10, exec time: 21ms, nodes: ds1@ecss1 v.3.14.7.585]


Установка зоны для транка:

admin@ds1@ecss1:/$ domain/biysk.local/iface/user-set sip1 sbc.gr nsk_sbc zone nsk
Property 'zone' successfully changed to 'nsk' for interfaces:
nsk_sbc

[exec at: 16.02.2021 15:12:35, exec time: 26ms, nodes: ds1@ecss1 v.3.14.7.585]


Включение поддержки  CFC на интерфейсе:

admin@ds1@ecss1:/$ domain/biysk.local/iface/user-set sip1 loc.gr 240473@biysk.local cfc-support true
Property 'cfc-support' successfully changed to 'true' for interfaces:
240473@biysk.local

[exec at: 16.02.2021 15:12:56, exec time: 30ms, nodes: ds1@ecss1 v.3.14.7.585]


Установка временной зоны для транка:

admin@ds1@ecss1:/$ domain/biysk.local/iface/user-set * * trunk timezone UTC+07:00              
Property 'timezone' successfully changed to 'UTC+07:00' for interfaces:
trunk

[exec at: 03.11.2023 16:58:15, exec time: 13ms, nodes: ds1@ecss1 v.3.14.14.600]

Команды конфигурирования свойств интерфейсов для профиля группы, профиля владельца

group-info

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

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

/domain/<DOMAIN>/iface/group-info

Синтаксис:

group-info [-o <OWNER>] [-g <GROUP>]

Параметры:

-о - флаг, который указывает на свойства уровня владельца интерфейса;
-g - флаг, который указывает на свойства глобального уровня;
<OWNER> - имя профиля владельца;
<GROUP> - имя профиля группы.

Пример:

admin@ds1@ecss1:/$ domain/biysk.local/iface/group-info -g sbc.gr -o sip1
Domain biysk.local onwer sip1 group sbc.gr iface resoureces properties:
┌─┬────────┬───────────────────────────────────────────────────────────────────────┐
│W│Property│                                 Value                                 │
├─┼────────┼───────────────────────────────────────────────────────────────────────┤
│g│domain  │"biysk.local"                                                          │
│g│gate    │{gate_amqp,<<"acp.adapter.init.ex">>,<<"acp.sip.sip1.ipset1.init.rk">>}│
│g│group   │{gate_amqp,<<"acp.adapter.init.ex">>,<<"acp.sip.sip1.ipset1.init.rk">>}│
│g│owner   │"sip1"                                                                 │
└─┴────────┴───────────────────────────────────────────────────────────────────────┘

Legend:
W: Where property is set:
   G: This is global property
   g: This is group property
   O: This is owner group property
   B: This is group+owner property
   ?: Unknown property level
Note: * char in W column means "Can't read iface resource info". Error reason in value column in this case

[exec at: 16.02.2021 15:13:19, exec time: 5ms, nodes: ds1@ecss1 v.3.14.7.585]

group-clean

Команда для сброса свойств интерфейсов.

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

/domain/<DOMAIN>/iface/group-clean

Синтаксис:

group-clean [-o <OWNER>] [-g <GROUP>] -p <PROPERTY>

Параметры:

-о - флаг, который указывает на свойства уровня владельца интерфейса;
-g - флаг, который указывает на свойство принадлежности группы;
-p - флаг, который указывает на параметр для группы интерфейса
<OWNER> - имя профиля владельца;
<GROUP> - имя профиля группы;
<PROPERTY> - свойство интерфейса.

Пример:

admin@ds1@ecss1:/$ domain/biysk.local/iface/group-clean -g ssw.gr -o sip1 -p cfc-support
Iface resources group property cfc-support is cleaned for domain biysk.local owner sip1, group ssw.gr

[exec at: 16.02.2021 15:14:24, exec time: 24ms, nodes: ds1@ecss1 v.3.14.7.585]

group-set

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

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

/domain/<DOMAIN>/iface/group-set

Синтаксис:

group-set [-o <OWNER>] [-g <GROUP>] -p <PROPERTY> <VALUE>

Параметры:

-о - флаг, который указывает на свойства уровня владельца интерфейса;
-g - флаг, который указывает на свойства глобального уровня;
-p - флаг, который указывает на параметр для группы интерфейса
<OWNER> - имя профиля владельца;
<GROUP> - имя профиля группы;
<PROPERTY> - свойство интерфейса;
<VALUE> - значение свойства.

Пример:

admin@ds1@ecss1:/$ domain/biysk.local/iface/group-set -g ssw.gr -o sip1 -p cfc-support true
Defined iface resources group property cfc-support for group ssw.gr, owner sip1

[exec at: 16.02.2021 15:13:50, exec time: 20ms, nodes: ds1@ecss1 v.3.14.7.585]