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

门锁解锁方式

更新时间:2022-03-18 07:25:16下载pdf

门锁解锁方式 API

流程图

门锁解锁方式

获取门锁成员已绑定的解锁方式列表

支持的门锁类型

  • Wi-Fi 门锁
  • Zigbee 门锁
  • 蓝牙门锁
  • 可视对讲 WIFI (仅支持家庭成员)

接口地址

GET /v1.0/devices/{device_id}/door-lock/user-types/{user_type}/users/{user_id}/assigned-keys

请求参数

参数名 类型 参数类型 说明 是否必填
device_id String URI 设备 ID
user_type Integer URI 成员类型(1:家庭成员;2:非家庭成员)
user_id String URI 成员 ID
unlock_type String URL 解锁类型(fingerprint/password/card)

请求示例

GET /v1.0/devices/xxx/door-lock/user-types/2/users/xxx/assigned-keys?unlock_type=card

返回参数

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

result

参数名 类型 说明
unlock_keys List 解锁方式列表

unlock_keys说明

参数名 类型 说明
unlock_no Integer 解锁方式ID(密码、指纹、卡等钥匙在门锁上的标识位)
unlock_type String 解锁类型(fingerprint/password/card)
hijack Boolean 是否为劫持解锁

请求成功返回示例

{
    "result":{
        "unlock_keys":[
            {
                "unlock_no":3,
                "unlock_type":"card",
                "hijack":false
            }
        ]
    },
    "success":true,
    "t":1593843316481
}

请求失败返回示例

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

获取门锁成员未绑定的解锁方式列表

支持的门锁类型

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

接口地址

GET /v1.0/devices/{device_id}/door-lock/unassigned-keys

请求参数

参数名 类型 参数类型 说明 是否必填
device_id String URI 设备 ID
unlock_type String URL 解锁类型(fingerprint/password/card/remoteControl)

请求示例

GET /v1.0/devices/xxxx/door-lock/unassigned-keys?unlock_type=card

返回参数

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

result

参数名 类型 说明
unlock_keys List 解锁方式列表

unlock_keys说明

参数名 类型 说明
unlock_no Integer 解锁方式ID(密码、指纹、卡等钥匙在门锁上的标识位)
unlock_type String 解锁类型(fingerprint/password/card)

请求成功返回示例

{
    "result":{
        "unlock_keys":[
            {
                "unlock_no":3,
                "unlock_type":"card"
            }
        ]
    },
    "success":true,
    "t":1593843316481
}

请求失败返回示例

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

云端发起解锁方式同步

支持的门锁类型

  • 带网关的蓝牙门锁
  • 常保活 Wi-Fi
  • 可视对讲 Wi-Fi
  • Wi-Fi 门禁

接口地址

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

请求参数

参数名 类型 参数类型 说明 是否必填
device_id String URI 设备 ID
codes String URL 解锁方式, 多个的话以逗号分隔
  • unlock_fingerprint:指纹
  • unlock_card:门卡
  • unlock_password:密码
  • unlock_face:人脸
  • unlock_hand:掌纹
  • unlock_finger_vein:指静脉
  • unlock_telecontrol_kit:遥控器

请求示例

PUT /v1.0/smart-lock/devices/vdevo12454656****/opmodes/actions/sync
{
    "codes":"unlock_fingerprint,unlock_password"
}

返回参数

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

请求成功返回示例

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

请求失败返回示例

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

门锁解锁方式录入

支持的门锁类型

  • Wi-Fi 门锁
  • Zigbee 门锁
  • 蓝牙门锁
  • 常保活 Wi-Fi 门锁 (仅支持家庭成员)
  • 可视对讲 Wi-Fi(仅支持家庭成员)
  • Wi-Fi 门禁

接口地址

PUT /v1.0/devices/{device_id}/door-lock/actions/entry

请求参数

参数名 类型 参数类型 说明 是否必填
device_id String URI 设备 ID
user_id String BODY 成员 ID
user_type Integer BODY 成员类型(1:家庭成员;2:非家庭成员)
Wi-Fi门禁请使用 2
unlock_type String BODY 解锁方式类型 fingerprint: 指纹解锁,password:密码解锁,card:门卡解锁,face:人脸解锁,remoteControl:遥控器
password_type String BODY 密码加密类型:ticket(当且仅当unlock_type为password, 且是蓝牙锁才有效)
ticket_id String BODY 密码加密临时秘钥ID(当且仅当unlock_type为password, 且是蓝牙锁才有效)
password String BODY 密码(当且仅当unlock_type为password, 且是蓝牙锁才有效)

请求示例

PUT /v1.0/devices/xxx/door-lock/actions/entry
{
    "unlock_type":"card",
	"user_type":2,
    "user_id":"000xxxwsn"
}

返回参数

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

请求成功返回示例

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

请求失败返回示例

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

门锁解锁方式删除

支持的门锁类型

  • Wi-Fi 门锁
  • Zigbee 门锁
  • 蓝牙门锁
  • 常保活 Wi-Fi 门锁 (仅支持家庭成员)
  • Wi-Fi 门禁

