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
        • setCollection: New collection point
        • deleteCollection: Delete collection point
        • getCollection: Get collection point information
        • modifyCollection: Modify the name of the collection point
        • turnCollection: Turn to collection point
      • Device cruise configuration
      • 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
Function details
Request address
Minimum permissions required for sub-account token request
Incoming parameter description
Sample input
Return data field description
Sample output

Add Collection Point Documentation for Developers - Imou Open Platform

setCollection: Add a collection point

Function details

Add favorite points.

Remarks: Need to have a CollectionPoint collection point capability set in the device

Request address

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

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
channelIdStringischannel number
nameStringYesCollection point name
needCruisebooleanNofalsetrue,falseWhether to join the cruise plan

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",
        "name":"name",
        "needCruise":false
    }
}

Return data field description

No data returned

Sample output

{
  "result":{
    "msg":"The operation was successful.",
    "code":"0"
  },
  "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af"
}
getDeviceCameraStatus: Get device enable switch status
deleteCollection: Delete collection point