Добавить триггер кампанию
Описание
Добавить триггер кампанию.
URL-адрес
Метод: POST
https://example.com/api/v1.1/campaigns/triggers/add/
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
format | string | "csv" | Нет | Формат возвращаемых данных по умолчанию – "json" |
name | string | "New Awesome Campaign" | Да | Название кампании |
is_active | bool | true | Нет | Статус кампании |
content | JSON array | [ | Да | Контент, присоединенный к кампании |
subid | string | "Adv_1" | Нет | Subid кампании |
trigger_type | string | "api_call" | Да | Тип триггера |
send_channel | string | "email" "sms" "push" | Да | Канал отправки. Если в запросе также передаются другие параметры, связанные с каналом ( content_type , send_email_content , send_sms_content , send_push_content ), кампания будет использовать канал, указанный в параметре send_channel . |
content_type | string | "email" | Нет | Параметр устарел. При его передаче кампания будет использовать email-канал для отправки. |
send_email_content | bool | false | Нет | Параметр устарел. При его передаче кампания будет использовать email-канал для отправки. |
send_sms_content | bool | false | Нет | Параметр устарел. При его передаче кампания будет использовать email-канал для отправки. |
send_push_content | bool | true | Нет | Параметр устарел. При его передаче кампания будет использовать email-канал для отправки. |
skip_minutes | int | 0 | Нет | Подождать Х минут перед активацией кампании |
resource_id | int | 24 | Нет | Идентификатор ресурса |
policy_id | int | 1 | Нет | Идентификатор политики отправки |
push_sending_mode | string | "fanout" (по умолчанию) "last" | Нет | Режим отправки push-сообщений (только для push-каналов) |
Smart настройки | ||||
virtual_sender_id | int | 12 | Нет | Идентификатор виртуального сендера Только для smart-аккаунтов |
is_random_trk_prefix | bool | false | Нет | Случайный префикс трекинг-домена Только для smart-аккаунтов |
custom_trk_domain | JSON array | ["trk.example.com", "trk2.example.com"] | Нет | Список произвольных трекинг-доменов Только для smart-аккаунтов |
blind_carbon_copy | JSON array | ["john@example.com", "george@example.com"] | Нет | Адреса для скрытой копии Только для smart-аккаунтов |
unconditional_sending | bool | true | Нет | Отправка вне зависимости от статуса подписки* Только для smart-аккаунтов |
* Опция доступна только при использовании Altcraft MP по лицензии (On-Premise). Для активации этой возможности в файл конфигурации main.json
в свойство EXTRAS
нужно добавить значение "unc_campaign"
.
Параметры, связанные с тип ом триггера
Поле | Тип | Описание | api_call | api_import | action | update | pixel | subscribe |
---|---|---|---|---|---|---|---|---|
action | string | Тип запуска, основанный на действии | Нет | Нет | Да | Нет | Нет | Нет |
update_query | JSON array | Обновление полей профиля:{ | Нет | Нет | Нет | Да | Нет | Нет |
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 | Идентификатор пикселя для захвата событий | Нет | Нет | Нет | Нет | Да | Нет |
Пример запроса
{
"token": "e94ce55afc8e4e07bd64afb4427f8a5c",
"name": "New trigger campaign 3",
"content": [
{
"subject": "Maybe very important message",
"from_email": "",
"from_name": "James",
"replyto_email": "",
"replyto_name": "",
"message_id": 8
}
],
"trigger_type": "api_call",
"send_channel": "email",
"list_id": 1
}
Пример ответа
{
"data": {
"saved_id": 42,
"trigger_link": "http://trk.example.com:8095/trg/3a345a07f01802e7966599e657a34d023a345a07f01802e7/<email|md5|xxh>"
},
"error": 0,
"error_text": "Successful operation"
}
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
saved_id | int | Идентификатор новой кампании |
trigger_link | string | Только если trigger_type = "api_call" |