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
          • detection.sos.enabled (Read voice SOS switch)
          • detection.sos.enabled (Set voice SOS switch)
          • detection.sos.sensitivity (Read voice SOS sensitivity)
          • detection.sos.sensitivity (Set voice SOS sensitivity)
          • detection.sos.dialect (Read dialect SOS detection)
          • detection.sos.dialect (Set dialect SOS detection)
          • detection.sos.detected (Voice SOS (general))
        • 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
Response data fields
Response example
Error codes

detection.sos.sensitivity (Read voice SOS sensitivity)

detection.sos.sensitivity: Read voice SOS sensitivity

detection.sos.sensitivity · Channel scope · Permission Config

What it does

Reads voice SOS sensitivity on this channel. The device may use levels 1–5 or an integer range 0–9999999. Follow the type from the latest capability list; do not mix both value styles in one request.

Request URL

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

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.

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 ID; "0" is common on IPCs
propertiesArrayyes["detection.sos.sensitivity"]

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.sos.sensitivity"
 ]
 }
}

Response data fields

The value is in result.data.properties["detection.sos.sensitivity"].

The device may use levels 1–5 or integer range 0–9999999 (step 1). Follow the type from the latest capability list.

ValueDescription
1–5Level when the device uses discrete levels
0–9999999Integer range when the device uses a numeric range

Response example

Discrete-level ident may return a JSON string; range ident returns a JSON number. Example (enum ident):

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "detection.sos.sensitivity": 1
 }
 }
 }
}

Range-ident example (JSON number):

{
 "data": {
 "properties": {
 "detection.sos.sensitivity": 50
 }
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Set voice SOS sensitivity · Voice SOS

detection.sos.enabled (Set voice SOS switch)
detection.sos.sensitivity (Set voice SOS sensitivity)