Спецификация команд внешнего интерфейса SIP софтфона

Обмен сообщениями между SIP сотфоном и native компонентом.

Обмен между native компонентом и софтфоном производится по протоколу TCP. SIP софтфон открывает серверный сокет на порту, указанному в настройках (по умолчанию 2555). Native компонент подключается к этому сокету в блокирующем режиме. В текущей версии возможно подключение к SIP софтфону только одного native компонента. SIP софтфон и native компонент могут обмениваться данными в обоих направлениях.

Сообщение обмена представляет собой строку вида <ключ1>=<значение1>; <ключ2>=<значение2>; ...<ключN>=<значениеN> Ключи и значения по возможности записываются в нижнем регистре.

 

Ключевые слова.

Тип сообщения type и имя сообщения name

  • event - событие, события отсылаемые софтфоном Native компоненту

type=event;name=<Имя события> ...

  • command - команда, команды отсылаемые Native компонентом софтфону

type=command;name=<Имя команды> ...

 

События type=event, значения ключа name

  • onactivelinechange - изменение текущей активной линии софтфона

Формат строки сообщения при переключении на свободную линию:

type=event;name=onactivelinechange;line=<С линии>;toline =<На линию>

Формат строки сообщения при переключении на занятую линию:

type=event;name=onactivelinechange;line=<С линии>;toline=<На линию>; number=<Номер абонента>; isincoming=<true|false>;hold=<true|false>  

Возникает в следующих случаях:
 - при интерактивном переключении активной линии на софтфоне;
 - при отработке софтфоном команды activeline.

Набор ключей-значений:
line - номер линии, с которой произошло переключение;
toline - номер линии, на которую произошло переключение;
number - номер абонента на занятой линии;
isincoming -  входящий или исходящий вызов (true – входящий, false – исходящий);
hold - состояние удержания вызова (true - на удержании, false - нет).

Примеры:
type=event;name=onactivelinechange;fromline=1;toline=2;
Произошло переключение с линии 1 на линию 2, при этом линия 2 не занята.

type=event;name=onactivelinechange;fromline=2;toline=1;number=sip:9229876543@192.168.1.1:5060;isincoming=true;hold=false
Произошло переключение с линии 2 на линию 1, занятую входящим вызовом от абонента 9229876543.
 

  • onbye - завершение входящего или исходящего вызова, неудачный набор номера

Версия 1.2.4
type=event;name=onbye;line=<Линия>;number=<Номер абонента>;isincoming=<true|false>;hold=
<true|false>; calltime=<Дата Время>;answertime=<Дата Время>;duration=<Длительность>

Версия 1.5.0
type=event;name=onbye;line=<Линия>;number=<Номер абонента>;isincoming=<true|false>;hold=
<true|false>; calltime=<Дата Время>;answertime=<Дата Время>;duration=<Длительность>;reason=<Код завершения>

Возникает в следующих случаях:
 - при завершении входящего или исходящего вызова;
 - при неудачном наборе номера.
Если вызов завершен по нашей инициативе, интерактивным завершением вызова на софтфоне или при помощи команды hangup, то данному событию предшествует событие onhangup.

Набор ключей-значений:
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming -  входящий или исходящий вызов (true – входящий, false – исходящий);
hold - состояние удержания вызова (true - на удержании, false - нет);
calltime - время начала вызова;
answertime - время ответа на вызов;
duration - длительность вызова в секундах;
reason - код завершения вызова, SIP ответ при завершении вызова (с версии 1.5.0), возможные значения:
- "" (пустое значение) - нет ответа с нашей стороны на входящий вызов или отбой с любой стороны входящего неотвеченного вызова;
- BYE - вызов завершен на другом конце линии (положили трубку);
- 200 - вызов завершен нами;
- 404 - неизвестный абонент;
- 486 - абонент занят.
В целом значения данного параметра требуют проверки путем тестирования на конкретных SIP серверах.
 

Пример:
type=event;name=onbye;line=2; number=sip:9229876543@192.168.1.1:5060;isincoming=false;hold=false;calltime=20.12.2014  20:49:22;answertime=20.12.2014  20:49:22;duration=7
Произошло завершение исходящего вызова на линии 2 с абонентом 9229876543.

  • oncall - осуществление набора номера

type=event;name=oncall;line=<Линия>;number=<Номер абонента>;isincoming=false;hold=false

