Getting Started
Official Site
Getting Started
Official Site
  • Document description
  • Read before you start

  • Light application development guide

  • Mobile application development guide

  • Cloud live development guide

  • Desktop application development guide

  • Third party development guide

  • Message push development guide

  • IoT things data model

  • HTTP interface

    • Development specification
    • API privacy policy
    • Postman interface simulation call
    • accessToken: Get administrator token
    • API request example
    • Account docking
    • Push configuration
    • Cloud storage service
    • Equipment management

    • Device configurat

      • Device wifi configuration
      • Equipment dynamic inspection configuration
      • Device storage configuration
      • Device enable configuration
      • Device collection point configuration
      • Device cruise configuration
      • Device video screen configuration
      • Device recording configuration
        • setLocalRecordPlanRules: Set device local recording plan
        • queryLocalRecordPlan: Query local recording plan of the device
        • setLocalRecordStream: Set the local recording video stream of the device
        • queryLocalRecordStream: Query the local recording video stream of the device
      • Device Operation
      • Daylight saving time configuration
    • Video equipment

    • Device message
    • Device live broadcast
    • Device lock access
  • Reference documents

On this page
Function details
Request address
Minimum permissions required for sub-account token request
Incoming parameter description
Sample input
Return data field description
Sample output

setLocalRecordPlanRules: Set device local recording plan

setLocalRecordPlanRules: Set device local recording plan

Function details

Set the local recording plan of the device. During the recording plan time period, the device will collect all the video data to the local storage of the device.

Remarks:

  1. The device needs to have the LocalRecord capability set to support the device's local recording configuration

  2. If the recording plan is not set by default, the device will only store the recording data associated with the device alarm event

Request address

https://openapi-[DataCenter].easy4ip.com/openapi/setLocalRecordPlanRules

Minimum permissions required for sub-account token request

"Permission":"Config" "Resource":"cam:serial number:channel number"

Incoming parameter description

Parameter name Parameter type Is it required? Default value Legal value Parameter description
token String Yes Administrator or sub-account accessToken
deviceId String Yes Device serial number
channelId String Yes Channel number
rules beginTime String Yes The time format is HH:mm:ss Start time
endTime String Yes The time format is HH:mm:ss End time
period String Yes Can be "Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday", and set multiple periods at the same time separated by commas. Repeat period

Sample input

{
    "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
    "system":{
        "ver":"1.0",
        "appId":"lcdxxxxxxxxx",
        "sign":"74bc756ebd53e9eef2836f8cf1730c10",
        "time":1599031074,
        "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
    },
    "params":{
        "token":"At_00006acr3456d12312d3grf60147de7ec",
        "deviceId":"TESTQWERXXXX",
        "channelId":"0",
        "rules":[{
            "beginTime":"00:00:00",
            "endTime":"23:59:59",
            "period":"Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday"
        }]
    }
}

Return data field description

No data returned

Sample output

{
  "result":{
    "msg":"The operation was successful.",
        "code":"0"
    },
    "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af"
}
getFillLightSensitivity: Query the sensitivity of the device fill light
queryLocalRecordPlan: Query local recording plan of the device