文章目录[隐藏]

1 对接指南
2 协议概述
- 2.1 接口
3 编程引导
- 3.1 人脸应用服务
  - 3.1.1 人脸应用解决方案架构
- 3.2 事件服务
  - 3.2.1 事件服务
4 API列表
- 4.1 人脸应用服务
5 附录
6 更新说明
- 6.1 资源目录
  - 6.1.1 人员信息
7 常见问题

1 对接指南

1.1 阅读指南

当前阅读指南适配综合安防管理平台iSecure Center V1.4.100版本，其它版本请参考【历史版本】。
为了能快速了解综合安防管理平台提供的开放能力，快速进行开发，建议按照以下顺序进行阅读：
1.查阅【相关术语】章节，对文档内会出现的专业术语进行初步认知。
2.查阅【快速上手】章节，了解对接的环境要求，开发前准备工作，并能通过示例代码完成接口调用。
3.查阅【协议概述】章节，掌握API的调用方式事件订阅方式。
4.查阅【能力概览】章节，对平台提供的接口有初步认识和理解。
5.阅读【编程引导】章节，通过几个案例的讲解，进一步认识平台提供的能力和实现的应用效果展示。
6.确认需要开发的业务需求，并评估需要使用到的平台提供的API能力。
7.阅读【API列表】章节，按分类查找API，通过阅读API的描述了解具体功能，挑选需要的API。
8.按照API接口定义，编码开发，完成应用的开发。

1.2 相关术语

术语/缩写	含义
OpenAPI	对外开放的接口
iSecure Center	综合安防管理平台
Http Method	http请求的方法，常用的方法有GET/POST/PUT/DELETE等
请求headers（Request Headers）	http请求中的头信息
header	Header即HTTP头域，包括常用头域，请求头域，响应头域和实体头域。它们遵循的是 RFC822[0]3.1节中给出的同一个常用格式。每一个头域由一个名字（域名）跟随一个”:”和域值构成。如Accept:text/plain。
path	http请求路径，指域名/IP（端口号）之后的部分，如请求地址为”www.example.com/artemis/api”，则path指”/artemis/api”
appKeyappSecret	一对appKey/appSecret用于标识一个调用方，appSecret作为密钥参与签名计算
AK	AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。本文中特指appKey
SK	SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。本文中特指appSecret
签名字符串	指待签名计算的字符串
签名	指签名计算的结果，为字符串
mgc	支持标准RTSP/RTMP/HLS取流协议，多线路场景下，做为安全隔离网关，对码流进行中转大路数（200路以上）分发。
RTSP	实时串流协议（Real Time Streaming Protocol，RTSP）是一种网络应用协议，专为娱乐和通信系统的使用，以控制流媒体服务器。该协议用于建立和控制终端之间的媒体会话。媒体服务器的客户端发布VCR命令，例如播放，录制和暂停，以便于实时控制从服务器到客户端（视频点播）或从客户端到服务器（语音录音）的媒体流。
RTMP	实时消息协议（英语：Real-Time Messaging Protocol，缩写RTMP）也称实时消息传输协议，是最初由Macromedia为通过互联网在Flash播放器与一个服务器之间传输流媒体音频、视频和数据而开发的一个专有协议。
HLS	HTTP Live Streaming（缩写是HLS）是一个由苹果公司提出的基于HTTP的流媒体网络传输协议。
RTP	实时传输协议（Real-time Transport Protocol或简写RTP）是一个网络传输协议，它是由IETF的多媒体传输工作小组1996年在RFC 1889中公布的。
STREAMFORM	视频封装格式，将已经编码压缩好的视频轨和音频轨按照一定的格式放到一个文件中。目前支持的有PS封装、TS封装、RTP封装、gb28181封装。

1.3 快速上手

1.3.1 环境准备

对接前需要先部署海康威视综合安防管理平台 iSecure Center V1.1.0或更高版本的产品。产品的安装过程请参考产品的《iSecure Center 综合安防管理平台安装部署指南》，该文档可以在产品安装光盘中获取。

1.3.2 开发前准备

开发前需要先获取对接的身份认证信息，AK/SK；平台会通过AK/SK认证方式来验证请求发送者的身份。
1.进入运管中心（http://ip:8001/center ），进入【状态监控】模块，选择【API网关】，选择【API管理】功能，进入API管理中心。
2.选择【合作方管理】，平台安装后，默认会创建一个对内合作方，可以使用此合作方进行接口调用测试，实际运行环境需要根据实际的情况创建新的合作方。
3.点击合作方的名称，进入合作方详情界面，获取合作方key（AK）和合作方Secret（SK）。
l 注：
1.三方平台如果会运行在不同网域的情况下，每个合作方只能绑定一个网域信息，请务必为调用端分配合适的合作方。
2.如果需要对三方调用平台做权限控制，接口授权控制，需要在【合作方管理】中新建合作方，并进行授权管理，新建的合作方默认没有接口的调用权限，需要配置授权的接口后，才能进行接口调用。
3.如果没有运管中心的登入权限（用户名密码等信息），请联系平台的管理员从API管理中心中获取AK/SK。

1.3.3 对接开发

综合安防管理平台提供了OpenAPI安全认证库（Java、C\+\+）快速实现接口调用。
Java实现接口调用步骤如下：
1.新建Java工程，从Hikvision AI Cloud开放平台网站（）上下载“OpenAPI安全认证库（Java）”，获取artemis-http-client.jar，导入到Java工程中。安全认证库已上传公网仓库，maven依赖坐标：

com.hikvision.ga
artemis-http-client
1.1.2

2.设置认证信息，设置ArtemisConfig的host，appKey(AK)，appSecret(SK)。
3.设置接口URL。
4.设置接口入参。
5.接口调用，调用doPostStringArtemis方法（该方法内部实现了登入认证逻辑），传入接口URL，接口入参，数据提交类型等信息，完成接口调用。
java源码如下：
import com.hikvision.artemis.sdk.ArtemisHttpUtil;
import com.hikvision.artemis.sdk.config.ArtemisConfig;
import java.util.HashMap;
import java.util.Map;

public class GetCameraPreviewURL {

    public static String GetCameraPreviewURL() {

        /**
         * STEP1：设置平台参数，根据实际情况,设置host appkey appsecret 三个参数.
         */
        ArtemisConfig.host = “127.0.0.1:443”; // artemis网关服务器ip端口
        ArtemisConfig.appKey = “29180881”; // 秘钥appkey
        ArtemisConfig.appSecret = “XO0wCAYGi4KV70ybjznx”;// 秘钥appSecret

        /**
         * STEP2：设置OpenAPI接口的上下文
         */
        final String ARTEMIS_PATH = “/artemis”;

        /**
         * STEP3：设置接口的URI地址
         */
        final String previewURLsApi = ARTEMIS_PATH + “/api/video/v1/cameras/previewURLs”;
        Map<string, string=””> path = new HashMap<string, string=””>(2) {
            {
                put(“https://”, previewURLsApi);//根据现场环境部署确认是http还是https
            }
        };

        /**
         * STEP4：设置参数提交方式
         */
        String contentType = “application/json”;

        /**
         * STEP5：组装请求参数
         */
        JSONObject jsonBody = new JSONObject();
        jsonBody.put(“cameraIndexCode”, “748d84750e3a4a5bbad3cd4af9ed5101”);
        jsonBody.put(“streamType”, 0);
        jsonBody.put(“protocol”, “rtsp”);
        jsonBody.put(“transmode”, 1);
        jsonBody.put(“expand”, “streamform=ps”);
        String body = jsonBody.toJSONString();
        /**
         * STEP6：调用接口
         */
        String result = ArtemisHttpUtil.doPostStringArtemis(path, body, null, null, contentType , null);// post请求application/json类型参数
        return result;
    }

    public static void main(String[] args) {
        String result = GetCameraPreviewURL();
        System.out.println(“result结果示例: ” + result);
    }
}
C\+\+实现接口调用步骤如下：
1.新建C\+\+工程，从Hikvision AI Cloud开放平台网站（）上下载“OpenAPI安全认证库（C\+\+）”，获取HttpUtillib\_code，编译生成HttpUtillib静态库、动态库，导入到C++工程中。
2.设置认证信息，设置平台地址，appkey(AK)，appSecret(SK)。
3.设置接口URL。
4.设置接口入参。
5.接口调用，调用HttpPost方法（该方法内部实现了登入认证逻辑），传入接口URL，接口入参，数据提交类型等信息，完成接口调用。
C\+\+源码如下：
#include “iostream”
#include “sstream”

#include “HttpUtillib.h”
#include “HttpHeader.h”

typedef struct Unit_query_s
{
string artemisIp;              //API 网关ip地址（必填）
int artemisPort;               //API 网关Port（必填）
string appKey;                 //API 网关的appKey（必填）
string appSecret;              //API 网关的appSecret（必填）

}Unit_query_t;
/*示例1：（Post）获取当前AppKey的合作方对应监控点列表*/
string FindIndexCodesOfAppKey(Unit_query_t query)
{
std::stringstream ss;
ss << “http://” << query.artemisIp << “:” << query.artemisPort
<< “/artemis/api/resource/v1/camera/advance/cameraList”;
map<string, string=””> headers;
//（必填的Http头）根据期望的Response内容类型设置
headers.insert(std::make_pair(HttpHeader::HTTP_HEADER_ACCEPT, “application/json”));
headers.insert(std::make_pair(HttpHeader::HTTP_HEADER_CONTENT_TYPE, “application/json;charset=UTF-8”));
list signHeaderPrefixList;
char strBody[1024] = { 0 };
sprintf_s(strBody, 1024, “{\”pageNo\”:%d,\”pageSize\”:%d}”, 1, 100);
return HttpPost(ss.str(), headers, strBody, query.appKey, query.appSecret, 30, signHeaderPrefixList);
}

int main()
{

Unit_query_t myQuery;
myQuery.appKey = “26018161”;
myQuery.appSecret = “tdxjiS8bNXZTOf80ymWw”;
myQuery.artemisIp = “x.x.x.x”;
myQuery.artemisPort = 80;

//1 Post
std::string str1 = FindIndexCodesOfAppKey(myQuery);
std::cout << str1 << std::endl << std::endl;

system(“pause”);
return 0;
}

2 协议概述

2.1 接口

2.1.1 接口规则

2.1.1.1 接口规则

接口规则	相关描述
传输方式	仅支持HTTPS传输
URL格式	url格式：https://{hostname}:{port}/artemis/{uri}。 hostname：平台的IP地址或域名。 port：平台的web访问端口。 uri：API的uri，每个API都有唯一的uri，详见API的接口定义。举例：https://127.0.0.1:443/artemis/api/xxxxx 注释： ip:port为平台web页面访问地址，如果还不清楚请参考： ISC产品的运管中心–集群代理服务cluster–监控详情/服务器参数–nginx https 监听端口如果有多线路配置，需参考：ISC产品的运管中心–系统维护–参数配置/多线路配置–集群代理服务
提交方式	采用POST方法提交
数据格式	提交和返回数据都为JSON格式
字符编码	统一采用UTF-8字符编码
安全认证	提供了基于AK/SK的安全认证方案。只有认证通过，才能正常访问每一个API。详见调用认证
权限控制	每一个API都需要被授权。调用未被授权的API会提示错误。
返回值	详见公共返回码

2.1.2 调用认证

2.1.2.1 调用认证

2.1.2.1.1 AK\SK摘要认证

OpenAPI皆可以使用AK\SK认证鉴权，AK\SK摘要认证方案如下。
>Headers示例：
Accept:*/*
Content-MD5: rwhJZnJMC/1h25ITjEz5gA==
Content-Type:application/json
Date: Fri Feb 01 10:22:21 CST 2019
X-Ca-Key:29666671
X-Ca-Signature:XeBEg2Ifh+FOfeProHLMYz8luWkJ00Exx7N7tJuats8=
X-Ca-Signature-Headers: x-ca-key
Headers需要包含Accept，Content-MD5，Content-Type，Date，X-Ca-Key，X-Ca-Signature，X-Ca-Signature-Headers
Accept ：默认值为\*/\*。
Content-MD5 设置值：MD5计算body的信息摘要，对信息摘要使用BASE64生成Conten-MD5字符串，示例：encoderBase64(MD5(body.getBytes(“UTF-8”)))//其中body就是请求调用接口时的json参数；此项为非必填项。
Content-Type：默认值为application/json
Date：当前时间，格式不做要求，示例中为JAVA时间格式。
X-Ca-Key：appKey，即AK。
X-Ca-Signature：签名，以appSecret（即SK）为密钥，使用HmacSHA256算法对签名字符串生成消息摘要，对消息摘要使用BASE64算法生成签名（签名过程中的编码方式全为UTF-8），公式如下：
X-Ca-Signature=BASE64(HmacSHA256(appSecret,”UTF-8″(httpHeaders + customHeaders + url));
X-Ca-Signature-Headers：默认值为x-ca-key，注意必须是全小写字母。
签名字符串由httpHeaders(指http标准header)、customHeaders（指自定义header）、url组成。
l 1. httpHeaders组成说明为：
httpHeaders = HTTP METHOD + “\n”
+ Accept +”\n”
+ Content-MD5 + “\n”
+ Content-Type + “\n”
+ Date + “\n”
注：HTTP METHOD为大写，如 “POST”。
l 2. 自定义customHeaders 组成说明：
customHeaders = “x-ca-key” + “:” + appKey + “\n”；
l 3. url是相对路径，如示例中的加粗部分：
l http://www.example.com /artemis/api/example?qa=a&qb=B
完整例子如下：
URL:http://www.example.com/artemis/api/example?qa=a&qb=B>

Http Method:POST

Headers

Accept:*/*

Accept-Encoding:gzip, deflate, sdch

Accept-Language:zh-CN,zh;q=0.8

Connection:keep-alive

Content-Length:0

Content-Type:application/json

Content-MD5:rwhJZnJMC/1h25ITjEz5gA==

Date: Fri Feb 01 10:22:21 CST 2019

Cookie:JSESSIONID=D9C4A515CACAC31211D1612039D062B7

X-Ca-Key:29666671

X-Ca-Signature:XeBEg2Ifh+FOfeProHLMYz8luWkJ00Exx7N7tJuats8=

X-Ca-Signature-Headers: x-ca-key
计算前的签名字符串：
POST\n

*/*\n

rwhJZnJMC/1h25ITjEz5gA==\n

application/json \n

Fri Feb 01 10:22:21 CST 2019\n

x-ca-key:29666671\n

/artemis/api/example?qa=a&qb=B
计算后的签名：
XeBEg2Ifh+FOfeProHLMYz8luWkJ00Exx7N7tJuats8=

2.1.2.1.2 access_token认证

OpenAPI还可以使用access_token认证鉴权，access_token认证方案如下。
1.调用【获取API网关接口调用token】接口，获取返回参数access_token，access_token默认有效期为12小时。

2.1.2.1.2.1 获取API网关接口调用token

l 接口说明
获取API网关接口调用token，无入参。
此接口使用AK\\SK摘要认证方式。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.4及以上版本
l 接口版本
v1
l 接口地址
/api/v1/oauth/token
l 请求方法
POST
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	True	状态码，0代表成功，其它参考公共返回码
msg	string	True	返回信息
data	object	False	返回数据
+access_token	string	True	token值，可作为header入参“access_token”调用其它OpenAPI接口
+token_type	string	True	token类型，bearer：合作方token
+expires_in	number	True	token过期时间，单位：秒

l 返回参数举例
{
    “code”: “0”,
    “msg”: “success”,
    “data”: {
        “access_token”: “eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJzY29wZSJdLCJleHAiOjE1NzM1NjkxNjYsImp0aSI6ImQ2MWFmMGVlLWUzYjctNGNlNi04ZTM0LWQwM2M1ZGU5MzUyYSIsImNsaWVudF9pZCI6IjI5MzQwNzQ1In0.zKRgeUk5JJvh-c4D-y69enRFsej1DKGwL24yeXOuVGc”,
        “token_type”: “bearer”,
        “expires_in”: 43199
    }
}

2.请求其它OpenAPI时，在header中添加入参，key为“access_token”，value为【获取API网关接口调用token】接口返回参数access_token的值，即可通过认证。

2.1.3 返回值规则

2.1.3.1 返回值规则

对于API接口调用返回的结果统一采用json格式，内容字段采用驼峰式方法命名,返回的接口内容格式如下：
{
“code”: //返回
“msg”: //返回信息
“data”: //返回详细数据
}
成功调用举例如下
{
“code”: “0”,
“msg”: “SUCCESS”,
“data”: {
“streamURL”: “rtsp: //10.2.145.66:655/EUrl/CLJ52BW”
}
}
失败调用举例如下
{
“code”: “0x02401006”,//错误码，参照错误码列表
“msg”: “Token Exception.”,
“data”: “”
}
图片数据，直接返回二进制流信息
单条数据返回格式
{
“code”: “0”,
“msg”: “返回的错误信息，方便对接和调试，不能有堆栈信息”,
“data”: {
“userId”: “xxxxxx”,
“name”: “xxxxxx”,
…
}
}
分页查询返回格式
{
    “code”:”0″,
    “msg”:”返回的错误信息，方便对接和调试，不能有堆栈信息”,
    “data”:{
        “total”:5, //总条数
        “pageSize”:20, //当前分页记录数
        “pageNo”: 1, //当前页
        “list”: [{ //分页内容
            “userId”: xxxxxx,
            “name”: “xxxxxx”,
                   …
            },{
            “userId”: xxxxxx,
            “name”: “xxxxxx”,
                      …
        }]
    }
}
无分页的批量数据返回格式
{
    “code”:”0″,
    “msg”:”返回的错误信息，方便对接和调试，不能有堆栈信息”,
    “data”:{
    “total”:5,
    “list”: [{
        “userId”: xxxxxx,
        “name”: “xxxxxx”,
                  …
        },{
        “userId”: xxxxxx,
        “name”: “xxxxxx”,
                 …
            }]
     }
}

2.1.4 公共返回码

2.1.4.1 公共返回码

l 1. API网关返回错误

返回码	错误分类及错误原因	消除建议
0x02400001	系统内部异常	1.查看artemis服务系统日志；2.未看出明显问题，研发人员进行排查。
0x02400004	调用提供方服务接口异常	1.查看artemis服务系统日志；2.未看出明显问题，研发人员进行排查。
0x02401000	APPKey为空	请求中填写正确的APP Key
0x02401001	APPKey对应的合作方不存在	请求中填写正确的APP Key
0x02401002	签名为空	请求中填写正确的签名信息
0x02401003	签名不正确	请求中填写正确的签名信息
0x02401004	API令牌的身份验证失败	检查token是否填写正确
0x02401005	API令牌为空	检查token是否填写正确
0x02401006	API令牌异常	检查token是否填写正确
0x02401007	API令牌过期	重新获取token
0x02401008	API接口未授权	向API接口管理员申请接口访问权限
0x02401009	权限验证异常	检查API网关服务是否异常
0x0240100a	参数转换异常，具体错误见异常信息	检查API接口参数是否正确,检查合作方参数是否都已配置
0x0240100b	API接口调用次数受限	向API接口管理员申请增加接口访问次数
0x0240100c	接口调用统计异常	重启网关服务
0x02400004	服务调用异常	检查服务提供方是否正常
0x0240101b	合作方IP受限	在合作方允许的IP段内调用
0x0240101c	合作方MAC受限	使用合作方允许的MAC调用
0x0240101d	合作方IP、MAC受限	在合作方允许的IP段、MAC白名单内进行调用
0x02401021	解析请求JSON数据异常	检查请求的数据是否为JSON数据
0x02401022	解析返回JSON数据异常	检查接口返回数据是否为JSON数据
0x02401023	不支持的请求编码字符集	检查请求方的字符编码集是否合法

返回码	错误分类及错误原因	消除建议
0x00072001	必填参数为空	请求中填写必要的参数
0x00072002	参数范围不正确	请求中参数范围填写不正确
0x00072003	参数格式不正确	请求中参数格式填写不正确
0x00072004	返回报文过长	请求中设置合适的分页大小
0x00072005	参数不存在	请求中改写为支持的参数
0x00072006	参数内容过长	请求中将参数内容长度缩小

l 3. 内部服务

返回码	错误分类及错误原因	消除建议
0x00052101	服务性能已达上限	请稍后重试
0x00052102	服务出错	请稍后重试
0x00052103	服务响应超时	请稍后重试
0x00052104	服务不可用	待服务修复后重试

l 4. 资源访问

返回码	错误分类及错误原因	消除建议
0x00072201	资源访问未授权	向资源管理员申请资源访问权限
0x00072202	资源不存在	请求中填写正确的资源编号
0x00072203	license数量受限	向管理员核对license信息
0x00072204	license未提供该功能	向管理员核对license信息

l 5. 其他错误

返回码	错误分类及错误原因	消除建议
0x00052301	其他未知的错误

3 编程引导

3.1 人脸应用服务

3.1.1 人脸应用解决方案架构

3.1.1.1 准备事项

>1. 安装iSee构架产品
>2. 按需安装artemis、frs、uis 组件
>3. 参考ISC帮助手册，配置好所需业务（添加好资源，添加好人脸，配置好识别计划等）

3.1.1.2 人脸应用能力

能力	子能力	OpenAPI接口	编程引导
人脸资源	查询	【按条件查询识别资源】
人脸应用	人脸分组	【人脸分组1VN检索】
	人脸图片	【人脸图片1V1比对】【人脸服务图片下载】【人脸评分】【以图搜图】
	人脸事件	【按条件查询人脸抓拍事件】【按条件查询重点人员事件】【按条件查询陌生人事件】【按条件查询高频人员识别事件】	重点人员识别计划
人脸管理	人脸分组	【单个添加人脸分组】【删除人脸分组】【单个修改人脸分组】【按条件查询人脸分组】	人脸分组创建与人脸录入
	人脸图片	【单个添加人脸】【批量添加人脸】【批量删除人脸】【单个修改人脸】【按条件批量查询人脸】【获取人脸及分组关联关系】【批量拷贝人脸到人脸分组】	人脸分组创建与人脸录入
计划管理	重点人员识别计划	【单个添加重点人员识别计划】【删除重点人员识别计划】【单个修改重点人员识别计划】【单个查询重点人员识别计划详情】【查询重点人员识别计划】【重新下发重点人员识别计划】	重点人员识别计划
	陌生人识别计划	【单个添加陌生人识别计划】【删除陌生人识别计划】【单个修改陌生人识别计划】【单个查询陌生人识别计划详情】【查询陌生人识别计划】【重新下发陌生人识别计划】	陌生人识别计划
	抓拍计划	【抓拍计划配置】

l 下述接口详见
* 人脸资源
* 人脸应用
* 人脸管理

3.1.1.3 准备事项

* 识别资源准备，用户在简单设备管理页面添加一台在线的脸谱或者超脑。
*ASW服务已经安装，并配置有至少一个静态资源池和一个动态资源池。
* 平台内所有的组件运作正常。
图片存储位置配置
1. 打开人脸监控应用服务的配置页面，页面上关于图片存储位置配置有两项，分别是人脸照片存储位置和人脸抓拍图片存储位置。
2. 选择已配置好的资源池作为人脸照片的存储位置，该资源池是静态资源池，不覆盖。
3. 选择已配置好的资源池作为人脸抓拍图片的存储位置，该资源池是动态资源池，能覆盖。
4. 保存成功后流程结束。

3.1.1.4 重点人员识别计划

3.1.1.4.1 人脸分组创建与人脸录入

Step1：调用接口【单个添加人脸分组】创建一个分组
Step2：向分组中添加人脸
将人脸添加到人脸分组提供了三种方式
1. 添加人脸及人员信息到人脸分组
人脸信息可以直接调用【单个添加人脸】接口
2. 将平台人员管理系统里的人员信息批量添加到人脸分组
可以调用【批量添加人脸】接口
2. 将其他分组内的照片copy到新的分组
可以调用【批量拷贝人脸到人脸分组】接口
注释：
人脸分组，还提供了查询，修改，删除的能力，接口如下
【按条件查询人脸分组】，【单个修改人脸分组】，【删除人脸分组】
分组里的人脸也提供了查询，修改，删除的能力，接口如下
【按条件批量查询人脸】，【单个修改人脸】，【按条件批量查询人脸】

3.1.1.4.2 重点人员识别计划配置

调用【单个添加重点人员识别计划】接口，实现重点人员识别，后续如果有重点人员进入相机范围内，会上报重点人脸识别事件。
可以通过事件订阅的方式收到事件。
识别计划如果下发失败，或出现异常可以调用【重新下发重点人员识别计划】接口，重新下发。
后期可以根据自己的情况进行查询，修改或删除。

3.1.1.5 陌生人识别计划

流程参考重点人脸识别计划，接口替换为陌生人识别计划相关接口即可。

3.1.1.6 接口调用建议

【批量拷贝人脸到人脸分组】，【单个修改人脸】接口
编程建议：使用上无限制，但是建议用户平台做过转换后串行调用，并发数建议不要超过10，并发线程内串行调用。
所以建议，三方如果客户端比较多的场景，不建议直接通过客户端来调用，可以在三方服务做一个请求缓存，后台异步调用接口。
【以图搜图】
编程建议：串行访问，一次一个请求。
【人脸图片1V1比对】，【人脸分组1VN检索】
编程建议：项目中有几台人脸设备并发数就是几，每个并发线程串行访问。

3.2 事件服务

3.2.1 事件服务

3.2.1.1 事件服务能力

能力	子能力	OpenAPI接口	编程引导
事件	事件订阅	【按事件类型订阅事件】【查询事件订阅信息】【按事件类型取消订阅】	事件订阅
	事件联动	【获取联动事件列表】	事件联动

**下述接口详见**事件服务

3.2.1.2 事件服务

3.2.1.2.1 事件订阅

事件订阅场景
1. 首先第三方指定事件类型订阅事件。
2. 设备触发事件上报到指定MQ，事件服务接收到事件后推送给已经订阅该事件的第三方。
3. 第三方接收到事件异步去处理事件。

3.2.1.3 事件联动

3.2.1.3.1 获取联动事件列表

获取联动事件列表
1. 调用【查询区域列表v2】接口获取区域编号。
2. 调用【获取联动事件列表】接口将区域编号、时间、分页等参数进行过滤查询，得到结果。

4 API列表

4.1 人脸应用服务

4.1.1 人脸资源

4.1.1.1 按条件查询识别资源

l 接口说明
a)根据条件，查询识别资源。
b)该接口和识别计划配置有关，识别计划配置时需要选择识别资源，通过该接口查询。
c)查询接口之间的关系为与，若不传任何条件，为查询全部的识别资源。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/resource/recognition
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCodes	string[]	False	通过indexCode集合查询指定的识别资源集合
name	string	False	识别资源名称模糊查询
recognitionResourceType	string	False	根据识别资源的类型搜索，SUPER_BRAIN 超脑，FACE_RECOGNITION_SERVER 脸谱，COMPARISON 深眸

