detection.door.keyAdd（密钥添加）

detection.door.keyAdd：密钥添加

detection.door.keyAdd · 设备级 · 权限 Config

功能详情

密钥添加。调一次执行一次。

请求地址

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.service.invoke

最小权限

管理员操作自己绑定的设备不需要权限。操作被分享设备需要基础配置权限。子用户绑定不需要。子账号需要 Config。设备级不要传 channelId。设备和通道写在同一次请求里返回 DV2008。超时不代表未执行。

传入参数说明

参数名	参数类型	是否必填	参数说明
`token`	String	是	管理员、子用户或子账号 accessToken
`deviceId`	String	是	设备序列号
`productId`	String	否	可省略。传了且与该设备实际型号不一致 → `DV2009`
`serviceId`	String	是	`detection.door.keyAdd`
`inputData`	Object	条件	见下表

参数名	说明	类型	必填	取值
`type`	1 密码，2 门卡，3 指纹。	`enum`	是	`1`；`2`；`3`
`cmd`	`1` 开始；`2` 取消	`enum`	是	`1`；`2`

公共请求字段与签名见签名约定与公共请求负载。

样例输入

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345",
 "serviceId": "detection.door.keyAdd",
 "inputData": {
 "type": "1",
 "cmd": "1"
 }
 }
}

返回 data 字段说明

出参在 result.data.outputData。

参数名	说明	类型	必填	取值
`code`	设备侧结果码	`enum`	否	`0`；`1`；`2`

样例输出

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "outputData": {
 "code": "0"
 }
 }
 }
}

错误码

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

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

错误码	错误码说明	下一步
`DV2003`	设备未声明该能力	以 `device.capability.list` 为准
`DV2007`	`channelId` 与 scope 不符	通道级必传，设备级不传
`DV2008`	同请求混用设备级与通道级	拆分请求
`DV2009`	`productId` 与型号不一致	省略或改为实际型号
`DV2011`	无能力权限	见权限码

更多见能力错误码。

门磁