Изменение параметров видеовстречи
Изменяет параметры видеовстречи или трансляции.
Чтобы выполнить запрос, приложению требуется разрешение telemost-api:conferences.update.
Запрос
PATCH
https://cloud-api.yandex.net/v1/telemost-api/conferences/{id}
Path-параметры
|
Имя параметра |
Тип |
Описание |
|
|
|
Идентификатор видеовстречи |
Заголовки
Authorization: OAuth <токен>
Content-Type: application/json
Тело (JSON)
{
"access_level": "string",
"live_stream": {
"access_level": "string",
"title": "string",
"description": "string"
}
}
Поля
|
Имя параметра |
Обязат. |
Тип |
Описание |
Ограничения, значение по умолчанию |
|
|
Нет |
|
Настройки ограничения доступа для видеовстречи |
Возможные значения:
|
|
|
Нет |
|
Параметры трансляции |
Если параметры не указаны, трансляция не создается или не изменяется. |
|
|
Нет |
|
Настройки ограничения доступа для трансляции |
Возможные значения:
|
|
|
Нет |
|
Название трансляции, которое отображается на странице для зрителей |
Максимальная длина 1024. |
|
|
Нет |
|
Описание трансляции, которое отображается на странице для зрителей |
Максимальная длина 2048. |
Примеры
Добавляет к текущей видеовстрече трансляцию или изменяет параметры трансляции, если она уже была добавлена:
{
"live_stream": {
"access_level": "PUBLIC",
"title": "Example conference created via API",
"description": "Some description of example conference created via API"
}
}
Только сотрудники организации смогут принять участие в видеовстрече или просмотреть ее трансляцию:
{
"access_level": "ORGANIZATION",
"live_stream": {
"access_level": "ORGANIZATION"
}
}
Только сотрудники организации смогут принять участие в видеовстрече, изменений в доступе зрителей не произойдет:
{
"access_level": "ORGANIZATION"
}
Результат
Успешный ответ
Результатом успешного запроса является ответ с кодом 200 и телом с JSON, где содержится информация о видеовстрече.
200 OK — запрос выполнен успешно:
{
"id": "string",
"join_url": "string",
"live_stream": {
"watch_url": "string"
}
}
|
Имя параметра |
Тип |
Описание |
|
|
|
Идентификатор видеовстречи |
|
|
|
Ссылка для участников, по которой можно присоединения к видеовстрече |
|
|
|
Данные о трансляции. Если видеовстреча создана без трансляции, параметр отсутствует |
|
|
|
Ссылка для зрителей, по которой можно смотреть трансляцию |
Примеры
{
"id": "12345678901234",
"join_url": "https://telemost.yandex.ru/j/12345678901234"
}
{
"id": "12345678901234",
"join_url": "https://telemost.yandex.ru/j/12345678901234",
"live_stream": {
"watch_url": "https://telemost.yandex.ru/live/123456789abcdef0123456789abcdef0"
}
}
Ответ с ошибкой
В случае ошибки возвращается сообщение следующего содержания:
{
"error": "string",
"message": "string",
"description": "string"
}
|
Имя параметра |
Тип |
Описание |
|
|
|
Код ошибки |
|
|
|
Сообщение об ошибке |
|
|
|
Техническое описание ошибки |
Ошибки могут быть со следующими HTTP-статусами:
-
402 Payment Required
{"error": "PaymentRequiredToUseLiveStreams"}— Трансляция не предусмотрена вашим тарифным планом.
-
403 Forbidden
{"error": "ApiRestrictedToOrganizations"}— Доступ запрещен, так как вы не являетесь пользователем Яндекс 360 для бизнеса.{"error": "ConferenceAccessForbidden"}— У вас нет доступа к запрашиваемой видеовстрече.
-
404 Not Found
{"error": "ConferenceNotFound"}— Запрошенная видеовстреча не найдена.
-
4xx
- Незадокументированные ошибки, например некорректный запрос, слишком большое количество запросов или проблемы с авторизацией.