Set NowIP settings

Configures the NowIP alarm notification settings.

NowIP provides additional alerts when a security alarm is triggered on the monitor. Notifications are sent as SIP messages to the configured SIP numbers where the BAS-IP Intercom app is installed.

application/json

Request Body

• now_ip object

  NowIP settings

  enable boolean

  Determines whether the feature is enabled

  main_number string

  First SIP number used to notify about triggers

  second_number string

  Second SIP number used to notify about triggers

  second_number_delay_call integer

  Delay between first and second SIP numbers call in seconds

• auto_call object

  Determines whether automatics SIP call is enabled when alarm activated

  enable boolean

  Determines whether the feature is enabled

  number string

  A call will be made to this SIP number after the sensor is triggered

• heartbeat object

  Enable SIP messages periodic notifications about alarm status

  enable boolean

  Determines whether the feature is enabled

  data string

  Message content

  timeout integer

  SIP message interval in seconds

• zones object[]

  List of messages that will be sent in a SIP message when proper sensor is triggered

  zone_id integer

  Possible values: <= 15

  Zone number

  zone_name string

  Zone name

Responses

• 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"
}

Loading...