$jsapi.sendToDynamicTextCampaign

Метод позволяет отправить событие с использованием параметров шаблона рассылки. Он должен быть создан заранее с помощью:

• $jsapi.createSendingTemplate()
• POST /text-campaign-service/dynamics/sending-templates

Синтаксис

ECMAScript 5

$jsapi.sendToDynamicTextCampaign({
    "eventSendingTemplateUuid": "template.id",
    "eventData": {},
    "callbackUrl": "https://webhook.site/dd9c5100-7ac7-48ad-a10c-85d151c9830c",
    "priority": 0,
    "sendingTime": "2023-10-01T12:00:00Z"
});

ECMAScript 6

В среде ECMAScript 6 метод является асинхронным. Вы можете передавать аргументы только по позициям:

await $jsapi.sendToDynamicTextCampaign(
    "template.id", 
    {},
    "https://webhook.site/dd9c5100-7ac7-48ad-a10c-85d151c9830c",
    0,
    "2023-10-01T12:00:00Z"
);

Принимаемые аргументы

Метод $jsapi.sendToDynamicTextCampaign() принимает следующие аргументы:

Аргумент	Тип	Описание	Обязательный	Пример
eventSendingTemplateUuid	Строка	UUID шаблона рассылки, в рамках которого будет отправлено событие. Возвращается в ответе на запрос создания рассылки.	Да	"template.id"
eventData	Объект	Дополнительные данные события, которые будут отправлены вместе с событием. Если в событии нет данных, то нужно передать пустой объект.	Да	{ "key": "value" }
callbackUrl	Строка	Ваш URL для получения статусов доставки. Формат данных и описание статусов приведены в разделе Динамические рассылки.	Нет	"https://webhook.site/dd9c5100-7ac7-48ad-a10c-85d151c9830c"
priority	Число	Приоритет отправки события. Чем ниже значение, тем выше приоритет.	Нет	0
sendingTime	Строка	Время отправки в формате ISO 8601.	Нет	"2023-10-01T12:00:00Z"

к сведению

• В среде ECMAScript 6 для необязательных аргументов нужно явно указывать null, если вы не хотите их использовать.
• Если вы не укажете необязательные аргументы, будут использованы значения из шаблона рассылки.
• Переопределить replies в шаблоне с помощью $jsapi.sendToDynamicTextCampaign() нельзя. Для этого используйте метод POST /text-campaign-service/dynamics/send-replies.

Возвращаемое значение

{
    "uuid": "{UUID}" // UUID отправленного события
}