开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
  • API 参考
    • 公共约定
    • HTTP 开发规范
    • accessToken(管理员 Token)
    • API 请求示例
    • 错误码
    • 接口调用限额
    • 账号与授权
    • 设备接口
    • 直播地址
    • 推送配置
    • 云存储
    • 资源池额度管理
    • 旧版接口(不再维护)
      • 门锁(遗留)
        • deleteDoorKey(销毁密钥)
        • doorbellCallAnswer(接听门口机/门铃呼叫)
        • doorbellCallHangUp(挂断门口机/门铃通话)
        • doorbellCallRefuse(拒接门口机/门铃呼叫)
        • generateSnapkey(生成门锁密码)
        • getDevicePowerInfo(查询门锁电量)
        • getDoorKeys(获取密钥列表)
        • getOpenDoorRecord(获取开门记录)
        • getSnapkeyList(获取临时密钥列表)
        • openDoorRemote(远程开门)
        • wakeUpDevice(唤醒休眠门锁)
      • 告警消息(遗留)
      • 设备查询(已弃用)
      • 设备维护(遗留)
      • 设备操作(遗留)
      • 设备使能(遗留)
      • 动检配置(遗留)
      • 收藏点(遗留)
      • 定时巡航(遗留)
      • 本地录像配置(遗留)
      • 音量(遗留)
      • 存储(遗留)
      • 图像与视频(遗留)
      • 时区(遗留)
      • Wi-Fi(遗留)
      • 本地录像查询(遗留)
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
功能说明
请求地址
请求格式
子账号 token 最低权限
请求参数
请求示例
返回 data 字段
响应示例
错误码
相关参考

generateSnapkey(生成门锁密码)

generateSnapkey:生成门锁密码

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

功能说明

为门锁生成临时密码(snapkey)。

请求地址

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

请求格式

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

子账号 token 最低权限

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

请求参数

effectPeriod 可选;省略或传 [] 表示全天有效。数组非空时,每项须包含 period、beginTime、endTime。

参数名参数类型是否必填默认值合法取值参数说明
tokenString是管理员或子账号 accessToken
deviceIdString是门锁设备序列号
nameString是密钥名称
effectiveNumInteger是-1:不限次数有效使用次数
effectiveDayInteger是[1,90]有效天数
effectPeriod.periodString条件必填Monday、Tuesday 等星期枚举,可多选逗号分隔,如 Monday,Wednesday,Friday有效星期;不支持跨天时段需在 beginTime/endTime 内体现
effectPeriod.beginTimeString条件必填时间格式 HH:mm:ss每日生效开始时间
effectPeriod.endTimeString条件必填时间格式 HH:mm:ss,须大于 beginTime每日生效结束时间

请求示例

{
 "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":"At_00000ad9e6e87f0142eb92e207aec46a",
 "name":"key001",
 "effectiveNum":-1,
 "effectiveDay":7,
 "effectPeriod":[
 {
 "period":"Monday",
 "beginTime":"12:00:00",
 "endTime":"18:00:00"
 }
 ]
 }
}

返回 data 字段

字段名字段类型字段说明
keyString设备生成的临时门锁密码/密钥值(非 keyId)
nameString门锁密钥名称

响应示例

{
 "result":{
 "msg":"操作成功.",
 "code":"0",
 "data": {
 "key":"13686275",
 "name":"key001"
 }
 },
 "id":"63d9e876-e223-481c-9886-6386d57556da"
}

错误码

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

网关与鉴权(SN / TK / OP)

错误码错误码说明下一步
SN1001签名校验异常按 HTTP 开发规范 核对 sign
TK1002token 无效或过期重新获取 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门铃/对讲忙稍后再接听或挂断

相关参考

  • 开发规范
  • 公共约定
  • 本模块索引
doorbellCallRefuse(拒接门口机/门铃呼叫)
getDevicePowerInfo(查询门锁电量)