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

Протестировать методы API можно на странице интерактивного обозревателя API и без написания кода
Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см. Создание и авторизация приложений)

При обновлении параметров телефонного терминала, находящегося в https://ringme-confluence.atlassian.net/wiki/spaces/Ringme/pages/2861301761 , синхронизирующиеся параметры (Список синхронизирующихся параметров) также обновятся и на остальных телефонных терминалах в “bundle“

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

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

Имя

Тип

Обязательное

Значение по умолчанию

Описание

Имя

Тип

Обязательное

Значение по умолчанию

Описание

label

string

нет

 

Отображение имени внутреннего номера. Отображается на вызываемом терминале при исходящих вызовах (если поддерживается)

announce_sound_upon_outgoing_call

long

нет

 

Идентификатор звукового файла, который проиграется при исходящем вызове в качестве объявления информации

announce_sound_upon_incoming_call

long

нет

 

Идентификатор звукового файла, который проиграется при ответе на входящий вызов в качестве объявления информации. Файл будет проигран в том числе при ответе через очередь

append_to_cid_name_on_transfer

string

нет

 

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

auth_type

string

нет

"digest"

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

  • digest - по паролю

  • network - только из заранее определенный сетей

  • both - по паролю из заранее определенный сетей

call_screening_enabled

boolean

нет

false

Управление механизмом подтверждения входящего вызова. Если параметр установлен в true, то во время вызова на внутренний номер при снятии трубки абонент услышит информацию о номере звонящего и о внешнем номере, на который был осуществлён вызов. Для ответа на вызов в данном случае следует нажать цифру 1, для отмены вызова следует повесить трубку

conference_announce_caller_name

boolean

нет

true

Локальная конференция внутреннего номера *8<внутренний_номер>. Параметр указывает, передавать ли в локальную конференцию имя пользователя присоединяющегося к ней внутреннего номера. Для приглашенных анонс не работает

conference_end_on_exit

boolean

нет

true

Локальная конференция внутреннего номера *8<внутренний_номер>. Параметр указывает, заканчивается ли конференция при выходе из нее внутреннего номера - создателя конференции

conference_pin

string

нет

 

Локальная конференция внутреннего номера *8<внутренний_номер>. Пин-код для входа в конференцию других внутренних номеров

external_number

string

нет

 

Если данный параметр определен, то SIP-сервер отправляет туда вызов. Этим номером может быть, например, мобильный. Вызов обрабатывается так же, как если бы он пришел непосредственно на терминал ( работают все правила переадресаций, записей разговоров, разрешение переводом и т.п.)

geo_list

string

нет

 

Задает список стран, с IP-адресов которых разрешено использование SIP-аккаунта. Страны перечисляются в формате  ISO 3166 Codes A2, например "RU US BY". Если список не задан, то используется одноименный параметр ресурса “Клиент (/client/)”. Если список имеет значение "*", то все страны разрешены и клиентский параметр игнорируется

hangup_timeout

long

нет

60

Максимальное время ожидания ответа внутреннего номера при входящем вызове в секундах. По истечении этого времени звонок считается не отвеченным и могут включиться правила входящего вызова (если есть) либо произойти отбой

hold_music

long

нет

0

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

ignore_early_media

boolean

нет

true

Если данный параметр установлен в true, то при вызове внутреннего номера будет игнорироваться раннее медиа, например, автоответчики. Может быть полезно в случае регистрации внешнего номера или применения FMC

incoming_limit

long

нет

0

Устанавливает, сколько вызовов внутренний номер может принимать одновременно: "0" - без ограничений, "1" - не более одного (аналог выключения "call waiting"), "2" - не более двух и т.д.

network_permission_group_id

long

нет

0

Задает идентификатор доверенных сетей клиента для авторизации на sip-сервере при 'auth_type':'network' или 'auth_type':'both'

preserve_caller_id_number_att_tr

boolean

нет

true

Параметр, указывающий, передавать ли получателю вызова номер звонящего при переводе вызова командой *2 (перевод с сопровождением). По умолчанию при переводе вызова *2 номер звонящего помещается в имя звонящего, а в номере звонящего отражен внутренний номер, с которого производится перевод вызова

record_enabled

boolean

нет

true

Параметр, указывающий, включать ли запись звонков в файл. Сохраненные файлы доступны через ресурс “Записи разговоров”, дисковая квота — через свойства клиента, занятое место на диске — через ресурс “Дисковое пространство

record_format

string

нет

None

Формат файлов записи разговора. Возможны варианты: ‘mp3’, ‘wav’, None. В случае отсутствия указания формата записи будет использована настройка, указанная в клиентской конфигурации (ресурс “Клиент (/client/)”). От формата записи зависит размер файлов записи. Полная спецификация приведена в конце данной страницы

record_stereo

boolean

нет

None

