Массовая отправка триггера

Описание

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

Данный запрос является 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 из профиля или подписок	Режим поиска подписчика. По умолчанию - email. Подробнее о матчинге здесь.

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
result	array	Идентификаторы профилей, которым отправлена кампания

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

JSON

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

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <trigger_id>85</trigger_id>
    <format>xml</format>
    <matching>email</matching>
    <data>
        <email>example3@example.com</email>
    </data>
    <data>
        <email>example4@example.com</email>
    </data>
</xml>

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

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "trigger_id": 96,
    "format": "json",
    "skip_triggers": false,
    "matching": "custom",
    "field_name": "Custom_ID",
    "data": [
        {
            "field_value": "003"
        },
        {
            "field_value": "002"
        }
    ]
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <trigger_id>85</trigger_id>
  <format>xml</format>
  <skip_triggers>false</skip_triggers>
  <matching>custom</matching>
  <field_name>Custom_ID</field_name>
  <data>
    <field_value>YY</field_value>
  </data>
    <data>
    <field_value>AA</field_value>
  </data>
</xml>

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

JSON

{
    "error": 0,
    "error_text": "Successful operation",
    "result": [
        {
            "profile_id": "6606e08f10bcdd88297057a7"
        },
        {
            "profile_id": "66101437dc4594c2934da6da"
        }
    ]
}

XML

<xml>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <result>
        <profile_id>66101437dc4594c2934da6da</profile_id>
    </result>
    <result>
        <profile_id>6606e08f10bcdd88297057a7</profile_id>
    </result>
</xml>

JSON

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

XML

<xml>
   <error>400</error>
   <error_debug>http: request body too large</error_debug>
   <error_text>Invalid request</error_text>
</xml>