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

Wi-Fi 门锁接口

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

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

获取成员个数信息

名称

tuya.m.device.member.count

版本

1.0

参数

名称 类型 说明 是否可选
devId String 设备编号 否

请求示例

{
 "devId" : "25230882b4e62d61b52a"
}

返回示例

{
    "result":{
        "familyUser":10,
        "panelUser":20
    },
    "t":1573024513335,
    "success":true,
    "status":"ok"
}

获取家庭成员列表

名称

tuya.m.device.member.list

版本

2.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否

返回参数

名称 类型 说明
userId String 成员编号
avatarUrl String 头像地址
userContact String 联系方式
unlockList String[] 成员拥有的解锁方式列表
userType String 用户类型 10. 管理员 20.普通成员. 30. 没有名字的成员
nickName String 用户昵称

请求示例

{
 "devId" : "25230882b4e62d61b52a"
}

返回示例

{
    "result":"1",
    "t":1573024513335,
    "success":{
        "userId":"12",
        "avatarUrl":"",
        "userContact":"86-13757150532",
        "unlockList":[
            "指纹1",
            "指纹2",
            "密码-1"
        ]
    },
    "status":"ok"
}

获取面板成员列表

名称

tuya.m.device.member.panel.list

版本

2.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
offset Integer 起始序号 否
limit Integer 每次请求的人员个数 否

返回参数

名称 类型 说明
userId String 成员编号
avatarUrl String 头像地址
userContact String 联系方式
unlockList 数组 成员拥有的解锁方式列表
userType String 用户类型 10. 管理员 20.普通成员. 30. 没有名字的成员
nickName String 用户昵称

请求示例

{
 "devId" : "25230882b4e62d61b52a",
 "offset" : 0,
 "linit": 50,
}

返回示例

{
    "result":"1",
    "t":1573024513335,
    "success":{
        "userId":"12",
        "avatarUrl":"",
        "userContact":"86-13757150532",
        "unlockList":[
            "指纹1",
            "指纹2",
            "密码-1"
        ]
    },
    "status":"ok"
}

用户添加

名称

m.smart.scale.history.user.add

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
name String 用户名称 否
avatar String 用户头像(没有传空) 否
sex String 性别(传空) 否
birthday String 生日(0) 否
height Integer 身高 否

请求示例

{
 "devId" : "25230882b4e62d61b52a",
 "name" : '涂小鸦',
 "avatar": '',
 "sex": '',
 "birthday": '',
 "height": 0
}

返回示例

{
  "result" : {
    "userId" : "0000000aip"
  },
  "t" : 1573612927418,
  "success" : true,
  "status" : "ok"
}

移除用户

名称

m.smart.scale.history.user.delete

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
userId String 用户编号 否

请求示例

{
 "devId" : "25230882b4e62d61b52a",
 "userId" : 9906',
}

返回示例

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

添加解锁方式

名称

tuya.m.device.member.opmode.add

版本

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"
}

解锁方式移除

名称

m.smart.scale.user.unlock.remove

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
unlockId String 解锁编号 否

请求示例

{
 "devId" : "25230882b4e62d61b52a",
 "unlockId" : '1-2',
}

返回示例

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

获取用户详情接口

名称

tuya.m.device.member.detail

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
userId String 用户编号 否

返回参数

名称 类型 说明
userId String 成员编号
avatarUrl String 头像地址
userContact String 联系方式
userType String 用户类型 10. 管理员 20.普通成员. 30. 没有名字的成员
nickName String 用户昵称
unlockDetail UnLockDetail[] 成员拥有的解锁方式列表

请求示例

{
 "devId" : "25230882b4e62d61b52a",
 "unlockId" : '1-2',
}

返回示例

{
  "result":"1",
  "t":1573024513335,
  "success":{
    "userId":"12",
    "avatarUrl":"",
    "userContact":"86-13757150532",
    "unlockDetail":[
        {
          "dpId":12,
          "unlockList":[
            {
                "devId":"vedoa12300",
                "unlockId":"12-2",
                "unlockName":"12-2",
                "unlockAttr":1,
                "opModeId":1,
            },
            {
                "devId":"vedoa12300",
                "unlockId":"12-3",
                "unlockName":"12-3",
                "unlockAttr":0,
                "opModeId":2,
            }
          ]
        },
        {
            "dpId":"13",
            "unlockList":[
              {
                "devId":"vedoa12300",
                "unlockId":"13-3",
                "unlockName":"13-3",
                "unlockAttr":0,
                "opModeId":9,
              }
            ]
        }
    ]
  },
  "status":"ok"
}

