Массовый импорт профилей + отправка триггера

Описание

Добавление или обновление нескольких профилей с последующей отправкой триггерной кампании.

Данный запрос является batch-версией запроса Импорт профиля + Отправка триггера.

примечание

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

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
Импорт профиля клиента
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
data	JSON object	[    {       "data": {          "_fname": "John",          "_lname": "Lambert",          "email": "profile4@example.com",          "phones": "+79000000000"       }    },    {       "data": {          "_fname": "Tom",          "_lname": "Hard",          "email": "profile3@example.com",          "phones": "+79000000001"       }    } ]	Нет	Данные о профиле, в том числе подписки. Каждый профиль — это отдельный JSON-объект "data".
skip_triggers	bool	true	Нет	Пропустить запуск триггеров. По умолчанию – false.
skip_invalid_subscriptions	bool	true	Нет	Пропустить невалидные подписки. По умолчанию – false.
detect_geo	bool	true	Нет	Включает автоопределение geo данных по полю _regip или _ip в data
subscription_filter	JSON object	Пример для push: "subscription_filter": {    "email": "example@example.com",    "phone": "+79106135133",    "subscription_id": "CAREFULWITHTHATAXE",    "provider": "Chrome",    "not_strict": true } Пример для email: "subscription_filter": {    "email": "example@example.com",    "not_strict": true } Пример для sms: "subscription_filter": {    "phone": "+79106135133",    "not_strict": false }	Нет	Выбирает конкретную подписку профиля для отправки. Если передан поиск профиля по custom, profile_id или custom_request . not_strict определяет, что делать, если подписка не найдена. В случае "true" будет использована любая подходящая подписка.
Поиск профиля подписчика для обновления
matching	string	"email" "email_profile" "phone" "profile_id" "custom"	Нет, если поиск по email из профиля или подписок	Режим поиска подписчика. по умолчанию - email. Подробнее.
email	string	"john@example.com"	"matching":"email" - по профилю и подпискам "matching":"email_profile" - только по профилю	Email-адрес
phone	string	"+79000000000"	"matching":"phone"	Номер телефона
profile_id	string	"abcdefghijklmnqrstuvwxyz"	"matching":"profile_id"	Идентификатор профиля
field_name	string	"CRM_ID"	"matching":"custom"	Название кастомного поля профиля для поиска.
field_value	int/string	"12345"	"matching":"custom"	Значение кастомного поля для поиска. подсказка Доступен поиск по сочетанию значений поля с типом "теги". Теги передаются в строке черз запятую: "тег_1, тег_2".
resource_id	int	24	Да	Идентификатор ресурса для поиска по email и phone
Запуск триггера
trigger_id	int	13	Да	Идентификатор триггерной кампании для запуска
timeout	JSON object	{ "days": 0, "hours": 0, "minutes": 5 }	Нет	Задержка перед запуском триггера. Указываются дни, часы и минуты.
custom_data	JSON object	{ "sending_time": "12:31:12" }	Нет	Данные для Захвата событий (Action hooks)
content	JSON object	{ "page": "registration_form" }	Нет	Дополнительные данные для подстановки в шаблон сообщения переменной {apicontent.fieldname}
attach	JSON objects array	{ "data": "data:text/csv;base64,SEVMTE8K", "name": "Attach.txt" }	Нет	Файл для прикрепления к email сообщению (только для email триггеров)

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

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

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

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "trigger_id": 96,
    "format": "json",
    "skip_triggers": false,
    "detect_geo": true,
    "matching": "email",
    "data": [
        {
            "data": {
                "_fname": "Lili",
                "_lname": "Collins",
                "email": "example@example.com",
                "phones": "+79000000000",
                "subscriptions": [
                    {
                        "channel": "email",
                        "email": "example@example.com",
                        "priority": 0,
                        "resource_id": 21,
                        "status": 0
                    }
                ]
            }
        },
        {
            "data": {
                "_fname": "Eva",
                "_lname": "Collins",
                "email": "example@example.com",
                "phones": "+79000000001",
                "subscriptions": [
                    {
                        "channel": "email",
                        "email": "example@example.com",
                        "priority": 0,
                        "resource_id": 21,
                        "status": 0
                    }
                ]
            }
        }
    ]
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <trigger_id>96</trigger_id>
    <format>xml</format>
    <skip_triggers>false</skip_triggers>
    <detect_geo>true</detect_geo>
    <matching>email</matching>
<data>
    <_fname>Lili</_fname>
    <_lname>Collins</_lname>
    <email>example@example.com</email>
    <phones>+79000000000</phones>
        <subscriptions>
            <channel>email</channel>
            <email>example@example.com</email>
            <priority>0</priority>
            <resource_id>21</resource_id>
            <status>0</status>
        </subscriptions>
</data>
<data>
    <_fname>Eva</_fname>
    <_lname>Collins</_lname>
    <email>example@example.com</email>
    <phones>+79000000001</phones>
    <subscriptions>
        <channel>email</channel>
        <email>example@example.com</email>
        <priority>0</priority>
        <resource_id>21</resource_id>
        <status>0</status>
    </subscriptions>
</data>
</xml>

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

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "trigger_id": 85,
    "format": "json",
    "skip_triggers": false,
    "detect_geo": true,
    "matching": "custom",
    "field_name": "Custom_ID",
    "data": [
        {
            "data": {
                "_fname": "Adama",
                "_lname": "Fuller",
                "email": "example@example.com,
                "phones": "+79000000000",
                "Custom_ID": "345",
                "subscriptions": [
                    {
                        "channel": "email",
                        "email": "example@example.com",
                        "priority": 0,
                        "resource_id": 21,
                        "status": 0
                    }
                ]
            }
        },
        {
            "data": {
                "_fname": "Eva",
                "_lname": "Fuller",
                "email": "example@example.com",
                "phones": "+79000000001",
                "Custom_ID": "567",
                "subscriptions": [
                    {
                        "channel": "email",
                        "email": "example@example.com",
                        "priority": 0,
                        "resource_id": 21,
                        "status": 0
                    }
                ]
            }
        }
    ]
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <trigger_id>85</trigger_id>
    <format>xml</format>
    <skip_triggers>false</skip_triggers>
    <detect_geo>true</detect_geo>
    <matching>custom</matching>
    <field_name>custom_field</field_name>
    <data>
        <_fname>Irina</_fname>
        <_lname>Depp</_lname>
        <email>example@example.com</email>
        <phones>+79000000000</phones>
        <custom_field>343</custom_field>
        <subscriptions array='true'>
            <channel>email</channel>
            <email>example@example.com</email>
            <priority>0</priority>
            <resource_id>21</resource_id>
            <status>0</status>
        </subscriptions>
    </data>
    <data>
        <_fname>Will</_fname>
        <_lname>Depp</_lname>
        <email>example@example.com</email>
        <phones>+79000000001</phones>
        <custom_field>560</custom_field>
        <subscriptions array='true'>
            <channel>email</channel>
            <email>example@example.com</email>
            <priority>0</priority>
            <resource_id>21</resource_id>
            <status>0</status>
        </subscriptions>
    </data>
</xml>

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

JSON

{
    "error": 0,
    "error_text": "Successful operation",
    "result": [
        {
            "profile_id": "661027b04a5d12bd6cc09125"
        },
        {
            "profile_id": "661027b04a5d12bd6cc09129"
        }
    ]
}

XML

<xml>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <result>
        <profile_id>661027b04a5d12bd6cc09125</profile_id>
    </result>
    <result>
        <profile_id>661027b04a5d12bd6cc09129</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>