Пользователь внутреннего номера (/user/extension/)

_{Протестировать методы API можно на странице}_{интерактивного обозревателя API}_{и без написания кода}
_{Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см.}_{Создание и авторизация приложений}₎

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

1 Описание структур данных
2 Ресурсы раздела “Клиент”

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

Имя	Тип	Обяза-тельный	Описание

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

Ресурсы раздела “Клиент”

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

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

Параметры URL

Имя	Тип

Имя	Тип
client_id	string

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

Имя	Тип

Имя	Тип
comment	string
status	string
name	string
access	string
extension_id	long
extra_params	string
timezone	string
login	string
password	string
email	string
email_notify	boolean

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

Имя	Тип

Имя	Тип
comment	string
status	string
name	string
email	string
access	string
extension_id	long
extra_params	string
timezone	string
login	string
id	long

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	long
extra_params	string
timezone	string
login	string
id	long

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

Обновить пользователя уровня "Внутренний номер"

Параметры URL

Имя	Тип

Имя	Тип
user_id	integer
client_id	string

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

Имя	Тип

Имя	Тип
comment	string
status	string
name	string
access	string
extension_id	long
extra_params	string
timezone	string
password	string
email	string

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

Имя	Тип

Имя	Тип
comment	string
status	string
name	string
email	string
access	string
extension_id	long
extra_params	string
timezone	string
login	string
id	long

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	long
extra_params	string
timezone	string
login	string
id	long

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

Удалить пользователя уровня "Внутренний номер"

Параметры URL

Имя	Тип

Имя	Тип
user_id	integer
client_id	string