锁-消息通知

开门通知列表

请求链接: /lockNoticeSettingAccount/list
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	500	锁ID
noticeType	int	Y	10	10开门通知 20胁迫开门

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
list	Array	通知列表
id	Int	数据ID
lockId	Int	锁ID
noticeType	Int	通知类型
settingValue	Object	设置值
openDoorId	Int	开门ID
openDoorType	Int	开门方式
remark	String	备注
noticeWay	Array	通知方式
type	String	通知类型（mail/sms）
accounts	Array	账号列表
countryCode	Int	国家代码
account	String	账号
total	Int	总数
pageNo	Int	页码
pageSize	Int	每页数量

json

{
  "list": [
    {
      "id": 2,
      "lockId": 1782,
      "noticeType": 10,
      "settingValue": {
        "openDoorId": 1,
        "openDoorType": 1,
        "remark": "开门通知2",
        "noticeWay": [
          {
            "type": "mail",
            "accounts": [
              "123@qq.com",
              "1234@qq.com"
            ]
          },
          {
            "type": "sms",
            "accounts": [
              {
                "countryCode": 86,
                "account": "18111111111"
              },
              {
                "countryCode": 86,
                "account": "18111111112"
              }
            ]
          }
        ]
      },
      "created_at": "2024-04-20T05:48:42.000000Z",
      "updated_at": "2024-04-20T05:48:42.000000Z"
    },
    {
      "id": 3,
      "lockId": 1782,
      "noticeType": 10,
      "settingValue": {
        "openDoorId": 1,
        "openDoorType": 1,
        "remark": "开门通知2",
        "noticeWay": [
          {
            "type": "mail",
            "accounts": [
              "123@qq.com",
              "1234@qq.com"
            ]
          },
          {
            "type": "sms",
            "accounts": [
              {
                "countryCode": 86,
                "account": "18111111111"
              },
              {
                "countryCode": 86,
                "account": "18111111112"
              }
            ]
          }
        ]
      },
      "created_at": "2024-04-20T06:20:54.000000Z",
      "updated_at": "2024-04-20T06:20:54.000000Z"
    }
  ],
  "total": 2,
  "pageNo": 1,
  "pageSize": 10
}

添加开门通知

请求链接: /lockNoticeSettingAccount/add
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	500	锁ID
noticeType	int	Y	10	10开门通知 20胁迫开门
settingValue	object	Y	{}	格式看下方代码块

settingValue 格式说明：

openDoorId: 电子钥匙：id、密码：id、IC卡：id、指纹：id、人脸：id
openDoorType: 开门方式：请看常量列表 0.4.6. 钥匙类型
remark: 钥匙名称或备注
noticeWay: 通知方式数组

json

{
  "openDoorId": 100,
  "openDoorType": 1,
  "remark": "家人-电子钥匙",
  "noticeWay": [
    {
      "type": "mail",
      "accounts": [
        {
          "countryCode": 0,
          "account": "123@qq.com"
        },
        {
          "countryCode": 0,
          "account": "123456@qq.com"
        }
      ]
    },
    {
      "type": "sms",
      "accounts": [
        {
          "countryCode": 86,
          "account": "18111111111"
        },
        {
          "countryCode": 86,
          "account": "18111111112"
        }
      ]
    }
  ]
}

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息

json

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

更新开门通知

请求链接: /lockNoticeSettingAccount/update
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockNoticeSettingAccountId	int	Y	1	数据ID
settingValue	object	Y	{}	格式看下方代码块

settingValue 格式说明：

openDoorId: 电子钥匙：keyId、密码：keyboardpwdId、IC卡：cardId、指纹：fingerprintId、人脸：faceId
openDoorType: 开门方式：请看常量列表 0.4.6. 钥匙类型
remark: 钥匙名称或备注
noticeWay: 通知方式数组

json

{
  "openDoorId": 100,
  "openDoorType": 1,
  "remark": "家人-电子钥匙",
  "noticeWay": [
    {
      "type": "mail",
      "accounts": [
        {
          "countryCode": 0,
          "account": "123@qq.com"
        },
        {
          "countryCode": 0,
          "account": "123456@qq.com"
        }
      ]
    },
    {
      "type": "sms",
      "accounts": [
        {
          "countryCode": 86,
          "account": "18111111111"
        },
        {
          "countryCode": 86,
          "account": "18111111112"
        }
      ]
    }
  ]
}

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息

json

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

删除开门通知

请求链接: /lockNoticeSettingAccount/delete
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockNoticeSettingAccountId	int	Y	1	数据ID

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息

json

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

设置N天未开门