l 请求参数举例
{
    “indexCodes”: [
        “7cc0adb2-a3c3-48fd-b432-718103e85c28”
    ],
    “name”: “脸谱”,
    “recognitionResourceType”: “COMPARISON”
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object[]	False	识别资源的集合
+indexCode	string	False	识别计划的唯一标识
+name	string	False	识别计划的名称
+recognitionResourceType	string	False	识别计划的类型，SUPER_BRAIN 超脑，FACE_RECOGNITION_SERVER 脸谱，COMPARISON 深眸

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: [
        {
            “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
            “name”: “这是一台深眸”,
            “recognitionResourceType”: “COMPARISON”
        }
    ]
}

4.1.2 人脸应用

4.1.2.1 人脸分组

4.1.2.1.1 人脸分组1VN检索

l 接口说明
a)1VN人脸分组检索是将任意人脸图片与人脸分组中的人脸照片进行比对，以确认是人脸分组中的哪一个人。
b)检索的人脸分组必须配置有识别计划，否则将无法进行检索。
c)检索出来的结果是分页的集合，单个识别资源最多可以检索100条记录。
d)必须指定搜图的分组范围，且最多可以在16个分组内搜索。
e)图片格式仅支持JPG，图片大小为128B到4M。
f)注：支持设备：sdk超脑、脸谱、智能应用服务器。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/application/oneToMany
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
pageNo	number	True	分页查询条件，页码，为空时，等价于1，页码不能小于1
pageSize	number	True	分页查询条件，页尺，为空时，等价于1000，页尺不能小于1或大于1000
searchNum	number	False	指定单个识别资源最大搜索张数，最大值为100，为空时，等价于100
minSimilarity	number	True	指定检索的最小相似度，最小为1，最大为100
facePicUrl	string	False	用于检索的图片，要求URL可以通过POST方式直接下载，该参数与facePicBinaryData至少有一个存在，都存在时优先使用facePicBinaryData
facePicBinaryData	string	False	用于检索的图片的二进制数据Base64编码后的字符串，该参数与facePicUrl至少有一个存在，都存在时优先使用facePicBinaryData
faceGroupIndexCodes	string[]	True	人脸分组唯一标志，指定检索的人脸分组范围,，可从按条件查询人脸分组获取
name	string	False	人脸名称模糊查询
sex	string	False	人脸的性别信息， 1-男性，2-女性，UNKNOWN-未知
certificateType	string	False	人脸的证件类别，111-身份证，OTHER-其它证件
certificateNum	string	False	人脸的证件号码模糊查询

l 请求参数举例
{
    “pageNo”: 1,
    “pageSize”: 20,
    “searchNum”: 99,
    “minSimilarity”: 50,
    “facePicUrl”: “http://10.21.22.115:6120/pic?7dd43=sb6-z67194163f7=11i5m*ep”,
    “facePicBinaryData”: “/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ..”,
    “faceGroupIndexCodes”: [
        “string”
    ],
    “name”: “张”,
    “sex”: “1”,
    “certificateType”: “1”,
    “certificateNum”: “4202041996051”
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object	False	从人脸分组中检索的分页结果
+total	number	False	结果总数
+pageNo	number	False	当前页
+pageSize	number	False	每页记录数
+list	object[]	False	1VN识别结果
++similarity	number	False	该人脸和上传人脸的相似度
++indexCode	string	False	人脸的唯一标识是
++faceInfo	object	False	人脸信息对象
+++name	string	False	人脸的名称,1~32个字符；不能包含 ‘ / : ? ” < >
+++sex	string	False	人脸的性别信息， 1-男性，2-女性，UNKNOWN-未知
+++certificateType	string	False	人脸的证件类别，111-身份证，OTHER-其它证件
+++certificateNum	string	False	人脸的证件号码信息。1~20个数字、字母。
++facePic	object	False	人脸图片对象
+++faceUrl	string	False	查询返回时，为绝对路径

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: {
        “total”: 500,
        “pageNo”: 1,
        “pageSize”: 10,
        “list”: [
            {
                “similarity”: 80,
                “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
                “faceInfo”: {
                    “name”: “张三”,
                    “sex”: “1”,
                    “certificateType”: “111”,
                    “certificateNum”: “420204199605121656”
                },
                “facePic”: {
                    “faceUrl”: “http://10.166.165.121:8080/frs/facepicturetemp/test.jpg”
                }
            }
        ]
    }
}

4.1.2.2 人脸图片

4.1.2.2.1 人脸图片1V1比对

l 接口说明
a)将两张人脸图片进行比对，并得到两者的相似度。
b)应用举例：将抓拍图片同身份证件上的人脸照片进行比对，以确认是否为同一个人。
c)图片格式仅支持JPG，图片大小为128B到4M。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/application/oneToOne
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
srcFacePicBinaryData	string	False	用于比较的人脸抓拍图片的二进制数据经过Base64编码后的字符串，该参数与srcFacePicUrl至少有一个存在，都存在时优先使用srcFacePicBinaryData。
srcFacePicUrl	string	False	用于比较的人脸抓拍图片，要求URL可以通过GET方式直接下载，该参数与srcFacePicBinaryData至少有一个存在，都存在时优先使用srcFacePicBinaryData。
distFacePicBinaryData	string	False	用于比较的人脸图片的二进制数据经过Base64编码后的字符串，该参数与distFacePicUrl至少有一个存在，都存在时优先使用distFacePicBinaryData。
distFacePicUrl	string	False	用于比较的人脸图片，要求URL可以通过GET方式直接下载，该参数与distFacePicBinaryData至少有一个存在，都存在时优先使用distFacePicBinaryData。

l 请求参数举例
{
    “srcFacePicBinaryData”: “/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ..”,
    “srcFacePicUrl”: “http://10.21.22.115:6120/pic?7dd43=sb6-z67194163f7=11i5m*epdt=*4pdi=*1s=i1b4i6d03*918a05cf2-88d032–6733588i273*e7ic5=”,
    “distFacePicBinaryData”: “/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ..”,
    “distFacePicUrl”: “http://10.21.22.115:6120/pic?7dd43=sb6-z67194163f7=11i5m*epdt=*4pdi=*1s=i1b4i6d03*918a05cf2-88d032–6733588i273*e7ic5=”
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object	False	1V1人脸图片比对结果
+similarity	string	False	两张人脸图片的相似度值

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: {
        “similarity”: “80”
    }
}

4.1.2.2.2 人脸服务图片下载

l 接口说明
a)通过调用图片下载接口将URL或URI转换成二进制图片流。
b)该接口适用于调用方的场景无法独立从URL获取图片。
c)接口支持传递URL或URI。人脸监控应用服务会自行判断如何获取图片，其中URI的方式要求图片必须在ASW服务上。
d)当传入的图片url是超脑上的图片时会返回图片base64编码，其他情况均返回重定向地址。
e)若接口会返回HTTP状态码302，此时调用方需要去重定向的目标URL下载图片；若接口返回HTTP状态码200，此时接口返回图片base64编码。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/application/picture
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
url	string	True	图片的URL或URI

l 请求参数举例
{
“url”: “http://10.67.184.149:80/picture/Streaming/tracks/203/?name=ch0002”
}
l 成功返回值
当传入的图片url是超脑上的图片时会返回图片base64编码，其他情况均返回302重定向地址。图片的重定向地址在header中的Location可以获取到。
l 成功返回参数举例
HTTP/1.1 302
Cache-Control: no-cache
Pragma: no-cache
expires: Wed, 31 Dec 1969 23:59:59 GMT
Location: http://ip:port/pic?6dd45=s6e-z19ac448e83458–1c51dc52c7cbfi8b3*=sd*=7dpi*=1dpi*m1i1t=-e390d706i049*e1i53=aaa&AccessKeyId=1DhNvwKMfIRodi5E&Expires=1538103300&Signature=ntjOpWW0JcAdJjE4tbYpBAmn5rk=
Content-Length: 0
Date: Fri, 28 Sep 2018 01:55:00 GMT
l 失败返回参数

参数名称	数据类型	参数描述	是否必须	备注
code	String	返回码	是	失败错误码，具体见错误码章节
msg	String	返回描述	是	记录接口执行情况说明信息
data	Object	返回数据	否

l 失败返回参数举例
{
“code”: “0x00072202”,
“data”: “null”,
“msg”: “Invalid Resource.(Detail: input aswSyscode’s target serviceInfo not found!)”
}

4.1.2.2.3 人脸评分

l 接口说明
a) 传入一张人脸图片，检测人脸图片是否合格，注意，人脸评分是检测人脸质量的辅助手段，只有人脸评分失败（返回错误码0x1f913016）时才认为是人脸图片不合格，其它情况如调用超时等情况，图片只是未检测，不能作为人脸不可用的依据。
b) 注：此接口需要额外授权
c)图片格式仅支持JPG，图片大小为128B到4M。
d)当返回字段对应的值为空时，该字段不返回。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.3及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/face/picture/check
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
facePicBinaryData	string	False	人脸图片的二进制数据经过 Base64 编码后的字符串，该参数与 f acePicUrl 至少有一个存在，都存在时优先使用此参数
facePicUrl	string	False	人脸图片url ，要求 URL 可以通过 GET 方式直接下载，该参数与 facePicBinaryData 至少有一个存在

l 请求参数举例
{
“facePicUrl”: “http://10.21.22.115:6120/pic?7dd43=sb6-z67194163f7=11i5m*epdt=*4pdi=*1s=i1b4i6d03*918a05cf2-88d032–6733588i273*e7ic5=s”
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5 人脸监控错误码
msg	string	False	返回描述
data	object	False	返回结果
+checkResult	boolean	False	人脸图片检测结果，true-评分合格 false-评分不合格
+statusCode	string	False	评分失败详细错误码， 0x1f902300-人脸检测错误（图片格式不符合要求、检测不到人脸等情况时） 0x1f902301-人脸检测超时 0x1f902303-图片两眼间距过小 0x1f902304-图片彩色置信度过低 0x1f902305-图片人脸角度过大 0x1f902306-图片清晰度过低 0x1f902307-图片过曝或过暗（灰阶值不符合要求） 0x1f902308-图片遮挡严重 0x1f902309-图片分数过低
+statusMessage	string	False	评分失败详情描述
+faceScore	number	False	人脸评分，范围： 1-100
+facePicAnalysisResult	object	False	评分成功后的人脸信息，用于人脸裁剪
++id	number	False	序号
++age	number	False	年龄
++ageRange	number	False	年龄偏差值
++ageGroup	string	False	年龄段，参考附录A.34 设备年龄段类型
++gender	string	False	性别，male-男性，female-女性，UNKNOWN-未知
++glasses	string	False	是否戴眼镜，YES-是， NO-否，UNKNOWN-未知
++smile	string	False	是否微笑，YES-是， NO-否，UNKNOWN-未知
++facePose	object	False	人脸角度信息
+++pitch	number	False	平面外上下俯仰角，范围：[-90,90]
+++yaw	number	False	平面外左右偏转角，范围：[-90,90]
+++roll	number	False	平面内旋转角，范围：[-90,90]
+++clearityScore	number	False	清晰度评分,范围：[0,1]
+++colorConfidence	number	False	彩色置信度,范围：[0,1]
+++eyeDistance	number	False	两眼间距,真实像素值
+++grayMean	number	False	灰阶均值,范围：[0,255]
+++visibleScore	number	False	可见度评分,范围：[0,1]
++targetModelData	string	False	目标数据模型
++faceRect	object	False	图片中人脸框区域
+++height	double	False	高度
+++width	number	False	宽度
+++x	number	False	X坐标
+++y	number	False	Y坐标
++recommendFaceRect	object	False	人脸区域推荐位置
+++height	number	False	高度
+++width	number	False	宽度
+++x	number	False	X坐标
+++y	number	False	Y坐标
++faceMark	object	False	图片中人脸特征位置
+++leftEye	object	False	左眼位置
++++x	number	False	X坐标
++++y	number	False	Y坐标
+++rightEye	object	False	右眼位置
++++x	number	False	X坐标
++++y	number	False	Y坐标
+++noseTip	object	False	鼻尖位置
++++x	number	False	X坐标
++++y	number	False	Y坐标
+++leftMouth	object	False	左嘴角位置
++++x	number	False	X坐标
++++y	number	False	Y坐标
+++rightMouth	object	False	右嘴角位置
++++x	number	False	X坐标
++++y	number	False	Y坐标
++beard	string	False	是否大胡子，是否微笑，YES-是， NO-否，UNKNOWN-未知
++mask	string	False	是否戴口罩，是否微笑，YES-是， NO-否，UNKNOWN-未知
++faceScore	number	False	人脸评分，范围： [0,100]

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success”,
    “data”: {
        “checkResult”: true,
        “statusCode”: “”,
        “statusMessage”: “”,
        “faceScore”: 90,
        “facePicAnalysisResult”: {
            “id”: 5566,
            “age”: 16,
            “ageRange”: 1,
            “ageGroup”: “TEENAGER”,
            “gender”: “male”,
            “glasses”: “NO”,
            “smile”: “NO”,
            “facePose”: {
                “pitch”: 45,
                “yaw”: 25,
                “roll”: 10,
                “clearityScore”: 0.5,
                “colorConfidence”: 0.5,
                “eyeDistance”: 300,
                “grayMean”: 120,
                “visibleScore”: 0.5
            },
            “targetModelData”: “DD”,
            “faceRect”: {
                “height”: 12.1,
                “width”: 16,
                “x”: 15,
                “y”: 3
            },
            “recommendFaceRect”: {
                “height”: 4,
                “width”: 6,
                “x”: 2,
                “y”: 1
            },
            “faceMark”: {
                “leftEye”: {
                    “x”: 33,
                    “y”: 22
                },
                “rightEye”: {
                    “x”: 44,
                    “y”: 33
                },
                “noseTip”: {
                    “x”: 43,
                    “y”: 12
                },
                “leftMouth”: {
                    “x”: 32,
                    “y”: 54
                },
                “rightMouth”: {
                    “x”: 67,
                    “y”: 12
                }
            },
            “beard”: “NO”,
            “mask”: “NO”,
            “faceScore”: 90
        }
    }
}

4.1.2.2.4 以图搜图

l 接口说明
a)通过人脸图片和检索条件，检索超脑、脸谱抓拍库或智能应用服务器中符合条件的记录。
b)以图搜图的前提是智能应用服务配置有或者曾经配置过识别计划。
c)如果要通过cameraIndexCode搜索，请保证搜索的通道有配置或配置过超脑、脸谱或智能应用服务器的识别计划。
d)检索出来的结果是分页的集合，为识别计划所关联的每个设备上的符合条件的前100条数据的集合
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/application/captureSearch
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
pageNo	number	False	分页查询条件，页码，为空时，等价于1，页码不能小于1
pageSize	number	False	分页查询条件，页尺，为空时，等价于1000，页尺不能小于1或大于1000
facePicBinaryData	string	False	用于搜图的图片的二进制数据经过Base64编码后的字符串，该参数与facePicUrl至少有一个存在，都存在时优先使用facePicBinaryData
facePicUrl	string	False	用于搜图的图片的URL，要求URL可以通过GET方式直接下载，该参数与facePicBinaryData至少有一个存在，都存在时优先使用facePicBinaryData
cameraIndexCodes	string[]	False	抓拍到人脸的抓拍机的唯一标识，若为空，则搜索全部的抓拍机
searchNum	number	False	指定每个监控点搜索张数的最大值，最大值为100，为空时，等价于100
startTime	string	True	指定搜图的开始时间，要求遵守ISO8601标准
endTime	string	True	指定搜图的结束时间，要求遵守ISO8601标准，且必须在startTime之后
minSimilarity	number	True	指定搜图的最小相似度，最小为1，最大为100
maxSimilarity	number	False	指定搜图的最大相似度，最小为1，最大为100
age	number	False	年龄，不小于 0
ageGroup	string	False	指定查询的年龄段，参考附录A.34 设备年龄段类型
sex	string	False	性别，male-男性，female-女性，UNKNOWN-未知
withGlass	string	False	是否戴眼镜，YES-是， NO-否，UNKNOWN-未知
smile	string	False	是否微笑，YES-是， NO-否，UNKNOWN-未知
isEthnic	string	False	是否是少数民族，YES-是， NO-否，UNKNOWN-未知

l 请求参数举例
{
    “pageNo”: 1,
    “pageSize”: 20,
    “facePicBinaryData”: “/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ..”,
    “facePicUrl”: “http://10.21.22.115:6120/pic?7dd43=sb6-z67194163f7=11i5m*epdt=*4pdi=*1s=i1b4i6d03*918a05cf2-88d032–6733588i273*e7ic5=”,
    “cameraIndexCodes”: [
        “7cc0adb2-a3c3-48fd-b432-718103e85c28”
    ],
    “searchNum”: 50,
    “startTime”: “2004-05-03T17:30:08.000+08:00”,
    “endTime”: “2004-06-03T17:30:08.000+08:00”,
    “minSimilarity”: 50,
    “maxSimilarity”: 90,
    “age”: 20,
    “ageGroup”: “YOUNG”,
    “sex”: “male”,
    “withGlass”: “YES”,
    “smile”: “NO”,
    “isEthnic”: “YES”
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object	False	以图搜图结果分页信息
+total	number	False	结果总数
+pageNo	number	False	当前页数
+pageSize	number	False	每页结果数
+list	object[]	False	人脸检索结果
++cameraIndexCode	string	False	抓拍到人脸的通道的唯一标识
++captureTime	string	False	抓拍到人脸的绝对时标，遵守ISO8601标准
++sex	string	False	抓拍到的人脸的性别，1-男性，2-女性，UNKNOWN-未知
++ageGroup	string	False	抓拍到的人脸年龄段，参考附录A.34 设备年龄段类型
++withGlass	string	False	抓拍到的人脸是否戴眼镜
++similarity	string	False	抓拍到的人脸和上传人脸的相似度
++bkgPicUrl	string	False	抓拍到的人脸的背景图片
++facePicUrl	string	False	抓拍到的人脸的人脸图片，注：若是超脑抓拍图，facePicUrl与bkgPicUrl相同，都是背景图片，需要使用rect坐标字段进行人脸抠图
++rect	string	False	超脑抓拍图的坐标，rect里面四个数字，依次是height，width，x，y。可用于人脸抠图。

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: {
        “total”: 500,
        “pageNo”: 1,
        “pageSize”: 10,
        “list”: [
            {
                “cameraIndexCode”: “21000000000323”,
                “captureTime”: “2004-05-03T17:30:08.000+08:00”,
                “sex”: “1”,
                “ageGroup”: “string”,
                “withGlass”: “NO”,
                “similarity”: “80”,
                “bkgPicUrl”: “http://10.33.47.14:6120/pic?7dd43=sb6-z67194163f7=11i5m*epdt=*4pdi=*1s=i1b4i6d03*918a05cf2-88d032–6733588i273*e7ic5=”,
                “facePicUrl”: “http://10.33.47.14:6120/pic?7dd43=sb6-z67194163f7=11i5m*epdt=*4pdi=*1s=i1b4i6d03*918a05cf2-88d032–6733588i273*e7ic5=”,
                “rect”: “0.086,0.048,0.238,0.731”
            }
        ]
    }
}

4.1.2.3 人脸事件

4.1.2.3.1 按条件查询人脸抓拍事件

