Zenler (независимый издатель) (предварительная версия)

Zenler — это единый курс создания, доставки и маркетинговой платформы.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Трой Тейлор
URL https://www.hitachisolutions.com
Адрес электронной почты ttaylor@hitachisolutions.com
Метаданные соединителя
Publisher Трой Тейлор
Веб-сайт https://www.newzenler.com/
Политика конфиденциальности https://www.newzenler.com/privacy-policy
Категории Управление бизнесом

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:
По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Ключ API securestring Ключ API для этого API True
Имя учетной записи securestring Имя учетной записи для этого API True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Добавление пользователя

Создает нового пользователя.
Обновление пользователя

Обновляет сведения пользователя.
Отмена подписки на воронку

Отменяет подписку пользователя из воронки.
Отмена регистрации для вебинара

Отмена регистрации пользователя для динамического вебинара.
Отмена регистрации для класса

Отмена регистрации пользователя для динамического класса.
Отмена регистрации пользователя

Отменяет регистрацию пользователя из курса.
Подписка на воронку

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

Извлекает список воронок.
Получение краткого отчета о продажах

Извлекает краткий отчет о продажах.
Получение краткого отчета о филиалах

Получает краткий отчет о филиалах.
Получение краткого отчета о ходе выполнения курса

Получает краткий отчет о ходе выполнения.
Получение курса

Извлекает курс по идентификатору курса.
Получение отчета о краткой регистрации

Извлекает краткий список регистраций.
Получение подробного отчета о продажах

Извлекает подробный отчет о продажах.
Получение подробного отчета о регистрации

Извлекает подробный список регистраций.
Получение подробного отчета о ходе выполнения курса

Извлекает подробный отчет о ходе выполнения.
Получение подробных отчетов о филиалах

Получает подробный отчет о филиалах.
Получение предстоящих вебинаров

Получение списка предстоящих трансляций вебинаров.
Получение предстоящих классов

Извлекает список предстоящих динамических классов.
Получение регистраций для воронки

Извлекает список регистраций для воронки.
Получение сведений о пользователе

Получение сведений о пользователе.
Получение списка курсов

Извлекает список курсов.
Получение списка пользователей

Извлекает список пользователей.
Регистрация для вебинара

Зарегистрируйте пользователя для динамического вебинара.
Регистрация для класса

Зарегистрируйте пользователя для динамического класса.
Регистрация пользователя

Регистрирует пользователя в курс.
Удаление пользователя

Удалите пользователя из учетной записи.

Добавление пользователя

Идентификатор операции:
UserPost

Создает нового пользователя.

Параметры

Имя Ключ Обязательно Тип Описание
Имя (Первое имя)
 first_name True string

Первое имя.
Фамилия
 last_name True string

Фамилия.
Адрес электронной почты
 email True string

Адрес электронной почты.
Пароль
 password True string

Пароль.
Комиссия
 commission True integer

Комиссия.
Роли
 roles True string

Роли.
Address
 address string

Адрес.
Город
 city string

Город.
Государство
 state string

Государство.
Телефон
 phone string

Номер телефона.
Почтовый индекс
 zip_code integer

Почтовый индекс.
Страна
 country string

Страна.
Состояние согласия GDPR
 gdpr_consent_status integer

Состояние согласия GDPR.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Идентификатор
 data.id string

Идентификатор.
Имя (Первое имя)
 data.first_name string

Первое имя.
Фамилия
 data.last_name string

Фамилия.
Адрес электронной почты
 data.email string

Адрес электронной почты.

Обновление пользователя

Идентификатор операции:
UserPut

Обновляет сведения пользователя.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пользователя
 user_id True string

Идентификатор пользователя.
Имя (Первое имя)
 first_name True string

Первое имя.
Фамилия
 last_name True string

Фамилия.
Адрес электронной почты
 email True string

Адрес электронной почты.
Пароль
 password True string

Пароль.
Комиссия
 commission True integer