Параметр, указывающий, осуществлять ли запись разговора в стерео- или моно-формате. Возможны варианты: 'yes', 'no', None. В случае отсутствия указания данного параметра будет использована настройка, указанная в клиентской конфигурации (ресурс “Клиент (/client/)”). От типа записи зависит размер файлов записи. Полная спецификация приведена в конце данной страницы

record_transfer

boolean

нет

true

Параметр, указывающий, осуществлять ли запись разговора при переводе вызова (если после перевода вызов попадает на другой внутренний номер с записью, запись на переводящем внутреннем номере останавливается). Работает только при активной функции record_enabled

record_on_transfer

boolean

нет

false

По умолчанию осуществляется запись разговора внутреннего номера. В случае, если активирована функция record_on_transfer, записывается противоположная от внутреннего номера сторона разговора.
При неактивной функции record_on_transfer запись остановится тогда, когда внутренний номер положит трубку, а с активной функцией record_on_transfer – только тогда, когда противоположная сторона разговора положит трубку

ringback_sound

long

нет

0

Мелодия, проигрываемая вместо гудков (183 progress, по умолчанию – 180 Ringing (гудки))

static_reg_address

string

нет

 

Если терминал по какой-либо причине не может регистрироваться на сервере, то регистрацию можно указать в явном виде, и все вызовы будут направлены на этот адрес. При этом терминал может продолжать регистрироваться на сервере, но вызовы все равно будут уходить согласно static_reg_address. Указывается в виде адрес:порт (например: 8.8.8.8:5068)

transfer_caller_id_number

string

нет

 

Фиксированный номер вызывающего абонента, который всегда отображается при переадресации вызова внутри АТС (может быть изменен провайдером телефонии при дальнейшей переадресации вызова)

vm_attach_file

boolean

нет

true

Параметр указывает, прикреплять ли файл с голосовым сообщением при отправке уведомления о получении. Актуально для vm_enabled

vm_enabled

boolean

нет

true

Параметр активирует голосовую почту

vm_greeting

long

нет

0

Идентификатор звукового файла, звучащего в качестве приветствия голосовой почты. Актуально для vm_enabled

vm_mailto

string

нет

 

Адрес e-mail для получения оповещений о новом голосовом сообщение (возможны несколько адресов через запятую). Актуально для vm_enabled

intercom

long

нет

None

Автоответ, при указании 0 - автоответ сразу, 1 или более- ответ через указанное время в сек.

Для отключения нужно указать None

bundle

Object

нет

{
"bundle_list": null, "bundle_id": null
}

Структура bundle.
Содержит в себе:
1. bundle_list
bundle_list это тип данных Object, куда записываются дополнительные добавочные из bundle. Пример:
{ "124": { "active": false}, "29196": { "active": true}}

"124" - id дополнительного добавочного

”active” - тип данных bool, показывает активен ли дополнительный добавочный в bundle или нет

2. bundle_id

id главного добавочного в bundle (int)

Чтобы задать bundle, необходимо указать "bundle_list" на главном добавочном. "bundle_id" - поле только для чтения

replace_pin

string

нет

None

Секретный код для функционала подмены добавочных. Необходимо вводить после соответствующей команды на телефонном терминале.

call_status_id

int

нет

None

Статус добавочного из ресурса Статусы добавочного

call_status_set_dt

string

нет

None

Время последней установки статуса Статусы добавочного

transfer_after_call_end_to

string

нет

None

номер, куда будет переведен вызов по окончанию разговора:

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

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

Пример

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

{ "auth_type": "digest", "hold_music": null, "preserve_caller_id_number_att_tr": false, "conference_pin": null, "conference_end_on_exit": true, "network_permission_group_id": 1, "append_to_cid_name_on_transfer": null, "record_stereo": false, "incoming_limit": 1, "vm_mailto": null, "vm_enabled": false, "hangup_timeout": 5, "record_enabled": true, "vm_attach_file": true, "conference_announce_caller_name": true, "announce_sound_upon_outgoing_call": null, "vm_greeting": null, "ignore_early_media": false, "static_reg_address": null, "geo_list": "RU", "call_screening_enabled": true, "ringback_sound": null, "record_format": "mp3", "transfer_caller_id_number": null, "record_transfer": true, "external_number": "+79876543210" "bundle": { "bundle_list": { "124": { "active": false }, "29196": { "active": true } }, "bundle_id": 3 }, "call_status_id": null, "call_status_set_dt": null, "transfer_after_call_end_to": null }

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

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

Ресурсы раздела “Внутренний номер”

GET /extension/{extension_id}/phone/

Получить свойства телефонного терминала

Параметры URL

Имя

Тип

Описание

Имя

Тип

Описание

extension_id

integer

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

PUT /extension/{extension_id}/phone/

Изменить свойства телефонного терминала

Параметры URL

Имя

Тип

Описание

Имя

Тип

Описание

extension_id

integer

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

Параметры JSON

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