$jsapi.createSendingTemplate

Метод создает шаблон динамической рассылки для отправки сообщений пользователям. Подробнее о порядке отправки сообщений в рамках таких рассылок можно прочитать в разделе Динамические рассылки.

Синтаксис

ECMAScript 5

$jsapi.createSendingTemplate({
    textCampaignName: "Имя рассылки",
    event: "",
    eventData: {},
    replies: [
        {
            "type": "text",
            "text": "Вам пришло новое уведомление!"
        },
        {
            "type": "image",
            "imageUrl": "https:/someurl.com/image.jpg"
        }
    ],
    botId: "237714518-mybot-256618725-fuZ-21048053393",
    clientId: "534134966",
    callbackUrl: "https://{hostName}/dd9c5100-7ac7-48ad-a10c-85d151c9830c",
    priority: 0
});

ECMAScript 6

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

await $jsapi.createSendingTemplate(
    "Имя рассылки",
    "",
    {},
    [
        {
            "type": "text",
            "text": "Вам пришло новое уведомление!"
        },
        {
            "type": "image",
            "imageUrl": "https:/someurl.com/image.jpg"
        }
    ],
    "4000001-my-4000001-mGO-30866",
    "534134966",
    "https://webhook.site/dd9c5100-7ac7-48ad-a10c-85d151c9830c",
    0
);

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

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

Аргумент	Тип	Описание	Обязательный	Пример
textCampaignName	Строка	Имя рассылки, в рамках которой будет отправлено сообщение. Рассылка должна быть заранее создана.	Да	"myTextCampaign"
event	Строка	Имя события. Должно быть заполнено или event и eventData, или replies.	Нет	"newNotification"
eventData	Объект	Дополнительные данные, которые будут отправлены в событии. Должно быть заполнено или event и eventData, или replies. Если в событии нет данных, то нужно передать пустой объект.	Нет	{ "key": "value" }
replies	Массив	Массив объектов, которые будут отправлены в сообщении. Должно быть заполнено или replies, или event и eventData. Подробнее о типах ответов читайте в разделе Ответы бота.	Нет	[ { "text": "Hello!" } ]
botId	Строка	Идентификатор бота. Можно найти на странице с подключенными каналами. Значение по умолчанию $request.botId.	Да	"237714518-mybot-256618725-fuZ-21048053393"
clientId	Строка	Идентификатор клиента, которому будет отправлено сообщение. Можно найти на странице Аналитика → Клиенты. Значение по умолчанию $request.userFrom.id.	Да	"1234567890"
callbackUrl	Строка	Ваш URL для получения статусов доставки. Формат данных и описание статусов приведены в разделе Динамические рассылки.	Нет	"https://webhook.site/dd9c5100-7ac7-48ad-a10c-85d151c9830c"
priority	Число	Приоритет отправки сообщений клиентам. Меньшее значение означает более высокий приоритет. Значение по умолчанию — 0.	Нет	2

к сведению

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

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

{
    "id": "{UUID}",
    "link": "https://example.com/text-campaign-service/dynamics/send-event-by-template/{UUID}"
}

Метод возвращает объект, который содержит поля:

• id — уникальный идентификатор шаблона рассылки, который можно использовать для отправки сообщений в рамках рассылки.
• link — URL для отправки события с использованием этого шаблона.