Инструменты пользователя

Инструменты сайта


sip1c:api

Список методов и свойст компоненты SIP

Описанные ниже функции и свойства доступны начиная с версии 2.0.18.4

Описание свойств компоненты, установка свойств имеет смысл до вызова метода Init компоненты.

СвойствоТипОписание
IsConnectedБулевоВ переменную помещается текущее состояние соединения с АТС
usesG711OnlyБулевоОграничить список используемых кодеков кодеками серии G711 (ALAW, ULAW)
detectsVoiceActivityБулевоВключить детектирование тишины
AllowStopStartMusicБулевоРазрешить управление громкостью других устройств, например музыкального плеера, при обработке звонка
ReregistrationTimeЧислоПериод перерегистрации компонента на сервере АТС, по умолчанию 300
useICEБулевоВключить ICE
useDNSSRVБулевоВключить DNSSRV
STUNserverСтрокаАдрес STUN сервера
SIPProxyСтрокаАдрес SIPProxy сервера
OutboundProxyСтрокаАдрес OutboundProxy сервера
isMicrophoneMutedБулево Возвращает текущее состояние микрофона
HaspLicenseServerСтрокаАдрес HASP сервера лицензий, если нужно указать определенный, вместо автоматического поиска
MikoLicenseСтрокаСвойство для установки ключа SAAS лицензирования (MIKO-XXXX-XXXX-XXXX-XXXX)
LicenseModeСтрокаCвойство в котором компонент сообщает о текущем режиме лицензирования SAAS,HASP, NoLicesnse
RingtonPathСтрокаПуть к WAV файлу для переопределения мелодии по умолчанию для звонка
TransportСтрокаПринимает значение TCP или UDP для указания типа транспортного протокола. По умолчанию пустая строка, что соответствует автоматическому выбору протокола софтфоном.

Ниже перечислены доступные функции компоненты.

ФункцияВозвратОписание
Init() - Инициализация SIP протокола
Version() Строка Возвращает версию компоненты, можно вызывать до Init
Close() - Деинициализация SIP протокола
Connect(Строка Логин, Строка Пароль, Строка SIPДомен:SIPПорт) - Подключение к SIP серверу
Disconnect() - Отключение от SIP сервера
Dial(Строка Номер) - Набрать номер
Hold(Строка ID_Звонка) - Поставить вызов на удержание
Resume(Строка ID_Звонка) - Вернуть вызов с удержания
Answer(Строка ID_Звонка) - Ответить на вызов
Hangup(Строка ID_Звонка) - Отбить вызов
Input(Строка ID_Звонка, Строка Номер) - Отправить DTMF сигнал
Transfer(Строка ID_Звонка, Строка Номер) - Безусловный перевод вызова
AttendedTransfer(Строка ID_Звонка1, Строка ID_Звонка2) - Соединение двух вызов с отбоем текущего (консультативный перевод)
ListSoundDevices() Строка Получить XML структуру с списком аудио устройств, для дальнейшей установки в SetSoundDevices
SetSoundDevices(Строка НазваниеМикрофон, Строка НазваниеСпикер, Строка НазваниеРингтонСпикер) - Установить используемые аудио устройства
SetOnlineStatus(Строка ТекущийСтатус) - Установить онлайн статус для текущего SIP аккаунта
PresenceSubsribe(Строка НомераПировЧерезЗапятую) - Подписаться на оповещения о состоянии SIP пиров
MuteMicrophone(Строка ID_Звонка) - Отключить микрофон
UnmuteMicrophone(Строка ID_Звонка) - Включить микрофон
StartRecordingCalltoWav(Строка ID_Звонка, Строка ПутьСИменемWavФайла) - Начать запись разговора в Wav файл
StopRecordingCalltoWav(Строка ID_Звонка) - Остановить запись разговора в Wav файл
CallRecordingStatus(Строка ID_Звонка) - Получить состояние записи разговора для указанной линии
PlayWavToCall(Строка ID_Звонка, Строка ПутьСИменемWavФайла) - Воспроизвести запись в разговор
GetLicenseInfo() Строка Получить инфорамацию доступной лицензии
AdjustInputVolume(Строка Уровень) - Изменить громкость микрофона уровень - от 0 до 200
AdjustOutputVolume(Строка Уровень) - Изменить громкость динамика уровень - от 0 до 200
AdjustSpeakerVolume(Строка Уровень) - Изменить громкость динамика уровень - от 0 до 200
sip1c/api.txt · Последние изменения: 2016/07/06 17:38 — mcvet