Добавочный является основной единицей АТС, выполняющая определенный перечень функций в соответствии с заданным типом. Ресурс служит для управления наиболее абстрактрыми свойствами добавочного, для специфичных параметров добавочных в зависимости от типа есть отдельные разделы (например /phone/ для добавочных типа "телефонный терминал")
Добавочный может быть адресован номерами разного типа:
- абсолютный. Имеет вид префикс_домена*префикс_клиента*имя_добавочного или префикс_клиента*имя_добавочного@имя_домена (например, 00500*0003*100 или 0003*100@somehost.com). Префиксы клиента и домена можно получить из /client/
- относительный. В пределах одного домена префикс_клиента*имя_добавочного (например 0003*100) и просто имя_добавочного в пределах одного клиента (например 100)
Ресурсы
Клиент
POST /client/{client_id}/extension/
Add extension
Параметры пути
Name | Type | Description |
|---|---|---|
|
| Required. Client id. |
Параметры JSON
Name | Type | Description |
|---|---|---|
|
| Required. One of 'active', 'blocked'. Default: blocked |
|
| |
|
| Required. One of 'phone', 'queue', 'ivr', 'fax'. Default: phone |
|
| Required. |
|
|
Resource fields
Name | Type | Description |
|---|---|---|
|
| Agent status. |
|
| Routing list name. |
|
| |
|
| Client id. |
|
| User extension id. |
|
| Rule type. |
|
| Resource id. |
| Ресурс | Метод | Параметры Пути | Тело запроса | Описание |
|---|---|---|---|---|
| /client/{client_id}/extension/ | POST | client_id (integer) уникальный идентификатор клиента, может принимать значение @me в случае пользователя типа "клиент" | поля ExtensionItem, за исключением ExtensionItem.id (генерируется автоматически) | Создание нового добавочного |
| GET | extension_id (integer) уникальный идентификатор добавочного, может принимать значение @me в случае пользователя типа "экстеншен" | Получить список входящих правил для добавочного | ||
| PUT | extension_id (integer) уникальный идентификатор добавочного, может принимать значение @me в случае пользователя типа "экстеншен" rule_id (integer) идентификатор IncomingRule.id | обновленные поля IncomingRule , за исключением IncomingRule.id | Обновляет правила входящего вызова | |
| DELETE | Удаляет правило входящего вызова | |||
| GET | Получить правило входящего вызова | |||
| PUT | extension_id (integer) уникальный идентификатор добавочного, может принимать значение @me в случае пользователя типа "экстеншен" | IncomingRuleOrder | Изменить порядок правил входящего вызова | |
| GET | extension_id (integer) уникальный идентификатор добавочного, может принимать значение @me в случае пользователя типа "экстеншен" | Получить порядок правил входящего вызова |
Группа добавочных
Добавочный
Описание структур данных
Добавочный (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 | да | уникальный идентификатор добавочного |