Get door sensor settings

Returns info about door sensor options

Responses

• 200
• 401
• 403

---

OK

application/json

• Schema
• Example (from schema)
• A A and B I panels
• A V-08 panel

---

Schema

• enable boolean

  Feature activation

• repeating_message_delay integer

  Time in seconds after which the panel will send the next message if the sensor is not closed

• repeating_message_enable boolean

  Resending messages if one message is not enough

• opening_delay integer

  Door sensor open timeout to start sending alerts

• available_modes string[]

  Possible values: [door_sensor, enter_button, concierge]

  door sensor - the contacts work as contacts of a door sensor, when the contacts are opened after the time specified in the parameter, the panel sends a message that the door has been open for too long

  enter_button - when the contacts are closed, it opens the door with a notification in the log that the door is open with the entry button

  concierge - call the concierge when the contacts are closed

• mode object

  Door mode

  anyOf

  • MOD1
  • MOD2

  ---

  string

  Possible values: [door_sensor, enter_button, concierge]

  The model represents available door access modes

  string

  Possible values: [door_sensor, enter_button]

  Params that available only on individual panels

{
  "enable": false,
  "repeating_message_delay": 60,
  "repeating_message_enable": false,
  "opening_delay": 120,
  "available_modes": [
    "door_sensor",
    "enter_button",
    "concierge"
  ],
  "mode": "enter_button"
}

{
  "enable": false,
  "repeating_message_delay": 60,
  "repeating_message_enable": false,
  "opening_delay": 120,
  "available_modes": [
    "door_sensor",
    "enter_button",
    "concierge"
  ],
  "mode": "door_sensor"
}

{
  "enable": false,
  "repeating_message_delay": 60,
  "repeating_message_enable": false,
  "opening_delay": 120,
  "available_modes": [
    "door_sensor",
    "enter_button"
  ],
  "mode": "door_sensor"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Loading...