Возникает в следующих случаях:
- при интерактивном посыле исходящего вызова;
- при отработке софтфоном команды call.
Если посыл вызова прошел успешно и начался дозвон абоненту, то софтфон инициирует событие onringback, в противном случае - событие onbye.

Набор ключей-значений:
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming - входящий или исходящий вызов (true – входящий, false – исходящий), в данном событии всегда false;
hold - состояние удержания вызова, в данном событии всегда false.

Пример:
type=event;name=oncall;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=false;hold=false
Произошел посыл исходящего вызова по линии 1 абоненту 9229876543.
 

  • onconnect - подключение native компонента к софтфону

type=event;name=onconnect

Возникает при вызове метода Подключить() / Connect()  native компонента и успешном подключении к софтфону. Если подключение к софтфону не произошло, то событие не возникает.
 

  • ondisconnect - отключение native компонента от софтфона

type=event;name=ondisconnect

Возникает при вызове метода Отключить() / Disconnect() native компонента и его отключении от софтфона..

 

  • ondtmf - получение DTMF сигнала

type=event;name=ondtmf;code=<DTMF сигнал>;method=<DTMF метод>;line=<Линия>;number=<Номер абонента>;isincoming=<true|false>;hold=false

Возникает при получении софтфоном DTMF сигнала как по активной, так и по неактивным линиям. Если вызов находится на удержании, то DTMF сигналы на софтфон не поступают.

Набор ключей-значений:
code – полученный сигнал DTMF;
method – метод, которым послан DTMF сигнал (0 - InBand, 1 - RFC2833, 2 - SIP Info);
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming -  входящий или исходящий вызов (true – входящий, false – исходящий);
hold - состояние удержания вызова, в данном событии всегда false.

Пример:
type=event;name=ondtmf;code=6;method=2;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=true;
Получен DTMF сигнал «6», посланный методом  SIP Info, по линии 1, занятой входящим вызовом от абонента 9229876543.
 

  • ongetparam - получен параметр софтфона (с версии 1.5.0)

type=event;name=ongetparam;paramname=<Параметр>;paramvalue=<Значение>;

Возникает при отработке софтфоном команды getparam.

Набор ключей-значений:
paramname - название параметра;
paramvalue - значение параметра.

Пример:
type=event;name=ongetparam;paramname=RecordDir;paramvalue=D:\Projects\SIPPhone
Получено значение "D:\Projects\SIPPhone" параметра RecordDir (Каталог записи вызовов) .

 

  • onhangup - завершение вызова софтфоном

type=event;name=onhangup;line=<Линия>;number=<Номер абонента>;isincoming=<true|false>;hold=<true|false>

Возникает в следующих случаях:
- при интерактивном отбое вызова на софтфоне;
- при отработке софтфоном команды hangup.
После непосредственного завершения вызова софтфон инициирует событие onbye.

Набор ключей-значений:
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming - входящий или исходящий вызов (true – входящий, false – исходящий);
hold - состояние удержания вызова (true - на удержании, false - нет).

Пример:
type=event;name=onhungup;line=2;number=sip:9229876543@192.168.1.1:5060;isincoming=true;hold=false
Был произведен отбой входящего вызова с абонентом 9229876543 по линии 2.

 

  • onhold - постановка вызова на удержание

type=event;name=onhold;line=<Линия>;number=<Номер абонента>;isincoming=<true|false>;hold=true;

Возникает в следующих случаях:
- при интерактивной постановке вызова на удержание в софтфоне;
- при отработке софтфоном команды hold.
После события onhold всегда следует событие oninviteok, в котором ключ hold равен true.

Набор ключей-значений:
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming - входящий или исходящий вызов (true – входящий, false – исходящий);
hold - состояние удержания вызова, в данном событии всегда true.

Пример:
type=event;name=onhold;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=true;hold=true
type=event;name=oninviteok;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=true;hold=true
Входящий вызова от абонента 9229876543 по линии 1 поставлен на удержание.

 

  • oninvite - поступление входящего вызова

type=event;name=oninvite;line=<Линия>;number=<Входящий номер>;isincoming=true;hold=false

Возникает при поступлении входящего вызова.

Набор ключей-значений:
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming - входящий или исходящий вызов (true – входящий, false – исходящий), в данном событии всегда true;
hold - состояние удержания вызова, в данном событии всегда false.

