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

queryLocalRecordPlan: Query the local recording plan of the device

queryLocalRecordPlan: Query the local recording plan of the device

Function details

Query the currently configured recording plan of the device

Remarks:

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

  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/queryLocalRecordPlan

Minimum permissions required for sub-account token request

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

Incoming parameter description

Parameter nameParameter typeRequired or notDefault valueLegal valueParameter description
tokenStringYesAdministrator or sub-account accessToken
deviceIdStringYesDevice serial number
channelIdStringYesDevice channel number

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"
    }
}

Return data field description

Field name Field type Field description
channelId Integer Device channel number
rules beginTime String Start time, HH:mm:ss format
endTime String End time, HH:mm:ss format
period String Recording period, can be "Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday"

Sample output

{
    "result":{
        "msg":"Successful operation。",
        "code":"0",
        "data": {
            "channelId": 0,
            "rules": [
                {
                    "beginTime": "10:33:25",
                    "endTime": "11:55:33",
                    "period": "Monday"
                }
            ]
        }
    },
    "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af"
}
setLocalRecordPlanRules: Set device local recording plan
setLocalRecordStream: Set the local recording video stream of the device