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
      • Media
      • Network
      • Power
        • Battery
          • power.battery.info (Get battery info (by category) property)
          • power.battery.chargeData (Get battery charge data property)
          • power.battery.low (Low battery alert (standard))
          • power.battery.full (Full battery alert)
          • power.battery.level (Get battery level property)
          • power.battery.level (Set battery level property)
        • Power saving / supply mode
        • Sleep and wake
        • Outlet metering
      • 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

power.battery.level (Get battery level property)

power.battery.level: Get battery level property

power.battery.level · device scope · permission Config

What it does

Reads the device battery level percentage. Range -100–100, step 1, unit %.

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. Do not send channelId on device-scope capabilities. Mixing device and channel properties in one request returns DV2008.

Request parameters

NameTypeRequiredDescription
tokenStringyesAccess token for an administrator, sub-user, or sub-account
deviceIdStringyesDevice serial number
productIdStringnoOptional. If sent and it does not match the device model → DV2009
propertiesArrayyes["power.battery.level"]

For common request fields and signing, see Signing conventions and Common request payload.

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": ["power.battery.level"]
 }
}

Response data fields

The value is in result.data.properties["power.battery.level"].

FieldTypeDescription
valueintBattery percentage, -100–100, step 1, unit % (negative values depend on device/product)

Response example

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

Error codes

Gateway

DV20xx

Battery

power.battery.full (Full battery alert)
power.battery.level (Set battery level property)