简体中文
简体中文
English
联系我们
注册
登录

成员管理

更新时间:2022-03-29 09:04:36下载pdf

设备成员管理

获取家庭用户和解锁方式的信息列表

支持的门锁类型

  • 常保活 Wi-Fi
  • 可视对讲 Wi-Fi

接口地址

GET /v1.0/smart-lock/devices/{device_id}/users

请求参数

参数名 类型 参数类型 说明 是否必填
device_id String URI 设备 ID
codes String URL 解锁方式, 多个的话以逗号分隔
  • unlock_fingerprint:指纹
  • unlock_card:门卡
  • unlock_password:密码
  • unlock_face:人脸
  • unlock_hand:掌纹
  • unlock_finger_vein:指静脉
page_no int URI 当前页数(从1开始计数)
page_size int URI 每页数据量

请求示例

GET /v1.0/smart-lock/devices/vdevo12454656****/users
{
    "codes":"unlock_fingerprint,unlock_password",
    "page_no":1,
    "page_size":100
}

返回参数

参数名 类型 说明
code Integer 返回的错误码,成功时为空,详情⻅返回的错误码
success Boolean 是否成功
true:成功
false:失败
t Long 响应时间
msg String 请求失败的信息,成功为空
result Object 用户数据列表

result

参数名 类型 说明
user_id Long 用户在家庭里的编号
avatar_url String 家庭用户头像地址
user_contact String 联系方式
unlock_detail json array 解锁方式详情
user_type int 用户类型
  • 10:管理员
  • 20:普通成员
  • 50:家庭主人
nick_name String 用户昵称
lock_user_id int 用户在锁上的编号
back_home_notify_attr int 家人到家提醒 开关是否打开
  • 1:是
  • 0:否
effective_flag int 当前用户是否在有效期内
  • 1:是
  • 0:否
time_schedule_info json array 用户时效信息
uid String 用户uid

unlock_detail

参数名 类型 说明
dp_code String 解锁方式
  • unlock_fingerprint:指纹
  • unlock_card:门卡
  • unlock_password:密码
  • unlock_face:人脸
  • unlock_hand:掌纹
  • unlock_finger_vein:指静脉
count int 当前解锁方式的数量
unlock_list json array 解锁方式信息列表

unlock_list

参数名 类型 说明
unlock_id String 解锁方式云端编号
unlock_sn int 解锁方式在门锁上的编号
unlock_name String 解锁方式名称
unlock_attr int 解锁方式属性,
  • 1:带劫持
op_mode_id int 解锁方式云端序号
photo_unlock bool 是否带开门抓拍功能(仅带抓拍功能的 Wi-Fi 门锁支持)
admin bool 是否是门锁上的管理员解锁方式(通过解锁方式同步或者管理员解锁方式上报功能通知云端)

time_schedule_info

参数名 类型 说明
permanent bool 是否永久,true 为永久
effective_time String 生效时间. 单位是秒
expired_time String 失效时间. 单位是秒
operate String 最近的操作
  • ADD:新增
  • MODIFY:修改
  • DELETE:删除
schedule_details json array 时效周期性信息

schedule_details

参数名 类型 说明
start_minute int 当天开始时间,单位分钟,最大值 1440
end_minute int 当天过期时间,单位分钟, 最大值 1440
working_day Int 星期, 每个值累加:
  • 1:星期天
  • 2:星期一
  • 4:星期二
  • 8:星期三
  • 16:星期四
  • 32:星期五
  • 64:星期六
time_zone_id String 时区

请求成功返回示例

{
  "result": {
    "has_more": false,
    "records": [
      {
        "avatar_url": "https://****",
        "back_home_notify_attr": 0,
        "effective_flag": 1,
        "lock_user_id": 5,
        "nick_name": "测试1",
        "time_schedule_info": {
          "delivery_status": "SUCCESS",
          "effective_time": 1628179200,
          "expired_time": 1638806399,
          "operate": "MODIFY",
          "permanent": false,
          "schedule_details": [
            {
              "all_day": false,
              "start_minute": 60,
              "end_minute": 480,
              "working_day": 97
            }
          ]
        },
        "uid": "ay1541490670142A1Dti",
        "unlock_detail": [],
        "user_contact": "86-13757150532",
        "user_id": "38823920",
        "user_type": 10
      }
    ],
    "total": 18,
    "total_pages": 1
  },
  "success": true,
  "t": 1628241725953
}

