Обновление списка соорганизаторов видеовстречи
Перезаписывает список соорганизаторов видеовстречи. Все текущие соорганизаторы перестают ими быть, вместо них соорганизаторами становятся пользователи из нового списка.
С помощью этого метода можно удалить всех соорганизаторов встречи, даже если вам неизвестны их электронные адреса. Для этого отправьте в теле запроса пустой список.
Чтобы выполнить запрос, приложению требуется разрешение telemost-api:conferences.update
.
Запрос
PUT
https://cloud-api.yandex.net/v1/telemost-api/conferences/{id}/cohosts
Path-параметры
Имя параметра |
Тип |
Описание |
|
|
Идентификатор видеовстречи |
Заголовки
Authorization: OAuth <токен>
Content-Type: application/json
Тело (JSON)
{
"cohosts": [
{
"email": "string"
}
]
}
Поля
Имя параметра |
Обязат. |
Тип |
Описание |
Ограничения, значение по умолчанию |
|
Нет |
|
Список соорганизаторов встречи |
Максимальная длина 30 элементов. Если параметр не указан или указан пустой список, встреча создается без соорганизаторов. |
|
Нет |
|
Адрес электронной почты соорганизатора |
Соорганизатором встречи может быть только пользователь с аккаунтом на Яндексе. |
Примеры
{
"cohosts": [
{
"email": "user@domain.ru"
}
]
}
{
"cohosts": []
}
Результат
Успешный ответ
Результатом успешного запроса является ответ с кодом 204.
204 No Content
— запрос выполнен успешно.
Ответ с ошибкой
В случае ошибки возвращается сообщение следующего содержания:
{
"error": "string",
"message": "string",
"description": "string",
"details": "object"
}
Имя параметра |
Тип |
Описание |
|
|
Код ошибки |
|
|
Сообщение об ошибке |
|
|
Техническое описание ошибки |
|
|
[Опциональный параметр] Дополнительная информация об ошибке |
Ошибки могут быть со следующими HTTP-статусами:
-
403 Forbidden
{"error": "ApiRestrictedToOrganizations"}
— доступ запрещен, так как вы не являетесь пользователем Яндекс 360 для бизнеса или ваш аккаунт зарегистрирован не на домене организации.{"error": "ConferenceAccessForbidden"}
— у вас нет доступа к запрашиваемой видеовстрече.
-
404 Not Found
{"error": "ConferenceNotFound"}
— Запрошенная видеовстреча не найдена.{"error": "NoSuchUserPrincipalsFound", "details": {"emails": "неверный_адрес1;неверный_адрес2;..."}}
— некоторые из переданных электронных адресов соорганизаторов не принадлежат пользователям с аккаунтами на Яндексе, некорректные адреса перечислены в полеdetails.emails
через;
.
-
4xx
- незадокументированные ошибки, например некорректный запрос, слишком большое количество запросов или проблемы с авторизацией.