1. API List
Contains the APIs used for enabling or disabling device function status.
See the following list:
No. | Function | Description |
---|---|---|
1 | Arming and disarming | Set the device action detection status |
2 | Disable device video encryption | Disable device video encryption |
3 | Enable device video encryption | Enable device video encryption |
4 | Get audio prompt status of Wi-Fi configuration | Get audio prompt status of Wi-Fi configuration or device reboot. |
5 | Set audio prompt for Wi-Fi configuration | Set audio prompt for Wi-Fi configuration or device reboot. |
6 | Get video tampering status | Get video tampering status |
7 | Set video tampering status | Set video tampering status |
8 | Get sound source positioning status | Get sound source positioning status |
9 | Set sound source positioning status | Set sound source positioning status |
10 | Get device arming and disarming schedule | Get device arming and disarming schedule (action detection) |
11 | Set device arming and disarming schedule | Set device arming and disarming schedule (action detection) |
12 | Get device microphone switch status | Get device microphone switch status |
13 | Set device microphone switch status | Set device microphone switch status |
14 | Set configuration of pir area | Set configuration of pir area |
15 | Get configuration of pir area | Get configuration of pir area |
16 | Set chime type | Set chime type |
17 | Get chime type | Get chime type |
18 | Set infrared type | Set infrared type |
19 | Get infrared type | Get infrared type |
20 | Get device time zone | Get device time zone |
21 | Get time zone list | Get time zone list |
22 | Set device time zone | Set device time zone |
23 | Get device capability | Get device capability |
24 | Get device language | Get device language |
25 | Set device language | Set device language |
1.1 Arming and Disarming
API Function
Edit the device arming and disarming status (action detection switch), realize the arming and disarming function.
Request Address
{areaDomain}/api/lapp/device/defence/set
Request Type
POST
- Request Parameters
Parameter Name | Type | Description | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
isDefence | int | Arming and disarming status of A1 device : 0-Sleep, 8-Home, 16-Away . Arming and disarming status of non-A1 device : 0 -Disarm, 1-Arm |
Y |
HTTP Request Message
POST /api/lapp/device/encrypt/off HTTP/1.1 Host: isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.8z25h2063dapeus7c99bb0r6e0kjfjz5&deviceSerial=427734888&validateCode=ABCDEF
Return Data
{ "code": "200", "msg": "Operating succeeded!" }
Return Code
Returned Code | Returned Infromation | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10005 | appKey exception. | appKey is frozen. |
20002 | Device does not exist. | |
20006 | Network exception. | Check the device network status. Try later. |
20007 | Device offline. | Check the device online status. |
20008 | Device response overtime. | Too many operations. Try later. |
20014 | Illegal deviceSerial. | |
20018 | The user does not have this device. | Check whether the device belongs to the current account. |
49999 | Data exception. | Calling the API exception. |
1.2 Disable Device Video Encryption
API Function
Disable device video encryption by verification code
Request Address
{areaDomain}/api/lapp/device/encrypt/off
Request Type
POST
- Request Parameters
Parameter Name | Type | Description | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
validateCode | String | device verification code, 6-bit upper case letters on the physical device. | Y |
HTTP Request Message
POST /api/lapp/device/encrypt/off HTTP/1.1 Host: isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.8z25h2063dapeus7c99bb0r6e0kjfjz5&deviceSerial=427734888&validateCode=ABCDEF
Return Data
{ "code": "200", "msg": "Operating succeeded!" }
Return Code
Returned Code | Returned Infromation | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10005 | appKey exception. | appKey is frozen. |
20002 | Device does not exist. | |
20006 | Network exception. | Check the device network status. Try later. |
20007 | Device offline. | Check the device online status. |
20008 | Device response overtime. | Too many operations. Try later. |
20010 | Device verification code error. | Check the device verification code. |
20018 | The user does not have this device. | Check whether the device belongs to the current account. |
49999 | Data exception. | Calling the API exception. |
60016 | Encryption is already disabled. | The device encryption is already disabled. |
1.3 Enable Device Video Encryption
API Function
Disable device video encryption.
Request Address
{areaDomain}/api/lapp/device/encrypt/on
Request Type
POST
- Request Parameters
Parameter Name | Type | Description | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
HTTP Request Message
POST /api/lapp/device/encrypt/on HTTP/1.1 Host: isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.8z25h2063dapeus7c99bb0r6e0kjfjz5&deviceSerial=427734888
Return Data
{ "code": "200", "msg": "Operating succeeded!" }
- Return Code
Returned Code | Returned Infromation | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10005 | appKey exception. | appKey is frozen. |
20002 | Device does not exist. | |
20006 | Network exception. | Check the device network status. Try later. |
20007 | Device offline. | Check the device online status. |
20008 | Device response overtime. | Too many operations. Try later. |
20014 | Illegal deviceSerial. | |
20018 | The user does not have this device. | Check whether the device belongs to the current account. |
49999 | Data exception. | Calling the API exception. |
60019 | Encryption is already enabled. | The device encryption is already enabled. |
1.4 Get Audio Prompt Status of Wi-Fi Configuration
API Function
This API is used to get the audio prompt status of Wi-Fi configuration or device reboot.Request Address
{areaDomain}/api/lapp/device/sound/switch/status
Request Type
POST
Request Parameters
Parameter Name | Type | Description | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
HTTP Request Message
POST /api/lapp/device/sound/switch/status HTTP/1.1 Host: isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.9mqitppidgce4y8n54ranvyqc9fjtsrl&deviceSerial=502608888
Return Data
{ "data": { "deviceSerial": "502608888", "channelNo": 1, "enable": 1 }, "code": "200", "msg": "Operating succeeded!" }
- Return Field
Parameter Name | Type | Description |
---|---|---|
deviceSerial | String | Device serial No. |
channelNo | String | Channel No. |
enable | int | Status: 0-Disable, 1-Enable |
- Return Code
Returned Code | Returned Infromation | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10004 | The user does not exist. | |
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 the API exception. |
1.5 Set Audio Prompt for Wi-Fi Configuration
API Function
This API is used to set the audio prompt for Wi-Fi configuration or device reboot.
Request Address
`{areaDomain}/api/lapp/device/sound/switch/set`
Request Type
`POST`
Request Parameters
Parameter Name | Type | Description | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
enable | int | Status:0-Disable, 1-Enable |
Y |
channelNo | int | Channel No., no transmission means the device itself. | N |
Channel No., no transmission means the device itself.
POST /api/lapp/device/sound/switch/set HTTP/1.1 Host: isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.9mqitppidgce4y8n54ranvyqc9fjtsrl&deviceSerial=596510888&enable=1&channelNo=1
Return Data
{ "code": "200", "msg": "Operating succeeded!" }
Return Code
Returned Code | Returned Infromation | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10005 | appKey exception. | appKey is frozen. |
20002 | Device does not exist. | |
20006 | Network exception. | Check the device network status. Try later. |
20007 | Device offline. | Check the device online status. |
20008 | Device response overtime. | Too many operations. Try later. |
20014 | Illegal deviceSerial. | |
20018 | The user does not have this device. | Check whether the device belongs to the current account. |
20032 | The channel does not exist. | The channel does not exist. |
49999 | Data exception. | API call exception |
60020 | This command is not supported. | The device does not support the people counting funcrion. |
60022 | Already the current status. | Already the current status. |
1.6 Get Video Tampering Status
API Function
This API is used to get the video tampering status (should be supported by device)
Request Address
`{areaDomain}/api/lapp/device/scene/switch/status`
Request Type
`POST`
Request Parameters
Parameter Name | Type | Description | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
HTTP Request Message
POST /api/lapp/device/scene/switch/status HTTP/1.1 Host: isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666
Return Data
{ "data": { "deviceSerial": "596510666", "channelNo": 1, "enable": 1 }, "code": "200", "msg": "Operating succeeded!" }
Return Field
Parameter Name | Type | Description | Required |
---|---|---|---|
deviceSerial | String | Device serial No. | Y |
channelNo | int | Channel No. | N |
enable | int | Status:0-Disable, 1-Enable |
Y |
- Return Code
Returned Code | Returned Infromation | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10004 | The user does not exist. | |
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 the API exception. |
1.7 Set Video Tampering Status
API Function
This API is used to set the video tampering status (should be supported by device)Request Address
{areaDomain}/api/lapp/device/scene/switch/set
Request Type
POST
Request Parameters
Parameter Name | Type | Description | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
enable | int | Status:0-Disable, 1-Enable |
Y |
channelNo | int | Channel No., no transmission means the device itself. | N |
HTTP Request Message
POST /api/lapp/device/scene/switch/set HTTP/1.1 Host: isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&channelNo=1&enable=1
Return Data
{ "code": "200", "msg": "Operating succeeded!" }
Return Code
Returned Code | Returned Infromation | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10005 | appKey exception. | appKey is frozen. |
20002 | Device does not exist. | |
20006 | Network exception. | Check the device network status. Try later. |
20007 | Device offline. | Check the device online status. |
20008 | Device response overtime. | Too many operations. Try later. |
20014 | Illegal deviceSerial. | |
20018 | The user does not have this device. | Check whether the device belongs to the current account. |
20032 | The channel does not exist. | The channel does not exist. |
49999 | Data exception. | API call exception |
60020 | This command is not supported. | The device does not support the people counting funcrion. |
60022 | Already the current status. | Already the current status. |
1.8 Get Sound Source Positioning Status
API Function
This API is used to get the sound source positioning status (the device should support sound source positioning function)
Request Address
{areaDomain}/api/lapp/device/ssl/switch/status
Request Type
POST
Request Parameters
Parameter Name | Type | Description | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
HTTP Request Message
POST /api/lapp/device/scene/switch/status HTTP/1.1 Host: isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666
Return Data
{ "data": { "deviceSerial": "596510666", "channelNo": 1, "enable": 1 }, "code": "200", "msg": "Operating succeeded!" }
Return Field
Parameter Name | Type | Description |
---|---|---|
deviceSerial | String | String Device serial No. |
channelNo | int | int Channel No. |
enable | int | Status: 0-Disable, 1-Enable |
- Return Code
Returned Code | Returned Infromation | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10004 | The user does not exist. | |
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 the API exception. |
60020 | This command is not supported. | The device does not support the people counting funcrion. |
1.9 Set Sound Source Positioning Status
API Function
This API is used to set the sound source positioning status (the device should support sound source positioning function)Request Address
{areaDomain}/api/lapp/device/ssl/switch/set
Request Type
POST
Request Parameters
Parameter Name | Type | Description | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
enable | int | Status:0-Disable, 1-Enable |
Y |
channelNo | int | Channel No., no transmission means the device itself. | N |
HTTP Request Message
POST /api/lapp/device/scene/switch/set HTTP/1.1 Host: isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&channelNo=1&enable=1
Return Data
{ "code": "200", "msg": "Operating succeeded!" }
Return Code
Returned Code | Returned Infromation | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10005 | appKey exception. | appKey is frozen. |
20002 | Device does not exist. | |
20006 | Network exception. | Check the device network status. Try later. |
20007 | Device offline. | Check the device online status. |
20008 | Device response overtime. | Too many operations. Try later. |
20014 | Illegal deviceSerial. | |
20018 | The user does not have this device. | Check whether the device belongs to the current account. |
20032 | The channel does not exist. | The channel does not exist. |
49999 | Data exception. | API call exception |
60020 | This command is not supported. | The device does not support the people counting funcrion. |
60022 | Already the current status. | Already the current status. |
1.10 Get Device Arming and Disarming Schedule
API Function
This API is used to get the device arming and disarming schedule (the device should support arming and disarming schedule)Request Address
{areaDomain}/api/lapp/device/defence/plan/get
Request Type
POST
Request Parameters
Parameter Name | Type | Description | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
channelNo | int | Channel No., no transmission means the device itself. | N |
HTTP Request Message
POST /api/lapp/device/defence/plan/get HTTP/1.1 Host: isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734888&channelNo=1
Return Data
{ "data": { "startTime": "23:20", "stopTime": "23:21", "period": "0,1,6", "enable": 0 }, "code": "200", "msg": "Operating succeeded!" }
Return Field
Parameter Name | Type | Description |
---|---|---|
startTime | String | Start time, for example: 6:00. By default, start time is 00:00 |
stopTime | String | End time, for example: 16:00, n00:00 means 00:00 of the next day. |
period | String | Monday to Sunday, represented by 0 to 6, separate with comma. |
enable | int | Enable or not: 1- Ennable, 0-Disable |
- Return Code
Returned Code | Returned Infromation | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10004 | The user does not exist. | |
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. |
20032 | The channel does not exist. | The channel does not exist. |
49999 | Data exception. | API call exception |
60020 | This command is not supported. | The device does not support the people counting funcrion. |
1.11 Set Device Arming and Disarming Schedule
API Function
This API is used to set the device arming and disarming (action detection) schedule (the device should support arming and disarming schedule)Request Address
{areaDomain}/api/lapp/device/defence/plan/set
Request Type
POST
Request Parameters
Parameter Name | Type | Description | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
channelNo | int | Channel No., no transmission means the device itself. | N |
startTime | String | Start time, for example: 6:00. By default, start time is 00:00 | N |
stopTime | String | End time, for example: 16:00, n00:00 means 00:00 of the next day. | N |
period | String | Monday to Sunday, represented by 0 to 6, separate with comma. | N |
enable | String | Enable or not: 1- Ennable, 0-Disable. By default, it is 1. | N |
HTTP Request Message
POST /api/lapp/device/defence/plan/set HTTP/1.1 Host: isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734888&channelNo=1&period=0%2C1%2C6&startTime=23%3A20&stopTime=23%3A21&enable=0
Return Data
{ "code": "200", "msg": "Operating succeeded!" }
Return Code
Returned Code | Returned Infromation | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10005 | appKey exception. | appKey is frozen. |
20002 | Device does not exist. | |
20006 | Network exception. | Check the device network status. Try later. |
20007 | Device offline. | Check the device online status. |
20008 | Device response overtime. | Too many operations. Try later. |
20014 | Illegal deviceSerial. | |
20018 | The user does not have this device. | Check whether the device belongs to the current account. |
20032 | The channel does not exist. | The channel does not exist. |
49999 | Data exception. | API call exception |
60020 | This command is not supported. | The device does not support the people counting funcrion. |
1.12 Get device microphone switch status
Function
This API is used to get device microphone switch status.
Requesting Address
{areaDomain}/api/lapp/camera/video/sound/status
Requesting Parameters
POST
Requesting Parameters
Parameter | Type | Description | Required |
---|---|---|---|
accessToken | String | The access_token obtained during authentication. | Y |
deviceSerial | String | The device serial No.. | Y |
- HTTP Requesting Report
POST /api/lapp/camera/video/sound/status HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666
- Returned Data
{
"data": [
{
"deviceSerial": "596510666",
"channelNo": 1,
"enable": "1"
}
],
"code": "200",
"msg": "Operation succeeded!"
}
- Returned Code
Returned Code | Returned Infromation | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10005 | appKey exception. | appKey is frozen. |
20002 | Device does not exist. | |
20006 | Network exception. | Check the device network status. Try later. |
20007 | Device offline. | Check the device online status. |
20008 | Device response overtime. | Too many operations. Try later. |
20014 | Illegal deviceSerial. | |
20018 | The user does not have this device. | Check whether the device belongs to the current account. |
49999 | Data exception. | Calling the API exception. |
60020 | Subscription failed. | Calling the API failed. |
1.13 Set device microphone switch status
Function
This API is used to set device microphone switch status.
Request Address
{areaDomain}/api/lapp/camera/video/sound/set
Request Type
POST
Request Parameters
Parameter Name | Description | Type | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
enable | String | Status: 0-Disable, 1-Enable | Y |
- HTTP Request Message
POST /api/lapp/camera/video/sound/set HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&enable=1
- Return Data
{
"code": "200",
"msg": "Operating succeeded!"
}
- Return Code
Return Code | Return Information | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10005 | appKey exception. | appKey is frozen. |
20002 | Device does not exist. | |
20006 | Network exception. | Check the device network status. Try later. |
20007 | Device offline. | Check the device online status. |
20008 | Device response overtime. | Too many operations. Try later. |
20014 | Illegal deviceSerial. | |
20018 | The user does not have this device. | Check whether the device belongs to the current account. |
49999 | Data exception. | Calling the API exception. |
60020 | Subscription failed. | Calling the API failed. |
1.14 Set configuration of pir area
Function
This API is used to set configuration of device's pir area.
Request Address
{areaDomain}/api/lapp/device/pir/set
Request Type
POST
Request Parameters
Parameter Name | Description | Type | Required | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y | ||||||||||||||||||||
deviceSerial | String | Device serial No. | Y | ||||||||||||||||||||
channelNo | int | Channel No., no transmission means the device itself. | N | ||||||||||||||||||||
area | String | pir area . if the value of area is 1,3,6,7 Selected area is
|
Y |
Every number in param area means the row of area.
Converting decimal to binary , All of 1 area is selected Rows and columns can get through itGet configuration of pir area
- HTTP Request Message
POST //api/lapp/device/pir/set HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&enable=1
- Return Data
{
"code": "200",
"msg": "Operating succeeded!"
}
- Return Code
Return Code | Return Information | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10005 | appKey exception. | appKey is frozen. |
20002 | Device does not exist. | |
20006 | Network exception. | Check the device network status. Try later. |
20007 | Device offline. | Check the device online status. |
20008 | Device response overtime. | Too many operations. Try later. |
20014 | Illegal deviceSerial. | |
20018 | The user does not have this device. | Check whether the device belongs to the current account. |
49999 | Data exception. | Calling the API exception. |
60020 | Subscription failed. | Calling the API failed. |
1.15 Get configuration of pir area
Function
This API is used to get configuration of device's pir area.
Request Address
{areaDomain}/api/lapp/device/pir/get
Request Type
POST
Request Parameters
Parameter Name | Description | Type | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
channelNo | int | Channel No., no transmission means the device itself. | N |
- HTTP Request Message
POST /api/lapp/device/pir/get HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&enable=1
- Return Data
{
"data": {
"deviceSerial": "C24899350",
"channelNo": 1,
"rows": 3,
"columns": 4,
"area": [
1,
9,
13
]
},
"code": "200",
"msg": "Operation succeeded"
}
- Return Field
Parameter Name | Type | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
devceSerial | String | Device serial No. | ||||||||||||||||||||
channelNo | int | Channel No. | ||||||||||||||||||||
rows | int | pir row number | ||||||||||||||||||||
columns | int | pir column number | ||||||||||||||||||||
area | array | pir area . if the value of area is 1,3,6,7 Selected area is
|
Every number in param area means the row of area.
Converting decimal to binary , All of 1 area is selected Rows and columns can get through itGet configuration of pir area
- Return Code
Return Code | Return Information | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10005 | appKey exception. | appKey is frozen. |
20002 | Device does not exist. | |
20006 | Network exception. | Check the device network status. Try later. |
20007 | Device offline. | Check the device online status. |
20008 | Device response overtime. | Too many operations. Try later. |
20014 | Illegal deviceSerial. | |
20018 | The user does not have this device. | Check whether the device belongs to the current account. |
49999 | Data exception. | Calling the API exception. |
60020 | Subscription failed. | Calling the API failed. |
1.16 Set chime type
Function
This API is used to set device chime type .
Request Address
{areaDomain}/api/lapp/device/chime/set
Request Type
POST
Request Parameters
Parameter Name | Description | Type | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
channelNo | int | Channel No., no transmission means the device itself. | N |
type | int | Device chime type , 1 -mechanical , 2 -electronic 3 -none |
Y |
duration | int | The length of time that sth lasts or continues | Y |
- HTTP Request Message
POST /api/lapp/device/chime/set HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.7jao9nxm84yxu7yw432mo40d9ewg4sgx-2rsq7g7pvj-11pgy9c-f3mvxd7vu&deviceSerial=C24899350&channelNo=1&type=3&duration=10000
- Return Data
{
"code": "200",
"msg": "Operation succeeded"
}
- Return Code
Return Code | Return Information | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10005 | appKey exception. | appKey is frozen. |
20002 | Device does not exist. | |
20006 | Network exception. | Check the device network status. Try later. |
20007 | Device offline. | Check the device online status. |
20008 | Device response overtime. | Too many operations. Try later. |
20014 | Illegal deviceSerial. | |
20018 | The user does not have this device. | Check whether the device belongs to the current account. |
49999 | Data exception. | Calling the API exception. |
60020 | Subscription failed. | Calling the API failed. |
1.17 Get chime type
Function
This API is used to get device chime type .
Request Address
{areaDomain}/api/lapp/device/chime/get
Request Type
POST
Request Parameters
Parameter Name | Description | Type | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
channelNo | int | Channel No., no transmission means the device itself. | N |
- HTTP Request Message
POST /api/lapp/camera/video/sound/set HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&channelNo=1
- Return Data
{
"data": {
"deviceSerial": "C24899350",
"channelNo": 1,
"type": 3,
"duration": 1000
},
"code": "200",
"msg": "Operation succeeded"
}
- Return Field
Parameter Name | Type | Description |
---|---|---|
devceSerial | String | Device serial No. |
channelNo | int | Channel No. |
type | int | Device chime type , 1 -mechanical , 2 -electronic 3 -none |
duration | int | The length of time that sth lasts or continues |
- Return Code
Return Code | Return Information | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10005 | appKey exception. | appKey is frozen. |
20002 | Device does not exist. | |
20006 | Network exception. | Check the device network status. Try later. |
20007 | Device offline. | Check the device online status. |
20008 | Device response overtime. | Too many operations. Try later. |
20014 | Illegal deviceSerial. | |
20018 | The user does not have this device. | Check whether the device belongs to the current account. |
49999 | Data exception. | Calling the API exception. |
60020 | Subscription failed. | Calling the API failed. |
1.18 Set infrared type
API Function
This API is used to set device infrared typeRequest Address
{areaDomain}/api/lapp/device/infrared/switch/set
Request Type
POST
Request Parameters
Parameter Name | Type | Description | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
enable | int | Status:0-Disable, 1-Enable |
Y |
channelNo | int | Channel No., no transmission means the device itself. | N |
- HTTP Request Message
POST /api/lapp/device/infrared/switch/get HTTP/1.1 Host: isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.b5ippaayadv7ggygbncw7olp3nq7b129-2vcdp4lsz9-17yuus8-upr63lmag&deviceSerial=C24899350&channelNo=1&enable=0
- Return Data
{ "code": "200", "msg": "Operation succeeded" }
- Return Field
Parameter Name | Type | Description |
---|---|---|
deviceSerial | String | Device serial No. |
channelNo | String | Channel No. |
enable | int | Status: 0-Disable, 1-Enable |
- Return Code
Returned Code | Returned Infromation | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10004 | The user does not exist. | |
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 the API exception. |
1.19 Get Infrared Type
API Function
This API is used to get device infrared type
Request Address
`{areaDomain}/api/lapp/device/infrared/switch/get`
Request Type
`POST`
Request Parameters
Parameter Name | Type | Description | Required |
---|---|---|---|
accessToken | String | Obtained access_token during assigning permission | Y |
deviceSerial | String | Device serial No. | Y |
channelNo | int | Channel No., no transmission means the device itself. | N |
HTTP Request Message
POST /api/lapp/device/infrared/switch/get HTTP/1.1 Host: isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.9mqitppidgce4y8n54ranvyqc9fjtsrl&deviceSerial=596510888&enable=1&channelNo=1
Return Data
{ "data": { "deviceSerial": "C24899350", "channelNo": 1, "enable": 0 }, "code": "200", "msg": "Operation succeeded" }
Return Code
Returned Code | Returned Infromation | Description |
---|---|---|
200 | Operation succeeded. | Requesting succeeded. |
10001 | Parameters error. | Parameters are empty or the format is incorrect. |
10002 | accessToken exception or is expired. | Get accessToken again. |
10005 | appKey exception. | appKey is frozen. |
20002 | Device does not exist. | |
20006 | Network exception. | Check the device network status. Try later. |
20007 | Device offline. | Check the device online status. |
20008 | Device response overtime. | Too many operations. Try later. |
20014 | Illegal deviceSerial. | |
20018 | The user does not have this device. | Check whether the device belongs to the current account. |
20032 | The channel does not exist. | The channel does not exist. |
49999 | Data exception. | API call exception |
60020 | This command is not supported. | The device does not support the people counting funcrion. |
60022 | Already the current status. | Already the current status. |
1.20 Get device time zone
API Function
Query the basic information of the user device (including time zone)
Request Address
{areaDomain}/api/lapp/device/info
Request Type
POST
Request Parameters
Parameter name | Type | Description | Required |
---|---|---|---|
accessToken | String | access_token | Y |
deviceSerial | Strring | Device serial number | Y |
version | String | Interface version number, the parameter must be entered as: utc to get the device time zone |
Y |
http Request Message
POST /api/lapp/device/info HTTP/1.1 Host: https://isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.8mozdi23c6gd3i3acx252ryl9nxdi7pc-9db2tvmfdx-0e8lbja-kqw6uutal&deviceSerial=Q00737271&version=utc
Return Data
{ "code": "200", "data": { "deviceSerial": "Q00737272", "deviceName": "A1S(Q00737272)", "model": "CS-A1S-32WE2G", "status": 1, "defence": 8, "isEncrypt": 0, "alarmSoundMode": 1, "offlineNotify": 0, "wifiSsid": "", "timeZone": "UTC+14:00" }, "msg": "Operation succeeded" }
Return Field
Field Name | Type | Description |
---|---|---|
deviceSerial | String | Device serial number |
deviceName | String | Device name |
model | String | Device model, such as CS-C2S-21WPFR-WX |
status | int | Online status: 0-Offline, 1-Online |
defence | int | Protected device arming and disarming status:0-sleep, 8-at home, 16-outing , ordinary IPC arming and disarming status:0-disarmed, 1-armed |
isEncrypt | int | Encrypt: 0-no encryption, 1-encryption |
alarmSoundMode | int | Alarm sound mode: 0-short call, 1-long call, 2-mute |
offlineNotify | int | Whether to notify the device goes offline: 0-not notify 1-notify |
wifiSsid | String | wifi ssid (returned when version = utc ) |
timeZone | String | Time zone (returned when version = utc ) |
- Return code
Return code | Returned message | Description |
---|---|---|
200 | Operate successfully | Request successfully |
10001 | Parameter error | The parameter is empty or the format is incorrect |
10002 | Abnormal or expired AccessToken | re-access AccessToken |
10005 | Abnormal appKey | appKey is frozen |
20002 | Device does not exist | |
20014 | deviceSerial is illegal | |
20018 | The user does not own the device | Check if the device belongs to the current account |
49999 | Data exception | Interface call exception |
50000 | Service exception | System service exception |
1.21 Get time zone list
API Function
Get a list of time zones
Request Address
{areaDomain}/api/lapp/timezone/list
Request Type
POST
Request Parameters
Parameter name | Type | Description | Required |
---|---|---|---|
language | String | Time zone language can only be ENGLISH orSIMPCN , the default value is ENGLISH |
N |
Http Request Message
POST /api/lapp/timezone/list HTTP/1.1 Host: https://isgpopen.ezvizlife.com
Return Data
{ "code": "200", "data": [ { "tzCode": "2", "tzValue": "UTC+14:00", "disPlayName": "(UTC+14:00) Kiritimati Island" }, { "tzCode": "4", "tzValue": "UTC+13:00", "disPlayName": "(UTC+13:00) Samoa" }, { "tzCode": "6", "tzValue": "UTC+13:00", "disPlayName": "(UTC+13:00) Nuku'alofa" }, { "tzCode": "8", "tzValue": "UTC+12:00", "disPlayName": "(UTC+12:00) Fiji" }, { "tzCode": "10", "tzValue": "UTC+12:00", "disPlayName": "(UTC+12:00) Auckland, Wellington" }, { "tzCode": "12", "tzValue": "UTC+12:00", "disPlayName": "(UTC+12:00) Anadyr, Petropavlovsk-Kamchatsky (RTZ 11)" }, { "tzCode": "14", "tzValue": "UTC+12:00", "disPlayName": "(UTC+12:00) Coordinated Universal Time+12" }, { "tzCode": "16", "tzValue": "UTC+11:00", "disPlayName": "(UTC+11:00) Solomon Is., New Caledonia" }, { "tzCode": "18", "tzValue": "UTC+11:00", "disPlayName": "(UTC+11:00) Chokurdakh (RTZ 10)" }, { "tzCode": "20", "tzValue": "UTC+10:00", "disPlayName": "(UTC+10:00) Canberra, Melbourne, Sydney" }, { "tzCode": "22", "tzValue": "UTC+10:00", "disPlayName": "(UTC+10:00) Brisbane" }, { "tzCode": "24", "tzValue": "UTC+10:00", "disPlayName": "(UTC+10:00) Magadan" }, { "tzCode": "26", "tzValue": "UTC+10:00", "disPlayName": "(UTC+10:00) Hobart" }, { "tzCode": "28", "tzValue": "UTC+10:00", "disPlayName": "(UTC+10:00) Vladivostok, Magadan (RTZ 9)" }, { "tzCode": "30", "tzValue": "UTC+10:00", "disPlayName": "(UTC+10:00) Guam, Port Moresby" }, { "tzCode": "32", "tzValue": "UTC+09:30", "disPlayName": "(UTC+09:30) Darwin" }, { "tzCode": "34", "tzValue": "UTC+09:30", "disPlayName": "(UTC+09:30) Adelaide" }, { "tzCode": "36", "tzValue": "UTC+09:00", "disPlayName": "(UTC+09:00) Seoul" }, { "tzCode": "38", "tzValue": "UTC+09:00", "disPlayName": "(UTC+09:00) Osaka, Sapporo, Tokyo" }, { "tzCode": "40", "tzValue": "UTC+09:00", "disPlayName": "(UTC+09:00) Yakutsk (RTZ 8)" }, { "tzCode": "42", "tzValue": "UTC+08:00", "disPlayName": "(UTC+08:00) Beijing, Chongqing, Hong Kong, Urumqi" }, { "tzCode": "44", "tzValue": "UTC+08:00", "disPlayName": "(UTC+08:00) Irkutsk (RTZ 7)" }, { "tzCode": "46", "tzValue": "UTC+08:00", "disPlayName": "(UTC+08:00) Kuala Lumpur, Singapore" }, { "tzCode": "48", "tzValue": "UTC+08:00", "disPlayName": "(UTC+08:00) Taipei" }, { "tzCode": "50", "tzValue": "UTC+08:00", "disPlayName": "(UTC+08:00) Ulaanbaatar" }, { "tzCode": "52", "tzValue": "UTC+08:00", "disPlayName": "(UTC+08:00) Perth" }, { "tzCode": "54", "tzValue": "UTC+07:00", "disPlayName": "(UTC+07:00) Krasnoyarsk (RTZ 6)" }, { "tzCode": "56", "tzValue": "UTC+07:00", "disPlayName": "(UTC+07:00) Bangkok, Hanoi, Jakarta" }, { "tzCode": "58", "tzValue": "UTC+06:30", "disPlayName": "(UTC+06:30) Yangon (Rangoon)" }, { "tzCode": "60", "tzValue": "UTC+06:00", "disPlayName": "(UTC+06:00) Dhaka" }, { "tzCode": "62", "tzValue": "UTC+06:00", "disPlayName": "(UTC+06:00) Astana" }, { "tzCode": "64", "tzValue": "UTC+06:00", "disPlayName": "(UTC+06:00) Novosibirsk (RTZ 5)" }, { "tzCode": "66", "tzValue": "UTC+05:45", "disPlayName": "(UTC+05:45) Kathmandu" }, { "tzCode": "68", "tzValue": "UTC+05:30", "disPlayName": "(UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi" }, { "tzCode": "70", "tzValue": "UTC+05:30", "disPlayName": "(UTC+05:30) Sri Jayawardenepura" }, { "tzCode": "72", "tzValue": "UTC+05:00", "disPlayName": "(UTC+05:00) Ekaterinburg (RTZ 4)" }, { "tzCode": "74", "tzValue": "UTC+05:00", "disPlayName": "(UTC+05:00) Islamabad, Karachi" }, { "tzCode": "76", "tzValue": "UTC+05:00", "disPlayName": "(UTC+05:00) Ashgabat, Tashkent" }, { "tzCode": "78", "tzValue": "UTC+04:30", "disPlayName": "(UTC+04:30) Kabul" }, { "tzCode": "80", "tzValue": "UTC+04:00", "disPlayName": "(UTC+04:00) Abu Dhabi, Muscat" }, { "tzCode": "82", "tzValue": "UTC+04:00", "disPlayName": "(UTC+04:00) Baku" }, { "tzCode": "84", "tzValue": "UTC+04:00", "disPlayName": "(UTC+04:00) Yerevan" }, { "tzCode": "86", "tzValue": "UTC+04:00", "disPlayName": "(UTC+04:00) Tbilisi" }, { "tzCode": "88", "tzValue": "UTC+04:00", "disPlayName": "(UTC+04:00) Port Louis" }, { "tzCode": "90", "tzValue": "UTC+04:00", "disPlayName": "(UTC+04:00) Izhevsk, Samara (RTZ 3)" }, { "tzCode": "92", "tzValue": "UTC+03:30", "disPlayName": "(UTC+03:30) Tehran" }, { "tzCode": "94", "tzValue": "UTC+03:00", "disPlayName": "(UTC+03:00) Kuwait, Riyadh" }, { "tzCode": "96", "tzValue": "UTC+03:00", "disPlayName": "(UTC+03:00) Baghdad" }, { "tzCode": "98", "tzValue": "UTC+03:00", "disPlayName": "(UTC+03:00) Minsk" }, { "tzCode": "100", "tzValue": "UTC+03:00", "disPlayName": "(UTC+03:00) Nairobi" }, { "tzCode": "102", "tzValue": "UTC+03:00", "disPlayName": "(UTC+03:00) Moscow, St. Petersburg, Volgograd (RTZ 2)" }, { "tzCode": "104", "tzValue": "UTC+02:00", "disPlayName": "(UTC+02:00) E. Europe" }, { "tzCode": "106", "tzValue": "UTC+02:00", "disPlayName": "(UTC+02:00) Cairo" }, { "tzCode": "108", "tzValue": "UTC+02:00", "disPlayName": "(UTC+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius" }, { "tzCode": "110", "tzValue": "UTC+02:00", "disPlayName": "(UTC+02:00) Athens, Bucharest" }, { "tzCode": "112", "tzValue": "UTC+02:00", "disPlayName": "(UTC+02:00) Jerusalem" }, { "tzCode": "114", "tzValue": "UTC+02:00", "disPlayName": "(UTC+02:00) Amman" }, { "tzCode": "116", "tzValue": "UTC+02:00", "disPlayName": "(UTC+02:00) Kaliningrad (RTZ 1)" }, { "tzCode": "118", "tzValue": "UTC+02:00", "disPlayName": "(UTC+02:00) Tripoli" }, { "tzCode": "120", "tzValue": "UTC+02:00", "disPlayName": "(UTC+02:00) Beirut" }, { "tzCode": "122", "tzValue": "UTC+02:00", "disPlayName": "(UTC+02:00) Harare, Pretoria" }, { "tzCode": "124", "tzValue": "UTC+02:00", "disPlayName": "(UTC+02:00) Damascus" }, { "tzCode": "126", "tzValue": "UTC+02:00", "disPlayName": "(UTC+02:00) Istanbul" }, { "tzCode": "128", "tzValue": "UTC+01:00", "disPlayName": "(UTC+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague" }, { "tzCode": "130", "tzValue": "UTC+01:00", "disPlayName": "(UTC+01:00) Sarajevo, Skopje, Warsaw, Zagreb" }, { "tzCode": "132", "tzValue": "UTC+01:00", "disPlayName": "(UTC+01:00) Windhoek" }, { "tzCode": "134", "tzValue": "UTC+01:00", "disPlayName": "(UTC+01:00) Brussels, Copenhagen, Madrid, Paris" }, { "tzCode": "136", "tzValue": "UTC+01:00", "disPlayName": "(UTC+01:00) West Central Africa" }, { "tzCode": "138", "tzValue": "UTC+01:00", "disPlayName": "(UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna" }, { "tzCode": "140", "tzValue": "UTC", "disPlayName": "(UTC) Dublin, Edinburgh, Lisbon, London" }, { "tzCode": "142", "tzValue": "UTC", "disPlayName": "(UTC) Monrovia, Reykjavik" }, { "tzCode": "144", "tzValue": "UTC", "disPlayName": "(UTC) Casablanca" }, { "tzCode": "146", "tzValue": "UTC", "disPlayName": "(UTC) Coordinated Universal Time" }, { "tzCode": "148", "tzValue": "UTC-01:00", "disPlayName": "(UTC-01:00) Azores" }, { "tzCode": "150", "tzValue": "UTC-01:00", "disPlayName": "(UTC-01:00) Cabo Verde Is." }, { "tzCode": "152", "tzValue": "UTC-02:00", "disPlayName": "(UTC-02:00) Coordinated Universal Time-02" }, { "tzCode": "154", "tzValue": "UTC-03:00", "disPlayName": "(UTC-03:00) Buenos Aires" }, { "tzCode": "156", "tzValue": "UTC-03:00", "disPlayName": "(UTC-03:00) Salvador" }, { "tzCode": "158", "tzValue": "UTC-03:00", "disPlayName": "(UTC-03:00) Brasilia" }, { "tzCode": "160", "tzValue": "UTC-03:00", "disPlayName": "(UTC-03:00) Greenland" }, { "tzCode": "162", "tzValue": "UTC-03:00", "disPlayName": "(UTC-03:00) Montevideo" }, { "tzCode": "164", "tzValue": "UTC-03:00", "disPlayName": "(UTC-03:00) Cayenne, Fortaleza" }, { "tzCode": "166", "tzValue": "UTC-03:30", "disPlayName": "(UTC-03:30) Newfoundland" }, { "tzCode": "168", "tzValue": "UTC-04:00", "disPlayName": "(UTC-04:00) Atlantic Time (Canada)" }, { "tzCode": "170", "tzValue": "UTC-04:00", "disPlayName": "(UTC-04:00) Cuiaba" }, { "tzCode": "172", "tzValue": "UTC-04:00", "disPlayName": "(UTC-04:00) Santiago" }, { "tzCode": "174", "tzValue": "UTC-04:00", "disPlayName": "(UTC-04:00) Asuncion" }, { "tzCode": "176", "tzValue": "UTC-04:00", "disPlayName": "(UTC-04:00) Georgetown, La Paz, Manaus, San Juan" }, { "tzCode": "178", "tzValue": "UTC-04:30", "disPlayName": "(UTC-04:30) Caracas" }, { "tzCode": "180", "tzValue": "UTC-05:00", "disPlayName": "(UTC-05:00) Eastern Time (US & Canada)" }, { "tzCode": "182", "tzValue": "UTC-05:00", "disPlayName": "(UTC-05:00) Bogota, Lima, Quito, Rio Branco" }, { "tzCode": "184", "tzValue": "UTC-05:00", "disPlayName": "(UTC-05:00) Indiana (East)" }, { "tzCode": "186", "tzValue": "UTC-06:00", "disPlayName": "(UTC-06:00) Saskatchewan" }, { "tzCode": "188", "tzValue": "UTC-06:00", "disPlayName": "(UTC-06:00) Central America" }, { "tzCode": "190", "tzValue": "UTC-06:00", "disPlayName": "(UTC-06:00) Central Time (US & Canada)" }, { "tzCode": "192", "tzValue": "UTC-06:00", "disPlayName": "(UTC-06:00) Guadalajara, Mexico City, Monterrey" }, { "tzCode": "194", "tzValue": "UTC-07:00", "disPlayName": "(UTC-07:00) Mountain Time (US & Canada)" }, { "tzCode": "196", "tzValue": "UTC-07:00", "disPlayName": "(UTC-07:00) Chihuahua, La Paz, Mazatlan" }, { "tzCode": "198", "tzValue": "UTC-07:00", "disPlayName": "(UTC-07:00) Arizona" }, { "tzCode": "200", "tzValue": "UTC-08:00", "disPlayName": "(UTC-08:00) Pacific Time (US & Canada)" }, { "tzCode": "202", "tzValue": "UTC-08:00", "disPlayName": "(UTC-08:00) Baja California" }, { "tzCode": "204", "tzValue": "UTC-09:00", "disPlayName": "(UTC-09:00) Alaska" }, { "tzCode": "206", "tzValue": "UTC-10:00", "disPlayName": "(UTC-10:00) Hawaii" }, { "tzCode": "208", "tzValue": "UTC-11:00", "disPlayName": "(UTC-11:00) Coordinated Universal Time-11" }, { "tzCode": "210", "tzValue": "UTC-12:00", "disPlayName": "(UTC-12:00) International Date Line West" } ], "msg": "Operation succeeded" }
Return Field
Field Name | Type | 描Description |
---|---|---|
tzCode | String | Time zone encoding (used when calling the set time interface) |
tzValue | String | Time zone |
disPlayName | String | Time zone's display name |
- Return Code
Return code | Return message | Description |
---|---|---|
200 | operate successfully | Request successfully |
10001 | Parameter error | The parameter is empty or the format is incorrect |
49999 | Data exception | Interface call exception |
1.22 Set device time zone
API Function
Set the time zone of the user's device
Request Address
{areaDomain}/api/lapp/device/timezone/set
Request Type
POST
Request Parameters
Parameter name | Type | Description | Required | |
---|---|---|---|---|
accessToken | String | access_token obtained by the authorization process | Y | |
deviceSerial | Strring | Device serial number | Y | |
timezone | String | Time zone code, tzCode value obtained through the time zone list query interface | Y | |
timeFormat | int | time format \ | 0: YYYY-MM-DD, 1: MM-DD-YYYY, 2: DD-MM-YYYY |
Y |
daylightSaving | String | Whether to turn on daylight saving time 0-not open, 1-open |
N |
httpRequest Message
POST /api/lapp/device/timezone/set HTTP/1.1 Host: https://isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.8mozdi23c6gd3i3acx252ryl9nxdi7pc-9db2tvmfdx-0e8lbja-kqw6uutal&deviceSerial=Q00737272&timezone=188&timeFormat=0
Return Data
{ "code": "200", "msg": "Operation succeeded" }
Return Code
Return code | Return message | Description |
---|---|---|
200 | Operate successfully | Requested successfully |
10001 | Parameter error | The parameter is empty or the format is incorrect |
10002 | Abnormal or expired AccessToken | re-accessAccessToken |
10005 | Abnormal appKey | appKey is frozen |
20002 | Device does not exist | |
20014 | deviceSerial is illegal | |
20018 | The user does not own the device | Check if the device belongs to the current account |
49999 | Data exception | Interface call exception |
50000 | Service exception | System service exception |
1.23 Get device capability
API Function
Query the capability set of user device
Request Address
{areaDomain}/api/lapp/device/capacity
Request Type
POST
Minimum permissions required for sub-account token requests
"Permission":"Get"
"Resource":"cam:序列号"
Request Parameters
Parameter name | Type | Description | Required |
---|---|---|---|
accessToken | String | access_token obtained by the authorization process | Y |
deviceSerial | Strring | Device serial number | Y |
channelNo | String | Device channel number | N |
http请求报文
POST /api/lapp/device/capacity HTTP/1.1 Host: https://isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.8mozdi23c6gd3i3acx252ryl9nxdi7pc-9db2tvmfdx-0e8lbja-kqw6uutal&deviceSerial=Q00737272
Return Data
{ "code": "200", "data": { "ptz_left_right": "0", "ptz_top_bottom": "0", "support_add_del_detector": "1", "support_alarm_voice": "1", "support_alert_tone": "1", "support_anti_open": "1", "support_ap_allseries": "1", "support_ap_mode": "2", "support_auto_offline": "0", "support_battery_manage": "1", "support_channel_number": 0, "support_cloud": "0", "support_defence": "1", "support_defenceplan": "1", "support_device_rf_signal_report": "1", "support_devicelog": "1", "support_disk": "0", "support_encrypt": "0", "support_ipc_link": "1", "support_language": "FRENCH,SPANISH,RUSSIAN,KOREAN,ITALIAN,GERMAN,ENGLISH", "support_message": "0", "support_modify_detectorguard": "0,0,7,7,7,0,7,0,0,0", "support_modify_detectorname": "1", "support_privacy": "0", "support_protection_mode": "1", "support_ptz": "0", "support_related_device": "2", "support_remote_quiet": "1", "support_safe_mode_plan": "1", "support_sim_card": "1", "support_smart_wifi": "1", "support_sound_light_alarm": "1", "support_talk": "0", "support_timezone": "1", "support_unbind": "0", "support_upgrade": "1", "support_weixin": "1", "support_wifi": "3", "support_wifi_userId": "1", "video_quality_capacity": [] }, "msg": "Operation succeeded" }
Return Field
See [Device Capability Set Description] (# capacity_list) for details
Capabilities that are in the capability set specification but not in the return field are not supported by default
Return Code
Return code | Return message | Description |
---|---|---|
200 | Operate successfully | Requested successfully |
10001 | Parameter error | The parameter is empty or the format is incorrect |
10002 | Abnormal or expired AccessToken | re-accessAccessToken |
10005 | Abnormal appKey | appKey is frozen |
20002 | Device does not exist | |
20014 | deviceSerial is illegal | |
20018 | The user does not own the device | Check if the device belongs to the current account |
49999 | Data exception | Interface call exception |
50000 | Service exception | System service exception |
1.24 Get device language
API Function
Get the current language setting of the user device
Request Address
{areaDomain}/api/lapp/device/language/get
Request Type
POST
Minimum permissions required for sub-account token requests
"Permission":"Get"
"Resource":"dev:serial number"
Request Parameters
Parameter name | Type | Description | Required |
---|---|---|---|
accessToken | String | access_token obtained by the authorization process | Y |
deviceSerial | Strring | Device serial number | Y |
Http Request Message
POST /api/lapp/device/language/get HTTP/1.1 Host: https://isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.8mozdi23c6gd3i3acx252ryl9nxdi7pc-9db2tvmfdx-0e8lbja-kqw6uutal&deviceSerial=Q00737272
Return Data
{ "code": "200", "data": { "language": "ENGLISH" }, "msg": "Operation succeeded" }
Return Field
Field Name | Type | Description |
---|---|---|
language | String | Device language |
- Return code
Return code | Return message | Description |
---|---|---|
200 | Operate successfully | Requested successfully |
10001 | Parameter error | The parameter is empty or the format is incorrect |
10002 | Abnormal or expired AccessToken | re-accessAccessToken |
10005 | Abnormal appKey | appKey is frozen |
20002 | Device does not exist | |
20014 | deviceSerial is illegal | |
20018 | The user does not own the device | Check if the device belongs to the current account |
49999 | Data exception | Interface call exception |
50000 | Service exception | System service exception |
1.25 Set device language
API Function
Set user device language
Request Address
{areaDomain}/api/lapp/device/language/set
Request Type
POST
Minimum permissions required for sub-account token requests
"Permission":"Config"
"Resource":"dev:serial number"
Requested Parameters
Parameter name | Type | Description | Required |
---|---|---|---|
accessToken | String | access_token obtained by the authorization process | Y |
deviceSerial | String | Device serial number | Y |
language | String | The language to be set. The parameter value can be obtained from the field [support_language] return by [Get Device Capability Set] (#api_capacity) | Y |
Http Request Message
POST /api/lapp/device/language/set HTTP/1.1 Host: https://isgpopen.ezvizlife.com Content-Type: application/x-www-form-urlencoded accessToken=at.8mozdi23c6gd3i3acx252ryl9nxdi7pc-9db2tvmfdx-0e8lbja-kqw6uutal&deviceSerial=Q00737272&language=GERMAN
Return Data
{ "code": "200", "msg": "Operation succeeded" }
Return Code
Return code | Return message | Description |
---|---|---|
200 | Operate successfully | Requested successfully |
10001 | Parameter error | The parameter is empty or the format is incorrect |
10002 | Abnormal or expired AccessToken | re-accessAccessToken |
10005 | Abnormal appKey | appKey is frozen |
20002 | Device does not exist | |
20006 | Network anomaly | Check the device network status, try again later |
20007 | The device is not online | Check if the device is online |
20008 | Device response timed out | Operating too frequently, try again later |
20014 | deviceSerial is illegal | |
20018 | The user does not own the device | Check if the device belongs to the current account |
49999 | Data exception | Interface call exception |
50000 | Service exception | System service exception |