7. Создание шаблона уведомления
Шаблон уведомлений − это формализованный образец содержания уведомления для определенного типа события. Шаблон уведомлений требуется для объединения однотипных событий при формировании уведомлений пользователям. На основании шаблона будет сформировано содержание уведомления.
Для корректной отправки уведомления пользователю необходимо осуществить настройку дополнительных компонентов в сценариях Создание действия для отправки уведомления, Создание правила для срабатывания действия и Настройка пересылки событий.
Для создания шаблона уведомления используйте метод POST /front-api-srv/api/v1.0/notification. В теле запроса нужно указать параметры и их значения.
| Параметр | Тип | Тип данных | Обяз. | Описание | Пример |
|---|---|---|---|---|---|
| name | body | string | + | Наименование шаблона | RSSI выше 0! |
| priority | body | string | + | Приоритет события по шаблону | medium |
| templates | body | array[object] | - | Массив шаблонов уведомлений | - |
| defaultReceivers | body | object | + | Объект получателей уведомления по умолчанию | - |
object "templates"
| Параметр | Тип | Тип данных | Обяз. | Описание | Пример |
|---|---|---|---|---|---|
| message | body | string | - | Текст шаблона уведомления | rssi повысился до {*rssi*} |
| subject | body | string | - | Тема шаблона уведомления | rssi выше 0 |
| channel | body | string | - | Канал шаблона уведомления | telegram |
object "defaultReceivers"
| Параметр | Тип | Тип данных | Обяз. | Описание | Пример |
|---|---|---|---|---|---|
| addresses | body | array[object] | - | Массив прямых адресов получателей уведомления | - |
object "addresses"
| Параметр | Тип | Тип данных | Обяз. | Описание | Пример |
|---|---|---|---|---|---|
| channel | body | string | - | Канал отправки уведомления (доступные каналы — telegram, email) | telegram |
| account | body | string | - | Адрес отправки уведомления | User 1 |
| accountType | body | string | - | Тип адреса. Применимо для канала связи telegram. Возможные варианты: userChatId, groupChatId, userLogin | userChatId |
Пример тела запроса:
{
"name": "RSSI выше 0!",
"priority": "medium",
"templates": [
{
"message": "rssi повысился до {*rssi*}",
"subject": "rssi выше 0",
"channel": "telegram"
}
],
"defaultReceivers": {
"addresses": [
{
"channel": "telegram",
"account": "User 1",
"accountType": "userChatId"
}
]
}
}После успешного выполнения запроса будет получен ответ, который содержит сохраненные данные шаблона уведомлений, и параметр notificationTypeId, который будет использоваться на следующем шаге процесса.
В случае ошибки обработки запроса в ответе будет получен код ошибки, по которому можно определить ее характер и устранить возможную проблему.
Пример ответа:
{
"name": "RSSI выше 0!",
"tenantId": "00f00a00-e00f-0a00-af0a-c0af00e0ff00",
"priority": "medium",
"templates": [
{
"id": "0be10d9d-fd66-4268-a672-192cb7950872",
"subject": "rssi выше 0",
"message": "rssi повысился до {*rssi*}",
"channel": "telegram",
"placeholders": [
"fio"
]
}
],
"defaultReceivers": {
"clientRoles": [],
"clientUsers": [],
"clientUserContacts": [],
"addresses": [
{
"channel": "telegram",
"account": "User 1",
"accountType": "userChatId"
}
]
},
"id": "8609430e-03f2-4f5f-8b6a-4137dd91a394"
}