Протестировать методы API можно на странице интерактивного обозревателя и без написания кода
Некоторые ресурсы, описанные на странице, по-умолчанию могут быть не доступны из-за типа приложения. См. типы и уровни приложений
Предназначен для управлениями свойствами добавочного типа 'phone'
Ресурсы
| Ресурс | Метод | Параметры Пути | Тело запроса | Описание |
|---|---|---|---|---|
| extension/{extension_id}/phone/ | PUT | extension_id (integer) уникальный идентификатор добавочного, может принимать значение @me в случае пользователя типа "экстеншен" | обновленные поля Телефонный терминал (/phone/)#PhoneProperties | Изменить свойства телефонного терминала |
| extension/{extension_id}/phone/ | GET | extension_id (integer) уникальный идентификатор добавочного, может принимать значение @me в случае пользователя типа "экстеншен" | Получить свойства телефонного терминала |
Описание структур данных
Свойства телефонного терминала (PhoneProperties)
Имя | Тип | Обязательное | Значение По Умолчанию | Описание |
|---|---|---|---|---|
|
| нет | false | активирует голосовую почту |
hold_music | integer | нет | null | идентификатор звукового файла, звучащий у другой стороны диалога, когда терминал переводит вызов в режим удержания. Если не указан, то будет звучать предустановленный системный файл |
| integer | нет | null | идентификатор звукового файла, который проиграется при исходящем вызове в качестве обьявления информации. |
record_enabled | boolean | нет | false | включить запись звонков в файл. Сохраненные файлы доступны через ресурс записей, дисковая квота через свойства клиента. Занятое место на диске через дисковое пространство |
vm_greeting | integer | нет | null | актуально для vm_enabled. Идентификатор звукового файла, звучащего в качестве приветствия голосовой почты |
vm_mailto | string | нет | "" | актуально для vm_enabled. Адрес e-mail для получения оповещений о новом голосовом сообщение (возможны несколько адресов через запятую) |
vm_attach_file | boolean | нет | true | актуально для vm_enabled. Прикреплять ли файл с голосовым сообщение при отправке уведомления о получении |
hangup_timeout | integer | нет | 60 | максимально ожидание ответа добавочного при входящем вызове, указывается в секундах. По истечении этого времени звонок считается не отвеченным и могут включится правила входящего вызова ( если есть), либо произойти отбой. |
auth_type | string | нет | "digest" | Тип аутентификации запросов добавочного на sip-сервере. Принимает одно из значений:
|
password | string | нет | задает пароль для авторизации на sip-сервере при 'auth_type':'digest' или 'auth_type':'both' | |
network_permission_group_id | integer | нет | null | задает идентификатор доверенных сетей клиента для авторизации на sip-сервере при 'auth_type':'network' или 'auth_type':'both' |
external_number | string | нет | null | если параметр определен, то sip-сервер отправляет туда вызов. Этим номером может быть, например, мобильный. Вызов обрабатывается так же, как если бы он пришел непосредственно на терминал ( работаю все правила переадресаций, записей разговоров, разрешение переводом и т.п.) |
static_reg_address | string | нет | null | если терминал по какой-либо причине не может регистрироваться на сервере, то регистрацию можно указать в явном виде. Все вызовы будут направлены на этот адрес. При этом терминал может продолжать регистрироваться на сервере, но вызовы все равно будут уходить согласно static_reg_address. Указывается в виде адрес:порт (например 8.8.8.8:5068) |
call_screening_enabled | boolean | нет | false | управление механизмом подтверждения входящего вызова. Если параметр установлен в true, то во время вызова на добавочный при снятии трубки абонент услышит информацию о номере звонящего и о внешнем номере, на который был осуществлён вызов. Для ответа на вызов в данном случае следует нажать цифру 1, для отмены вызова следует повесить трубку. |
ignore_early_media | boolean | нет | false | если данный параметр установлен в true, то при вызове добавочного будет игнорироваться раннее медиа, например, автоответчики. Может быть полезно в случае регистрации внешнего номера или применения FMC. |
incoming_limit | integer | нет | 0 | устанавлиевает, сколько добавочный может принимать вызовов одновременно. "0" - без ограничений, "1" - не более одного (аналог выключения "call waiting"), "2" - не более двух и т.д. |
allow_webrtc | boolean | нет | false | Если установлено значение "true", то позволяет добавочному работать через WebRTC |
geo_list | string | нет | null | Задает список стран, с айпи адресов которых разрешено использование SIP аккаунта. Страны перечисляются в формате ISO 3166 Codes A2, например "RU US BY". Если список не задан, то используется одноименный параметр ресурса клиент. Если список имеет значение "*", то все страны разрешены и клиентский параметр игнорируется . |
| append_to_cid_name_on_transfer | string | нет | null | # Добавление признака перевода к имени звонящему. Может быть полезно при "слепом переводе", чтобы понять, откуда был переведен вызов. |
| conference_announce_caller_name | boolean | нет | null | Локальная конференция добавочного *8<номердобавочного>. Анонс имени пользователя добавочного, который зашел в локальную конференцию. Для приглашенных анонс не работает |
| conference_end_on_exit | boolean | нет | true | Локальная конференция добавочного *8<номердобавочного>. Конференция закончится, если пользователь добавочного-создателя конференции выйдет из конференции. |
| conference_pin | string | нет | null | Локальная конференция добавочного *8<номердобавочного>. Пин-код для входа в конференцию других добавочных. |
| preserve_caller_id_number_att_tr | boolean | нет | false | Сохранять номер звонящего при переводе командой *2 (перевод с сопровождением). По-умолчанию при переводе *2 номер звонящего помещается в имя звонящего, а в номере звонящего отражен добавочный, совершающий перевод. |
| record_format | # | |||
| record_stereo | # | |||
| record_transfer | boolean | нет | false | Работает только при активной функции record_enabled. Запись в том числе переведенных вызовов (если после перевода вызов попадает на другой добавочный с записью - запись на переводящем добавочном останавливается) |
| ringback_sound | integer | нет | null | Мелодия вместо гудков - 183 progress, по умолчанию 180 Ringing (гудки) |
| transfer_caller_id_number | string | нет | null | Изменение номера (from user number) при переводе |
Примеры использования
Для добавочного с идентификатором 54 установим привязку внешнего мобильного номера +79876543210
метод | ресурс | данные | ответ |
|---|---|---|---|
| PUT | /extension/54/phone/ |
|
} |
Похожие разделы