Телефонный терминал (/phone/)

Owned by Dmitri Savolainen
Last updated: Aug 28, 2020 by Asia Khalitova (Unlicensed)
3 min read

Мы обновили документацию, актуальная версия страницы доступна по ссылке: Телефонный терминал (/phone/)

Предназначен для управлениями свойствами добавочного типа 'phone'

Ресурсы

РесурсМетодПараметры ПутиТело запросаОписание
extension/{extension_id}/phone/PUT

extension_id (integer) уникальный идентификатор добавочного, может принимать значение @me в случае пользователя типа "экстеншен"

обновленные поля Телефонный терминал (/phone/)#PhonePropertiesИзменить свойства телефонного терминала
extension/{extension_id}/phone/GETextension_id (integer) уникальный идентификатор добавочного, может принимать значение @me в случае пользователя типа "экстеншен"  
Получить свойства телефонного терминала


Описание структур данных

Свойства телефонного терминала (PhoneProperties)   

Имя
Тип
Обязательное

Значение По

Умолчанию

Описание

vm_enabled

boolean

нет

falseактивирует голосовую почту
hold_musicintegerнетnullидентификатор звукового файла, звучащий у другой стороны диалога, когда терминал переводит вызов в режим удержания. Если не указан, то будет звучать предустановленный системный файл

announce_sound_upon_outgoing_call

integerнетnullидентификатор звукового файла, который проиграется при исходящем вызове в качестве обьявления информации. 
record_enabledbooleanнетfalseвключить запись звонков в файл. Сохраненные файлы доступны через ресурс записей, дисковая квота через свойства клиента. Занятое место на диске через дисковое пространство
vm_greetingintegerнетnullактуально для vm_enabled. Идентификатор звукового файла, звучащего в качестве приветствия голосовой почты
vm_mailtostringнет""актуально для vm_enabled. Адрес e-mail для получения оповещений о новом голосовом сообщение (возможны несколько адресов через запятую)
vm_attach_filebooleanнетtrueактуально для vm_enabled. Прикреплять ли файл с голосовым сообщение при отправке уведомления о получении
hangup_timeoutintegerнет60максимально ожидание ответа добавочного при входящем вызове, указывается в секундах. По истечении этого времени звонок считается не отвеченным и могут включится правила входящего вызова ( если есть), либо произойти отбой.
auth_typestringнет"digest"

Тип аутентификации запросов добавочного на sip-сервере. Принимает одно из значений:

  • digest - по паролю
  • network - только из заранее определенный сетей
  • both - по паролю из заранее определенный сетей
passwordstringнет
задает пароль для авторизации на sip-сервере при 'auth_type':'digest' или 'auth_type':'both'
network_permission_group_idintegerнетnullзадает идентификатор доверенных сетей клиента для авторизации на sip-сервере при 'auth_type':'network' или 'auth_type':'both'
external_numberstringнетnullесли параметр определен, то sip-сервер отправляет туда вызов. Этим номером может быть, например, мобильный. Вызов обрабатывается так же, как если бы он пришел непосредственно на терминал ( работаю все правила переадресаций, записей разговоров, разрешение переводом и т.п.)
static_reg_addressstringнетnullесли терминал по какой-либо причине не может регистрироваться на сервере, то регистрацию можно указать в явном виде. Все вызовы будут направлены на этот адрес. При этом терминал может продолжать регистрироваться на сервере, но вызовы все равно будут уходить согласно static_reg_address. Указывается в виде адрес:порт (например 8.8.8.8:5068)
call_screening_enabledbooleanнетfalseуправление механизмом подтверждения входящего вызова. Если параметр установлен в true, то во время вызова на добавочный при снятии трубки абонент услышит информацию о номере звонящего и о внешнем номере, на который был осуществлён вызов. Для ответа на вызов в данном случае следует нажать цифру 1, для отмены вызова следует повесить трубку.
ignore_early_mediabooleanнетfalseесли данный параметр установлен в true, то при вызове добавочного будет игнорироваться раннее медиа, например, автоответчики. Может быть полезно в случае регистрации внешнего номера или применения FMC.