Варианты обработки события командами:
answer - ответить на вызов;
hangup - завершить вызов;
transfercall - переадресовать вызов.
Перед отправкой команды необходимо переключиться на линию, на которой произошло событие.

Пример:
type=event;name=oninvite;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=true;hold=false
Поступил входящий вызов по линии 1 от абонента 9229876543.
 

  • oninviteok - ответ на входящий или исходящий вызов

type=event;name=oninviteok;line=<Линия>;number=<Номер абонента>;isincoming=<true|false>;hold=<true|false>;

Возникает в следующих случаях:
- при интерактивном ответе на входящий вызов;
- при отработке софтфоном команды answer при входящем вызове;
- при ответе на исходящий вызов;
- при постановке вызова на удержание, сразу после события onhold;
- при снятии вызова с удержания, сразу после события onunhold.
При входящем вызове, данному событию всегда предшествует событие oninvite, при исходящем – событие onringback.

Набор ключей-значений:
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming - входящий или исходящий вызов (true – входящий, false – исходящий);
hold - состояние удержания вызова (true - на удержании, false - нет).

Пример:
type=event;name=oninviteok;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=true;hold=false
Произошел ответ на входящий вызов от абонента 9229876543 по линии 1.
 

  • onmicmute - отключение микрофона

type=event;name=onmicmute

Возникает в следующих случаях:
- при интерактивном отключении микрофона в софтфоне;
- при отработке софтфоном команды micmute.
 

  • onmicunmute - включение микрофона

type=event;name=onmicunmute

Возникает в следующих случаях:
- при интерактивном включении микрофона в софтфоне;
- при отработке софтфоном команды micunmute.
 

  • onreceivemsg - получено текстовое сообщение

type=event;name=onreceivemsg;number=<Номер абонента>;msg=<Текст сообщения>;

Возникает в следующих случаях:
  - при получении текстового сообщения.

Набор ключей-значений:
number – номер абонента, от которого отправлено сообщение;
msg - текст сообщения.

Пример:
type=event;name=onreceivemsg;number=23;msg=Салам!
Получено сообщение "Салам!" от абонента с номером 23.

 

  • onregistrationinfo - запрос регистрационных данных активного аккаунта софтфона

type=event;name=onregistrationok;server=<Сервер>;user=<Логин>;password=<Пароль>;proxy=<Proxy>; stun=<STUN>; state=<Состояние аккаунта>

Возникает в следующих случаях:
- при выполнении метода ВК Подключить() / Connect();
- при отработке софтфоном команды registerinfo.

Набор ключей-значений:
server - адрес SIP сервера - сервер[:порт] и т.д. по смыслу;
state - текущее состояние аккаунта (AutConnecting, AutDisconnecting, Connected, Connecting, Disconnected, Disconnecting, StunRequest).
 

  • onregistrationok - осуществление регистрации на сервере

type=event;name=onregistrationok;server=<Сервер>;user=<Логин>;password=<Пароль>;proxy=<Proxy>; stun=<STUN>
 

  • onregistrationbye - разрегистрация на сервере

type=event;name=onregistrationbye;server=<Сервер>;user=<Логин>;password=<Пароль>;proxy=<Proxy>; stun=<STUN>
 

  • onringback - осуществление исходящего вызова

type=event;name=onringback;line=<Линия>;number=<Номер абонента>;isincoming=false;

Возникает при начале дозвона до абонента.
Данному событию всегда предшествует событие oncall.

Набор ключей-значений:
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming - входящий или исходящий вызов (true – входящий, false – исходящий), в данном событии всегда false.

Пример:
type=event;name=onringback;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=false;
Начался дозвон до абонента 9229876543 по линии 1.
 

  • onsenddtmf - отправка DTMF сигнала

type=event;name=onsenddtmf;method=<DTMF метод>;code=<DTMF сигнал>;line=<Линия>;number=<Номер абонента>;isincoming=<true|false>;

Возникает в следующих случаях:
  - при интерактивной отсылке софтфоном DTMF сигнала;
  - при отработке софтфоном команды senddtmf.
Если вызов находится на удержании, то DTMF сигналы по линии не посылаются.

