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

      • Add device
      • Device query
        • listDeviceDetailsByIds: Batch query of device details
        • listDeviceDetailsByPage: Paging device details for querying
        • deviceOnline: Get device online status
        • unBindDeviceInfo: Unbound device information acquisition
        • checkDeviceBindOrNot: Query device binding status
        • bindDeviceChannelInfo: Obtain the detailed information of a single device channel
        • deviceVersionList: Get device version and upgradeable information
        • deviceOpenList: Paging to obtain the basic information of the channel for adding devices to the open platform
        • queryOpenDeviceChannelInfo: Obtain the basic information of the channel for adding devices to the open platform
        • deviceOpenDetailList: Get detailed device information in batches
        • deviceBaseList: Paging to obtain the basic information of the device channel added or shared by the easy4ip app
        • queryBaseDeviceChannelInfo: Get the basic information of the channel added or shared by the easy4ip app
        • deviceBaseDetailList: Get detailed information of devices added or shared by easy4ip app in batches
        • shareDeviceList: Paging to get the device list shared by the easy4ip app to the developer
        • upgradeProcessDevice: Get device upgrade status and progress
        • listDeviceAbility: Obtain the ability set of multiple devices, channels and accessories in batch
        • subAccountDeviceInfo: Obtain the capability set of multiple devices, channels and accessories in batch
        • subAccountDeviceList: Get the capability set of multiple devices, channels and accessories in batch
      • Device maintenance
    • Device configurat

    • 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

Get Device Upgrade Status and Progress - Imou Open Platform

upgradeProcessDevice: Get device upgrade status and progress

Function details

Get device upgrade status and progress.

Request address

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

Minimum permissions required for sub-account token request

"Permission":"Upgrade" "Resource":"dev:serial number"

Incoming parameter description

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

Sample input

{
    "system":{
        "ver":"1.0",
        "appId":"lcdxxxxxxxxx",
        "sign":"6abf3bc90dbcb21883a2fb24af18574c",
        "time":1603371026,
        "nonce":"4279d75d-742a-4e40-a5a0-5fdd096305f5"
    },
    "id":"e65e61bf-b5c4-4989-850e-808216c00ce9",
    "params":{
        "deviceId":"TESTQWERXXXX",
        "token":"At_00000ad9e6e87f0142eb92e207aec46a"
    }
}

Return data field description

Field nameField typeField description
versionStringDevice program version number
statusStringDevice upgrade status, idle: not upgrading, downloading: downloading the upgrade package, upgrading: upgrading
percentStringEquipment upgrade progress percentage

Sample output

{
  "result":{
    "msg":"The operation was successful.",
    "code":"0",
    "data":{
      "count":1,
      "deviceVersionList":[
        {
          "percent":"60",
          "status":"upgrading",
          "version":"2.145.1000.0.R.20181112"
        }
      ]
    }
  },
  "id":"e65e61bf-b5c4-4989-850e-808216c00ce9"
}
shareDeviceList: Paging to get the device list shared by the easy4ip app to the developer
listDeviceAbility: Obtain the ability set of multiple devices, channels and accessories in batch