接口地址

DELETE /v1.0/devices/{device_id}/door-lock/user-types/{user_type}/users/{user_id}/unlock-types/{unlock_type}/keys/{unlock_no}

请求参数

参数名 类型 参数类型 说明 是否必填
device_id String URI 设备 ID
user_type Integer URI 成员类型(1:家庭成员;2:非家庭成员)
Wi-Fi门禁请使用 2
user_id String URI 成员 ID
unlock_type String URI 解锁类型(fingerprint/password/card/remoteControl)
unlock_no Integer URI 解锁方式ID(密码、指纹、卡等钥匙在门锁上的标识位)

请求示例

DELETE /v1.0/devices/xxxx/door-lock/user-types/2/users/xxxx/unlock-types/fingerprint/keys/30

返回参数

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

请求成功返回示例

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

请求失败返回示例

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

取消录入解锁方式

支持的门锁类型

  • Wi-Fi 门锁
  • Zigbee 门锁
  • 蓝牙门锁
  • 常保活 Wi-Fi 门锁 (仅支持家庭成员)
  • 可视对讲 Wi-Fi(仅支持家庭成员)
  • 可视对讲 Wi-Fi(仅支持家庭成员)
  • Wi-Fi 门禁

接口地址

PUT /v1.0/devices/{device_id}/door-lock/unlock-types/{unlock_type}/actions/cancel

请求参数

参数名 类型 参数类型 说明 是否必填
device_id String URI 设备 ID
unlock_type String URI 解锁类型(fingerprint/password/card/remoteControl)

请求示例

PUT /v1.0/devices/xxx/door-lock/unlock-types/card/actions/cancel

返回参数

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

请求成功返回示例

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

请求失败返回示例

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

更新解锁方式名称

支持的门锁类型

  • Wi-Fi 门禁

接口地址

PUT /v1.0/devices/{device_id}/door-lock/opmodes/{unlock_sn}

请求参数

参数名 类型 参数类型 说明 是否必填
device_id String URI 设备 ID
unlock_sn Integer URI 解锁方式编号
dp_code String BODY 解锁方式的 dpCode
  • 密码:unlock_password
  • 指纹:unlock_fingerprint
  • 门卡:unlock_card
  • 人脸:unlock_face
  • 遥控器:unlock_telecontrol_kit
  • unlock_name String BODY 解锁方式名称

    请求示例

    PUT  /v1.0/devices/vdevo16232264458****/door-lock/opmodes/2
    

    返回参数

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

    请求成功返回示例

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

    请求失败返回示例

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

    设置解锁方式为挟持解锁

    支持的门锁类型

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

    接口地址

    PUT /v1.0/devices/{device_id}/door-lock/unlock-types/{unlock_type}/keys/{unlock_no}/hijack
    

    请求参数

    参数名 类型 参数类型 说明 是否必填
    device_id String URI 设备 ID
    unlock_type String URI 解锁类型(fingerprint/password/card)
    unlock_no Integer URI 解锁方式 ID(密码、指纹、卡等钥匙在门锁上的标识位)

    请求示例

    PUT /v1.0/devices/xxx/door-lock/unlock-types/card/keys/130/hijack
    

    返回参数

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

    请求成功返回示例

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

    请求失败返回示例

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

    删除解锁方式的挟持解锁

    支持的门锁类型

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

    接口地址

    DELETE /v1.0/smart-lock/devices/{device_id}/unlock-types/{unlock_type}/keys/{unlock_sn}/hijack
    

    请求参数

    参数名 类型 参数类型 说明 是否必填
    device_id String URI 设备 ID
    unlock_type String URI 解锁类型
    • 指纹:unlock_fingerprint
    • 门卡:unlock_card
    • 密码:unlock_password
    unlock_sn Integer URI 解锁方式 ID(密码、指纹、卡等钥匙在门锁上的标识位)

    请求示例

    DELETE /v1.0/smart-lock/devices/vdevo12454656****/unlock-types/unlock_fingerprint/keys/1/hijack
    

    返回参数

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

    请求成功返回示例

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

    请求失败返回示例

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

    设置解锁方式特殊属性

    支持的门锁类型

    • Wi-Fi 门锁

    接口地址

    POST /v1.0/smart-lock/devices/{device_id}/opmodes/{opmode_id}/attribute/{attribute}/opmode-attr
    

    请求参数

    参数名 类型 参数类型 说明 是否必填
    device_id String URI 设备 ID
    opmode_id Long URI 解锁方式序号
    attribute Integer URI 属性
    • 1:语音属性
    • 2:拍照属性
    enabled Boolean BODY 是否开启
    • true:开启
    • false:关闭

    请求示例

    POST /v1.0/smart-lock/devices/vdevo12454656****/opnodes/1234/attribute/4/opmode-attr
    

    返回参数

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

    请求成功返回示例

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

    请求失败返回示例

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