Задание на массовую отправку триггера

Описание

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

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

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

примечание

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

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию – "json")
id	int	5511	Да	Идентификатор кампании
attach	JSON array of File object	[]	Нет	File object
content	JSON object	{ "H1": "Weather alert", "H2": "Welcome" }	Нет	Контент для переменных apicontent в сообщениях.
custom_data	JSON object	{ "field": "value" }	Нет	Данные для Захвата событий (Action hooks). Можно передавать как в корне запроса, так и в каждом объекте data отдельно.
data	array	[    {"email": "profile1@example.com"},    {"email": "profile2@example.com"} ]	Да	Поле в базе данных и его значение, по которому будет произведен поиск нужного профиля.
Настройки поиска профиля
matching	string	"email" "email_profile" "email_sub" "phone" "phone_sub" "profile_id" "push_sub" "custom" "custom_sub" "email_phone" "email_phone_sub"	Нет, если поиск по email из профиля или подписок	Режим поиска подписчика. По умолчанию - email.
email	string	"john@example.com"	"matching":"email" - по профилю и подпискам "matching":"email_profile" - только по профилю "matching":"email_sub" - только по подпискам	Email-адрес
phone	string	"+79000000000"	"matching":"phone" - по телефону из профиля и подписок "matching":"phone_sub" - по телефону из подписок"	Номер телефона
profile_id	string	"abcdefghijklmnqrstuvwxyz"	"matching":"profile_id"	Идентификатор профиля
field_name	string	"CRM_ID"	"matching":"custom"	Название кастомного поля профиля для поиска.
field_value	int/string	"12345"	"matching":"custom"	Значение кастомного поля для поиска.
custom_request	JSON object		Если нет свойства "matching"	MongoDB запрос по полям профиля

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
task_id	string	Идентификатор задачи

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

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

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

{
	"token": "abcdefghijklmnqrstuvwxyz",
	"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",
	"task_id": "30421978-7f6d-4f39-913f-fb6cad8e2477"
}

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

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