l 接口说明
a)按条件查询人脸抓拍事件。
b)检索出来的结果是分页的集合，分页参数由接口参数传入。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.3及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/event/face_capture/search
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
pageNo	number	False	分页查询条件，页码，为空时，等价于1，页码不能小于1
pageSize	number	False	分页查询条件，页尺，为空时，等价于1000，页尺不能小于1或大于1000
startTime	string	True	指定查询的开始时间，要求遵守ISO8601标准，yyyy-MM-ddTHH:mm:ss.SSS+当前时区，例如北京时间： 2018-07-26T15:00:00.000+08:00，且必须在endTime之前
endTime	string	True	指定查询的结束时间，要求遵守ISO8601标准，yyyy-MM-ddTHH:mm:ss.SSS+当前时区，例如北京时间： 2018-07-26T15:00:00.000+08:00，且必须在startTime之后
cameraIndexCodes	string[]	False	监控点唯一标志集合，若不指定，则查询所有的监控点
age	string[]	False	指定查询的年龄段，参考附录A.34 设备年龄段类型
gender	string	False	定查询的性别，male-男，female-女
glass	string	False	指定查询是否戴眼镜， yes是， no否

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object	False	返回数据
+total	number	False	结果总数
+pageNo	number	False	当前页
+pageSize	number	False	每页记录数
+list	object[]	False	查询结果集
++eventTime	string	False	事件时间,遵守ISO8601标准，yyyy-MM-ddTHH:mm:ss.SSS+当前时区，例如北京时间：2018-07-26T15:00:00.000+08:00
++gender	string	False	性别，male-男，female-女
++age	string	False	年龄段，参考附录A.34 设备年龄段类型
++glass	string	False	指定查询是否戴眼镜， yes 是， no 否
++cameraIndexcode	string	False	监控点唯一标识
++cameraName	string	False	监控点名称
++bkgUrl	string	False	抓拍背景图
++snapUrl	string	False	抓拍小图

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success”,
    “data”: {
        “total”: 500,
        “pageNo”: 1,
        “pageSize”: 20,
        “list”: [
            {
                “eventTime”: “2018-07-26T15:00:00.000+08:00”,
                “gender”: “male”,
                “age”: “child”,
                “glass”: “yes “,
                “cameraIndexcode”: “282c954b564045a59353f6441bbbbf76”,
                “cameraName”: “监控点名称”,
                “bkgUrl”: “http://10.19.132.9:6040/pic?=d32i791e*9dbi99b-a24aeb–193f28a84d4c8ifb1*=sd*=0dpi*=1d7i3t1pe*m5i14=89ba-28zad1s=439cd1”,
                “snapUrl”: “http://10.19.132.9:6040/pic?=d72i794e*9dbi99b-a24aeb–193f28a84d4c8ifb1*=sd*=0dpi*=1d6i3t1pe*m5i14=89ba-28zad1s=337cd3”
            }
        ]
    }
}

4.1.2.3.2 按条件查询重点人员事件

l 接口说明
a)按条件查询重点人员事件。
b)检索出来的结果是分页的集合，分页参数由接口参数传入。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.3及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/event/black/search
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
pageNo	number	False	分页查询条件，页码，为空时，等价于1，页码不能小于1
pageSize	number	False	分页查询条件，页尺，为空时，等价于1000，页尺不能小于1或大于1000
startTime	string	True	指定查询的开始时间，要求遵守ISO8601标准，yyyy-MM-ddTHH:mm:ss.SSS+当前时区，例如北京时间： 2018-07-26T15:00:00.000+08:00，且必须在endTime之前
endTime	string	True	指定查询的结束时间，要求遵守ISO8601标准，yyyy-MM-ddTHH:mm:ss.SSS+当前时区，例如北京时间： 2018-07-26T15:00:00.000+08:00，且必须在startTime之后
cameraIndexCodes	string[]	False	监控点唯一标志集合，若不指定，则查询所有的监控点
similarity	number	True	指定查询的最小相似度, 最小为1，最大为100
name	string	False	指定查询的人员姓名
certificateType	string	False	指定查询的证件类型，ID-身份证，otherId-其他证件
certificateNumber	string	False	指定查询的证件号码
age	string[]	False	指定查询的年龄段，参考附录A.34 设备年龄段类型
gender	string	False	定查询的性别，male-男，female-女
glass	string	False	指定查询是否戴眼镜， yes是， no否
faceGroupIndexcodes	string[]	False	指定查询的所属人脸分组集合，不指定则查询所有的人脸分组
orderType	string	False	排序字段。结果查询排序字段，0时间，1相似度，排序支持倒序排序，默认按照时间倒叙排序

l 请求参数举例
{
    “pageNo”: 1,
    “pageSize”: 20,
    “startTime”: “2019-05-03T17:30:08.000+08:00”,
    “endTime”: “2019-05-03T17:30:08.000+08:00”,
    “cameraIndexCodes”: [
        “7cc0adb2-a3c3-48fd-b432-718103e85c28”
    ],
    “similarity”: 80,
    “name”: “张三”,
    “certificateType”: “ID”,
    “certificateNumber”: “1234567890”,
    “age”: [
        “young”
    ],
    “gender”: “female”,
    “glass”: “yes”,
    “faceGroupIndexcodes”: [
        “07022922-5950-47cf-a349-c228f92d2e41”
    ],
    “orderType”: “0”
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object	False	返回数据
+total	number	False	结果总数
+pageNo	number	False	当前页
+pageSize	number	False	每页记录数
+list	object[]	False	查询结果集
++snapInfo	object	False	重点人员事件抓拍信息
+++bkgUrl	string	False	抓拍背景图
+++snapUrl	string	False	抓拍小图
+++deviceIndexcode	string	False	设备唯一标识
+++deviceName	string	False	设备名称
+++cameraIndexcode	string	False	监控点唯一标识
+++cameraName	string	False	监控点名称
+++gender	string	False	性别，male-男，female-女
+++age	string	False	年龄段，参考附录A.34 设备年龄段类型
+++glass	string	False	指定查询是否戴眼镜， yes 是， no 否
+++eventTime	string	False	事件时间,遵守ISO8601标准，yyyy-MM-ddTHH:mm:ss.SSS+当前时区，例如北京时间：2018-07-26T15:00:00.000+08:00
++targetInfoList	object[]	False	重点人员事件目标图信息集
+++name	string	False	姓名
+++similarity	string	False	相似度
+++certificateType	string	False	证件类型，111-身份证，OTHER-其他证件
+++sex	string	False	性别，1-男，2-女，UNKNOWN-未知
+++certificateNumber	string	False	证件号
+++faceInfoIndexcode	string	False	人脸唯一标识
+++faceGroupIndexcode	string	False	人脸分组唯一标识
+++faceGroupName	string	False	人脸分组名称
+++faceUrl	string	False	人脸图片url

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success”,
    “data”: {
        “total”: 500,
        “pageNo”: 1,
        “pageSize”: 20,
        “list”: [
            {
                “snapInfo”: {
                    “bkgUrl”: “http://10.19.132.9:6040/pic?=d3=0dpi*=1d7i3t1pe*m5i14=89ba-28zad1s=439cd1”,
                    “snapUrl”: “http://10.19.132.9:6040/pic?=d72i794e*9dbi99b-a24aeb–193f24c8ifb1*=sd*pe*m5i14=89ba-28zad1s=337cd3”,
                    “deviceIndexcode”: “e973dc5f76c443c2ad6f404b679d39d5”,
                    “deviceName”: “设备名称”,
                    “cameraIndexcode”: “282c954b564045a59353f6441bbbbf76”,
                    “cameraName”: “监控点名称”,
                    “gender”: “male”,
                    “age”: “young\t”,
                    “glass”: “yes”,
                    “eventTime”: “2018-07-26T15:00:00.000+08:00”
                },
                “targetInfoList”: [
                    {
                        “name”: “张三”,
                        “similarity”: “6”,
                        “certificateType”: “ID”,
                        “sex”: “male”,
                        “certificateNumber”: “1234567890”,
                        “faceInfoIndexcode”: “624cfb31-16bd-4747-afb1-a9468ff9a441”,
                        “faceGroupIndexcode”: “e8997392-a969-429c-acee-8879d6eff3b1”,
                        “faceGroupName”: “人脸分组名称”,
                        “faceUrl”: “http://10.33.47.14:6120/pic?8dd195ic3-e*9da4818ab115m4ep=t =d1s*i=d1b*i8d4d*8af2fc914- -03ebd05zb97s=8i94=”
                    }
                ]
            }
        ]
    }
}

4.1.2.3.3 按条件查询陌生人事件

l 接口说明
a)按条件查询陌生人员事件。
b)检索出来的结果是分页的集合，分页参数由接口参数传入。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.3及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/event/stranger/search
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
pageNo	number	False	分页查询条件，页码，为空时，等价于1，页码不能小于1
pageSize	number	False	分页查询条件，页尺，为空时，等价于1000，页尺不能小于1或大于1000
startTime	string	True	指定查询的开始时间，要求遵守ISO8601标准，yyyy-MM-ddTHH:mm:ss.SSS+当前时区，例如北京时间： 2018-07-26T15:00:00.000+08:00，且必须在endTime之前
endTime	string	True	指定查询的结束时间，要求遵守ISO8601标准，yyyy-MM-ddTHH:mm:ss.SSS+当前时区，例如北京时间： 2018-07-26T15:00:00.000+08:00，且必须在startTime之后
cameraIndexCodes	string[]	False	监控点唯一标志集合，若不指定，则查询所有的监控点
age	string[]	False	指定查询的年龄段，参考附录A.34 设备年龄段类型
gender	string	False	定查询的性别，male-男，female-女
glass	string	False	指定查询是否戴眼镜， yes是 no否

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object	False	返回数据
+total	number	False	结果总数
+pageNo	number	False	当前页
+pageSize	number	False	每页记录数
+list	object[]	False	查询结果集
++eventTime	string	False	事件时间,遵守ISO8601标准，yyyy-MM-ddTHH:mm:ss.SSS+当前时区，例如北京时间：2018-07-26T15:00:00.000+08:00
++gender	string	False	定查询的性别，male-男，female-女
++age	string	False	年龄段，参考附录A.34 设备年龄段类型
++glass	string	False	指定查询是否戴眼镜， yes，是 no 否
++deviceIndexcode	string	False	设备唯一标识
++deviceName	string	False	设备名称
++cameraIndexcode	string	False	监控点唯一标识
++cameraName	string	False	监控点名称
++bkgUrl	string	False	抓拍背景图
++snapUrl	string	False	抓拍小图

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success”,
    “data”: {
        “total”: 500,
        “pageNo”: 1,
        “pageSize”: 20,
        “list”: [
            {
                “eventTime”: “2018-07-26T15:00:00.000+08:00”,
                “gender”: “male”,
                “age”: “young”,
                “glass”: “yes”,
                “deviceIndexcode”: “e973dc5f76c443c2ad6f404b679d39d5”,
                “deviceName”: “设备名称”,
                “cameraIndexcode”: “282c954b564045a59353f6441bbbbf76”,
                “cameraName”: “监控点名称”,
                “bkgUrl”: “http://10.19.132.9:6040/pic?=d32i791e*9dbi99b-a24aeb–193f28a84d4c8ifb1*=sd*=0dpi*=1d7i3t1pe*m5i14=89ba-28zad1s=439cd1”,
                “snapUrl”: “http://10.19.132.9:6040/pic?=d72i794e*9dbi99b-a24aeb–193f28a84d4c8ifb1*=sd*=0dpi*=1d6i3t1pe*m5i14=89ba-28zad1s=337cd3”
            }
        ]
    }
}

4.1.2.3.4 按条件查询高频人员识别事件

l 接口说明
a)按条件查询高频人员识别事件。
b)检索出来的结果是分页的集合，分页参数由接口参数传入。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.3及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/event/high_frequency/search
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
pageNo	number	False	分页查询条件，页码，为空时，等价于1，页码不能小于1
pageSize	number	False	分页查询条件，页尺，为空时，等价于1000，页尺不能小于1或大于1000
startTime	string	True	指定查询的开始时间，要求遵守ISO8601标准，yyyy-MM-ddTHH:mm:ss.SSS+当前时区，例如北京时间： 2018-07-26T15:00:00.000+08:00，且必须在endTime之前
endTime	string	True	指定查询的结束时间，要求遵守ISO8601标准，yyyy-MM-ddTHH:mm:ss.SSS+当前时区，例如北京时间： 2018-07-26T15:00:00.000+08:00，且必须在startTime之后
occurrences	number	False	出现次数
orderType	number	False	排序字段。结果查询排序字段，0时间，1出现次数，排序只支持倒序排序，默认按照时间倒叙排序
cameraIndexCodes	string[]	False	监控点唯一标志集合，若不指定，则查询所有的监控点

l 请求参数举例
{
    “pageNo”: 1,
    “pageSize”: 20,
    “startTime”: “2019-05-03T17:30:08.000+08:00”,
    “endTime”: “2019-05-03T17:30:08.000+08:00”,
    “occurrences”: 1,
    “orderType”: 1,
    “cameraIndexCodes”: [
        “7cc0adb2-a3c3-48fd-b432-718103e85c28”
    ]
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object	False	返回数据
+total	number	False	结果总数
+pageNo	number	False	当前页
+pageSize	number	False	每页记录数
+list	object[]	False	查询结果集
++eventTime	string	False	事件时间,遵守ISO8601标准，yyyy-MM-ddTHH:mm:ss.SSS+当前时区，例如北京时间：2018-07-26T15:00:00.000+08:00
++cameraIndexcode	string	False	监控点唯一标识
++cameraName	string	False	监控点名称
++occurrences	number	False	出现次数
++bkgUrl	string	False	抓拍背景图
++snapUrl	string	False	抓拍小图

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success”,
    “data”: {
        “total”: 500,
        “pageNo”: 1,
        “pageSize”: 20,
        “list”: [
            {
                “eventTime”: “2018-07-26T15:00:00.000+08:00”,
                “cameraIndexcode”: “282c954b564045a59353f6441bbbbf76”,
                “cameraName”: “监控点名称”,
                “occurrences”: 10,
                “bkgUrl”: “http://10.40.241.123:80/picture/Streaming/tracks/203/?name=ch0002_00000000392072087500800173743&size=173743”,
                “snapUrl”: “http://10.40.241.123:80/picture/Streaming/tracks/203/?name=ch0002_00000000392072104960000606711&size=606711”
            }
        ]
    }
}

4.1.3 人脸管理

4.1.3.1 人脸分组管理

4.1.3.1.1 单个添加人脸分组

l 接口说明
一次性添加一个人脸分组，返回结果为添加成功的人脸分组。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/face/group/single/addition
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
name	string	False	人脸分组的名称，1~32个字符；不能包含 ‘ / : ? ” < >
description	string	False	分组的描述，1~128个字符

l 请求参数举例
{
“name”: “仓库值守人员”,
“description”: “仓库值守人员是指守着仓库的人”
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述,描述错误码的原因
data	object	False	人脸分组信息
+indexCode	string	False	人脸分组的唯一标识,由人脸监控应用服务生成
+name	string	False	人脸分组的名称,人脸分组的名称是唯一的
+description	string	False	人脸分组的描述

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success”,
    “data”: {
        “indexCode”: “5dc82633-a4cb-4107-b55e-f21bbdf952f9”,
        “name”: “仓库值守人员”,
        “description”: “仓库值守人员是指守着仓库的人”
    }
}

4.1.3.1.2 删除人脸分组

l 接口说明
a)根据删除条件，删除一批人脸分组,最大1000个，返回的data为布尔类型，true代表操作成功，false代表操作失败。
b)已经配置有识别计划的人脸分组，不允许删除，由特定错误码标识。
c)根据唯一标识删除时，会校验唯一标识的有效性，若任意分组唯一标识无效，则返回错误。传入的唯一标识重复，做去重处理。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/face/group/batch/deletion
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCodes	string[]	True	分组的唯一标识，可从按条件查询人脸分组获取

l 请求参数举例
{
    “indexCodes”: [
        “5dc82633-a4cb-4107-b55e-f21bbdf952f9”
    ]
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述,描述错误码的原因
data	boolean	False	删除是否成功,true：成功,false：失败

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success”,
    “data”: true
}

4.1.3.1.3 单个修改人脸分组

l 接口说明
a)修改单个人脸分组，返回的data为布尔类型，true代表操作成功，false代表操作失败。
b)修改后的字段信息以修改时传入的字段为准，若不传字段或传入null字段，则该字段会被置为null。
c)若该人脸分组已经被配置到识别计划中，则修改人脸分组后，会将修改后的信息，一并下发到设备上。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/face/group/single/update
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCode	string	True	人脸分组的唯一标识，可从按条件查询人脸分组获取
name	string	True	人脸分组的名称，1~32个字符；不能包含 ‘ / : ? ” < >
description	string	True	分组的描述，1~128个字符

l 请求参数举例
{
    “indexCode”: “5dc82633-a4cb-4107-b55e-f21bbdf952f9”,
    “name”: “仓库值守人员”,
    “description”: “仓库值守人员是指守着仓库的人”
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	boolean	False	修改是否成功,true成功,false：失败

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success”,
    “data”: true
}

4.1.3.1.4 按条件查询人脸分组

l 接口说明
a)根据查询条件，查询人脸分组集合。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/face/group
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCodes	string[]	False	通过唯一标识集合查询指定的人脸分组集合
name	string	False	人脸分组名称模糊查询

l 请求参数举例
{
    “indexCodes”: [
        “5dc82633-a4cb-4107-b55e-f21bbdf952f9”
    ],
    “name”: “仓库值守”
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object[]	False	人脸分组集合
+indexCode	string	False	人脸分组的唯一标识,由人脸监控应用服务生成
+name	string	False	人脸分组的名称,人脸分组的名称是唯一的
+description	string	False	人脸分组的描述

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success”,
    “data”: [
        {
            “indexCode”: “5dc82633-a4cb-4107-b55e-f21bbdf952f9”,
            “name”: “仓库值守人员”,
            “description”: “仓库值守人员是指守着仓库的人”
        }
    ]
}

4.1.3.2 人脸信息管理

4.1.3.2.1 单个添加人脸

l 接口说明
a)一次性添加一张人脸，返回结果为添加成功的人脸。
b)添加的人脸图片，目前支持URL方式和二进制数据方式。URL方式时，人脸监控应用服务会通过HTTP协议的GET方式下载图片，校验图片，最后重新上传图片；二进制数据是指图片的字节流经过Base64编码后得到的字符串。
c)该URL能通过HTTP协议的GET方式能下载获取到即可，若包含认证，由调用方在URL中加上认证信息，保证URL能成功访问。
d)人脸监控应用服务会根据图片存储位置配置，将图片上传到图片存储服务器中，返回的URL为图片存储服务器上的相对地址。
e)图片大小和格式均有要求，上传大小在10KB到200KB见的图片，上传JPG格式的图片。
f)若添加的人脸对应的人脸分组已经配置有识别计划，则新添加的人脸会被一并下发到设备上。
g)该接口依赖于图片存储位置已配置完，请确保平台已经配置有人脸图片存储位置，否则添加必定失败。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/face/single/addition
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
faceGroupIndexCode	string	True	指定人脸添加到的人脸分组的唯一标识,人脸监控应用服务会校验该值的有效性，可从按条件查询人脸分组获取
faceInfo	object	True	人脸信息对象
+name	string	True	人脸的名称,1~32个字符；不能包含 ‘ / : ? ” < >
+sex	string	False	人脸的性别信息， 1-男性，2-女性，UNKNOWN-未知
+certificateType	string	False	人脸的证件类别，111-身份证，OTHER-其它证件
+certificateNum	string	False	人脸的证件号码信。1~20个数字、字母。
facePic	object	True	人脸图片对象
+faceUrl	string	False	人脸图片的URL。和faceBinaryData不能同时为空，同时存在时优先取faceBinaryData；图片的大小范围在10KB到200KB之间，只支持JGP格式图片。
+faceBinaryData	string	False	人脸图片的二进制数据经过Base64编码后的字符串，和faceUrl不能同时为空，同时存在时优先取faceBinaryData。图片的大小范围在10KB到200KB之间，只支持JGP格式图片。

l 请求参数举例
{
    “faceGroupIndexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
    “faceInfo”: {
        “name”: “张三”,
        “sex”: “1”,
        “certificateType”: “111”,
        “certificateNum”: “420204199605121656”
    },
    “facePic”: {
        “faceUrl”: “http://10.166.165.121:8080/frs/facepicturetemp/test.jpg”
    }
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object	False	添加成功的人脸
+indexCode	string	False	人脸的唯一标识
+faceGroupIndexCode	string	False	人脸所属的人脸分组的唯一标识
+faceInfo	object	False	人脸信息
++name	string	False	人脸的名称,1~32个字符；不能包含 ‘ / : ? ” < >
++sex	string	False	人脸的性别信息， 1-男性，2-女性，UNKNOWN-未知
++certificateType	string	False	人脸的证件类别，111-身份证，OTHER-其它证件
++certificateNum	string	False	人脸的证件号码信息。1~20个数字、字母
+facePic	object	False	人脸的图片信息
++faceUrl	string	False	人脸图片的URL

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success”,
    “data”: {
        “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
        “faceGroupIndexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
        “faceInfo”: {
            “name”: “张三”,
            “sex”: “1”,
            “certificateType”: “111”,
            “certificateNum”: “420204199605121656”
        },
        “facePic”: {
            “faceUrl”: “/pic?=d8ei1a5i94d7*971-1994ea–0c7e13895f9b8i4b1*=*d8d1i”
        }
    }
}

4.1.3.2.2 批量添加人脸

l 接口说明
>a)本接口只支持将安保基础数据中人员的人脸图片导入到人脸监控的人脸分组中。
b)一次性添加一批人脸，添加结果由接口同步返回成功还是失败。
c)一次最多导入1000个人脸。
d)若添加的人脸对应的人脸分组已经配置有识别计划，则新添加的人脸会被一并下发到设备上。
e)入参和单个添加人脸的接口不相同，批量接口只需要传入安保基础数据人员indexCode和要加入的人脸分组indexCode。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/face/batch/addition
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
Array[0]	object	True	添加的人脸的集合
+indexCode	string	True	人脸唯一标识，单次批量添加操作，不允许重复。
+faceGroupIndexCode	string	True	指定人脸添加到的人脸分组的唯一标识, 人脸监控应用会校验该值的有效性，可从按条件查询人脸分组获取

l 请求参数举例
[
    {
        “indexCode”: “5dc82633-a4cb-4107-b55e-f21bbdf952f9”,
        “faceGroupIndexCode”: “5dc82633-a4cb-4107-b55e-f21bbdf952f6”
    }
]
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	boolean	False	添加是否成功,true：成功,false：失败

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: true
}

4.1.3.2.3 批量删除人脸

l 接口说明
a)根据人脸删除条件删除一批人脸，返回的data为布尔类型，true代表操作成功，false代表操作失败。
b)若删除的人脸对应的人脸分组已经配置有识别计划，则删除的人脸会被一并从设备上删除。
c)该接口是从指定分组内删除指定人脸。
d)人脸分组唯一标识和人脸的唯一标识集合均不能为空。
e)一次性最多从一个分组内删除1000个人脸。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/face/deletion
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCodes	string[]	True	人脸的唯一标识集合，可从按条件批量查询人脸获取
faceGroupIndexCode	string	True	人脸分组的唯一标识，可从按条件查询人脸分组获取

l 请求参数举例
{
    “indexCodes”: [
        “5dc82633-a4cb-4107-b55e-f21bbdf952f9”
    ],
    “faceGroupIndexCode”: “5dc82633-a4cb-4107-b55e-f21bbdf952f6”
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	boolean	False	删除是否成功,true：成功,false：失败

l 返回参数举例
{
    “code”: “0”,
    “msg”: “batch delete face success.”,
    “data”: true
}

4.1.3.2.4 单个修改人脸

l 接口说明
a)修改单张人脸信息,返回的data为布尔类型，true代表操作成功，false代表操作失败。
b)若修改的人脸对应的人脸分组已经配置有识别计划，则修改后的人脸会被重新下发到设备上。
c)修改后的字段信息以修改时传入的字段为准，若不传字段或传入null字段，则该字段会被置为null。
d)如果要修改人脸信息，则需要传递faceInfo对象。
e)如果要修改人脸图片，则需要传递facePic对象。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/face/single/update
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCode	string	True	人脸的唯一标识，可从按条件批量查询人脸获取
faceInfo	object	False	人脸信息
+name	string	True	人脸的名称,1~32个字符；不能包含 ‘ / : ? ” < >
++sex	string	False	人脸的性别信息， 1-男性，2-女性，UNKNOWN-未知
++certificateType	string	False	人脸的证件类别，111-身份证，OTHER-其它证件
+certificateNum	string	False	人脸的证件号码信息。1~20个数字、字母
facePic	object	False	人脸图片
+faceBinaryData	string	False	人脸图片的二进制数据经过Base64编码后的字符串。和faceUrl不能同时为空，同时存在时优先取faceBinaryData，图片的大小范围在10KB到200KB之间，只支持JGP格式图片。
+faceUrl	string	False	人脸图片的URL。和faceBinaryData不能同时为空，同时存在时优先取faceBinaryData，图片的大小范围在10KB到200KB之间，只支持JGP格式图片。