Набор ключей-значений:
code – отосланный DTMF сигнал;
method – метод, которым отослан DTMF сигнал (0 - InBand, 1 - RFC2833, 2 - SIP Info);
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming - входящий или исходящий вызов (true – входящий, false – исходящий).

Пример:
type=event;name=onsenddtmf;code=9;method=0; line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=true
Софтфоном, по линии 1, занятой входящим вызовом от абонента 9229876543, отослан DTMF сигнал «9» методом InBand.

 

  • onsendmsg - отправка текстового сообщения

type=event;name=onsendmsg;number=<Номер абонента>;msg=<Текст сообщения>;

Возникает в следующих случаях:
  - при интерактивной отправке софтфоном текстового сообщения;
  - при отработке софтфоном команды sendmsg.

Набор ключей-значений:
number – номер абонента, которому отправлено сообщение;
msg - текст сообщения.

Пример:
type=event;name=onsendmsg;number=23;msg=Привет!
Отправлено сообщение "Привет!" на номер 21.

 

  • onsilence - наступление тишины в линии

type=event;name=onsilence;line=<Линия>;number=<Номер абонента>;isincoming=<true|false>;hold=false;

Возникает в случае детектирования тишины в линии.
Регулируется параметрами SilenceThreshold и SilenceTimeout в HKEY_CURRENT_USER\Software\if56\SipPhone\1.0\SIPClient.
C версии 1.5.0  регулируется параметрами SilenceThreshold и SilenceTimeout в настройках софтфона. Тишина не детектируется в линии поставленной на удержание.

Набор ключей-значений:
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming - входящий или исходящий вызов (true – входящий, false – исходящий);
hold - состояние удержания вызова, в данном событии всегда false.

Пример:
type=event;name=onsilence;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=true;hold=false
Детектирована тишина в линии 1.

 

  • onsilenceend - окончание тишины в линии (с версии 1.5.0)

type=event;name=onsilenceend;line=<Линия>;number=<Номер абонента>;isincoming=<true|false>;hold=false;

Возникает в случае детектирования окончания тишины в линии. C версии 1.5.0 регулируется параметрами SilenceThreshold и SilenceTimeout в настройках софтфона. Окончание тишины не детектируется в линии поставленной на удержание.

Набор ключей-значений:
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming - входящий или исходящий вызов (true – входящий, false – исходящий);
hold - состояние удержания вызова, в данном событии всегда false.

Пример:
type=event;name=onsilenceend;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=true;hold=false
Детектировано окончание тишины в линии 1.

 

  • onstartrecord - начало записи вызова (с версии 1.5.0)

type=event;name=onstartrecord;line=<Линия>;number=<Номер абонента>;isincoming=<true|false>; hold=<true|false>;

Возникает в следующих случаях:
- при интерактивном включении записи вызова на форме софтфона;
- при начале записи вызова, если включена настройка "Автозапись вызовов";
- при отработке софтфоном команды startrecord.

Набор ключей-значений:
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming - входящий или исходящий вызов (true – входящий, false – исходящий);
hold - состояние удержания вызова (true - на удержании, false - нет).

Пример:
type=event;name=onstartrecord;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=true;hold=false
Начата запись вызова по линии 1.

 

  • onstoprecord - окончание записи вызова (с версии 1.5.0)

type=event;name=onstoprecord;line=<Линия>;number=<Номер абонента>;isincoming=<true|false>; hold=<true|false>;recordfile=<Файл>
 

Возникает в следующих случаях:
- при интерактивном выключении записи вызова на форме софтфона;
- при завершении вызова, если вызов записывался;
- при отработке софтфоном команды stoprecord.

Набор ключей-значений:
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming - входящий или исходящий вызов (true – входящий, false – исходящий);
hold - состояние удержания вызова (true - на удержании, false - нет);
recordfile - полный путь к файлу записи.

Пример:
type=event;name=onstoprecord;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=true;hold=false; recordfile=D:\Projects\SIPPhone\9229876543_11_20150310_153746.wav
Закончена запись вызова по линии 1 в файл D:\Projects\SIPPhone\9229876543_11_20150310_153746.wav.

 

  • ontransfercall - переадресация вызова

type=event;name=ontransfercall;tonumber=<Номер переадресации>;line=<Линия>;number=<Номер абонента>; isincoming=<true|false>;

Возникает в следующих случаях:
- при интерактивном трансфере вызова;
- при отработке софтфоном команды transfercall.

