Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

Описание

Данный запрос позволяет импортировать несколько профилей и сразу отправить их в сценарий, он является batch-версией запроса Одновременный импорт и запуск профиля в сценарий.

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


URL-адрес

Метод: POST

https://example.com/api/v1.1/workflows/import_and_start_batch

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
formatstring"json"НетФормат возвращаемых данных (по умолчанию - "json")
workflow_idInt1ДаИдентификатор цепочки
matchingString"email"Да

Режим поиска подписчика.

По умолчанию - email. 

profile_idString
"5f19953a03e4227216278ba4"
"matching":"profile_id"Идентификатор профиля
emailString
"importStart9219@example.com"

"matching":"email" - по профилю и подпискам

"matching":"email_profile" - только по профилю

Email-адрес
phoneString"+79001234567""matching":"phone"Номер телефона
field_nameString"CRM_ID""matching":"custom"Название кастомного поля профиля для поиска. 
field_valueAny"12345""matching":"custom"

Значение кастомного поля для поиска.

Доступен поиск по сочетанию значений поля с типом "тэги". Тэги передаются в строке черз запятую: "тэг_1, тэг_2".
dataObject

{
    "_fname": "John",
    "_lname": "Doe"
}

НетДанные о профиле, в том числе подписки
skip_triggersBooltrueНетПропустить запуск триггеров
по умолчанию – false
skip_invalid_subscriptionsBooltrueНетПропустить невалидные подписки
по умолчанию – false
detect_geoBooltrueНет

Включает автоопределение geo данных по полю _regip  или _ip в data

contentObject

"content": {
    "one": "My email = importStart9219@example.com",
    "two": "Timestamp: 1595512477",
    "three": "Three"
},

Нет

Дополнительные данные для подстановки в шаблон сообщения переменной {apicontent.fieldname}. Так же {apicontent}  можно использовать в узлах "API вызов" и "Контент фильтр"

attacharray of {name, flie_key, data, mimetype}
НетФайл для прикрепления к Email сообщению (только для Email триггеров)
custom_requestJSON object
Если нет свойства "matching"MongoDB запрос по полям профиля
subscriptionJSON object
Email
{
	"channel_sid": "email",
	"resource_id": 47,
	"email_data": {
	"email":"example1@example.com"
	}
}
SMS
{
	"channel_sid": "sms",
	"resource_id": 47,
	"phone_data": {
	"phone":"+79000000001"
	}
}
PUSH
{
	"channel_sid": "push",
	"resource_id": 47,
	"push_data": {
	"subscription_id":"12345",
	"provider": "ChromeFirebase"
	}
}

Подписки профиля.

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

ПараметрТипОписание
error_textstringТекст ошибки
errorintКод ошибки
task_idstringИдентификатор задачи

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

{
	"token": "abcdefghijklmnqrstuvwxyz",
	"workflow_id": 2,
	"matching": "email",
	"data": [
		{
			"data": {
				"_fname": "Herbert",
				"_lname": "Lambert",
				"email": "profile5@example.com",
				"phones": "+790000000000"
			}
		},
		{
			"data": {
				"_fname": "Bert",
				"_lname": "Lambert",
				"email": "profile8@example.com",
				"phones": "+790000000000"
			}
		}
	]
}

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

{
	"token": "abcdefghijklmnqrstuvwxyz",
	"workflow_id": 233,
	"matching": "custom",
	"field_name": "New_field_1",
	"data": [
		{
			"data": {
			"_fname": "NUMBER15",
			"_lname": "Lambert",
			"email": "profile015@example.com",
			"phones": "+790000000015",
			"New_field_1": "00015"
			}
		},
		{
			"data": {
				"_fname": "NUMBER16",
				"_lname": "Lambert",
				"email": "profile016@example.com",
				"phones": "+790000000016",
				"New_field_1": "00016"
			}
		}
	]
}

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

{
	"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"
}
  • No labels