My own CONFERENCE
онлайн-сервис, позволяющий проводить вебинары, различного рода тренинги и видеоконференции
Как настроить подключение
Для начала работы необходимо получить ключ API. Для этого зайдите в свой личный кабинет My own CONFERENCE, раздел Профиль:
После получения API-ключа переходим в настройки проекта в Salebot -> Константы проекта и сохраняем его в переменную myownconference_api_key:
Каждая функция возвращает словарь, у которого есть параметр status, он может иметь два значения 0 и 1.
Если значение status=1, то запрос в myownconference прошел успешно и в параметре result будет результат запроса, например: {'status': '1', 'result': [{'name': 'Super web', 'alias': 'csml-sjgf-cnjp-clkw', 'start': '2022-02-12 00:00:00'}]} или запрос в myownconference прошел успешно, но ничего не найдено: {'status': '1', 'result': []}
Если status=0 - то есть какая-то проблема и описание будет находиться в error, например: {"status":"0","error":"Webinar with alias "wenk-gjkc-teqp-nteh" not active"} {'status': '0', 'error': 'Missing required variables - email'}
Как осуществлять поиск вебинаров
Для поиска вебинаров используется функция myownconference_find_webinars(date, status), где: date - дата в формате дд.мм.гггг выбор всех вебинаров за определенный день status - значение 1 (активные или будущие вебинары), 0 - завершенные
myownconference_find_webinars() - без аргументов вернет массив всех найденных вебинаров.
Функция возвращает словарь вида: - в случае успеха: {'status': '1', 'result': [{'name': 'Super web', 'alias': 'csml-sjgf-cnjp-clkw', 'start': '2022-02-12 00:00:00'}]} - в случае ошибки, например: {"status":"0","error":"Format not supported or date is not valid. Params must be yyyy-mm-dd"}
Как проверить присутствует ли пользователь на активном вебинаре
myownconference_is_online_user(webinar_id, email) webinar_id - идентификатор вебинара, другими словами значение 'alias' из запроса при поиске вебинара email - адрес электронной почты пользователя, если не передать, то будет использоваться адрес из переменной email, если она есть.
Результат работы функции при успешном запросе: {"status":"1","result":true} - пользователь присутствует в данный момент на вебинаре {"status":"1","result":false} - пользователь не на вебинаре
В случае возникновения проблемы при выполнении запроса: {"status":"0","error":"Webinar with alias "serg-dhpq-mznf-fwcb" not active"}
Как получить данные истории пользователя по вебинару
myownconference_history_user(webinar_id, email) webinar_id - идентификатор вебинара, другими словами значение 'alias' из запроса при поиске вебинара email - адрес электронной почты пользователя - необязательный параметр, если есть адрес в переменной email, то значение будет взято из нее.
Результат работы функции при успешном запросе: в параметре 'result' будет массив с данными о пользователе: {'status': '1', 'result': ['Вася Пупкин', 'exam@gmail.com', 'ua', '12:02:45', '12:12:15', 'G', '28%']} {"status":"1","result":false} - пользователь не найден
В случае возникновения проблемы при выполнении запроса: {'status': '0', 'error': 'Missing required variables - email'} - не передан адрес электронной почты и адрес не найден в переменной email
Пример запроса и получении имени пользователя:
Как проверить есть ли пользователь в списке всех участников
myownconference_is_our_user(email) email - адрес электронной почты пользователя - необязательный параметр, если есть адрес в переменной email, то значение будет взято из нее.
Результат работы функции при успешном запросе: {"status":"1","result":true} - пользователь присутствует в Вашей базе {"status":"1","result":false} - нет такого пользователя в Вашей базе участников
В случае возникновения проблемы при выполнении запроса: {'status': '0', 'error': 'Missing required variables - email'} - не передан адрес электронной почты email и его значение не найдено в переменной email
Как создать участника
Эта функция добавляет участника вебинара в общий список всех пользователей. После успешного создания, этого пользователя уже можно зарегистрировать на какой-то вебинар (об этом ниже).
myownconference_add_user(email) email - адрес электронной почты пользователя - необязательный параметр, если есть адрес в переменной email, то значение будет взято из нее.
Результат работы функции при успешном запросе : {"status":"1","result":true} - пользователь добавлен в ваш список всех участников
В случае возникновения проблемы при выполнении запроса: {'status': '0', 'error': 'Missing required variables - email'} - не передан адрес электронной почты email и его значение не найдено в переменной email
Как зарегистрировать участника на вебинар
Для регистрации обязательно надо спрашивать у клиента email. Все остальное - по желанию.
myownconference_add_user_to_webinar(webinar_id, email) webinar_id - идентификатор вебинара, другими словами значение 'alias' из запроса при поиске вебинара email - адрес электронной почты пользователя - необязательный параметр, если есть адрес в переменной email, то значение будет взято из нее.
Результат работы функции при успешном запросе: {"status":"1","result":true} - пользователь зарегистрирован на вебинар
В случае возникновения проблемы при выполнении запроса: {"status":"0","error":"Webinar with alias \"serg-dhpq-mznf-fwcb\" not active"}
Last updated