Набор ключей-значений:
tonumber – номер, на который осуществлен перевод вызова;
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming - входящий или исходящий вызов (true – входящий, false – исходящий).

Пример:
ttype=event;name=ontransfercall;tonumber=25;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=false;
По линии 1, на номер 25, осуществлен трансфер исходящего вызова абоненту 9229876543.

 

  • onunhold - снятие вызова с удержания

type=event;name=onunhold;line=<Линия>;number=<Номер абонента>;isincoming=<true|false>; hold=false

Возникает в следующих случаях:
- при интерактивном снятии вызова с удержания в софтфоне;
- при отработке софтфоном команды unhold.
После события onunhold всегда следует событие oninviteok, в котором ключ hold равен false.

Набор ключей-значений:
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming - входящий или исходящий вызов (true – входящий, false – исходящий);
hold - состояние удержания вызова, в данном событии всегда false.

Пример:
type=event;name=onunhold;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=true;hold=false
type=event;name=oninviteok;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=true;hold=false
Входящий вызова от абонента 9229876543 по линии 1 снят с удержания.

 

  • onwavstarted - начало воспроизведения звукового файла в линию (с версии 1.5.0)

type=event;name=onwavstarted;line=<Линия>;number=<Номер абонента>;isincoming=<true|false>; hold=<true|false>;

Возникает в следующих случаях:
  - при начале проигрывания файла автоприветствия на входящий вызов;
  - при отработке софтфоном команды playwavfile.

Набор ключей-значений:
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming - входящий или исходящий вызов (true – входящий, false – исходящий);
hold - состояние удержания вызова (true - на удержании, false - нет).

Пример:
type=event;name=onwavstarted;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=true;hold=false
Начато воспроизведение звукового файла в линию 1.

 

  • onwavstopped - окончание воспроизведения звукового файла в линию (с версии 1.5.0)

type=event;name=onwavstopped;line=<Линия>;number=<Номер абонента>;isincoming=<true|false>; hold=<true|false>;

Возникает в следующих случаях:
  - при окончании проигрывания файла автоприветствия на входящий вызов;
  - при окончании проигрывания файла заданного софтфону командой playwavfile.

Набор ключей-значений:
line - номер линии, на которой произошло событие;
number - номер абонента на линии;
isincoming - входящий или исходящий вызов (true – входящий, false – исходящий);
hold - состояние удержания вызова (true - на удержании, false - нет).

Пример:
type=event;name=onwavstopped;line=1;number=sip:9229876543@192.168.1.1:5060;isincoming=true;hold=false
Закончено воспроизведение звукового файла в линию 1.

 

  • onerror - при ошибке выполнения команды, в настоящий момент на стадии разработки
  • onlog - техническая информация для отладки, в релизе не используется

 

Команды type=command, значения ключа name

  • activeline - переключение активной линии

type=command;name=activeline;toline=<Номер линии>;

где <Номер линии> - номер линии, на которую необходимо переключиться, возможные значения от 0 до 6, другие значения игнорируются
передача ключа <toline> со значением 0 предназначено для определения номера активной линии, вызывает возврат события onactivelinechange в котором значения ключей line и toline равны номеру активной линии

  • answer - ответ на входящий вызов на активной линии

type=command;name=answer;

  • call - вызов абонента по активной линии

type=command;name=call;number=<Вызываемый номер>;

  • hangup - положить трубку на активной линии

type=command;name=hangup;

  • transfercall - безконсультативная переадресация вызова на активной линии

type=command;name=transfercall;tonumber=<Вызываемый номер>;

  • senddtmf- отправка DTMF сигнала

type=command;name=senddtmf;line=<Номер линии>;code=<DTMF cигнал>;

где <Номер линии> - номер линиии, по которой необходимо передать сигнал, необязательный ключ, если не указан или значение ключа не лежит в диапазоне от 1 до 6, то сигнал передается по активной линии
<DTMF cигнал> - сигнал для передачи, может принимать значения от 0 до 9, *, #

  • sendmsg- отправка текстового сообщения

type=command;name=sendmsg;number=<Номер абонента>;msg=<Текст сообщения>;

где <Номер абонента> - номер абонента, которому необходимо отправить сообщение
<Текст сообщения> - текст сообщения

  • hold - удержание вызова на активной линии

