Tuya.com
简体中文
English
注册
登录开发者平台
简体中文
English
注册
登录开发者平台
垂直品类面板 SDK
search
根据文档目录筛选
垂直品类面板 SDK门锁 SDK 开发门锁接口Zigbee 门锁接口

Zigbee 门锁接口

更新时间：2021-08-27 11:07:12下载pdf

说明： 接口请求方法请使用 TYSdk.apiRequest。

手势密码设置

API 名称

tuya.m.device.lock.gesturepwd.set

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
devId String 设备编号 否
open Boolean 是否开启 否
password String 密码 是

返回参数

名称 类型 描述
AtopResult Boolean 方法是否执行成功

请求示例

{
 "devId" : "25230882b4e62d61b52a",
 "open" : true,
}

验证用户输入的手势密码

API 名称

tuya.m.device.lock.gesturepwd.validate
验证用户输入的手势密码，每次输错，云端会记录试错次数，超出可尝试次数会锁定密码。

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
devId String 设备编号 否
password String 密码 否

返回参数

名称 类型 描述
devId String 设备编号
uid String 创建人 uid
password String 密码
password Integer 密码类型(1：手势密码 2：数字密码)
status Boolean 是否有效
checkResult Boolean 手势密码验证结果
spareTime Integer 还可以尝试的次数（最大为 5 次）

请求示例

{
 "devId" : "25230882b4e62d61b52a",
 "password" : "123456",
}

返回示例

{
    "result": {
      "devId":"123",
      "uid":"111",
      "password":"123456",
      "status":true,
      "checkResult":false,
      "spareTime":4
    }
}

获取发送验证码的目标账户

API 名称

tuya.m.device.user.account.get

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
devId String 设备编号 否

请求示例

{
  "devId" : "25230882b4e62d61b52a",
}

返回示例

{
  "result" : {
    "account":"13577778888",
    "countryCode":"86"
  },
  "t" : 1573612927418,
  "success" : true,
  "status" : "ok"
}

发送验证码

API 名称

tuya.m.device.user.verifycode.send
发送验证码。发送验证码到目标账户。

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
account String 用户账户 否

请求示例

{
 "account" : "hzj@qq.com",
}

发送验证码–校验验证码

API 名称

tuya.m.device.user.verifycode.check

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
account String 用户账户 否
code String 验证码 否

请求示例

{
  "account" : "hzj@qq.com",
  "code" : "123456",
}

获取家庭成员列表

API 名称

tuya.m.zigbee.member.list

API 版本

1.0

删除无效临时开锁方式

API 名称

tuya.m.device.lock.zigbee.temppwdList.remove

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
devId String 设备编号 否

请求示例

{
 "devId" : "25230882b4e62d61b52a",
}

返回示例

{
  "result": true,
  "t": 1550562572623,
  "success": true,
  "status": "ok"
}

防劫持设置

API 名称

tuya.m.scale.hijacking.add.config

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
devId String 设备编号 否
dpId Integer unlockId 的前半部分 否
dpValue Integer unlockId 的后半部分 否

请求示例

{
  "devId" : "25230882b4e62d61b52a",
  "dpValue":"1-1",
  "dpId":"1"
}

返回示例

{
  "result":true,
  "t":1573024513335,
  "success":true,
  "status":"ok"
}

防劫持移除

API 名称

tuya.m.scale.hijacking.remove.config

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
devId String 设备编号 否
dpId Integer unlockId 的前半部分 否
dpValue Integer unlockId 的后半部分 否

请求示例

{
  "devId" : "25230882b4e62d61b52a",
  "dpValue":"1-1",
  "dpId":"1"
}

返回示例

{
  "result":true,
  "t":1573024513335,
  "success":true,
  "status":"ok"
}

创建周期性临时密码

说明： 新版本供家用门锁 PRO 家用门锁新公版使用。

API 名称