Комиссия.
Роли
 roles True string

Роли.
Address
 address string

Адрес.
Город
 city string

Город.
Государство
 state string

Государство.
Телефон
 phone string

Номер телефона.
Почтовый индекс
 zip_code integer

Почтовый индекс.
Страна
 country string

Страна.
Состояние согласия GDPR
 gdpr_consent_status integer

Состояние согласия GDPR.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Message
 data.message string

Сообщение.

Отмена подписки на воронку

Идентификатор операции:
FunnelUnsubscribe

Отменяет подписку пользователя из воронки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор воронки
 funnel_id True string

Идентификатор воронки.
Адрес электронной почты
 email string

Сообщение электронной почты.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Данные
 data string

Данные.

Отмена регистрации для вебинара

Идентификатор операции:
WebinarUnregister

Отмена регистрации пользователя для динамического вебинара.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор вебинара
 webinar_id True string

Идентификатор вебинара.
Адрес электронной почты
 email True string

Адрес электронной почты.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Данные
 data string

Данные.

Отмена регистрации для класса

Идентификатор операции:
ClassUnregister

Отмена регистрации пользователя для динамического класса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор динамического класса
 liveclass_id True string

Идентификатор динамического класса.
Адрес электронной почты
 email string

Сообщение электронной почты.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Данные
 data string

Данные.

Отмена регистрации пользователя

Идентификатор операции:
UserUnenroll

Отменяет регистрацию пользователя из курса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пользователя
 user_id True string

Идентификатор пользователя.
Идентификатор курса
 course_id True string

Идентификатор курса.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Message
 data.message string

Сообщение.

Подписка на воронку

Идентификатор операции:
FunnelSubscribe

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор воронки
 funnel_id True string

Идентификатор воронки.
Имя
 name True string

Имя.
Адрес электронной почты
 email True string

Адрес электронной почты.
Фамилия
 last_name string

Фамилия.
Address
 address string

Адрес.
Город
 city string

Город.
Государство
 state string

Государство.
Телефон
 phone string

Номер телефона.
Почтовый индекс
 zip_code integer

Почтовый индекс.
Страна
 country string

Страна.
Состояние согласия GDPR
 gdpr_consent_status integer

Состояние согласия GDPR.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Имя
 data.name string

Имя.
Адрес электронной почты
 data.email string

Адрес электронной почты.
Воронка
 data.funnel string

Воронка.

Получение воронок

Идентификатор операции:
FunnelList

Извлекает список воронок.

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
 limit integer

Предел.
Страница
 page integer

Номер страницы.
Заказ по
 orderby string

Порядок по полю.
Заказ
 order string

Порядок.
Искать
 search string

Поисковый термин.
Состояние
 status integer

Состояние.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Товары
 data.items array of object
Идентификатор
 data.items.id integer

Идентификатор.
Имя
 data.items.name string

Имя.
Тип
 data.items.type string

Тип.
URL
 data.items.url string

URL-адрес.
Всего потенциальных клиентов
 data.items.total_leads integer

Общее количество потенциальных клиентов.
Эскиз
 data.items.thumbnail string

Эскиз.
Всего элементов
 data.pagination.total_items integer

Общее число элементов.
Элементы на страницу
 data.pagination.items_per_page integer

Элементы на страницу.
Индекс страницы
 data.pagination.page_index integer

Индекс страницы.
Всего страниц
 data.pagination.total_pages integer

Общее число страниц.

Получение краткого отчета о продажах

Идентификатор операции:
ReportSalesBrief

Извлекает краткий отчет о продажах.

Параметры

Имя Ключ Обязательно Тип Описание
Дата начала
 start_date string

Дата начала.
Дата окончания
 end_date string

Дата окончания.
Лимит
 limit integer

Предел.
Страница
 page integer

Номер страницы.
Группировать по
 groupby string

Группа по.
Идентификаторы курсов
 course_ids string

