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

Различают:

  • параметры SIP-транка (TR) — просмотр и установка командами /domain/DOMAIN/trunk/sip/...
  • параметры локального SIP-абонента (SUB) — просмотр и установка командами /domain/DOMAIN/sip/user/...
    Пометка "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
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
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-rbtTR

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

где 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Контекст маршрутизации.-
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)

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

Значения:

  • utf-8 — использование кодировки UTF-8 для данного абонента;
  • latin1 — использование кодировки latin1 для данного абонента;
  • cp1251 — использование кодировки cp1251 для данного абонента.
-
symbol_hash_as_isTR, SUBПередача символа '#' не в Hex-формате (%23). Значения:
  • false — решётка передаётся в hex-формате (%23);
  • true — решётка передаётся символом '#'.
false
ice/enabledSUBВключается, когда необходимо обеспечить корректную рабоу Web-клиента, чтобы вызов уходил с SDP понятный WebRTC. Значения:
  • false — решётка передаётся в hex-формате (%23);
  • true — решётка передаётся символом '#'.

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


trunkTRЛогическое объединение транков (направление). Необходим для группировки 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
Описание параметров кластера SIP:

/adapter/<CLUSTER>/properties

Описание параметров Виртуальной АТС на уровне SIP-адаптера:

domain/<DOMAIN>/sip/properties
domain/<DOMAIN>/sip/properties_sys