1. API List

This section introduces the device operation related APIs.

API List:

No. Function Description
1 Add Device Add the device to the login account.
2 Delete Device Remove the specified device from the login account.
3 Edit Device Name Edit the device name.
4 Capture Picture Capture the current view of the device.
5 Link IPC to NVR Link IPC to NVR.
6 Delete IPC form NVR Delete the IPC from the NVR

1.1 Add Device

  • Function

    Add device to this account.

  • Request Address

    {areaDomain}/api/lapp/device/add

  • Request Method

    POST

  • Request Parameters
Parameter Type Description Required
accessToken String The access_token during authentication. Y
deviceSerial String The device serial No.. Y
validateCode String The device verification code: six upper cases in the device body. Y

  • HTTP Request Message

    POST /api/lapp/device/add HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.20h863523v1zfck75qgmwhoy7vl2teqp&deviceSerial=427734888&validateCode=ABCDEF

  • Returned Data

    {
  "code": "200",
  "msg": "Operation succeeded!"
}

  • Returned Code
Returned Code Returned Message Description
200 Operation succeeded. Requesting succeeded.
10001 Parameters error. Parameter is empty or the format is incorrect.
10002 accessToken exception or expired. Get accessToken again.
10005 appKey exception. appKey is frozen.
20002 Device does not exist.
20006 Network exception. Check the network status. Try again.
20007 The device is offline. Check whether the device is online.
20010 Device verification code error. Check whether the device verification code is correct.
20011 Adding device failed. Check whether the network is connected.
20013 Device has been added by others. The device has been added by other account.
20014 Illegal deviceSerial
20017 Device has been added by yourself. The device has been added by this account.
49999 Data exception. Calling API exception.

1.2 Delete Device

  • Function

    Remove the device from this account.

  • Request Address

    {areaDomain}/api/lapp/device/delete

  • Request Method
`POST`
  • Request Parameters
Parameter Type Description Required
accessToken String The access_token during authentication. Y
deviceSerial String The device serial No.. Y

  • HTTP Request Message

    POST /api/lapp/device/delete HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.20h863523v1zfck75qgmwhoy7vl2teqp&deviceSerial=427734888

  • Returned Data

    {
  "code": "200",
  "msg": "Operation succeeded!"
}

  • Returned Code
Returned Code Returned Message Description
200 Operation succeeded. Requesting succeeded.
10001 Parameters error. Parameter is empty or the format is incorrect.
10002 accessToken exception or expired. Get accessToken again.
10005 appKey exception. appKey is frozen.
20002 Device does not exist.
20014 Illegal deviceSerial
20018 The user does not have this device. Check whether the device belongs to the current account.
49999 Data exception. Calling API exception.

1.3 Edit Device Name

  • Function

    Edit device name.

  • Request Address

    {areaDomain}/api/lapp/device/name/update

  • Request Method

    POST

  • Request Parameters
Parameter Type Description Required
accessToken String The access_token during authentication. Y
deviceSerial String The device serial No.. Y
deviceName String Device name,within 50 bytes and special characters are not supported. Y
  • HTTP Request Message
    POST /api/lapp/device/name/update HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.cp894sbq65xa5niv0myrfdzma0ja7js1&deviceSerial=0&deviceName=5
  • Returned Data
    {
  "code": "200",
  "msg": "Operation succeeded!"
}
  • Returned Code
Returned Code Returned Message Description
200 Operation succeeded. Requesting succeeded.
10001 Parameters error. Parameter is empty or the format is incorrect.
10002 accessToken exception or expired. Get accessToken again.
10005 appKey exception. appKey is frozen.
20002 Device does not exist.
20014 Illegal deviceSerial
20018 The user does not have this device. Check whether the device belongs to the current account.
49999 Data exception. Calling API exception.

1.4 Capture Pictures

  • Function

    Capture the device current view.It is only available for the IPC or IPC linked NVR.

  • Request Address

    {areaDomain}/api/lapp/device/capture

  • Request Method

    POST

  • Request Parameters
Parameter Type Description Required
accessToken String The access_token during authentication. Y
deviceSerial String The device serial No.. Y
channelNo int Channel No.. For IPC device, it is 1. Y

  • HTTP Request Message

    POST /api/lapp/device/capture HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.12xp95k63bboast3aq0g5hg22q468929&deviceSerial=427734888&channelNo=1

  • Returned Data

    {
  "data": {

      "picUrl": "http://img.ys7.com//group2/M00/74/22/CmGdBVjBVDCAaFNZAAD4cHwdlXA833.jpg"

    }, "code": "200", "msg": "Operation succeeded!" } </pre>

  • Returned Code