Идентификаторы курса.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Товары
 data.items array of object
Всего продаж
 data.items.total_sales integer

Общий объем продаж.
Идентификатор курса
 data.items.course_id integer

Идентификатор курса.
Общий объем доходов
 data.items.earnings_total string

Общий доход.
Итог продаж
 data.items.sales_total string

Общий объем продаж.
Плата за афф
 data.items.aff_fee string

Плата за филиал.
Имя
 data.items.name string

Имя.
Day
 data.items.day string

День.
Месяц
 data.items.month string

Месяц.
Валюта
 data.items.currency string

Валюта.
Всего элементов
 data.pagination.total_items integer

Общее число элементов.
Элементы на страницу
 data.pagination.items_per_page integer

Элементы на страницу.
Индекс страницы
 data.pagination.page_index integer

Индекс страницы.
Всего страниц
 data.pagination.total_pages integer

Общее число страниц.

Получение краткого отчета о филиалах

Идентификатор операции:
ReportAffiliateBrief

Получает краткий отчет о филиалах.

Параметры

Имя Ключ Обязательно Тип Описание
Дата начала
 start_date string

Дата начала.
Дата окончания
 end_date string

Дата окончания.
Лимит
 limit integer

Предел.
Страница
 page integer

Номер страницы.
Идентификаторы курсов
 course_ids[] string

Идентификаторы курса.
Идентификаторы филиалов
 affiliate_ids[] string

Идентификаторы филиала.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Товары
 data.items array of object
Валюта
 data.items.currency string

Валюта.
Идентификатор аффик
 data.items.aff_id string

Идентификатор филиала.
Имя Aff
 data.items.aff_name string

Имя филиала.
Aff Email
 data.items.aff_email string

Адрес электронной почты филиала.
Общее число продаж
 data.items.total_sales_count integer

Общее количество продаж.
Общая комиссия
 data.items.total_commission string

Общая комиссия.
Ожидающая комиссия
 data.items.pending_commission string

Ожидающая комиссия.
Платная комиссия
 data.items.paid_commission string

Платная комиссия.
Всего элементов
 data.pagination.total_items integer

Общее число элементов.
Элементы на страницу
 data.pagination.items_per_page string

Элементы на страницу.
Индекс страницы
 data.pagination.page_index string

Индекс страницы.
Всего страниц
 data.pagination.total_pages integer

Общее число страниц.

Получение краткого отчета о ходе выполнения курса

Идентификатор операции:
ReportProgressBrief

Получает краткий отчет о ходе выполнения.

Параметры

Имя Ключ Обязательно Тип Описание
Дата начала
 start_date string

Дата начала.
Дата окончания
 end_date string

Дата окончания.
Лимит
 limit integer

Предел.
Страница
 page integer

Номер страницы.
Идентификаторы курсов
 course_ids[] string

Идентификаторы курса.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Идентификатор курса
 data.items.course_number.courseId integer

Идентификатор курса.
Дата начала
 data.items.course_number.start_date string

Дата начала.
Дата последней
 data.items.course_number.last_date string

Последняя дата.
Имя курса
 data.items.course_number.courseName string

Имя курса.
Всего учащихся
 data.items.course_number.total_students integer

Общее число учащихся.
Не начата
 data.items.course_number.not_started integer

Началось ли.
В процессе
 data.items.course_number.in_progress integer

Независимо от того, выполняется ли процесс.
Завершено
 data.items.course_number.completed integer

Завершено ли выполнение.
Скорость передачи
 data.items.course_number.pass_rate integer

Скорость передачи.
Всего элементов
 data.pagination.total_items integer

Общее число элементов.
Элементы на страницу
 data.pagination.items_per_page string

Элементы на страницу.
Индекс страницы
 data.pagination.page_index string

Индекс страницы.
Всего страниц
 data.pagination.total_pages integer

Общее число страниц.

Получение курса

Идентификатор операции:
CourseGet

