Функции для работы с оповещениям
Описание и характеристика функций модуля Автоматизации, которые можно использовать при отправке уведомлений.
Функции отправки сообщений
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 Модель конфигурации
-