Set NowIP settings
Configures NowIP settings.
They provides additional alert on alarm triggering on the internal monitor using the SIP protocol. Notification occurs by sending SIP messages to the specified SIP number on which the BAS-IP Intercom application is installed.
- application/json
Request Body
now_ip object
NowIP settings
enable booleanDetermines whether the feature is enabled
main_number stringFirst SIP number used to notify about triggers
second_number stringSecond SIP number used to notify about triggers
second_number_delay_call integerDelay between first and second SIP numbers call in seconds
auto_call object
Determines whether automatics SIP call is enabled when alarm activated
enable booleanDetermines whether the feature is enabled
number stringA call will be made to this SIP number after the sensor is triggered
heartbeat object
Enable SIP messages periodic notifications about alarm status
enable booleanDetermines whether the feature is enabled
data stringMessage content
timeout integerSIP message interval in seconds
zones object[]
List of messages that will be sent in a SIP message when proper sensor is triggered
zone_id integerPossible values:
<= 15
Zone number
zone_name stringZone name
- 200
- 400
- 401
OK
Validation error. Required fields are not provided.
- Wrong zone_id
- Wrong number
- 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 number
- Wrong zone_id
- Base
- No value
- Wrong param type
Schema
- error string
Error information
{
"error": true
}
{
"error": "Wrong number"
}
{
"error": "Wrong zone_id"
}
{
"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"
}