文档首页/ 行业视频管理服务 IVM/ API参考/ 设备目标授权配置/ 批量设置通道目标授权状态
更新时间：2024-05-21 GMT+08:00
查看PDF
分享

批量设置通道目标授权状态

功能介绍

批量设置通道受限特性授权状态（如陌生人告警、目标抓拍、目标考勤、目标库管理、目标识别、黑名单、白名单、频次分析），只支持好望设备。调用此接口前需先获得用户的授权同意书（含法律条款内容）。

URI

PUT /v1/{user_id}/devices/{device_id}/channels/targets/authorization

表1 路径参数

参数

是否必选

参数类型

描述

device_id

是

String

设备ID：

好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取

user_id

是

String

用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

是

String

用户认证AccessToken，从获取用户北向接口认证AccessToken中获取
表3 请求Body参数

参数

是否必选

参数类型

描述

state

是

String

授权操作：枚举类型

枚举值：

  • OPENED 开启

  • CLOSED 关闭

channels

是

Array of strings

通道id集合，集合长度范围[1,65]。目前只支持好望设备，通道id取值范围[-1,999]。通道id为-1时代表设备本身，需要同时对设备及通道操作时同时传入-1及通道id。

当授权对象为直连设备时，此参数可填 ["0"]，设备授权状态也是通道授权状态，因此直连设备授权成功响应不返回channels_result——通道执行结果

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

device_id

String

设备ID

device_result

String

设备授权结果：枚举类型

枚举值：

  • 0 成功

  • 1 失败

channels_result

Array of ChannelTargetsAuthResult objects

通道执行结果
表5 ChannelTargetsAuthResult

参数

参数类型

描述

channel_id

String

通道id

channel_result

String

通道授权结果：枚举类型

枚举值：

  • 0 成功

  • 1 失败

请求示例

批量设置通道目标授权状态

PUT /v1/2562572829***/devices/952352LWXT***/channels/targets/authorization

{
       "state":"OPENED",
       "channels":["0"]
}

响应示例

状态码： 200

OK

{
  "device_id" : "952352LWXT***",
  "device_result" : "0",
  "channels_result" : [ {
    "channel_id" : "0",
    "channel_result" : "0"
  } ]
}

状态码

请参见状态码

错误码

请参见错误码

相关文档