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

Описание

Ресурс предназначен для создания, удаления, а также для управления и уточнения параметров пользователя уровня добавочного.

Пользователь уровня добавочного имеет доступ к настройкам и ресурсам конкретного добавочного, а в зависимости от типа доступа (access type) либо имеет полный доступ (full), либо доступ только для чтения ('read_only') без права на какие-либо изменения в настройках.

Ресурсы /user/extension/

Ресурсы создания, удаления, а также для управления и уточнения параметров пользователя уровня добавочного:

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

Добавить нового пользователя уровня "Добавочный"

Параметры URL

Имя	Тип	Описание
`client_id`	`string`	Нужно указать обязательно.

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

Имя	Тип	Описание
`comment`	`string`	Комментарий (заметка)
`status`	`string`	Статус пользователя. Может быть: 'active' либо 'blocked'.
`name`	`string`	Нужно указать обязательно.
`access`	`string`	Тип доступа к ресусрам. Может быть 'full' либо 'read_only' (нет прав на изменения)
`extension_id`	`integer`	Нужно указать обязательно.ID добавочного, для которого создается пользователь
`extra_params`	`string`	Поле дополнительных параметров - можно приспособить для любых целей
`timezone`	`string`	Пользовательская тайм-зона
`login`	`string`	Нужно указать обязательно.
`password`	`string`	Нужно указать обязательно.
`email`	`string`	Нужно указать обязательно.
email_notify	boolean	Если True тогда текущему пользователю(кто создает), на почту будут высланны данные для доступа в систему для нового созданного пользователя.

Параметры ответа

Имя	Тип	Описание
`comment`	`string`
`status`	`string`
`name`	`string`
`email`	`string`
`access`	`string`
`extension_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	ID данного ресурса

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

Получить список пользователей типа "Добавочный" клиента

Параметры URL

Имя	Тип	Описание
`client_id`	`string`	Нужно указать обязательно.

Параметры запроса (фильтр)

Имя	Тип	Описание
`comment`	`array [string]`
`status`	`array [string]`
`name`	`array [string]`
`id`	`array [integer]`
`access`	`array [string]`
`extension_id`	`array [integer]`
`timezone`	`array [string]`
`login`	`array [string]`
`email`	`array [string]`

Параметры ответа

Имя	Тип	Описание
`comment`	`string`
`status`	`string`
`name`	`string`
`email`	`string`
`access`	`string`
`extension_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	ID данного ресурса

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

Обновление пользователя типа "Добавочный"

Параметры URL

Имя	Тип	Описание
`user_id`	`integer`	Нужно указать обязательно.
`client_id`	`string`	Нужно указать обязательно.

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

Имя	Тип	Описание
`comment`	`string`	Комментарий (заметка)
`status`	`string`	Статус пользователя. Может быть: 'active' либо 'blocked'.
`name`	`string`	Видимое имя пользователя
`access`	`string`	Тип доступа к ресусрам. Может быть 'full' либо 'read_only' (нет прав на изменения).
`extension_id`	`integer`	ID пользователя уровня "Добавочный"
`extra_params`	`string`	Поле дополнительных параметров - можно приспособить для любых целей
`timezone`	`string`	Пользовательская тайм-зона
`password`	`string`
`email`	`string`

Параметры ответа

Имя	Тип	Описание
`comment`	`string`
`status`	`string`
`name`	`string`
`email`	`string`
`access`	`string`
`extension_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	ID данного ресурса

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

Запросить параметры пользователя типа "Добавочный"

Параметры URL

Имя	Тип	Описание
`user_id`	`integer`	Нужно указать обязательно.
`client_id`	`string`	Нужно указать обязательно.

Параметры ответа

Имя	Тип	Описание
`comment`	`string`
`status`	`string`
`name`	`string`
`email`	`string`
`access`	`string`
`extension_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	ID данного ресурса

`DELETE /client/{client_id}/user/extension/{user_id`}

Удаление пользователя типа "Добавочный"

Параметры URL

Имя	Тип	Описание
`user_id`	`integer`	Нужно указать обязательно.
`client_id`	`string`	Нужно указать обязательно.

REST API Документация клиента

Пользователь добавочного (/user/extension/)

Описание

Ресурсы /user/extension/

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

Параметры URL

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

Параметры ответа

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

Параметры URL

Параметры запроса (фильтр)

Параметры ответа

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

Параметры URL

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

Параметры ответа

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

Параметры URL

Параметры ответа

`DELETE /client/{client_id}/user/extension/{user_id`}

Параметры URL

Теги по теме

Описание

Ресурсы /user/extension/

POST /client/{client_id}/user/extension/

Параметры URL

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

Параметры ответа

GET /client/{client_id}/user/extension/

Параметры URL

Параметры запроса (фильтр)

Параметры ответа

PUT /client/{client_id}/user/extension/{user_id}

Параметры URL

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

Параметры ответа

GET /client/{client_id}/user/extension/{user_id}

Параметры URL

Параметры ответа

DELETE /client/{client_id}/user/extension/{user_id}

Параметры URL

Теги по теме

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

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

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

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

`DELETE /client/{client_id}/user/extension/{user_id`}