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

Добавочный является основной единицей АТС, выполняющая определенный перечень функций в соответствии с заданным типом. Ресурс служит для управления наиболее абстрактрыми свойствами добавочного, для специфичных параметров добавочных в зависимости от типа есть отдельные разделы (например /phone/ для добавочных типа "телефонный терминал")

абсолютный. Имеет вид префикс_домена*префикс_клиента*имя_добавочного или префикс_клиента*имя_добавочного@имя_домена (например, 00500*0003*100 или 0003*100@somehost.com). Префиксы клиента и домена можно получить из /client/
относительный. В пределах одного домена префикс_клиента*имя_добавочного (например 0003*100) и просто имя_добавочного в пределах одного клиента (например 100)

адресуется своим персональным номером, который может быть абсолютным и относительным:

Ресурсы

Клиент

`POST /client/{client_id}/extension/`

Add extension

Параметры пути

Name	Type	Description
`client_id`	`string`	Required. Client id.

Параметры JSON

Name	Type	Description
`status`	`string`	Required. One of 'active', 'blocked'. Default: blocked
`label`	`string`
`type`	`string`	Required. One of 'phone', 'queue', 'ivr', 'fax'. Default: phone
`name`	`string`	Required.
`extension_group_id`	`integer`

Resource fields

Name	Type	Description
`status`	`string`	Agent status.
`name`	`string`	Routing list name.
`label`	`string`
`client_id`	`integer`	Client id.
`extension_group_id`	`integer`	User extension id.
`type`	`string`	Rule type.
`id`	`integer`	Resource id.

...

Вариант префикс_клиента*имя_добавочного является основным используемым при выдаче результатов и приеме параметров.

Будучи созданым, добавочный не может быть переименован: возможно удаление с последующим созданием под другим именем.

Есть возможность объединения несколько экстеншенов в группу добавочных номеров.

Table of Contents

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

Добавочный (ExtensionItem)
Anchor
ExtensionItem
ExtensionItem

Имя

Тип

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

Значение По

Умолчанию

Описание

status

string

нет

"blocked"

Статус добавочного:

'active' - активен
'blocked' - заблокирован

name

string

да

префикс_клиента*имя_добавочного или просто имя_добавочного(в этом случчае префикс будет дописан автоматически) Разрядность номера в пределах клиента одинакова и определяется его свойствами.

label string нет null Display Name добавочного. Отображается на вызываемом терминале при исходящих вызовах (если поддерживается)

client_id integer да Идентификатор клиента, которому принадлежит добавочный

extension_group_id integer нет null Идентификатор группы, которой принадлежит добавочный

type Anchor ExtensionItem.type ExtensionItem.type

string

да

Тип добавочного. Параметры настройки, зависящие от типа, находятся в соотвествующих разделах:

id integer да Уникальный идентификатор добавочного

dial_rule_limit

integer

нет

null

Лимит количества правил набора

caller_id_name

string

нет

null

Отображаемое имя при исходяще вызове

extra_params

string

нет

null

Дополнительные параметра

Пример

Создание добавчного типа 'phone'

метод	ресурс	данные	ответ
POST	/client/@me/extension/	`{` `"status": "active",` `"type": "phone",` `"name": "100",` `"label": "Иванов Петр"` `}`	`{` `"status": "active",` `"name": "000*100",` `"label": "Иванов Петр",` `"client_id": 12,` `"extension_group_id": null, "caller_id_name": null, "dial_rule_limit": null, "extra_params": null,` `"type": "phone",` `"id": 190` `}`

Ресурсы

Раздел "клиент"

`POST /client/{client_id}/extension/`

Добавить extension

Параметры URL

Имя	Тип
`client_id`	`string`

Параметры JSON

Имя	Тип	Обязательный
`status`	`string`	`нет`
`dial_rule_limit`	`integer`	`нет`
`name`	`string`	`да`
`extension_group_id`	`integer`	`нет`
`label`	`string`	`нет`
`caller_id_name`	`string`	`нет`
`extra_params`	`string`	`нет`
`type`	`string`	`да`

Поля ответа

Имя	Тип
`status`	`string`
`dial_rule_limit`	`integer`
`name`	`string`
`extension_group_id`	`integer`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`extra_params`	`string`
`type`	`string`
`id`	`integer`

`GET /client/{client_id}/extension/`

Получить extension list

Параметры URL

Имя	Тип
`client_id`	`string`

Параметры запроса

Имя	Тип
`status`	`array [string]`
`name`	`array [string]`
`id`	`array [string]`
`caller_id_name`	`array [string]`
`extension_group_id`	`array [string]`
`per_page`	`integer`
`type`	`array [string]`
`page`	`integer`

Поля ответа

Имя	Тип
`status`	`string`
`dial_rule_limit`	`integer`
`name`	`string`
`extension_group_id`	`integer`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`extra_params`	`string`
`type`	`string`
`id`	`integer`

...

`PUT /client/{client_id}/extension/`

...

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

...

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

rule_id (integer) идентификатор IncomingRule.id

...

Группа добавочных

Добавочный

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

...

Имя

...

Тип

...

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

...

Значение По

Умолчанию

...

Описание

...

Статус добавочного:

'active' - активен
'blocked' - заблокирован

...

Тип добавочного. Параметры настройки, зависящие от типа, находятся в соотвествующих разделах:

...

`{extension_id`}

Обновить extension

Параметры URL

Имя	Тип
`extension_id`	`integer`
`client_id`	`string`

Параметры JSON

Имя	Тип	Обязательный
`status`	`string`	`нет`
`dial_rule_limit`	`integer`	`нет`
`extension_group_id`	`integer`	`нет`
`label`	`string`	`нет`
`caller_id_name`	`string`	`нет`
`extra_params`	`string`	`нет`

Поля ответа

Имя	Тип
`status`	`string`
`dial_rule_limit`	`integer`
`name`	`string`
`extension_group_id`	`integer`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`extra_params`	`string`
`type`	`string`
`id`	`integer`

`GET /client/{client_id}/extension/{extension_id`}

Получить extension

Параметры URL

Имя	Тип
`extension_id`	`integer`
`client_id`	`string`

Поля ответа

Имя	Тип
`status`	`string`
`dial_rule_limit`	`integer`
`name`	`string`
`extension_group_id`	`integer`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`extra_params`	`string`
`type`	`string`
`id`	`integer`

`DELETE /client/{client_id}/extension/{extension_id`}

Удалить extension

Параметры URL

Имя	Тип
`extension_id`	`integer`
`client_id`	`string`

Раздел "Группа добавочных"

`GET /extension_group/{ext_group_id}/extension/`

Получить extension list

Параметры URL

Имя	Тип
`ext_group_id`	`string`

Параметры запроса

Имя	Тип
`status`	`array [string]`
`name`	`array [string]`
`caller_id_name`	`array [string]`
`type`	`array [string]`
`id`	`array [string]`

Поля ответа

Имя	Тип
`status`	`string`
`dial_rule_limit`	`integer`
`name`	`string`
`extension_group_id`	`integer`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`extra_params`	`string`
`type`	`string`
`id`	`integer`

...

`PUT /extension_group/{ext_group_id}/extension/{extension_id`}

Обновить extension

Параметры URL

Имя	Тип
`ext_group_id`	`string`
`extension_id`	`integer`

Параметры JSON

Имя	Тип	Обязательный
`status`	`string`	`нет`
`dial_rule_limit`	`integer`	`нет`
`label`	`string`	`нет`
`caller_id_name`	`string`	`нет`
`extra_params`	`string`	`нет`
`password`	`string`	`нет`

Поля ответа

Имя	Тип
`status`	`string`
`dial_rule_limit`	`integer`
`name`	`string`
`extension_group_id`	`integer`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`extra_params`	`string`
`type`	`string`
`id`	`integer`

`GET /extension_group/{ext_group_id}/extension/{extension_id`}

Получить extension

Параметры URL

Имя	Тип
`ext_group_id`	`string`
`extension_id`	`integer`

Поля ответа

Имя	Тип
`status`	`string`
`dial_rule_limit`	`integer`
`name`	`string`
`extension_group_id`	`integer`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`extra_params`	`string`
`type`	`string`
`id`	`integer`

Раздел "Добавочный"

`GET /extension/{extension_id}/extension/`

Получить extension

Параметры URL

Имя	Тип
`extension_id`	`string`

Поля ответа

Имя	Тип
`status`	`string`
`dial_rule_limit`	`integer`
`name`	`string`
`extension_group_id`	`integer`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`extra_params`	`string`
`type`	`string`
`id`	`integer`

Page Comparison

Versions Compared

Old Version 5

New Version Current

Key

Ресурсы

Клиент

POST /client/{client_id}/extension/

Параметры пути

Параметры JSON

Resource fields

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

Добавочный (ExtensionItem) AnchorExtensionItemExtensionItem

Пример

Создание добавчного типа 'phone'

Ресурсы

Раздел "клиент"

POST /client/{client_id}/extension/

Параметры URL

Параметры JSON

Поля ответа

GET /client/{client_id}/extension/

Параметры URL

Параметры запроса

Поля ответа

PUT /client/{client_id}/extension/

Группа добавочных

Добавочный

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

{extension_id}

Параметры URL

Параметры JSON

Поля ответа

GET /client/{client_id}/extension/{extension_id}

Параметры URL

Поля ответа

DELETE /client/{client_id}/extension/{extension_id}

Параметры URL

Раздел "Группа добавочных"

GET /extension_group/{ext_group_id}/extension/

Параметры URL

Параметры запроса

Поля ответа

PUT /extension_group/{ext_group_id}/extension/{extension_id}

Параметры URL

Параметры JSON

Поля ответа

GET /extension_group/{ext_group_id}/extension/{extension_id}

Параметры URL

Поля ответа

Раздел "Добавочный"

GET /extension/{extension_id}/extension/

Параметры URL

Поля ответа

`POST /client/{client_id}/extension/`

Добавочный (ExtensionItem)
Anchor
ExtensionItem
ExtensionItem

`POST /client/{client_id}/extension/`

`GET /client/{client_id}/extension/`

`PUT /client/{client_id}/extension/`

`{extension_id`}

`GET /client/{client_id}/extension/{extension_id`}

`DELETE /client/{client_id}/extension/{extension_id`}

`GET /extension_group/{ext_group_id}/extension/`

`PUT /extension_group/{ext_group_id}/extension/{extension_id`}

`GET /extension_group/{ext_group_id}/extension/{extension_id`}

`GET /extension/{extension_id}/extension/`