请求失败返回示例

{
    "success":false,
    "code":500, // 错误码,详细请见错误码文档
    "msg":"system error,please contact the admin"
}

更新用户时效

支持的门锁类型

  • 常保活 Wi-Fi
  • Wi-Fi 门禁

接口地址

PUT /v1.0/smart-lock/devices/{device_id}/users/{user_id}/schedule

请求参数

参数名 类型 参数类型 说明 是否必填
device_id String URI 设备 ID
user_id String URI 用户 ID
schedule json BODY 用户时效信息

schedule

参数名 类型 说明
permanent bool 是否永久,true 为永久
effective_time String 生效时间. 单位是秒
expired_time String 失效时间. 单位是秒
schedule_details json array 时效周期性信息

schedule_details

参数名 类型 说明
start_minute int 当天开始时间,单位分钟,最大值 1440
end_minute int 当天过期时间,单位分钟, 最大值 1440
working_day Int 星期, 每个值累加:
  • 1:星期天
  • 2:星期一
  • 4:星期二
  • 8:星期三
  • 16:星期四
  • 32:星期五
  • 64:星期六
time_zone_id String 时区

请求示例

PUT /v1.0/smart-lock/devices/vdevo12454656****/users/130**/schedule
{
  "scheduleDetails": [
    {
      "allDay": false,
      "start_minute": "420",
      "end_minute": "1438",
      "workingDay": 99
    }
  ],
  "effectiveTime": 1628179200,
  "expiredTime": 1640015999,
  "permanent": false
}

返回参数

参数名 类型 说明
code Integer 返回的错误码,成功时为空,详情⻅返回的错误码
success Boolean 是否成功
true:成功
false:失败
t Long 响应时间
msg String 请求失败的信息,成功为空
result Boolean 返回结果

请求成功返回示例

{
  "result": true,
  "success": true,
  "t": 1628241725953
}

请求失败返回示例

{
    "success":false,
    "code":500, // 错误码,详细请见错误码文档
    "msg":"system error,please contact the admin"
}

获取用户的解锁方式列表

支持的门锁类型

  • 可视对讲 Wi-Fi
  • Wi-Fi 门禁

接口地址

GET /v1.0/smart-lock/devices/{device_id}/opmodes/{user_id}

请求参数

参数名 类型 参数类型 说明 是否必填
device_id String URI 设备 ID
user_id String URI 用户 ID
codes String URL 目标的解锁方式的 Code, 多个以逗号隔开(可为空)
  • unlock_fingerprint:指纹
  • unlock_password:密码
  • unlock_card:门卡
  • unlock_face:人脸
  • unlock_hand:掌纹
  • unlock_finger_vein:指静脉
  • unlock_telecontrol_kit:遥控器
unlock_name String URL 目标解锁方式名称(可为空)
page_no Integer URL 当前页数(从1开始计数)
page_size Integer URL 每页数据量

请求示例

GET /v1.0/smart-lock/devices/6c982a30639b8f6338d3ox/opmodes/33970143?page_size=20&page_no=1&codes=unlock_fingerprint,unlock_password,unlock_card&unlock_name=

返回参数

参数名 类型 说明
code Integer 返回的错误码,成功时为空,详情⻅返回的错误码
success Boolean 是否成功
true:成功
false:失败
t Long 响应时间
msg String 请求失败的信息,成功为空
result Boolean 返回结果

result

参数名 类型 说明
user_name String 用户名称
user_id String 用户ID
user_type Integer 用户类型
  • 0-未知人员类型
  • 10-管理员
  • 20-普通家人
  • 40-分享用户
  • 50-超级管理员
lock_user_id Integer 用户在锁上的ID
unlock_name String 解锁方式名称
opmode_id String 当前解锁方式的主键ID
dp_code String 解锁方式的dpCode
unlock_sn String 解锁方式编号
phase Integer 状态
  • 1-已确认
  • 2- 待确认
  • 3-已冻结
  • 4- 待冻结
  • 5-待解冻
  • 6-待重置
  • 7-创建失败
  • 8-已删除
  • 9-待删除
  • 10-待创建
unlock_attr Integer 解锁方式属性 (1代表劫持属性)
notify_info String 通知方式,一个JSON格式字符串
allocate_flag Boolean 是否是从未分配的解锁方式分配给用户的(如果是的话是可以解绑的). 1-是, 0-否

