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

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

МЕТОД HTTP

POST

URL

https://userapi.webinar.ru/v3/events

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

  • name — название мероприятия; 
  • 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;
  • image — фон вебинара. ID файла в файловой системе, который будет использован в качестве фона;
  • type — тип мероприятия. Значения:
    - webinar — вебинары;
    - meeting — совещания.
    Чем отличаются от вебинаров можно прочитать по ссылке.
    Значение по умолчанию заявисит от настроек профиля Владельца команды. Если в разделе "Запускать быстрое меропритие в режиме Совещания" стоит галочка, то meeting. Если этого чекбокса не стоит, то webinar
  • 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

ПОЛЯ ОТВЕТА

  • eventId — идентификатор шаблона. Используется для:
    - создания вебинаров (eventSession);
    - сбора статистики по вебинару;
    - модерации участников;
    - регистрации на серийные события;
  • link — публичная ссылка на лендинг мероприятия.

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

url: https://userapi.webinar.ru/v3/events,
method: POST,
headers:
{
    x-auth-token: x-auth-token,
    Content-Type: application/x-www-form-urlencoded,
data:
{
    name: 1000 тайн вселенной
    access: 10
    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"
}
Вы нашли ответ?