Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

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

Имя
Тип
Обязательное

Значение По

Умолчанию

Описание
statusstringнет"blocked"

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

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

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

labelstringнетnullDisplay Name добавочного. Отображается на вызываемом терминале при исходящих вызовах (если поддерживается)
client_idintegerда Идентификатор клиента, которому принадлежит добавочный
extension_group_idintegerнетnullИдентификатор группы, которой принадлежит добавочный
type
Anchor
ExtensionItem.type
ExtensionItem.type
stringда 

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

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

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/

...

Имя

Тип

Обязательный

status

string

нет

label

string

нет

type

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

extensionextra_group_idparams

integerstring

type

string

id

integer

GET /client/{client_id}/extension/

...

Имя

Тип

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]

id

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

extensionextra_group_idparams

integerstring

type

string

id

integer

...

PUT /client/{client_id}/extension/{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

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

...

Имя

Тип

status

array [string]

typename

array [string]

caller_id_name

array [string]name

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

extensionextra_group_idparams

integerstring

type

string

id

integer

...

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

...

Имя

Тип

Обязательный

status

string

нетpassword

dial_rule_limit

integer

нет

label

string

нет

caller_id_name

string

нет

extra_params

string

нет

labelpassword

string

нет

Поля ответа

Имя

ТипИмя

status

Тип

status

stringstring

dial_rule_limit

integer

name

string

extension_group_id

integer

label

string

caller_id_name

string

client_id

integer

extensionextra_group_idparams

integerstring

type

string

id

integer

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

...

Поля ответа

Имя

Тип

status

string

dial_rule_limit

integer

name

string

extension_group_id

integer

label

string

caller_id_name

string

client_id

integer

extensionextra_group_idparams

integerstring

type

string

id

integer

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

GET /extension/{extension_id}/extension/

...

Поля ответа

Имя

Тип

status

string

dial_rule_limit

integer

name

string

extension_group_id

integer

label

string

caller_id_name

string

client_id

integer

extensionextra_group_idparams

integerstring

type

string

id

integer