获取用户信息

本文介绍获取用户信息的 API。

接口描述

获取用户信息, 包含用户的时效，联系方式和已经录入的解锁方式等。当前支持品类：常保活 Wi-Fi 门锁。

接口地址

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

请求参数

参数名	类型	参数位置	是否必填	说明
device_id	String	uri	true	设备 ID
codes	String	query	true	硬件解锁方式, 多个的话以逗号分隔 unlock_fingerprint：指纹 unlock_card：门卡 unlock_password：密码 unlock_face：人脸 unlock_hand：掌纹 unlock_finger_vein：指静脉
page_no	Integer	query	true	当前页数，从1开始计数
page_size	Integer	query	true	每页数据量

返回参数

参数名	类型	说明
result	OpenApiPagination

result 说明

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

records 说明

参数名	类型	说明
user_id	String	用户 ID
avatar_url	String	头像地址
user_contact	String	联系方式
unlock_detail	List	成员拥有的解锁方式列表
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	UserTimeScheduleInfoVO	用户时效信息
uid	String	用户 uid

unlock_detail 说明

参数名	类型	说明
dp_code	String	硬件解锁方式 unlock_fingerprint：指纹 unlock_card：门卡 unlock_password：密码 unlock_face：人脸 unlock_hand：掌纹 unlock_finger_vein：指静脉
unlock_list	List	解锁方式详细列表
count	Long	当前解锁方式的数量

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	一天里开始生效分钟
end_minute	Long	一天里开始失效分钟
working_day	Integer	星期, 每个值累加： 1：星期天 2：星期一 4：星期二 8：星期三 16：星期四 32：星期五 64：星期六
time_zone_id	String	时区
all_day	Boolean	是否全天

unlock_list 说明

参数名	类型	说明
unlock_id	String	解锁方式云端编号
unlock_sn	Integer	解锁方式在门锁上的编号
unlock_name	String	解锁方式名称
unlock_attr	Integer	解锁方式属性， 1：带劫持
op_mode_id	Long	解锁方式云端序号
photo_unlock	Boolean	是否带开门抓拍功能 true：是 false：否
admin	Boolean	是否是管理员 true：是 false：否

请求示例

GET: /v1.0/smart-lock/devices/vdevo12454656****/users

{
  "codes": "unlock_fingerprint,unlock_password",
  "pageNo": 1,
  "pageSize": 10
}

返回示例

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

错误码

参考 错误码。