请求链接: /lockSetting/updateLockNoticeSetting
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	500	锁ID
dayNotOpenDoorState	int	Y	0	N天未开门提醒开关：0/1
dayNotOpenDoorValue	int	N	1	门未开时间：单位天数
dayNotOpenDoorNoticeWayList	array	N	[]	通知方式：对象格式看下方

dayNotOpenDoorNoticeWayList 格式示例：

json

[
  {
    "type": "mail",
    "accounts": [
      {
        "countryCode": 0,
        "account": "123456@qq.com"
      },
      {
        "countryCode": 0,
        "account": "1234@qq.com"
      }
    ]
  },
  {
    "type": "sms",
    "accounts": [
      {
        "countryCode": 86,
        "account": "18111111111"
      },
      {
        "countryCode": 86,
        "account": "18111111112"
      }
    ]
  }
]

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息

json

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

设置门未关好

请求链接: /lockSetting/updateLockNoticeSetting
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	500	锁ID
doorNotCloseState	int	Y	0	门未关好开关：0/1

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息

json

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

设置防拆报警通知

请求链接: /lockSetting/updateLockNoticeSetting
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	500	锁ID
tamperAlarmState	int	Y	0	开关：0/1

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息

json

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

设置低电量提醒

请求链接: /lockSetting/updateLockNoticeSetting
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	500	锁ID
lowElecNoticeState	int	Y	1	通知开关：0/1
lowElecNoticeWayList	array	N	[]	通知方式：对象格式看下方

lowElecNoticeWayList 格式示例：

json

[
  {
    "type": "mail",
    "accounts": [
      {
        "countryCode": 0,
        "account": "13@qq.com"
      }
    ]
  },
  {
    "type": "sms",
    "accounts": [
      {
        "countryCode": 86,
        "account": "12345678911"
      }
    ]
  }
]

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息

json

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

胁迫开门通知列表

请求链接: /lockNoticeSettingAccount/list
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	500	锁ID
noticeType	int	Y	20	20胁迫开门

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
list	Array	通知列表
id	Int	数据ID
lockId	Int	锁ID
noticeType	Int	通知类型
settingValue	Object	设置值
openDoorId	Int	开门ID
openDoorType	Int	开门方式
remark	String	备注
noticeWay	Array	通知方式
type	String	通知类型（mail/sms）
accounts	Array	账号列表
countryCode	Int	国家代码
account	String	账号
total	Int	总数
pageNo	Int	页码
pageSize	Int	每页数量

json

{
  "list": [
    {
      "id": 2,
      "lockId": 1782,
      "noticeType": 10,
      "settingValue": {
        "openDoorId": 1,
        "openDoorType": 1,
        "remark": "开门通知2",
        "noticeWay": [
          {
            "type": "mail",
            "accounts": [
              "123@qq.com",
              "1234@qq.com"
            ]
          },
          {
            "type": "sms",
            "accounts": [
              {
                "countryCode": 86,
                "account": "18111111111"
              },
              {
                "countryCode": 86,
                "account": "18111111112"
              }
            ]
          }
        ]
      },
      "created_at": "2024-04-20T05:48:42.000000Z",
      "updated_at": "2024-04-20T05:48:42.000000Z"
    },
    {
      "id": 3,
      "lockId": 1782,
      "noticeType": 10,
      "settingValue": {
        "openDoorId": 1,
        "openDoorType": 1,
        "remark": "开门通知2",
        "noticeWay": [
          {
            "type": "mail",
            "accounts": [
              "123@qq.com",
              "1234@qq.com"
            ]
          },
          {
            "type": "sms",
            "accounts": [
              {
                "countryCode": 86,
                "account": "18111111111"
              },
              {
                "countryCode": 86,
                "account": "18111111112"
              }
            ]
          }
        ]
      },
      "created_at": "2024-04-20T06:20:54.000000Z",
      "updated_at": "2024-04-20T06:20:54.000000Z"
    }
  ],
  "total": 2,
  "pageNo": 1,
  "pageSize": 10
}

添加胁迫开门通知

请求链接: /lockNoticeSettingAccount/add
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	500	锁ID
noticeType	int	Y	20	20胁迫开门
settingValue	object	Y	{}	格式看下方代码块

settingValue 格式说明：

openDoorId: 指纹：id、人脸：id
openDoorType: 开门方式：请看常量列表 0.4.6. 钥匙类型
remark: 指纹名称或备注
noticeWay: 通知方式数组

json

{
  "openDoorId": 100,
  "openDoorType": 1,
  "remark": "家人-指纹钥匙",
  "noticeWay": [
    {
      "type": "mail",
      "accounts": [
        {
          "countryCode": 0,
          "account": "123@qq.com"
        },
        {
          "countryCode": 0,
          "account": "123456@qq.com"
        }
      ]
    },
    {
      "type": "sms",
      "accounts": [
        {
          "countryCode": 86,
          "account": "18111111111"
        },
        {
          "countryCode": 86,
          "account": "18111111112"
        }
      ]
    }
  ]
}

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息

