Set DTMF code for door lock
Configure DTMF code used for opening lock during call
DTMF code regex: ^[\d*#]{1,4}$
Path Parameters
- lock-number integer required
Possible values: [
0
,1
,2
]Lock number
- application/json
Request Body required
- dtmf_code string required
Possible values:
non-empty
and<= 4 characters
, Value must match regular expression^[\d*#A-D]{1,4}$
DTMF code
Responses
- 200
- 400
- 401
- 403
OK
- Wrong lock-number
- Wrong DTMF param
- DTMF code is already in use
- 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)
- Base
- No value
- Wrong param type
- Wrong lock number
- Wrong D T M F
- In Use
Schema
- error string
Error message
{
"error": true
}
{
"error": "Wrong JSON body"
}
{
"error": "Wrong JSON body: no value for `param`"
}
{
"error": "Wrong JSON body: value `param` was of the wrong type"
}
{
"error": "Wrong lock-number"
}
{
"error": "Wrong DTMF value"
}
{
"error": "DTMF code is already in use"
}
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...