Запросом можно регистрировать участника так, словно он регистрируются самостоятельно.
Если Email ранее регистрировался, то новые данные будут проигнорированы. Использоваться будут существующие данные.
МЕТОД HTTP
POST
URL
https://userapi.webinar.ru/v3/eventsessions/{eventsessionID}/register
ОБЯЗАТЕЛЬНЫЕ ПАРАМЕТРЫ
- email — электронная почта участника.
ДОПОЛНИТЕЛЬНЫЕ ПАРАМЕТРЫ
- name — имя участника;
- secondName — фамилия участника;
- additionalFields[{Field_Key}] — значение дополнительного поля.
Какого именно поля определяется Field_Key — ключом поля.
Получить ключ можно запросом GET /eventsessions/{eventsessionID}. - nickname — имя в чате. Никнейм пользователя, который будут видеть другие участники, когда он будет писать в чате.
По умолчанию: "name secondName"; - role — роль участника на этом мероприятии. Значения:
- ADMIN
- LECTURER
- GUEST
Подробнее о ролях.
По умолчанию: GUEST. - isAutoEnter — автовход в вебинар.
Флаг определяет что будет происходить после запуска вебинара: участник попадет в комнату автоматически или должен будет ввести свое имя в чате и нажать "ПОДКЛЮЧИТЬСЯ". Значения:
- true — автовход в вебинар сразу после его начала;
- false — вывод формы "Как к Вам обращаться в чате" сразу после начала вебинара.
По умолчанию: false; - sendEmail — рассылка писем с платформы Webinar.ru.
Флаг определяет отправку письма "Вы зарегистрированы на вебинар". Значения:
- true — письмо будет оправлено;
- false — письмо отправлено не будет.
По умолчанию: true; - avatar — фото участника. URL картинки, который будет использован в качестве аватара;
- pattrName — отчество участника. Будет доступно в разделе Люди;
- description — описание к карточке пользователя. Будет доступно в разделе Люди;
- organization — организация участника. Будет доступно в разделе Люди;
- position — должность участника. Будет доступно в разделе Люди;
- sex — пол участника. Будет доступно в разделе Люди.
ПОЛЯ ОТВЕТА
- participationId — ID участника. Используется для получения статистики и изменений роли в мероприятии;
- link — уникальная ссылка для входа в вебинар;
- contactId — ID этого контакта из раздела Люди. Возвращается только в случае, если Email ранее не был зарегистрирован на мероприятия организации.
ПРИМЕР ЗАПРОСА
url: https://userapi.webinar.ru/v3/eventsessions/{eventsessionID}/register,
method: POST,
headers:
{
x-auth-token: {Token},
Content-Type: application/x-www-form-urlencoded
},
data:
{
email: i.ivanov@weinar.ru,
secondName: Иванов,
name: Иван,
additionalFields[{Field_Key1}]: Петрович,
additionalFields[{Field_Key2}]: От друзей и знакомых,
nickname: Ваня из отдела продаж,
role: GUEST,
isAutoEnter: true,
sendEmail: false,
avatar: https://events-storage.webinar.ru/api-storage/224x199/files/webinar/2019/03/29/K9YNmaAbdTmN4g5G6GT2Usx3zkDlGhYxRD5RLtGnm2VO1ocM.jpg"
}
};
ПРИМЕР ОТВЕТА
{
participationId: 62522169,
link: https://events.webinar.ru/supportservice/2356695/97683fed47e6f1cfbe325664bfce94c23,
contactId: 48584027
}