Здесь показаны различия между двумя версиями данной страницы.
Следующая версия | Предыдущая версия | ||
sip1c:api [2013/12/17 12:22] nb создано |
sip1c:api [2018/10/02 06:40] (текущий) apor |
||
---|---|---|---|
Строка 1: | Строка 1: | ||
====== Список методов и свойст компоненты SIP ====== | ====== Список методов и свойст компоненты SIP ====== | ||
+ | |||
+ | <note tip>Описанные ниже функции и свойства доступны начиная с версии 2.0.18.4</note> | ||
+ | |||
+ | Описание свойств компоненты, установка свойств имеет смысл до вызова метода Init компоненты. | ||
|**Свойство**|**Тип**|**Описание**| | |**Свойство**|**Тип**|**Описание**| | ||
|IsConnected|Булево|В переменную помещается текущее состояние соединения с АТС| | |IsConnected|Булево|В переменную помещается текущее состояние соединения с АТС| | ||
- | |usesG711Only|Булево|Ограничить список используемых кодеков кодеками серии G711 (ALAW, ULAW) | + | |usesG711Only|Булево|Ограничить список используемых кодеков кодеками серии G711 (ALAW, ULAW)| |
|detectsVoiceActivity|Булево|Включить детектирование тишины| | |detectsVoiceActivity|Булево|Включить детектирование тишины| | ||
- | |HaspLicenseServer|Строка|Адрес HASP сервера лицензий, если нужно указать определенный, вместо автоматического поиска | | ||
|AllowStopStartMusic|Булево|Разрешить управление громкостью других устройств, например музыкального плеера, при обработке звонка| | |AllowStopStartMusic|Булево|Разрешить управление громкостью других устройств, например музыкального плеера, при обработке звонка| | ||
- | |ReregistrationTime|Число|Период перерегистрации компонента на сервере АТС, по умолчанибю 300| | + | |ReregistrationTime|Число|Период перерегистрации компонента на сервере АТС, по умолчанию 300| |
|useICE|Булево|Включить ICE| | |useICE|Булево|Включить ICE| | ||
|useDNSSRV|Булево|Включить DNSSRV| | |useDNSSRV|Булево|Включить DNSSRV| | ||
|STUNserver|Строка|Адрес STUN сервера| | |STUNserver|Строка|Адрес STUN сервера| | ||
- | |STUNPort|Число|Порт STUN сервера| | ||
|SIPProxy|Строка|Адрес SIPProxy сервера| | |SIPProxy|Строка|Адрес SIPProxy сервера| | ||
- | |SIPProxyPort|Число|Порт SIPProxy сервера| | ||
|OutboundProxy|Строка|Адрес OutboundProxy сервера| | |OutboundProxy|Строка|Адрес OutboundProxy сервера| | ||
- | |OutboundProxyPort|Число|Порт OutboundProxy сервера| | ||
|isMicrophoneMuted|Булево| Возвращает текущее состояние микрофона| | |isMicrophoneMuted|Булево| Возвращает текущее состояние микрофона| | ||
+ | |HaspLicenseServer|Строка|Адрес HASP сервера лицензий, если нужно указать определенный, вместо автоматического поиска | | ||
+ | |MikoLicense|Строка|Свойство для установки ключа SAAS лицензирования (MIKO-XXXX-XXXX-XXXX-XXXX)| | ||
+ | |LicenseMode|Строка|Cвойство в котором компонент сообщает о текущем режиме лицензирования SAAS,HASP, NoLicesnse| | ||
+ | |RingtonPath|Строка|Путь к WAV файлу для переопределения мелодии по умолчанию для звонка| | ||
+ | |Transport|Строка|Принимает значение TCP или UDP для указания типа транспортного протокола. По умолчанию пустая строка, что соответствует автоматическому выбору протокола софтфоном.| | ||
+ | Ниже перечислены доступные функции компоненты. | ||
- | |**Функция**|**Описание**| | + | |**Функция**|**Возврат**|**Описание**| |
- | |Init|| | + | |Init()| - |Инициализация SIP протокола| |
- | |Version|| | + | |Version()| Строка |Возвращает версию компоненты, можно вызывать до Init| |
- | |Close|| | + | |Close()| - |Деинициализация SIP протокола| |
- | |Connect|| | + | |Connect(Строка Логин, Строка Пароль, Строка SIPДомен:SIPПорт)| - |Подключение к SIP серверу| |
- | |Disconnect|| | + | |Disconnect()| - |Отключение от SIP сервера| |
- | |Dial|| | + | |Dial(Строка Номер)| - |Набрать номер| |
- | |Hold|| | + | |Hold(Строка ID_Звонка)| - |Поставить вызов на удержание| |
- | |Resume|| | + | |Resume(Строка ID_Звонка)| - |Вернуть вызов с удержания| |
- | |Answer|| | + | |Answer(Строка ID_Звонка)| - |Ответить на вызов| |
- | |Hangup|| | + | |Hangup(Строка ID_Звонка)| - |Отбить вызов| |
- | |Input|| | + | |Input(Строка ID_Звонка, Строка Номер)| - |Отправить DTMF сигнал| |
- | |Transfer|| | + | |Transfer(Строка ID_Звонка, Строка Номер)| - |Безусловный перевод вызова| |
- | |AttendedTransfer|| | + | |AttendedTransfer(Строка ID_Звонка1, Строка ID_Звонка2)| - |Соединение двух вызов с отбоем текущего (консультативный перевод)| |
- | |ListSoundDevices|| | + | |ListSoundDevices()| Строка |Получить XML структуру с списком аудио устройств, для дальнейшей установки в SetSoundDevices| |
- | |SetOnlineStatus|| | + | |SetSoundDevices(Строка НазваниеМикрофон, Строка НазваниеСпикер, Строка НазваниеРингтонСпикер)| - |Установить используемые аудио устройства| |
- | |SetSoundDevices|| | + | |SetOnlineStatus(Строка ТекущийСтатус)| - |Установить онлайн статус для текущего SIP аккаунта| |
- | |PresenceSubsribe|| | + | |PresenceSubsribe(Строка НомераПировЧерезЗапятую)| - |Подписаться на оповещения о состоянии SIP пиров| |
- | |MuteMicrophone|| | + | |MuteMicrophone(Строка ID_Звонка)| - |Отключить микрофон| |
- | |UnmuteMicrophone|| | + | |UnmuteMicrophone(Строка ID_Звонка)| - |Включить микрофон| |
- | |StartRecordingCalltoWav|| | + | |StartRecordingCalltoWav(Строка ID_Звонка, Строка ПутьСИменемWavФайла)| - |Начать запись разговора в Wav файл| |
- | |StopRecordingCalltoWav|| | + | |StopRecordingCalltoWav(Строка ID_Звонка)| - |Остановить запись разговора в Wav файл| |
- | |CallRecordingStatus|| | + | |CallRecordingStatus(Строка ID_Звонка)| - |Получить состояние записи разговора для указанной линии| |
- | |PlayWavToCall|| | + | |PlayWavToCall(Строка ID_Звонка, Строка ПутьСИменемWavФайла)| - |Воспроизвести запись в разговор| |
- | |GetHASPInfo|| | + | |GetLicenseInfo()| Строка |Получить инфорамацию доступной лицензии| |
- | |SendMetrika|| | + | |AdjustInputVolume(Строка Уровень)| - |Изменить громкость микрофона уровень - от 0 до 200| |
- | |SetMIKOLicenseMode|| | + | |AdjustOutputVolume(Строка Уровень)| - |Изменить громкость динамика уровень - от 0 до 200| |
+ | |AdjustSpeakerVolume(Строка Уровень)| - |Изменить громкость динамика уровень - от 0 до 200| |