Извлекает курс по идентификатору курса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор курса
 course_id True string

Идентификатор курса.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Идентификатор
 data.items.id integer

Идентификатор.
Имя
 data.items.name string

Имя.
Субтитры
 data.items.subtitle string

Подзаголовок.
Эскиз
 data.items.thumbnail string

Эскиз.
Тип курса
 data.items.course_type integer

Тип курса.
Владелец
 data.items.owner string

Владелец.
Идентификатор учебного заведения
 data.items.school_id integer

Идентификатор учебного заведения.
Публика
 data.items.public integer

Является ли общедоступным.
Обработанный
 data.items.featured integer

Указывает, включена ли функция.
Скрытый
 data.items.hidden integer

Является ли скрытым.
Частный
 data.items.private integer

Независимо от того, является ли частный.

Получение отчета о краткой регистрации

Идентификатор операции:
ReportEnrollBrief

Извлекает краткий список регистраций.

Параметры

Имя Ключ Обязательно Тип Описание
Дата начала
 start_date string

Дата начала.
Дата окончания
 end_date string

Дата окончания.
Идентификатор курса
 course_id string

Идентификатор курса.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Товары
 data.items array of object
Идентификатор курса
 data.items.course_id integer

Идентификатор курса.
Имя курса
 data.items.course_name string

Имя курса.
Количество регистраций
 data.items.no_of_enrollments integer

Количество регистраций.
Всего элементов
 data.pagination.total_items integer

Общее число элементов.
Элементы на страницу
 data.pagination.items_per_page integer

Элементы на страницу.
Индекс страницы
 data.pagination.page_index integer

Индекс страницы.
Всего страниц
 data.pagination.total_pages integer

Общее число страниц.

Получение подробного отчета о продажах

Идентификатор операции:
ReportSalesDetailed

Извлекает подробный отчет о продажах.

Параметры

Имя Ключ Обязательно Тип Описание
Дата начала
 start_date string

Дата начала.
Дата окончания
 end_date string

Дата окончания.
Лимит
 limit integer

Предел.
Страница
 page integer

Номер страницы.
Идентификаторы курсов
 course_ids string

Идентификаторы курса.
Тип оплаты
 payment_type integer

Тип оплаты.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Товары
 data.items array of object
Создано в
 data.items.created_at string

При создании.
Код проводки
 data.items.transaction_id string

Идентификатор транзакции.
Цена на продажу
 data.items.sales_price string

Цена на продажу.
Заработать цену
 data.items.earn_price string

Заработать цену.
Имя учащегося
 data.items.student_name string

Имя учащегося.
Электронная почта учащегося
 data.items.student_email string

Адрес электронной почты учащегося.
Курс
 data.items.course string

Курс.
Идентификатор курса
 data.items.course_id integer

Идентификатор курса.
Код купона
 data.items.coupon_code string

Код купона.
Шлюз платежей
 data.items.payment_gateway string

Шлюз платежей.
Всего элементов
 data.pagination.total_items integer

Общее число элементов.
Элементы на страницу
 data.pagination.items_per_page integer

Элементы на страницу.
Индекс страницы
 data.pagination.page_index integer

Индекс страницы.
Всего страниц
 data.pagination.total_pages integer

Общее число страниц.

Получение подробного отчета о регистрации

Идентификатор операции:
ReportEnrollDetail

Извлекает подробный список регистраций.

Параметры

Имя Ключ Обязательно Тип Описание
Дата начала
 start_date string

Дата начала.
Дата окончания
 end_date string

Дата окончания.
Идентификатор курса
 course_id string

Идентификатор курса.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Товары
 data.items array of object
Идентификатор курса
 data.items.course_id integer

Идентификатор курса.
Идентификатор пользователя
 data.items.user_id string

Идентификатор пользователя.
Имя курса
 data.items.course_name string

Имя курса.
Имя (Первое имя)
 data.items.first_name string

Первое имя.
Фамилия
 data.items.last_name string

