Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


SEO Metadata

Ознакомьтесь с API для запуска триггерной кампании сразу для нескольких профилей в платформе Altcraft Marketing.

Table of Contents

Описание

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

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

Возвращает ответ с id таска, не дожидаясь выполнения.

Info

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

URL-адрес

Метод: POST

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

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

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


Code Block
    {
        "H1": "Weather alert",
        "H2": "Welcome"
    }



НетКонтент для переменных
apicontent
в сообщениях.
custom_dataJSON object
{ "field": "value" }
Нет

Контент для переменных apicontent в сообщениях

dataarray


Code Block
[ 
	{"email": "profile1@example.com"}, 
	{"email": "profile2@example.com"} 
]


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

"email"

"email_profile"

"email_sub"

"phone"

"phone_sub"

"profile_id"

"push_sub"

"custom"

"custom_sub"

"email_phone"

"email_phone_sub"

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

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

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

emailstring"john@example.com"

"matching":"email" - по профилю и подпискам

"matching":"email_profile" - только по профилю

"matching":"email_sub" - только по подпискам

Email-адрес
phonestring"+79000000000"

"matching":"phone" - по телефону из профиля и подписок

"matching":"phone_sub" - по телефону из подписок

Номер телефона
profile_idstring
"abcdefghijklmnqrstuvwxyz"
"matching":"profile_id"Идентификатор профиля
field_namestring


"matching":"custom"Название поля для поиска
field_value

"matching":"custom"Значение поля для поиска
custom_requestJSON object
Если нет свойства "matching"MongoDB запрос по полям профиля

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

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

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

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

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

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

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

Code Block
{
	"error": 0,
	"error_text": "Successful operation",
	"task_id": "30421978-7f6d-4f39-913f-fb6cad8e2477"
}

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

Code Block
{
	"error":400,
	"error_debug":"http: request body too large",
	"error_text":"Invalid request"
}