getSnapkeyList（获取临时密钥列表）

getSnapkeyList：获取临时密钥列表

遗留 HTTP 保留： 新接入可使用门磁与门锁（detection.door）对应能力。两套接口不是一对一替代。门锁/门铃 HTTP 在 registry 中没有一对一映射。

功能说明

获取门锁设备的临时密钥列表。

请求地址

https://openapi-[DataCenter].easy4ip.com/openapi/getSnapkeyList

请求格式

POST JSON 请求体见请求约定；签名见签名。

子账号 token 最低权限

子账号 accessToken 的策略须包含 Config 权限；设备级资源 URI 为 dev:{deviceId}。详见权限码。

请求参数

参数名	参数类型	是否必填	默认值	合法取值	参数说明
token	String	是			管理员或子账号 accessToken
deviceId	String	是			门锁设备序列号

请求示例

{
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1603350639,
 "nonce":"350f4c7a-a352-46cf-ae03-f4f526f5d99f"
 },
 "id":"b8f45dbb-79ad-4a7e-8b24-7eb618c5191f",
 "params":{
 "token":"At_00000ad9e6e87f0142eb92e207aec46a",
 "deviceId":"TESTQWERXXXX"
 }
}

返回 data 字段

字段名	字段类型	字段说明
snapkeys.keyId	String	密钥唯一 ID
snapkeys.snapKey	String	临时密钥
snapkeys.name	String	密钥名称
snapkeys.status	String	临时密钥状态：notUsed 未使用；bUsed 已使用；failed 已过期
snapkeys.createUtcTime	String	创建时间（UTC），格式 yyyyMMddTHHmmssZ
snapkeys.createLocalTime	String	创建设备本地时间，格式 yyyyMMddTHHmmssZ
snapkeys.localTime	String	失效或使用时设备本地时间，格式 yyyyMMddTHHmmss
snapkeys.utcTime	String	失效或使用时 UTC 时间，格式 yyyyMMddTHHmmssZ
snapkeys.effectiveNum	String	有效开锁次数上限（仅部分机型返回）
snapkeys.effectTime	String	生效时段明细（仅部分机型返回）
snapkeys.effectPeriod	String	周期生效规则明细（仅部分机型返回）

响应示例

{
 "id":"b8f45dbb-79ad-4a7e-8b24-7eb618c5191f",
 "result":{
 "code":"0",
 "msg":"操作成功",
 "data": {
 "snapkeys":[{
 "keyId":"100",
 "snapKey":"123456",
 "name":"Temporary Key 1",
 "status":"notUsed",
 "createUtcTime":"20170418T162832Z",
 "createLocalTime":"20170418T162832Z",
 "localTime":"20170418T163832",
 "utcTime":"20170418T163832Z",
 "effectiveNum":"3",
 "effectTime":"20170418T080000Z/20170418T200000Z",
 "effectPeriod":"1,2,3,4,5"
 }]
 }
 }
}

错误码

本接口可能返回下列码；完整分组见错误码与能力错误码。

网关与鉴权（SN / TK / OP）

错误码	错误码说明	下一步
`SN1001`	签名校验异常	按 HTTP 开发规范核对 `sign`
`TK1002`	token 无效或过期	重新获取 accessToken
`OP1002`	缺少必填参数	补必填字段
`OP1003`	参数不合法	按本页参数表核对
`OP1009`	权限不足	核对 token 与设备绑定/分享权限
`OP1013`	接口总次数超限	降低调用频率
`OP1014`	接口日限额超限	见接口调用限额
`DV1007`	设备离线	等设备上线

更多见错误码 · OP/SN/TK。

子账号（SUB）

错误码	错误码说明	下一步
`SUB1001`–`SUB1002`	子账号无接口权限	在 addPolicy 中补策略
`SUB1005`	子账号 token 过期	重新 subAccountToken
`SUB1006`	子账号与设备无授权	核对 `Resource` 与设备序列号
`SUB1008`	子账号未绑定应用	先创建并绑定子账号

更多见错误码 · SUB。

设备访问与通道（DV10xx）

错误码	错误码说明	下一步
`DV1007`	设备离线或超时	等设备上线
`DV1009`	设备正忙	稍后重试
`DV1012`	分享/授权设备权限不足	核对子账号 `Permission` / `Resource`
`DV1019`	能力集不支持	确认型号与能力列表
`DV1020`	通道离线	检查通道状态
`DV1026`	不支持此功能	换接口或升级固件
`DV1028`	未绑定或通道不存在	核对 `deviceId` / `channelId`

更多见错误码 · DV。

门锁与门铃（DV10xx）

错误码	错误码说明	下一步
`DV1016`	设备密码错误	核对门锁密码
:---	:---	:---
`DV1038`	低电量无法添加临时密钥	充电后重试
:---	:---	:---
`DV1039`	临时密钥条件不满足	按本页参数说明调整
:---	:---	:---
`DV1050`	临时密钥次数超限	删除旧密钥或等待
:---	:---	:---
`DV1070`	门铃/对讲忙	稍后再接听或挂断