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
      • Image
      • PTZ
      • Light
      • Recording
      • Audio
        • Do Not Disturb
        • Microphone capture
        • Prompt tone
        • Ringtone
        • Alarm speech
          • audio.speech.enabled (Read alarm speech switch)
          • audio.speech.enabled (Set alarm speech switch)
          • audio.speech.level (Read alarm speech volume (dB))
          • audio.speech.level (Set alarm speech volume (dB))
          • audio.speech.broadcastCount (Read broadcast count)
          • audio.speech.broadcastCount (Set broadcast count)
        • Voice control
        • Volume
      • 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
Feature details
Request address
Minimum permission
Request parameters
Request example
Response example

audio.speech.level (Read alarm speech volume (dB))

audio.speech.level: Read alarm speech volume (dB)

audio.speech.level · Device scope · Permission Config

Feature details

Some models use string enum "1"–"5"; others use JSON number 1–5—follow read-back. Read device alarm voice dB. 50/60/70/80/90 dB. The standard path is the device property audio.speech.level; some models parallel AbAlarmSound or legacy OpenAPI volume interfaces (such asgetSoundVolumeSize) in the registry, and the ability leaf and this property still prevail. See the alarm voice directory.

Request address

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

Minimum permission

Administrators do not need permission to operate self-bound devices. Basic configuration permission is required to operate the shared device. Child user binding is not required. Sub-account requires Config.

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
propertiesArrayyes["audio.speech.level"]

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",
 "properties": [
 "audio.speech.level"
 ]
 }
}

# # # Returns a description of the data field

The value is in result.data.properties["audio.speech.level"].

API value (JSON number or string per read-back)Description
"50"50db
"60"60db
"70"70db
"80"80db
"90"90db

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "audio.speech.level": "50"
 }
 }
 }
}

Error Code

Gateway and device error codes are in Global return codes.

Set sound decibel setting properties · Alarm voice

audio.speech.enabled (Set alarm speech switch)
audio.speech.level (Set alarm speech volume (dB))