Як налаштувати з'єднання

Спочатку потрібно отримати 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"}