Приложение Б. Набор параметров интерфейса 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-интерфейса
Название параметра | Тип | Описание | Значение по умолчанию |
---|---|---|---|
access_group | TR, SUB | Группа, которая определяет правила доступа для этого пользователя | all |
alarm_enable | TR, SUB | Отправка предупреждений при переходе интерфейса в неактивное состояние. Для транков/абонентов: если включена опция периодического опроса (см. настройку options_control). Значения:
| true |
alias (aliases_list) | SUB | Cписок алиасов, если пользователь был задекларирован с логическим, а не цифровым номером. | - |
aliases activities | SUB (info) | Cписок алиасов с указанием их состояния. | - |
allow | SUB (info,rt) | Параметр хранит для абонента запросы, поддерживаемые пользовательским шлюзом, которые были получены в запросе регистрации (используется, чтобы знать, чем отправить запрос "check OPTIONS" или "INVITE"). Устанавливается протокол-адаптером SIP. | - |
allow events | SUB (info) | Расширения (Allow-Events), поддерживаемые терминалом SIP-пользователя. | - |
authentication | SUB (info) | Параметры аутентификации SIP-пользователя: логин, пароль, требование qop. | none |
auto-answer-version | SUB | Автоматический ответ терминала вызываемому абоненту (позволяет средствами протокола SIP установить диалог, не дожидаясь ответа стороной Б). Значения:
| Alert-Info: Auto Answer |
category_to_sip | TR, SUB | Выбор режима передачи категории вызывающей стороны средствами протокола SIP (для обеспечения совместимости с встречными системами различных производителей). Режим передачи может быть задан на уровне домена (Pbx), группы SIP-юзеров, SIP-интерфейса (транка или юзера). В зависимости от уровня, имеются следующие режимы:
| default |
cdpn-transformation | TR | Подмена CDPN в сообщении SetupInd от SIP-адаптера к ядру значением из ACDPN или Redirecting Значения:
| none |
channel-contact-map | TR | Параметр связывает номер канала с контактом, который уже должен быть создан. Если канал не существует, то он будет создан. Значения:
| - |
client-profile | SUB | Идентификатор профиля SIP-клиента. Позволяет включать опции специфичные терминалам конкретного производителя или модели (см. настройку профиля абонентов SIP).
| none |
compact-form | TR, SUB | Использование SIP-заголовков компактной формы.
| - |
connect time | TR (info) | Время последнего соединения с транком (либо после пропадания ответов на периодический опрос доступности, либо с момента старта или декларации. | - |
contacts definition | SUB (info,rt) | Список зарегистрированных контактов с сопутствующей им информацией: время истечения регистрации, локальная точка регистрации, заголовков Via, User-Agetnt. | - |
content_encoding | TR | Кодирование тела SIP-запроса (ответа). Значения:
| none |
declared by | TR, SUB (info,rt) | Дата декларации интерфейса и оператор, выполнивший ее. | - |
digest | SUB | Требование аутентификации. Для частной сети при настроенных trusted-ip аутентификация может быть излишней. | true |
disconnections number | TR (info) | Количество потерь связи с транком (прекращение ответов на периодический опрос доступности). | - |
disable-remote-port-control | TR, SUB | Отключение проверки удаленного порта при входящем вызове от абонента. Значения:
| false |
display-name-encoding | Тип схемы для кодирования/декодирования sip url. | win1251 | |
dtmf-duration | TR, SUB | Длительность DTMF-сигнала, передаваемая в исходящем сообщении SIP INFO. | 100 |
dtmf-relay | TR, SUB | Выбор типа MIME для передачи DTMF в теле запроса SIP INFO. При значении "true" используется тип "application/dtmf-relay", иначе "application/dtmf". | false |
expand-destinations | TR | Позволяет ввести несколько IP адресов для транка, с которых разрешается принимать входящие вызовы. | - |
fork-mode | SUB | Регистрация нескольких контактов SIP-абонента.
Allow-repeat-ip — разрешить перезапись контактов с одного IP-адреса, но разных портов:
При последовательном переборе контактов (режимы find-me) возможно переключение:
| disable |
gate | TR, SUB (info) | Имя инициирующей очереди и ключ маршрутизации адаптера на внутреннем транспорте (AMQP). Параметры являются служебными, назначаются всегда автоматически при декларации или регистрации в зависимости от типа транка или юзера. | - |
group | TR,SUB | Группа интерфейсов, которой принадлежит SIP-пользователь. | - |
history_info | TR | Включение оригинальной информации о переадресации в заголовок History-Info в исходящий INVITE. | false |
host | TR | IP-адрес или имя хоста сервера. | - |
host-to-invite | SUB | registered-domain — в исходящем INVITE в заголовке To используется домен, полученный в запросе регистрации. sip-domain — в исходящем INVITE в заголовке To используется SIP-домен пользователя. | registered-domain |
ice/enabled | IF | Включается, когда необходимо обеспечить корректную работу web-клиента, чтобы вызов уходил с SDP, понятным WebRTC. Значения:
Вместе с данным параметром нужно включить nat-traversal. Данный параметр в своей работе конфликтует с core_forking, являясь менее приоритетным. | |
core_forking | IF | Включается, когда необходимо обеспечить одновременное использование абонентом телефонного аппарата и WebRTC-клиента, работающего по протоколу ice. На все контакты такого пользователя делаются параллельные вызовы. Контакт, ответивший раньше остальных, будет проключен с вызывающим абонентом. Данный параметр в своей работе конфликтует с ice/enabled, являясь более приоритетным. | none |
inc_authentication | TR | Требование прокси авторизации со стороны транка. Принимает значения:
| false |
inc_authentication_type | TR | Тип запроса авторизации: user — в ответе 401, proxy — в ответе 407. | user |
inc_authentication_login | TR | Логин для входящей прокси авторизации. Используется, если требуется прокси-авторизация для транка при входящем занятии. | - |
inc_authentication_password | TR | Пароль для входящей прокси авторизации. Используется, если требуется прокси-авторизация для транка при входящем занятии. | - |
internal iface name | SUB (info) | Идентификатор интерфейса внутри системы. | - |
inc-login | TR | логин встречной стороны для аутентификации входящего вызова. | LOGIN |
inc-password | TR | пароль встречной стороны для аутентификации входящего вызова. | PASSWORD |
ip-set | TR | Привязка транка к локальному адресу (набору адресов). Настроенные ip-set смотри: cluster/adapter/sip1/sip/network/info. | - |
isActive | TR, SUB (info) | Состояние интерфейса в данный момент. Значения:
| false |
isup_r_ccl_send | TR | Поддержка сообщения CCL ISUP-R. При отбое со стороны вызывающего абонента (далее абонента А) на сторону вызываемого абонента (далее абонента Б) Актуально только для режимов с инкапсуляцией ISUP (см. настройку mode). Значения:
| false |
isup-cause-location | TR, SUB | Локализация транка на сети. Используется для определения инициатора разъединения, в частности, при инкапсуляции ISUP/REL. Данная локализация описана в рекомендации ITU Q.850:
Реальные значения (при отображении параметров интерфейсов):
Разрешенные значения для ввода (при вводе с терминала используются сокращения):
По [TAB] параметры разворачиваются в указанном выше виде с подсказкой после символа подчеркивания. | local_network |
last via | SUB (info) | Информация о прохождении запроса регистрации. | - |
listen_port | TR | Порт для SIP-сигнализации с транка на стороне SSW. Если на адаптере открыто несколько слушающих портов, то можно различать транки по получению сообщений с одного адреса одной сети, но с разных портов. Номер порта всегда должен быть выбран из имеющегося списка. | - |
local-end-point | TR | Транспортные параметры включения транка на стороне ECSS. Включают в себя: ip-set, listen-port, node-control. Node-control включается при необходимости обслуживания вызовов только одним определенным IP-адресом. На локальной стороне. | |
maddr | TR | Отправка запросов на номер массовой рассылки. Значения:
| none |
mode | TR | Режим инкапсуляции ISUP. Принимает значения:
| - |
my_from | TR, SUB | Назначается для групп транков или абонентов. Назначение исходящего адреса, отличного от локального хоста. Необходимо для обеспечения возможности установки в заголовок "From" (при исходящих запросах на данную транковую группу или абонентов) Значения:
Опциональные параметры:
| default |
nat_traversal | TR, SUB | Включение режима обхода NAT. Опция применима к SIP-пользователям и динамическим SIP-транкам (для которых требуется регистрация на ECSS). Значения:
Общий принцип режима NAT-traversal: При включении этого параметра SSW игнорирует поле "Contact" в SIP-сообщениях и отправляет сигнализацию, используя адрес источника (source). Для работы режима необходимо дополнительно настроить параметр udp-src-check на MSR, данный параметр работает аналогично параметру NAT-traversal, но уже не для SIP-сигнализации, а для RTP-потока, он позволяет SSW игнорировать данные источника в SDP и отправлять медиа на адрес источника (см. раздел Настройка программного медиасервера). | false |
no_video | IF | На уровне интерфейса добавлено свойство no_video. Возможные значения опции no_video:
На основе получившего медиа профиля формируется sdp-template, который засылается на msr в SIP-сообщении INVITE. В результате msr отдает OfferSDP без секции видео в SIP-сообщении 200 OK. | false |
options_control | TR, SUB | Периодический контроль доступности направления (транка или контактов юзера). При включении данной опции на транк с заданным интервалом отправляется запрос "SIP/OPTIONS". Если ответа не получено, то направление (контакт) переводится в неактивное состояние и шлется соответствующий alarm (см. настройку alarm_enable). При этом периодический опрос не прекращается. При получении ответа направление (контакт) возвращается (если было неактивно) в активное состояние. Если опция выключена, то контроля доступности нет — считаем направление (контакт) доступным Кроме проверки доступности, результатом запроса "OPTIONS" является информация о параметрах встречной стороны, например, поддержка 100rel (надежная доставка предварительных ответов), timers (session-expire по RFC 4028). | 0 |
original-cdpn-to | TR, SUB | Переключение подстановки CDPN на основе Original CDPN на основе принятых заголовков To либо Diversion. | true |
out_login (proxy_out_login) | TR, SUB | Логин для исходящей авторизации. Необходим, если встречная сторона (транк) требует авторизации исходящих от нас запросов. | - |
out_password (proxy_out_password) | TR, SUB | Пароль для исходящей авторизации. Необходим, если встречная сторона (транк) требует авторизации исходящих от нас запросов. | - |
published presence | SUB (info) | Состояние, опубликованное терминалом SIP-пользователь (PUBLISH, Event: presence). Транслируется подписчикам услуги presence. | - |
play-rbt | IF | Переопределение КПВ. где MODE:
Если данное свойство выставлено на интерфейсе, и произошел вызов на транк, то будет КПВ будет переопределяться. | none |
port | TR | Порт назначения для транка. | - |
qop-authentication (aut_qop) | SUB | Использование расширенной QOP-авторизации (повышенный уровень защиты). Значения:
| false |
realUri | TR | Описание параметров удаленной стороны. Формат: {MODE,ISUP,DEST_HOST,DEST_PORT}
Служебный параметр формируется автоматически при декларации или смене одного из параметров. | - |
referred-by-as-cgpn | TR, SUB | Номер и поля user заголовка Referred-By используется в качестве Cgpn при отправке в ядро SetupInd. | false |
register-expire-min | SUB | Минимальное значение периода перерегистрации. | 90 |
register-expire-max | SUB | Максимальное значение периода перерегистрации. | 3600 |
registrator | SUB (info) | Имя и транспортные параметры ноды, которой была обработана регистрация. Выставляется протокол-адаптером SIP. | - |
regs_time | SUB (info) | Время регистрации. Устанавливается протокол-адаптером SIP. | - |
rel_to_cancel | TR | Включение инкапсуляции ISUP/REL в "SIP/CANCEL". Актуально для режимов с инкапсуляцией ISUP (см. настройку mode). Значения:
| false |
remote-client | TR | Выбор предустановленного профиля встречного сервера. Позволяет включать опции специфичные серверам конкретного производителя (см. настройку профиля абонентов SIP).
| default |
remote-ctr-indication | TR, SUB | Заголовок для указания об удаленном CTR:
| rpi |
remote-end-point | TR | Транспортные параметры включения транка на встречной стороне. Включают в себя: ip-адрес/доменное имя и порт. | |
remote-network-type | TR | Тип удаленной сети. Используется для определения инициатора разъединения, в частности, при инкапсуляции ISUP/REL. Значения:
| local |
req100rel | TR | Требование надежных промежуточных ответов. Надежность обеспечивается Значения:
Удаленная сторона поддерживает данную опцию,
Удаленная сторона не поддерживает данную опцию, но при настройке было задано "требовать надежность". В этом случае требование отправляться не будет, но если в дальнейшем (например, после очередного ответа на "OPTIONS") определится поддержка, то требование начнет ставиться, в этом случае данный параметр поменяет значение на "true". | false |
rfc-4028-control | TR, SUB | Поддержка контроля сессии по RFC 4028, даже в случае, если удаленная сторона его не поддерживает. К настройке доступны значения "true" и "false". Значения:
| true |
route-by-via | TR | Настройка актуальна для динамического транка. Позволяет подставлять в Request-URI информацию из поля Contact, полученную при регистрации. Значения:
| false |
routing.context | TR, SUB,IF | Контекст маршрутизации. | - |
sip-modifications | TR, SUB | Настройка модификации заголовков SIP в исходящих запросах и ответах. Кроме модификации текста доступно полное исключение заголовка из сообщения. Формат:
| - |
sip-transit | TR, SUB | При звонке SIP/SIP есть возможность транзита отдельных заголовков Формат:
Параметры:
| - |
sip-domain | TR, SUB | SIP-домен в "Request URI", заголовках From, To исходящего от нас запроса. Значения:
| - |
supported | SUB (info) | Функции (Supported), поддерживаемые терминалом SIP-пользователя. | - |
support_encoding | SUB (info),IF | Отображение Display Name в зависимости от типа кодировки Значения:
| - |
symbol_hash_as_is | TR, SUB | Передача символа '#' не в Hex-формате (%23). Значения:
| false |
trunk (trunk name) | TR | Логическое объединение транков (направление). Необходим для группировки SIP-направлений в целях контроля, статистики, СОРМ и т.д. Значением является имя. | - |
trusted-ip | SUB | Список доверенных IP-адресов, запросы REGISTER и INVITE, полученные с IP-адреса из этого списка, обрабатываются без аутентификации. | none |
tel-uri-in-diversion | TR, SUB | Использование формата "tel:" вместо "sip:" в заголовке Diversion при переадресации звонка. | false |
uptime | TR (info) | Длительность последнего соединения с транком (либо после пропадания ответов на периодический опрос доступности, либо с момента старта или декларации. | - |
user agent | SUB (info) | Название терминала SIP-пользователя (User-Agent). | - |
use-global-callref | TR | Использование GLOBAL CALL REF для ISUP-ETSI. Параметр работает для адаптации диалектов национальных стандартов ОКС-7 при пропускании международного трафика. | false |
user-name | TR | Имя юзера при исходящей регистрации транка. Если не назначено (значение none), используется имя транка. | none |
Описание параметров Виртуальной АТС на уровне SIP-адаптера:
domain/<DOMAIN>/sip/properties
domain/<DOMAIN>/sip/properties_sys