AlertRule

  • accountId
    Type: stringFormat: uuid
    required
  • assetId
    Type: stringFormat: uuid
    required
  • channel
    Type: object · AlertRuleChannel
    required
    • type
      Type: integer · ChannelTypeenum
      required

      Integer numbers.

      values
      • 1

        Call

      • 2

        Sms

      • 3

        Telegram

      • 4

        Email

    • call
      Type: object · CallChannelOptions nullable
    • email
      Type: object · EmailChannelOptions nullable
    • sms
      Type: object · SmsChannelOptions nullable
    • telegram
      Type: object · TelegramChannelOptions nullable
  • eventType
    Type: integer · EventTypeenum
    required

    Integer numbers.

    values
    • 1

      InputPowerDisconnected

    • 2

      InputVoltageLow

    • 3

      BatteryLow

    • 4

      Jammed

    • 5

      MovementStarted

  • id
    Type: stringFormat: uuid
    required
  • order
    Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32
    required

    Signed 32-bit integers (commonly used integer type).

  • recipient
    Type: object · Recipient
    required
    • culture
      required
    • phoneNumber
      Type: string
      required

      The phone number of the recipient in E.164 format (e.g. +1234567890).

    • timeZone
      required
    • description
      Type: null | string
  • dates
    Type: object · DateRange nullable
    • from
      Type: stringFormat: date
      required

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

    • to
      Type: stringFormat: date
      required

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • daysOfWeek
    Type: array integer[] | null · DayOfWeek[]enum
    values
    • 0
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • Type: integer · DayOfWeekenum

      Integer numbers.

      values
      • 0

        Sunday

      • 1

        Monday

      • 2

        Tuesday

      • 3

        Wednesday

      • 4

        Thursday

      • 5

        Friday

      • 6

        Saturday

  • insideGeofences
    Type: array string[] | null
  • isDisabled
    Type: boolean
  • outsideGeofences
    Type: array string[] | null
  • timeOfDay
    Type: object · TimeRange nullable
    • from
      Type: stringFormat: time
      required

      Start time (00:00:00 - 23:59:59)

    • to
      Type: stringFormat: time
      required

      End time (00:00:00 - 23:59:59)