incoming_limit		integerнет0устанавлиевает, сколько добавочный может принимать вызовов одновременно. "0" - без ограничений, "1" - не более одного (аналог выключения "call waiting"), "2"  - не более двух и т.д.
allow_webrtcbooleanнетfalseЕсли установлено значение "true", то позволяет добавочному работать через WebRTC
geo_liststringнетnullЗадает список стран, с айпи адресов которых разрешено использование SIP аккаунта. Страны перечисляются в формате  ISO 3166 Codes A2, например "RU US BY". Если список не задан, то используется одноименный параметр ресурса клиент. Если список имеет значение "*", то все страны разрешены и клиентский параметр игнорируется .
append_to_cid_name_on_transferstringнетnull

# 

Добавление признака перевода к имени звонящему. Может быть полезно при "слепом переводе", чтобы понять, откуда был переведен вызов.

conference_announce_caller_namebooleanнетnullЛокальная конференция добавочного *8<номердобавочного>. Анонс имени пользователя добавочного, который зашел в локальную конференцию. Для приглашенных анонс не работает
conference_end_on_exitbooleanнетtrueЛокальная конференция добавочного *8<номердобавочного>. Конференция закончится, если пользователь добавочного-создателя конференции выйдет из конференции.
conference_pinstringнетnullЛокальная конференция добавочного *8<номердобавочного>. Пин-код для входа в конференцию других добавочных.
preserve_caller_id_number_att_trbooleanнетfalseСохранять номер звонящего при переводе командой *2 (перевод с сопровождением). По-умолчанию при переводе *2 номер звонящего помещается в имя звонящего, а в номере звонящего отражен добавочный, совершающий перевод.
record_formatstringнетNoneФормат записи разговора. Возможны варианты:

'mp3', 'wav', None

В случае отсутствия указания формата записи будет использована настройка, указанная в клиентской конфигурации Клиент(/client/).

От формата записи зависит объем записи, полная спецификация указана в конце данной статьи.

record_stereostringнетNoneЗапись в стерео или моно. Возможны варианты:

'yes', 'no', None

В случае отсутствия указания record_stereo будет использована настройка, указанная в клиентской конфигурации Клиент(/client/).

От типа записи зависит объем записи, полная спецификация указана в конце данной статьи.

record_transferbooleanнетfalseРаботает только при активной функции record_enabled. Запись в том числе переведенных вызовов (если после перевода вызов попадает на другой добавочный с записью - запись на переводящем добавочном останавливается) 
ringback_soundintegerнетnullМелодия вместо гудков - 183 progress, по умолчанию 180 Ringing (гудки)
transfer_caller_id_numberstringнетnullИзменение номера (from user number) при переводе

Примеры использования

Для добавочного с идентификатором 54 установим привязку внешнего мобильного номера +79876543210


метод
ресурс
данные
ответ
PUT
/extension/54/phone/

{
"external_number": "+79876543210"
}

{
"auth_type": "digest",
"hold_music": null,
"vm_attach_file": true,
"vm_enabled": false,
"vm_greeting": null,
"network_permission_group_id": 1,
"record_enabled": true,
"static_reg_params": null,
"external_number": "+79876543210",
"hangup_timeout": 5,
"vm_mailto": "",
"call_screening_enabled": false,
"ignore_early_media": false,
"allow_webrtc": false,
"geo_list": "RU"

}

Спецификация записи разговора

mp3_mono
Bit rate : 16.0 kb/s
Channel(s) : 1 channel
Sampling rate : 8 000 Hz

mp3_stereo
Bit rate : 32.0 kb/s
Channel(s) : 2 channels
Sampling rate : 8 000 Hz

wav_mono
Bit rate : 128 kb/s
Channel(s) : 1 channel
Sampling rate : 8 000 Hz

wav_stereo
Bit rate : 256 kb/s
Channel(s) : 2 channels
Sampling rate : 8 000 Hz

Похожие разделы