Просмотр настроек по умолчанию для всех видеовстреч организации

Получает данные о настройках по умолчанию, которые действуют для всех создаваемых в организации видеовстреч. Метод доступен только администраторам организации.

Чтобы выполнить запрос, приложению требуется разрешение telemost-api:conferences.read.

Запрос

GET

https://cloud-api.yandex.net/v1/telemost-api/organizations/{org_id}/settings

Path-параметры

Имя параметра	Тип	Описание
`org_id`	`integer`	Идентификатор организации. Где взять идентификатор организации Его может посмотреть администратор в кабинете организации Яндекс 360 для бизнеса: Войдите в аккаунт администратора организации. В меню слева выберите общие настройки → Профиль организации. Идентификатор будет написан под названием организации.

Заголовки

Authorization: OAuth <токен>

Результат

Успешный ответ

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

200 OK — запрос выполнен успешно:

{
    "waiting_room_level_adhoc": {
        "value": "string"
    },
    "waiting_room_level_calendar": {
        "value": "string"
    },
    "cloud_recording_allowed_roles": {
    	"value": ["string"]
    },
    "cloud_recording_email_receivers": {
    	"value": ["string"]
    },
    "summarization_allowed_roles": {
    	"value": ["string"]
    },
    "summarization_email_receivers": {
    	"value": ["string"]
    }
}

Поля

Имя параметра	Тип	Описание	Основные используемые значения
`waiting_room_level_adhoc`	`object`	Настройки комнаты ожидания для видеовстреч, созданных по кнопке Новая видеовстреча в Телемосте
`waiting_room_level_adhoc.` `value`	`string`	Значение по умолчанию	`PUBLIC` — комната ожидания выключена, пользователи смогут сразу присоединиться к встрече. `ORGANIZATION` — комната ожидания включена для внешних пользователей, к встрече сразу смогут присоединиться только пользователи с аккаунтами на домене организации. `ADMINS` — комната ожидания включена для всех пользователей, кроме организаторов и соорганизаторов.
`waiting_room_level_calendar`	`object`	Настройки комнаты ожидания для видеовстреч, созданных из Яндекс Календаря
`waiting_room_level_calendar.` `value`	`string`	Значение по умолчанию	`PUBLIC` — комната ожидания выключена, пользователи смогут сразу присоединиться к встрече. `ORGANIZATION` — комната ожидания включена для внешних пользователей, к встрече сразу смогут присоединиться только пользователи с аккаунтами на домене организации. `ADMINS` — комната ожидания включена для всех пользователей, кроме организаторов и соорганизаторов.
`cloud_recording_allowed_roles`	`object`	Кто может вести запись видеовстречи на Яндекс Диск
`cloud_recording_allowed_roles.` `value`	`array` of `string`	Значение по умолчанию для настройки	`OWNER` — организатор. `INTERNAL_COHOST` — соорганизаторы (для данного параметра значение задает всех соорганизаторов, в том числе не из организации). `INTERNAL_MEMBER` — участники (для данного параметра значение задает всех участников, в том числе не из организации).
`cloud_recording_email_receivers`	`object`	Кто получит на почту ссылку на Яндекс Диск с записью видеовстречи
`cloud_recording_email_receivers.` `value`	`array` of `string`	Значение по умолчанию для настройки	`OWNER` — организатор. `INTERNAL_COHOST` — соорганизаторы — сотрудники организации. `INTERNAL_MEMBER` — участники — сотрудники организации.
`summarization_allowed_roles`	`object`	Кто может включать конспектирование видеовстречи
`summarization_allowed_roles.` `value`	`array` of `string`	Значение по умолчанию для настройки	`OWNER` — организатор. `INTERNAL_COHOST` — соорганизаторы (для данного параметра значение задает всех соорганизаторов, в том числе не из организации). `INTERNAL_MEMBER` — участники (для данного параметра значение задает всех участников, в том числе не из организации).
`summarization_email_receivers`	`object`	Кто получит на почту конспект видеовстречи
`summarization_email_receivers.` `value`	`array` of `string`	Значение по умолчанию для настройки	`OWNER` — организатор. `INTERNAL_COHOST` — соорганизаторы — сотрудники организации. `INTERNAL_MEMBER` — участники — сотрудники организации.

Ответ с ошибкой

В случае ошибки возвращается сообщение следующего содержания:

{
  "error": "string",
  "message": "string",
  "description": "string",
  "details": "object"
}

Имя параметра	Тип	Описание
`error`	`string`	Код ошибки
`message`	`string`	Сообщение об ошибке
`description`	`object`	Техническое описание ошибки
`details`	`object`	[Опциональный параметр] Дополнительная информация об ошибке

Ошибки могут быть со следующими HTTP-статусами:

403 Forbidden
- {"error": "ApiRestrictedToOrganizations"} — доступ запрещен, так как вы не являетесь пользователем Яндекс 360 для бизнеса или ваш аккаунт зарегистрирован не на домене организации.
- {"error": "OrganizationSettingsAccessForbidden"} — доступ запрещен, так как вы не являетесь администратором организации.
4xx
- незадокументированные ошибки, например некорректный запрос, слишком большое количество запросов или проблемы с авторизацией.

Была ли статья полезна?

Удаление из списка

Обновление