Фамилия.
Адрес электронной почты
 data.items.email string

Адрес электронной почты.
Дата регистрации
 data.items.enrollment_date string

Дата регистрации.

Получение подробного отчета о ходе выполнения курса

Идентификатор операции:
ReportProgressDetailed

Извлекает подробный отчет о ходе выполнения.

Параметры

Имя Ключ Обязательно Тип Описание
Дата начала
 start_date string

Дата начала.
Дата окончания
 end_date string

Дата окончания.
Лимит
 limit integer

Предел.
Страница
 page integer

Номер страницы.
Идентификаторы курсов
 course_ids[] string

Идентификаторы курса.
Расширенный фильтр
 af_v string

Расширенный фильтр.
Купон имеет значение
 coupon_is[] string

Купон.
Купон как
 coupon_like[] string

Купон похож.
Имя
 name_is[] string

Имя — это.
Имя, например
 name_like[] string

Имя похоже.
Электронная почта
 email_is[] string

Это сообщение электронной почты.
Электронная почта как
 email_like[] string

Сообщение электронной почты похоже.
Филиал
 affiliate_is[] string

Филиал.
Тип оплаты
 payment_type integer

Тип оплаты.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
ИД пользователя
 data.items.course_number.uid string

Уникальный идентификатор.
Идентификатор курса
 data.items.course_number.courseId string

Идентификатор курса.
Имя
 data.items.course_number.name string

Имя.
Адрес электронной почты
 data.items.course_number.email string

Адрес электронной почты.
Дата регистрации
 data.items.course_number.enrollment_date string

Дата регистрации.
Дата начала
 data.items.course_number.start_date string

Дата начала.
Дата завершения
 data.items.course_number.completed_date string

Дата завершения.
Состояние
 data.items.course_number.status string

Состояние.
Последнее участие
 data.items.course_number.last_attended string

Когда последний раз присутствовал.
Процент завершения
 data.items.course_number.completion_percentage integer

Процент завершения.
Всего элементов
 data.pagination.total_items integer

Общее число элементов.
Элементы на страницу
 data.pagination.items_per_page string

Элементы на страницу.
Индекс страницы
 data.pagination.page_index string

Индекс страницы.
Всего страниц
 data.pagination.total_pages integer

Общее число страниц.

Получение подробных отчетов о филиалах

Идентификатор операции:
ReportAffiliateDetailed

Получает подробный отчет о филиалах.

Параметры

Имя Ключ Обязательно Тип Описание
Дата начала
 start_date string

Дата начала.
Дата окончания
 end_date string

Дата окончания.
Лимит
 limit integer

Предел.
Страница
 page integer

Номер страницы.
Идентификаторы курсов
 course_ids[] string

Идентификаторы курса.
Идентификаторы филиалов
 affiliate_ids[] string

Идентификаторы филиала.
Расширенный фильтр
 af_v string

Расширенный фильтр.
Купон имеет значение
 coupon_is[] string

Купон.
Купон как
 coupon_like[] string

Купон похож.
Имя
 name_is[] string

Имя — это.
Имя, например
 name_like[] string

Имя похоже.
Электронная почта
 email_is[] string

Это сообщение электронной почты.
Электронная почта как
 email_like[] string

Сообщение электронной почты похоже.
Филиал
 affiliate_is[] string

Филиал.
Тип оплаты
 payment_type string

Тип оплаты.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Товары
 data.items array of object
Курс
 data.items.course string

Курс.
Создано в
 data.items.created_at string

При создании.
Цена на продажу
 data.items.sales_price string

Цена на продажу.
Скидка купона
 data.items.coupon_discount string

Скидка купона.
Комиссия
 data.items.commission string

Комиссия.
Состояние выплаты
 data.items.payout_status string

Состояние выплаты.
Всего элементов
 data.pagination.total_items integer

Общее число элементов.
Элементы на страницу
 data.pagination.items_per_page integer

