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
      • Device Operation
        • setDeviceSnap:Device snapshot
        • setDeviceSnapEnhanced:Device snapshot
        • controlMovePTZ:PTZ mobile control interface
        • controlLocationPTZ:PTZ positioning interface
        • devicePTZInfo:Get device PTZ control interface
        • restartDevice:Restart the device(Only support device-level restart)
        • calibrationDeviceTime:Calibration equipment UTC time
        • getDeviceTime:Query device UTC time
      • Daylight saving time configuration
    • Video equipment

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

On this page
Function details
Request address
request format
Minimum permissions required for sub-account token request
Incoming parameter description
Sample input
Return data field description
Sample output

setDeviceSnap: Device snapshot

setDeviceSnap: Device snapshot

Function details

Capture the current screen image of the camera, and supports the capture frequency of 1 time/3s.

The client request interval must be greater than or equal to 3s.

Remarks:

It is recommended that developers determine which device capture interface to use after measuring the interface based on the device performance:

If the device performance is good (it can process and return the snapshot picture every second), it is recommended that the developer call the setDeviceSnapEnhanced interface;

If the device performance is poor (mainly for devices listed before 2017), it is recommended that developers call the setDeviceSnap interface for device snapshots.

Request address

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

request format

Please refer to the Development Specification for the API request method and some authentication parameters such as sign calculation method

Minimum permissions required for sub-account token request

"Permission":"Capture" "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
channelIdStringYesChannel ID

Sample input

{
    "system":{
        "ver":"1.0",
        "appId":"lcdxxxxxxxxx",
        "sign":"1f239a40a252ef1190fc8b1e61bb8b44",
        "time":1603369597,
        "nonce":"755263ee-7301-43c9-9d65-464f0febfc80"
    },
    "id":"c8dd3f09-554b-41dc-8616-76889952e24e",
    "params":{
        "deviceId":"TESTQWERXXXX",
        "channelId":"0",
        "token":"At_00000ad9e6e87f0142eb92e207aec46a"
    }
}

Return data field description

Field name Field type Field description
url String Capture access address

Sample output

{
  "result":{
    "msg":"The operation was successful.",
    "code":"0",
        "data":{
            "url":"https://lechangecloud.oss-cn-hangzhou.aliyuncs.com/lechange/TESTQWERXXXX_img/Alarm/0/7aa3f5dd3bf1436a87ca1828aad382c3.jpg?Expires=1603974670&OSSAccessKeyId=LTAIP4igXeEjYBoG&Signature=4f7U%2Bgbu3pZXUlL36K14MxFU0IA%3D"
        }
    },
    "id":"c8dd3f09-554b-41dc-8616-76889952e24e"
}
queryLocalRecordStream: Query the local recording video stream of the device
setDeviceSnapEnhanced:Device snapshot