Skip to content

钥匙用户模块

锁用户列表/搜索锁用户列表

  1. 请求链接: /keyUser/listKeyUser

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
pageNoStringY"1"页码
pageSizeStringY"20"每页数量
searchStrStringY""搜索需传入此参数
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
listArray用户列表
uidInt用户ID
nicknameString昵称
headUrlString头像URL
useridString用户账号
json
{
  "list": [
    {
      "uid": 16599773,
      "nickname": "张图",
      "headUrl": "",
      "userid": "786612630@qq.com"
    },
    {
      "uid": 17136099,
      "nickname": "张图",
      "headUrl": "",
      "userid": "78661263@qq.com"
    },
    {
      "uid": 17135615,
      "nickname": "章丘",
      "headUrl": "",
      "userid": "15080825640@163.com"
    },
    {
      "uid": 17136213,
      "nickname": "赵姐",
      "headUrl": "",
      "userid": "8632147526@qq.com"
    }
  ]
}

群发钥匙检查

  1. 请求链接: /keyUser/canSendKey

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
endDateStringY"1689665220000"结束时间
lockIdListStringY"[]"锁ID列表(JSON字符串)
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
errorCodeInt错误码
descriptionString描述
errorMsgString错误信息

说明:该接口检查钥匙是否可以发送钥匙,如果可以发送,则发送。如果钥匙的有效期小于当前选择的时间,则提示。主要是检查授权管理员的钥匙。

成功示例:

