Просмотр параметров видеовстречи

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

Запрос

GET

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

Path-параметры

Имя параметра	Тип	Описание
`id`	`string`	Идентификатор видеовстречи

Заголовки

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

Результат

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

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

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

{
  "id": "string",
  "join_url": "string",
  "access_level": "string",
  "live_stream": {
      "watch_url": "string",
      "access_level": "string",
      "title": "string",
      "description": "string"
  },
  "sip_uri_meeting" : "string",
  "sip_uri_telemost"  : "string",
  "sip_id": "string"
}

Имя параметра	Тип	Описание
`id`	`string`	Идентификатор видеовстречи
`join_url`	`string`	Ссылка для участников, по которой можно присоединения к видеовстрече
`access_level`	`string`	Настройки ограничения доступа для видеовстречи. Возможные значения: `PUBLIC` — для всех пользователей `ORGANIZATION` — только для сотрудников `UNKNOWN` — добавлен для обеспечения обратной совместимости: все значения, которые добавятся в будущем, будут обрабатываться как `UNKNOWN`
`live_stream`	`object`	Данные о трансляции. Если видеовстреча создана без трансляции, параметр отсутствует
`live_stream.` `watch_url`	`string`	Ссылка для зрителей, по которой можно смотреть трансляцию
`live_stream.` `access_level`	`string`	Настройки ограничения доступа для трансляции. Возможные значения: `PUBLIC` — для всех пользователей `ORGANIZATION` — только для сотрудников `UNKNOWN` — добавлен для обеспечения обратной совместимости: все значения, которые добавятся в будущем, будут обрабатываться как `UNKNOWN`
`live_stream.` `title`	`string`	Название трансляции, которое отображается на странице для зрителей
`live_stream.` `description`	`string`	Описание трансляции, которое отображается на странице для зрителей
`sip_uri_meeting`	`string`	Ссылка на подключение к видеовстрече по протоколу SIP. Если в видеовстрече подключение по SIP не поддерживается, параметр отсутствует
`sip_uri_telemost`	`string`	Ссылка на подключение к голосовому меню Телемоста по протоколу SIP. Если в видеовстрече подключение по SIP не поддерживается, параметр отсутствует
`sip_id`	`string`	Идентификатор для SIP-подключения. Если в видеовстрече подключение по SIP не поддерживается, параметр отсутствует

Примеры

Видеовстреча без трансляции

Видеовстреча с трансляцией

Видеовстреча с поддержкой SIP-подключения

{
  "id": "12345678901234",
  "join_url": "https://telemost.yandex.ru/j/12345678901234",
  "access_level": "UNKNOWN"
}

{
  "id": "12345678901234",
  "join_url": "https://telemost.yandex.ru/j/12345678901234",
  "access_level": "ORGANIZATION",
  "live_stream": {
    "watch_url": "https://telemost.yandex.ru/live/123456789abcdef0123456789abcdef0",
    "access_level": "PUBLIC",
    "title": "Example conference created via API",
    "description": "Some description of example conference created via API"
  }
}

{
  "id": "12345678901234",
  "join_url": "https://telemost.yandex.ru/j/12345678901234",
  "access_level": "ORGANIZATION",
  "live_stream": {
    "watch_url": "https://telemost.yandex.ru/live/123456789abcdef0123456789abcdef0",
    "access_level": "PUBLIC",
    "title": "Example conference created via API",
    "description": "Some description of example conference created via API"
  },
  "sip_uri_meeting" : "12345678901234567890@sip.t.ya.ru",
  "sip_uri_telemost"  : "j@sip.t.ya.ru",
  "sip_id": "12345678901234567890"
}

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

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

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

Имя параметра	Тип	Описание
`error`	`string`	Код ошибки
`message`	`string`	Сообщение об ошибке
`description`	`object`	Техническое описание ошибки

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

403 Forbidden
- {"error": "ApiRestrictedToOrganizations"} — Доступ запрещен, так как вы не являетесь пользователем Яндекс 360 для бизнеса.
- {"error": "ConferenceAccessForbidden"} — У вас нет доступа к запрашиваемой видеовстрече.
404 Not Found
- {"error": "ConferenceNotFound"} — Запрошенная видеовстреча не найдена.
4xx
- Незадокументированные ошибки, например некорректный запрос, слишком большое количество запросов или проблемы с авторизацией.