l 请求参数举例
{
“indexCode” : “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
“faceInfo” : {
    “name” : “张三”,
    “sex” : “1”,
    “certificateType” : “111”,
    “certificateNum” : “420204199605121656”
},
“facePic” : {
    “faceUrl” : “http://10.166.165.121:8080/frs/facepicturetemp/test.jpg”
  }
}

l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	boolean	False	修改是否成功,true：成功,false：失败

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: true
}

4.1.3.2.5 按条件批量查询人脸

l 接口说明
a)根据查询条件，批量查询人脸信息，一次性最多查询1000条人脸。
b)查询条件之间的关系为与，即所有条件同时生效。
c)可以通过传入faceGroupIndexCode，查询指定人脸分组下的人脸。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/face
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
certificateNum	string	False	人脸的证件号码模糊查询
certificateType	string	False	人脸的证件类型搜索
faceGroupIndexCode	string	False	根据人脸所属的分组搜索该分组下符合条件的人脸
indexCodes	string[]	False	通过人脸的唯一标识集合查询指定的人脸集合
name	string	False	人脸名称模糊查询
pageNo	number	False	分页查询条件，页码，为空时，等价于1，页码不能小于1或大于1000
pageSize	number	False	分页查询条件，页尺，为空时，等价于1000，页尺不能小于1或大于1000
sex	string	False	性别搜索,1代表男性、2代表女性、unknown代表未知

l 请求参数举例
{
    “certificateNum”: “4202041996051”,
    “certificateType”: “1”,
    “faceGroupIndexCode”: “5dc82633-a4cb-4107-b55e-f21bbdf952f9”,
    “indexCodes”: [
        “5dc82633-a4cb-4107-b55e-f21bbdf952f9”
    ],
    “name”: “张”,
    “pageNo”: 1,
    “pageSize”: 20,
    “sex”: “1”
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object	False	查询到的人脸分页对象
+total	number	False	结果总数
+pageNo	number	False	当前页
+pageSize	number	False	每页记录数
+list	object[]	False	人脸
++indexCode	string	False	人脸的唯一标识
++faceGroupIndexCode	string	False	人脸所属的人脸分组的唯一标识
++faceInfo	object	False	人脸信息
+++name	string	False	人脸的名称,1~32个字符；不能包含 ‘ / : ? ” < >
+++sex	string	False	人脸的性别信息， 1-男性，2-女性，unknown-未知
+++certificateType	string	False	人脸的证件类别，111-身份证，OTHER-其它证件
+++certificateNum	string	False	人脸的证件号码信息。1~20个数字、字母
++facePic	object	False	人脸的图片信息
+++faceUrl	string	False	人脸图片的URL，查询返回时，为绝对路径

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success”,
    “data”: {
        “total”: 500,
        “pageNo”: 1,
        “pageSize”: 10,
        “list”: [
            {
                “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
                “faceGroupIndexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
                “faceInfo”: {
                    “name”: “张三”,
                    “sex”: “1”,
                    “certificateType”: “1”,
                    “certificateNum”: “420204199605121656”
                },
                “facePic”: {
                    “faceUrl”: “http://10.166.165.121:8080/frs/facepicturetemp/test.jpg”
                }
            }
        ]
    }
}

4.1.3.2.6 获取人脸及分组关联关系

l 接口说明
a)已经配置了一条或多条识别计划。
b)调用方获取到人脸比对事件后，可通过调用该接口获取关联关系，将人脸比对事件报文中的人脸编号、分组编号和人脸监控应用服务中相对应。
c)调用方可在识别计划下发完成后调用该接口获取关联关系。
d)严禁在事件接收时调用此接口，避免造成接口性能不佳。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/plan/getFaceRelation
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCodes	string[]	True	人脸唯一编号数组，，可从按条件批量查询人脸获取

l 请求参数举例
{
    “indexCodes”: [
        “3045a9d0-f2c8-469f-ab01-934a6db26cd6”
    ]
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object[]	False	查询到的人脸关联关系对象数组
+faceIndexCode	string	False	人脸监控应用服务人脸编号
+faceGroupIndexCode	string	False	人脸监控应用服务人脸分组唯一编号
+resFaceIndexCode	string	False	识别资源上人脸的唯一编号
+resFaceGroupIndexCode	string	False	识别资源上人脸库的唯一编号
+resIndexCode	string	False	识别资源的唯一编号

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success”,
    “data”: [
        {
            “faceIndexCode”: “02afa708-e6d2-4d57-8354-96ca2a1796a3”,
            “faceGroupIndexCode”: “673a6f98-4860-4309-adf1-996f98c4d256”,
            “resFaceIndexCode”: “F59243DAB43341C2BC66058C746F8531”,
            “resFaceGroupIndexCode”: “ADB228DAD80740538B897FD3A35EA749”,
            “resIndexCode”: “72bee5a4b82942658bd8aa3449f3c8fc”
        }
    ]
}

4.1.3.2.7 批量拷贝人脸到人脸分组

l 接口说明
a)批量将若干人脸拷贝到若干分组内。
b)这个接口可以实现将平台已经存在的人脸迁移到其它分组内。
c)无论如何调用该接口，同一个分组内不会出现两个indexCode相同的人脸。
d)若人脸已经在人脸分组内了，重复的迁移操作也会返回成功。
e)拷贝一次性最多拷贝1000张图片，最多同时拷贝到16个分组内。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/face/batch/copy
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCodes	string[]	True	待拷贝的若干人脸唯一标识集合，，可从按条件批量查询人脸获取
faceGroupIndexCodes	string[]	True	目标人脸分组的唯一标识集合，，可从按条件查询人脸分组获取

l 请求参数举例
{
    “indexCodes”: [
        “5dc82633-a4cb-4107-b55e-f21bbdf952f9”
    ],
    “faceGroupIndexCodes”: [
        “5dc82633-a4cb-4107-b55e-f21bbdf952f5”
    ]
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	boolean	False	拷贝是否成功,true：成功,false：失败

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: true
}

4.1.3.3 重点人员识别计划管理

4.1.3.3.1 单个添加重点人员识别计划

l 接口说明
a)该接口可以新增一条重点人员识别计划，以实现将若干抓拍点抓拍到的人脸，通过若干识别资源同若干分组内的人脸比较，并将命中结果以事件形式上报。
b)配置一条识别计划需要人脸分组集合（通过”按条件查询人脸分组”接口获取），抓拍点集合（通过LDAP服务获取监控点，并通过型号确定抓拍点），识别资源集合（通过”按条件查询识别资源”接口获取）。
c)一条重点人员识别计划只能配置一种识别资源类别：深眸或脸谱或超脑。
d)一条重点人员识别计划，可以配置多个超脑作为识别资源或一个脸谱作为识别资源。
e)一条重点人员识别计划如果配置深眸作为识别资源，则recognitionResourceIndexCodes可以传空。因为深眸的抓拍点就是识别资源本身，人脸监控应用服务会根据抓拍点自动匹配正确的识别资源。
f)人脸监控应用服务会校验抓拍点的有效性。校验规则如下：超脑作为识别资源时，抓拍点必须是超脑的通道；脸谱作为识别资源时，脸谱作为识别资源时，抓拍点一般为深眸或其他人脸抓拍机通道；深眸作为识别资源时，抓拍点必须是深眸的通道；一个通道是否是深眸/超脑/抓拍机的通道，取决于通道所属设备的型号，详见附录I 人脸监控应用服务支持设备型号列表。
g)重点人员识别计划配置有以下限制，这些限制会在添加时作为特殊错误返回：超脑的一个通道只能配置一次重点人员识别计划；同一个抓拍点不能同时配置在多个脸谱上；抓拍点或识别资源没有同步到IAC前，无法配置识别计划。
h)识别计划的配置为异步过程，调用接口成功后，人脸监控应用服务会在后台自动下发人脸分组并执行布控操作，可以通过接口”单个查询重点人员识别计划详情”查询该识别计划的下发结果。
i) 识别计划支持配置时间计划模板，当时间计划参数不传时，默认全天候。当传入此参数时，时间计划规则如下：按周计划进行配置，每一天的时间段上限为8，每一个时间段的开始时间必须小于结束时间。<brj)同一个深眸支持配置多个识别计划。<brk)若设备上人脸分组达到上限，则有可能导致下发失败。

l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/plan/recognition/black/addition
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
name	string	True	识别计划名称,1~32个字符；不能包含 ‘ / : ? ” < >
faceGroupIndexCodes	string[]	True	人脸分组唯一标识的集合，非空，人脸监控应用服务会校验标识的有效性，可从按条件查询人脸分组获取
cameraIndexCodes	string[]	True	抓拍点通道唯一标识的集合，非空，人脸监控应用服务会校验抓拍点标识的有效性，可通过分页获取监控点资源获取
recognitionResourceIndexCodes	string[]	False	识别资源唯一标识的集合。人脸监控应用服务会校验识别资源标识的有效性，若有重复、无效的标识，校验不通过。识别资源类型为深眸时，可以为空。可从按条件查询识别资源获取
recognitionResourceType	string	True	识别资源类型，SUPER_BRAIN 超脑，FACE_RECOGNITION_SERVER 脸谱，COMPARISON 深眸
description	string	False	识别计划描述，1~128个字符
threshold	number	True	识别计划的阈值，重点人员是指相似度超过该值时报警，范围[1, 100)
timeBlockList	object[]	False	时间计划模板，不填默认全天候
+dayOfWeek	string	True	星期几，1-7分别表示周一至周七
+timeRange	object[]	True	时间段数组，一天可以有多个时间段
++startTime	string	True	开始时间，时分，如“00:00”
++endTime	string	True	结束时间，时分，如“00:00”

l 请求参数举例
{
    “name”: “这是一条重点人员识别计划”,
    “faceGroupIndexCodes”: [
        “8ce19be05b5c4914b1e3c9eee3997eb2”
    ],
    “cameraIndexCodes”: [
        “c4023a78c83948f9b6b0fb76b0f3db71”
    ],
    “recognitionResourceIndexCodes”: [
        “867c73b5-56d8-43b7-8491-6481ab23c8be”
    ],
    “recognitionResourceType”: “SUPER_BRAIN”,
    “description”: “这是一个描述”,
    “threshold”: 32,
    “timeBlockList”: [
        {
            “dayOfWeek”: “1”,
            “timeRange”: [
                {
                    “startTime”: “00:00”,
                    “endTime”: “12:00”
                }
            ]
        }
    ]
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	string	False	添加成功的识别计划的唯一标识

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”
}

4.1.3.3.2 删除重点人员识别计划

l 接口说明
a)根据重点人员识别计划的唯一标识,删除若干重点人员识别计划，返回的data为布尔类型，true代表操作成功，false代表操作失败。
b)删除识别计划后，会异步删除识别计划中下发到设备上的人脸分组、人脸、布控信息。因此调用接口成功的时候，可以观察到识别资源上的分组还是存在的，需要等一段时间后才会删除。
c)请勿在识别计划正在下发时，调用删除识别计划的接口。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/plan/recognition/black/deletion
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCodes	string[]	True	操作的计划的唯一标识集合，操作可能是删除等，可从查询重点人员识别计划获取

l 请求参数举例
{
    “indexCodes”: [
        “7cc0adb2-a3c3-48fd-b432-718103e85c28”
    ]
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	boolean	False	删除是否成功,true：成功,false：失败

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: true
}

4.1.3.3.3 单个修改重点人员识别计划

l 接口说明
a)修改指定的重点人员识别计划信息，返回的data为布尔类型，true代表操作成功，false代表操作失败。
b)修改识别计划时，传入的信息和添加一致，不需要修改的字段也要传过来，但是部分不支持修改的字段不需要传，详情请以入参说明为准。
c)修改识别计划的接口校验同添加一致，请见单个添加重点人员识别计划中的接口说明。
d)识别计划修改后，会自动重新下发。
e)脸谱作为识别资源的识别计划，不支持更换识别资源。深眸、超脑作为识别资源时不支持修改识别资源的类型。
f) 识别计划支持配置时间计划模板，当时间计划参数不传时，默认全天候。当传入此参数时，时间计划规则如下：按周计划进行配置，每一天的时间段上限为8，每一个时间段的开始时间必须小于结束时间。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/plan/recognition/black/update
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCode	string	True	识别计划唯一标识，可从查询重点人员识别计划获取
name	string	True	识别计划名称
faceGroupIndexCodes	string[]	True	人脸分组唯一标识的集合，非空，人脸监控应用服务会校验标识的有效性，可从按条件查询人脸分组获取
cameraIndexCodes	string[]	True	抓拍点通道唯一标识的集合，非空，人脸监控应用服务会校验抓拍点标识的有效性，可通过分页获取监控点资源获取
recognitionResourceIndexCodes	string[]	False	识别资源唯一标识的集合。人脸监控应用服务会校验识别资源标识的有效性，若有重复、无效的标识，校验不通过。识别资源类型为深眸时，可以为空。可从按条件查询识别资源获取
description	string	False	识别计划备注
threshold	number	True	阈值
timeBlockList	object[]	False	时间计划模板
+dayOfWeek	string	True	星期几，1-7分别表示周一至周七
+timeRange	object[]	True	时间段数组，一天可以有多个时间段
++startTime	string	True	开始时间，时分，如“00:00”
++endTime	string	True	结束时间，时分，如“00:00”

l 请求参数举例
{
    “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
    “name”: “这是一条重点人员识别计划”,
    “faceGroupIndexCodes”: [
        “8ce19be05b5c4914b1e3c9eee3997eb2”
    ],
    “recognitionResourceIndexCodes”: [
        “867c73b5-56d8-43b7-8491-6481ab23c8be”
    ],
    “cameraIndexCodes”: [
        “c4023a78c83948f9b6b0fb76b0f3db71”
    ],
    “description”: “这是一个描述”,
    “threshold”: 32,
    “timeBlockList”: [
        {
            “dayOfWeek”: “1”,
            “timeRange”: [
                {
                    “startTime”: “00:00”,
                    “endTime”: “12:00”
                }
            ]
        }
    ]
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	boolean	False	修改是否成功,true：成功,false：失败

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success”,
    “data”: true
}

4.1.3.3.4 单个查询重点人员识别计划详情

l 接口说明
a)根据重点人员识别计划的唯一标识，查询单个重点人员识别计划的下发状态和结果详情。
b)返回的结果中包含了识别计划的所有信息和下发状态。还包含了人脸分组、人脸、通道布控的结果，其中人脸下发结果以分页方式返回。
c)通道布控的结果，在超脑作为识别资源的识别计划中才会返回；脸谱和深眸作为识别资源时，该字段为空集合。
d)调用方可以通过定时调用该接口，获取识别计划的下发情况和具体每张人脸的下发结果。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/plan/recognition/black/detail
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCode	string	True	识别计划的唯一标识，可从查询重点人员识别计划获取
pageNo	number	False	分页查询条件，页码，为空时，等价于1。针对下发详情中的人脸条目生效
pageSize	number	False	分页查询条件，页尺，为空时，等价于1000。针对下发详情中的人脸条目生效

l 请求参数举例
{
    “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
    “pageNo”: 1,
    “pageSize”: 20
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object	False	识别计划下发详情
+indexCode	string	False	识别计划的唯一标识
+name	string	False	识别计划的名称
+recognitionPlanType	string	False	识别计划的类型， BLACK_LIST-重点人员识别计划 WHITE_LIST-陌生人识别计划
+startTime	string	False	识别计划开始下发的时间,遵循ISO8601的时间格式
+usingTime	number	False	识别计划下发已经用的时间,单位:秒
+status	string	False	识别计划的状态,，参考附录A.33
+faceGroupIssuedResults	object[]	False	每个人脸分组的下发结果集合
++indexCode	string	False	唯一标识
++dataType	string	False	下发项的类型, FACE-人脸 FACE_GROUP-人脸分组 CHANNEL-监控点通道
++errorCode	string	False	下发项的结果
+cameraControlResults	object[]	False	每个通道的布控结果集合
++indexCode	string	False	唯一标识
++dataType	string	False	下发项的类型, FACE-人脸 FACE_GROUP-人脸分组 CHANNEL-监控点通道
++errorCode	string	False	下发项的结果
+faceIssuedResultPage	object	False	每张人脸的下发情况分页结果
++total	number	False	结果总数
++pageNo	number	False	当前页数
++pageSize	number	False	每页结果数
++list	object[]	False	每张人脸的下发情况
+++indexCode	string	False	唯一标识
+++dataType	string	False	下发项的类型, FACE-人脸 FACE_GROUP-人脸分组 CHANNEL-监控点通道
+++errorCode	string	False	下发项的结果

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: {
        “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
        “name”: “这是一条重点人员识别计划”,
        “recognitionPlanType”: “BLACK_LIST”,
        “startTime”: “2004-05-03T17:30:08+08:00”,
        “usingTime”: 5,
        “status”: “RUNNING”,
        “faceGroupIssuedResults”: [
            {
                “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
                “dataType”: “FACE_GROUP”,
                “errorCode”: “0”
            }
        ],
        “cameraControlResults”: [
            {
                “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
                “dataType”: “CHANNEL”,
                “errorCode”: “0”
            }
        ],
        “faceIssuedResultPage”: {
            “total”: 500,
            “pageNo”: 1,
            “pageSize”: 10,
            “list”: [
                {
                    “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
                    “dataType”: “FACE”,
                    “errorCode”: “0”
                }
            ]
        }
    }
}

4.1.3.3.5 查询重点人员识别计划

l 接口说明
a)根据查询条件，查询符合条件的重点人员识别计划的集合。
b)查询条件之间的关系为与，即所有条件同时生效，不传任何条件代表查询所有。
c)这里的人脸分组集合作为查询条件，如果传多个分组，则识别计划只要包含其中任意一个分组，就会被查询出来。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/plan/recognition/black
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
description	string	False	根据识别计划描述模糊搜索
faceGroupIndexCodes	string[]	False	根据人脸分组唯一标识集合搜索
name	string	False	根据识别计划名称模糊搜索
status	string	False	根据下发状态搜索，参考附录A.33

l 请求参数举例
{
    “description”: “这是一个描述”,
    “faceGroupIndexCodes”: [
        “string”
    ],
    “name”: “这是一条重点人员识别计划”,
    “status”: “RUNNING”
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object[]	False	查询到的识别计划集合
+indexCode	string	False	识别计划的唯一标识
+name	string	False	识别计划的名称
+faceGroupIndexCodes	string[]	False	人脸分组的唯一标识集合
+cameraIndexCodes	string[]	False	抓拍点的唯一标识集合
+recognitionResourceIndexCodes	string[]	False	识别资源的唯一标识集合
+recognitionResourceType	string	False	识别资源类型，SUPER_BRAIN 超脑，FACE_RECOGNITION_SERVER 脸谱，COMPARISON 深眸
+recognitionPlanType	string	False	识别计划的类型, BLACK_LIST-重点人员识别计划 WHITE_LIST-陌生人识别计划
+description	string	False	识别计划的描述
+status	string	False	识别计划的状态,参考附录A.33
+available	boolean	False	是否启用,true:启用,false:禁用
+startTime	string	False	识别计划开始下发的时间
+usingTime	number	False	识别计划下发已经用的时间
+threshold	number	False	阈值，范围[1,100)

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: [
        {
            “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
            “name”: “这是一条重点人员识别计划”,
            “faceGroupIndexCodes”: [
                “8ce19be05b5c4914b1e3c9eee3997eb2”
            ],
            “cameraIndexCodes”: [
                “c4023a78c83948f9b6b0fb76b0f3db71”
            ],
            “recognitionResourceIndexCodes”: [
                “867c73b5-56d8-43b7-8491-6481ab23c8be”
            ],
            “recognitionResourceType”: “SUPER_BRAIN”,
            “recognitionPlanType”: “BLACK_LIST”,
            “description”: “这是一个描述”,
            “status”: “RUNNING”,
            “available”: true,
            “startTime”: “2004-05-03T17:30:08+08:00”,
            “usingTime”: 57000,
            “threshold”: 32
        }
    ]
}

4.1.3.3.6 重新下发重点人员识别计划

l 接口说明
a)重新下发指定的重点人员识别计划，返回的data为布尔类型，true代表操作成功，false代表操作失败。
b)重新下发只能针对状态为下发失败的识别计划操作，且重新下发只会下发失败的部分，对于已经成功的部分不会重复下发。
c)重新下发的结果可以通过单个查询重点人员识别计划详情查看。

l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/plan/recognition/black/restart
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCode	string	True	识别计划的唯一标识，可从查询重点人员识别计划获取

l 请求参数举例
{
“indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	boolean	False	重新下发是否成功,true：成功,false：失败

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: true
}

4.1.3.4 陌生人识别计划管理

4.1.3.4.1 单个添加陌生人识别计划

l 接口说明
a)该接口可以新增一条陌生人识别计划，以实现将若干抓拍点抓拍到的人脸，通过若干识别资源同若干分组内的人脸比较，并将没有命中的结果以事件形式上报。
b)配置一条识别计划需要人脸分组集合（通过”按条件查询人脸分组”接口获取），抓拍点集合（通过LDAP服务获取监控点，并通过型号确定抓拍点），识别资源集合（通过”按条件查询识别资源”接口获取）。
c)陌生人识别计划只支持配置多个超脑作为识别资源。
d)人脸监控应用服务会校验抓拍点的有效性。校验规则如下：超脑作为识别资源时，抓拍点必须是超脑的通道；一个通道是否是超脑的通道，取决于通道所属设备的型号，详见附录I 人脸监控应用服务支持设备型号列表。
e)陌生人识别计划配置有以下限制，这些限制会在添加时作为特殊错误返回：超脑的一个通道只能配置一次陌生人识别计划；超脑的通道或超脑本身没有同步到IAC前，无法配置识别计划。
f)识别计划的配置为异步过程，调用接口成功后，人脸监控应用服务会在后台自动下发人脸分组并执行布控操作，可以通过接口”单个查询陌生人识别计划详情”查询该识别计划的下发结果。
g) 识别计划支持配置时间计划模板，当时间计划参数不传时，默认全天候。当传入此参数时，时间计划规则如下：按周计划进行配置，每一天的时间段上限为8，每一个时间段的开始时间必须小于结束时间。
j)同一个深眸支持配置多个识别计划。
k)若设备上人脸分组达到上限，则有可能导致下发失败。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/plan/recognition/white/addition
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
name	string	True	识别计划名称,1~32个字符；不能包含 ‘ / : ? ” < >
faceGroupIndexCodes	string[]	True	人脸分组唯一标识的集合，非空，人脸监控应用服务会校验标识的有效性，可从按条件查询人脸分组获取
cameraIndexCodes	string[]	True	抓拍点通道唯一标识的集合，非空，人脸监控应用服务会校验抓拍点标识的有效性，可通过分页获取监控点资源获取
recognitionResourceIndexCodes	string[]	False	识别资源唯一标识的集合。人脸监控应用服务会校验识别资源标识的有效性，若有重复、无效的标识，校验不通过。识别资源类型为深眸时，可以为空。可从按条件查询识别资源获取
recognitionResourceType	string	True	识别资源类型，SUPER_BRAIN 超脑，FACE_RECOGNITION_SERVER 脸谱，COMPARISON 深眸
description	string	False	识别计划描述，1~128个字符
threshold	number	True	识别计划的阈值，陌生人是指相似度不足该值时报警，范围[1, 100)
timeBlockList	object[]	False	时间计划模板，不填默认全天候
+dayOfWeek	string	True	星期几，1-7分别表示周一至周七
+timeRange	object[]	True	时间段数组，一天可以有多个时间段
++startTime	string	True	开始时间，时分，如“00:00”
++endTime	string	True	结束时间，时分，如“00:00”

