8. Создание действия для отправки уведомления

Действие для отправки уведомления необходимо для определения параметров, определяющих событие на устройстве.

Чтобы создать действие для отправки уведомлений используйте метод POST /front-api-srv/api/v1.0/action.

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
functions	body	array[object]	+	Действие	-

object “functions”

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
method	body	string	+	Название метода действия для отправки уведомления	sendNotification
payload	body	array[object]	+	Принадлежность к шаблону уведомления или операции	-
params	body	array[object]	+	Параметры действия. При выполнении запроса значения объекта могут отсутствовать.	-

object “payload”

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
notificationTypeId	body	string	+	Идентификатор типа шаблона уведомления	8609430e-03f2-4f5f-8b6a-4137dd91a394
priority	body	string	+	Приоритет	medium
variables	body	array	-	Переменные	-

Пример тела запроса:

1
{
2
  "functions": [
3
    {
4
      "method": "sendNotification",
5
      "payload": {
6
        "notificationTypeId": "8609430e-03f2-4f5f-8b6a-4137dd91a394",
7
        "priority": "medium",
8
        "variables": {
9
        }
10
      },
11
      "params": []
12
    }
13
  ]
14
}

После успешного выполнения запроса будет получен ответ, который содержит сохраненные действия отправки уведомлений, и параметр actionId, который будет использоваться на следующем шаге процесса.

В случае ошибки обработки запроса в ответе будет получен код ошибки, по которому можно определить ее характер и устранить возможную проблему.

Пример ответа:

1
{
2
    "id": "d0330eaf-393d-4c26-bfb7-893c2aa0ca43",
3
    "functions": [
4
      {
5
        "id": "0ef49d23-48a6-49b3-83af-b3c3a41764dd",
6
        "method": "sendNotification",
7
        "payload": {
8
           "notificationTypeId": "8609430e-03f2-4f5f-8b6a-4137dd91a394",
9
           "priority": "medium",
10
        "variables": {
11
         }
12
        },
13
        "params": []
14
     }
15
  ]
16
}