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
      • Privacy
      • Call
      • Storage
      • System
      • Algorithm
      • Maintenance
      • Control
        • Infrared remote
        • Outlet and switching
          • control.outlet.countdownFailed (Countdown failed event)
          • control.outlet.countdownFinished (Countdown finished event)
          • control.outlet.overload (Power overload)
          • control.outlet.switch2Switched (Switch channel 2 changed)
          • control.outlet.switch3Switched (Switch channel 3 changed)
          • control.outlet.switched (Switch state changed)
          • control.outlet.timerFailed (Timer task failed event)
          • control.outlet.timerFinished (Timer task finished event)
          • control.outlet.childLock (Get child lock property)
          • control.outlet.enabled (Get switch / relay state property)
          • control.outlet.externalSwitchType (Get external switch type property)
          • control.outlet.masterEnabled (Read master switch)
          • control.outlet.multiControl (Get multi-channel switch property)
          • control.outlet.operationMode (Get switch operation mode property)
          • control.outlet.overchargeProtection (Read overcharge protection)
          • control.outlet.powerSaving (Get auto power-saving property)
          • control.outlet.pulseDuration (Read pulse duration)
          • control.outlet.restartState (Get multi-channel restart state property)
          • control.outlet.switch2Enabled (Read switch channel 2)
          • control.outlet.switch3Enabled (Read switch channel 3)
          • control.outlet.switch4Enabled (Read switch channel 4)
          • control.outlet.switch5Enabled (Read switch channel 5)
          • control.outlet.switch6Enabled (Read switch channel 6)
          • control.outlet.switchCount (Get switch count property)
          • control.outlet.countdownGet (Get countdown)
          • control.outlet.countdownSet (Set countdown)
          • control.outlet.taskList (Task list)
          • control.outlet.timerGet (Get timer)
          • control.outlet.timerList (Timer delay list)
          • control.outlet.timerSet (Set timer)
          • control.outlet.childLock (Set child lock property)
          • control.outlet.enabled (Set switch / relay state property)
          • control.outlet.externalSwitchType (Set external switch type property)
          • control.outlet.masterEnabled (Set master switch property)
          • control.outlet.multiControl (Set multi-channel switch property)
          • control.outlet.operationMode (Set switch operation mode property)
          • control.outlet.overchargeProtection (Set overcharge protection property)
          • control.outlet.powerSaving (Set auto power-saving property)
          • control.outlet.pulseDuration (Set pulse duration property)
          • control.outlet.restartState (Set multi-channel restart state property)
          • control.outlet.switch2Enabled (Set switch channel 2)
          • control.outlet.switch3Enabled (Set switch channel 3)
          • control.outlet.switch4Enabled (Set switch channel 4)
          • control.outlet.switch5Enabled (Set switch channel 5)
          • control.outlet.switch6Enabled (Set switch channel 6)
          • control.outlet.switchCount (Set switch count property)
        • Travel motor
        • Lock actuator
    • 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

control.outlet.restartState (Get multi-channel restart state property)

control.outlet.restartState: Get multi-channel restart state property

control.outlet.restartState · device scope · permission Config

What it does

Reads multi-channel restart state.

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["control.outlet.restartState"]

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": [
 "control.outlet.restartState"
 ]
 }
}

Response data fields

The value is in result.data.properties["control.outlet.restartState"].

NameDescriptionTypeRequiredValues
controlTypeControl modeenumno0 all channels; 1 per channel
rstSta1Channel 1 restart stateenumno0 on; 1 off; 2 power-loss memory
rstSta2Channel 2 restart stateenumnoSame as rstSta1
rstSta3Channel 3 restart stateenumnoSame as rstSta1
rstSta4Channel 4 restart stateenumnoSame as rstSta1

Enums are usually strings in JSON (e.g. "0"), matching Set multi-channel restart state.

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "control.outlet.restartState": {
 "controlType": "0",
 "rstSta1": "0",
 "rstSta2": "0",
 "rstSta3": "0",
 "rstSta4": "0"
 }
 }
 }
 }
}

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
DV2003Property not on deviceUse device.capability.list
DV2004Value out of rangeCheck properties values
DV2007channelId vs scope mismatchRequired for channel scope; omit for device scope
DV2008Mixed device and channel propertiesSplit the request
DV2009productId mismatchOmit or set actual model id

See Capability errors.

Set multi-channel restart state property · Outlet and switching

control.outlet.pulseDuration (Read pulse duration)
control.outlet.switch2Enabled (Read switch channel 2)