l 请求参数举例
{
    “name”: “仓库值守陌生人识别计划”,
    “faceGroupIndexCodes”: [
        “8ce19be05b5c4914b1e3c9eee3997eb2”
    ],
    “cameraIndexCodes”: [
        “c4023a78c83948f9b6b0fb76b0f3db71”
    ],
    “recognitionResourceIndexCodes”: [
        “867c73b5-56d8-43b7-8491-6481ab23c8be”
    ],
    “recognitionResourceType”: “SUPER_BRAIN”,
    “description”: “这是一个描述”,
    “threshold”: 32,
    “timeBlockList”: [
        {
            “dayOfWeek”: “1”,
            “timeRange”: [
                {
                    “startTime”: “00:00”,
                    “endTime”: “12:00”
                }
            ]
        }
    ]
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	string	False	添加成功的识别计划的唯一标识

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”
}

4.1.3.4.2 删除陌生人识别计划

l 接口说明
a)根据陌生人识别计划的唯一标识,删除若干陌生人识别计划，返回的data为布尔类型，true代表操作成功，false代表操作失败。
b)删除识别计划后，会异步删除识别计划中下发到设备上的人脸分组、人脸、布控信息。因此调用接口成功的时候，可以观察到识别资源上的分组还是存在的，需要等一段时间后才会删除。
c)请勿在识别计划正在下发时，调用删除识别计划的接口。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/plan/recognition/white/deletion
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCodes	string[]	True	操作的计划的唯一标识集合，操作可能是删除等，可从查询陌生人识别计划获取

l 请求参数举例
{
    “indexCodes”: [
        “7cc0adb2-a3c3-48fd-b432-718103e85c28”
    ]
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	boolean	False	删除是否成功,true：成功,false：失败

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: true
}

4.1.3.4.3 单个修改陌生人识别计划

l 接口说明
a)修改指定的陌生人识别计划信息，返回的data为布尔类型，true代表操作成功，false代表操作失败。
b)修改识别计划时，传入的信息和添加一致，不需要修改的字段也要传过来，但是部分不支持修改的字段不需要传，详情请以入参说明为准。
c)修改识别计划的接口校验同添加一致，请见单个添加陌生人识别计划中的接口说明，这里不再赘述。
d)识别计划修改后，会自动重新下发。
e)深眸、超脑作为识别资源时不支持修改识别资源的类型。
f) 识别计划支持配置时间计划模板，当时间计划参数不传时，默认全天候。当传入此参数时，时间计划规则如下：按周计划进行配置，每一天的时间段上限为8，每一个时间段的开始时间必须小于结束时间。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/plan/recognition/white/update
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCode	string	True	识别计划的唯一标识，可从查询陌生人识别计划获取
name	string	True	识别计划名称,1~32个字符；不能包含 ‘ / : ? ” < >
faceGroupIndexCodes	string[]	True	人脸分组唯一标识的集合，非空，人脸监控应用服务会校验标识的有效性，可从按条件查询人脸分组获取
cameraIndexCodes	string[]	True	抓拍点通道唯一标识的集合，非空，人脸监控应用服务会校验抓拍点标识的有效性，可通过分页获取监控点资源获取
recognitionResourceIndexCodes	string[]	False	识别资源唯一标识的集合。人脸监控应用服务会校验识别资源标识的有效性，若有重复、无效的标识，校验不通过。识别资源类型为深眸时，可以为空。可从按条件查询识别资源获取
description	string	False	识别计划描述，1~128个字符
threshold	number	True	识别计划的阈值，陌生人是指相似度不足该值时报警，范围 [1,100)
timeBlockList	object[]	False	时间计划模板
+dayOfWeek	string	True	星期几，1-7分别表示周一至周七
+timeRange	object[]	True	时间段数组，一天可以有多个时间段
++startTime	string	True	开始时间，时分，如“00:00”
++endTime	string	True	结束时间，时分，如“00:00”

l 请求参数举例
{
    “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
    “name”: “仓库值守陌生人识别计划”,
    “faceGroupIndexCodes”: [
        “8ce19be05b5c4914b1e3c9eee3997eb2”
    ],
    “recognitionResourceIndexCodes”: [
        “867c73b5-56d8-43b7-8491-6481ab23c8be”
    ],
    “cameraIndexCodes”: [
        “c4023a78c83948f9b6b0fb76b0f3db71”
    ],
    “description”: “这是一个描述”,
    “threshold”: 32,
    “timeBlockList”: [
        {
            “dayOfWeek”: “1”,
            “timeRange”: [
                {
                    “startTime”: “00:00”,
                    “endTime”: “12:00”
                }
            ]
        }
    ]
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	boolean	False	修改是否成功,true：成功,false：失败

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: true
}

4.1.3.4.4 单个查询陌生人识别计划详情

l 接口说明
a)根据陌生人识别计划的唯一标识，查询单个陌生人识别计划的下发状态和结果详情。
b)返回的结果中包含了识别计划的所有信息和下发状态。还包含了人脸分组、人脸、通道布控的结果，其中人脸的下发结果由于过多，会以分页的方式返回。
c)调用方可以通过定时调用该接口，获取识别计划的下发情况和具体每张人脸的下发结果。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/plan/recognition/white/detail
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCode	string	True	识别计划的唯一标识，可从查询陌生人识别计划获取
pageNo	number	False	分页查询条件，页码，为空时，等价于1。针对下发详情中的人脸条目生效
pageSize	number	False	分页查询条件，页尺，为空时，等价于1000。针对下发详情中的人脸条目生效

l 请求参数举例
{
    “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
    “pageNo”: 1,
    “pageSize”: 20
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object	False	识别计划下发详情
+indexCode	string	False	识别计划的唯一标
+name	string	False	识别计划的名称
+recognitionPlanType	string	False	识别计划的类型, BLACK_LIST-重点人员识别计划 WHITE_LIST-陌生人识别计划
+startTime	string	False	识别计划开始下发的识别计划开始下发的时间,遵循ISO8601的时间格式
+usingTime	number	False	识别计划下发已经用的时间,单位:秒
+status	string	False	识别计划的状态,，参考附录A.33
+faceGroupIssuedResults	object[]	False	每个人脸分组的下发结果集合
++indexCode	string	False	唯一标识
++dataType	string	False	下发项的类型, FACE-人脸 FACE_GROUP-人脸分组 CHANNEL-监控点通道
++errorCode	string	False	下发项的结果
+cameraControlResults	object[]	False	每个通道的布控结果集合
++indexCode	string	False	唯一标识
++dataType	string	False	下发项的类型, FACE-人脸 FACE_GROUP-人脸分组 CHANNEL-监控点通道
++errorCode	string	False	下发项的结果
+faceIssuedResultPage	object	False	每张人脸的下发情况分页结果
++total	number	False	结果总数
++pageNo	number	False	当前页数
++pageSize	number	False	每页结果数
++list	object[]	False	下发项详情
+++indexCode	string	False	唯一标识
+++dataType	string	False	下发项的类型, FACE-人脸 FACE_GROUP-人脸分组 CHANNEL-监控点通道
+++errorCode	string	False	下发项的结果

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: {
        “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
        “name”: “仓库值守陌生人识别计划”,
        “recognitionPlanType”: “WHITE_LIST”,
        “startTime”: “2004-05-03T17:30:08+08:00”,
        “usingTime”: 1,
        “status”: “RUNNING”,
        “faceGroupIssuedResults”: [
            {
                “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
                “dataType”: “FACE_GROUP”,
                “errorCode”: “0”
            }
        ],
        “cameraControlResults”: [
            {
                “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
                “dataType”: “CHANNEL”,
                “errorCode”: “0”
            }
        ],
        “faceIssuedResultPage”: {
            “total”: 500,
            “pageNo”: 1,
            “pageSize”: 10,
            “list”: [
                {
                    “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
                    “dataType”: “FACE”,
                    “errorCode”: “0”
                }
            ]
        }
    }
}

4.1.3.4.5 查询陌生人识别计划

l 接口说明
a)根据查询条件，查询符合条件的陌生人识别计划的集合。
b)查询条件之间的关系为与，即所有条件同时生效，不传任何条件代表查询所有。
c)这里的人脸分组集合作为查询条件，如果传多个分组，则识别计划只要包含其中任意一个分组，就会被查询出来。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/plan/recognition/white
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
description	string	False	根据识别计划描述模糊搜索
faceGroupIndexCodes	string[]	False	根据人脸分组唯一标识集合搜索
name	string	False	根据识别计划名称模糊搜索
status	string	False	根据下发状态搜索，参考附录A.33

l 请求参数举例
{
    “description”: “这是一个描述”,
    “faceGroupIndexCodes”: [
        “string”
    ],
    “name”: “仓库值守陌生人识别计划”,
    “status”: “RUNNING”
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	object[]	False	查询到的识别计划集合
+indexCode	string	False	识别计划的唯一标识
+name	string	False	识别计划的名称
+faceGroupIndexCodes	string[]	False	人脸分组的唯一标识集合
+cameraIndexCodes	string[]	False	抓拍点的唯一标识集合
+recognitionResourceIndexCodes	string[]	False	识别资源的唯一标识集合
+recognitionResourceType	string	False	识别资源类型，SUPER_BRAIN 超脑，FACE_RECOGNITION_SERVER 脸谱，COMPARISON 深眸
+recognitionPlanType	string	False	识别计划的类型, BLACK_LIST-重点人员识别计划 WHITE_LIST-陌生人识别计划
+description	string	False	识别计划的描述
+status	string	False	识别计划的状态,，参考附录A.33
+available	boolean	False	是否启用,true:启用,false:禁用
+startTime	string	False	识别计划开始下发的时间
+usingTime	number	False	识别计划下发已经用的时间
+threshold	number	False	阈值，范围[1,100)

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: [
        {
            “indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”,
            “name”: “仓库值守陌生人识别计划”,
            “faceGroupIndexCodes”: [
                “8ce19be05b5c4914b1e3c9eee3997eb2”
            ],
            “cameraIndexCodes”: [
                “c4023a78c83948f9b6b0fb76b0f3db71”
            ],
            “recognitionResourceIndexCodes”: [
                “867c73b5-56d8-43b7-8491-6481ab23c8be”
            ],
            “recognitionResourceType”: “SUPER_BRAIN”,
            “recognitionPlanType”: “WHITE_LIST”,
            “description”: “这是一个描述”,
            “status”: “RUNNING”,
            “available”: true,
            “startTime”: “2004-05-03T17:30:08+08:00”,
            “usingTime”: 57000,
            “threshold”: 32
        }
    ]
}

4.1.3.4.6 重新下发陌生人识别计划

l 接口说明
a)重新下发指定的陌生人识别计划，返回的data为布尔类型，true代表操作成功，false代表操作失败。
b)重新下发只能针对状态为下发失败的识别计划操作，且重新下发只会下发失败的部分，对于已经成功的部分不会重复下发。
c)重新下发的结果可以通过单个查询陌生人识别计划详情查看。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/plan/recognition/white/restart
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
indexCode	string	True	识别计划的唯一标识，可从查询陌生人识别计划获取

l 请求参数举例
{
“indexCode”: “7cc0adb2-a3c3-48fd-b432-718103e85c28”
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	boolean	False	重新下发是否成功,true：成功,false：失败

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: true
}

4.1.3.5 抓拍计划配置

l 接口说明
a)配置平台的抓拍计划，目前支持开启和关闭两种操作。
b)当抓拍计划关闭后，也就无法从消息队列中获取到人脸抓拍事件了。
c)关闭抓拍计划不会影响到识别计划，因此人脸比对报警、重点人员识别报警、陌生人识别报警，仍旧会上报。
d)关闭抓拍计划的接口，是为了在部分场景下，去除无用的抓拍事件。这样可以释放消息队列、事件服务和人脸监控的压力，将性能用在更需要的地方。
e)重复的开启或者关闭，接口会返回成功。
l 接口适配产品版本
综合安防管理平台iSecure Center V1.2及以上版本
l 接口版本
v1
l 接口地址
/api/frs/v1/plan/capture/configuration
l 请求方法
POST
l 数据提交方式
application/json
l 请求参数

参数名称	数据类型	是否必须	参数描述
eventSwitch	boolean	True	开启或者关闭平台的抓拍计划，true:开启 false:关闭

l 请求参数举例
{
“eventSwitch”: true
}
l 返回参数

参数名称	数据类型	是否必须	参数描述
code	string	False	返回码，0:接口业务处理成功，其它参考附录E.5
msg	string	False	返回描述
data	boolean	False	删除是否成功,true：成功,false：失败

l 返回参数举例
{
    “code”: “0”,
    “msg”: “Success.”,
    “data”: true
}

5 附录

5.1 附录A 数据字典

5.1.1 附录A.1区域类型

———————

区域类型码	区域类型名称	备注
0	普通区域
1	级联区域
2	楼栋单元

5.1.2 附录A.3资源权限码

资源名称	资源权限码	权限控制项名称	备注
区域	view	查看
组织	view	查看
门禁控制器	view	查看
	eventRecv	事件接收
门禁点	view	查看
	eventRecv	事件接收
	doorControl	开关门
	normalControl	常开常关
编码设备	view	查看
	intercom	设备对讲
	eventRecv	接收事件
监控点	view	查看
	preview	视频预览
	ptzControl	云台控制
	audioRecv	接收声音
	playback	录像回放
	eventRecv	接收事件
	osdConfig	osd叠加配置
	picQuery	图片查询
报警输入	view	查看
	eventRecv	接收事件
报警输出	view	查看
	ioOutControl	输出控制
入侵报警-子系统通道	view	子系统查看
	control	子系统控制
	eventRecv	子系统事件接收
入侵报警-防区通道	view	防区查看
	control	防区控制
	eventRecv	防区接收事件
可视对讲设备	view	查看
	doorCtrl	开关门
	eventRecv	接收事件
梯控-控制器	view	查看
动环-开关量	view	查看
	control	控制
动环-传感器	view	查看
	control	控制
动环-环境量	eventRecv	接收事件

5.1.3 附录A.5视频通道类型

———————

编码设备通道类型码	编码设备通道类型名称	备注
analog	模拟通道
digital	数字通道
mirror	镜像通道
record	录播通道
zero	零通道

5.1.4 附录A.6编码设备接入协议

———————

编码设备接入协议码	编码设备接入协议名称	备注
hiksdk_net	海康SDK
gb_reg	GB/T28181
ehome_reg	EHOME
onvif_net	ONVIF
dhsdk_net	大华SDK
bi_reg	B接口协议
ezviz_net	萤石协议

5.1.5 附录A.10性别类型

———————

类型	类型说明
0	未知
1	男性
2	女性

5.1.6 附录A.11证件类型

———————

类型	类型说明
111	身份证
414	护照
113	户口簿
335	驾驶证
131	工作证
133	学生证
990	其他

5.1.7 附录A.12学历类型

———————

类型	类型说明
1	小学
2	初中
3	中技
4	高中
5	中专
6	大专
7	本科
8	硕士
9	博士
10	其他

5.1.8 附录A.13民族类型

———————

类型	类型说明
1	汉族
2	蒙古族
3	回族
4	藏族
5	维吾尔族
6	苗族
7	彝族
8	壮族
9	布依族
10	朝鲜族
11	满族
12	侗族
13	瑶族
14	白族
15	土家族
16	哈尼族
17	哈萨克族
18	傣族
19	黎族
20	僳僳族
21	佤族
22	畲族
23	高山族
24	拉祜族
25	水族
26	东乡族
27	纳西族
28	景颇族
29	柯尔克孜族
30	土族
31	达斡尔族
32	仫佬族
33	羌族
34	布朗族
35	撒拉族
36	毛难族
37	仡佬族
38	锡伯族
39	阿昌族
40	普米族
41	塔吉克族
42	怒族
43	乌孜别克族
44	俄罗斯族
45	鄂温克族
46	崩龙族
47	保安族
48	裕固族
49	京族
50	塔塔尔族
51	独龙族
52	鄂伦春族
53	赫哲族
54	门巴族
55	珞巴族
56	基诺族
97	其它

5.1.9 附录A.22能力集

———————

能力集标识码	能力集标识名称	备注
vss	视频能力
event_veh	车辆抓拍能力
eagle_eye_2DP	碗型鹰眼能力
eagle_eye_2DP_Z	球型鹰眼能力
eagle_eye_panorama	环型鹰眼能力
gis	可视域能力
event_heat	热成像能力
event_pdc	客流量统计能力
ptz	云台能力
event_person_density	人流量密度统计能力
event_acs_compare	人证设备人证比对能力
event_face	人脸采集能力(人脸抓拍机)
face_match	人脸建模能力
event_face_match	人脸比对能力
motiontrack	自动追踪能力
manualtrack	枪球联动能力
event_body	人体智能分析能力
event_rule	行为分析事件能力
event_ias	入侵报警能力(报警主机)
event_emer	紧急报警能力(报警柱/盒)
event_gps	GPS事件能力
io	IO能力
videolabel	虚拟标签能力
event_uav	无人机能力
event_rfid	RFID能力
event_wifi	WIFI能力

5.1.10 附录A.23录像存储位置

———————

编码设备接入协议码	编码设备接入协议名称	备注
0	中心存储
1	设备存储

5.1.11 附录A.24传输协议

———————

编码设备接入协议码	编码设备接入协议名称	备注
0	UDP
1	TCP

5.1.12 附录A.25任务下载类型

———————

任务下载类型码	类型
1	卡片
2	指纹
3	(保留)
4	人脸

5.1.13 附录A.30证件类型说明

——————–

枚举字段	数据类型	枚举类别	枚举值	枚举值解释	参考资料	备注
certType	Integer	证件类型	111	身份证
			414	护照
			113	户口簿
			335	驾驶证
			131	工作证
			133	学生证
			990	其他

5.1.14 附录A.32识别资源类型

———————

识别资源类型码	识别资源类型名称	备注
SUPER_BRAIN	超脑
FACE_RECOGNITION_SERVER	脸谱
COMPARISON	深眸

5.1.15 附录A.33识别计划状态类型

————————-

状态类型码	状态类型名称	备注
RUNNING	正在下发
SUCCESS	下发成功
PART_FAIL	部分失败
FAIL	下发失败
DELETE	已被删除
WAITING	等待下发	等待下发是指人脸监控应用服务可能在下发其它的识别计划，该识别计划进入等待队列
PAUSE	暂停	暂停是指该识别计划下发途中被人为停止

5.1.16 附录A.39录像存储位置

———————

录像存储位置类型名称	录像存储位置类型编码
中心存储	0
设备存储	1

5.1.17 附录A.41接入协议类型

———————

接入协议类型名称	接入协议类型编码
海康私有协议	hiksdk_net
海康私有串口协议	hiksdk_com
eHome协议	ehome_reg
大华私有协议	dhsdk_net
ONVIF协议	onvif_net
GB/T28181	gb_reg
国网B接口协议	bi_reg
汉军	hun_net
高德威	gdw_net
来邦	lbon_net
益可达私有协议	yikedasdk_net
瑞堡私有协议	hikrainbow_netcom
依时利私有协议	eastriver_net
海康地磁私有协议	hikgeo_reg
海康地磁TCP协议	tcpgeo_reg
海康地磁UDP协议	udpgeo_reg
迈特安私有协议	mtasdk_reg
海康LED私有协议	hikled_net
海康LED私有串口协议	hikled_com
诺瓦LED私有协议	novaled_net
诺瓦LED私有串口协议	novaled_com

5.1.18 附录A.45智能后分析能力集

————————-

智能后分析能力名称	智能后分析能力编码
人脸结构化能力	face
人体结构化能力	body
车辆结构化能力	vehicle
活动目标结构化能力	moving_target
行为分析报警能力	alarm
行为分析人员密度检测能力	person_density
人脸黑名单报警能力	blacklist
智能算法调度能力	dispatching

5.1.19 附录A.46下发项类型

——————-

下发项类型码	下发项类型名称	备注
FACE	人脸
FACE_GROUP	人脸分组
CHANNEL	监控点通道

5.1.20 附录A.53任务下载类型说明

————————-

任务下载类型码	类型
1	卡片
2	指纹
3	卡片+指纹（组合）
4	人脸
5	卡片+人脸（组合）
6	人脸+指纹（组合）
7	卡片+指纹+人脸（组合）

5.1.21 附录A.54权限条目状态说明

————————-

状态码	状态名称	备注
0	已配置未下载	已配置人员权限，还未下载到设备
1	更新待下载	原权限已下载至设备，新权限还未更新到设备
2	更新待删除	原权限已下载至设备，设备上的权限还未删除
3	已下载	权限已下载到设备
4	未配置	未配置人员权限或者设备上权限已被删除

5.1.22 附录A.58婚姻状况

—————–

婚姻状况	婚姻类型
未婚	1
已婚	2
丧偶	3
离婚	4
未说明的婚姻状态	5

5.2 附录B ISO8601时间格式说明

5.2.1 附录BISO8601时间格式说明

ISO8601是国际标准化组织制定的日期时间表示规范，全称是《数据存储和交换形式·信息交换·日期和时间的表示方法》
合并表示时，要在时间前面加一大写字母T，如要表示北京时间2004年5月3日下午5点30分8秒，可以写成2004-05-03T17:30:08+08:00或20040503T173008+08。

5.3 附录D 事件列表

5.3.1 附录D5 人脸监控事件

5.3.1.1 附录D.5.1人脸监控事件类型

事件分类	事件名称	事件类型码
人脸监控	人脸抓拍事件	131614
	人脸比对事件	131659
	重点人员识别事件	1644175361
	陌生人识别事件	1644171265
	高频人员识别事件	132865

5.3.1.2 附录D.5.2人脸抓拍事件报文示例

参数名称	数据类型	属性描述	是否必填	最大长度	备注
method	String	方法名，用于标识报文用途	是	不限	事件固定OnEventNotify
params	Params	事件参数信息	是	不限	具体参数信息

Params属性说明：

参数名称	数据类型	属性描述	是否必填	最大长度	备注
sendTime	String	事件从接收者（程序处理后）发出的时间	是	32	ISO8601时间格式
ability	String	事件类别	是	64	标识人脸抓拍事件为event_face
events	Events[]	事件信息	是	不限

Events属性说明：

参数名称	数据类型	属性描述	是否必填	最大长度	备注
data	Data	事件详情	是	不限	详见Data属性说明
eventId	String	事件唯一标识	是	64
srcIndex	String	事件源编号，物理设备是资源编号	是	64
srcType	String	事件源类型	是	64
srcName	String	事件源名称	否	64
eventType	Number	事件类型	是	64
status	Number	事件状态	是	32	0-瞬时 1-开始 2-停止 3-事件脉冲 4-事件联动结果更新
timeout	Number	脉冲超时时间	是	32	单位：秒
happenTime	String	事件发生时间（设备时间）	是	32
srcParentIndex	String	事件发生的事件源父设备编号	否	64

Data属性说明

