Set DTMF settings

Configures DTMF settings used for opening lock during call

First key is always available, second key might be disabled. First key has value by default. If 'default_value' is disabled, key uses data from 'value' field.

application/json

Request Body

• first_key object required

  First key settings

  name string

  Key name

  default_value boolean

  Determines whether the default DTMF is enabled

  value string

  Possible values: non-empty and <= 4 characters, Value must match regular expression ^[\d*#A-D]{1,4}$

  Custom DTMF value

• second_key object required

  Second key settings

  enabled boolean

  Determines whether the second DTMF key is enabled

  name string

  Key name

  value string

  Possible values: non-empty and <= 4 characters, Value must match regular expression ^[\d*#A-D]{1,4}$

  Custom DTMF value

• elevator object

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

  DTMF code for calling lift. If 'default_value' is enabled device will use default 'DACB' DTMF value for elevator

  value string

  Possible values: non-empty and <= 4 characters

  Custom DTMF value

  default_value boolean

  Determines whether the default DTMF is enabled

Responses

• 200
• 400
• 401

---

OK

• Wrong DTMF value

Validation error. Required fields are not provided.

• Missed json body or wrong param. Response sample:

  "error": "Wrong JSON body"

• Required field is not provided. Response sample:

  "error": "Wrong JSON body: no value for `param`"

where param - is a required field that was not provided

• Field was of the wrong type. Response sample:

  "error": "Wrong JSON body: value `param` was of the wrong type"

where param - is a field of the wrong type

application/json

• Schema
• Example (from schema)
• Wrong D T M F
• Base
• No value
• Wrong param type

---

Schema

• error string

  Error information

{
  "error": true
}

{
  "error": "Wrong DTMF value"
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error information

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...