tuya.m.device.zigbee.newTempPwd.create

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
devId String 设备编号 否
name String 名称 否
effectiveTime String 生效时间 否
invalidTime String 失效时间 否
password String 密码 否
schedule String 定时配置 是
countryCode String 国家码 是
phone String 手机号 是
oneTime Integer 是否一次性密码(0 否 1 是) 否
sendMsg Integer 是否发送短信(0 否 1 是) 否

请求示例

{
  "devId": "vedosoeerjfneweinqw",
  "name" : "涂小鸦",
  "password" : "123456",
  "phone" : "12345678901",
  "countryCode" : "86",
  "effectiveTime" : "1601519817000",
  "invalidTime" : "160161817000",
}

返回示例

{
  "result": "resultDO": {
		"deliveryStatus": 1,
		"devId": "123",
		"id": 111,
		"name": "testLock",
		"oneTime": 1,
		"operate": 124,
		"password": "123456",
		"phase": 1,
		"phone": "86-13575791025",
		"scheduleList": [{
			"allDay": false,
			"effectiveTime": 967,
			"invalidTime": 1270,
			"timeZoneId": "",
			"workingDay": 81
		}],
		"sendMsg": 1,
		"status": true,
		"timeZone": "",
		"tyNumber": 998,
		"uid": "0"
	},
	"success": true
}

创建周期性临时密码

说明： 旧版本仅供公寓锁及家用门锁老公版使用。

API 名称

tuya.m.zigbee.lock.temppwd.create

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
devId String 设备编号 否
name String 名称 否
phone String 手机号 是
effectiveTime String 生效时间 否
invalidTime String 失效时间 否
password String 密码 否
oneTime Integer 是否一次性密码(0 否 1 是) 否
createLimit Integer 如果有自定义的密码数量限制，可以填下这个规则，后面创建密码数量不会超过这个数字 是

请求示例

{
  "devId": "6c4ff4cbc8022cabe134rq",
  "password": "95657EE8B6EEF10E035642F017A79B60",
  "phone": "12345678901",
  "effectiveTime": "1622179887",
  "name": "768163",
  "invalidTime": "1622262687",
  "oneTime": "0",
  "createLimit": 0
}

返回示例

{
  "result": true,
  "t": 1622179903124,
  "success": true,
  "status": "ok"
}
}

查看临时密码列表

说明： 旧版本仅供公寓锁及家用门锁老公版使用。

API 名称

tuya.m.zigbee.lock.temppwd.list

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
devId String 设备编号 否

返回参数

名称 类型 描述
id Long 主键 ID
mobile String 手机号
name String 名称
effectiveTime String 生效时间
invalidTime String 失效时间
password String 密码
deliveryStatus Integer 投递具体状态 1 待确认 2 确认成功 3 确认失败 4 重复密码 5 密码已满 6 有效期重叠
effective Integer 有效性 1.待生效、2.生效中、3.即将过期、4.已过期
oneTime Integer 是否一次性密码(0 否 1 是)
phase Integer 删除状态 2 正常 3 已冻结 4 已删除 5 创建失败
gmtCreate Integer 创建时间（13 位毫秒）

请求示例

{
 "devId" : "25230882b4e62d61b52a",
 "useful" : true,
 "offset" : 0,
 "limit" : 50,
}

返回示例

{
	"result": [{
		"phase": 2,
		"effective": 3,
		"effectiveTime": 1622002358,
		"mobile": "",
		"name": "民咕咕",
		"canDelete": false,
		"invalidTime": 1622009558,
		"id": 4233107,
		"gmtCreate": 1622002396400,
		"oneTime": 0,
		"deliveryStatus": 1
	}, {
		"phase": 2,
		"effective": 2,
		"effectiveTime": 1622001863,
		"mobile": "",
		"name": "许建臣",
		"canDelete": false,
		"invalidTime": 1653537863,
		"id": 4233106,
		"gmtCreate": 1622001890431,
		"oneTime": 0,
		"deliveryStatus": 2
	}],
	"t": 1622002537414,
	"success": true,
	"status": "ok"
}

展示一次性临时密码和周期性临时密码的列表

说明： 新版本供家用门锁 PRO 家用门锁新公版使用。

API 名称

