Описание
Запуск триггер кампании для нескольких профилей.
Данный запрос является batch-версией запроса Запуск триггерной кампании (API call).
Тело запроса ограничено по умолчанию до 10мб, исключение: файлы - 100мб
URL-адрес
Метод: POST
http://example.com/api/v1.1/campaigns/triggers/start_batch
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
| format | string | "json" | Нет | Формат возвращаемых данных по умолчанию – "json" |
| trigger_id | int | 1 | Да | Идентификатор кампании |
| attach | JSON array of File object | [] | Нет | File object |
| content | JSON object | {
"H1": "Weather alert",
"H2": "Welcome"
}
| Нет | Контент для переменных apicontent в сообщениях. |
| custom_data | JSON object | { "field": "value" } | Нет | Пользовательские параметры, возвращаются в хуках (Захват событий) |
| data | array | [
{"email": "profile1@example.com"},
{"email": "profile2@example.com"}
]
| Да | Поле в базе данных и его значение, по которому будет произведен поиск нужного профиля. Подробнее о data здесь. |
| Поиск профиля подписчика для отправки триггера | ||||
| matching | string | "email" "email_profile" "email_sub" "phone" "phone_sub" "profile_id" "push_sub" "custom" "custom_sub" "email_phone" "email_phone_sub" | Нет, если поиск по email из профиля или подписок | Режим поиска подписчика. Подробнее о матчинге здесь. |
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |
| task_id | string | Идентификатор задачи |
Пример запроса с матчингом по 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"
}