Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
    • Browse by device type
    • Device capabilities
      • Common methods
      • Detection and alarms
        • Arming
        • Attention zone
        • People counting
        • Cry detection
        • Absence from post
        • Face recognition
        • Fall detection
        • Gesture call
        • Intrusion
        • Loitering
        • Minor detection
        • Person and vehicle mix
        • Motion detection
        • Video occlusion
        • Illegal parking
        • Person detection
        • Pet detection
        • PIR
        • License plate recognition
        • Vehicle guard
        • Siren
          • detection.siren.enabled (Read siren switch)
          • detection.siren.linkage (Read alarm-linked siren)
          • detection.siren.linkage (Set alarm-linked siren)
          • detection.siren.linkageEvents (Read siren linkage events)
          • detection.siren.linkageEvents (Set siren linkage events)
          • detection.siren.plan (Read siren arming time periods)
          • detection.siren.plan (Set siren arming time periods)
          • detection.siren.state (Read siren state)
          • detection.siren.start (Start siren)
          • detection.siren.stop (Stop siren)
          • detection.siren.countdown (Get siren countdown)
          • detection.siren.duration (Set siren duration)
          • detection.siren.activated (Siren activated)
          • detection.siren.holdDuration (Read siren hold duration)
          • detection.siren.holdDuration (Set siren hold duration)
        • Voice SOS
        • Abnormal sound
        • Tripwire
        • Unoccupied detection
        • Vehicle
        • Door contact
        • Tamper
        • Gate accessory
        • Environment sensing
        • Target detection frame
      • Image
      • PTZ
      • Light
      • Recording
      • Audio
      • Media
      • Network
      • Power
      • Privacy
      • Call
      • Storage
      • System
      • Algorithm
      • Maintenance
      • Control
    • Events overview
    • Permission codes
    • Capability error codes
    • Alarm and capability messages
    • Capability FAQ
    • Legacy ability and push types
  • API reference
  • SDK and tools
  • Solutions
  • Platform and support
On this page
What it does
Request URL
Minimum permission
Request parameters
Request example
Error codes

detection.siren.holdDuration (Set siren hold duration)

detection.siren.holdDuration: Set siren hold duration

detection.siren.holdDuration · Channel scope · Permission Config

What it does

Sets how long the siren stays on. Range 0–600, step 1, unit s.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.set

Minimum permission

The administrator does not need an extra permission on a device they bound. A shared device needs the basic configuration permission. A bound sub-user does not. A sub-account needs Config. Omitting channelId on a channel-scope capability returns DV2007. Mixing device and channel in one request returns DV2008. A write timeout does not mean the operation did not run.

Request parameters

NameTypeRequiredDescription
tokenStringyesAdministrator, sub-user, or sub-account accessToken
deviceIdStringyesDevice serial number
productIdStringnoOptional. If sent and it does not match the device model → DV2009
channelIdStringyesChannel scope: required. Do not send on device-scope capabilities
propertiesObjectyesKey is detection.siren.holdDuration

Value 0–600, step 1, unit s.

Common request fields and the signature are in Development specification.

Request example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345",
 "channelId": "0",
 "properties": { "detection.siren.holdDuration": 50 }
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Siren

detection.siren.holdDuration (Read siren hold duration)
detection.sos.enabled (Read voice SOS switch)