tuya.m.device.lock.temppwd.pagelist

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
devId String 设备编号 否
useful Boolean 是否有效 否
offset Integer 偏移量 否
limit Integer 记录数 否

请求示例

{
 "devId" : "25230882b4e62d61b52a",
 "useful" : true,
 "offset" : 0,
 "limit" : 50,
}

返回示例

{
  "resultDO": {
		"datas": [{
			"deliveryStatus": 1,
			"devId": "123",
			"id": 111,
			"name": "testLock",
			"oneTime": 1,
			"operate": 124,
			"password": "123456",
			"phase": 1,
			"phone": "86-13575791025",
			"scheduleList": [{
				"allDay": false,
				"effectiveTime": 967,
				"invalidTime": 1270,
				"timeZoneId": "",
				"workingDay": 81
			}],
			"sendMsg": 1,
			"status": true,
			"timeZone": "",
			"tyNumber": 998,
			"uid": "0"
		}],
		"hasNext": false,
		"totalCount": 0
	},
	"success": true
}

更新周期性临时密码

API 名称

tuya.m.device.zigbee.newTempPwd.update

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
id Long 用户编号 否
devId String 设备编号 否
name String 名称 否
effectiveTime String 生效时间 否
invalidTime String 失效时间 否
password String 密码 否
schedule String 定时配置 是
countryCode String 国家码 是
phone String 手机号 是
oneTime Integer 是否一次性密码(0 否 1 是) 否
sendMsg Integer 是否发送短信(0 否 1 是) 否
operate Integer 125 删除 126 修改 否

请求示例

{
  "id": 1,
  "devId": "vedosoeerjfneweinqw",
  "name" : "涂小鸦",
  "password" : "123456",
  "phone" : "12345678901",
  "countryCode" : "86",
  "effectiveTime" : "1601519817000",
  "invalidTime" : "160161817000",
}

返回示例

{
  "result": "resultDO": {
		"deliveryStatus": 1,
		"devId": "123",
		"id": 111,
		"name": "testLock",
		"oneTime": 1,
		"operate": 124,
		"password": "123456",
		"phase": 1,
		"phone": "86-13575791025",
		"scheduleList": [{
			"allDay": false,
			"effectiveTime": 967,
			"invalidTime": 1270,
			"timeZoneId": "",
			"workingDay": 81
		}],
		"sendMsg": 1,
		"status": true,
		"timeZone": "",
		"tyNumber": 998,
		"uid": "0"
	},
	"success": true
}

临时开锁方式修改、冻结、解冻接口

说明： 旧版本仅供公寓锁及家用门锁老公版使用。

API 名称

tuya.m.zigbee.lock.temppwd.update

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
id Long 用户编号 否
devId String 设备编号 否
operate Integer 操作类型(125 删除、126 修改、127 冻结、128 解冻) 否
name String 名称 否
effectiveTime String 生效时间 否
invalidTime String 失效时间 否
password String 密码 否
phone String 手机号 否
oneTime Integer 是否一次性密码(0 否 1 是) 否

请求示例

{
  "id": 1,
  "devId": "vedosoeerjfneweinqw",
  "name" : "涂小鸦",
  "password" : "123456",
  "operate" : 127,
  "phone" : "12345678901",
  "countryCode" : "86",
  "effectiveTime" : "1601519817000",
  "invalidTime" : "160161817000",
}

返回示例

{
  "result": true,
  "t": 1573024513335,
  "success": true,
  "status": "ok"
}

修改一次性密码的名称

API 名称

tuya.m.device.lock.temppwd.name.update

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
pwdId Long 密码主键 否
name String 密码名称 否
devId String 设备编号 否

请求示例

{
  "devId" : "25230882b4e62d61b52a",
  "name": "名称",
  "pwdId": 11
}

更新临时密码名称

API 名称

tuya.m.device.lock.temppwd.name.update

API 版本

2.0

请求参数

名称 类型 描述 参数是否可选
devId String 设备编号 否
pwdId Integer 解锁方式 id 是
name String 名称 是

请求示例

