Просмотр списка соорганизаторов видеовстречи

Получает данные о соорганизаторах видеовстречи.

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

Запрос

GET

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

Path-параметры

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

Тип

Описание

id

string

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

Query-параметры

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

Тип

Описание

offset

int

[Опциональный параметр] Сдвиг начала чтения списка.

Минимальное значение: 0. Значение по умолчанию: 0.

limit

int

[Опциональный параметр] Количество элементов для чтения.

Минимальное значение: 1. Максимальное значение: 256. Значение по умолчанию: 50.

Заголовки

Authorization: OAuth <токен>

Результат

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

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

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

{
  "cohosts": [
    {
      "email": "string"
    }
  ]
}

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

Тип

Описание

cohosts

array of object

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

cohosts.email

string

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

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

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

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

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

Тип

Описание

error

string

Код ошибки

message

string

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

description

object

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

details

object

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

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

  • 403 Forbidden

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

    • {"error": "ConferenceNotFound"} — запрошенная видеовстреча не найдена.
  • 4xx

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