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
        • Voice SOS
        • Abnormal sound
          • detection.sound.enabled (Read abnormal sound switch)
          • detection.sound.enabled (Set abnormal sound switch)
          • detection.sound.threshold (Read abnormal sound threshold)
          • detection.sound.threshold (Set abnormal sound threshold)
          • detection.sound.detected (Abnormal sound alarm)
        • 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
Related

detection.sound.detected (Abnormal sound alarm)

detection.sound.detected: Abnormal sound alarm

detection.sound.detected · Channel scope · Message query permission Alarm

What it does

Standard pushes use capabilityEvent and this page’s msgType; some models may also emit legacy msg_type values—see device.capability.list and the event catalog.

Reported when abnormal sound triggers. msgType is detection.sound.detected. Subscribe to capabilityEvent in callbackFlag to receive pushes. See Receive device messages, setMessageCallback, Event catalog, and Overview and common payload.

Reported fields

Fields inside outputData. Platform fields: Overview and common payload.

NameTypeRequiredDescription
soundTypetextnoSound type string

Example

{
 "msgType": "detection.sound.detected",
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "channelId": "0",
 "outputData": {
 "soundType": "Device-defined type string; no fixed enum"
 },
 "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.

Related

  • Event catalog: abnormal sound
  • Overview and common payload
  • Receive device messages
  • Abnormal sound
detection.sound.threshold (Set abnormal sound threshold)
detection.trip.enabled (Read tripwire detection switch)