Вернуться наверх
На этой странице:

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

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

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

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

object "functions"

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

object "payload"

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

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

json
{
  "functions": [
    {
      "method": "sendNotification", 
      "payload": {
        "notificationTypeId": "8609430e-03f2-4f5f-8b6a-4137dd91a394",
        "priority": "medium",
        "variables": {
        }
      },
      "params": []
    }
  ]
}

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

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

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

json
{
    "id": "d0330eaf-393d-4c26-bfb7-893c2aa0ca43",
    "functions": [
      {
        "id": "0ef49d23-48a6-49b3-83af-b3c3a41764dd",
        "method": "sendNotification",
        "payload": {
           "notificationTypeId": "8609430e-03f2-4f5f-8b6a-4137dd91a394",
           "priority": "medium",
        "variables": {
         } 
        },
        "params": []
     }
  ]
}