海康云眸 IoT API
    海康云眸 IoT API
    • 产品介绍
    • 能力概览
    • 错误码表
    • 报警类型表
    • 常见问题
    • 示例DEMO
    • 快速入门
      • 接口调用说明
      • 生成授权凭证
        POST
    • 基础服务能力
      • 设备分组管理
        • 新增组
        • 删除组
        • 更新组
        • 获得单个组详情
        • 查询所有节点列表
        • 查找组的下级节点
      • 设备管理
        • 注册设备
        • 注销设备
        • 修改设备名称
        • 获得单个设备信息
        • 获得设备列表
        • 获取设备总数
        • 查询设备状态
      • 设备确权
        • 确权流程说明
        • 下线确认
        • 上线确认
      • 通道管理
        • 查询设备下通道列表
        • 同步设备下通道
        • 修改通道名称
      • 人员管理
        • 添加人员
        • 更新人员信息
        • 删除人员信息
        • 获得单个人员详情
        • 人脸评分标准配置接口
        • 人员人脸更新
        • 人员人脸删除
    • 报警能力管理
      • 获取报警能力列表
        GET
      • 修改报警能力状态
        POST
    • 视频服务能力
      • 视频对接指南
      • 视频参数配置
        • 视频设备码流参数配置指南
        • 接口配置
          • 获取音视频单通道编码能力
          • 获取音视频单通道编码配置
          • 设置音视频单通道编码配置
      • 视频集成方案
        • web视频控件
        • UIKIT
        • 微信小程序
        • 移动端SDK
          • Android
          • IOS
          • 错误码对照表
        • 标准流预览
          • 开通标准流预览功能
          • 获取标准流预览地址
          • 获取预览/回放地址
        • 互动直播间
          • 创建直播间
          • 编辑直播间
          • 删除直播间
          • 查询直播间列表
          • 设置直播间状态
          • 账号充值
      • 设备视频加密
        • 关闭设备视频加密
        • 开启设备视频加密
      • 云台控制
        • 开始云台控制
        • 停止云台控制
        • 3D放大
      • 预置点操作
        • 添加预置点
        • 更新预置点
        • 清除预置点
        • 调用预置点
        • 加载预置点
      • 取流认证
        GET
      • 远程抓图
        POST
    • 门禁服务能力
      • 门禁对接指南
      • 卡片操作
        • 新增卡片
        • 删除卡片
        • 根据人员编号删除卡片
      • 门禁计划
        • 计划模板管理
          • 周计划模板添加/更新
          • 周计划模板获取
          • 周计划模板删除
          • 假日计划模板添加/更新
          • 假日计划模板获取
          • 假日计划模板删除
        • 门禁计划管理
          • 周计划配置
          • 周计划获取
          • 假日计划配置
          • 假日计划获取
          • 假日组计划配置
          • 假日组计划获取
          • 门禁计划配置
          • 门禁计划聚合配置
          • 门禁计划获取
          • 清空门禁计划
      • 权限分组
        • 权限组新增
        • 权限组更新
        • 权限组删除
        • 获取权限组列表
        • 权限组绑定人员
        • 权限组解绑人员
        • 权限组获取人员编号列表
        • 权限组绑定设备
        • 权限组解绑设备
        • 权限组获取设备序列号列表
        • 人员权限信息查询
      • 权限下发
        • 根据权限组下发权限
        • 查询下发失败记录
        • 下发所有失败人员
        • 清空设备本地权限
        • 获取设备能力集
        • 人员权限信息更新
      • 远程控门
        • 远程控门
        • 远程呼梯
      • 可视对讲
        • 设置可视对讲通知地址
        • 可视对讲交互事件通知
        • 获取可视对讲通知地址
      • 人员信息采集
        • 远程采集方式
          • 规则配置
          • 获取规则配置
          • 采集身份证信息
          • 采集卡信息
          • 采集指纹信息
          • 采集人脸信息
          • 获取人脸采集进度
        • 本地采集方式
          • 规则配置
          • 获取规则配置
          • 录入人员信息
          • 查询采集数据
          • 获取采集状态信息
          • 删除全部采集数据
          • 根据人员编号删除采集数据
      • 多重认证
        • 获取群组配置
        • 群组配置
        • 清除群组配置
        • 获取多重认证配置
        • 设置多重认证配置
      • 访客二维码生成
        POST
      • 设备本地事件查询
        GET
    • 边缘人脸服务能力
      • 边缘人脸对接指南
      • 人脸库管理
        • 创建人脸库
        • 删除全部人脸库
        • 删除单个人脸库
        • 获取所有人脸库基本参数
        • 批量设置人脸库基本参数
        • 获取单个人脸库基本参数
        • 设置单个人脸库基本参数
        • 查询人脸库剩余人脸数及磁盘容量
      • 人脸库人脸管理
        • 查询单个人脸库中人脸信息
        • 删除单个人脸库中人脸
      • 人脸下发入库
        • 人脸批量异步下发
        • 查询人脸异步下发任务状态
        • 查询人脸异步下发所有任务状态
        • 人脸下发底图入库状态查询
        • 人脸异步下发任务删除
      • 设置人脸比对参数配置
        • 设置人脸比对参数配置
        • 获取人脸比对参数配置
        • 设置人脸比对/陌生人比对联动配置
      • 客流统计
        • 客流统计参数配置
        • 客流统计参数配置获取
        • 查询客流数据
    • 消息通道
      • 对接指南
      • 消息类型定义
      • 消息通道API
        • 创建消费者
        • 消费消息
        • 提交偏移量
    • 其他设备能力
      • 萤石探测器
        • 获取探测器列表
        • 关联探测器
        • 设置探测器状态
        • 删除探测器
        • 获取可关联的IPC列表
        • 获取已关联的IPC列表
        • 设置探测器与IPC的关联关系
        • 修改探测器名称
        • 一键消警
      • 区域热度
        • 获取区域关注度配置
        • 区域关注度配置
        • 生成热度图
        • 获取热度图
        • 获取热度图配置
        • 设置热度图配置
      • 设备校时
        • 获取设备校时配置
        • 配置设备校时
        • 获取NTP服务器配置
        • 配置NTP服务器
        • 获取指定NTP服务器配置
        • 配置指定NTP服务器参数
      • 萤石云储存
        • 设备开通云存储
        • 开启/关闭云存储
        • 获取设备云存储信息
      • 视频安全帽
        • 设备本地开关权限控制
        • 设备录像开关
        • 设备立即上报按键触发抓图事件
        • 设备立即上报状态信息
        • 设备补光灯开关
        • 设备激光灯开关
      • 报警主机
        • 获取子系统列表
        • 获取防区列表
        • 获取主机状态
        • 获取所有防区状态
        • 子系统布防
        • 子系统撤防
      • 设备布撤防
    • 历史接口
      • 组管理
        • 新增组
        • 修改组
        • 删除组
        • 获取所有组
        • 查找组的下级节点
      • 组管理V2
        • 新增组
        • 修改组
        • 删除组
        • 获取所有组
        • 获取单个组信息
        • 查找组的下级节点
      • 设备管理
        • 注册设备
        • 注销设备
        • 获取设备列表
        • 获取单个设备信息
        • 修改设备名称
        • 获取设备总数
        • 设备布撤防
      • 通道管理
        • 查询设备下通道列表
        • 同步设备下通道
        • 修改通道名称
        • 设备抓图
      • 标准流预览
        • 关闭设备视频加密
        • 开通标准流预览功能
        • 获取标准流预览地址
        • 获取指定有效期标准流预览地址
      • 云台操作
        • 开始云台控制
        • 停止云台控制
        • 添加预置点
        • 调用预置点
        • 清除预置点
      • 门禁管理
        • 门禁管理
          • 人员下发
          • 人员更新
          • 人员查询
          • 人员删除
          • 卡下发
          • 卡更新
          • 卡查询
          • 卡删除
          • 人脸下发
          • 人脸修改
          • 人脸查询
          • 人脸删除
          • 访客二维码生成
          • 远程控门
          • 可视对讲交互事件通知
          • 可视对讲通知地址配置
        • 门禁批量管理
          • 注册人员信息
          • 批量注册人员信息
          • 更新人员信息
          • 查询人员列表
          • 删除人员信息
          • 批量下发
          • 查询任务状态
          • 查询任务详情
        • 门禁计划
          • 计划模板管理
            • 周计划模板添加/更新
            • 周计划模板获取
            • 周计划模板删除
            • 假日计划模板添加/更新
            • 假日计划模板获取
            • 假日计划模板删除
          • 门禁计划管理
            • 周计划配置
            • 周计划获取
            • 假日计划配置
            • 假日计划获取
            • 假日组计划配置
            • 假日组计划获取
            • 门禁计划配置
            • 门禁计划聚合配置
            • 门禁计划获取
            • 清空门禁计划
      • 超脑人脸管理
        • IO管理
          • 获取设备IO端口状态
          • 获取设备指定输出口信息
          • 配置设备指定输出口信息
          • IO输出
        • 人脸管理
          • 删除人脸
          • 查询人脸信息
          • 查询人脸列表
        • 人脸库管理
          • 创建人脸库
          • 查询人脸库容量
          • 删除全部人脸库
          • 删除指定人脸库
          • 查询人脸库基本参数
          • 设置人脸库基本参数
          • 查询指定人脸库基本参数
          • 设置指定人脸库基本参数
          • 查询人脸比对参数
          • 配置人脸比对参数
        • 人员信息管理
          • 注册人员信息
          • 查询人员列表
          • 注销人员信息
        • 获取磁盘基本信息
      • 下发任务管理
        • 下发人脸
        • 任务状态查询
        • 人脸下发状态查询
        • 删除任务
    • 健康码分析能力
      • 健康码识别
      • 行程码识别
      • 核酸报告识别
    • 获取access_token
      POST

    常见问题

    接口调用#

    1.接口返回Http状态码401#

    问题原因:身份认证不通过
    解决办法:
    1.检查接口调用传token的方式是否正确
    2.重新获取token
    3.参考开发指南->接口说明->认证管理
    4.如果是获取token接口返回401,则检查client_id与client_secret是否正确

    2.接口返回Http状态码503、429#

    问题原因:接口调用频率超过限制(默认100次/分钟)
    解决办法:检查是否存在后台运行的程序在调用接口、异常一直重试等情况,确认接口调用频率。

    3.接口返回Http状态码404#

    问题原因:接口路径/请求方式错误
    解决办法:参考接口文档,核对接口路径与请求方式是否正确

    4.接口返回Http状态码301、302#

    问题原因:3XX是客户端错误,301和302为客户端请求重定向
    解决办法:请求协议需为https

    5.接口返回510001参数错误#

    问题原因:参数错误或传参方式不正确
    解决办法:参考接口文档,核对接口入参与传参方式是否正确

    设备管理#

    1.添加设备时返回”设备不在线/设备不存在”#

    问题原因:设备没有正常接入到云端
    解决办法:
    1.检查设备网络链接、配置是否正常
    2.设备需要配置成萤石云接入,配置方式:
    img
    配置若有问题可咨询设备技术支持

    2.添加设备时返回”设备型号不支持”#

    问题原因1:云眸是按照白名单的方式来接入设备的,新增的设备型号需要报备
    解决办法1:联系云眸技术支持报备设备型号
    问题原因2:设备没有向萤石报备该型号
    解决办法2:联系设备技术支持,需要设备产品部门向萤石报备该型号

    3.添加设备时返回”设备已被别人添加”#

    问题原因:设备已经被其他人在云眸平台其他账号下或萤石APP添加过
    解决办法:先将设备在其他账号下删除,再重新添加

    4.添加设备时返回”未开通XXXX服务或接入已达上限”#

    问题原因:用户需要下单购买对应的服务才能接入设备
    解决办法:联系海康分公司销售提交申请单,下单购买对应的服务(视频、客流、人脸、门禁等)

    5.添加设备返回”510207设备添加成功,通道同步失败,请手动同步刷新”#

    问题原因1:未报备的设备型号
    解决办法1:联系云眸技术支持报备设备型号
    问题原因2.同步通道超时,目前同步通道超时时间为20秒
    解决办法2.确认设备网络连接是否正常,并重新调用同步设备通道接口

    6.调用接口返回”设备不存在”#

    问题原因:设备未添加到云眸,或传参错误找不到该设备
    解决办法:通过设备注册接口将设备添加到云眸,检查传参例如设备ID、设备序列号是否正确

    7.调用接口返回”设备不在线”#

    问题原因:网络连接断开或其他原因导致设备网络连接不上
    解决办法:检查设备网络连接、配置情况

    8.调用接口返回”设备响应超时”#

    问题原因:网络连接不稳定或其他原因导致与设备交互命令响应超时,目前设备响应超时时间为15秒
    解决办法:
    1.检查设备网络连接、配置情况
    2.与云眸技术支持确认设备固件版本是否为支持云眸的版本(涉及定制版本的请单独联系分公司销售)

    9.设备查询接口/设备列表页面的设备在线状态与实际情况不符#

    问题原因:开放平台目前的设备在线状态是每小时定时轮询的,不是实时更新的
    解决办法:后续迭代版本会根据设备/通道上下线消息及时更新设备/通道在线状态

    10.接口返回无效数据#

    问题原因:设备/通道ID不存在,可能已被删除
    解决办法:重新获取设备/通道列表,检查设备/通道ID是否正确

    视频集成#

    1.SDK初始化或Web视频控件初始化报错”账号配置异常”、”子账号不存在”#

    问题原因:账号下还未添加设备
    解决办法:先调用设备注册接口添加设备

    2.调用获取标准流预览地址接口返回”地址未绑定”#

    问题原因:每个设备的标准流预览地址均需要开通
    解决办法:调用开通标准流预览功能接口开通该功能

    3.Web视频控件无法预览视频,报错”502012验证码错误”#

    问题原因:海康视频设备默认是开启加密的,使用web视频控件预览视频时需要关闭设备视频加密
    解决办法:调用关闭设备视频加密接口关闭视频加密

    4.视频可以正常预览,回放报错”400036验证码错误”#

    问题原因:NVR/IPC未关闭视频加密
    解决办法:调用接口或在业务平台设备管理页面关闭视频加密

    5.视频预览/回放报错”110031用户没有权限”#

    问题原因:该设备不属于该用户
    解决办法:检查确认该设备是否属于该用户账号,如果是IPC通过NVR接入平台,则NVR必须属于该用户账号

    6.视频预览报错400901#

    问题原因:设备不在线
    解决办法:检查设备网络连接是否正常

    7.Web视频控件预览错误码0#

    问题原因:视频控件未正确初始化
    解决办法:检查接口调用情况,前端代码初始化控件是否正常

    8.SDK Demo、Web视频控件Demo集成错误#

    问题原因:Demo仅供参考,具体接入到项目中还是需要第三方开发者自行开发的
    解决办法:参考Demo的接口调用流程,开发实现自己的业务

    9.SDK集成之后有文件冲突#

    解决办法:删除重复的冲突文件

    10.SDK初始化后无法预览,但是demo是可以正常预览的#

    问题原因:SDK初始化信息不正确
    解决办法:使用正确的账号信息初始化SDK

    11.视频可以正常预览,但是无法回放,报错5405流媒体向设备发送或接受信令超时/cas响应超时#

    问题原因:平台上添加的是IPC,NVR没有添加到平台上
    解决办法:将NVR添加到平台上

    12.视频标准流预览报错视频编码类型非H264#

    问题原因:标准流预览要求设备视频编码类型为H264
    解决办法:登录设备配置视频编码类型为H264
    img

    13.控件预览视频报错525454不支持的码流类型#

    问题原因:预览的视频清晰度与当前设备清晰度不匹配
    解决办法:
    1.在控件上操作切换视频清晰度
    2.初始化视频控件时,videoLevel传0(流畅),也可以设置为-1(默认使用上次设置),流畅也存在设备不支持的情况

    14.视频控件初始化时如何设置清晰度?#

    A:设置初始化参数videoLevel的值,0-流畅 1-均衡 2-高清 3-超清

    15.webDemo中的FireTransFunction是做什么用的#

    A:这个是视频控件的回调接口,用来接收控件的回调事件

    16.视频回放提示没有录像文件#

    A:普通摄像头没有存储能力,需要通过NVR(硬盘录像机)接入平台

    17.标准流预览清晰度为什么很低?#

    A:标准流预览地址有2个,不带hd后缀的为设备子码流,清晰度较低,带hd后缀的为设备主码流,一般清晰度较高,可在设备上配置主子码流的清晰度

    18.视频控件如何设置分屏数?#

    A:修改配置文件C:Program Files (x86)HikCloudViewPluginHikCloudViewPluginchain CloudView.ini中的的参数
    [layout]
    Playback=3(回放)
    Preview=1 (预览)
    1:一分屏 3:4分频 7:9分屏
    暂不支持其他分屏数

    19.视频控件如何实现轮播?#

    A:循环调用播放接口即可

    门禁管理#

    1.门禁事件消息无法上报#

    问题原因:
    1.设备没有上报门禁事件
    2.设备型号未报备
    解决办法:
    1.确认设备版本、网络连接是否正常
    2.如果是的新的设备型号接入,需要联系云眸技术支持报备

    2.下发人脸接口返回512006subpicAnalysisModelingError、pictureModelingFailed建模失败或badParameters参数错误#

    问题原因:图片人脸质量不符合要求
    解决办法:按照要求采集人脸照片
    img

    3.下发人脸接口返回”512006 unknown”#

    问题原因:人脸照片分辨率超过了设备支持的最大分辨率
    解决办法:使用画图软件调整图片分辨率到设备支持的范围内,例如671设备支持最大分辨率为1920*1080,不同型号设备能力不一样,具体参数可咨询设备技术支持

    4.删除人员接口返回512107设备型号不支持#

    问题原因:设备型号未报备
    解决办法:联系云眸技术支持报备设备型号

    5.门禁设备人脸识别成功,但是门没有联动打开#

    1.检查门禁设备与门之间的线路连接是否正常
    2.设备门锁动作时间需要调整为1秒,如果是默认5秒的话,门在5秒之内是不会重复打开的

    6.人员下发接口返回人员下发失败 comparisonTimeRangeError#

    问题原因:validEndTime填的太大了,例如2099年
    解决办法:修改validEndTime参数(例如2029),重试下发

    7.卡下发接口返回卡下发失败 searchDataBaseElementError#

    问题原因:设备数据库被损坏,一般是下发过程中断电导致的
    解决办法:需要将设备恢复出厂设置,重新激活、重新配置

    8.人员下发接口返回人员下发失败beyondARGSRangeLimit#

    问题原因:下发参数错误,部分设备roomNumber字段只支持2位数字,如果传了3位数字例如101就会返回这个错误
    解决办法:修改下发参数,改为floorNumber+roomNumber组合,例如房间号1801则floorNumber为18,roomNumber传1

    9.批量下发接口返回成功,但是查看设备上的人员信息没有记录#

    问题原因:批量下发接口返回成功只表示批量任务创建成功,需要调用查询任务状态接口确定任务已完成,再调用任务详情接口查询详细下发结果。

    10.门禁下发的人员到了有效期会删除么?#

    A:不会删除,验证时会提示过期

    11.注册的设备下发了人脸,当设备注销之后人脸还能识别成功#

    A:目前设备注销接口不会主动删除设备上的人脸信息,需要业务方自行调用接口删除

    消息通道#

    1.消息通道拉取不到消息#

    问题原因:
    1.消息拉取方式不正确,消费者创建之后第一次消费消息时需要建立连接(可能会耗时2-3秒),此时获取到的消息列表是空的
    2.拉取消息的间隔超过30秒,消费者建立连接的有效期是30秒,拉取间隔超过30秒会导致每次拉取时都需要建立连接而实际拉到消息列表是空的
    解决办法:
    1.消费消息的接口多尝试调用几次
    2.消费消息的间隔要在30秒以内
    3.参考消息通道demo(开发指南->消息通道)
    4.联系平台技术支持查看消息是否正确投递

    2.消息通道消费到的消息重复#

    问题原因:偏移量提交不正确
    解决办法:
    1.如果是采用自动提交偏移量的方式,需要保证消费间隔在30秒以内(自动提交偏移量是在下一次请求是提交上一次消费的偏移量),消费到消息之后的消息处理一定要是异步处理的,否则可能会造成间隔超过30秒,产生消息重复的现象
    2.如果是采用手动提交偏移量的方式,需要保证消费到消息之后正确提交偏移量(未消费到消息不可以提交偏移量,可能会造成偏移量被重置)
    3.参考消息通道demo(开发指南->消息通道)
    4.可根据消息的msgID去重

    3.接口返回514006租户未开通消息通道#

    问题原因:消息通道功能需要单独开通
    解决办法:联系云眸技术支持开通消息通道功能

    4.接口返回514004消费者数量已达上限#

    问题原因:创建的消费者数量已经达到上限(5个)
    解决办法:无需每次消费都创建消费者,创建一个之后循环调用消费消息接口即可,消费者5分钟内没有消费会自动删除

    5.消息通道的消息最大保存多久?#

    A:7天

    其他#

    1.设备ID和通道ID是不变的吗?#

    A:设备ID和通道ID是设备添加到平台之后生成的平台唯一标识,只有在设备删除重新添加时会改变,其他情况下不会改变

    2.设备抓图接口返回20006网络异常#

    A:设备网络异常,需要检查设备网络。如果设备网络正常,则需要检查设备版本,较老的版本是不支持云端抓图的

    3.云台控制接口返回”该设备不支持云台控制”#

    A:云台控制本身是设备的能力,一般只有球机、半球机有这个能力,返回该错误则需要考虑更换支持云台控制的设备

    4.IOS拍摄的人脸照片调用人脸评分接口返回人脸质量差#

    A:正常相机拍摄或者安卓手机拍摄,图片的Orientation值(表示图片方向)一般为1或者无该信息,IOS为了保证竖着拍跟横着拍照片看起来效果一样,给竖着拍的照片增加了一个90°的旋转,其Orientation值一般为6(镜像翻转的可能为5),导致图片在编码解码后会出现旋转的现象,而人脸横着的图片是无法解析出来的。

    5.收不到设备报警消息#

    A:如果是在设备报警类型列表中的报警消息(例如区域入侵fielddetection、电瓶车报警leftdetection),按照以下步骤进行检查
    1.检查消息通道权限(登录后,从秘钥管理菜单进入)-设备报警消息是否开启
    2.设备添加成功后,调用布撤防接口进行布防
    如果是不在设备报警类型列表中的报警消息,则需要联系技术支持具体排查

    【海康云眸】API开发者 微信交流群

    用微信扫右侧二维码,加入【海康云眸】API开发者 交流群,互助沟通

    扫码加入交流群
    上一页
    报警类型表
    下一页
    示例DEMO
    Built with