Протестировать методы API можно на странице интерактивного обозревателя API и без написания кода
Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см. Создание и авторизация приложений)
Описание структур данных
Имя | Тип | Обяза-тельный | Описание |
---|---|---|---|
comment | string | нет | Комментарий (заметка) |
status | string | нет | Статус пользователя. Может быть: 'active' или 'blocked' |
name | string | да | Имя пользователя |
extension_group_id | integer | да | Идентификатор группы внутренних номеров, для которой создается пользователь |
access | string | нет | Тип доступа к ресурсам. Может быть 'full' или 'read_only' (нет прав на изменения) |
extra_params | string | нет | Поле для дополнительных параметров, можно приспособить для любых целей |
timezone | string | нет | Пользовательская тайм-зона |
login | string | да | Логин пользователя |
password | string | да | Пароль пользователя |
string | да | e-mail пользователя | |
email_notify | boolean | нет | Если параметр принимает значение ‘True’,тогда текущему пользователю (который создает) на почту будут высланы данные для доступа в систему для нового созданного пользователя. В случае указания email_for_notify - на почту из email_for_notify, если не указан email_for_notify- то будет отправлено текущему пользователю (который создает) |
email_for_notify | string | нет | поле, необходимое для email_notify, это e-mail , куда будут отправлены данные при создании нового пользователя |
Ресурсы раздела “Клиент”
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
POST /client/{client_id}/user/extension_group/ Добавить нового пользователя уровня "Группа внутренних номеров" Параметры URL
Параметры запроса
Параметры ответа
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||
GET /client/{client_id}/user/extension_group/ Получить список пользователей уровня "Группа внутренних номеров" Параметры URL
Параметры запроса (фильтр)
Параметры ответа
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
PUT /client/{client_id}/user/extension_group/{user_id} Обновить пользователя уровня "Группа внутренних номеров" Параметры URL
Параметры запроса
Параметры ответа
|
Expand | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
GET /client/{client_id}/user/extension_group/{user_id} Запросить параметры пользователя уровня "Группа внутренних номеров" Параметры URL
Параметры ответа
|
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
DELETE /client/{client_id}/user/extension_group/{user_id} Удалить пользователя уровня "Группа внутренних номеров" Параметры URL
|