notify_info

参数名 类型 说明
app_send Integer 是否app 通知. 0: 否;1:是 (微信公众号的话, 这里也是1)
msg_phone String 接受短信的手机号码
voice_phone String 接受语音电话的手机号码

请求成功返回示例

{
  "result":[
    {
        "phase":3,
        "dp_code":"unlock_password",
        "unlock_attr":0,
        "unlock_name":"lin",
        "user_name":"小苗",
        "user_id":"28873683",
        "unlock_sn":3,
        "uid":"ay1562298621752U9R5d",
        "unlock_id":"12-3",
        "operate":"CREATE",
        "lock_user_id":2,
        "opmode_id":"729548",
        "voice_attr":0,
        "user_time_set":"386cd30072bc9b7f000000000000000000",
        "user_type":20,
        "delivery_status":"SUCCESS",
      	"allocate_flag":0,
      	"notify_info":{
            "app_send":1
        }
    },
    {
        "phase":3,
        "dp_code":"unlock_password",
        "unlock_attr":0,
        "unlock_name":"lin-1",
        "user_name":"小苗",
        "user_id":"28873683",
        "unlock_sn":4,
        "uid":"ay1562298621752U9R5d",
        "unlock_id":"12-4",
        "operate":"CREATE",
        "lock_user_id":2,
        "opmode_id":"729549",
        "voice_attr":0,
        "user_time_set":"386cd30072bc9b7f000000000000000000",
        "user_type":20,
        "delivery_status":"SUCCESS",
        "allocate_flag":1,
      	"notify_info":{
            "app_send":0,
            "msg_phone":"86-15156789943"
        }
    }
]
  "sucess":ture,
  "t":1542626129429
}

请求失败返回示例

{
    "success":false,
    "code":500, // 错误码,详细请见错误码文档
    "msg":"system error,please contact the admin"
}

获取被移除的用户列表

支持的门锁类型

  • 可视对讲 WIFI

接口地址

GET /v1.0/devices/{device_id}/door-lock/absent-users

请求参数

参数名 类型 参数类型 说明 是否必填
device_id String URI 设备 ID

请求示例

GET /v1.0/devices/6c982a30639b8f6338d3ox/door-lock/absent-users

返回参数

参数名 类型 说明
code Integer 返回的错误码,成功时为空,详情⻅返回的错误码
success Boolean 是否成功
true:成功
false:失败
t Long 响应时间
msg String 请求失败的信息,成功为空
result Boolean 返回结果

result

参数名 类型 说明
user_id String 用户id
user_type Integer 用户类型
  • 50:超级管理员
  • 10:管理员
  • 20:普通成员
  • 40:分享成员
  • 0:未知用户
lock_user_id Integer 用户在锁上的编号

请求成功返回示例

{
  "result": [
{
      "user_id": "390981",
      "user_type": 10,
      "lock_user_id": 2
    }
],
  "success": true,
  "t": 1628241725953
}

请求失败返回示例

{
    "success":false,
    "code":500, // 错误码,详细请见错误码文档
    "msg":"system error,please contact the admin"
}

控制门锁设备删除用户

支持的门锁类型

  • 可视对讲 WIFI

接口地址

POST /v1.0/smart-lock/devices/{device_id}/users/{user_ids}/actions/delete-users-issue

请求参数

参数名 类型 参数类型 说明 是否必填
device_id String URI 设备 ID
user_ids String URI 用户 ID(多个用逗号分隔)

请求示例

POST /v1.0/smart-lock/devices/6c982a30639b8f6338****/users/xxx/actions/delete-users-issue

返回参数

参数名 类型 说明
code Integer 返回的错误码,成功时为空,详情⻅返回的错误码
success Boolean 是否成功
true:成功
false:失败
t Long 响应时间
msg String 请求失败的信息,成功为空
result Boolean 返回结果

请求成功返回示例

{
  "result": true,
  "success": true,
  "t": 1628241725953
}

请求失败返回示例

{
    "success":false,
    "code":500, // 错误码,详细请见错误码文档
    "msg":"system error,please contact the admin"
}

新增设备成员

支持的门锁类型

  • Wi-Fi 门锁
  • Zigbee 门锁
  • 蓝牙门锁

接口地址

