Link Search Menu Expand Document

Создание, добавление и настройка автовебинара

Для формирования комнаты с типом «Автовебинар» используется метод создания сущности автовебинара в API livedigital: createPlayback. В теле запроса передается name - наименование автовебинарной комнаты и type - тип комнаты, может принимать значение webinar или conference.

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

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

POST https://moodhood-api.livedigital.space/v1/spaces/60d55c0eb9ef88ab17aabb12/playbacks, где 60d55c0eb9ef88ab17aabb12 - ID группы (space).

{
  "name": "instruction",
  "type": "webinar"
}

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

curl -X 'POST' \
  'https://moodhood-api.livedigital.space/v1/spaces/60d55c0eb9ef88ab17aabb12/playbacks' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "instruction",
  "type": "webinar",
  "joinSettingsFields": [
    {
      "slug": "email",
      "type": "email",
      "title": "Mobile Phone",
      "enabled": true,
      "required": true,
      "description": "Used as a helper in an input elements"
    }
  ],
  "joinSettingsCustomFields": [
    {
      "id": "abcdefae-7dec-11d0-a765-00a0c91eabcd",
      "type": "string",
      "title": "Favorite Color",
      "enabled": true,
      "required": true,
      "description": "Used as a helper in an input elements",
      "order": 0
    }
  ]
}'

В результате выполнения запроса будет создана комната, а её параметры, в т.ч. id, будут отражены в теле ответа. Настройка этих параметров будет производиться после добавления контента (записи), в следующем шаге.

Добавление контента (видеозаписи) в автовебинар

Для того, чтобы автовебинарная комната работала, необходимо обязательно добавить в неё запись уже прошедшей встречи на платформе livedigital. Эта запись будет воспроизводиться как автовебинар. Идентификатор (recordId) записи, который нужен в теле запроса, можно получить методом GetAroomRecord или достать из вебхука (об окончании видеозаписи). Для добавления контента используется метод PUT updatePlayback.

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

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

PUT https://moodhood-api.livedigital.space/v1/spaces/60d55c0eb9ef88ab17aabb12/playbacks/bea6ac23-d665-4f0b-a0ee-0d91f13a9eec, где 60d55c0eb9ef88ab17aabb12 - ID группы (space), а bea6ac23-d665-4f0b-a0ee-0d91f13a9eec - ID автовебинарной комнаты, который был получен в createPlayback.

{
  "recordId": "67051203d7dd5310a35ca4dd"
}

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

curl -X 'PUT' \
  'https://moodhood-api.livedigital.space/v1/spaces/60d55c0eb9ef88ab17aabb12/playbacks/abcdefae-7dec-11d0-a765-00a0c91eabcd' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "joinSettingsFields": [
    {
      "slug": "email",
      "type": "email",
      "title": "Mobile Phone",
      "enabled": true,
      "required": true,
      "description": "Used as a helper in an input elements"
    }
  ],
  "joinSettingsCustomFields": [
    {
      "id": "abcdefae-7dec-11d0-a765-00a0c91eabcd",
      "type": "string",
      "title": "Favorite Color",
      "enabled": true,
      "required": true,
      "description": "Used as a helper in an input elements",
      "order": 0
    }
  ],
  "readinessStatus": "draft",
  "recordId": "67051203d7dd5310a35ca4dd",
  "assetId": "60d55c0eb9ef88ab17aabb12",
  "duration": 15563
}'

В результате выполнения контент будет доступен для просмотра через интерфейс livedigital на вкладке «Контент».

Настройка автовебинарной комнаты

При помощи метода PUT updatePlayback настраиваем необходимые поля входа, чтобы потом корректно сформировалась аналитика по проведенному автовебинару. Настроить можно название автовебинарной комнаты, включить/выключить заполняемые пользователем поля входа (почта, номер телефона), указать обязательность заполнения этих полей:

  • slug - уникальный идентификатор поля, которое заполняет участник при входе. Может быть email или phone.
  • type - тип поля, должен соответствовать признаку slug, т.е. если slug = phone, то type = phone.
  • title - название поля входа, для slug = email необходимо указать значение admin.classrooms.email, для slug = phone укажите admin.classrooms.phone
  • enable - признак, который активирует поля входа email/phone. Может быть true или false.
  • required - делает поля обязательным для заполнения участником. Может быть true или false.

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

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

