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 saving / supply mode
        • Sleep and wake
        • Outlet metering
          • power.outlet.current (Get current current property)
          • power.outlet.energy (Get energy data property)
          • power.outlet.power (Get current power property)
          • power.outlet.voltage (Get current voltage property)
          • power.outlet.clearEnergy (Clear energy data)
          • power.outlet.read (Read electrical parameters)
          • power.outlet.statsByTime (Operation stats by time)
          • power.outlet.current (Set outlet current property)
          • power.outlet.energy (Set energy data property)
          • power.outlet.power (Set current power property)
          • power.outlet.voltage (Set current voltage property)
      • 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
inputData fields
Request example
Response data fields
Response example
Error codes

power.outlet.read (Read electrical parameters)

power.outlet.read: Read electrical parameters

power.outlet.read · device scope · permission Config

What it does

Reads current outlet voltage, current, power, and related electrical parameters. Each call runs once. When there is no business input, inputData is {}.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.service.invoke

Minimum permission

The administrator does not need an extra permission on a device they bound. A shared device needs one of the capability row share_auth_code aliases (match the console share grant). 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. A timeout does not mean the action failed. See Permission codes. Shared devices must satisfy one alias in the capability row share_auth_code (for example Config,config).

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
serviceIdStringyespower.outlet.read
inputDataObjectyespass {} when there are no extra fields

inputData fields

No extra fields.

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",
 "serviceId": "power.outlet.read",
 "inputData": {}
 }
}

Response data fields

Output is in result.data.outputData.

FieldTypeDescription
voltageIntegerVoltage, unit mV
currentIntegerCurrent, unit mA
powerIntegerPower, unit mW

Some models may return additional outputData keys (e.g. switchCnt, code); treat them as optional unless listed in your thing model / device.capability.list.

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "outputData": {
 "voltage": 220000,
 "current": 120,
 "power": 26400
 }
 }
 }
}

Error codes

CodeMeaningNext step
SN1001Signature errorCheck sign per Development specification
TK1002Token invalid or expiredRefresh accessToken
OP1002Missing required parameterAdd required fields
OP1003Invalid parameterMatch this page’s parameter table
OP1009Permission deniedCheck token and device bind/share grants
OP1013Total call limit exceededReduce call rate
OP1014Daily per-interface limit exceededSee Interface call limits
DV1007Device offlineWait until the device is online

See Return codes · OP/SN/TK for the full catalog.

CodeMeaningNext step
DV2003Capability not on deviceUse device.capability.list
DV2007channelId vs scope mismatchRequired for channel scope; omit for device scope
DV2008Mixed device and channel in one callSplit the request
DV2009productId mismatchOmit or set actual model id
DV2011No capability permissionSee Permission codes

See Capability errors.

Outlet metering

power.outlet.clearEnergy (Clear energy data)
power.outlet.statsByTime (Operation stats by time)