获取成员的解锁方式列表

更新时间:2023-12-07 03:33:54

本文介绍获取成员的解锁方式列表的 API。

接口描述

获取成员的解锁方式列表数据集合。

接口地址

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

请求参数

参数名类型参数位置是否必填说明
device_idStringuritrue设备 ID
user_idStringuritrue用户ID
codesStringquerytrue期望获取哪些种类的解锁方式。多个以英文逗号隔开(可为空)
  • 指纹:unlock_fingerprint
  • 门卡:unlock_card
  • 密码:unlock_password
  • 人脸:unlock_face
  • 掌纹:unlock_hand
  • 指静脉:unlock_finger_vein
  • 遥控器:unlock_telecontrol_kit
unlock_nameStringquerytrue目标解锁方式名称,用以做数据过滤之用,可为空
page_noIntegerquerytrue当前页数(从 1 开始计数)
page_sizeIntegerquerytrue每页数据量

返回参数

参数名类型说明
resultOpenApiPagination

result 说明

参数名类型说明
totalInteger数据总数
total_pagesInteger总页数
has_moreBoolean是否还有更多数据
recordsList分页数据

records 说明

参数名类型说明
user_nameString用户名称
user_typeInteger用户类型
  • 0:未知人员类型
  • 10:管理员
  • 20:普通家人
  • 40:分享用户
  • 50:超级管理员
user_idString用户 ID
lock_user_idInteger用户在锁上的ID
unlock_nameString解锁方式名称
dp_codeString解锁方式的dpCode
unlock_snInteger解锁方式编号
unlock_attrInteger开锁方式属性(1代表劫持属性)
phaseInteger状态
  • 1:已确认
  • 2: 待确认
  • 3:已冻结
  • 4: 待冻结
  • 5:待解冻
  • 6:待重置
  • 7:创建失败
  • 8:已删除
  • 9:待删除
  • 10:待创建
notify_infoUnlockNotifyInfo通知方式
voice_attrInteger语音属性(如果该属性为1则该密码可以通过语音来解锁)
  • 0:不能通过语音打开
  • 1:可以通过语音进行开门
operateString操作
  • CREATE:创建
  • MODIFY:修改
  • DELETE:删除
delivery_statusString硬件对操作的反馈
  • ONGOING:下发中
  • SUCCESS:成功
  • FAILED:失败
allocate_flagInteger是否是从未分配的解锁方式分配给用户的(如果是的话是可以解绑的)
  • 1:是
  • 0:否
channel_idInteger通道 ID

notify_info 说明

参数名类型说明
app_sendBoolean是否app 通知
  • 0:否
  • 1:是 (微信公众号的话, 这里也是1)
voice_phoneString
owner_idString

请求示例

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

返回示例

{
    "result": {
        "records": [
            {
                "allocate_flag": 1,
                "unlock_name": "门卡3",
                "user_name": "拉布",
                "unlock_sn": 3,
                "unlock_attr": 0,
                "voice_attr": 0,
                "user_type": 10,
                "user_id": "36731989",
                "dp_code": "unlock_card",
                "channel_id": -1,
                "lock_user_id": 1
            },
            {
                "allocate_flag": 1,
                "unlock_name": "人脸0",
                "user_name": "拉布",
                "unlock_sn": 0,
                "unlock_attr": 0,
                "voice_attr": 0,
                "user_type": 10,
                "user_id": "36731989",
                "dp_code": "unlock_face",
                "channel_id": -1,
                "lock_user_id": 1
            },
            {
                "allocate_flag": 1,
                "unlock_name": "指纹0",
                "user_name": "拉布",
                "unlock_sn": 0,
                "unlock_attr": 0,
                "voice_attr": 0,
                "user_type": 10,
                "user_id": "36731989",
                "dp_code": "unlock_fingerprint",
                "channel_id": -1,
                "lock_user_id": 1
            }
        ],
        "total_pages": 1,
        "total": 3,
        "has_more": false
    },
    "t": 1630310979003,
    "success": true
}

错误码

参考 错误码