Функции для работы с оповещениям
Описание и характеристика функций модуля Автоматизации, которые можно использовать при отправке уведомлений.
Функции отправки сообщений
SendEmail
-
Назначение: Отправка почтовых сообщений
-
Описание: Функция позволяет отправить письмо через указанный SMTP сервер.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Message Struct:EmailMessage Модель сообщения Связь Configuration Struct:EmailConfiguration Модель конфигурации Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Error String Текст ошибки, в случае ее возникновения Связь
-
Struct - EmailMessage
Описание структуры Struct:EmailMessage:
| Пин | Тип | Описание |
|---|---|---|
| Subject | String | Тема письма |
| Body | String | Текст письма |
| MailType | String | Формат письма (plain/html) |
| Recipients | String (array) | Список адресов получателей |
Struct - EmailConfiguration
Описание структуры Struct:EmailConfiguration:
| Пин | Тип | Описание |
|---|---|---|
| FromName | String | Имя отправителя |
| FromEmail | String | Адрес отправителя |
| Host | String | Адрес SMTP сервера |
| Port | Integer | Порт сервера |
| Username | String | Имя пользователя |
| Password | String | Пароль пользователя |
| SecureMode | String | Режим шифрования (TLS/SSL) |
SendEmailExtended
-
Назначение: Отправка почтовых сообщений через Подключения типов действий
-
Описание: Функция позволяет отправить письмо через настроенное подключение в Типе действий.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Scenario Struct:ScenarioBase Системная переменная Связь ConnectionCreds Struct:ConnectionsStructApi Модель подключения Связь Message Struct:EmailMessage Модель сообщения Связь DefaultCreds Struct:EmailConfiguration Модель конфигурации Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Error String Текст ошибки, в случае ее возникновения Связь
-
Struct - ConnectionsStructApi
Описание структуры Struct:ConnectionsStructApi: Служебная структура для передачи в функцию SendEmailExtended параметров подключения.
Struct - EmailMessage Ext
Описание структуры Struct:EmailMessage:
| Пин | Тип | Описание |
|---|---|---|
| Subject | String | Тема письма |
| Body | String | Текст письма |
| MailType | String | Формат письма (plain/html) |
| Recipients | String (array) | Список адресов получателей |
Struct - EmailConfiguration Ext
Описание структуры Struct:EmailConfiguration:
| Пин | Тип | Описание |
|---|---|---|
| FromName | String | Имя отправителя |
| FromEmail | String | Адрес отправителя |
| Host | String | Адрес SMTP сервера |
| Port | Integer | Порт сервера |
| Username | String | Имя пользователя |
| Password | String | Пароль пользователя |
| SecureMode | String | Режим шифрования (TLS/SSL) |
SendTelegramMessage
-
Назначение: Отправка сообщений через Telegram
-
Описание: Функция взаимодействия с API Telegram для отправки текстовых сообщений
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BotToken String Токен Telegram-бота Связь ChatId String Идентификатор чата в Telegram Связь Message Struct:TelegramMessage Модель сообщения Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Result Wildcard Ответ запроса Связь Response Struct:HttpResponse Возвращает результат выполнения запроса согласно модели HttpResponse Связь
-
Struct - TelegramMessage
Описание структуры Struct:EmailMessage:
| Пин | Тип | Описание |
|---|---|---|
| Text | String | Текст сообщения |
| ParseMode | String | Режим парсинга сообщения Telegram parse_mode |
| DisableWebPagePreview | Bool | Отключение предпросмотра ссылок в сообщении |
| DisableNotification | Bool | Отключение уведомления для сообщения |
| ProtectContent | Bool | Установка запрета на пересылку сообщения |
SendTelegramMessageExtended
-
Назначение: Отправка сообщений через Telegram
-
Описание: Функция взаимодействия с API Telegram для отправки текстовых сообщений
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Scenario Struct:ScenarioBase Системная переменная Связь ConnectionCreds Struct:ConnectionsStructApi Модель подключения Связь Recipients String(array) Список получателей (Telegram ChatId) Связь Message Struct:TelegramMessage Модель сообщения Связь DefaultCreds Struct:TelegramCreds Модель конфигурации Связь ProxyConfiguration Struct:ProxyConfiguration Модель конфигурации прокси-сервера Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Result Dynamic (array) Массив результатов выполнения каждого запроса в отдельности Связь Response Struct:HttpResponse Возвращает результат выполнения запроса согласно модели HttpResponse Связь
-
Struct - TelegramCreds
Описание структуры Struct:TelegramCreds:
| Пин | Тип | Описание |
|---|---|---|
| Token | String | Токен Telegram-бота |
Struct - ProxyConfiguration
Описание структуры `Struct:ProxyConfiguration:
| Пин | Тип | Описание |
|---|---|---|
| Address | String | Адрес сервера |
| Port | Integer | Порт сервера |
| Username | String | Пользователь |
| Password | String | Пароль |
SendImageTelegram
-
Назначение: Отправка сообщений через Telegram
-
Описание: Функция взаимодействия с API Telegram для отправки текстовых сообщений
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BotToken String Токен Telegram-бота Связь ChatId String Идентификатор чата в Telegram Связь Image Struct:TelegramImage Модель вложения Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Result Wildcard Ответ запроса Связь Response Struct:HttpResponse Возвращает результат выполнения запроса согласно модели HttpResponse Связь
-
Struct - TelegramImage
Описание структуры Struct:TelegramImage:
| Пин | Тип | Описание |
|---|---|---|
| ImageUri | String | Публичная ссылка на изображение |
| Bytes | Byte (array) | Массив байт изображения. Если указан ImageUri данный параметр игнорируется |
| FileName | String | Имя файла. Если оставить пустым будет задано дефолтное название Image |
| Caption | String | Описание изображения |
| Settings | Struct:TelegramImageSettings | Модель дополнительных настроек |
Struct - TelegramImageSettings
Описание структуры Struct:TelegramImageSettings:
| Пин | Тип | Описание |
|---|---|---|
| ParseMode | String | Режим парсинга сообщения Telegram parse_mode |
| HasSpoiler | Bool | Защита изображение спойлером. Изображение будет видно после нажатия на спойлер. |
| DisableNotification | Bool | Отключение уведомления для сообщения |
| ProtectContent | Bool | Установка запрета на пересылку сообщения |
FilterRecipients
-
Назначение: Вспомогательная функция фильтрации получателей из рассылки
-
Описание: Функция возвращает результат, согласно переданной в настройках действия рассылки (или нескольких рассылок)
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Scenario Struct:ScenarioBase Системная переменная Связь RecipientsList Struct:RecipientsListStructApi (Array) Массив моделей рассылок, получаемых из входной модели действия Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Result Struct:FilterRecipientsResult (Array) Модель подключения, которое указано для рассылки и список контактов Связь Error String Текст ошибки в случае выполнения запроса с ошибкой Связь -
Пример использования
-
Struct - FilterRecipientsResult
Описание структуры Struct:FilterRecipientsResult:
| Пин | Тип | Описание |
|---|---|---|
| Recipients | String (array) | Список контактов из рассылки |
| Connection | Struct:ConnectionsStructApi | Модель, используемого подключения в рассылке РГ |
GetConnectionCreds
-
Назначение: Вспомогательная функция получения данных подключения
-
Описание: Функция возвращает данные, определенные в качестве параметров подключения в типе действий
РекомендацияДля сохранности логинов и паролей, рекомендуем использовать данную функцию только при создании глобальных функций в собственных библиотеках автоматона.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Scenario Struct:ScenarioBase Системная переменная Связь BearerToken String Токен пользователя с правами администратора Связь Connection Struct:ConnectionsStructApi Модель, используемого подключения в рассылке РГ Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Result Wildcard Необходимо выбрать созданную структуру подключения, которая задействована в рассылке Связь Error String Текст ошибки в случае выполнения запроса с ошибкой Связь -
Пример использования
Пример структуры подключения из библиотеки
Libs_us1.NotificationService:
-
GetContacts
-
Назначение: Системная функция получения контактных данных пользователей
-
Описание: Функция используется при автоматическом создании функций рассылок, чтобы получить контактные данные для конкретных пользователей, согласно переданному типу контакта
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Scenario Struct:ScenarioBase Системная переменная Связь BearerToken String Токен пользователя с правами администратора Связь ContactId Integer64 Идентификатор контакта, который указан для подключения и по которому создана рассылка Связь UserIds Integer64 (Array) Массив идентификаторов пользователей, у которых из профилей будет забираться контактная информация Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Contacts String (Array) Массив строк с контактными данными Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponseСвязь
-
FilterUserIds
-
Назначение: Системная функция получения контактных данных пользователей при использовании ролей в рассылках
-
Описание: Функция используется при автоматическом создании функций рассылок, чтобы получить контактные данные для конкретных пользователей, согласно выбранной роли
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Scenario Struct:ScenarioBase Системная переменная Связь RoleIds Integer64 (Array) Массив идентификаторов ролей пользователей в РГ Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь UserIds Integer64 (Array) Массив идентификаторов пользователей, у которых в текущей РГ есть роли, переданные на вход Связь
-