参数名称	数据类型	属性描述	是否必填	最大长度	备注
captureLibResult	CaptureLibResult	抓拍结果	是	不限
+ faces	Faces	人脸信息	是	不限
++ URL	String	抓拍到的人脸图片的URL，可能位于设备或ASW服务上。	是	256	调用人脸服务图片下载获取图片数据
++ age	Age	年龄信息	否	不限
+++ ageGroup	String	年龄段，见附录附录A.34 设备年龄段类型	否	32
++ faceRect	FaceRect	人脸坐标	否	不限
+++ height	Number	宽度	否	不限
+++ width	Number	高度	否	不限
+++ x	Number	X坐标	否	不限
+++ y	Number	Y坐标	否	不限
++faceScore	Object	人脸评分参数	否
+++enable	Boolean	是否开启功能	是
+++type	Number	过滤类型	是		0-全部类型 1-人脸抓拍图片过滤 2-黑名单库 3-白名单库
+++totalScore	Number	人脸评分	否		人脸总评分：综合所有评分项得到人脸总评分数值越大人脸质量越高 float类型 [0,1]
++ gender	Gender		否	不限
+++ value	String	性别，见数据字典设备性别类型	否	32
++ glass	Glass		否	不限
+++ value	String	是否戴眼镜，见数据字典设备戴眼镜类别	否	32
+ targetAttrs	TargetAttrs	目标属性	是	不限
++ bkgUrl	String	抓拍图片的完整原图	是	256	调用人脸服务图片下载获取图片数据
++ cameraIndexCode	String	抓拍这张图片的监控点的唯一标识	是	64
++ deviceIndexCode	String	抓拍这张图片的监控点所属的设备的唯一标识	是	64
++ faceTime	String	抓拍这张图片时的时间	是	64
++ picServerIndexCode	String	图片服务唯一标志	否	32
++rect	FaceRect	人脸坐标	否	不限
+++ height	Number	宽度	否	不限
+++ width	Number	高度	否	不限
+++ x	Number	X坐标	否	不限
+++ y	Number	Y坐标	否	不限
channelID	String	抓拍这张图片的监控点的通道号	是	32
dataType	String	事件类别，人脸比对的事件类别为faceMatch	是	128
ipAddress	String	事件来源的地址，人脸抓拍的事件来源为抓拍机的地址。	是	32
portNo	String	事件来源的端口	否	32

示例：
{
“method”: “OnEventNotify”,
“params”: {
“ability”: “event_face”,
“events”: [{
“data”: {
“captureLibResult”: [{
“faces”: [{
“URL”: “http://10.33.47.14:6040/pic?4dd943i5e-3ce498181m3epmbIq2sD0oiuBc0he & Expires = 1537864795 & Signature =Ko0xhlkahKKIEgVb + vE0iyjgwIaVe9k0dJySlrBryGs = & Algorithm = 1 “,
“age”: {
“ageGroup”: “unknown”
},
“faceRect”: {
“height”: 0.1070000007748604,
“width”: 0.061000000685453422,
“x”: 0.42500001192092901,
“y”: 0.37000000476837158
},
“faceScore”: {
“enable”: “true”,
“totalScore”: 0,
“type”: 1
},
“gender”: {
“value”: “unknown”
},
“glass”: {
“value”: “unknown”
}
}],
“targetAttrs”: {
“bkgUrl”: “http://10.33.47.14:6040/pic?=d71i666e6i985-f335aa–cf835d1a6d0ccicb=PbQloIsYLjSnnsiIRVtR2UpkKXTAZsDKvS8sVBGey4=&Algorithm=1”,
“cameraIndexCode”: “9bb11d8fe23b4c348214d29cf02e7ac8”,
“deviceIndexCode”: “5c1c1e18938640f5b3db936323519e70”,
“faceTime”: “2018-09-25T16:23:29.000+08:00”,
“picServerIndexCode”: “fb98a466-8ddb-46fb-8620-5b4d2f02fea7”,
“rect”: {
“height”: 0.36599999666213989,
“width”: 0.20600000023841861,
“x”: 0.048000000417232513,
“y”: 0.34599998593330378
}
}
}],
“channelID”: 1,
“dataType”: “face”,
“ipAddress”: “10.67.183.178”,
“portNo”: 8500
},
“eventId”: “681EC005-B522-4BCF-9C16-75A74307A7B5”,
“eventType”: 131614,
“happenTime”: “2018-09-25T16:23:29.000+08:00”,
“srcIndex”: “9bb11d8fe23b4c348214d29cf02e7ac8”,
“srcType”: “camera”,
“status”: 0,
“timeout”: 0
}],
“sendTime”: “2018-09-25T16:23:15.499+08:00”
}
}

5.3.1.3 附录D.5.3人脸比对事件报文示例

参数名称	数据类型	属性描述	是否必填	最大长度	备注
method	String	方法名，用于标识报文用途	是	不限	事件固定OnEventNotify
params	Params	事件参数信息	是	不限	具体参数信息

Params属性说明：

参数名称	数据类型	属性描述	是否必填	最大长度	备注
sendTime	String	事件从接收者（程序处理后）发出的时间	是	32	ISO8601时间格式
ability	String	事件类别	是	64	标识人脸比对事件事件为event_face_match
events	Events[]	事件信息	是	不限

Events属性说明：

参数名称	数据类型	属性描述	是否必填	最大长度	备注
data	Data	事件详情	是	不限	详见Data属性说明
eventId	String	事件唯一标识	是	64
srcIndex	String	事件源编号，物理设备是资源编号	是	64
srcType	String	事件源类型	是	64
srcName	String	事件源名称	否	64
eventType	Number	事件类型	是	64
status	Number	事件状态	是	32	0-瞬时 1-开始 2-停止 3-事件脉冲 4-事件联动结果更新
timeout	Number	脉冲超时时间	是	32	单位：秒
happenTime	String	事件发生时间（设备时间）	是	32
srcParentIndex	String	事件发生的事件源父设备编号	否	64

Data属性说明

参数名称	数据类型	属性描述	是否必填	最大长度	备注
alarmResult	AlarmResult	比对结果	是	不限
+ faces	Faces	人脸信息	是	不限
++ URL	String	抓拍到的人脸图片的URL	是	256	可能位于设备或ASW服务上，调用人脸服务图片下载获取图片数据
++ age	String	年龄信息	否	不限
+++ ageGroup	String	年龄段，见附录附录A.34 设备年龄段类型	否	32
++ faceRect	String	人脸坐标	否	不限
+++ height	Number	宽度	否	不限
+++ width	Number	高度	否	不限
+++ x	Number	X坐标	否	不限
+++ y	Number	Y坐标	否	不限
++ gender	Gender	性别信息	否	不限
+++ value	String	性别	否	32	见数据字典设备性别类型
++ glass	Glass	是否戴眼镜	否	不限
+++ value	String	是否戴眼镜	否	32	见数据字典设备戴眼镜类别
++ identify	Identify	识别信息	否	不限
+++ candidate	Candidate	比对到的目标人脸	是	不限	有几个对象代表比对到了几张人脸
++++ blacklist_id	String	比对到的人脸所属人脸分组的唯一标识	是	64	注意和平台的人脸分组的标识不一定相同
++++ human_data	Human_data	人员数据	是	不限
+++++ face_picurl	String	比对到的人脸的图片URL	是	128	可能位于设备或ASW服务上，调用人脸服务图片下载获取图片数据
++++ human_id	String	比对到的人脸所属人脸的唯一标识	是	64	和平台的人脸分组的标识不一定相同
++++ reserve_field	Reserve_field		否	不限
+++++ bornTime	String	出生日期，格式形如20000101	否	32
+++++ certificateNumber	String	证件号码	否	32
+++++ certificateType	String	证件类型	否	10	见数据字典附录A.47 设备证件类型
+++++ gender	String	性别类型	否	10
+++++ name	String	人脸姓名	否	96
++++ similarity	Number	比对到的人脸和抓拍到的人脸之间的相似度	是	不限
+++ maxsimilarity	Number	比对到的所有人脸和抓拍到的人脸相似度最高的那个值	是	不限
+ targetAttrs	TargetAttrs		是	不限
++ bkgUrl	String		是	128
++ cameraIndexCode	String	抓拍这张图片的监控点的唯一标识	是	64
++ deviceIndexCode	String	抓拍这张图片的监控点所属的设备的唯一标识	是	64
++ faceTime	String	抓拍这张图片时的时间	是	32
++ picServerIndexCode	String	图片服务唯一标志	否	32
++rect	FaceRect	人脸坐标	否	不限
+++ height	Number	宽度	否	不限
+++ width	Number	高度	否	不限
+++ x	Number	X坐标	否	不限
+++ y	Number	Y坐标	否	不限
channelID	String	抓拍这张图片的监控点的通道号	是	32
dataType	String	事件类别，人脸比对的事件类别为faceMatch	是	64
ipAddress	String	事件来源的地址	是	64	人脸比对的事件来源为识别资源的地址。
portNo	Number	事件来源的端口	否	64

示例：
{
“method “: “OnEventNotify “,
“params “: {
“ability “: “event_face_match “,
“events “: [{
“data “: {
“alarmResult “: [{
“faces “: [{
“URL “: “http: //10.67.184.149:80/picture/Streaming/tracks/203/?name020010000019000349337600031725 & size = 31725”,
“age”: {
“ageGroup”: “young”
},
“faceRect”: {
“height”: 0.1040000021457672,
“width”: 0.054999999701976783,
“x”: 0.53899997472763062,
“y”: 0.3970000147819519
},
“gender”: {
“value”: “female”
},
“glass”: {
“value”: “no”
},
“identify”: [{
“candidate”: [{
“blacklist_id”: “88FAAC33601441D5A7422FA2D9464590”,
“human_data”: [{
“face_picurl”: “http://10.67.184.149:80/FDLib?FDID=88FAAC33601441D5A7422FA2D9464590&4832 A2E1E84B7580C38E6968D6B943 & size = 6128 “
}],
“human_id”: “574832A2E1E84B7580C38E6968D6B943”,
“reserve_field”: {
“bornTime”: “”,
“certificateNumber”: “”,
“certificateType”: “ID”,
“gender”: “female”,
“name”: “大超脑4”
},
“similarity”: 0.090000003576278687
}],
“maxsimilarity”: 0.090000003576278687
}]
}],
“targetAttrs”: {
“bkgUrl”: “http://10.67.184.149:80/picture/Streaming/tracks/203/?name=0010000019000352563200150984 & size = 150984 “,
“cameraIndexCode”: “f3b8b0ab19d043929e9985736ea31270”,
“deviceIndexCode”: “eaab3100c69642f5a2c660fb16779a0c”,
“faceTime”: “2018-09-25T16:23:48.000+08:00”,
“picServerIndexCode”: “fb98a466-8ddb-46fb-8620-5b4d2f02fea7”,
“rect”: {
“height”: 0.36599999666213989,
“width”: 0.20600000023841861,
“x”: 0.048000000417232513,
“y”: 0.34599998593330378
}
}
}],
“channelID”: 2,
“dataType”: “faceMatch”,
“ipAddress”: “10.67.184.149”,
“portNo”: 8500
},
“eventId”: “3D64FEB6-3953-4A48-B735-1CF81FA0BDF4”,
“eventType”: 131659,
“happenTime”: “2018-09-25T16:23:48.000+08:00”,
“srcIndex”: “f3b8b0ab19d043929e9985736ea31270”,
“srcType”: “camera”,
“status”: 0,
“timeout”: 0
}],
“sendTime”: “2018-09-25T16:23:40.306+08:00”
}
}

5.3.1.4 附录D.5.4重点人员识别事件报文示例

参数名称	数据类型	属性描述	是否必填	最大长度	备注
method	String	方法名，用于标识报文用途	是	不限	事件固定OnEventNotify
params	Params	事件参数信息	是	不限	具体参数信息

Params属性说明：

参数名称	数据类型	属性描述	是否必填	最大长度	备注
sendTime	String	事件从接收者（程序处理后）发出的时间	是	32	ISO8601时间格式
ability	String	事件类别	是	64	标识人重点人员识别事件为event_face_recognition
events	Events[]	事件信息	是	不限

Events属性说明：

参数名称	数据类型	属性描述	是否必填	最大长度	备注
data	Data	事件详情	是	不限	详见Data属性说明
ability	String	事件类别	是	64	人脸事件为event_frs
eventId	String	事件唯一标识	是	64
srcIndex	String	事件源编号，物理设备是资源编号	是	64
srcType	String	事件源类型	是	64
srcName	String	事件源名称	否	64
eventType	Number	事件类型	是	64
status	Number	事件状态	是	32	0-瞬时 1-开始 2-停止 3-事件脉冲 4-事件联动结果更新
timeout	Number	脉冲超时时间	是	32	单位：秒
happenTime	String	事件发生时间（设备时间）	是	32
srcParentIndex	String	事件发生的事件源父设备编号	否	64

Data属性说明

参数名称	数据类型	属性描述	是否必填	最大长度	备注
faceRecognitionResult	FaceRecognitionResult	识别结果	是	不限
+ snap	Snap	抓拍信息	是	不限
++ ageGroup	String	年龄段，见附录附录A.34 设备年龄段类型	是	32
++ gender	String	性别，见数据字典设备性别类型	是	32
++ glass	String	是否戴眼镜，见数据字典设备戴眼镜类别	是	32
++ bkgUrl	String	背景图片URL	是	128	位于超脑上则为完整的URL，位于asw上则为不带IP、PORT的URI，调用人脸服务图片下载获取图片数据
++ faceUrl	String	人脸图片URI	是	128	位于超脑上则为完整的URL，位于asw上则为不带IP、PORT的URI，调用人脸服务图片下载获取图片数据
++ faceTime	String	抓拍图片的时间	是	32
+ faceMatch	FaceMatch	识别到的目标信息	是	不限	可能有1-5个目标
++ faceGroupCode	String	目标所属的人脸分组的唯一标识	是	64
++ faceGroupName	String	目标所属的人脸分组的名称	是	64
++ faceInfoCode	String	目标对应的人脸的唯一标识	是	64
++ faceInfoName	String	目标对应的人脸的名称	是	64
++ faceInfoSex	String	目标对应的人脸的性别	是	32
++ certificate	String	目标对应的人脸的证件号码	否	32
++ certificateType	String	目标对应的人脸的证件类型	否	32	111：身份证 officerID：军官证其余为其它证件
++ similarity	Number	目标人脸和抓拍人脸的相似度	是	32
++ facePicUrl	String	目标人脸的图片	是	128	存储于超脑上则为完整的URL，存储于asw上则为不带IP、PORT的URI，调用人脸服务图片下载获取图片数据
srcEventId	String	源事件的唯一标识，即转自的人脸比对事件的唯一标识	是	64
resInfo	ResInfo	触发重点人员识别事件的报警的抓拍点的信息	是	不限
+ resourceType	String	资源类型	是	32	重点人员识别事件均为抓拍点报警，例如：camera
+ indexCode	String	资源的唯一标识	是	64
+ cn	String	资源的名称	是	32

示例：
{
“method”: “OnEventNotify”,
“params”: {
“sendTime”: “2018-09-25T19:31:54.951+08:00”,
“ability”: “event_face_recognition”,
“events”: [{
“eventType”: 1644175361,
“eventId”: “ba49eeef-8c17-4c1a-8eab-53a0c9eb06fe”,
“srcIndex”: “eb82bf1b-a3dc-4e3d-8bfd-ff52e42245c9”,
“ability”: “event_frs”,
“data”: {
“faceRecognitionResult”: {
“snap”: {
“ageGroup”: “young”,
“gender”: “male”,
“glass”: “yes”,
“bkgUrl”: “http://10.67.184.149:80/picture/Streaming/tracks/203/?006853427200019404 & size = 19404”,
“faceUrl”: “http://10.66.165.124:6120/pic?7dd489324-7doc81l*3dec1=–87zd61fa3e614idb1*=2d0i0s1*=idp1*=*d4i1t=pe7m5517641”,
“faceTime”: “2018-09-25 19:32:02”
},
“faceMatch”: [{
“faceGroupCode”: “eb82bf1b-a3dc-4e3d-8bfd-ff52e42245c9”,
“faceGroupName”: “ghc”,
“faceInfoCode”: “98c83004-c390-4d8b-a97a-34a3218a5ac7”,
“faceInfoName”: “233”,
“faceInfoSex”: “unknown”,
“certificate”: “32423”,
“certificateType”: “111”,
“similarity”: 0.05,
“facePicUrl”: “http://10.33.47.14:6040/pic?=d2ei666i31f6935-f775aa–cf835d1a6d0ccidp= 89 d1”
}]
},
“srcEventId”: “B89C250C-B8C2-4215-9A6C-09CC34DF25A7”,
“resInfo”: [{
“resourceType”: “camera”,
“indexCode”: “f3b8b0ab19d043929e9985736ea31270”,
“cn”: “184.128_7627_人脸抓拍”
}]
},
“happenTime”: “2018-09-25T19:32:02.000+08:00”,
“srcType”: “faceGroup”,
“status”: 0,
“timeout”: 0
}]
}
}

5.3.1.5 附录D.5.5陌生人员识别事件报文示例

参数名称	数据类型	属性描述	是否必填	最大长度	备注
method	String	方法名，用于标识报文用途	是	不限	事件固定OnEventNotify
params	Params	事件参数信息	是	不限	具体参数信息

Params属性说明：

参数名称	数据类型	属性描述	是否必填	最大长度	备注
sendTime	String	事件从接收者（程序处理后）发出的时间	是	32	ISO8601时间格式
ability	String	事件类别	是	64	标识陌生人员识别事件为event_face_recognition
events	Events[]	事件信息	是	不限

Events属性说明：

参数名称	数据类型	属性描述	是否必填	最大长度	备注
data	Data	事件详情	是	不限	详见Data属性说明
eventId	String	事件唯一标识	是	64
srcIndex	String	事件源编号，物理设备是资源编号	是	64
srcType	String	事件源类型	是	64
srcName	String	事件源名称	否	64
eventType	Number	事件类型	是	64
status	Number	事件状态	是	32	0-瞬时 1-开始 2-停止 3-事件脉冲 4-事件联动结果更新
timeout	Number	脉冲超时时间	是	32	单位：秒
happenTime	String	事件发生时间（设备时间）	是	32
srcParentIndex	String	事件发生的事件源父设备编号	否	64

Data属性说明

参数名称	数据类型	属性描述	是否必填	最大长度	备注
faceRecognitionResult	FaceRecognitionResult	识别结果	是	不限
+ snap	Snap	抓拍信息	是	不限
++ ageGroup	String	年龄段，见附录附录A.34 设备年龄段类型	是	32
++ gender	String	性别，见数据字典设备性别类型	是	32
++ glass	String	是否戴眼镜，见数据字典设备戴眼镜类别	是	32
++ bkgUrl	String	背景图片URL	是	128	存储于超脑上则为完整的URL，存储于asw上则为不带IP、PORT的URI ，调用人脸服务图片下载获取图片数据
++ faceUrl	String	人脸图片URL	是	128	存储于超脑上则为完整的URL，存储于asw上则为不带IP、PORT的URI ，调用人脸服务图片下载获取图片数据
++ faceTime	String	抓拍图片的时间	是	32
srcEventId	String	源事件的唯一标识，即转自的人脸比对事件的唯一标识	是	64
resInfo	ResInfo	触发重点人员识别事件的报警的抓拍点的信息	是	不限
+ resourceType	String	资源类型	是	32	重点人员识别事件均为抓拍点报警，例如：camera
+ indexCode	String	资源的唯一标识	是	64
+ cn	String	资源的名称	是	32

示例：
{
“method”: “OnEventNotify”,
“params”: {
“ability”: “event_face_recognition”,
“events”: [{
“data”: {
“faceRecognitionResult”: {
“snap”: {
“ageGroup”: “young”,
“bkgUrl”: “http://10.67.184.86:80/picture/Streaming/tracks/103/?name=ch0001_03000001329060946534400136268&size=136268”,
“faceTime”: “2019-05-27 14:17:11”,
“faceUrl”: “http://10.67.184.86:80/picture/Streaming/tracks/103/?name=ch0001_03000001329060945868800006112&size=6112”,
“gender”: “male”,
“glass”: “yes”
},
“srcEventId”: “9409397C-26E4-48AB-8DB0-D4A48B00E32B”
},
“resInfo”: [{
“cn”: “184.156_6024_抓拍”,
“indexCode”: “86f0d4c232fc4807af9f7b98490a5891”,
“resourceType”: “camera”
}],
“srcEventId”: “9409397C-26E4-48AB-8DB0-D4A48B00E32B”
},
“eventId”: “709260f8-13ad-405e-a405-c5bb652cd2e5”,
“eventType”: 1644171265,
“happenTime”: “2019-05-27T14:17:11.000+08:00”,
“srcIndex”: “86f0d4c232fc4807af9f7b98490a5891”,
“srcName”: “184.156_6024_抓拍”,
“srcType”: “camera”,
“status”: 0,
“timeout”: 0
}],
“sendTime”: “2019-05-27T14:17:05.761+08:00”
}
}

5.3.1.6 附录D.5.6高频人员识别事件报文示例

参数名称	数据类型	属性描述	是否必填	最大长度	备注
method	String	方法名，用于标识报文用途	是	不限	事件固定OnEventNotify
params	Params	事件参数信息	是	不限	具体参数信息

Params属性说明：

参数名称	数据类型	属性描述	是否必填	最大长度	备注
sendTime	String	事件从接收者（程序处理后）发出的时间	是	32	ISO8601时间格式
ability	String	事件类别	是	64	标识高频人员识别事件event_high_frequency_personel
uids	String[]	用户id	否	不限
events	Events[]	事件信息	是	不限

Events属性说明：

参数名称	数据类型	属性描述	是否必填	最大长度	备注
data	Data	事件详情	是	不限	详见Data属性说明
eventId	String	事件唯一标识	是	64
srcIndex	String	事件源编号，物理设备是资源编号	是	64
srcType	String	事件源类型	是	64
srcName	String	事件源名称	否	64
eventType	Number	事件类型	是	64
status	Number	事件状态	是	32	0-瞬时 1-开始 2-停止 3-事件脉冲 4-事件联动结果更新
timeout	Number	脉冲超时时间	是	32	单位：秒
happenTime	String	事件发生时间（设备时间）	是	32
srcParentIndex	String	事件发生的事件源父设备编号	否	64

Data属性说明

参数名称	数据类型	属性描述	是否必填	最大长度	备注
URLCertificationType	String	图片url认证方式	否	32	digest-摘要认证（这个针对设备本地存储返回URL的方式，设备例如NVR/DVR）
activePostCount	Number	事件触发次数	否	32
channelID	Number	设备通道号	是	32	设备通道号，默认1开始
dataType	String	数据模型标识	是	32	由IAC添加
dateTime	String	数据触发时间	是	32	由设备产生
eventDescription	String	事件描述	是	不限
eventState	String	事件状态	否	不限
eventType	String	事件类型	否	不限
ipAddress	String	设备的IP地址	是	不限
macAddress	String	Mac地址	否	32
portNo	Number	设备端口号	是	32
protocol	String	协议类型	否	32
recvTime	String	数据接收时间	是	32	由IAC添加
sendTime	String	数据发送时间	是	32	由IAC添加
faceCapture	FaceCaptureResult[]	识别结果	是	不限
+ faces	faceInfo[]	人脸信息	否	不限
++ URL	String	人脸图片url	是	不限	，调用人脸服务图片下载获取图片数据
++ age	Object	年龄段	是	不限
+++ ageGroup	String	年龄段，见附录附录A.34 设备年龄段类型	是	32
++ faceId	Number	人脸ID	是	不限
++ faceRect	String	人脸坐标	否	不限
+++ height	Number	宽度	否	不限
+++ width	Number	高度	否	不限
+++ x	Number	X坐标	否	不限
+++ y	Number	Y坐标	否	不限
++ gender	Object	性别，见数据字典设备性别类型	是	32
+++ value	String	性别，见数据字典设备性别类型	是	不限
++ glass	Object	是否戴眼镜，见数据字典设备戴眼镜类别	是	不限
+++ value	String	是否戴眼镜，见数据字典设备戴眼镜类别	是	不限
++ mask	Object	是否带口罩	是	不限
+++ value	String	是否带口罩	是	不限
++ smile	Object	是否微笑	是	不限
+++ value	String	是否微笑	是	不限
++ occurrences	Number	目标出现次数	是	不限
+recordDataIndex	String	高频人员检测报警历史查询索引	是	不限
+targetAttrs	targetAttrsInfo	目标属性	是	不限	透传字段，部分字段由数据源扩展字段获取
++ bkgUrl	String	背景图片URL	是	128	存储于超脑上则为完整的URL，存储于asw上则为不带IP、PORT的URI ，调用人脸服务图片下载获取图片数据
++ cameraIndexCode	String	监控点indexCode	是	64
++ deviceChannel	Number	设备通道号	是	32
++ deviceIndexCode	String	设备indexCode	是	64
++ deviceName	String	设备名称	是	64
++ faceTime	String	抓拍图片的时间	是	32
++ imageServerCode	String	图片服务编号	否	32	若云存储配置服务编码则有该字段
++ picServerIndexCode	String	图片服务唯一标志	否	32