PUT https://moodhood-api.livedigital.space/v1/spaces/60d55c0eb9ef88ab17aabb12/playbacks/bea6ac23-d665-4f0b-a0ee-0d91f13a9eec, где 60d55c0eb9ef88ab17aabb12 - ID группы (space), а bea6ac23-d665-4f0b-a0ee-0d91f13a9eec - ID автовебинарной комнаты, который был получен в createPlayback.

{
  "joinSettingsFields": [
  {
   "slug": "email",
   "type": "email",
   "title": "admin.classrooms.email",
   "enabled": true,
   "required": false
  },
  {
   "slug": "phone",
   "type": "phone",
   "title": "admin.classrooms.phone",
   "enabled": true,
   "required": false
  }
 ]
}

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

curl -X 'PUT' \
  'https://moodhood-api.livedigital.space/v1/spaces/60d55c0eb9ef88ab17aabb12/playbacks/abcdefae-7dec-11d0-a765-00a0c91eabcd' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "bea6ac23-d665-4f0b-a0ee-0d91f13a9eec",
    "assetId": "67a9c2a392629c3dad7cc74b",
    "type": "webinar",
    "name": "instruction",
    "spaceId": "652d0c2f5e9d5f14bbea2528",
    "timelineId": "22c3af37-cbdd-43e4-a3ea-99cc8765de17",
    "chatApplicationId": "cb9727a9-9ec0-443a-9b0c-f02eec5e0826",
    "readinessStatus": "draft",
    "readinessStatusChangedAt": "2025-02-10T09:14:24.766Z",
    "joinSettings": {
        "fields": [
            {
                "slug": "email",
                "type": "email",
                "enabled": true,
                "required": false
            },
            {
                "slug": "phone",
                "type": "phone",
                "enabled": true,
                "required": false
            }
        ],
        "customFields": []
    }
}

Настройка расписание показа автовебинара

После создания сущности необходимо задать время проведения автовебинара (расписание). Расписание автовебинара может быть однократным, повторяющимся или постоянным. Однократное мероприятие проводится в определенное время один раз. Повторяющееся мероприятие повторяется в указанный день, время и дату. Постоянное имеет бесконечное количество повторений и каждый раз после открытия страницы с автовебинаром будет повторяться с начала. Используйте метод createPlaybackEvent для создания любого из расписаний автовебинара.

  • endDate - дата завершения (null либо в формате 2025-01-01T12:11:22.000Z)
  • name - имя автовебинара;
  • playbackId - id записи;
  • recurrence - цикличность мероприятия. Для всех мероприятий, кроме повторяющегося, рекомендуем оставлять значение null;
  • startDate - дата и время начала мероприятия в формате 2025-01-01T12:11:22.000Z

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

POST https://moodhood-api.livedigital.space/v1/spaces/60d55c0eb9ef88ab17aabb12/playback-events, где 60d55c0eb9ef88ab17aabb12 - ID группы (space).

Пример тела запроса для однократно повторяющегося автовебинара, который доступен только в определенное время:

{
endDate: null
name: "Имя автовебинара"
playbackId: "a06b59a7-8529-42f7-bb0e-52e571de3488"
recurrence: null
startDate: "2025-02-06T11:50:00.000Z"
timezone: "Europe/Moscow"
}

Пример тела запроса для постоянного вебинара, который каждый раз открывается при нажатии на ссылку:

{
endDate: null
name: "Имя автовебинара"
playbackId: "a06b59a7-8529-42f7-bb0e-52e571de3488"
recurrence: "null"
startDate: "null"
timezone: "Europe/Moscow"
}

Пример тела запроса, который повторяется в указанный день, время и дату:

{
endDate: "2025-02-10T12:28:56.651Z"
name: "Имя автовебинара"
playbackId: "a06b59a7-8529-42f7-bb0e-52e571de3488"
recurrence: "*/5 * * * *",
startDate: "2025-02-10T11:28:56.651Z"
timezone: "Europe/Moscow"
}

