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
Reported fields
Example
Minimum permission

detection.siren.activated (Siren activated)

detection.siren.activated: Siren activated

detection.siren.activated · Channel scope · Message query permission Alarm

What it does

Reported when the siren activates. The payload uses msgType detection.siren.activated. Subscribe to capabilityEvent in callbackFlag. See Receive device messages, setMessageCallback, Event catalog, and Overview and common payload.

Reported fields

No extra fields. Platform fields: Overview and common payload.

Example

{
 "msgType": "detection.siren.activated",
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "channelId": "0",
 "outputData": {},
 "time": 1673406989,
 "localTime": "20230111T111629",
 "alarmId": "116257862023505xxxx"
}

Minimum permission

The administrator does not need an extra permission on a device they bound. A shared device needs the alarm message permission. A bound sub-user does not. A sub-account needs Alarm. list / search filters out events you are not allowed to see. See Siren.

detection.siren.duration (Set siren duration)
detection.siren.holdDuration (Read siren hold duration)