json

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

更新胁迫开门通知

请求链接: /lockNoticeSettingAccount/update
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockNoticeSettingAccountId	int	Y	1	数据ID
settingValue	object	Y	{}	格式看下方代码块

settingValue 格式说明：

openDoorId: 指纹：fingerprintId、人脸：faceId
openDoorType: 开门方式：请看常量列表 0.4.6. 钥匙类型
remark: 指纹名称或备注
noticeWay: 通知方式数组

json

{
  "openDoorId": 100,
  "openDoorType": 1,
  "remark": "家人-指纹钥匙",
  "noticeWay": [
    {
      "type": "mail",
      "accounts": [
        {
          "countryCode": 0,
          "account": "123@qq.com"
        },
        {
          "countryCode": 0,
          "account": "123456@qq.com"
        }
      ]
    },
    {
      "type": "sms",
      "accounts": [
        {
          "countryCode": 86,
          "account": "18111111111"
        },
        {
          "countryCode": 86,
          "account": "18111111112"
        }
      ]
    }
  ]
}

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息

json

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

删除胁迫开门通知

请求链接: /lockNoticeSettingAccount/delete
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockNoticeSettingAccountId	int	Y	1	数据ID

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息

json

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

设置有人按门铃状态

请求链接: /lockSetting/updateLockNoticeSetting
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	500	锁ID
doorbellNoticeState	int	Y	0	开关：0/1

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息

json

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

设置有人出现在门口

请求链接: /lockSetting/updateLockNoticeSetting
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	500	锁ID
someoneAtDoorNoticeState	int	Y	0	开关：0/1

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息

json

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

获取锁消息设置

请求链接: /lockSetting/getLockNoticeSetting
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
lockId	int	Y	500	锁ID

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
dayNotOpenDoorState	Int	N天未开门状态
dayNotOpenDoorValue	Int	N天未开门天数
dayNotOpenDoorNoticeWayList	Array	N天未开门通知方式
doorNotCloseState	Int	门未关闭通知状态
tamperAlarmState	Int	防拆报警状态
lowElecNoticeState	Int	低电量通知状态
lowElecNoticeWayList	Array	低电量通知方式
coercionOpenDoorNoticeList	Array	胁迫开门通知列表
fingerprintId	Int	指纹ID
doorbellNoticeState	Int	有人按门铃通知状态
someoneAtDoorNoticeState	Int	有人出现在门口通知状态

json

{
  "dayNotOpenDoorState": 0,
  "dayNotOpenDoorValue": 1,
  "dayNotOpenDoorNoticeWayList": [],
  "doorNotCloseState": 0,
  "tamperAlarmState": 0,
  "lowElecNoticeState": 1,
  "lowElecNoticeWayList": [
    {
      "type": "mail",
      "accounts": [
        "123@qq.com",
        "1234@qq.com"
      ]
    },
    {
      "type": "sms",
      "accounts": [
        {
          "countryCode": 86,
          "account": "18111111111"
        },
        {
          "countryCode": 86,
          "account": "18111111112"
        }
      ]
    }
  ],
  "coercionOpenDoorNoticeList": [
    {
      "fingerprintId": 10921,
      "noticeWay": [
        {
          "type": "mail",
          "accounts": [
            "123@qq.com",
            "1234@qq.com"
          ]
        },
        {
          "type": "sms",
          "accounts": [
            {
              "countryCode": 86,
              "account": "18111111111"
            },
            {
              "countryCode": 86,
              "account": "18111111112"
            }
          ]
        }
      ]
    }
  ],
  "doorbellNoticeState": 0,
  "someoneAtDoorNoticeState": 0
}

锁-消息通知 ​

开门通知列表 ​

添加开门通知 ​

更新开门通知 ​

删除开门通知 ​

设置N天未开门 ​

设置门未关好 ​

设置防拆报警通知 ​

设置低电量提醒 ​

胁迫开门通知列表 ​

添加胁迫开门通知 ​

更新胁迫开门通知 ​

删除胁迫开门通知 ​

设置有人按门铃状态 ​

设置有人出现在门口 ​

获取锁消息设置 ​

锁-消息通知

开门通知列表

添加开门通知

更新开门通知

删除开门通知

设置N天未开门

设置门未关好

设置防拆报警通知

设置低电量提醒

胁迫开门通知列表

添加胁迫开门通知

更新胁迫开门通知

删除胁迫开门通知

设置有人按门铃状态

设置有人出现在门口

获取锁消息设置