Регистрация на курс

register_customer_on_course(tariff_id, email, email_notification, period, reregistration)

Пример: register_customer_on_course(123, email, 1, "", True)

Чтобы клиенты получали email-письма, передайте 1 в параметр email_notification.

Если вы не отправите 1, то клиент не будет получать email-письма!

Как предоставить доступ к курсу через 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'

Чтобы клиенты получали email-письма, необходимо передать 1 в параметр email_notification.

Если вы не отправите 1, то клиент не будет получать email-письма!**

Присвойте функцию переменной.

После выполнения в переменную будет записан один из ответов:

customer is already on tariff - если есть тарифный план или доступ вручную закрыт

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)

Параметры функции Описание
! 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 тарифного плана
! email адрес электронной почты клиента

Как проверить, присутствовал ли студент на вебинаре

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() - возвращает имя студента, привязанного к клиенту.

Функция без параметров.

Возвращает имя студента, которое студент ввёл при регистрации на курс, или имя студента из его личного кабинета.