Get DTMF code settings

Get DTMF code setting for first and second locks

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• codes object

  Dtmf codes

  first object

  DTMF for first lock

  use_default_value boolean

  Default value: false

  If true '#' will be used

  custom_value string

  Possible values: Value must match regular expression ^([0-9*#]{1,4})$

  Default value: #

  Custom value that will be used

  second object

  DTMF for second lock

  is_enabled boolean

  Default value: false

  Is feature enabled?

  value string

  Possible values: Value must match regular expression ^([0-9*#]{1,4})$

  Default value: 0

  Custom value that will be used

  elevator object

  DTMF for elevator lock

  use_default_value boolean

  Default value: false

  If true '#' will be used

  custom_value string

  Possible values: Value must match regular expression ^[\\d*#ABCD]{1,4}$

  Default value: DC

  Custom value that will be used

{
  "codes": {
    "first": {
      "use_default_value": true,
      "custom_value": "#"
    },
    "second": {
      "is_enabled": true,
      "value": "0"
    },
    "elevator": {
      "use_default_value": true,
      "custom_value": "DC"
    }
  }
}

{
  "codes": {
    "first": {
      "use_default_value": false,
      "custom_value": "#"
    },
    "second": {
      "is_enabled": false,
      "value": "0"
    }
  }
}

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Describes the base error user might get

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  Describes the parameter that did not pass a validation

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be a string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Log In"
  }
}

Loading...