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

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

Чтобы изменить настройки по умолчанию, добавьте приложению разрешение telemost-api:organization_settings.update.

Разрешение telemost-api:conferences.update для этого запроса устарело и поддерживается временно.

Для выполнения запроса требуется право telemost-api:conferences.update.

Request

PUT

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

Path parameters

Name

Description

org_id

Type: string

Идентификатор организации.

Example: 123456

Body

application/json
{
  "waiting_room_level_adhoc": {
    "value": "ORGANIZATION"
  },
  "waiting_room_level_calendar": {
    "value": "ORGANIZATION"
  },
  "cloud_recording_email_receivers": {
    "value": [
      "OWNER"
    ]
  },
  "summarization_email_receivers": {
    "value": [
      "OWNER",
      "INTERNAL_COHOST"
    ]
  },
  "calendar_event_summarization_email_receivers": {
    "value": [
      "OWNER"
    ]
  },
  "cloud_recording_allowed_roles": {
    "value": [
      "OWNER",
      "INTERNAL_COHOST",
      "INTERNAL_MEMBER"
    ]
  },
  "summarization_allowed_roles": {
    "value": [
      "OWNER",
      "INTERNAL_COHOST"
    ]
  },
  "is_incoming_phone_calls_turned_on": true
}

Name

Description

cloud_recording_allowed_roles

Type: CloudRecordingAllowedRoles

Кто может вести запись видеовстречи на Яндекс Диск.

Example
{
  "value": [
    "OWNER",
    "INTERNAL_COHOST",
    "INTERNAL_MEMBER"
  ]
}

cloud_recording_email_receivers

Type: CloudRecordingEmailReceivers

Роли участников встречи, которые получат письмо со ссылкой на Яндекс Диск с записью видеовстречи.

Example
{
  "value": [
    "OWNER"
  ]
}

summarization_allowed_roles

Type: SummarizationAllowedRoles

Роли участников встречи, которым разрешено включать конспектирование видеовстречи.

Example
{
  "value": [
    "OWNER",
    "INTERNAL_COHOST"
  ]
}

summarization_email_receivers

Type: SummarizationEmailReceivers

Роли участников встречи, которые получат письмо c конспектом видеовстречи.

Example
{
  "value": [
    "OWNER",
    "INTERNAL_COHOST"
  ]
}

waiting_room_level_adhoc

Type: WaitingRoomLevelAdhoc

Настройки комнаты ожидания для видеовстреч, созданных по кнопке Новая видеовстреча в Телемосте.

Example
{
  "value": "ORGANIZATION"
}

waiting_room_level_calendar

Type: WaitingRoomLevelCalendar

Настройки комнаты ожидания для видеовстреч, созданных из Яндекс Календаря.

Example
{
  "value": "ORGANIZATION"
}

calendar_event_summarization_email_receivers

Type: CalendarEventSummarizationEmailReceivers

Роли участников, приглашенных на встречу в календаре, которые получат письмо c саммаризацией встречи.

Example
{
  "value": [
    "OWNER"
  ]
}

is_incoming_phone_calls_turned_on

Type: boolean

Включена ли возможность дозваниваться в встречу с телефона.

WaitingRoomLevelAdhoc

Настройки комнаты ожидания для видеовстреч, созданных по кнопке Новая видеовстреча в Телемосте.

Name

Description

value

Type: string

Уровень доступа встречи:

  • PUBLIC — комната ожидания выключена, пользователи смогут сразу присоединиться к встрече.
  • ORGANIZATION — комната ожидания включена для внешних пользователей, к встрече сразу смогут присоединиться только пользователи с аккаунтами на домене организации.
  • ADMINS — комната ожидания включена для всех пользователей, кроме организаторов и соорганизаторов.
  • UNKNOWN — параметр для обеспечения обратной совместимости.

Enum: PUBLIC, ORGANIZATION, ADMINS
Example
{
  "value": "ORGANIZATION"
}

WaitingRoomLevelCalendar

Настройки комнаты ожидания для видеовстреч, созданных из Яндекс Календаря.

Name

Description

value

Type: string

Уровень доступа встречи:

  • PUBLIC — комната ожидания выключена, пользователи смогут сразу присоединиться к встрече.
  • ORGANIZATION — комната ожидания включена для внешних пользователей, к встрече сразу смогут присоединиться только пользователи с аккаунтами на домене организации.
  • ADMINS — комната ожидания включена для всех пользователей, кроме организаторов и соорганизаторов.
  • UNKNOWN — параметр для обеспечения обратной совместимости.

Enum: PUBLIC, ORGANIZATION, ADMINS
Example
{
  "value": "ORGANIZATION"
}

CloudRecordingEmailReceivers

Роли участников встречи, которые получат письмо со ссылкой на Яндекс Диск с записью видеовстречи.

Name

Description

value

Type: string[]

Список ролей участников встречи.

Example
[
  "OWNER"
]
Example
{
  "value": [
    "OWNER"
  ]
}

SummarizationEmailReceivers

Роли участников встречи, которые получат письмо c конспектом видеовстречи.

Name

Description

value

Type: string[]

Список ролей участников встречи.