示例：
{
    “method”:”OnEventNotify”,
    “params”:{
        “ability”:”event_high_frequency_personel”,
        “events”:[
            {
                “data”:{
                    “URLCertificationType”:”digest”,
                    “activePostCount”:1,
                    “channelID”:4,
                    “dataType”:”HFPD”,
                    “dateTime”:”2019-07-24T14:35:12.000+08:00″,
                    “eventDescription”:”High frequency personnel detection”,
                    “eventState”:”active”,
                    “eventType”:”HFPD”,
                    “faceCapture”:[
                        {
                            “faces”:[
                                {
                                    “URL”:”http://10.67.184.150:80/picture/Streaming/tracks/403/?name=ch0004_00000000137067916851200050361&size=50361″,
                                    “age”:{
                                        “ageGroup”:”young”
                                    },
                                    “faceId”:1,
                                    “faceRect”:{
                                        “height”:0.187,
                                        “width”:0.105,
                                        “x”:0.54800000000000004,
                                        “y”:0.501
                                    },
                                    “gender”:{
                                        “value”:”male”
                                    },
                                    “glass”:{
                                        “value”:”no”
                                    },
                                    “mask”:{
                                        “value”:”no”
                                    },
                                    “occurrences”:36,
                                    “smile”:{
                                        “value”:”no”
                                    }
                                }
                            ],
                            “recordDataIndex”:”00ch0004_00000000137080834232400010296″,
                            “targetAttrs”:{
                                “bkgUrl”:”http://10.67.184.150:80/picture/Streaming/tracks/403/?name=ch0004_00000000137067921971200140834&size=140834″,
                                “cameraIndexCode”:”d3d756a08db84e43ac4118f5a7163750″,
                                “deviceChannel”:4,
                                “deviceIndexCode”:”e836d6728c2947f78a7865b0ba2a3c03″,
                                “deviceName”:”大超脑184.150″,
                                “faceTime”:”2019-07-24T14:35:12.000+08:00″,
                                “imageServerCode”:””,
                                “picServerIndexCode”: “0265add8-6a74-40da-a302-36f45ba15fef”
                            }
                        }
                    ],
                    “ipAddress”:”10.67.184.150″,
                    “macAddress”:”58:03:fb:1f:f2:be”,
                    “portNo”:8500,
                    “protocol”:”HTTP”,
                    “recvTime”:”2019-07-24T14:36:30.175+08:00″,
                    “sendTime”:”2019-07-24T14:36:30.176+08:00″
                },
                “eventId”:”33B979A3-5E36-3844-BCDE-6EF10F4F82FF”,
                “eventType”:132865,
                “happenTime”:”2019-07-24T14:35:12.000+08:00″,
                “srcIndex”:”d3d756a08db84e43ac4118f5a7163750″,
                “srcParentIndex”:”e836d6728c2947f78a7865b0ba2a3c03″,
                “srcType”:”camera”,
                “status”:0,
                “timeout”:0
            }
        ],
        “sendTime”:”2019-07-24T14:36:30.176+08:00″,
        “uids”:[
            “Ren_test”,
            “admin”
        ]
    }
}

5.4 附录E 返回码说明

5.4.1 返回码说明

5.4.1.1 附录E.5人脸监控错误码

———————–

返回码	描述	消除建议
0x0623003e	业务抛出了未捕捉的异常	1，打开路径人脸监控应用服务的日志地址。 2，拷贝日志，联系研发人员排查。
0x06234000	必填字段不能为空	对照提示和文档查看是否有必填字段为空。
0x06234001	字段合法性校验不通过	对照提示和文档查看是否有字段非法。
0x0621100b	人脸分组已经被关联到识别计划上,删除分组失败	在删除分组前，先删除分组对应的识别计划。
0x0621100c	无效的人脸分组编号	该人脸分组编号对应的人脸分组不存在或已经删除。
0x0621100d	重复的人脸编号	入参中存在重复的人脸编号。
0x0621100e	上传任务已过期或唯一标识不正确	回查上传任务的唯一标识不存在。
0x0622300e	图片上传失败	查看ASW服务是否正常工作。
0x0622300f	图片下载失败	查看上传的图片是否能够正常访问。
0x0622300d	图片服务器资源池未配置	前往运管中心配置ASW服务的资源池。
0x0621200b	脸谱建模失败	确认平台有至少一台脸谱在线且脸谱正常工作。
0x0621200d	人脸数量达到平台上限	删除部分人脸。
0x0621200e	人脸分组中人脸数量达到上限	删除部分分组内的人脸。
0x06220203	从云存储下载图片失败	查看ASW服务是否正常工作。
0x06223003	图片像素大小不符合规定	上传大小在10KB到200KB见的图片。
0x06223008	图片格式类型不支持	上传JPG格式的图片。
0x0621100d	重复的编号	查看入参中是否有重复的编号。
0x1f93003e	业务抛出了未捕捉的异常	1，打开路径通用智能服务的日志地址。2，拷贝日志，联系研发人员排查。
0x1f934000	必填字段不能为空
0x1f93003e	业务抛出了未捕捉的异常	打开路径通用智能服务的日志地址。 2，拷贝日志，联系研发人员排查。
0x1f934000	必填字段不能为空	对照提示和文档查看是否有必填字段为空。
0x1f934001	字段合法性校验不通过	对照提示和文档查看是否有字段非法。
0x1f91100b	人脸分组已经被关联到识别计划上,删除分组失败	在删除分组前，先删除分组对应的识别计划。
0x1f91100c	无效的人脸分组编号	该人脸分组编号对应的人脸分组不存在或已经删除。
0x1f91100d	重复的人脸编号	入参中存在重复的人脸编号。
0x1f91100e	上传任务已过期或唯一标识不正确	回查上传任务的唯一标识不存在。
0x1f92300e	图片上传失败	查看ASW服务是否正常工作。
0x1f92300f	图片下载失败	查看上传的图片是否能够正常访问。
0x1f92300d	图片服务器资源池未配置	前往运管中心配置ASW服务的资源池。
0x1f91200b	脸谱建模失败	确认有至少一台脸谱在线且脸谱正常工作。
0x1f91200d	人脸数量达到上限	删除部分人脸。
0x1f91200e	人脸分组中人脸数量达到上限	删除部分分组内的人脸。
0x1f920203	从云存储下载图片失败	查看ASW服务是否正常工作。
0x1f923003	图片像素大小不符合规定	上传大小在10KB到200KB见的图片。
0x1f923008	图片格式类型不支持	上传JPG格式的图片。
0x1f91100d	重复的编号	查看入参中是否有重复的编号。
0x1f910000	tagId 为空	tagId为空
0x1f910001	tagId长度非法	tagId长度超过32
0x1f910002	tagId包含特殊字符	tagId包含特殊字符
0x1f910011	通用智能服务未知错误	1，打开路径通用智能服务的日志地址。2，拷贝日志，联系研发人员排查。
0x1f911006	tagId对应的人脸分组id不存在	1，检查该分组id是否存在。2，拷贝日志，联系研发人员排查。
0x1f911000	分组名称为空	name为空
0x1f911001	人脸分组名称长度非法	name长度大于32
0x1f911002	人脸分组名称包含特殊字符	name含有特殊字符
0x1f911005	人脸分组描述长度非法	description长度大于128
0x1f911003	人脸分组名称重复	name已经存在
0x1f911004	人脸分组数量超过限制	人脸分组数量超过256
0x1f913016	评分失败	评分失败，checkResult为false失败原因详见statusCode、statusMessage
0x1f902302	评分算法未授权	评分算法未授权
0x1f902066	参数错误	入参错误，检查入参，返回data为null
0x1f902197	base64解码失败	base64解码失败，检查入参，返回data为null
0x1f910010	算法段不存在	算法段不存在
0x1f900000	未知错误	未知错误，检查入参，返回data为null
0x1f91300b	图片url为空	facePicUrl或facePicBinaryData为空
0x1f902300	人脸检测错误（图片格式不符合要求、检测不到人脸等情况时）	使用符合要求的图片
0x1f902301	人脸检测超时	使用符合要求的图片
0x1f902303	图片两眼间距过小	使用符合要求的图片
0x1f902304	图片彩色置信度过低	使用符合要求的图片
0x1f902305	图片人脸角度过大	使用符合要求的图片
0x1f902306	图片清晰度过低	使用符合要求的图片
0x1f902307	图片过曝或过暗（灰阶值不符合要求）	使用符合要求的图片
0x1f902308	图片遮挡严重	使用符合要求的图片
0x1f902309	图片分数过低	使用符合要求的图片

# 附录E.other

5.4.1.1.1 附录E.other.1资源目录错误码

———————-

B类常规错误码	错误分类及错误原因	错误描述（英文）
0x00072001	参数错误：必填参数为空	The required parameter $$ is blank.
0x00072002	参数错误：参数范围不正确	The value of parameter $$ is out of range.
0x00072003	参数错误：参数格式不正确	The format of parameter $$ is not correct.
0x00072004	参数错误：未指定分页大小或者分页过大导致返回报文过长	Return message too long, please setting paging size.
0x00052101	服务错误：服务性能已达上限	Service performance reaches the upper limit.
0x00052102	服务错误：服务异常	Service error.
0x00052103	服务错误：服务响应超时	Service response timeout.
0x00052104	服务错误：服务不可用	Service unavailable.
0x00072201	资源异常：资源访问未授权	Resource unauthorized.
0x00072202	资源异常：资源不存在	Invalid resource.
0x00072203	资源异常：License数量受限	License reaches the upper limit.
0x00072204	资源异常：License未提供该功能	License prohibits the use of this function.
0x00052301	其他错误：其他未知错误	Other error.
0x14c00002	该用户不存在	The input parameter [ userId ] invalid, user does not exist.
0x14c00003	区域查询条件sonOrgIndexCodes 不合法	The required parameter sonOrgIndexCodes takes effect with the condition of parameters:parentIndexCodes、regionType、regionName are null.
0x14c00004	资源查询条件containSubRegion、exactCondition 不合法	The required parameter containSubRegiontakes effect with the condition of the regionIndexCodes is not null， regionIndexCodes only has one value ，and the containSubRegion and exactCondition not both exists.
0x14c00005	资源类型resourceType、权限码authCodes错误；	The parameter[resourceType/authCodes] is wrong.The detailed reasons may refer to returned msg.
0x14c00015	当前入参非系统唯一标识	$$ is not unique indication
0x14c00016	Token校验失败	Token Invalid! request forbidden!
0x14c00017	SecuSID已过期	SecuSID is expired! please get new SecuSiD by keyExChange!
0x14c00018	密钥交换失败	exchage key fail! please check your post paramers!
0x14c00019	加密数据失败	encrypt data fail!
0x14c00020	解密数据失败	decrypt data fail!
0x14c02301	批量操作时部分成功、部分失败	batch add/del fail！
0x14c02302	管理相关权限校验失败	the privilege of manage check fail！
0x14c02303	资源不存在	resource is not exist！
0x14c02304	请求超时	Request Timeout

## 附录E.other.2 事件订阅返回码说明
————————–

返回码	说明
0	success
0x00072001	The required parameter $$ is blank.
0x00072002	The value of Parameter $$ is out of range.
0x00072003	The format of Parameter $$ is not correct.
0x02c0112d	token check fail
0x02c0112e	get reg param fail

5.4.1.1.2 附录E.other.3卡片错误码

———————-

返回码类别	描述	消除建议	errorcode	msg
卡号已存在	待开卡列表中删除已存在的卡号	0x04a12700	cardNo $$ is exists
卡号不存在	退卡接口中卡号必须是已存在的正常卡	0x04a12701	cardNo $$ is not exists
挂失卡不能退卡	输入正常卡的卡号	0x04a12702	cardNo $$ status is loss，can’t back
人员与卡号不是所属关系	修改人员id或者卡号，确保人员id是卡号所属人员的人员id	0x04a12703	cardNo $$ don’t belong to personId $$
根据参数无法查找到正确记录信息	检查输入参数是否有误	0x0531f00e	The required parameter $$ can not find corresponding record.
参数校验失败	检查输入参数是否有误	0x04a12600	Param $$ is error
集合大小超过50	检查输入的集合大小，将集合大小控制在50以下	0x04a12601	list $$ size over 50

5.4.1.1.3 附录E.other.4网管错误码

———————-