Returned Code Returned Message Description
200 Operation succeeded. Requesting succeeded.
10001 Parameters error. Parameter is empty or the format is incorrect.
10002 accessToken exception or expired. Get accessToken again.
10005 appKey exception. appKey is frozen.
20002 Device does not exist.
20006 Network exception. Check the network status. Try again.
20007 The device is offline. Check whether the device is online.
20008 Device requesting timeout. No more operations. Try again.
20014 Network exception. Check the network status. Try again.
20018 The user does not have this device. Check whether the device belongs to the current account.
20032 The channel does not exist in this user. Check whether the device has this channel.
49999 Data exception. Calling the API exception.
60017 Capturing pictures failed. The device returns fail.
60020 The command is not supported. Check whether the device supports capturing.

  • Function

    This API is used to link IPC to NVR.

  • Request Address

    {areaDomain}/api/lapp/device/ipc/add

  • Request Method

    POST

  • Request Parameters
Parameter Type Description Required
accessToken String The access_token during authentication. Y
deviceSerial String The device serial No.. Y
ipcSerial String IPC serial No. to be linked. Y
channelNo int Optional, when it is empty, link IPC to the specified channel, or link IPC to the first channel. N
validateCode String Optional, IPC verification code. By default, it is empty. N

  • HTTP Request Message

    POST /api/lapp/device/ipc/add HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&channelNo=1&ipcSerial=777777777&validateCode=

  • Returned Data

    {
  "code": "200",
  "msg": "Operation succeeded!"
}

  • Returned Code

Returned Code Returned Message Description
200 Operation succeeded. Requesting succeeded.
10001 Parameters error. Parameter is empty or the format is incorrect.
10002 accessToken exception or expired. Get accessToken again.
10005 appKey exception. appKey is frozen.
20002 Device does not exist.
20006 Network exception. Check the network status. Try again.
20007 The device is offline. Check whether the device is online.
20008 Device requesting timeout. No more operations. Try again.
20014 Network exception. Check the network status. Try again.
20018 The user does not have this device. Check whether the device belongs to the current account.
49999 Data exception. Calling the API exception.
60012 Unknown error. The device returns other error code.
60020 The command is not supported. Check whether the device supports capturing.
60040 The added devices are not in the same LAN.
60041 The added device is linked to other device or requesting timeout.
60042 The added device password error.
60043 The added device exceeds the limit.
60044 The added device network timeout.
60045 The added device IP is conflict with that of other channel.
60046 The added device IP is conflict with that of this device.
60047 The stream type is not supported.
60048 The bandwidth exceeds the system accessing bandwidth.
60049 Illegal IP or port
60050 The added device version is not supported. You need to upgrade it.
60051 The added device is not supported.
60052 The added device channel No. error.
60053 The added device resolution is not supported.
60054 The device account is locked.
60055 The added device streaming error. Check the IPC stream.

1.6 Delete IPC from NVR

  • Function

    This API is used to remove the IPC from NVR.

  • Request Address

    {areaDomain}/api/lapp/device/ipc/delete

  • Request Method

    POST

  • Request Parameters
Parameter Type Description Required
accessToken String The access_token during authentication. Y
deviceSerial String The device serial No.. Y
ipcSerial String IPC serial No. to be linked. Y
channelNo int Optional, when it is empty, link IPC to the specified channel, or link IPC to the first channel. N

  • HTTP Request Message

    POST /api/lapp/device/ipc/delete HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&channelNo=1&ipcSerial=777777777

  • Returned Data

    {
  "code": "200",
  "msg": "Operation succeeded!"
}

  • Returned Code

Returned Code Returned Message Description
200 Operation succeeded. Requesting succeeded.
10001 Parameters error. Parameter is empty or the format is incorrect.
10002 accessToken exception or expired. Get accessToken again.
10005 appKey exception. appKey is frozen.
20002 Device does not exist.
20006 Network exception. Check the network status. Try again.
20007 The device is offline. Check whether the device is online.
20008 Device requesting timeout. No more operations. Try again.
20014 Network exception. Check the network status. Try again.
20018 The user does not have this device. Check whether the device belongs to the current account.
49999 Data exception. Calling the API exception.
60012 Unknown error. The device returns other error code.
60020 The command is not supported. Check whether the device supports capturing.
60056 Deleting the device failed.
60057 The device to delete is not linked.

results matching ""

    No results matching ""