修改解锁方式名称

名称

tuya.m.device.member.opmode.update

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
opmodeId String 解锁方式序号,添加时返回的opModeId 否
unlockName String 开门方式的名称 否

请求示例

{
 "devId" : "25230882b4e62d61b52a",
 "opmodeId" : '47958',
 "unlockName" : '涂小鸦',
}

返回示例

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

防劫持设置

名称

tuya.m.scale.hijacking.add.config

版本

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"
}

防劫持移除

名称

tuya.m.scale.hijacking.remove.config

版本

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"
}

判断是否有需要分配的开锁方式

名称

tuya.m.device.unlock.assignlist

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否

请求示例

[
  {
    "opmode":"1",
    "unlockInfo":[{
        "unlockId":"1-01",
        "unlockName":"指纹1"
    }]
  },
  {
    "opmode":"2",
    "unlockInfo":[{
        "unlockId":"2-01",
        "unlockName":"密码1"
    }]
  },
  {
    "opmode":"3",
    "unlockInfo":[{
        "unlockId":"3-01",
        "unlockName":"门卡1"
    }]
  }
]
3. 开锁方式分配

返回示例

{
  
}

查询需要分配的开锁方式列表

名称

tuya.m.device.unlock.waitassign

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否

请求示例

{
  "devId": "vedosoeerjfneweinqw"
}

返回示例

{
  "result": true,  //true 有待分配的， false: 没有待分配的
  "t": 1550562572623,
  "success": true,
  "status": "ok"
}

开锁方式分配

名称

tuya.m.device.user.unlock.allocate

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
userId String 用户编号 否
unlockId String 开锁方式编号 否

请求示例

{
  "devId" : "6cc1483v89yz1t8o",
  "userId" : "3765529",
  "unlockIds" : ["101-01","101-02"]
}

返回示例

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

开门记录分配

名称

tuya.m.device.user.unlock.bind

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
userId String 用户编号 否
unlockId String 解锁编号 否

请求示例

{
  "devId" : "6cc1483v89yz1t8o",
  "userId" : "3765529",
  "unlockIds" : ["1-1","2-2"]
}

返回示例

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

获取配网到现在有多少天

名称

tuya.m.device.lock.active.period

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否

请求示例

{
  "devId" : "6cc1483v89yz1t8o",
}

返回示例

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

未读记录数接口

名称

tuya.m.device.lock.alarm.unread

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否

请求示例

{
  "devId" : "6cc1483v89yz1t8o",
}

返回示例

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

开门记录

名称

tuya.m.scale.history.list

版本

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
}

报警记录

名称

tuya.m.device.lock.alarm.list

版本

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
}

获取在线临时密码列表

名称

tuya.m.device.lock.temppwd.list

版本

2.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否

请求示例

{
  "devId" : "6cc1483v89yz1t8o",
}

返回参数

名称 类型 说明
name String 密码名称
effective int 密码状态 1. 待生效 2。 待下发 3. 使用中 4. 待删除 5. 已过期
scheduleDetails String 定时数据json格式字符串
phone String 电话
effectiveTime Long 生效时间
invalidTime Long 失效时间
availTime Integer 可用次数 0、永久，1、一次性
sn int 密码序号

返回示例

{
    "result": [{
       "effective": 3,
        "effectiveTime": 111,
        "id": 11,
        "invalidTime": 333,
        "name": "name",
        "phone": "phone",
        "scheduleDetails": [{ //返回参数新增shcedule列表
            "allDay": true,
            "effectiveTime": 720,
            "invalidTime": 1080,
            "workingDay": 8 //星期用一个字节来表示，bit0 ~ bit6 分别代表周日~周六
        }],
        "sn": 123
    }],
     "t": 1550562572623,
     "success": true,
     "status": "ok"
}

添加在线临时密码列表

名称

tuya.m.device.lock.temppwd.create

版本

4.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
password String 临时密码 否
schedule int 定时数据json格式字符串 是
phone String 电话 是
effectiveTime Long 生效时间 否
invalidTime Long 失效时间 否
name String 密码名称 否
availTime Integer 可用次数 0、永久，1、一次性 否
countryCode int 密码序号 是

请求示例

{
  "devId" : "vdevo158313195425051"
  "countryCode" : "86",
  "availTime" : 1,
  "invalidTime" : 1588133004,
  "name" : "沽湖时区验证4.0",
  "effectiveTime" : 1588132904,
  "schedule":"",
  "phone" : "15158064461",
  "password" : "2E478FEBBDBE029F9B091FDC9E5CB8F9",
}

