Добавление соорганизаторов к видеовстрече

Добавляет пользователей в список соорганизаторов видеовстречи.

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

Запрос

PATCH

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

Path-параметры

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

Тип

Описание

id

string

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

Заголовки

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

Тело (JSON)

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

Поля

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

Обязат.

Тип

Описание

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

cohosts

Нет

array of object

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

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

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

cohosts.email

Нет

string

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

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

Пример

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

Результат

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

Результатом успешного запроса является ответ с кодом 204.

204 No Content — запрос выполнен успешно.

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

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

{
  "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"} — Запрошенная видеовстреча не найдена.
    • {"error": "NoSuchUserPrincipalsFound", "details": {"emails": "неверный_адрес1;неверный_адрес2;..."}} — некоторые из переданных электронных адресов соорганизаторов не принадлежат пользователям с аккаунтами на Яндексе, некорректные адреса перечислены в поле details.emails через ;.
  • 4xx

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