Перейти на сайт

Создать мероприятие (Eventsession)

POST events/{EventID}/sessions

Перед тем как приступить к созданию мероприятия следует понять его техническую структуру. Мероприятие состоит из двух сущностей:

  • EventSession — собственно мероприятие (вебинар или встреча). На него приглашаются участники и ведущие, он может быть запущен и остановлен.

  • Event — техническая “оболочка” мероприятия, содержащая в себе его основные параметры: описание, файлы, настройки и правила повторения.

ВАЖНО: чтобы создать мероприятие нужно последовательно выполнить два запроса:

МЕТОД HTTP

POST

URL

https://userapi.mts-link.ru/v3/events/EventID/sessions

ОБЯЗАТЕЛЬНЫЕ ПАРАМЕТРЫ

ДОПОЛНИТЕЛЬНЫЕ ПАРАМЕТРЫ

  • name — название мероприятия;

  • accessSettings — доступ к мероприятиям. Включает в себя 3 параметра, каждый из них принимает одно значение: 0 - выключено, 1 - включено.

    - isPasswordRequired — доступ с паролем

    - isRegistrationRequired — доступ с регистрацией

    - isModerationRequired — доступ с залом ожидания

  • (Архивный способ передачи данных) access — уровень доступа к мероприятию. Значения:
    ​- 1 — свободный доступ;
    ​- 3 — свободный доступ с паролем;
    ​- 4 — регистрация;
    ​- 6 — регистрация с паролем;
    ​- 8 — регистрация с последующей ручной модерацией участников;
    ​- 10 — регистрация с последующей ручной модерацией участников и с паролем.

  • startType — тип запуска мероприятия. Значения:

    - manual — ручной запуск мероприятия;

    - autostart — автоматический запуск мероприятия в указанное время;

    - autowebinar — автовебинар.

    Без указания типа, по умолчанию используется manual.
    ​Читать подробнее.

  • description — описание мероприятия. Текстовое поле.

  • lang — язык интерфейса мероприятия. Значения:
    - RU
    - EN
    По умолчанию: язык профиля Владельца вебинара. 

  • startsAt[][] — дата/время начала мероприятия. Параметр передается в виде массива элементов:
    - date — массив из элементов: year, month, day;
    - time — массив из элементов: hour и minute;
    Значение по умолчанию: текущая дата и время;

  • timezone — часовой пояс вебинара. Передаётся в виде id, который можно получить запросом GET /timezones.
    Значение по умолчанию: 1 — UTC +3 Волгоград, Москва, Санкт-Петербург;

  • image — фон вебинара. ID файла в файловой системе, который будет использован в качестве фона. 

    settingsByModule[][] - массив настроек мероприятия. Содержит в себе массив из элементов разделенный по типу настроек и в качестве значения - массив допустимых параметров и их значений:


    Настройки мероприятия [eventsession].

  • mediaControlsShow - управлять медиа-контентом, значения: true или false.

  • allowScreensharing - показывать экран, значения: true или false.

  • allowManageFilesForGuest - добавлять файлы и управлять ими в презентере, значения: true или false.

  • allowPresentationFilesForGuest - демонстрировать файлы (только во встречах), используется вместе с параметром allowManageFilesForGuest, значения: true или false.

    Настройки выхода в эфир [conference]:

  • guestPublishMode - выход в эфир, значения: forbid (выкл), withConfirmation (с подтверждением), free (автоматически).

  • joinWithEnabledMicrophone - подключаться со включенным микрофоном, значения: true или false.

    Настройки чата [chat].

  • show - писать сообщения в чат, значения: true или false.

  • showMiniChat - отображать мини-чат, значения: true или false.

  • premoderation - пре-модерация сообщений, значения: true или false.

    Настройки модуля вопросов [question].

  • show - задавать вопросы, значения: true или false.

    Настройки списка участников [participation].

  • show - видеть список участников, значения: true или false.

ПОЛЯ ОТВЕТА

  • eventsessionId — идентификатор вебинара. Используется для регистрации на вебинары, работы с записью;

  • link — ссылка на сессию. В пользовательских сценариях не используется.

ПРИМЕР ЗАПРОСА

url: https://userapi.mts-link.ru/v3/events/{eventID}/sessions,
method: POST,
headers: 
{
    x-auth-token: {Token},
    Content-Type: application/x-www-form-urlencoded
},

ПРИМЕР ОТВЕТА

201 Created
{
  "eventSessionId": 2405055,
  "link": "https://events.webinar.ru/supportservice/2361791/session/2405055"
}
👆 На этом пока всё