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
        • setCruiseConfig: Set timed cruise
        • getCruiseConfig: Get timing cruise settings
      • Device video screen configuration
      • Device recording configuration
      • Device Operation
      • Daylight saving time configuration
    • Video equipment

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

On this page
Detailed description
Input parameter note
Sample input
Sample output

setTimedCruisePlan - Set a plan of timing cruise for device - Imou Open Platform

setTimedCruisePlan: Set a plan of timing cruise for device

Detailed description

Set a plan of timing cruise for device, a "TimedCruise" ability is required to use this function(only support single channel device)

Input parameter note

Parameter ListNoteParameter TypeMandatoryDefault ValidityLegal value
tokenaccessTokenStringY
deviceIdDevice IDStringY
channelIdchannel IDStringN
cruiseNamename of planStringY
cruisesplan listObject[]Y
periodperiod of cruiseStringY
beginTimetime of begin to cruiseStringYTHHmmss
endTimetime of end to cruiseStringYTHHmmss

Sample input

{
    "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
    "system":{
        "ver":"1.0",
        "appId":"lcdxxxxxxxxx",
        "sign":"74bc756ebd53e9eef2836f8cf1730c10",
        "time":1599031074,
        "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
    },
    "params":{
        "token":"At_12345678901234567890123456789012",
        "deviceId":"TESTQWERXXXX-dfXXX-XX",
        "channelId":"0",
        "cruiseName":"cruise1",
        "cruises ":[{
            "period":"Monday",
            "beginTime":"T000000",
            "endTime":"T235959"
        }]
    }
}

Sample output

{
    "id":"123456",
    "result":{
        "code":"0",
        "msg":"Operation is successful."
    }
}
turnCollection: Turn to collection point
getCruiseConfig: Get timing cruise settings