{
  "devId" : "6cc1483v89yz1t8o",
  "pwdId" : 123123,
  "name" : '涂小鸦',
}

返回示例

{
    "result":true,
    "t":1573024513335,
    "success":true,
    "status":"ok"
}

临时密码短信重发

API 名称

tuya.m.device.zigbee.sms.resend

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
id Long 编号 否

请求示例

{
  "devId" : "6cc1483v89yz1t8o",
}

返回示例

{
  "result": true,  //只有true的时候代表分配成功
  "t": 1550562572623,
  "success": true,
  "status": "ok"
}

报警记录

API 名称

tuya.m.device.lock.alarm.list

API 版本

1.0

请求参数

名称 类型 描述 参数是否可选
devId String 设备编号 否
dpIds Integer dp 点 否
offset Integer 起始记录数 否
limit Integer 每页记录数 否

请求示例

{
  "devId" : "6cc1483v89yz1t8o",
  "dpIds" : [1,2,3,4],
  "offset" : 0,
  "limit" : 50,
}

返回示例

{
  "datas":[
    {
      "devId":"7381641184f3eb715317",
      "dps":[
        {
          "56":"1-2"
        }
      ],
      "avatar":"https://images.tuyacn.com/smart/user_res/avatar/scale/no_body_icon.png",
      "userName":"云端",
      "gmtCreate":1567079971000,
      "uuid":"156707000591403D659FAA1D8F951049B2001C9971000",
      "userId":"0",
      "tags":0,
      "status":1
    }
  ],
  "hasNext":true,
  "totalCount":43
}

开门记录

API 名称

tuya.m.scale.history.list

API 版本

2.0

请求参数

名称 类型 描述 参数是否可选
devId String 设备编号 否
dpIds Integer dp 点 否
offset Integer 起始记录数 否
limit Integer 每页记录数 否
startTime Integer 开始时间 否
endTime Integer 结束时间 否

请求示例

{
  "devId" : "6cc1483v89yz1t8o",
  "dpIds" : [1,2,3,4],
  "offset" : 0,
  "limit" : 50,
  "startTime" : '',
  "endTime" : '',
}

返回示例

{
  "datas":[
    {
      "devId":"7381641184f3eb715317",
      "dps":[
        {
          "4":"0"
        }
      ],
      "avatar":"https://images.tuyacn.com/smart/user_res/avatar/scale/no_body_icon.png",
      "userName":"云端",
      "unlockName":"解锁方式名称"
      "gmtCreate":1567079971000,
      "uuid":"156707000591403D659FAA1D8F951049B2001C9971000",
      "userId":"0",
      "tags":0,
      "status":1
    }
  ],
  "hasNext":true,
  "totalCount":43
}

添加解锁方式

API 名称

tuya.m.device.member.opmode.add

API 版本

2.0

请求参数

名称 类型 描述 参数是否可选
devId String 设备编号 否
userId String 用户编号 否
unlockId String 解锁编号 否
unlockName String 解锁方式名称 否

请求示例

{
  "devId" : "25230882b4e62d61b52a",
  "userId" : '9906',
  "unlockId" : '1-2',
  "unlockName" : '指纹02',
}

返回示例

{
    "result" : {
      "opModeId" : 47958,
      "unlockName" : "密码40"
    },
    "t" : 1574503711145,
    "success" : true,
    "status" : "ok"
}
上一篇Wi-Fi 门锁接口
下一篇蓝牙门锁接口
语言
简体中文
简体中文
English
400-881-8611
7×24小时服务热线
市场合作
marketing@tuya.com
业务合作
service@tuya.com
媒体联络
pr@tuya.com
关注“涂鸦智能”
涂鸦服务尽在掌握
关注“全球智能商业”
第一时间获取物联网资讯
联系我们加入我们Tuya ExpoApp 商城TuyaGoTuyaGo服务商查询
法律声明隐私协议加州隐私权利声明服务条款廉正合规安全应急响应中心
©2014-2024 杭州涂鸦信息技术有限公司 版权
浙ICP备14011795号
浙B2-20210233号
浙公网安备33010602004238号
简体中文
简体中文
English