Перейти к основному содержимому
Документация для версии v71

Запуск триггерной кампании

В этой статье мы покажем, как отправить сообщению профилю, запустив триггерную кампанию через API.

подсказка

Через API можно запустить только активную триггерную кампанию, настроенную на событие "При использовании особого вызова API". Создание триггерной кампании описано в этой статье.

Получение API-токена​

API-токен — это ключ доступа к платформе через API. Он используется в любом API-запросе.

Найти токен можно в настройках платформы Altcraft, в разделе "Токены". Если у вас ещё нет токена, создайте его, нажав на соответствующую кнопку:

предупреждение

API-токен могут создать только мастер-пользователи. Если у вас нет прав для создания токена, обратитесь к пользователю с правами мастера.

Установка и запуск Postman​

Для работы с API-запросами вам понадобится приложение, позволяющее отправлять и принимать их.

1. Скачайте и установите приложение Postman или откройте его веб-версию.

2. Выберите метод POST для вашего запроса.

3. Перейдите на вкладку Body и выберите режим raw. Убедитесь, что выбран формат JSON.

URL-адрес запроса​

Для отправки запроса на сервер вам необходимо ввести его URL. Он индивидуален для каждого запроса. Например, для запроса на импорт профиля URL-адрес будет таким:

https://example.com/api/v1.1/campaigns/triggers/start

Замените example.com на домен, на котором развернута ваша платформа. Вы можете скопировать адрес прямо из адресной строки:

Создание запроса​

Перейдем к написанию запроса.

Поиск профиля по email

Предположим, в базе есть подписчик с email-адресом zaycev@example.com. Мы хотим отправить ему на почту сообщение, запустив триггерную кампанию #1. Наш запрос может выглядеть так:

{
  "token": "abcdefghklmnopqrstzxc",
  "id": 1,
  "matching": "email",
  "email": "zaycev@example.com"
}
  • "token" — ваш API-токен. Подробнее о том, где можно его найти, написано в начале статьи.
  • "id" — идентификатор триггерной кампании. Он указан рядом с названием кампании справа от знака # . id триггерной кампании — это всегда число, не путайте его с названием.
  • "matching" и "email" — параметры, по которым запрос найдёт в базе необходимый профиль. В данном случае используется поиск по email-адресу профиля.

Поиск профиля по profile_id

Если email-адрес клиента неизвестен, вы можете найти его профиль в базе, используя внутренний идентификатор (profile_id):

{
  "token": "abcdefghklmnopqrstzxc",
  "id": 1,
  "matching": "profile_id",
  "email": "660fb662ef3df43421a8cda5"
}

Идентификатор профиля можно найти в его карточке:

Поиск профиля по дополнительному полю

Если для идентификации профиля клиента в базе используются данные из дополнительного поля, вы можете использовать их для запуска триггерной кампании.

Предположим, мы хотим отправить сообщение клиенту, который поставил лайк на запись Вконтакте. Но мы не знаем о нем ничего, кроме его ID Вконтакте, который записан в нашей базе данных в поле "vk_id". В этом случае запрос будет выглядеть следующим образом:

{
  "token": "abcdefghklmnopqrstzxc",
  "id": 5,
  "matching": "custom",
  "field_name": "vk_id",
  "field_value": "123456"
}
подсказка

Обратите внимание на синтаксис вашего запроса. Лишние символы или незакрытые скобки могут привести к ошибке.

Отправка запроса​

Чтобы отправить запрос, нажмите кнопку Send в Postman. При успешном выполнении вы получите сообщение об успешной отправке запроса:

Если что-то пошло не так, в ответном сообщении будет указан номер и описание ошибки:

Если у вас не получилось самостоятельно устранить ошибку, передайте номер и описание ошибки в службу поддержки Altcraft.

подсказка

В статье описывается лишь часть возможных параметров для данного запроса. С остальными параметрами можно ознакомиться здесь.

Последнее обновление