Создать шаблон (Event)
Перед тем как приступить к созданию мероприятия следует понять его техническую структуру. Мероприятие состоит из двух сущностей:
EventSession — собственно мероприятие (вебинар или встреча). На него приглашаются участники и ведущие, он может быть запущен и остановлен.
Event — техническая “оболочка” мероприятия, содержащая в себе его основные параметры: описание, файлы, настройки и правила повторения.
ВАЖНО: чтобы создать мероприятие нужно последовательно выполнить два запроса:
МЕТОД HTTP
POST
URL
https://userapi.mts-link.ru/v3/events
ОБЯЗАТЕЛЬНЫЕ ПАРАМЕТРЫ
name — название мероприятия;
accessSettings — доступ к мероприятиям. Массив, включает в себя 3 параметра, каждый из них принимает одно значение: 0 - выключено, 1 - включено.
- isPasswordRequired — доступ с паролем
- isRegistrationRequired — доступ с регистрацией
- isModerationRequired — доступ с залом ожидания
ДОПОЛНИТЕЛЬНЫЕ ПАРАМЕТРЫ
(Архивный способ передачи данных) access — уровень доступа к мероприятию. Значения:
- 1 — свободный доступ;
- 3 — свободный доступ с паролем;
- 4 — регистрация;
- 6 — регистрация с паролем;
- 8 — регистрация с последующей ручной модерацией участников;
- 10 — регистрация с последующей ручной модерацией участников и с паролем.password — пароль для входа на мероприятие;
description — описание мероприятия. Текстовое поле. Отсутствует разметка или верстка;
additionalFields[][] — регистрационное поле. Передается в виде массива полей.
- label — название поля;
- type — тип поля. Может быть:
- text — текстовое поле;
- radio — поле с заданными значениями;
- values — массив вариантов ответа;
- placeholder — значение по умолчанию;rule — [Обязательно для серии] правило генерации дат повторения событий в серийном мероприятии.
Примеры значений:
- FREQ=DAILY — eжедневное повторение;
- FREQ=WEEKLY;INTERVAL=2 — повторять каждые две недели;
- FREQ=MONTHLY — повторять каждый месяц;
- FREQ=WEEKLY;BYDAY=TU,TH,SA;INTERVAL=3 — повторять по вторникам, четвергам и субботам каждые три недели.
Подробнее про формат;isEventRegAllowed — [Обязательно для серии] правило регистрации на серию. Значения:
- true — регистрация осуществляется на всю серию (Event) мероприятий;
- false — регистрироваться нужно на каждое отдельное мероприятие (EventSession);startsAt[][] — дата/время начала мероприятия. Параметр передается в виде массива элементов:
- date — массив из элементов: year, month, day;
- time — массив из элементов: hour и minute;
Значение по умолчанию: текущая дата и время.endsAt[][] — [Обязательно для серии] дата/время завершения серии мероприятий. Параметр передается в виде массива элементов:
- date — массив из элементов: year, month, day;
- time — массив из элементов: hour и minute;timezone — часовой пояс вебинара. Передаётся в виде id, который можно получить запросом GET /timezones.
Значение по умолчанию: 1 — UTC +3 Волгоград, Москва, Санкт-Петербург;image — фон вебинара. ID файла в файловой системе, который будет использован в качестве фона;
type — тип мероприятия. Значения:
- webinar — вебинары;
- meeting — встречи;- training — тренинги;
*Значение по умолчанию: webinar.
Рекомендуется всегда передавать в явном виде тип мероприятий.
Также можно создать бесконечную встречу, для этого передается флаг isEndless. Значения:
- 1 — бесконечная встреча. При этом, обязательно нужно передавать тип мероприятия - встреча (type=meeting);
- 0 — обычная встреча;
Подробнее про формат бесконечной встречи.lang — язык интерфейса мероприятия. Значения:
- RU
- EN
По умолчанию: язык профиля Владельца вебинара;urlAlias — замена названия вебинара в ссылке. Заменяет eventID в ссылке на вебинар;
lectorIds[] — ведущий на лендинге. Добавляет иконку с фото и данными ведущего. Передается как массив userID сотрудников организации.
Добавить лекторов, не состоящих в организации нельзя;tags[] — теги мероприятия. Массив тегов, которые будут добавлены к мероприятию;
duration — длительность мероприятия. Меняет значение "Продолжительность" на лендинге, но не определяет фактическое время завершения. Значение данного поля должно подпадать под регулярное выражение. Примеры значений:
- PT0H30M0S — 30 минут;
- PT1H0M0S — 1 час;
- PT1H30M0S — 1 час 30 минут;
Более подробно ознакомиться с форматом можно по ссылке;ownerId — владелец мероприятия. UserID сотрудника организации.
По умолчанию: создатель организации.defaultRemindersEnabled — стандартные напоминания. Включает/отключает набор стандартных напоминаний. Значения:
- true - включить напоминания за 1 день и за 15 минут;
- false - выключить напоминания за 1 день и за 15 минут;
По умолчанию: true.brandingId— выбрать шаблон брендирования для мероприятия. Указывается идентификатор шаблона. Получить идентификаторы можно с помощью запроса GET /brandings. О том, что такое "шаблоны брендирования" можно почитать по ссылке.
ПОЛЯ ОТВЕТА
eventId — идентификатор шаблона. Используется для:
- создания вебинаров (eventSession);
- сбора статистики по вебинару;
- модерации участников;
- регистрации на серийные события;link — публичная ссылка на лендинг мероприятия.
ПРИМЕР ЗАПРОСА
url: https://userapi.mts-link.ru/v3/events,
method: POST,
headers:
{
x-auth-token: x-auth-token,
Content-Type: application/x-www-form-urlencoded,
data:
{
name: 1000 тайн вселенной
accessSettings[isPasswordRequired]: 1
accessSettings[isModerationRequired]: 1
accessSettings[isRegistrationRequired]: 1
startsAt[date][year]: 2022
startsAt[date][month]: 1
startsAt[date][day]: 1
startsAt[time][hour]: 12
startsAt[time][minute]: 0
additionalFields[0][label]: Ваше отчество
additionalFields[0][type]: text
additionalFields[1][label]: Откуда вы о нас узнали?
additionalFields[1][type]: radio
additionalFields[1][values][0]: От друзей и знакомых
additionalFields[1][values][1]: От коллег и партнеров по работе
additionalFields[1][values][2]: Из социальных сетей
lectorIds[0]:1029
}
}
ПРИМЕР ОТВЕТА
201 Created
{
"eventId": 2356695,
"link": "https://events.webinar.ru/supportservice/2356695"
}