Добавочный является основной единицей АТС, выполняющая определенный перечень функций в соответствии с заданным типом. Ресурс служит для управления наиболее абстрактрыми свойствами добавочного, для специфичных параметров добавочных в зависимости от типа есть отдельные разделы (например /phone/ для добавочных типа "телефонный терминал")
Добавочный может быть адресован номерами разного типа:
- абсолютный. Имеет вид префикс_домена*префикс_клиента*имя_добавочного или префикс_клиента*имя_добавочного@имя_домена (например, 00500*0003*100 или 0003*100@somehost.com). Префиксы клиента и домена можно получить из /client/
- относительный. В пределах одного домена префикс_клиента*имя_добавочного (например 0003*100) и просто имя_добавочного в пределах одного клиента (например 100)
Будучи созданым, добавочный не может быть переименован: возможно удаление с последующим созданием под другим именем.
Описание структур данных
Добавочный (ExtensionItem)
Имя | Тип | Обязательное | Значение По Умолчанию | Описание |
|---|---|---|---|---|
status | string | нет | "blocked" | Статус добавочного:
|
name | string | да | Имя добавочного. Он же короткий номер добавочного в пределах клиента. Например "100" или "4000" Разрядность номера в пределах клиента одинакова и определяется его свойствами. | |
label | string | нет | null | Display Name добавочного. Отображается на вызываемом терминале при исходящих вызовах (если поддерживается) |
client_id | integer | да | Идентификатор клиента, которому принадлежит добавочный | |
extension_group_id | integer | нет | null | Идентификатор группы, которой принадлежит добавочный |
type | string | да | Тип добавочного. Параметры настройки, зависящие от типа, находятся в соотвествующих разделах:
| |
id | integer | да | уникальный идентификатор добавочного |
Ресурсы
Клиент
POST /client/{client_id}/extension/
Добавить extension
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры JSON
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
Имя | Тип |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /client/{client_id}/extension/
Получить extension list
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры запроса
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
PUT /client/{client_id}/extension/{extension_id}
Обновить extension
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
Параметры JSON
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /client/{client_id}/extension/{extension_id}
Получить extension
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
Имя | Тип |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
DELETE /client/{client_id}/extension/{extension_id}
Удалить extension
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Группа добавочных
GET /extension_group/{ext_group_id}/extension/
Получить extension list
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры запроса
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
PUT /extension_group/{ext_group_id}/extension/{extension_id}
Обновить extension
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
Параметры JSON
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
Имя | Тип |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /extension_group/{ext_group_id}/extension/{extension_id}
Получить extension
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Добавочный
GET /extension/{extension_id}/extension/
Получить extension
Параметры URL
Имя | Тип |
|---|---|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|