Функции калькулятора для курсов
Регистрация на курс
register_customer_on_course(tariff_id, email, email_notification, period, reregistration)
! tariff_id
обязательный параметр, ID тарифного плана. Вы можете скопировать его в строке браузера в настройках тарифного плана.
обязательный параметр, адрес электронной почты клиента. Вы можете указать конкретное значение или переменную, в которой записан email клиента.
email_notification
необязательный параметр, отправляет студенту email-сообщение о его регистрации на курс, если он включен.
period
необязательный параметр, ограничение по времени действия тарифного плана. Поддерживаются следующие форматы даты: %d.%m.%Y %H:%M или %d.%m.%Y Пример:
period = '15.08.2023 11:00'
reregistration
необязательный параметр, со значениями True или False. Этот параметр необязателен и указывается, если нужно повторно зарегистрировать студентов на тот же курс и тарифный план.
purchase_price
необязательный параметр. Позволяет указать стоимость курса, если клиент оплатил доступ к нему через бота. Если вы не укажете его, будет использована стоимость указанного тарифного плана. Это будет полезно, если клиент оплачивает доступ к курсу через бота по цене, отличающейся от стоимости указанного тарифного плана.
Пример: register_customer_on_course(123, email, 1, "", True)
Чтобы клиенты получали письма, передайте 1 в параметр email_notification.
Если вы не передадите 1, письма клиента не будут получены!
Как предоставить доступ к курсу через Telegram Web App?
Для этого укажите функцию в Блоке Калькулятор
access_course_from_webapp(text, button_label)
Во время использования функции студент авторизуется в Telegram и получает доступ к курсу. Для дальнейшего обучения студенту не нужно вводить логин и пароль, так как авторизация уже выполнена.
Параметры функции:
text - это текст сообщения, которое получит клиент. Параметр можно указать в переменной, записав его в поле Калькулятора до вызова функции, либо указать в самой функции в кавычках.
button_label - это текст на кнопке Web App. Вы можете указать параметр либо в переменной, либо в самой функции. Во втором случае параметр записывается в кавычках.
Актуально ТОЛЬКО для работы с Telegram-ботом.
На скриншоте ниже показан пример использования функции.
На первом шаге мы регистрируем клиента на курс, затем используем функцию access_course_com_webapp, чтобы предоставить доступ к онлайн-продукту.
Результат выполнения функции:
Эта кнопка открывает страницу с курсами/тарифами, которые есть у студента.
Если клиент не связан с аккаунтом студента, функция возвращает 'client not attached to customer'.
Чтобы создать такую связь, нужно просто записаться на курс через бота.
Как выдать доступ к курсу через бота
register_customer_on_course()
Для этого укажите функцию в Блоке Калькулятор
register_customer_on_course(tariff_id, email, email_notification, period)
! tariff_id - ID тарифного плана. Вы можете скопировать его в строке браузера в настройках тарифного плана.
email_notification - Этот параметр отправляет студенту email-сообщение о его регистрации на курс, если он включен.
! email - адрес электронной почты клиента. Вы можете указать конкретное значение или переменную, в которой записан email клиента.
period - ограничение по времени действия тарифного плана. Поддерживаются следующие форматы даты: %d.%m.%Y %H:%M или %d.%m.%Y Пример:
period = '15.08.2023 11:00'
Чтобы клиенты получали письма, нужно передать 1 в параметр email_notification.
Если вы не передадите 1, то письма клиента не будут получены!
Присвойте функцию переменной.
После выполнения в переменную будет записан один из ответов:
клиент уже на тарифе - если тарифный план уже есть или доступ закрыт вручную
wrong_tariff_id - указан неверный id
tariff_added - тарифный план был добавлен студенту
Пример:
Как проверить наличие доступа к курсу
has_customer_tariff(tariff_id)
Для этого укажите функцию в Блоке Калькулятор has_customer_tariff(tariff_id, email)
! tariff_id - ID тарифного плана. Вы можете скопировать его в строке браузера в настройках тарифного плана или в разделе Тарифные планы.
email - необязательный параметр. Передайте этот параметр, чтобы проверить, записан ли клиент на курс с указанным адресом электронной почты.
После выполнения функция возвращает True или False.
Возможные ответы функции в случае ошибок:
wrong tariff_id - передано неверное значение tariff_id
customer not found - пользователь не зарегистрирован как студент.
Как зарегистрировать клиента на платформе БЕЗ предоставления доступа к курсу
register_customer(email)
Для этого укажите функцию в Блоке Калькулятор register_customer(email)
адрес электронной почты клиента.
Вы можете указать переменную в функции или значения параметров. Чтобы указать переменную, напишите ее имя без кавычек и синтаксических символов, решеток и фигурных скобок. Чтобы указать конкретное значение, укажите адрес электронной почты клиента в кавычках.
Рекомендуется присвоить функции переменную, чтобы вы могли видеть результат выполнения функции и работать с ним. Пример на скриншоте ниже: имя переменной задается перед знаком равно, далее идут функция и параметр в скобках.
После успешного выполнения функции в переменную будет записан ответ: customer created
Как проверить доступ к курсу и временные ограничения?
Для этого укажите функцию в Блоке Калькулятор has_customer_tariff_with_date(tariff_id, email), чтобы проверить наличие доступа к курсу по email (возвращает подробный ответ о наличии доступа и временных ограничениях).
Параметры функции:
! tariff_id - ID тарифного плана. Вы можете скопировать его в строке браузера в настройках тарифного плана или в разделе Тарифные планы.
email - необязательный параметр.
Ответ будет:
студент записан и есть ограничение по времени доступа: Доступ есть до 2023-09-28 22:00:00
студент записан, ограничений нет: Доступ без ограничений по времени
студент не записан: Нет доступа к этому тарифу
Возможные ответы функции в случае ошибок:
wrong tariff_id - передано неверное значение tariff_id
customer not found -пользователь не зарегистрирован как студент.
Как удалить доступ к курсу студента через бота
del_customer_from_course(course_id, email)
Для этого укажите функцию в Блоке Калькулятор del_customer_from_course(course_id, email)
! tariff_id
ID тарифного плана
адрес электронной почты клиента
Как проверить, посетил ли студент вебинар
customer_was_on_translation()
Доступ к курсу нужно предоставить в боте.
Для этого есть функция register_customer_on_course() и access_course_from_webapp()
Чтобы проверить, посещал студент вебинар или нет, укажите функцию в Блоке Калькулятор customer_was_on_translation(translation_guid, email, after_start_time)
! translation_guid - ID трансляции. Скопируйте значение поля
Название находится в ссылке настроек трансляции
after_start_time - время начала трансляции в формате: '2023-04-18 13:30:00'.
! email - адрес электронной почты студента
Обратите внимание! Имя переменной может быть любым, удобным и понятным вам. В случае ошибки в написании параметров функции в переменную будет записано сообщение: wrong translation_guid
В этом случае рекомендуем проверить параметры функции и протестировать их еще раз. Чтобы получить значение длительности пребывания на вебинаре из переменной в Калькуляторе, можно воспользоваться функцией работы с массивами и словарями. ссылка/ссылка массивами и словарями.
Пример настроек в Блоке Калькулятор:
time_spent1 = answer2[0]['time_spent']
Как найти имя студента, привязанное к боту?
Бывают случаи, когда студенты могут быть привязаны к онлайн-чату личного кабинета студента, а также те, кто привязан к мессенджеру и пишет вашим менеджерам через бота. Чтобы корректно выдавать именные сертификаты о прохождении курса в боте и не искать имя студента в списке, есть функция:
get_customer_name() - возвращает имя студента, связанного с клиентом.
Функция без параметров.
Возвращает имя студента, которое студент указал при регистрации на курс, или имя студента из его личного кабинета.
Последнее обновление