POST /v1.0/devices/{device_id}/user

请求参数

参数名 参数类型 说明 是否必填
device_id String 设备 ID
nick_name String 用户名称
sex Integer 性别
1:男
2:女
birthday Long 出生年月日 否
height Integer 身高(cm)
weight Integer 体重(g)
contact String 联系方式

响应参数

名称 类型 说明
t Long 返回时间
success Boolean 是否成功
result Object 结果

result参数说明

名称 类型 说明
user_id String 添加的用户ID

修改设备成员

支持的门锁类型

  • Wi-Fi 门锁
  • Zigbee 门锁
  • 蓝牙门锁

接口地址

PUT /v1.0/devices/{device_id}/users/{user_id}

请求参数

参数名 参数类型 说明 是否必填
device_id String 设备 ID
user_id String 添加的用户ID
nick_name String 用户名称
sex Integer 性别
1:男
2:女
birthday Long 出生年月日 否
height Integer 身高(cm)
weight Integer 体重(g)

响应参数

名称 类型 说明
t Long 时间戳
success Boolean 是否成功
result Object 结果

更新设备用户的角色

支持的门锁类型

  • Wi-Fi 门禁

接口地址

PUT /v1.0/smart-lock/devices/{device_id}/users/{user_id}/actions/role

请求参数

参数名 类型 参数类型 说明 是否必须
device_id String URI 设备 ID
user_id String URI 用户 ID
role String BODY 新角色
  • admin:管理员
  • normal:普通成员

请求示例

PUT /v1.0/smart-lock/devices/6c5fa86feedc16f77d****/users/8923iu****/actions/role

{
    "role":"admin"
}

返回参数

