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

Описание

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

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API-токен
id	int	1	Да	Идентификатор рассылки
format	string	"json"	Нет	Формат возвращаемых данных по умолчанию – "json"

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

JSON

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

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <id>12</id>
</xml>

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

JSON

{
  "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"
}

XML

<xml>
    <data>
        <blind_carbon_copy/>
        <call_url>http://trk.test.test.altcraft.com:8095/trg/65512f8ec196edd63e50585b4bfd377365512f8ec196edd62f3de6b87e2969e3/
            <email|md5|xxh>
            </call_url>
            <channel>0</channel>
            <content>
                <from_email/>
                <from_name/>
                <message_id>8</message_id>
                <replyto_email/>
                <replyto_name/>
                <subject/>
            </content>
            <custom_tracking_domains/>
            <description/>
            <for_confirm>false</for_confirm>
            <id>12</id>
            <is_active>true</is_active>
            <attributes>
                <season>spring_2024</season>
                <branch>marketing</branch>
            </attributes>
            <is_new_ch>false</is_new_ch>
            <is_new_contact>false</is_new_contact>
            <is_new_sub>false</is_new_sub>
            <is_random_tracking_prefix>false</is_random_tracking_prefix>
            <is_status_changed>false</is_status_changed>
            <list_id>1</list_id>
            <name>New trigger campaign 3</name>
            <policy_id>0</policy_id>
            <resource_id>4</resource_id>
            <send_channel>email</send_channel>
            <skip_minutes>0</skip_minutes>
            <skip_unique_checking>false</skip_unique_checking>
            <start_schedule>
                <losers>false</losers>
                <profile>false</profile>
                <start_hours/>
                <start_mdays/>
                <start_mins/>
                <start_months/>
                <start_wdays/>
                <start_years/>
                <tz/>
            </start_schedule>
            <sub_cats_filter/>
            <sub_fields_filter/>
            <subid/>
            <subscribe_resource_id>0</subscribe_resource_id>
            <trigger_type>api_call</trigger_type>
            <unconditional_sending>false</unconditional_sending>
            <update_time>2024-02-15T20:45:00.705Z</update_time>
            <updated_user>roman</updated_user>
            <virtual_sender_id>0</virtual_sender_id>
        </data>
        <error>0</error>
        <error_text>Successful operation</error_text>
    </xml>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
id	int	Идентификатор рассылки
name	string	Название рассылки
is_active	bool	Статус рассылки
content	JSON array	Content object
trigger_type	string	Тип триггера
send_channel	string	Канал отправки
skip_minutes	int	Подождать (минуты) перед активацией триггера
resource_id	int	Идентификатор ресурса
for_confirm	bool	Использует ли рассылка сообщения со ссылкой подтверждения
policy_id	int	Идентификатор политики отправки
descr	string	Описание рассылки
push_sending_mode	string	Режим отправки push-сообщений (только для push-каналов)
attributes	object	Атрибуты, назначенные рассылке, и их значения
Smart настройки (только для smart-аккаунтов)
virtual_sender_id	int	Идентификатор виртуального сендера
is_random_tracking_prefix	bool	Случайный префикс трекинг-домена
custom_tracking_domains	JSON array	Список трекинг-доменов
blind_carbon_copy	JSON array	Адреса для скрытой копии
unconditional_sending	bool	Отправка вне зависимости от статуса подписки

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

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

Поле	Тип	Описание	api_call	api_import	action	update	pixel	subscribe
action	string	Тип запуска, основанный на действии	Нет	Нет	Да	Нет	Нет	Нет
update_query	JSON array	Обновление полей профиля: { "fieldname": "custom_ID", "fieldtype": "int", "operator": "equal", "value": "2000" }	Нет	Нет	Нет	Да	Нет	Нет
link_name	string	Имя ссылки в сообщении	Нет	Нет	Да	Нет	Нет	Нет
message_id	int	Идентификатор сообщения для событий захвата	Нет	Нет	Да	Нет	Нет	Нет
list_id	int	Идентификатор базы данных	Да	Да	Нет	Да	Нет	Нет
subscribe_resource_id	int	Идентификатор ресурса подписки, на которую реагирует триггер	Нет	Нет	Нет	Нет	Нет	Да
channel	string	Канал на который реагировать	Нет	Нет	Нет	Нет	Нет	Да
is_new_sub	bool	Реагировать на новый ресурс	Нет	Нет	Нет	Нет	Нет	Да
is_new_ch	bool	Реагировать на новый канал в ресурс	Нет	Нет	Нет	Нет	Нет	Да
is_new_contact	bool	Реагировать на новый контакт в канале	Нет	Нет	Нет	Нет	Нет	Да
is_status_changed	bool	Реагировать на смену статуса на перечисленные в trigger_statuses	Нет	Нет	Нет	Нет	Нет	Да
trigger_statuses	array(int)	Статусы новых/измененных подписок, на которые реагирует триггер	Нет	Нет	Нет	Нет	Нет	Да
pixel_id	int	Идентификатор пикселя для захвата событий	Нет	Нет	Нет	Нет	Да	Нет
pixel_target	string	Цель пикселя для захвата событий	Нет	Нет	Нет	Нет	Да	Нет

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}]

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

Оператор	Описание	Line	Number	IP	Enum	Date	Boolean	Tags	Object	Arr_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"	если из массива удален один из элементов	-	-	-	-	-	-	-	-	+