Операции Mindbox
Раздел описывает операции интеграции Mindbox в платформе Fasttrack: какие операции доступны, в какой момент они вызываются, какие параметры принимают и как обрабатывать результат в конструкторе.
Как вызвать операцию
Любая операция Mindbox вызывается в конструкторе тегом {% mindbox.operation %}. Тело запроса формируется заранее объектом через {% createobj %} … {% endcreateobj %}, а результат выполнения сохраняется в переменную для дальнейшего использования.
Общая схема состоит из трёх шагов:
Аргументы тега {% mindbox.operation %}:
name
Имя операции в Mindbox (например, ft.GetCustomer). Должно совпадать с именем, заведённым в админке Mindbox.
custom_fields
Объект с телом запроса, созданный через {% createobj %}.
as <переменная>
Имя переменной, в которую помещается результат выполнения операции.
Пример полного вызова — проверка наличия контакта в Mindbox по номеру телефона:
{# вызываем операцию ft.GetCustomer для проверки наличия контакта в MindBox #}
{% createobj get_contact %}
{
"page": {
"pageNumber": "1",
"itemsPerPage": "10"
},
"customer": {
"mobilePhone": "{{attributes.profile_phone_number}}"
}
}
{% endcreateobj %}
{% mindbox.operation name="ft.GetCustomer" custom_fields=get_contact as operation_ft_GetCustomer %}
{# сохраним результат выполнения операции в переменнную operation_ft_GetCustomer #}
{% save_variable "operation_ft_GetCustomer" operation_ft_GetCustomer %}Основные методы
ft.BotStart — Старт бота
Вызывается в момент первого запуска бота пользователем. Передаёт в Mindbox факт входа в бота, идентификатор пользователя в боте и, при наличии, данные из диплинка (магазин, акция, платформа).
Пример вызова:
Структура ответа (схематично):
ft.CreateCustomer — Создание клиента
Создаёт клиента в Mindbox. Вызывается, когда пользователь оставил номер телефона и его нужно завести как контакт. Здесь же фиксируется согласие на рассылки.
Пример вызова:
Структура ответа (схематично):
ft.FillUpCustomer — Дополнить клиента
Дозаполняет профиль уже существующего клиента: ФИО, дата рождения, пол, контакты, часовой пояс. Вызывается, когда пользователь постепенно сообщает дополнительные данные о себе.
Пример вызова:
Структура ответа (схематично):
ft.GetCustomer — Получить информацию о клиенте
Возвращает данные клиента из Mindbox по номеру телефона. Используется для проверки наличия контакта и получения его профиля.
Пример вызова:
Структура ответа (схематично):
Бот лояльности
ft.ConfirmPhone — Подтвердить телефон
Подтверждает номер телефона клиента. Используется, если на проекте предусмотрено подтверждение номера (например, через код из SMS).
Пример вызова:
Структура ответа (схематично):
ft.GenerateLoyaltyCode — Генерация QR-кода авторизации
Генерирует код авторизации в программе лояльности. Используется, если на проекте применяется динамический QR-код.
Пример вызова:
Структура ответа (схематично):
ft.GetCustomerOrders — Список заказов по номеру телефона
Возвращает список заказов клиента по номеру телефона с постраничной выборкой.
Пример вызова:
Структура ответа (схематично):
Дополнительные методы
ft.EditCustomer — Редактировать клиента
Обновляет данные существующего клиента. В отличие от ft.FillUpCustomer, используется для прямого редактирования полей профиля.
Пример вызова:
Структура ответа (схематично):
ft.GetTicket — Получить тикет по клиенту
Возвращает тикет (обращение / купон / запись) клиента по номеру телефона.
Пример вызова:
Структура ответа (схематично):
ft.ChatBotEvent — Событие в боте
Передаёт в Mindbox информацию о произошедшем событии в боте. Список идентификаторов (типов) событий определяет клиент.
Пример вызова:
Структура ответа (схематично):
ft.GetCustomerRecommendations — Получить рекомендации
Возвращает персональные товарные рекомендации для клиента по номеру телефона.
Пример вызова:
Структура ответа (схематично):
Last updated