Создание видеовстречи

Создает видеовстречу или трансляцию в Телемосте.

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

Запрос

POST

https://cloud-api.yandex.net/v1/telemost-api/conferences

Заголовки

Authorization: OAuth <токен>
Content-Type: application/json

Тело (JSON)

{
  "access_level": "string", //deprecated
  "waiting_room_level": "string",
  "live_stream": {
    "access_level": "string",
    "title": "string",
    "description": "string"
  },
  "cohosts": [
    {
      "email": "string"
    }
  ]
}

Поля

Имя параметра

Обязат.

Тип

Описание

Ограничения, значение по умолчанию

access_level

Нет

Deprecated — используется для обратной совместимости

string

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

Основные используемые значения:

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

waiting_room_level

Нет

string

Настройки комнаты ожидания для видеовстречи

Основные используемые значения:

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

live_stream

Нет

object

Параметры трансляции

Если параметры не указаны, трансляция не создается или не изменяется.

live_stream. access_level

Нет

string

Настройки ограничения доступа для трансляции

Основные используемые значения:

  • PUBLIC — для всех пользователей;
  • ORGANIZATION — только для сотрудников;
  • UNKNOWN — добавлен для обеспечения обратной совместимости: все значения, которые добавятся в будущем, будут обрабатываться как UNKNOWN.

live_stream. title

Нет

string

Название трансляции, которое отображается на странице для зрителей

Максимальная длина 1024.

live_stream. description

Нет

string

Описание трансляции, которое отображается на странице для зрителей

Максимальная длина 2048.

cohosts

Нет

array of object

Список соорганизаторов встречи

Максимальная длина 30 элементов.

Если параметр не указан или указан пустой список, встреча создается без соорганизаторов.

cohosts.email

Нет

string

Адрес электронной почты соорганизатора

Соорганизатором встречи может быть только пользователь с аккаунтом на Яндексе.

Примеры

Видеовстреча для всех пользователей без трансляции.

{
  "waiting_room_level": "PUBLIC",
}

Видеовстреча для сотрудников организации с трансляцией для всех пользователей.

{
  "waiting_room_level": "ADMIN",
  "live_stream": {
    "access_level": "PUBLIC",
    "title": "Example conference created via API",
    "description": "Some description of example conference created via API"
  }
}

Видеовстреча с двумя соорганизаторами для всех пользователей без трансляции.

{
  "waiting_room_level": "PUBLIC",
  "cohosts": [
    {
      "email": "user1@yandex.ru"
    },
    {
      "email": "user2@org-domain.ru"
    }
  ]
}

Результат

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

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

201 Created — запрос выполнен успешно:

{
  "id": "string",
  "join_url": "string",
  "live_stream": {
      "watch_url": "string"
  }
}

Имя параметра

Тип

Описание

id

string

Идентификатор видеовстречи

join_url

string

Ссылка для участников, по которой можно присоединения к видеовстрече

live_stream

object

Данные о трансляции. Если видеовстреча создана без трансляции, параметр отсутствует

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",
  "details": "object"
}

Имя параметра

Тип

Описание

error

string

Код ошибки

message

string

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

description

object

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

details

object

[Опциональный параметр] Дополнительная информация об ошибке

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

  • 402 Payment Required

    • {"error": "PaymentRequiredToUseLiveStreams"} — трансляция не предусмотрена вашим тарифным планом.

  • 403 Forbidden

    • {"error": "ApiRestrictedToOrganizations"} — доступ запрещен, так как вы не являетесь пользователем Яндекс 360 для бизнеса или ваш аккаунт зарегистрирован не на домене организации.

  • 404 Not Found

    • {"error": "NoSuchUserPrincipalsFound", "details": {"emails": "неверный_адрес1;неверный_адрес_;..."}} — некоторые из переданных электронных адресов соорганизаторов не принадлежат пользователям с аккаунтами на Яндексе, некорректные адреса перечислены в поле details.emails через ;.

  • 4xx

    • незадокументированные ошибки, например некорректный запрос, слишком большое количество запросов или проблемы с авторизацией.
Предыдущая
Доступ к API
Следующая
Просмотр информации