Пример cURL:

curl -X 'POST' \
  'https://moodhood-api.livedigital.space/v1/spaces/60d55c0eb9ef88ab17aabb12/playback-events' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "playbackId": "60d55c0eb9ef88ab17aabb12",
  "name": "string",
  "recurrence": "*/5 * * * *",
  "startDate": "2025-02-10T11:28:56.651Z",
  "endDate": "2025-02-10T11:28:56.651Z",
  "timezone": "Europe/London"
}'

Получение аналитики по проведенному автовебинару

После окончания проведения автовебинара аналитика также будет доступна, как и после завершения обычного вебинара или конференции. Аналитика забирается с помощью метода getPlaybackSessionAnalyticsReport. Получить отчёт можно в формате json или xlsx. Для получения аналитики потребуется playbackEventId и EventSessionId, узнать их можно при помощи метода getPlaybackEventSessions.

Пример выполнения https://moodhood-api.livedigital.space/v1/spaces/60d55c0eb9ef88ab17aabb12/playbacks/bea6ac23-d665-4f0b-a0ee-0d91f13a9eec/event-sessions?order=asc, где 60d55c0eb9ef88ab17aabb12 - ID группы (спейса), bea6ac23-d665-4f0b-a0ee-0d91f13a9eec - ID автовебинара (playbackId)

"id": "6d0b521b-343e-48f5-9f8d-fd9a78f0c0cb",
"playbackEventId": "79698777-e9ac-4616-9506-4691e7fedff6",
"chatApplicationId": "cb9727a9-9ec0-443a-9b0c-f02eec5e0826",
"chatChannelId": "67ab0257000aca39994d73c4",
"type": "webinar",
"startDate": "2025-02-11T07:55:00.000Z",
"endDate": "2025-02-11T07:55:36.751Z",
"mediaUrl": "https://media-assets.s3.ru-1.storage.selcloud.ru/playbacks/652d0c2f5e9d5f14bbea2528/0659ddf5-af6b-4638-833e-f00ab480bf19?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=8a82a08701174897b07fb99ccabac1fc%2F20250211%2Fru-1%2Fs3%2Faws4_request&X-Amz-Date=20250211T075503Z&X-Amz-Expires=94&X-Amz-Signature=721fce5097e9b0c5133b1dc48e931f6296787fbbdd5ee1547cab26fb995766a9&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D%220659ddf5-af6b-4638-833e-f00ab480bf19.mp4%22&x-id=GetObject",
"frequency": "oneTime",
"recurrence": null,
"timezone": "Europe/Moscow",
"uniqueParticipantsCount": 2
        }
    ],
    "total": 1

В результате получаем необходимые параметры для получения отчета: "id": "6d0b521b-343e-48f5-9f8d-fd9a78f0c0cb" и "playbackEventId": "79698777-e9ac-4616-9506-4691e7fedff6"

Теперь можно получить аналитику имея все данные.

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

GET https://moodhood-api.livedigital.space/v1/spaces/60d55c0eb9ef88ab17aabb12/analytics/playback-report?playbackEventId=79698777-e9ac-4616-9506-4691e7fedff6&playbackEventSessionId=6d0b521b-343e-48f5-9f8d-fd9a78f0c0cb&format=xlsx, где 60d55c0eb9ef88ab17aabb12 - ID группы (space), 79698777-e9ac-4616-9506-4691e7fedff6 - ID автовебинарной комнаты, 6d0b521b-343e-48f5-9f8d-fd9a78f0c0cb - ID автовебинарной сессии, xlsx или json - формат выгрузки.

В результате выполнения метода будет получен отчёт в необходимом формате: xlsx или json.

Пример cURL:

curl -X 'GET' \
  'https://moodhood-api.livedigital.space/v1/spaces/60d55c0eb9ef88ab17aabb12/analytics/playback-report?playbackEventId=79698777-e9ac-4616-9506-4691e7fedff6&playbackEventSessionId=6d0b521b-343e-48f5-9f8d-fd9a78f0c0cb&format=xlsx' \
  -H 'accept: */*'