Описание
Отправить профиль клиента в сценарий (цепочку).
URL-адрес
Метод: POST
https://example.com/api/v1.1/workflows/start
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
| format | string | "json" | Нет | Формат возвращаемых данных по умолчанию – "json" |
| id | int | 12 | Да | Идентификатор сценария |
| content | JSON-object | {} | Нет | Дополнительные данные для подстановки в шаблон сообщения переменной {apicontent.fieldname}. Так же {apicontent} можно использовать в узлах "API вызов" и "Контент фильтр" |
| attach | JSON-массив | [] | Нет | Приложить файлы к сообщению |
| Поиск профиля подписчика | ||||
| matching | string | "email" "email_profile" "email_sub" "phone" "phone_sub" "profile_id" "push_sub" "custom" "custom_sub" "email_phone" "email_phone_sub" | Нет, если поиск по 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" | Значение кастомного поля для поиска. Доступен поиск по сочетанию значений поля с типом "тэги". Тэги передаются в строке черз запятую: "тэг_1, тэг_2". |
| resource_id | int | 24 | Нет | Идентификатор ресурса для |
| 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" будет использована любая подходящая подписка. |
Пример запроса
Отправить один профиль в сценарий.
{
"token": "abcdefghijklmnqrstuvwxyz",
"id": 5511,
"matching": "profile_id",
"profile_id": "5a74876369d42613b31947b8"
}
Добавить профиль в сценарий с дополнительным контентом, который можно подставлять в любые кампании, запланированные в сценарии. По данным, которые переданы в дополнительном контенте, возможно сформировать условия выбора. Для этого используйте в сценарии ноду "Контент Фильтр".
Вставить текст "New videos on your favorite channels" на место переменной "{apicontent.email_title}", если она используется в сообщении.
Приложить к сообщению файлы "日本.txt" и "US.txt".
{
"attach": [
{
"data": "data:text/csv;base64,5LuK5pel44GvCg==",
"name": "日本.txt"
},
{
"data": "data:text/csv;base64,SEVMTE8K",
"name": "US.txt"
}
],
"content": {
"data_lines": [
"Channel A",
"Channel B"
],
"email_title": "New videos on your favorite channels"
},
"id": 5511,
"token": "abcdefghijklmnqrstuvwxyz"
}
Пример ответа
{
"error": 0,
"error_text": "Successful operation"
}
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |