Link Search Menu Expand Document

Конфигурирование групп и комнат

Для каждого проекта мы рекомендцем создать отдельную группу. Это облегчит управления всеми мероприятиями.

Настройка группы (space)

Настройка группы производится при создании самой группы, либо задается методом updateSpace. В качестве параметра в строке запроса указывается идентификатор группы (см. Создание группы). Для группы можно настроить следующие атрибуты:

  • name - имя группы;
  • description - описание группы;
  • logo - логотип;
  • isPublic - deprecated функционал, в скоров времени этот атрибут будет удален.

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

В теле запроса обязательно передаются параметры name - имя редактируемой группы и isPublic: true. Полная спецификация метода приведена в Swagger.

Пример выполнения запроса updateSpace:

PUT https://moodhood-api.livedigital.space/v1/spaces/60d55c0eb9ef88ab17b0aabb, где 60d55c0eb9ef88ab17b0aabb - ID группы.

{
  "isPublic": true,
  "name": "Some test space",
  "description": "Space where my team will have all future calls",
  "logo": "https://server.com/images/someimage.png"
}

Пример кода для cURL:

{
curl --location --request PUT 'https://moodhood-api.livedigital.space/v1/spaces/60d55c0eb9ef88ab17b0aabb' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MmFiNWE4NGIwY2U2ZWUzMWIwOTk3YjMiLCJhdWQiOiJ1c2VyIiwidHlwZSI6ImFjY2Vzc1Rva2VuIiwiY0lkIjoiNjJhMDlmYzcwMmY4NmNlMzdhOTM4NmYxIiwianRpIjoiZXZ5ZlJWRWsyRGozVFFsYzF5UnBLIiwic2duIjoiYjgxMTBmOGZiNiIsImlhdCI6MTY1NTc1ODAwMiwiZXhwIjoxNjU2MzYyODAyfQ.hzXW-dHJD0TUtLY22yefmZogvSanEbb70zRo4Kku98A' \
--header 'Content-Type: application/json' \
--data-raw '{
 "isPublic": true,
 "name": "Some test space",
 "description": "Space where my team will have all future calls",
 "Logo": "https://server.com/images/png-clipart-myspace-logo.png"
}'

В результате успешного выполнения запроса для группы будут установлены новые параметры и сервер вернет код ответа 200.

Настройка комнаты (room)

Настройка комнаты производится при создании самой комнаты, либо задается методом updateRoom. В качестве параметров в строке запроса указываются идентификаторы комнаты (см. Создание комнат) и группы, в которой создана эта комната (см. Создание группы).

Для комнаты можно настроить следующие атрибуты (параметры в теле запроса):

  • name - имя комнаты;
  • isPublic - доступ к комнате (любой участник с ссылкой на комнату, может присоединиться к мероприятию или к комнате могут подключаться только пользователи из LMS, у которых есть специальная пригласительная ссылка, или зарегистрированные в livedigital и имеющие доступ к группе);
  • isScreensharingAllowed - разрешено ли демонстрировать экран во время мероприятия участникам встречи;
  • isChatAllowed - включен/выключен чат у всех пользователей;
  • isAutoRecordingAllowed - включена/выключена автоматическая запись при входе администратора в комнату;
  • isMicrophonePublishingAllowed - возможность включать/выключать микрофон участникам встречи (не администраторам);
  • isCameraPublishingAllowed - возможность включать/выключать веб-камеру участникам встречи (не администраторам);
  • isRemoteDrawingAllowed - доступна ли функция удаленного рисования на экране пользователя;
  • waitingRoomAudience - включен/выключен зал ожидания;
  • type - тип комнаты: конференция(lesson) или вебинар(webinar);
  • redirectUrl - включена/выключена переадресация после завершения встречи на заданный URL.

Возможны два типа комнат:

  • lesson - для уроков, при этом участники могут включать камеру, микрофон, демонстрацию экрана,
  • webinar - для вебинаров, когда вести аудио\видео вещание может только создатель или модератор, остальные участники могут только смотреть и слушать.

Полная спецификация метода приведена в Swagger.

Важно! Мы не рекомендуем изменять тип уже созданной комнаты. Также параметры templateId и parentRoomId не используются, их необходимо удалить при создании комнаты.

В результате выполнения запроса будут изменены настройки комнаты в соответствии с указанными параметрами.

Пример выполнения запроса updateRoom:

PUT https://moodhood-api.livedigital.space/v1/spaces/60d55c0eb9ef88ab17b0aabb/rooms/62b0e25e3dc082dc7502d273, где 60d55c0eb9ef88ab17b0aabb - ID группы (spaceId), а 62b0e25e3dc082dc7502d273 - ID комнаты (roomId).

{
  "name": "string",
  "isPublic": true,
  "isChatAllowed": true,
  "isRecordAllowed": true,
  "isScreensharingAllowed": true,
  "isAutoRecordingAllowed": false,
  "isMicrophonePublishingAllowed": true,
  "isScreenMediaPublishingAllowed": true,
  "isCameraPublishingAllowed": true,
  "isRemoteDrawingAllowed": true,
  "waitingRoomAudience": "nobody",
  "redirectUrl": "https://developer.mozilla.org/docs/Web/HTTP/Overview"
}

Пример кода для cURL

curl --location --request PUT 'https://moodhood-api.livedigital.space/v1/spaces/62b0e24a81ad6df4bb583c58/rooms/62b0e25e3dc082dc7502d273' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MmFiNWE4NGIwY2U2ZWUzMWIwOTk3YjMiLCJhdWQiOiJ1c2VyIiwidHlwZSI6ImFjY2Vzc1Rva2VuIiwiY0lkIjoiNjJhMDlmYzcwMmY4NmNlMzdhOTM4NmYxIiwianRpIjoiZXZ5ZlJWRWsyRGozVFFsYzF5UnBLIiwic2duIjoiYjgxMTBmOGZiNiIsImlhdCI6MTY1NTc1ODAwMiwiZXhwIjoxNjU2MzYyODAyfQ.hzXW-dHJD0TUtLY22yefmZogvSanEbb70zRo4Kku98A' \
--header 'Content-Type: application/json' \
--data-raw '{
 "name": "string",
 "isPublic": true,
 "isScreensharingAllowed": true,
 "isChatAllowed": true,
 "type": "lesson"
}'

В результате выполнения запроса параметры комнаты будут обновлены и от сервера вернется код ответа 200.