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.enabled (Set alarm speech switch)

audio.speech.enabled: Set alarm speech switch

audio.speech.enabled · Device scope · Permission Config

Feature details

Turns on or off the device alarm voice. 1 on, 0 off. Out of bounds rejection, not truncation.

Request address

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

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. A write timeout does not mean that it was not executed.

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
propertiesObjectyeskey is audio.speech.enabled (int 0/1)
properties["audio.speech.enabled"]Description
0Off
1On

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.enabled": 1
 }
 }
}

# # # Returns a description of the data field

On success, code is "0" and data is {}.

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {}
 }
}

Error Code

Gateway and device error codes are in Global return codes.

Get alarm voice switch properties · alarm voice

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