json
{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

失败示例:

json
{
  "errorCode": -3039,
  "description": "你自己钥匙的有效期小于当前选择的时间,请重新选择时间或者联系管理员调整你的钥匙有效期。\n钥匙名称:MCBN01_210576",
  "errorMsg": "Authorized ekey time not enough."
}

批处理群发钥匙

  1. 请求链接: /key/batchSend

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
lockIdsarrayY[500, 501]锁列表
createUserintY0发送的邮箱/手机号未注册时重新调用接口加这个字段传1
countryCodeStringY""国家区号(createUser=1时使用)
receiverUsernameStringY"123@qq.com"手机号/邮箱地址
keyNameStringY"张三"钥匙接受者姓名
keyTypeintY1钥匙类型
weekDaysarrayN[1, 2, 3, 4, 7]循环钥匙必填
startDateintY0永久可默认0
endDateintY0永久可默认0
startTimeintN1710032400000keyType为循环可填,生效时间:09:00 转毫秒时间
endTimeintN1710079200000keyType为循环可填,失效时间:23:00 转毫秒时间
remoteUnlockSwitchintY0是否支持远程开锁开关:1-是、2-否
keyRightintY0是否授权管理员
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
keyIdInt钥匙ID
receiverUidInt接收者用户ID
json
{
  "keyId": 109750817,
  "receiverUid": 16599773
}

用户拥有的锁

  1. 请求链接: /keyUser/listByUse

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
pageNoStringY"1"页码
pageSizeStringY"20"每页数量
uidStringY"16599773"用户ID
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
listArray锁列表
lockIdInt锁ID
uidInt用户ID
lockAliasString锁别名
keyStatusString钥匙状态
endDateLong结束时间
keyIdInt钥匙ID
startDateLong开始时间
keyRightInt钥匙权限
json
{
  "list": [
    {
      "lockId": 9418481,
      "uid": 16599773,
      "lockAlias": "MCBN01_8f3106",
      "keyStatus": "110412",
      "endDate": 1689405179000,
      "keyId": 109084863,
      "startDate": 1689318720000,
      "keyRight": 0
    }
  ]
}

即将到期的电子钥匙列表

  1. 请求链接: /keyUser/listExpireUser

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
pageNoStringY"1"页码
pageSizeStringY"20"每页数量

说明:查出的是在一个月内到期的

  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
listArray钥匙列表
lockAliasString锁别名
keyStatusString钥匙状态
endDateLong结束时间
startDayLong开始日期
headUrlString头像URL
keyIdInt钥匙ID
useridString用户账号
colorTypeInt颜色类型
lockIdInt锁ID
uidInt用户ID
weekDaysString有效星期(JSON字符串)
endDayLong结束日期
nicknameString昵称
nickname2String昵称2
keyTypeInt钥匙类型
startDateLong开始时间
keyRightInt钥匙权限
descriptionString描述
pageNoInt页码
pageSizeInt每页数量
pagesInt总页数
totalInt总数
json
{
  "list": [
    {
      "lockAlias": "MCBN01_8f3106",
      "keyStatus": "110411",
      "endDate": 1689242400000,
      "startDay": 1689264000000,
      "headUrl": "",
      "keyId": 109086023,
      "userid": "8632147526@qq.com",
      "colorType": 1,
      "lockId": 9418481,
      "uid": 17136213,
      "weekDays": "[1,7]",
      "endDay": 1689436799000,
      "nickname": "赵姐",
      "nickname2": "8632147526",
      "keyType": 4,
      "startDate": 1689210000000,
      "keyRight": 0
    },
    {
      "lockAlias": "MCBN01_8f3106",
      "keyStatus": "110401",
      "endDate": 1689405179000,
      "headUrl": "",
      "keyId": 109084863,
      "description": "即将过期",
      "userid": "786612630@qq.com",
      "colorType": 1,
      "lockId": 9418481,
      "uid": 16599773,
      "nickname": "张图",
      "nickname2": "午夜",
      "startDate": 1689318720000,
      "keyRight": 0
    }
  ],
  "pageNo": 1,
  "pageSize": 20,
  "pages": 1,
  "total": 2
}

修改有效期

  1. 请求链接: /key/updateKeyDate

  2. 请求方式: POST

说明:跟"3.2.5编辑电子钥匙的有效期、有效时间、有效日的"接口一样

  1. 参数说明:
名称类型是否必需示例描述
endDateStringY"1689242400000"结束时间
endDayStringY"1689695999000"不使用
keyIdStringY"109086023"钥匙ID
lockIdStringY"9418481"锁ID
startDateStringY"1689210000000"开始时间
startDayStringY"1689264000000"不使用
uidStringY"17136213"用户ID
weekDaysStringY"[1,7]"有效星期(JSON字符串)
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
errorCodeInt错误码
descriptionString描述
errorMsgString错误信息
json
{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

分组列表(已废弃)

  1. 请求链接: /keyGroup/list

  2. 请求方式: POST

说明:已废弃(包含了授权管理员的锁)

  1. 参数说明:
名称类型是否必需示例描述
typeStringY"2"类型
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
listArray分组列表
lockNumInt锁总数量
keyGroupIdInt组ID
keyGroupNameString组名
groupTypeInt组类型 0未分组 1非未分组
lockListArray锁列表
lockIdInt锁ID
lockAliasString锁名
json
{
  "list": [
    {
      "lockNum": 4,
      "keyGroupId": 29,
      "keyGroupName": "未分组",
      "groupType": 0,
      "lockList": [
        {
          "lockId": 500,
          "lockAlias": "公司会议室通道锁"
        },
        {
          "lockId": 501,
          "lockAlias": "公司会议门禁锁"
        },
        {
          "lockId": 1711,
          "lockAlias": "CDBN01_df4a6425"
        },
        {
          "lockId": 1713,
          "lockAlias": "CDBN01_df4a646"
        }
      ]
    },
    {
      "lockNum": 2,
      "keyGroupId": 326,
      "keyGroupName": "哈哈哈1",
      "groupType": 1,
      "lockList": [
        {
          "lockId": 1683,
          "lockAlias": "CDBN01_df4a6423"
        },
        {
          "lockId": 1685,
          "lockAlias": "TMH_30d80f8a8206"
        }
      ]
    },
    {
      "lockNum": 0,
      "keyGroupId": 333,
      "keyGroupName": "哈哈哈2",
      "groupType": 1,
      "lockList": []
    }
  ]
}

分组下的锁(已废弃)

  1. 请求链接: /room/listByGroup

  2. 请求方式: POST

说明:已废弃

  1. 参数说明:
名称类型是否必需示例描述
keyGroupIdStringY"0"分组ID
typeStringY"2"类型
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
listArray锁列表
lockIdString锁ID
lockAliasString锁别名
json
{
  "list": [
    {
      "lockId": "222",
      "lockAlias": "MCBN01_210576"
    },
    {
      "lockId": "222",
      "lockAlias": "MCBN01_210576"
    }
  ]
}

删除用户

  1. 请求链接: /keyUser/deleteKeyUser

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
uidStringY"2"用户ID
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
errorCodeInt错误码
descriptionString描述
errorMsgString错误信息
json
{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

即将到期的密码列表

  1. 请求链接: /keyUser/listExpirePwd

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
pageNointN1页码
pageSizeintN20每页数量
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
listArray密码列表
clientIdString客户端ID
lockOwnerIdInt锁所有者ID
lockIdInt锁ID
keyboardPwdTypeInt密码类型
keyboardPwdStatusInt密码状态
startDateLong开始时间
endDateLong结束时间
keyboardPwdString密码
keyboardPwdHashString密码哈希
addTypeInt添加类型
pwdRightInt密码权限
isCustomInt是否自定义
isCoercedInt是否胁迫
hoursStartInt小时开始
hoursEndInt小时结束
pwdUserNoInt密码用户编号
businessIdInt业务ID
created_atString创建时间
updated_atString更新时间
api_userObjectAPI用户信息
pwdIdInt密码ID
uidInt用户ID
nicknameString昵称
lockAliasString锁别名
expireDateInt到期天数
pageNoInt页码
pageSizeInt每页数量
pagesInt总页数
totalInt总数
json
{
  "list": [
    {
      "clientId": "ewKnbqQwANE9pYBuKUz3FLzPOPcrzspO",
      "lockOwnerId": 385,
      "lockId": 1759,
      "keyboardPwdType": 3,
      "keyboardPwdStatus": 1,
      "startDate": 1711609200000,
      "endDate": 1713888000000,
      "keyboardPwd": "69030810717",
      "keyboardPwdHash": "f5d35453e8619ac00d8e91a1c1b04f26351acd1e",
      "addType": 0,
      "pwdRight": 0,
      "isCustom": 0,
      "isCoerced": 2,
      "hoursStart": 0,
      "hoursEnd": 23,
      "pwdUserNo": 0,
      "businessId": 0,
      "created_at": "2024-03-28T02:00:04.000000Z",
      "updated_at": "2024-03-28T02:00:04.000000Z",
      "api_user": {
        "id": 385,
        "account_name": "6666@qq.com"
      },
      "pwdId": 6602,
      "uid": 385,
      "nickname": "32223",
      "lockAlias": "锁",
      "expireDate": 26
    }
  ],
  "pageNo": 1,
  "pageSize": 20,
  "pages": 1,
  "total": 1
}

即将到期的IC卡列表

  1. 请求链接: /keyUser/listExpireCard

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
pageNointN1页码
pageSizeintN20每页数量
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
listArrayIC卡列表
clientIdString客户端ID
lockOwnerIdInt锁所有者ID
lockIdInt锁ID
cardNumberString卡号
startDateLong开始时间
endDateLong结束时间
cardStatusInt卡状态
cardTypeInt卡类型
cardRightInt卡权限
weekDayArray有效星期
addTypeInt添加类型
isCoercedInt是否胁迫
cardUserNoInt卡用户编号
businessIdInt业务ID
created_atString创建时间
updated_atString更新时间
api_userObjectAPI用户信息
cardIdInt卡ID
uidInt用户ID
nicknameString昵称
lockAliasString锁别名
expireDateInt到期天数
pageNoInt页码
pageSizeInt每页数量
pagesInt总页数
totalInt总数
json
{
  "list": [
    {
      "clientId": "ewKnbqQwANE9pYBuKUz3FLzPOPcrzspO",
      "lockOwnerId": 385,
      "lockId": 1759,
      "cardNumber": "232",
      "startDate": 1711333200000,
      "endDate": 1712557200000,
      "cardStatus": 1,
      "cardType": 4,
      "cardRight": 0,
      "weekDay": [1, 2, 3, 4, 5],
      "addType": 1,
      "isCoerced": 1,
      "cardUserNo": 0,
      "businessId": 0,
      "created_at": "2024-03-28T02:07:35.000000Z",
      "updated_at": "2024-03-28T02:07:35.000000Z",
      "api_user": {
        "id": 385,
        "account_name": "6666@qq.com"
      },
      "cardId": 5543,
      "uid": 385,
      "nickname": "v3vgbh",
      "lockAlias": "锁",
      "expireDate": 11
    }
  ],
  "pageNo": 1,
  "pageSize": 20,
  "pages": 1,
  "total": 1
}

即将到期的指纹列表

  1. 请求链接: /keyUser/listExpireFingerprint

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
pageNointN1页码
pageSizeintN20每页数量
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
listArray指纹列表
clientIdString客户端ID
lockOwnerIdInt锁所有者ID
lockIdInt锁ID
fingerprintStatusInt指纹状态
fingerprintNumberString指纹编号
fingerprintTypeInt指纹类型
startDateLong开始时间
endDateLong结束时间
weekDayArray有效星期
addTypeInt添加类型
fingerRightInt指纹权限
isCoercedInt是否胁迫
fingerprintUserNoInt指纹用户编号
businessIdInt业务ID
created_atString创建时间
updated_atString更新时间
api_userObjectAPI用户信息
fingerprintIdInt指纹ID
uidInt用户ID
nicknameString昵称
lockAliasString锁别名
expireDateInt到期天数
pageNoInt页码
pageSizeInt每页数量
pagesInt总页数
totalInt总数
json
{
  "list": [
    {
      "clientId": "ewKnbqQwANE9pYBuKUz3FLzPOPcrzspO",
      "lockOwnerId": 385,
      "lockId": 1759,
      "fingerprintStatus": 1,
      "fingerprintNumber": "fb3d4e32-f212-458c-b08c-a4055d0700ec",
      "fingerprintType": 4,
      "startDate": 1711333200000,
      "endDate": 1712557020000,
      "weekDay": [1, 3],
      "addType": 1,
      "fingerRight": 0,
      "isCoerced": 1,
      "fingerprintUserNo": 0,
      "businessId": 0,
      "created_at": "2024-03-28T02:09:19.000000Z",
      "updated_at": "2024-03-28T02:09:19.000000Z",
      "api_user": {
        "id": 385,
        "account_name": "6666@qq.com"
      },
      "fingerprintId": 6969,
      "uid": 385,
      "nickname": "测试卡-胁迫-2中指2222",
      "lockAlias": "锁",
      "expireDate": 11
    }
  ],
  "pageNo": 1,
  "pageSize": 20,
  "pages": 1,
  "total": 1
}

即将到期的人脸列表

  1. 请求链接: /keyUser/listExpireFace

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
pageNointN1页码
pageSizeintN20每页数量
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
listArray人脸列表
clientIdString客户端ID
lockOwnerIdInt锁所有者ID
lockIdInt锁ID
faceNumberString人脸编号
featureDataString特征数据
startDateLong开始时间
endDateLong结束时间
faceTypeInt人脸类型
statusInt状态
cyclicConfigString循环配置(JSON字符串)
addTypeInt添加类型
faceRightInt人脸权限
businessIdInt业务ID
dateInt日期
created_atString创建时间
updated_atString更新时间
faceUserNoInt人脸用户编号
user_infoObject用户信息
faceIdInt人脸ID
uidInt用户ID
nicknameString昵称
lockAliasString锁别名
expireDateInt到期天数
pageNoInt页码
pageSizeInt每页数量
pagesInt总页数
totalInt总数
json
{
  "list": [
    {
      "clientId": "ewKnbqQwANE9pYBuKUz3FLzPOPcrzspO",
      "lockOwnerId": 385,
      "lockId": 1759,
      "faceNumber": "8728787",
      "featureData": "458787",
      "startDate": 1711328400000,
      "endDate": 1712584800000,
      "faceType": 4,
      "status": 1,
      "cyclicConfig": "[]",
      "addType": 1,
      "faceRight": 0,
      "businessId": 0,
      "date": 0,
      "created_at": "2024-03-28T02:10:58.000000Z",
      "updated_at": "2024-03-28T02:10:58.000000Z",
      "faceUserNo": 0,
      "user_info": {
        "id": 385,
        "account_name": "6666@qq.com"
      },
      "faceId": 19,
      "uid": 385,
      "nickname": "人2脸名称2w2",
      "lockAlias": "锁",
      "expireDate": 11
    }
  ],
  "pageNo": 1,
  "pageSize": 20,
  "pages": 1,
  "total": 1
}

即将到期的掌静脉

  1. 请求链接: /keyUser/listExpirePalmVein

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
pageNointN1页码
pageSizeintN20每页数量
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
listArray掌静脉列表
clientIdString客户端ID
lockOwnerIdInt锁所有者ID
lockIdInt锁ID
palmVeinNumberString掌静脉编号
startDateLong开始时间
endDateLong结束时间
palmVeinTypeInt掌静脉类型
weekDayArray有效星期
palmVeinStatusInt掌静脉状态
palmVeinUserNoInt掌静脉用户编号
businessIdInt业务ID
palmVeinRightInt掌静脉权限
addTypeInt添加类型
isCoercedInt是否胁迫
created_atString创建时间
updated_atString更新时间
user_infoObject用户信息
lock_infoObject锁信息
palmVeinIdInt掌静脉ID
uidInt用户ID
nicknameString昵称
lockAliasString锁别名
expireDateInt到期天数
pageNoInt页码
pageSizeInt每页数量
pagesInt总页数
totalInt总数
json
{
  "list": [
    {
      "clientId": "TMwurHIlxuRdS7lkiHPdOJlBgWutBoW1",
      "lockOwnerId": 11023,
      "lockId": 329,
      "palmVeinNumber": "28881",
      "startDate": 1750299272721,
      "endDate": 1750302872000,
      "palmVeinType": 2,
      "weekDay": [],
      "palmVeinStatus": 1,
      "palmVeinUserNo": 0,
      "businessId": 0,
      "palmVeinRight": 0,
      "addType": 1,
      "isCoerced": 0,
      "created_at": "2025-06-19T02:16:33.000000Z",
      "updated_at": "2025-06-19T02:16:33.000000Z",
      "user_info": {
        "id": 11023,
        "account_name": "585685@qq.com"
      },
      "lock_info": {
        "btDeviceName": "TMH_ea9acd84050d"
      },
      "palmVeinId": 1,
      "uid": 11023,
      "nickname": "掌静脉名称3",
      "lockAlias": "啊啊啊",
      "expireDate": 1
    }
  ],
  "pageNo": 1,
  "pageSize": 20,
  "pages": 1,
  "total": 1
}

即将到期的遥控

  1. 请求链接: /keyUser/listExpireRemote

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
pageNointN1页码
pageSizeintN20每页数量
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
listArray遥控列表
clientIdString客户端ID
lockOwnerIdInt锁所有者ID
lockIdInt锁ID
remoteNumberString遥控编号
macStringMAC地址
startDateLong开始时间
endDateLong结束时间
remoteTypeInt遥控类型
weekDayArray有效星期
electricQuantityInt电量
firmwareInfoArray固件信息
remoteStatusInt遥控状态
created_atString创建时间
updated_atString更新时间
remoteUserNoInt遥控用户编号
businessIdInt业务ID
remoteRightInt遥控权限
addTypeInt添加类型
isCoercedInt是否胁迫
user_infoObject用户信息
lock_infoObject锁信息
remoteIdInt遥控ID
uidInt用户ID
nicknameString昵称
lockAliasString锁别名
expireDateInt到期天数
pageNoInt页码
pageSizeInt每页数量
pagesInt总页数
totalInt总数
json
{
  "list": [
    {
      "clientId": "TMwurHIlxuRdS7lkiHPdOJlBgWutBoW1",
      "lockOwnerId": 11023,
      "lockId": 331,
      "remoteNumber": "6",
      "mac": "",
      "startDate": 1750298760000,
      "endDate": 1750329000000,
      "remoteType": 2,
      "weekDay": [],
      "electricQuantity": 0,
      "firmwareInfo": [],
      "remoteStatus": 1,
      "created_at": "2025-06-19T02:07:04.000000Z",
      "updated_at": "2025-06-19T02:07:04.000000Z",
      "remoteUserNo": 6,
      "businessId": 0,
      "remoteRight": 0,
      "addType": 1,
      "isCoerced": 0,
      "user_info": {
        "id": 11023,
        "account_name": "585685@qq.com"
      },
      "lock_info": {
        "btDeviceName": "TMH_d928291e9a14"
      },
      "remoteId": 2,
      "uid": 11023,
      "nickname": "555",
      "lockAlias": "遥控",
      "expireDate": 1
    }
  ],
  "pageNo": 1,
  "pageSize": 20,
  "pages": 1,
  "total": 1
}

鑫泓佳智能硬件通信协议文档