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
        • setDeviceCameraStatus: Set device enable switch
        • getDeviceCameraStatus: Get device enable switch status
      • Device collection point configuration
      • 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

getDeviceCameraStatus - Device Enable Switch Status - Imou Open Platform

getDeviceCameraStatus: Get device enable switch status

Function details

Get the status of the device enable switch.

Note: Only devices with accessType=PaaS in the device details are supported

Request address

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

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
channelIdStringYesIf the enableType is device-level enable, there is no need to pass the channel number, and the channel-level enable needs to pass the channel numberchannel number
enableTypeStringYesPlease refer to "Device Capability Switch Description" for details, the first letter is lowercaseDevice enable type

Sample input

{
    "system":{
        "ver":"1.0",
        "appId":"lcdxxxxxxxxx",
        "sign":"89624489b8ede5f40103923c9c244ab8",
        "time":1603354153,
        "nonce":"d40fc5c4-a3db-42b8-9fe0-a81983701b8c"
    },
    "id":"d8f62142-3754-4b9c-a828-233c7a13bc4e",
    "params":{
        "enableType":"closeCamera",
        "deviceId":"TESTQWERXXXX",
        "channelId":"0",
        "token":"At_00000ad9e6e87f0142eb92e207aec46a"
    }
}

Return data field description

Field name Field type Field description
status String Enable switch, on: on, off: off
enableType String The type of device enablement, for example: closeCamera: privacy mask; smartTrack: smart tracking; smartLocate: listening sound displacement

Sample output

{
  "result":{
    "msg":"The operation was successful.",
        "code":"0",
        "data":{
            "enableType":"closeCamera",
            "status": "on"
        }
    },
    "id":"d8f62142-3754-4b9c-a828-233c7a13bc4e"
}
setDeviceCameraStatus: Set device enable switch
setCollection: New collection point