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
        • Recording events
        • Local recordings
        • Plan
          • record.plan.enabled (Get recording storage switch property)
          • record.plan.enabled (Set recording storage switch property)
          • record.plan.normal (Get normal recording storage property)
          • record.plan.normal (Set normal recording storage property)
          • record.plan.plan (Get storage plan property)
          • record.plan.plan (Set storage plan property)
          • record.plan.storageMode (Get local recording storage mode property)
          • record.plan.storageMode (Set local recording storage mode property)
          • record.plan.config (Get local recording parameters property)
          • record.plan.config (Set local recording parameters property)
          • record.plan.maxDuration (Get max recording duration property)
          • record.plan.maxDuration (Set max recording duration property)
        • Playback
        • Timelapse
      • Audio
      • 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
What it does
Request URL
Minimum permission
Request parameters
Request example
Response data fields
Response example
Error codes

record.plan.normal (Get normal recording storage property)

record.plan.normal: Get normal recording storage property

record.plan.normal · channel scope · permission Config

What it does

Reads the normal recording storage switch for this channel. 0 off, 1 on.

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. Omitting channelId on channel-scope capabilities returns DV2007. 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
channelIdStringyesChannel ID; "0" is common for IPC
propertiesArrayyes["record.plan.normal"]

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",
 "channelId": "0",
 "properties": [
 "record.plan.normal"
 ]
 }
}

Response data fields

The value is in result.data.properties["record.plan.normal"].

ValueDescription
0Off (do not store normal recordings)
1On (store normal recordings)

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "record.plan.normal": 1
 }
 }
 }
}

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 normal recording storage property · Plan

record.plan.enabled (Set recording storage switch property)
record.plan.normal (Set normal recording storage property)