Example
[
  "OWNER",
  "INTERNAL_COHOST"
]
Example
{
  "value": [
    "OWNER",
    "INTERNAL_COHOST"
  ]
}

CalendarEventSummarizationEmailReceivers

Роли участников, приглашенных на встречу в календаре, которые получат письмо c саммаризацией встречи.

Name

Description

value

Type: string[]

Список ролей участников встречи.

Example
[
  "OWNER"
]
Example
{
  "value": [
    "OWNER"
  ]
}

CloudRecordingAllowedRoles

Кто может вести запись видеовстречи на Яндекс Диск.

Name

Description

value

Type: string[]

Список ролей участников встречи.

Example
[
  "OWNER",
  "INTERNAL_COHOST",
  "INTERNAL_MEMBER"
]
Example
{
  "value": [
    "OWNER",
    "INTERNAL_COHOST",
    "INTERNAL_MEMBER"
  ]
}

SummarizationAllowedRoles

Роли участников встречи, которым разрешено включать конспектирование видеовстречи.

Name

Description

value

Type: string[]

Список ролей участников встречи.

Example
[
  "OWNER",
  "INTERNAL_COHOST"
]
Example
{
  "value": [
    "OWNER",
    "INTERNAL_COHOST"
  ]
}

Responses

200 OK

Результатом успешного запроса является ответ с кодом 200.

Body

application/json
{
  "waiting_room_level_adhoc": {
    "value": "ORGANIZATION"
  },
  "waiting_room_level_calendar": {
    "value": "ORGANIZATION"
  },
  "cloud_recording_email_receivers": {
    "value": [
      "OWNER"
    ]
  },
  "summarization_email_receivers": {
    "value": [
      "OWNER",
      "INTERNAL_COHOST"
    ]
  },
  "calendar_event_summarization_email_receivers": {
    "value": [
      "OWNER"
    ]
  },
  "cloud_recording_allowed_roles": {
    "value": [
      "OWNER",
      "INTERNAL_COHOST",
      "INTERNAL_MEMBER"
    ]
  },
  "summarization_allowed_roles": {
    "value": [
      "OWNER",
      "INTERNAL_COHOST"
    ]
  },
  "is_incoming_phone_calls_turned_on": true
}

Name

Description

cloud_recording_allowed_roles

Type: CloudRecordingAllowedRoles

Кто может вести запись видеовстречи на Яндекс Диск.

Example
{
  "value": [
    "OWNER",
    "INTERNAL_COHOST",
    "INTERNAL_MEMBER"
  ]
}

cloud_recording_email_receivers

Type: CloudRecordingEmailReceivers

Роли участников встречи, которые получат письмо со ссылкой на Яндекс Диск с записью видеовстречи.

Example
{
  "value": [
    "OWNER"
  ]
}

summarization_allowed_roles

Type: SummarizationAllowedRoles

Роли участников встречи, которым разрешено включать конспектирование видеовстречи.

Example
{
  "value": [
    "OWNER",
    "INTERNAL_COHOST"
  ]
}

summarization_email_receivers

Type: SummarizationEmailReceivers

Роли участников встречи, которые получат письмо c конспектом видеовстречи.

Example
{
  "value": [
    "OWNER",
    "INTERNAL_COHOST"
  ]
}

waiting_room_level_adhoc

Type: WaitingRoomLevelAdhoc

Настройки комнаты ожидания для видеовстреч, созданных по кнопке Новая видеовстреча в Телемосте.

Example
{
  "value": "ORGANIZATION"
}

waiting_room_level_calendar

Type: WaitingRoomLevelCalendar

Настройки комнаты ожидания для видеовстреч, созданных из Яндекс Календаря.

Example
{
  "value": "ORGANIZATION"
}

calendar_event_summarization_email_receivers

Type: CalendarEventSummarizationEmailReceivers

Роли участников, приглашенных на встречу в календаре, которые получат письмо c саммаризацией встречи.

Example
{
  "value": [
    "OWNER"
  ]
}

is_incoming_phone_calls_turned_on

Type: boolean

Включена ли возможность дозваниваться в встречу с телефона.

400 Bad Request

Некорректный запрос.

Body

application/json
{
  "error": "TelemostBadRequestError",
  "description": "Некорректный запрос.",
  "message": "Некорректный запрос.",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Некорректный запрос.

error

Type: string

Код ошибки

Example: TelemostBadRequestError

message

Type: string

Сообщение об ошибке.

Example: Некорректный запрос.

details
Type: object

Дополнительные детали ошибки

Example
{}

403 Forbidden

Возможные ошибки:

  • Нет прав на выполнение запроса.
  • API доступен пользователям Яндекс 360 для бизнеса.

Body

application/json
{
  "error": "OrganizationSettingsAccessForbidden",
  "description": "Нет прав на выполнение запроса.",
  "message": "Нет прав на выполнение запроса.",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Нет прав на выполнение запроса.

error

Type: string

Код ошибки

Example: OrganizationSettingsAccessForbidden

message

Type: string

Сообщение об ошибке.

Example: Нет прав на выполнение запроса.

details
Type: object

Дополнительные детали ошибки

Example
{}
Предыдущая
Просмотр