Элементы на страницу.
Индекс страницы
 data.pagination.page_index integer

Индекс страницы.
Всего страниц
 data.pagination.total_pages integer

Общее число страниц.

Получение предстоящих вебинаров

Идентификатор операции:
WebinarList

Получение списка предстоящих трансляций вебинаров.

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
 limit integer

Предел.
Страница
 page integer

Номер страницы.
Заказ по
 orderby string

Порядок по полю.
Заказ
 order string

Порядок.
Искать
 search string

Поисковый термин.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Товары
 data.items array of object
Идентификатор
 data.items.id integer

Идентификатор.
Тема
 data.items.topic string

Тема.
Дата расписания
 data.items.schedule_date string

Дата расписания.
Timezone
 data.items.timezone string

Часовой пояс.
Продолжительность
 data.items.duration integer

Длительность.
URL-адрес регистрации
 data.items.register_url string

URL-адрес регистрации.
Повторяется
 data.items.recurring boolean

Будет ли повторяющийся.
Последнее повторяющееся расписание
 data.items.recent_recurring_schedule string

Последнее повторяющееся расписание.
Всего элементов
 data.pagination.total_items integer

Общее число элементов.
Элементы на страницу
 data.pagination.items_per_page integer

Элементы на страницу.
Индекс страницы
 data.pagination.page_index integer

Индекс страницы.
Всего страниц
 data.pagination.total_pages integer

Общее число страниц.

Получение предстоящих классов

Идентификатор операции:
ClassList

Извлекает список предстоящих динамических классов.

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
 limit integer

Предел.
Страница
 page integer

Номер страницы.
Заказ по
 orderby string

Порядок по полю.
Заказ
 order string

Порядок.
Искать
 search string

Поисковый термин.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Товары
 data.items array of object
Идентификатор
 data.items.id integer

Идентификатор.
Тема
 data.items.topic string

Тема.
Дата расписания
 data.items.schedule_date string

Дата расписания.
Timezone
 data.items.timezone string

Часовой пояс.
Продолжительность
 data.items.duration integer

Длительность.
URL-адрес регистрации
 data.items.register_url string

URL-адрес регистрации.
Повторяется
 data.items.recurring boolean

Будет ли повторяющийся.
Последнее повторяющееся расписание
 data.items.recent_recurring_schedule string

Последнее повторяющееся расписание.
Всего элементов
 data.pagination.total_items integer

Общее число элементов.
Элементы на страницу
 data.pagination.items_per_page integer

Элементы на страницу.
Индекс страницы
 data.pagination.page_index integer

Индекс страницы.
Всего страниц
 data.pagination.total_pages integer

Общее число страниц.

Получение регистраций для воронки

Идентификатор операции:
FunnelEnrollment

Извлекает список регистраций для воронки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор воронки
 funnel_id True string

Идентификатор воронки.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Товары
 data.items array of object
Идентификатор
 data.items.id string

Идентификатор.
Имя (Первое имя)
 data.items.first_name string

Первое имя.
Фамилия
 data.items.last_name string

Фамилия.
Адрес электронной почты
 data.items.email string

Адрес электронной почты.
Зарегистрировано в
 data.items.enrolled_on string

При регистрации.

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

Идентификатор операции:
UserGet

Получение сведений о пользователе.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пользователя
 user_id True string

Идентификатор пользователя.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Идентификатор
 data.id string

Идентификатор.
Имя (Первое имя)
 data.first_name string

Первое имя.
Фамилия
 data.last_name string

Фамилия.
Адрес электронной почты
 data.email string

Адрес электронной почты.
Биография
 data.bio string

Биография.
Address
 data.address string

Адрес.
Город
 data.city string

Город.
Государство
 data.state string

Государство.
Почтовый индекс
 data.zip_code string

Почтовый индекс.
Роли
 data.roles array of integer
Телефон
 data.phone string

Номер телефона.

Получение списка курсов