schedule参数格式实例
[{

"allDay": true, //是否全天
"effectiveTime": 720, //生效时间
"invalidTime": 1080, //失效时间
"workingDay":   //星期用一个字节来表示，bit0 ~ bit6 分别代表周日~周六

}, {

"allDay": true,
"effectiveTime": 720,
"invalidTime": 1080,
"workingDay": 3

}]
返回示例

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

更新临时密码名称

名称

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

版本

2.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
pwdId Integer 解锁方式id 是
name String 名称 是

请求示例

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

返回示例

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

删除在线临时密码列表

名称

tuya.m.device.lock.temppwd.del

版本

2.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
id String 密码流水号 否

请求示例

{
  "devId" : "6cc1483v89yz1t8o",
  "id" : 2,
}

返回示例

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

判断当前类型的密码是否可以继续获取

名称

tuya.m.device.lock.offlinepwd.available

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
pwdType String 0.多次使用的密码 1.单次使用的密码 8. 删除单个的密码 9.清空码 否

请求示例

{
  "devId" : "002000015ccf7f0f3c7d"
  "pwdType" : "0"
}

返回示例

{
  "result" : "false",//是否可以继续获取
  "t" : 1565874044056,
  "success" : true,
  "status" : "ok"
}

添加离线临时密码

名称

tuya.m.device.lock.offlinepwd.get

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
pwdType 字符 密码类型 0.多次使用的密码 1. 单次使用的密码 9. 清空码 否
gmtStart 数值 开始时间(非多次密码暂时传0) 否
gmtExpired 数值 结束时间(非多次密码暂时传0) 否
pwdName 字符 密码名称 是
countryCode 字符 国家码 是
mobile 字符 手机号 是

请求示例

{
  "devId" : "002000015ccf7f0f3c7d"
  "pwdType" : "1"
  "gmtStart" : "1568001081"
  "gmtExpired" : "1578001081"
}

返回示例

{
  "result" : {pwd:"1234567890",pwdId: "3234"},//离线临时密码
  "t" : 1565874044056,
  "success" : true,
  "status" : "ok"
}

获取离线临时密码列表

名称

tuya.m.device.lock.offlinepwd.list

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
pwdType String 密码类型 0.多次使用的密码 1. 单次使用的密码 9. 清空码 否
offset Integer 起始序号 否
limit Integer 每次请求的人员个数 否

请求示例

{
  "devId" : "002000015ccf7f0f3c7d"
  "pwdType" : "1"
}

返回示例

{
  "result" : [{
  pwdId: 123123,
  pwdName: "密码名称1",
  gmtStart:"1565874044",
   gmtExpired:"1575874044"
   status: 1,   //密码状态 1.已下发，生效中 2. 下发成功  3.已失效
  },{
    pwdId: 23456,
    pwdName: "密码名称2",
  gmtStart:"1565874044",
    gmtExpired:"1575874044"
  }],
  "t" : 1565874044056,
  "success" : true,
  "status" : "ok"
}

设置某个离线密码的名称

名称

tuya.m.device.lock.offlinepwd.bind

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
pwdId Integer 密码序号 否
pwdName String 密码名称 否
mobile String 手机号 否

请求示例

{
  "devId" : "6c67bdf59cc478a024yakz",
  "pwdId" : 15002,
  "pwdName" : "绑定名称",
  "mobile" : "13757150532"
}

返回示例

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

获取某个离线临时密码的删除密码(仅限多次使用的密码)

名称

tuya.m.device.lock.offlinepwd.revoke

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否
pwdId Integer 密码序号 否

请求示例

{
  "devId" : "002000015ccf7f0f3c7d"
  "pwdId" : "1"
}

返回示例

{
  "result" : "1234567890", // 离线删除密码
  "t" : 1565874044056,
  "success" : true,
  "status" : "ok"
}

获取可分配的离线不限次数密码

名称

tuya.m.device.lock.offlinepwd.revocable

版本

1.0

请求参数

名称 类型 说明 是否可选
devId String 设备编号 否

请求示例

{
  "devId" : "002000015ccf7f0f3c7d"
}

返回示例


{
  "result" : [{
    pwdId: 012123123,
    pwdName: "密码名称1",
    gmtStart:"1565874044",
    gmtExpired:"1575874044",
  },{
    pwdId: 083232389,
    pwdName: "多次密码1",
    gmtStart:"1565874044",
    gmtExpired:"1575874044"
  }],
  "t" : 1565874044056,
  "success" : true,
  "status" : "ok"
}
上一篇门锁接口
下一篇Zigbee 门锁接口
语言
简体中文
简体中文
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