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

Получить информацию о триггер кампании

Описание​

Получить информацию о триггер кампании.

URL-адрес​

Метод: POST

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

Параметры запроса​

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
idint1ДаИдентификатор кампании
formatstring"json"НетФормат возвращаемых данных
по умолчанию – "json"

Пример запроса​

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "id": 12
}

Пример ответа​

{
  "data": {
    "call_url": "trk.test.test.altcraft.com/trg/465ea6fedf0a75fafe1a413943aae3696d95939038311994/<email|md5|xxh>",
    "content": [
      {
        "from_email": "",
        "from_name": "",
        "message_id": 41,
        "replyto_email": "",
        "replyto_name": "",
        "subject": ""
      }
    ],
    "send_channel": "email",
    "custom_tracking_domains": [],
    "id": 7,
    "is_active": true,
    "attributes": {
        "season": "spring_2024",
        "branch": "marketing"
    },
    "is_random_tracking_prefix": false,
    "list_id": 20,
    "name": "API call trigger",
    "resource_id": 44,
    "skip_minutes": 0,
    "subid": "API",
    "trigger_type": "api_call",
    "virtual_sender_id": 98
  },
  "error": 0,
  "error_text": "Successful operation"
}

Возвращаемые параметры​

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
idintИдентификатор кампании
namestringНазвание кампании
is_activeboolСтатус кампании
contentJSON arrayContent object
trigger_typestringТип триггера
send_channelstringКанал отправки
skip_minutesintПодождать (минуты) перед активацией триггера
resource_idintИдентификатор ресурса
for_confirmboolИспользует ли кампания сообщения со ссылкой подтверждения
policy_idintИдентификатор политики отправки
descrstringОписание кампании
push_sending_modestringРежим отправки push-сообщений (только для push-каналов)
attributesobjectАтрибуты, назначенные кампании, и их значения
Smart настройки (только для smart-аккаунтов)
virtual_sender_idintИдентификатор виртуального сендера
is_random_tracking_prefixboolСлучайный префикс трекинг-домена
custom_tracking_domainsJSON arrayСписок трекинг-доменов
blind_carbon_copyJSON arrayАдреса для скрытой копии
unconditional_sendingboolОтправка вне зависимости от статуса подписки

Тип триггера в зависимости от полей ответа​

Поля, меняющиеся в зависимости от типа триггера (trigger_type)

ПолеТипОписаниеapi_callapi_importactionupdatepixelsubscribe
actionstringТип запуска, основанный на действииНетНетДаНетНетНет
update_queryJSON arrayОбновление полей профиля:
{ 
 "fieldname": "custom_ID",
 "fieldtype": "int",
 "operator": "equal",
 "value": "2000" 
 }
НетНетНетДаНетНет
link_namestringИмя ссылки в сообщенииНетНетДаНетНетНет
message_idintИдентификатор сообщения для событий захватаНетНетДаНетНетНет
list_idintИдентификатор базы данныхДаДаНетДаНетНет
subscribe_resource_idintИдентификатор ресурса подписки, на которую реагирует триггерНетНетНетНетНетДа
channelstringКанал на который реагироватьНетНетНетНетНетДа
is_new_subboolРеагировать на новый ресурсНетНетНетНетНетДа
is_new_chboolРеагировать на новый канал в ресурсНетНетНетНетНетДа
is_new_contactboolРеагировать на новый контакт в каналеНетНетНетНетНетДа
is_status_changedboolРеагировать на смену статуса на перечисленные в trigger_statusesНетНетНетНетНетДа
trigger_statusesarray(int)Статусы новых/измененных подписок, на которые реагирует триггерНетНетНетНетНетДа
pixel_idintИдентификатор пикселя для захвата событийНетНетНетНетДаНет
pixel_targetstringЦель пикселя для захвата событийНетНетНетНетДаНет

trigger_type: action​

Его эквивалент в пользовательском интерфейсе "Тип триггера": "При выполнении подписчиком выбранного действия".

Его дополняют три поля.

Два основных: "action": "<action name>" и "message_id": 123.

И поле "link_name": "String", которое появляется вместе с "action": "click_sms" и "action": "clicklink_sms".

  • "action": "open" — Открыт Email.
  • "action": "read" — Прочитан Email.
  • "action": "click" — Любой клик в Email.
  • "action": "confirm" — Клик на Confirm ссылку.
  • "action": "click_sms" — Любой клик в SMS.
  • "action": "clicklink" — Клик по ссылке в Email (здесь также требуется поле "link_name": "String").
  • "action": "clicklink_sms" — Клик по ссылке в SMS (здесь также требуется поле "link_name": "String").

trigger_type: api_import​

Его эквивалент в пользовательском интерфейсе "Тип триггера": "При импорте подписчика через API".

Его дополняет поле "list_id": 32 — ID листа, для которого создан триггер.

trigger_type: pixel​

Его эквивалент в пользовательском интерфейсе "Тип триггера": "Когда пиксель активирован".

Его дополняют два поля:

  • "pixel_id": 64 — в интерфейсе "Выберите пиксель".
  • "pixel_target": "Target-name" — в интерфейсе "Цель".

trigger_type: update​

Его эквивалент в пользовательском интерфейсе "Тип триггера": "Когда какое либо поле изменено".

Его дополняют два поля:

  • "list_id": 32 — ID листа, для которого создан триггер.
  • "update_query": {"fieldname": "_postal_code", "fieldtype": "unicode", "operator": "equal", "value": "800028"} — условие срабатывания триггера.

Запрос обновления​

  • "fieldname": "_postal_code" — имя стандартного или дополнительного поля в листе. Дополнительные поля отображаются под своим именем. Перевод стандартных полей находится на странице Внутренние названия стандартных полей.
  • "fieldtype": "unicode" — тип данных в поле, зависит от "fieldname". Запрос поля листа показывает список стандартных (default) и дополнительных (custom) полей. Также там есть system поля, но они здесь не используются.
  • "operator": "equal" — логический оператор.
  • "value": "800028" — значение, которое должно принять поле при обновлении подписчика.
  • "submatch": "object_key" — путь к свойству, значение которого должно измениться, чтобы сработал триггер. Используется только с типами полей object и arr_object.

Типы полей​

Тип поля можно узнать запросом поля листа.

  • unicode — Строка, "abc"
  • int — Число, -1234
  • bool — Boolean, true
  • date — Дата (в виде строки), "2000-10-24T00:00:00.000Z"
  • tags — Теги (список строк), ["T1", "Tag2"]
  • enum — Список, представляет собой структуру key-value {"item_one": 1, "item_two": 2}
  • object — Объект, {"A": "B", "C": "D"}
  • arr_object — Массив объектов, [{"A": 1},{"B": 2}]

Операторы запроса​

ОператорОписаниеLineNumberIPEnumDateBooleanTagsObjectArr_object
"equal"если он станет равным++++++---
"not_equal"если он станет не равным++++++---
"not_exists_or_empty"если он не существует или пуст++++++-++
"not_empty_or_exists"если не пустой или существует++++++-++
"tag_added_any"если один из тегов добавлен------+--
"tag_removed_any"если один из тегов удален------+--
"equal_property"если значение указанного свойство станет равным-------++
"not_equal_property"если значение указанного свойство станет не равным-------++
"added_element"если в массив добавлен новый элемент--------+
"deleted_element"если из массива удален один из элементов--------+
Последнее обновление