Идентификатор операции:
CourseList

Извлекает список курсов.

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
 limit integer

Предел.
Страница
 page integer

Номер страницы.
Заказ по
 orderby string

Порядок по полю.
Заказ
 order string

Порядок.
Искать
 search string

Поисковый термин.
Тип
 type integer

Тип.
Состояние
 status integer

Состояние.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Товары
 data.items array of object
Идентификатор
 data.items.id integer

Идентификатор.
Имя
 data.items.name string

Имя.
Субтитры
 data.items.subtitle string

Подзаголовок.
Эскиз
 data.items.thumbnail string

Эскиз.
URL
 data.items.url string

URL-адрес.
Всего элементов
 data.pagination.total_items integer

Общее число элементов.
Элементы на страницу
 data.pagination.items_per_page integer

Элементы на страницу.
Индекс страницы
 data.pagination.page_index integer

Индекс страницы.
Всего страниц
 data.pagination.total_pages integer

Общее число страниц.

Получение списка пользователей

Идентификатор операции:
UserList

Извлекает список пользователей.

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
 limit integer

Предел.
Страница
 page integer

Номер страницы.
Заказ по
 orderby string

Порядок по полю.
Заказ
 order string

Порядок.
Искать
 search string

Поисковый термин.
Role
 role integer

Роль.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Товары
 data.items array of object
Идентификатор
 data.items.id string

Идентификатор.
Имя (Первое имя)
 data.items.first_name string

Первое имя.
Фамилия
 data.items.last_name string

Фамилия.
Адрес электронной почты
 data.items.email string

Адрес электронной почты.
Роли
 data.items.roles array of integer

Роли.
Всего элементов
 data.pagination.total_items integer

Общее число элементов.
Элементы на страницу
 data.pagination.items_per_page integer

Элементы на страницу.
Индекс страницы
 data.pagination.page_index integer

Индекс страницы.
Всего страниц
 data.pagination.total_pages integer

Общее число страниц.

Регистрация для вебинара

Идентификатор операции:
WebinarRegister

Зарегистрируйте пользователя для динамического вебинара.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор вебинара
 webinar_id True string

Идентификатор вебинара.
Имя
 name True string

Имя.
Адрес электронной почты
 email True string

Адрес электронной почты.
Фамилия
 last_name string

Фамилия.
Address
 address string

Адрес.
Город
 city string

Город.
Государство
 state string

Государство.
Телефон
 phone string

Номер телефона.
Почтовый индекс
 zip_code integer

Почтовый индекс.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Имя
 data.name string

Имя.
Адрес электронной почты
 data.email string

Адрес электронной почты.
Live Webinar
 data.live webinar string

Живой вебинар.
Message
 data.message string

Сообщение.

Регистрация для класса

Идентификатор операции:
ClassRegister

Зарегистрируйте пользователя для динамического класса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор динамического класса
 liveclass_id True string

Идентификатор динамического класса.
Имя
 name True string

Имя.
Адрес электронной почты
 email True string

Адрес электронной почты.
Фамилия
 last_name string

Фамилия.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Имя
 data.name string

Имя.
Адрес электронной почты
 data.email string

Адрес электронной почты.
Live Class
 data.live class string

Динамический класс.
Message
 data.message string

Сообщение.

Регистрация пользователя

Идентификатор операции:
UserEnroll

Регистрирует пользователя в курс.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пользователя
 user_id True string

Идентификатор пользователя.
Идентификатор курса
 course_id True string

Идентификатор курса.
Идентификатор плана
 plan_id string

Идентификатор плана.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Данные
 data string

Данные.

Удаление пользователя

Идентификатор операции:
UserDelete

Удалите пользователя из учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пользователя
 user_id True string

Идентификатор пользователя.

Возвращаемое значение

Имя Путь Тип Описание
Код ответа
 response_code integer

Код ответа.
Message
 message string

Ответное сообщение.
Данные
 data string

Данные.