Как настроить подключение

Сначала необходимо получить API-ключ. Вы можете найти его в разделе Профиль в вашем личном кабинете на MyOwnConference

После копирования ключа откройте Настройки -> Константы проекта в Mavibot и вставьте его в переменную 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'}]}

или запрос выполнен успешно, но ничего не найдено:

{'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 из переменной 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 из переменной email, если она существует

Результат в случае успеха:

В параметре result будет массив с данными пользователя

{'status': '1', 'result': ['John Smith', '[email protected]', 'ua', '12:02:45', '12:12:15', 'G', '28%']} {"status":"1","result":false} - пользователь не найден

В случае неудачи:

{'status': '0', 'error': 'Missing required variables - email'} - email не был передан и не найден в переменной email

Пример запроса и получения имени пользователя:

Пример запроса для получения истории пользователя

Пример результата запроса

Как проверить, есть ли пользователь в списке всех участников

Функция myownconference_is_our_user(email), где:

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 из переменной 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 из переменной email, если она существует

Результат в случае успеха:

{"status":"1","result":true} - пользователь зарегистрирован на вебинар

В случае неудачи:

{"status":"0","error":"Webinar with alias "serg-dhpq-mznf-fwcb" not active"}