type=command;name=hold;

  • unhold - отмена удержания вызова на активной линии

type=command;name=unhold;

  • playwavfile - воспроизвести wav файл в линию (с версии 1.5.0)
    Внимание! Поддерживаются только wav файлы формата 8000Гц моно.

type=command;name=playwavfile;line=<Номер линии>;file=<Файл>;

Набор ключей-значений:
line - номер линии по которой необходимо воспроизвести файл;
file - путь к файлу.

  • conference - включение режима конференции по всем линиям с активными соединениями

type=command;name=conference;

  • unconference - отключение режима конференции

type=command;name=unconference;

  • micmute - отключение микрофона

type=command;name=micmute;

  • micunmute - включение микрофона

type=command;name=micunmute;

  • startrecord - включение записи разговора на активной линии

type=command;name=startrecord;

  • stoprecord - выключение записи разговора на активной линии

type=command;name=stoprecord;

  • register - зарегистрироваться на сервере

type=command;name=register;server =<Сервер>;user =<Логин>;password=<Пароль>;stun=<STUN>;proxy=<Proxy>;

где <Сервер> - адрес SIP сервера - сервер[:порт] и т.д. по смыслу
обязательным является передача ключей user, server, password

  • registerinfo - получить регистрационные данные активного аккаунта

type=command;name=registerinfo;

  • unregister - разрегистрироваться на сервере

type=command;name=unregister;

  • getparam - получить настройку/параметр софтфона (с версии 1.5.0)

type=command;name=getparam;paramname=<Параметр>;

Набор ключей-значений:
paramname - имя параметра.
Имена параметров приведены в описании команды setparam.

  • setparam - установить настройку/параметр софтфона (с версии 1.5.0)

type=command;name=setparam;paramname=<Параметр>;paramvalue=<Значение>;

Набор ключей-значений:
paramname - имя параметра;
paramvalue - значение параметра.
 

Настройки окна софтфона

Параметр \ настройка Имя Тип Значение  по умолчанию
Запускать при старте Windows RunOnWindowsStart Булево false
Сворачивать при запуске RunMinimize Булево false
Показывать в панели задач ShowInTaskBar Булево false
Запретить выгружать DisableUnload Булево false
Показывать при входящем вызове ShowOnCall Булево false
Количество линий LinesCount Число 6

 

Настройки аудио

Параметр \ настройка Имя Тип Значение  по умолчанию
Микрофон AudioInDevice Строка Default
Динамик AudioOutDevice Строка Default
Звонок AudioRingDevice Строка Default
Звонок в системный бипер(не работает на x64) RingOnBeeper Булево false
Каталог записи вызовов RecordDir Строка пустая строка
Автозапись вызовов RecordAutostart Булево  
Номера, исключаемые из автозаписи RecordExcluded Строка - регулярное выражение

(^)(.{1,20})($)
(все номера длиной от 1 до 20 символов)

Воспроизводить файл приветствия при входящем вызове PlayGreeting Булево false
Файл приветствия PlayGreetingFile Строка пустая строка
(поддерживаются только файлы формата 8000Гц моно)
Номера, исключаемые из воспроизведения приветствия PlayGreetingExcluded Строка - регулярное выражение

((^)(.{2,4})($))|(9051234567)(номера от 2 до 4 символов и номер 9051234567)

       

 

Системные настройки

Параметр \ настройка Имя Тип Значение  по умолчанию
Разрешить внешнее подключение UseExternal Булево true
Номер порта для внешнего подключения ExternalPort Число 2555
Локальный порт SIP клиента LocalPort Число 0 (если 0, то выбирается системой)
Минимальный номер RTP порта RtpPortMin Число 22000
Максимальный номер RTP порта RtpPortMax Число 24000
Порог тишины в линии SilenceThreshold Число 500
Таймаут детектирования тишины в линии SilenceTimeout Число 5000
Метод передачи DTMF сигнала DTMFMethod Число 1
Локальный IP (для multihomed компьютеров) DefaultLocalIP Строка пустая строка
SIP аккаунт по умолчанию DefaultAccount Строка  

 

Примеры:


type=command;name=activeline;toline=3 — переключит активную линию на третью линию
type=command;name=call;number=22@192.168.1.1:5060 — произведет вызов абонента 22@192.168.1.1:5060
по активной линии