Skip to end of metadata
Go to start of metadata

Описание

Запуск триггер кампании для нескольких профилей.

Данный запрос является batch-версией запроса Запуск триггерной кампании (API call).

Тело запроса ограничено по умолчанию до 10мб, исключение: файлы - 100мб

URL-адрес

Метод: POST

http://example.com/api/v1.1/campaigns/triggers/start_batch

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
formatstring"json"НетФормат возвращаемых данных
по умолчанию – "json"
trigger_idint1ДаИдентификатор кампании
attachJSON array of File object[]НетFile object
contentJSON object
    {
        "H1": "Weather alert",
        "H2": "Welcome"
    }
НетКонтент для переменных
apicontent
в сообщениях.
custom_dataJSON object
{ "field": "value" }
Нет

Пользовательские параметры, возвращаются в хуках (Захват событий)

dataarray
[ 
	{"email": "profile1@example.com"}, 
	{"email": "profile2@example.com"} 
]
Да

Поле в базе данных и его значение, по которому будет произведен поиск нужного профиля.

Подробнее о data здесь.

Поиск профиля подписчика для отправки триггера 
matchingstring

"email"

"email_profile"

"email_sub"

"phone"

"phone_sub"

"profile_id"

"push_sub"

"custom"

"custom_sub"

"email_phone"

"email_phone_sub"

Нет, если поиск

по email из профиля или подписок

Режим поиска подписчика.
По умолчанию - email. 

Подробнее о матчинге здесь.

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

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
task_idstringИдентификатор задачи

Пример запроса с матчингом по email

{
	"token": "abcdefghijklmnqrstuvwxyz",
	"trigger_id": 8,
	"format": "json",
	"matching": "email",
	"data": [
		{"email": "profile1@example.com"}, 
		{"email": "profile2@example.com"}
	]
}

Пример запроса с матчингом по custom-полю

{
	"token": "abcdefghijklmnqrstuvwxyz",
	"trigger_id": 455,
	"format": "json",
	"skip_triggers": false,
	"matching": "custom",
	"field_name": "New_field_1",
	"data": [
		{
			"field_value": "001"
		},
		{
			"field_value": "002"
		}
	]
}

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

{
	"error": 0,
	"error_text": "Successful operation",
	"result": [
		{
			"error": 409,
			"error_text": "Unclear Matching"
		},
		{
			"profile_id": "6042600a363b2746cd972a83"
		}
	]
}

Пример ответа при срабатывании ограничения запроса

{
	"error":400,
	"error_debug":"http: request body too large",
	"error_text":"Invalid request"
}
  • No labels