错误码	错误码描述	错误码建议
0x0350f003	表结构不存在	1.请检查相关表结构。
0x03511014	告警信息不存在	1.查看错误日志。
0x0350f002	配置项不存在	1.请检查相关自检配置项。
0x03511013	队列参数超过限制长度	1.查看错误日志。
0x0350f001	文件或文件夹不存在	1.请检查相关文件或者文件夹。
0x03511015	白名单过滤	1.查看错误日志。
0x0350f007	数据库表结构初始化失败	1.请检查数据库表结构初始化。
0x03511018	参数解析失败	1.查看错误日志。
0x0350f006	数据库错误	1.请检查数据库是否正常。
0x03511017	开始时间大于结束时间	1.查看错误日志。
0x0350f005	数据库连接失败	1.请检查数据库配置项。
0x0350f004	索引不存在	1.请检查相关索引。
0x03511019	数据查询失败	1.查看错误日志。
0x03511010	状态属性status参数非法（0-离线，1-在线，-1-未检测）	1.查看错误日志。
0x03511012	没有告警信息%s	1.查看错误日志。
0x03511011	参数不合法	1.查看错误日志。
0x0351100c	分页信息pageSize格式错误（正整数）	1.查看错误日志。
0x0351100b	分页信息pageNo格式错误（正整数）	1.查看错误日志。
0x0351100e	查询参数includeSubNode格式错误（1-包含，0-不包含）	1.查看错误日志。
0x0351100d	区域编码regionId不能为空	1.查看错误日志。
0x0351100f	排序参数错误	1.查看错误日志。
0x0351100a	用户ID不存在(未定义)	1.查看错误日志。
0x03511003	没有找到此indexCode的记录	1.查看错误日志。
0x03511002	资源还原失败	1.查看错误日志。
0x03505020	CMDB事件报文错误	1.查看错误日志。
0x03511005	资源编码indexCode为空	1.查看错误日志。
0x03511004	接口验证失败，token为空或者错误	1.查看错误日志。
0x03511007	资源类型不存在（资源类型未定义）	1.查看错误日志。
0x03511006	时间参数格式错误，解析失败(时间参数格式：yyyy-MM-dd)	1.查看错误日志。
0x03511009	用户id不能为空	1.查看错误日志。
0x03511008	资源模型属性不存在（未定义）	1.查看错误日志。
0x03511001	主键还原失败	1.查看错误日志。
0x0350e00b	远程请求错误	1.查看错误日志。
0x0350e00a	创建请求失败	1.查看错误日志。
0x03505019	告警操作错误	1.查看错误日志。
0x0350e00f	组件配置文件初始化失败	1.查看错误日志。
0x03505018	告警接受错误	1.查看错误日志。
0x0350e00e	Token认证错误	1.查看错误日志。
0x0350e00d	数据库初始化错误	1.查看错误日志。
0x0350e00c	请求其他组件错误	1.查看错误日志。
0x03512005	资源下发失败错误	1.查看错误日志。
0x03512006	汉字编码失败	1.查看错误日志。
0x03512003	业务日志初始化失败	1.查看错误日志。
0x03512004	手动同步错误	1.查看错误日志。
0x0350501e	启用的告警规则为空	1.查看错误日志。
0x0350501d	告警状态缓存修改失败	1.查看错误日志。
0x0350501f	告警导出错误	1.查看错误日志。
0x03512001	客户端请求错误	1.查看错误日志。
0x03512002	组件应用容器关闭错误	1.查看错误日志。
0x0350501c	告警状态缓存初始化失败	1.查看错误日志。
0x03505022	告警数据处理错误	1.查看错误日志。
0x0351102a	告警状态参数错误	1.查看错误日志。
0x03505021	解析指标报文错误	1.查看错误日志。
0x03511025	统计指标值参数错误	1.查看错误日志。
0x03511024	统计指标空	1.查看错误日志。
0x03511027	告警时间为空	1.查看错误日志。
0x03511026	资源属性指标不存在	1.查看错误日志。
0x03511029	该资源类型接口不支持	1.联系组件开发人员。
0x03511028	告警指标为空	1.查看错误日志。
0x0350a002	注册平台KPI信息失败	1.查看错误日志。
0x0350a001	注册平台指标信息失败	1.查看错误日志。
0x0350a004	保活失败	1.查看错误日志。
0x0350a003	录入平台上报数据失败，数据格式不合法	1.查看错误日志。
0x0350a005	注销平台信息失败	1.查看错误日志。
0x03511021	触发门限参数异常	1.查看错误日志。
0x03511020	资源类型参数为空	1.查看错误日志。
0x03511023	告警id为空	1.查看错误日志。
0x03511022	恢复门限参数异常	1.查看错误日志。
0x0351101d	告警等级参数错误	1.查看错误日志。
0x0351101c	告警等级参数为空	1.查看错误日志。
0x0351101f	告警类型参数错误	1.查看错误日志。
0x0351101e	告警类型参数为空	1.查看错误日志。
0x03506005	资源编辑失败	1.查看错误日志。
0x03506004	资源列表导出失败	1.查看错误日志。
0x03506006	资源删除失败	1.查看错误日志。
0x03506001	资源类型查询失败	1.查看错误日志。
0x03506003	资源详情查询失败	1.查看错误日志。
0x0351101b	网域ID为空	1.查看错误日志。
0x03506002	资源管理分页查询	1.查看错误日志。
0x0351101a	请求参数为空	1.查看错误日志。
0x03506021	资源全量下发失败	1.查看错误日志。
0x03518005	定时处理tb_subscriber_alarm_info表里过期记录失败	1.查看错误日志。
0x03518006	SecuDK 握手验证失败	1.查看错误日志。
0x03518007	SQL 语句执行错误	1.查看错误日志。
0x03518001	握手失败	1.查看错误日志。
0x03501006	查询监控点历史状态失败	1.查看错误日志。
0x03501005	监控点列表导出失败	1.查看错误日志。
0x03501004	监控点资源详情查询失败	1.查看错误日志。
0x03501003	监控点分辨率情况及总数失败	1.查看错误日志。
0x03501009	监控点资源详情查询失败	1.查看错误日志。
0x03506019	导入历史详情查询失败	1.查看错误日志。
0x03501008	编码设备在线情况及总数失败	1.查看错误日志。
0x03501007	编码设备列表查询失败	1.查看错误日志。
0x03506016	资源导入模板下载失败	1.查看错误日志。
0x03506018	导入历史查询失败	1.查看错误日志。
0x03506017	资源导入失败	1.查看错误日志。
0x03501002	监控点在线情况及总数失败	1.查看错误日志。
0x03501001	监控点列表查询失败	1.查看错误日志。
0x0350601e	资源导入，保存资源失败	1.查看错误日志。
0x0350601b	资源绑定失败	1.查看错误日志。
0x0350601a	确认导入资源	1.查看错误日志。
0x0350601c	资源解绑失败	1.查看错误日志。
0x03501017	视频质量统计情况查询失败	1.查看错误日志。
0x03501016	视频质量统计列表查询失败	1.查看错误日志。
0x03501015	录像检查列表导出失败	1.查看错误日志。
0x03501014	资源历史录像情况查询失败	1.查看错误日志。
0x03501019	视频质量统计详情查询失败	1.查看错误日志。
0x03501018	视频质量统计指标情况查询失败	1.查看错误日志。
0x03506026	资源目录操作失败	1.查看错误日志。
0x03501013	资源录像详情查询失败	1.查看错误日志。
0x03506023	资源增量下发失败	1.查看错误日志。
0x03501012	录像检查结果列表查询失败	1.查看错误日志。
0x03506022	资源全量下发失败	1.查看错误日志。
0x03501011	编码设备列表导出失败	1.查看错误日志。
0x03506025	创建巡检计划失败	1.查看错误日志。
0x03501010	编码设备历史状态查询失败	1.查看错误日志。
0x03506024	生成CSV文件失败	1.查看错误日志。
0x03507010	业务概览大数据以图搜图错误	1.查看错误日志。
0x03507011	业务概览卡口错误	1.查看错误日志。
0x03501028	门禁设备列表查询	1.查看错误日志。
0x03501027	门禁设备类型查询	1.查看错误日志。
0x03501026	门禁设备在线状态查询	1.查看错误日志。
0x0350ff00	参数校验失败	1.检查参数。
0x03501025	组织区域树查询	1.查看错误日志。
0x0350ff01	获取区域失败	1. 联系管理员。
0x03501029	门禁设备详情查询	1.查看错误日志。
0x03501020	视频质量统计历史诊断详情查询失败	1.查看错误日志。
0x0350ff06	查询设备历史状态失败	1. 联系管理员。
0x0350ff07	分页查询设备在线状态失败	1. 联系管理员。
0x0350ff08	查询用户信息失败	1. 联系管理员。
0x03501024	视频预览失败	1.查看错误日志。
0x0350ff02	获取组件地址失败	1.查看日志看时候哪个组件地址获取失败。2.查看组件是否运行正常。
0x03501023	一键图像重巡失败	1.查看错误日志。
0x0350ff03	查询设备在线率失败	1. 联系管理员。
0x03501022	图像重巡监控点列表查询失败	1.查看错误日志。
0x0350ff04	获取门禁设备类型失败	1. 联系管理员。
0x03501021	视频质量统计列表导出失败	1.查看错误日志。
0x0350ff05	导出设备在线状态失败	1. 联系管理员。
0x0350102f	解码设备历史查询失败	1.查看错误日志。
0x0350102e	解码设备详情查询失败	1.查看错误日志。
0x0350700e	业务概览云分析统计错误	1.查看错误日志。
0x0350700f	业务概览设备能力集统计错误	1.查看错误日志。
0x0350700c	运维概况列表详情查询失败	1.查看错误日志。
0x0350102d	解码设备列表查询失败	1.查看错误日志。
0x03513002	数据转换失败	1.查看错误日志。
0x0350700d	运维概况小时归并失败	1.查看错误日志。
0x03513003	定时任务停止失败	1.查看错误日志。
0x0350102b	门禁设备历史记录查询	1.查看错误日志。
0x0350102a	门禁设备导出	1.查看错误日志。
0x03513001	数据设置失败	1.查看错误日志。
0x03502008	区域运维统计统计查询失败	1.查看错误日志。
0x03501039	清理历史数据失败	1.查看错误日志。
0x03502009	区域运维统计图表查询失败	1.查看错误日志。
0x03501038	解析Double数据失败	1.查看错误日志。
0x03501037	巡检入库失败	1.查看错误日志。
0x03501036	存储设备导出	1.查看错误日志。
0x03502004	异常点位详情列表导出失败	1.查看错误日志。
0x03502005	录像情况统计统计查询失败	1.查看错误日志。
0x03502006	录像情况统计图表查询失败	1.查看错误日志。
0x03502007	录像情况统计统计导出失败	1.查看错误日志。
0x03501031	解码设备在导出失败	1.查看错误日志。
0x03502001	视频质量统计查询失败	1.查看错误日志。
0x03501030	解码设备在线率查询失败	1.查看错误日志。
0x03502002	异常点位详情查询失败	1.查看错误日志。
0x03502003	视频质量统计统计导出失败	1.查看错误日志。
0x03501035	存储设备在线率查询失败	1.查看错误日志。
0x03501034	存储设备历史	1.查看错误日志。
0x03507012	业务概览趋势图错误	1.查看错误日志。
0x03501033	存储设备详情查询失败	1.查看错误日志。
0x03501032	存储设备列表查询失败	1.查看错误日志。
0x03514008	测试连通性失败	1.查看错误日志。
0x03508001	获取一键运维详情失败	1.查看错误日志。
0x03514007	实时巡检失败	1.查看错误日志。
0x03514006	生成全量数据失败	1.查看错误日志。
0x03514005	删除下级平台失败	1.查看错误日志。
0x0350103f	录像巡检删除巡检结果失败	1.查看错误日志。
0x03514009	NCG批量保存失败	1.查看错误日志。
0x0350103a	巡检数据每日归并失败	1.查看错误日志。
0x03514004	更新下级平台失败	1.查看错误日志。
0x0350103e	录像巡检保存巡检结果失败	1.查看错误日志。
0x03514003	创建下级平台失败	1.查看错误日志。
0x0350103d	录像巡检保存录像计划失败	1.查看错误日志。
0x03514002	下级平台详情获取失败	1.查看错误日志。
0x0350103c	接口内部错误	1.查看错误日志。
0x03514001	下级平台列表查询获取失败	1.查看错误日志。
0x0350103b	参数校验失败	1.查看错误日志。
0x0350ff20	组件http通信失败	1.查看日志看时候哪个组件地址获取失败。2.查看组件是否运行正常。
0x03502019	监控点实时统计详情查询失败	1.查看错误日志。
0x03501049	录像保存天数巡检保存归并结果失败	1.查看错误日志。
0x0350ff21	查询权限区域列表失败	1. 联系管理员。
0x03501048	录像保存天数巡检保存巡检结果失败	1.查看错误日志。
0x03501047	录像巡检更新资源属性失败	1.查看错误日志。
0x03502015	取流情况统计查询失败	1.查看错误日志。
0x03502016	取流情况统图表计查询失败	1.查看错误日志。
0x03502017	取流情况统图表计查询失败	1.查看错误日志。
0x03502018	监控点实时统计列表查询失败	1.查看错误日志。
0x03502011	区域运维统计权重值修改失败	1.查看错误日志。
0x03501042	录像巡检消息为空	1.查看错误日志。
0x03502012	区域运维统计导出失败	1.查看错误日志。
0x03501041	录像巡检配置信息为空	1.查看错误日志。
0x03502013	区域运维统计详情导出失败	1.查看错误日志。
0x03501040	录像巡检消息格式转换失败	1.查看错误日志。
0x03501046	录像巡检消息实体转换失败	1.查看错误日志。
0x03501045	拷贝录像计划失败	1.查看错误日志。
0x03501044	录像巡检查询录像计划失败	1.查看错误日志。
0x03502010	区域运维统计权重值查询失败	1.查看错误日志。
0x03501043	录像巡检保存巡检归并结果失败	1.查看错误日志。
0x0350201e	监控点离线时长统计导出失败	1.查看错误日志。
0x03501060	统计报表云分析单元列表导出失败	1.查看错误日志。
0x0350201a	监控点实时统计图表查询失败	1.查看错误日志。
0x0350104a	录像保存天数巡检消息实体转换失败	1.查看错误日志。
0x0350201b	监控点实时统计列表导出失败	1.查看错误日志。
0x0350201c	监控点实时统计详情导出失败	1.查看错误日志。
0x0350201d	监控点离线时长统计查询失败	1.查看错误日志。
0x0350104c	VQD结果矫正失败	1.查看错误日志。
0x03501059	云存储磁盘汇总信息查询失败	1.查看错误日志。
0x03501058	云存储汇总信息查询失败	1.查看错误日志。
0x03501053	云存储节点详情查询失败	1.查看错误日志。
0x03501052	云存储详情查询失败	1.查看错误日志。
0x03501051	云存储节点列表查询失败	1.查看错误日志。
0x03501050	云存储列表查询失败	1.查看错误日志。
0x03501057	云存储列表导出失败	1.查看错误日志。
0x03508004	导出点播状态结果失败	1.查看错误日志。
0x03501056	云存储监控点列表查询失败	1.查看错误日志。
0x03501055	云存储存储卷列表查询失败	1.查看错误日志。
0x03508002	导出一键运维结果失败	1.查看错误日志。
0x03501054	云存储磁盘列表查询失败	1.查看错误日志。
0x03508003	一键运维巡检失败	1.查看错误日志。
0x0350d001	保存缓存信息失败	1.查看错误日志。
0x0350d004	删除缓存信息失败	1.查看错误日志。
0x0350d005	REDIS初始化失败	1.查看错误日志。
0x0350d002	获取缓存信息失败	1.查看错误日志。
0x0350d003	批量获取缓存信息失败	1.查看错误日志。
0x0350105c	大数据集群列表导出失败	1.查看错误日志。
0x03514022	检验是否已经存在失败	1.查看错误日志。
0x0350d008	数据库执行失败	1.查看错误日志。
0x0350105b	云存储存储卷汇总信息查询失败	1.查看错误日志。
0x03514021	录像CSV解析失败	1.查看错误日志。
0x0350d009	热点过滤器初始化失败	1.查看错误日志。
0x0350105a	云存储监控点汇总信息查询失败	1.查看错误日志。
0x03514020	录像CSV解析失败	1.查看错误日志。
0x0350d006	事件发布失败	1.查看错误日志。
0x0350d007	模型获取失败	1.查看错误日志。
0x0350105f	云分析单元列表导出失败	1.查看错误日志。
0x0350105e	云分析集群列表导出失败	1.查看错误日志。
0x03514024	录像保存天数CSV解析失败	1.查看错误日志。
0x0350105d	大数据单元列表导出失败	1.查看错误日志。
0x03514023	录像保存天数CSV生成失败	1.查看错误日志。
0x0351401f	socket创建失败	1.查看错误日志。
0x03503005	获取区域数量失败	1.查看错误日志。
0x03503006	获取区域资源失败	1.查看错误日志。
0x03503007	获取用户数量失败	1.查看错误日志。
0x03503008	获取用户资源失败	1.查看错误日志。
0x03503001	获取监控点数量失败	1.查看错误日志。
0x0351401a	文件不存在	1.查看错误日志。
0x03503002	获取监控点资源失败	1.查看错误日志。
0x03503003	获取编码设备数量失败	1.查看错误日志。
0x03503004	获取编码设备资源失败	1.查看错误日志。
0x0351401e	HASH生成失败	1.查看错误日志。
0x0351401d	文件生成失败	1.查看错误日志。
0x0351401c	VQD增量生成失败	1.查看错误日志。
0x0351401b	文件重命名失败	1.查看错误日志。
0x03514019	NCG获取远程文件失败	1.查看错误日志。
0x03509002	添加拓扑树失败	1.查看错误日志。
0x03514018	NCG读取增量失败	1.查看错误日志。
0x03509001	查询拓扑树失败	1.查看错误日志。
0x03514017	NCG全量失败	1.查看错误日志。
0x03514016	录像CSV生成失败	1.查看错误日志。
0x0350300e	获取同步任务失败	1.查看错误日志。
0x0350300f	同步数据失败	1.查看错误日志。
0x03514011	CSV解析失败	1.查看错误日志。
0x0350300b	初始化License信息失败	1.查看错误日志。
0x03514010	VQD批量入库失败	1.查看错误日志。
0x0350300c	增量消息解析异常	1.查看错误日志。
0x0350300d	更新License异常	1.查看错误日志。
0x03514015	录像CSV生成失败	1.查看错误日志。
0x03514014	IO错误失败	1.查看错误日志。
0x03514013	ping命令失败	1.查看错误日志。
0x03514012	socket关闭失败	1.查看错误日志。
0x0351400f	VQD级联解析失败	1.查看错误日志。
0x0351400e	获取NCG服务失败	1.查看错误日志。
0x03503012	视频监控响应失败	1.查看错误日志。
0x0351400d	获取服务节点失败	1.查看错误日志。
0x0351400c	ncg状态入库错误	1.查看错误日志。
0x03503010	加解密失败	1.查看错误日志。
0x0351400b	IO流关闭失败	1.查看错误日志。
0x03503011	同步任务调度异常	1.查看错误日志。
0x0351400a	游标文件设置失败	1.查看错误日志。
0x03510002	mq初始化失败	1.查看错误日志。
0x03510001	秘钥初始化失败	1.查看错误日志。
0x03515019	生成消防设备资源全量文件失败	1.查看错误日志。
0x03510004	mq消息入库失败	1.查看错误日志。
0x03515018	生成可视对讲资源增量文件失败	1.查看错误日志。
0x03510003	mq密码解码失败	1.查看错误日志。
0x03509010	拓扑保存失败	1.查看错误日志。
0x03515017	生成可视对讲资源全量文件失败	1.查看错误日志。
0x03510006	巡检结果接收mq的目的错误	1.查看错误日志。
0x03510005	巡检结果接收mq消息为空	1.查看错误日志。
0x03510008	秘钥交换握手失败	1.查看错误日志。
0x03510007	巡检结果线程池停止失败	1.查看错误日志。
0x03515012	生成大数据单元资源增量文件失败	1.查看错误日志。
0x03515011	生成大数据单元资源全量文件失败	1.查看错误日志。
0x03515010	生成大数据集群资源增量文件失败	1.查看错误日志。
0x03515016	生成梯控读卡器资源增量文件失败	1.查看错误日志。
0x03515015	生成梯控读卡器资源全量文件失败	1.查看错误日志。
0x03515014	生成梯控主机资源增量文件失败	1.查看错误日志。
0x03515013	生成梯控主机资源全量文件失败	1.查看错误日志。
0x0350d00a	全量缓存初始化失败	1.查看错误日志。
0x0351500f	生成大数据集群资源全量文件失败	1.查看错误日志。
0x0350d00d	快照配置失败	1.查看错误日志。
0x0350d00e	版本配置初始化失败	1.查看错误日志。
0x0350d00b	模型校验失败	1.查看错误日志。
0x0350d00c	CSV文件读写错误	1.查看错误日志。
0x0351500a	生成存储设备资源增量文件失败	1.查看错误日志。
0x03510009	查询录像配置失败	1.查看错误日志。
0x03509009	查询拓扑图详情失败	1.查看错误日志。
0x0350d00f	版本读写失败	1.查看错误日志。
0x03509008	添加拓扑节点失败	1.查看错误日志。
0x03509007	添加网元失败	1.查看错误日志。
0x03509006	查询未关联的拓扑节点	1.查看错误日志。
0x0351500e	生成云分析单元资源增量文件失败	1.查看错误日志。
0x03509005	删除拓扑树失败	1.查看错误日志。
0x0351500d	生成云分析单元资源全量文件失败	1.查看错误日志。
0x03509004	更新拓扑树失败	1.查看错误日志。
0x0351500c	生成云分析资源增量文件失败	1.查看错误日志。
0x03509003	拓扑图参数错误	1.查看错误日志。
0x0351500b	生成云分析资源全量文件失败	1.查看错误日志。
0x03515009	生成存储设备资源全量文件失败	1.查看错误日志。
0x03515008	生成区域资源增量文件失败	1.查看错误日志。
0x03515007	生成区域资源全量文件失败	1.查看错误日志。
0x0350d010	采集数据校验失败	1.查看错误日志。
0x03515006	生成编码设备资源增量文件失败	1.查看错误日志。
0x03515001	生成监控点资源全量文件失败	1.查看错误日志。
0x0350900f	查询拓扑节点详情失败	1.查看错误日志。
0x03515005	生成编码设备资源全量文件失败	1.查看错误日志。
0x0350900e	删除拓扑关系失败	1.查看错误日志。
0x03515004	生成解码设备资源增量文件失败	1.查看错误日志。
0x0350900d	更新拓扑关系失败	1.查看错误日志。
0x03515003	生成解码设备资源全量文件失败	1.查看错误日志。
0x0350900c	添加拓扑关系失败	1.查看错误日志。
0x03515002	生成监控点资源增量文件失败	1.查看错误日志。
0x0350900b	更新拓扑节点失败	1.查看错误日志。
0x0350900a	删除拓扑节点失败	1.查看错误日志。
0x03504003	巡检资源增量下发失败	1.查看错误日志。
0x03504002	巡检资源同步解锁失败	1.查看错误日志。
0x03504001	巡检资源下发失败	1.查看错误日志。
0x0350e013	数据库连接失败	1.查看错误日志。
0x0350e012	本地加密错误	1.查看错误日志。
0x0350e011	获取配置文件参数失败	1.查看错误日志。
0x0350e010	获取组件信息失败	1.查看错误日志。
0x0350400b	巡检结果ntp入库失败	1.查看错误日志。
0x0350400a	消息队列推送状态失败	1.查看错误日志。
0x0350e002	加载多语言错误	1.查看错误日志。
0x0350e001	导出excel文件错误	1.查看错误日志。
0x03515028	生成云存储节点资源增量文件失败	1.查看错误日志。
0x0350e006	握手错误	1.查看错误日志。
0x0350e005	配置文件加载错误	1.查看错误日志。
0x0350e004	文件解压错误	1.查看错误日志。
0x0350e003	类加载错误	1.查看错误日志。
0x03515023	生成录像计划全量文件失败	1.查看错误日志。
0x0350e009	远程地址不可达	1.查看错误日志。
0x03515022	生成门禁读卡器资源增量文件失败	1.查看错误日志。
0x0350e008	脚本执行错误	1.查看错误日志。
0x03515021	生成门禁读卡器资源全量文件失败	1.查看错误日志。
0x0350e007	CloaderDHI初始化错误	1.查看错误日志。
0x03515020	生成门禁点资源资源增量文件失败	1.查看错误日志。
0x03515027	生成云存储节点资源全量文件失败	1.查看错误日志。
0x03515026	生成云存储资源增量文件失败	1.查看错误日志。
0x03515025	生成云存储资源全量文件失败	1.查看错误日志。
0x03515024	生成录像计划增量文件失败	1.查看错误日志。
0x0351000a	恢复默认的录像配置信息出错	1.查看错误日志。
0x0351501b	生成消防传感器资源全量文件失败	1.查看错误日志。
0x0351501a	生成消防设备资源增量文件失败	1.查看错误日志。
0x0351501f	生成门禁点资源资源全量文件失败	1.查看错误日志。
0x0351501e	生成门禁设备资源增量文件失败	1.查看错误日志。
0x0351501d	生成门禁设备资源全量文件失败	1.查看错误日志。
0x0351501c	生成消防传感器资源增量文件失败	1.查看错误日志。

5.5 附录I 人脸监控应用服务支持设备型号列表

5.5.1 附录I人脸监控应用服务支持设备型号列表

匹配规则为模糊匹配，用设备的真实型号模糊匹配型号列表，若能匹配上，就说明人脸监控应用服务支持这款设备。

5.5.1.1 超脑

支持型号	备注
9632NX-I8/FA
96032NX
9664NX
96064NX
96128NX

5.5.1.2 深眸

支持型号	备注
2CD8426FWD/F
2CD8627FWD/F
2CD8527FWD/F

5.5.1.3 抓拍机

支持型号	备注
2CD70
2CD9365-F
2CD7627FWD/F
2CD7667F/F
2CD7027FWD/F
2CD7A27FWD/F
2CD6124FWD-IZ/F
2CD6024FWD-A/F
2CD6026FWD
2CD6124FWD-I/C
2CD7127FWD/F
2CD6124FWD-I/H
2CD8426F/B-I
2CD6810F/C
2CD9525-ASF
2CD9365-FS
2CD8627FWD/D
2PT91
2VS235-F837
2CD7T47
2CD7D47
2CD7A47
2CD7147
2CD7047
2CD7647
2CD7247

6 更新说明

6.1 资源目录

6.1.1 人员信息

6.1.1.1 人员及照片信息

1. 新增接口【根据人员唯一字段获取人员详细信息】
2. 新增接口【增量获取人员数据】
3. 新增接口【全量获取人脸照片】

6.1.1.2 组织信息

1. 新增接口【根据组织编号获取组织详细信息】
2. 新增接口【增量获取组织数据】
3. 新增接口【查询组织列表v2】V2版本相对V1来说修改如下
入参：新增参数 parentOrgIndexCodes 用于按父组织进行查询、expressions 用于指定查询条件、orderBy 用于指定排序字段、orderType 用于指定是降序还是升序排列。

6.1.1.3 卡片接口

1. 新增接口【增量获取卡片数据】
2. 新增接口【增量获取卡片数据】

7 常见问题

7.1 调用认证

l Q: 【高频问题】接口对接所需要的AppKey，AppSecret以及API网关地址，从哪里获取？
A:可以从综合安防管理平台的运管中心的管理员处获取。
注意：请注意三方平台如果会运行在不同的IP网域的情况下，每个合作方只能绑定一个网域信息，请为务必自己的调用端分配合适的合作方。
l Q: 对接调用API接口，AppKey和AppSecret在接口报文中怎么放？
A:AppKey对应head中X-Ca-Key；AppSecret作为密钥，使用HmacSHA256算法对签名字符串生成消息摘要，对消息摘要使用BASE64算法生成签名。详见协议概述-接口-调用认证 A:AppKey对应head中X-Ca-Key；AppSecret作为密钥，使用HmacSHA256算法对签名字符串生成消息摘要，对消息摘要使用BASE64算法生成签名。详见[协议概述-接口-调用认证](/docs/6a14a251f6d042319b277b26ad60aa17)

7.2 开发包和文档

l Q:平台API接口详细的开发文档以及开发的demo哪里获取？
A:可以从“下载”—“iSecure Center”—“ OpenAPI安全认证库-JAVA版本v1.1.0”或者“OpenAPI安全认证库-C\+\+版本 v1.1.0”及更高版本获取。目前仅支持JAVA和C\+\+。
l Q: 使用OpenAPI接口调用工具-JAVA版本，调用openAPI接口，报错SSLException?
A:JDK版本不匹配，目前支持JDK1.7以及1.8版本，JDK1.7只支持http请求，JDK1.8支持http和https请求。

7.3 接口调试

l Q: 【高频问题】调用OpenAPI接口，https和http请求使用什么端口？
A:http请求不支持，https请求默认使用443端口，可在平台“运行管理中心-系统维护-服务参数配置-集群代理服务”中查看，nginx 监听端口对应http请求端口，nginx https 监听端口对应https请求端口。
如果有多线路配置，需参考：ISC产品的运管中心–系统维护–参数配置/多线路配置–集群代理服务。
l Q: API在线调试页面，“是否使用MOCK”是什么意思？
A:使用Mock进行在线调试则不需要进行验证，不需要填写AppKey和AppSecret，但是返回的是假数据，这个假数据只作参考，与后台实际数据无关。
l Q: 调用接口报错，40X，50X？
A:此类报错一般都是没有找到对应组件里的接口，首先要确保此接口对应的组件已经安装，状态是否正常。使用代码调试的检查接口地址是否有误，IP与端口是否正确；在线调试的，检查接口对应的提供方配置是否正确。可在“调用统计”里查看具体调用信息。如果调用统计里查不到具体调用信息，说明根本没有请求到对应的OpenAPI接口或者调用认证有误。
l Q: 调用接口返回状态码302？
A:调用获取图片接口后，返回302重定向，是正常现象，说明调用成功。若使用Java的OpenAPI安全认证库，可使用ArtemisHttpUtil.doPostStringImgArtemis方法来调用重定向的图片接口。
l Q: 调用接口报错，返回报文提示“Consumer paramValue is null”？
A:检查调用接口所用的AppKey，对应的合作方的参数是否配置正确，userId、domainId、tagId是否都已配置。
l Q: 调用接口报错，返回报文提示“Invalid [auth-token], request forbidden”？
A:auth-token错误，在“运行管理中心-状态监控”中重启API网关后可解决。
l Q: 调用接口报错，返回报文提示“Timeout(30000)”？
A:接口响应超时，可在“调用统计”里查看具体超时时间。
l Q: 调用接口报错，返回报文提示缺少必要参数？
A:首先检查入参是否正确：必填入参是否齐全，格式是否正确，是否有多余空格之类的影响。若多个接口都提示缺少必要参数，请检查API网关的版本是否与OpenAPI资源包的版本匹配，低版本的API网关无法使用高版本的OpenAPI资源包。
l Q: API网关管理页面修改并保存提供方的地址后，接口依旧调不通？
A: 修改提供方信息之后，需要将其下包含的API重新下线再上线，修改才有效。
l Q: 调用接口报错”code”: “0x02401001″，”msg”: “Consumer inexistence!”
A: 此报错为没有访问权限的报错，请检查调用这个接口所用使用的AppKey和AppSecret是否正确，以及是否为对应合作方分配了这个接口的使用权限。
l Q: 调用接口报错”code”: “0x0240100a”，”msg”: “param convert error：Consumer paramValue is null !”
A: 此报错为合作方缺少必要参数的报错，在“合作方管理”中检查所使用的Ak/SK对应的合作方是否配置有userId、domainId、tagId参数。
l Q: 通过API网关进行事件订阅之后，怎么获取回调事件信息？
A:事件触发后，事件服务会将触发的事件报文信息回调到对应的订阅接口。
l Q: 使用对外合作方的AppKey和AppSecret，调用获取图片的接口返回的图片地址是相对地址，没有IP、PORT。
A: 检查运管中心里是否进行了对应的多线路配置，若无配置，组件就会返回相对地址。
l Q: 调用事件订阅接口订阅事件后，没有收到对应的事件报文。
A: 依次检查该事件所属组件是否成功安装，状态是否正常；调用事件订阅接口是否成功，事件码是否正确；订阅的事件是否成功触发，平台上是否有事件记录。
l Q: 调用关闭了验证的接口，接口报缺少appKey错误。
A: 因为部分接口的隐藏入参是通过appKey匹配合作方配置好的参数，关闭验证后，不会传appKey/appSecret，导致匹配不了合作方，此时需要在入参中添加这些参数，或者在接口配置中将这些参数写死。

7.4 具体接口&事件问题

7.4.1 人脸应用

**Q: 人脸服务图片下载**Q: [人脸服务图片下载](/docs/003824a4267c472b913ed3b58ab73f51#ae2b03b6) 接口有时返回正常的状态码200，有时返回302？**
A:人脸的图片下载接口，如果图片在超脑设备上，接口会返回状态码200，图片位于存储接入服务上，则返回302。
l Q: 人员识别事件报文，facePicUrl字段为什么没有IP、PORT的URI。
A:图片位于超脑上，则接口返回facePicUrl为完整的URL，图片位于存储接入服务上则为不带IP、PORT的URI。
注意：外网使用图片下载接口的时候，需要先找海康支持，对asw， uis， frs组件做多线路配置，以及路由的端口映射。</brj)同一个深眸支持配置多个识别计划。<brk)若设备上人脸分组达到上限，则有可能导致下发失败。

浏览量: 379