setDeviceSnap（设备抓图）

setDeviceSnap：设备抓图

上一篇：unBindDevice（解绑设备） · 下一篇：setDeviceSnapEnhanced（设备抓图增强） · 设备操作。

功能说明

抓取摄像机当前画面，支持约每 3 秒 1 次的频率。

客户端请求间隔须大于或等于 3 秒。

说明：
建议开发者先结合设备性能压测，再选择抓图接口：
若设备性能较好（约每秒可处理并返回抓图），建议使用 setDeviceSnapEnhanced；
若设备性能较弱（主要为 2017 年前上市机型），建议使用 setDeviceSnap。

请求地址

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

请求格式

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

子账号 token 最低权限

"Permission":"Capture" "Resource":"cam:设备序列号:通道号"

请求参数

参数名	参数类型	是否必填	参数说明
token	String	是	管理员或子账号 accessToken
deviceId	String	是	设备序列号
channelId	String	是	通道号

请求示例

{
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1603369597,
 "nonce":"755263ee-7301-43c9-9d65-464f0febfc80"
 },
 "id":"c8dd3f09-554b-41dc-8616-76889952e24e",
 "params":{
 "deviceId":"TESTQWERXXXX",
 "channelId":"0",
 "token":"At_00000ad9e6e87f0142eb92e207aec46a"
 }
}

返回 data 字段

字段名	字段类型	字段说明
url	String	抓图图片访问地址

响应示例

{
 "result":{
 "msg":"操作成功.",
 "code":"0",
 "data":{
 "url":"https://storage.example.com/snap/7aa3f5dd3bf1436a87ca1828aad382c3.jpg?Expires=1603974670&AccessKeyId=EXAMPLE&Signature=EXAMPLE"
 }
 },
 "id":"c8dd3f09-554b-41dc-8616-76889952e24e"
}

错误码

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

网关与鉴权（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）

错误码	错误码说明	下一步
`DV1010`	抓图过于频繁	降低调用频率
:---	:---	:---
`DV1053`	抓图失败	检查网络与设备在线