generateSnapkey(生成门锁密码)
新接入请优先使用 设备能力与事件 与 V2 设备 API。本页保留给仍在调用 POST /openapi/generateSnapkey 的兼容对接。
generateSnapkey:生成门锁密码
要点:https://openapi.lechange.cn/openapi/generateSnapkey · 权限 "Permission":"Config" "Resource":"dev:序列号" · 见 错误码
生成门锁密码。
请求参数
| 参数名 | 参数类型 | 是否必填 | 默认值 | 合法值 | 参数说明 | |
|---|---|---|---|---|---|---|
| token | String | 是 | 管理员或者子账号accessToken | |||
| deviceId | String | 是 | 门锁设备序列号 | |||
| name | String | 是 | 密钥名称 | |||
| effectiveNum | Integer | 是 | -1:不限次数 | 有效次数 | ||
| effectiveDay | Integer | 是 | [1,90] | 有效天数 | ||
| effectPeriod | Array | 否 | [] | ≤128 条 | 生效时段;省略或 `[]` 表示全天/无时段限制。数组非空时每项须含 `period`(星期,可逗号多选如 `Monday,Friday`)、`beginTime`/`endTime`(`HH:mm:ss`,不支持跨天) | |
请求示例
{
"system":{
"ver":"1.0",
"appId":"lcdxxxxxxxxx",
"sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
"time":1603356648,
"nonce":"1f62152b-074b-45cd-b9b6-2b00117db8f3"
},
"id":"63d9e876-e223-481c-9886-6386d57556da",
"params":{
"deviceId":"TESTQWERXXXX",
"token": "<yourAccessToken>",
"name":"key001",
"effectiveNum":-1,
"effectiveDay":7,
"effectPeriod":[
{
"period":"Monday",
"beginTime":"12:00:00",
"endTime":"18:00:00"
}
]
}
}
响应字段
| 字段名 | 字段类型 | 字段说明 |
|---|---|---|
| key | String | 门锁密钥唯一ID |
| name | String | 门锁密钥名称 |
响应示例
{
"result":{
"msg":"操作成功。",
"code":"0",
"data": {
"key":"13686275",
"name":"key001"
}
},
"id":"63d9e876-e223-481c-9886-6386d57556da"
}
错误码
本接口可能返回下列码;完整分组见 错误码。
网关与鉴权(SN / TK / OP)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SN1001 | 签名异常 | 按 签名 核对 sign |
TK1002 | token 无效或过期 | 重新获取 token |
OP1002 | 缺少必填参数 | 补必填字段 |
OP1003 | 参数不合法 | 按本页参数表核对 |
OP1039 | 分钟级限流 | 等到下一分钟再试 |
OP1040 | 调用超限 | 降低频率 |
DV1007 | 设备离线或超时 | 等设备上线 |
子账号(SUB)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SUB1001 | 子账号无指定权限 | 在 子账号策略 中补权限 |
SUB1002 | 子账号无任何设备权限 | 授权设备或调整策略 |
SUB1005 | 子账号 token 过期 | 重新 获取子账号 token |
SUB1006 | 子账号与设备无授权关系 | 核对 Resource 与设备序列号 |
SUB1008 | 子账号未绑定当前应用 | 先创建并绑定子账号 |
SUB1007 | 创建子账号失败 | 核对参数后重试 |
SUB1009 | 子账号创建失败,账号格式错误 | account 须为手机号或邮箱 |
SUB1010 | 子账号创建失败,账号已存在 | 勿重复绑定同一子账号到应用 |
更多见 错误码 · SUB。
设备访问与通道(DV10xx)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
DV1007 | 设备离线或超时 | 等设备上线;低电休眠先 唤醒 |
DV1009 | 设备正忙 | 稍后重试 |
DV1012 | 分享/授权设备权限不足 | 核对子账号 Permission / Resource |
DV1019 | 能力集不支持 | 确认型号与 设备能力 |
DV1020 | 通道离线 | 检查通道与设备状态 |
DV1026 | 不支持此功能 | 换接口或升级固件 |
DV1028 | 未绑定或通道不存在 | 核对 deviceId / channelId |
DV1030 | 设备休眠 | 唤醒后再调 |
DV1057 | 通道不存在 | 核对通道号 |
DV1061 | 设备响应超时 | 检查设备网络 |
DV1062 | 需先唤醒设备 | 调用唤醒接口 |
DV1069 | 不满足操作条件 | 见 msg |
门锁与门铃(DV10xx)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
DV1016 | 设备密码错误 | 核对门锁密码 |
DV1038 | 低电量无法添加临时密钥 | 充电后重试 |
DV1039 | 临时密钥条件不满足 | 按本页参数说明调整 |
DV1050 | 临时密钥次数超限 | 删除旧密钥或等待 |
DV1070 | 门铃/对讲忙 | 稍后再接听或挂断 |
说明
子账号 token 须具备最小权限:Permission 为 Config,Resource 为 dev:{deviceId}。配置见 权限码。