参数名 类型 说明
code Integer 返回的错误码,成功时为空,详情⻅返回的错误码
success Boolean 是否成功。<ul
  • true:成功
  • false:失败
  • t Long 响应时间
    msg String 请求失败的信息,成功为空

    响应成功示例

    {
      "success": true,
      "t": 1614147303662
    }
    

    相应失败返回示例

    {
        "success": false,
        "code": 500, // 错误码,详细请见错误码文档
        "msg": "system error,please contact the admin"
    }
    

    删除设备成员

    支持的门锁类型

    • Wi-Fi 门锁
    • Zigbee 门锁
    • 蓝牙门锁

    接口地址

    DELETE /v1.0/devices/{device_id}/users/{user_id}
    

    请求参数

    参数名 参数类型 说明 是否必填
    device_id String 设备 ID
    user_id String 用户ID

    响应参数

    名称 类型 说明
    t Long 时间戳
    success Boolean 是否成功
    result Object 结果

    查询设备成员信息

    支持的门锁类型

    • Wi-Fi 门锁
    • Zigbee 门锁
    • 蓝牙门锁

    不支持查询管理员

    接口地址

    GET /v1.0/devices/{device_id}/users/{user_id}
    

    请求参数

    参数名 参数类型 说明 是否必填
    device_id String 设备 ID
    user_id String 用户ID

    响应参数

    参数名 参数类型 说明
    device_id String 设备 ID
    nick_name String 用户名称
    sex Integer 性别
    1:男
    2:女
    birthday Long 出生年月日
    height Integer 身高(cm)
    weight Integer 体重(g)
    contact String 联系方式

    查询设备成员信息(v1.1)

    该接口支持获取当前用户的信息,不支持查询管理员。

    支持的门锁类型

    • Wi-Fi 门禁

    接口地址

    GET /v1.1/devices/{device_id}/users/{user_id}
    

    请求参数

    参数名 类型 参数类型 说明 是否必须
    device_id String URI 设备 ID
    user_id String URI 用户 ID (如果查询当前用户,则需要传递 0 )

    请求示例

    GET /v1.1/devices/vdevo16232264458****/users/0
    

    返回参数

    参数名 类型 说明
    code Integer 返回的错误码,成功时为空,详情⻅返回的错误码
    success Boolean 是否成功。
    • true:成功
    • false:失败
    t Long 响应时间
    msg String 请求失败的信息,成功为空
    result Object 返回结果

    result说明

    参数名 类型 说明
    user_id String 用户 ID
    avatar_url String 头像地址
    user_contact String 联系方式
    user_type Integer 用户类型
    • 管理员:10
    • 普通成员:20
    • 家庭主人:50
    nick_name String 用户昵称
    lock_user_id Integer 用户在锁上的编号
    back_home_notify_attr Integer 是否打开 家人到家提醒 开关
    • 1:是
    • 0:否
    effective_flag Integer 是否有效的标签(所谓有效是指当前用户的时效是否未过期)
    • 1:是
    • 0:否
    time_schedule_info Object 用户时效信息
    uid String 用户 UID

    time_schedule_info说明

    参数名 类型 说明
    permanent Boolean 是否永久
    effective_time Long 生效时间,精确到秒
    expired_time Long 失效时间,精确到秒
    operate String 操作
    • ADD:新增
    • MODIFY:修改
    • DELETE:删除
    delivery_status String 设备对操作的反馈
    • ONGOING:下发中
    • SUCCESS:下发成功
    • FAILED:下发失败
    schedule_details List 时效周期性信息

    schedule_details说明

    参数名 类型 说明
    start_minute Long 生效时间,是个分钟数,比如 “07:30”,那么该值=7x60+30=450
    end_minute Long 失效时间,是个分钟数,比如 “17:30”,那么该值=17x60+30=1050
    working_day Integer 星期,每个值累加:
    • 1:星期天
    • 2:星期一
    • 4:星期二
    • 8:星期三
    • 16:星期四
    • 32:星期五
    • 64:星期六
    all_day Boolean 是否全天
    time_zone_id String 时区 ID,比如 Asia/Shanghai

    响应成功示例

    {
      "result": {
        "avatar_url": "https://thirdwx.qlogo.cn/mmopen/vi_32/y6E5GpvgQicwyxjCkJfpNcBo5Sd6wtmYbjHY6kzyibEn9yNicmGDZWrc0BxaaC2xFPibh5k9niaRMjGTEuNFZPFsP3g/132",
        "lock_user_id": 1,
        "nick_name": "长空",
        "user_contact": "",
        "user_id": "38028607",
        "user_type": 50
      },
      "success": true,
      "t": 1632448688665
    }
    

    响应失败返回示例

    {
        "success": false,
        "code": 500, // 错误码,详细请见错误码文档
        "msg": "system error,please contact the admin"
    }
    

    根据设备 ID 查询成员信息列表

    支持的门锁类型

    • Wi-Fi 门锁
    • Zigbee 门锁
    • 蓝牙门锁

    接口地址

    GET /v1.0/devices/{device_id}/users
    

    请求参数

    参数名 参数类型 说明 是否必填
    device_id String 设备 ID

    响应参数

    参数名 参数类型 说明
    device_id String 设备 ID
    nick_name String 用户名称
    sex Integer 性别
    • 1:男
    • 2:女
    birthday Long 出生年月日
    height Integer 身高(cm)
    weight Integer 体重(g)
    contact String 联系方式

    根据设备 ID查询成员信息列表-v1.1

    说明:相比 v1.0 版本, 该接口支持根据关键字及角色信息进行数据过滤。

    支持的门锁类型

    • Wi-Fi 门禁

    接口地址

    GET /v1.1/devices/{device_id}/users
    

    请求参数

    参数名 类型 参数类型 说明 是否必须
    device_id String URI 设备 ID
    keyword String QUERY 查询的关键字(目前只查询用户名称/账号,模糊匹配),当该值为空字符串则认为不参与过滤
    role String QUERY 角色(如果为空字符串则认为不参与过滤)
    • admin:管理员
    • normal:普通成员
    page_no Integer QUERY 当前页数(从 1 开始计数)
    page_size Integer QUERY 每页数据量

    请求示例

    GET /v1.1/devices/vdevo16232264458****/users?keyword=test&role=admin&page_no=1&page_size=10
    
    

    返回参数

    参数名 类型 说明
    code Integer 返回的错误码,成功时为空,详情⻅返回的错误码
    success Boolean 是否成功
  • true:成功
  • false:失败
  • t Long 响应时间
    msg String 请求失败的信息,成功为空
    result Object 返回结果

    result说明

    参数名 类型 说明
    has_more Boolean 是否还有更多数据
    total_pages Integer 总页数
    total Integer 数据总条数
    records List 分页数据

    records说明

    参数名 类型 说明
    user_id String 用户 ID
    avatar_url String 头像地址
    user_contact String 联系方式
    user_type Integer 用户类型
    • 管理员:10
    • 普通成员:20
    • 家庭主人:50
    nick_name String 用户昵称
    lock_user_id Integer 用户在锁上的编号
    back_home_notify_attr Integer 是否打开 家人到家提醒 开关
    • 1:是
    • 0:否
    effective_flag Integer 是否有效的标签(所谓有效是指当前用户的时效是否未过期)
    • 1:是
    • 0:否
    time_schedule_info Object 用户时效信息
    uid String 用户 UID

    time_schedule_info说明

    参数名 类型 说明
    permanent Boolean 是否永久
    effective_time Long 生效时间,精确到秒
    expired_time Long 失效时间,精确到秒
    operate String 操作
    • ADD:新增
    • MODIFY:修改
    • DELETE:删除
    delivery_status String 设备对操作的反馈
    • ONGOING:下发中
    • SUCCESS:下发成功
    • FAILED:下发失败
    schedule_details List 时效周期性信息

    schedule_details说明

    参数名 类型 说明
    start_minute Long 生效时间,是个分钟数,比如 “07:30”,那么该值=7x60+30=450
    end_minute Long 失效时间,是个分钟数,比如 “17:30”,那么该值=17x60+30=1050
    working_day Integer 星期,每个值累加:
    • 1:星期天
    • 2:星期一
    • 4:星期二
    • 8:星期三
    • 16:星期四
    • 32:星期五
    • 64:星期六
    all_day Boolean 是否全天
    time_zone_id String 时区 ID,比如 Asia/Shanghai

    响应成功示例

    {
      "result": {
        "has_more": true,
        "records": [
          {
            "avatar_url": "",
            "back_home_notify_attr": 0,
            "effective_flag": 1,
            "lock_user_id": 1,
            "nick_name": "Nicole",
            "time_schedule_info": {
              "permanent": true
            },
            "user_contact": "test@163.com",
            "user_id": "30665363",
            "user_type": 50,
            "uid": "ay1***6168*****VdmWA"
          }
        ],
        "total": 14,
        "total_pages": 14
      },
      "success": true,
      "t": 1624613523063
    }
    

    响应失败返回示例

    {
        "success": false,
        "code": 500, // 错误码,详细请见错误码文档
        "msg": "system error,please contact the admin"
    }
    

    分配门锁密码给设备成员

    支持的门锁类型

    • Wi-Fi 门锁
    • Zigbee 门锁
    • 蓝牙门锁

    请求地址

    POST /v1.0/devices/{device_id}/device-lock/users/{user_id}/allocate
    

    请求参数

    参数 类型 说明 是否必填
    device_id String 设备 ID
    user_id String 设备成员 ID
    no String 门锁编号
    type String 密码类型(fingerprint/password/card)

    响应参数

    参数 类型 说明
    result boolean 操作结果

    响应成功示例

    {
        "success": true,
        "t": 1571898808491,
        "result": true
    }
    

    将未分配的解锁方式分配给用户(支持同时分配多个)

    支持的门锁类型

    • Wi-Fi 门禁
    • 蓝牙门锁

    请求地址

    POST /v1.0/devices/{device_id}/door-lock/opmodes/actions/allocate
    

    请求参数

    参数 类型 参数类型 说明 是否必填
    device_id URI String 设备 ID
    user_id BODY String 用户 ID
    unlock_list BODY List 解锁方式列表

    unlock_list说明

    参数名 类型 说明 是否必填
    dp_code String 解锁方式的 dpCode
    unlock_sn Integer 解锁方式编号

    请求示例

    
    POST /v1.0/devices/vdevo16232264458****/door-lock/opmodes/actions/allocate
    
    {
      "user_id": "30665363",
      "unlock_list": [
        {
          "dp_code": "unlock_password",
          "unlock_sn": 2
        }
      ]
    }
    
    
    

    响应参数

    参数 类型 说明
    result boolean 操作结果

    响应成功示例

    {
        "success": true,
        "t": 1571898808491,
        "result": true
    }
    

    将已分配给用户的解锁方式解绑(支持同时解绑多个)

    支持的门锁类型

    • Wi-Fi 门锁
    • Zigbee 门锁
    • 蓝牙门锁(只能解绑通过分配接口解绑的解锁方式)

    请求地址

    POST /v1.0/smart-lock/devices/{device_id}/opmodes/actions/cancel-allocate
    

    请求参数

    参数 类型 参数类型 说明 是否必填
    device_id URI String 设备 ID
    user_id BODY String 用户 ID
    unlock_list BODY List 解锁方式列表

    unlock_list说明

    参数名 类型 说明 是否必填
    code String 解锁方式的 code
    • 指纹:unlock_fingerprint
    • 密码:unlock_password
    • 门卡:unlock_card
    • 人脸:unlock_face
    • 掌纹: unlock_hand
    • 指静脉:unlock_finger_vein
    • 虹膜:unlock_eye
    unlock_sn int 解锁方式编号

    请求示例

    POST /v1.0/smart-lock/devices/vdevo16232264458****/opmodes/actions/cancel-allocate
    
    {
      "user_id": "00****pdo",
      "unlock_list": [
        {
          "dp_code": "unlock_fingerprint",
          "unlock_sn": 2
        },
        {
          "dp_code": "unlock_password",
          "unlock_sn": 1
        },
        {
          "dp_code": "unlock_card",
          "unlock_sn": 3
        }
      ]
    }
    

    响应参数

    参数 类型 说明
    result boolean 操作结果

    响应成功示例

    {
        "success": true,
        "t": 1571898808491,
        "result": true
    }
    

    获取用户帐号所关联的设备

    支持的门锁类型

    • Wi-Fi 门禁

    接口地址

    GET /v1.0/smart-lock/users/{uid}/devices
    

    请求参数

    参数名 类型 参数类型 说明 必填
    uid String URI 设备 ID
    page_no Integer QUERY 当前页数(从 1 开始计数)
    page_size Integer QUERY 通道 ID 每页数据量

    请求示例

    GET /v1.0/smart-lock/users/bay1629701943556****/devices?page_no=1&page_size=10
    

    返回参数

    参数名 类型 说明
    code Integer 错误响应码,成功时为空(详情⻅见错误码)
    success Boolean 是否成功
    • true:成功
    • false:失败
    t Long 响应时间
    msg String 请求失败的信息,成功为空
    result Object 请求结果

    result说明

    参数名 类型 说明
    total Integer 数据总数
    total_pages Integer 总页数
    has_more Boolean 是否还有更多数据
    records List 分页数据

    records说明

    参数名 类型 说明
    id String 设备 ID
    uuid String 设备唯一标识
    uid String 用户 UID
    name String 设备名称
    time_zone String 时区
    ip String 设备 IP
    local_key String 密钥
    sub Boolean 是否为子设备
    model String 产品型号
    active_time Long 设备上次配网时间
    lon String 经度
    lat String 纬度
    owner_id String 设备所在家庭 ID
    product_id String 产品 ID
    product_name String 产品名
    category String 产品类别
    icon String 设备图标
    online Boolean 是否在线

    请求成功返回示例

    {
      "result": {
        "has_more": false,
        "records": [
          {
            "active_time": 1626252626,
            "category": "ldcg",
            "icon": "smart/program_category_icon/ldcg.png",
            "id": "6c8d95e9b2d8cfe1a*****",
            "ip": "",
            "lat": "",
            "local_key": "dc1ba7ed034****c",
            "lon": "",
            "model": "S-LUX-ZB",
            "name": "光照探测器",
            "online": true,
            "product_id": "pisltm67",
            "product_name": "亮度传感器",
            "sub": true,
            "time_zone": "+08:00",
            "uuid": "6c8d9*****d8cfe1a****"
          }
        ],
        "total": 2,
        "total_pages": 1
      },
      "success": true,
      "t": 1632462436318
    }
    

    请求失败返回示例

    {
        "success": false,
        "code": 500, // 错误码,详细请见错误码文档
        "msg": "system error,please contact the admin"
    }
    

    Wi-Fi门禁的一些说明

    用户体系介绍

    • 设备配网者属于家庭用户体系
    • 其他用户属于非家庭用户体系

    角色跟权限介绍

    Wi-Fi 门禁的角色类型

    • 超级管理员(设备拥有者)
    • 管理员
    • 普通成员

    各角色的权限定义(建议)

    建议向下管理,平级不能查看/操作,具体如下:

    • 设备拥有者,可以添加/更新/删除 任意成员的数据 (不能删除自己)。
    • 管理员可以管理自己的数据和普通成员的数据;不能查看/管理其他管理员的数据。
    • 普通成员只能查看/操作自己的数据。