Versions Compared

Key

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

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

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

Table of Contents

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

Имя

Тип

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

Описание

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

да

Пароль пользователя

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, куда будут отправлены данные при создании нового пользователя

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

Expand
titlePOST /client/{client_id}/user/extension_group/

POST /client/{client_id}/user/extension_group/

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

Параметры URL

Имя

Тип

client_id

string

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

Имя

Тип

comment

string

status

string

name

string

extension_group_id

long

access

string

extra_params

string

timezone

string

login

string

password

string

email

string

email_notify

boolean

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

Имя

Тип

comment

string

status

string

name

string

extension_group_id

long

email

string

access

string

extra_params

string

timezone

string

login

string

id

long

Expand
titleGET /client/{client_id}/user/extension_group/

GET /client/{client_id}/user/extension_group/

Получить список пользователей уровня "Группа внутренних номеров"

Параметры URL

Имя

Тип

client_id

string

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

Имя

Тип

comment

Array[string]

status

Array[string]

name

Array[string]

id

Array[integer]

access

Array[string]

extension_group_id

Array[integer]

timezone

Array[string]

login

Array[string]

email

Array[string]

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

Имя

Тип

comment

string

status

string

name

string

extension_group_id

long

email

string

access

string

extra_params

string

timezone

string

login

string

id

long

Expand
titlePUT /client/{client_id}/user/extension_group/{user_id}

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

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

Параметры URL

Имя

Тип

user_id

integer

client_id

string

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

Имя

Тип

comment

string

status

string

name

string

extension_group_id

long

access

string

extra_params

string

timezone

string

password

string

email

string

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

Имя

Тип

comment

string

status

string

name

string

extension_group_id

long

email

string

access

string

extra_params

string

timezone

string

login

string

id

long

Expand
titleGET /client/{client_id}/user/extension_group/{user_id}

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

Запросить параметры пользователя уровня "Группа внутренних номеров"

Параметры URL

Имя

Тип

user_id

integer

client_id

string

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

Имя

Тип

comment

string

status

string

name

string

extension_group_id

long

email

string

access

string

extra_params

string

timezone

string

login

string

id

long

Expand
titleDELETE /client/{client_id}/user/extension_group/{user_id}

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

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

Параметры URL

Имя

Тип

user_id

integer

client_id

string