Versions Compared

Old Version 6

changes.mady.by.user Dmitri Savolainen

Saved on

compared with

New Version 7

changes.mady.by.user Dmitri Savolainen

Saved on

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да Имя добавочного. Он же короткий номер добавочного в пределах клиента. Например "100" или "4000" Разрядность номера в пределах клиента одинакова и определяется его свойствами.
labelstringнетnullDisplay Name добавочного. Отображается на вызываемом терминале при исходящих вызовах (если поддерживается)
client_idintegerда Идентификатор клиента, которому принадлежит добавочный
extension_group_idintegerнетnullИдентификатор группы, которой принадлежит добавочный
type
Anchor
ExtensionItem.type
ExtensionItem.type
stringда 

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

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

Ресурсы

Клиент

POST /client/{client_id}/extension/

Add Добавить extension

Параметры

...

URL

NameИмя

TypeТип

Description

client_id

stringRequired. 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

Description

Name

Type

нет

Поля ответа

 

Имя

Тип

Имя

Тип

status

stringAgent status.

name

stringRouting list name.

label

string

client_id

integer

Client id.

extension_group_id

integer

User extension id.

type

stringRule type.

id

integer

Resource id.

РесурсМетодПараметры ПутиТело запросаОписание

GET /client/{client_id}/extension/

...

Получить extension list

Параметры URL

Имя

Тип

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

поля ExtensionItem, за исключением ExtensionItem.id (генерируется автоматически)Создание нового добавочного
 GETextension_id (integer) уникальный идентификатор добавочного, может принимать значение @me в случае пользователя типа "экстеншен"   Получить список входящих правил для добавочного
 PUT

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

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

обновленные поля IncomingRule , за исключением IncomingRule.idОбновляет правила входящего вызова
 DELETE Удаляет правило входящего вызова
 GET Получить правило входящего вызова
 PUTextension_id (integer) уникальный идентификатор добавочного, может принимать значение @me в случае пользователя типа "экстеншен"IncomingRuleOrderИзменить порядок правил входящего вызова
 GETextension_id (integer) уникальный идентификатор добавочного, может принимать значение @me в случае пользователя типа "экстеншен" Получить порядок правил входящего вызова

 

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

Добавочный

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

...

typeуникальный идентификатор добавочного
Имя
Тип
Обязательное

Значение По

Умолчанию

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

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

  • 'active' - активен
  • 'blocked' - заблокирован
namestringда Имя добавочного. Он же короткий номер добавочного в пределах клиента. Например "100" или "4000" Разрядность номера в пределах клиента одинакова и определяется его свойствами.
labelstringнетnullDisplay Name добавочного. Отображается на вызываемом терминале при исходящих вызовах (если поддерживается)
client_idintegerда Идентификатор клиента, которому принадлежит добавочный
extension_group_idintegerнетnullИдентификатор группы, которой принадлежит добавочный
Anchor
ExtensionItem.typeExtensionItem.typestringда 

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

idintegerда 

string

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

Имя

Тип

status

array [string]

name

array [string]

extension_group_id

array [string]

type

array [string]

id

array [string]

Поля ответа

Имя

Тип

status

string

name

string

label

string

client_id

integer

extension_group_id

integer

type

string

id

integer

PUT /client/{client_id}/extension/{extension_id}

Обновить extension

Параметры URL

Имя

Тип

extension_id

integer

client_id

string

Параметры JSON

Имя

Тип

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

status

string

нет

password

string

нет

label

string

нет

Поля ответа

Имя

Тип

status

string

name

string

label

string

client_id

integer

extension_group_id

integer

type

string

id

integer

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

Получить extension

Параметры URL

Имя

Тип

extension_id

integer

client_id

string

Поля ответа

Имя

Тип

Имя

Тип

status

string

name

string

label

string

client_id

integer

extension_group_id

integer

type

string

id

integer

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

Удалить extension

Параметры URL

Имя

Тип

extension_id

integer

client_id

string

Поля ответа

Имя

Тип

status

string

name

string

label

string

client_id

integer

extension_group_id

integer

type

string

id

integer

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

Добавочный