设备WebHook上报数据接口说明

• C1C2上报格式
  • 描述
  • 数据格式
  • 基本字段
    • 抓拍事件
      • 返回值
      • 示例
    • c1客流的统计数据
    • c2客流的统计数据
      • 返回值
      • 备注
    • 设备的状态信息
      • 可通过返回参数控制设备
        • c1设备脸库管理示例
        • c2设备脸库管理示例
        • rtmp控制示例
        • 升级推送示例
        • 校时示例
      • 备注
  • 请求示例
    • 上报脸图信息(带场景图和离线识别信息)
    • 上报脸图信息(不带场景图和离线识别信息)
    • c1客流的统计数据信息
    • c2客流的统计数据信息
    • 设备状态信息(wifi)
    • 设备状态信息(lan)
• XD500上报格式
  • XD500设备状态信息
  • XD500人脸信息
  • XD500的c2客流统计数据

C1C2上报格式

描述

AI人脸抓拍机可配置Webhook向对应的服务器地址发送人脸图、客流数据以及设备状态信息

数据格式

• 投递内容为json格式,由基本字段加事件特定字段组成。
• 请求及返回结果都使用UTF-8字符集进行编码
• 以下所有Timestamp时间戳类型,默认为GMT时间,Unix时间戳（1970年1月1日开始所经过的秒数）

基本字段

抓拍事件

返回值

第三方http服务器接收到设备投递的抓拍事件信息(即type值等于1)之后,可以将服务器识别到的结果返回给设备,设备将根据识别结果进行显示信息,开启gpio等操作。 如果含display字段,则作为识别结果显示到视频流,如不含display字段,则依次显示"name age sexual"信息。

示例

{
    "result": {
    "name": "刘德华",
    "age": 50,
    "sexual": "male",
    "display": "VIP-刘德华/男/50",
    "box_color": 654321,
    "text_color": 123456,
    "unlock_gpio": 1,
    "unlock_bluetooth": 1,
    "sound_url", "http://www.example.com/welcome.mp3"
    }
}

C1客流的统计数据

C2客流的统计数据

返回值

忽略

备注

• 设备按当天当地时间0时0分0秒开始计算每天的客流统计数据。
• 设备每隔10分钟存盘一次客流统计数据,如设备重启则从flash重新加载数据继续统计,若跨天时会立刻上报一次客流统计数据,前一天的数据会被清空,10分钟后开始上报当天的数据。

设备的状态信息

可通过返回参数控制设备

第三方http服务器接收到设备的状态信息(即type值等于3)之后,可以将time_interval返回给设备,设置设备状态信息的发送间隔（以此字段作为心跳间隔),返回参数中必须带time_interval字段.

第三方http服务器接收到设备的状态信息(即type值等于3)之后,可以将rtmp推流的控制信息返回给设备,从而实现对设备推流的控制.推流控制信息有两个控制来源,一个来自第三方返回的控制信息,一个来自赛蓝的平台. ,两种方式可以互抢,设备响应最近收到的一次控制信息,旧的控制信息会被新的覆盖.

第三方http服务器接收到设备的状态信息(即type值等于3)之后,可以将脸库管理信息返回给设备，即可对设备脸库进行查询,注册,删除,清空等操作. 由于C1和C2设备所使用的算法不同,脸库管理的消息也有部分区别,请根据设备类型选用脸库管理的协议. C1和C2设备可根据设备状态信息中的app_version进行区分,C1的人脸识别设备app_version是3开头(3.x.x.xxx),例如3.5.3.783. C2的人脸识别设备app_version是4开头(4.x.x.xxx),例如4.2.0.286.

以下是C1设备脸库管理请求参数:

以下是C1设备脸库管理回复参数: | 字段 | 类型 | 必填 | 描述 | | -------------- | --------- | ---- | ----------------------------------------------------------------------------------- | | total_face | uint | 是 | 设备中注册的人脸总数。 | | face | Array | 是 | 人脸信息数组 | | person_id | String | 否 | 注册时填写的人物的唯一标识，最大长度32字节。| | person_name | String | 否 | 注册时填写的名字，最大长度32字节。 |

C1设备脸库管理示例

type 1, 注册请求:

{
    "facelib_manage": 
    {
        "type": 1, 
        "seq": 1566358435,
        "facelib_url": "http://192.168.102.55:8000/test.json.gz"
    }            
}

type 1, 无回复:

type 2, 先清空设备脸库,再注册:

{
    "facelib_manage": 
    {
        "type": 1, 
        "seq": 1566358435,
        "facelib_url": "http://192.168.102.55:8000/test.json.gz"
    }            
}

type 2, 无回复:

type 3, 删除person_ids对应的人脸请求:

{
    "facelib_manage": {
    "type": 3, 
    "seq": 1566358435,    
    "person_ids": "1530328053_xRW2UVaF,1530328061_4DKCgzJ7,1530328068_JHL0Fa8x,1530328075_lla9K0QQ"
    },
    "time_interval":120
}

type 3, 无回复:

type 4, 清空设备脸库请求:

{
    "facelib_manage": {
    "type": 4, 
    "seq": 1566358435
    },
    "time_interval":120,
}

type 4, 无回复:

type 5, 查询设备脸库请求:

{
    "facelib_manage": {
    "type": 4, 
    "seq": 1566358435
    },
    "time_interval":120,
}

type 5, 查询设备脸库回复:

{
        "cid" : "294300000005",
        "type" : 4,
        "time" : 1542430377,
        "total_face" : 5,
        "face" : 
        [
                {
                        "person_id" : "20190629153538m3CH6Jdtc2DHnANaab",
                        "person_name" : "张丽"
                },
                {
                        "person_id" : "20190629153538MFwkbpkVeRXQVCmiYi",
                        "person_name" : "明明"
                },
                {
                        "person_id" : "201906291535388Di0THqo0wDgNzrWHK",
                        "person_name" : "玉玉"
                },
                {
                        "person_id" : "20190629153539Kh2y5dvAW7Sg5fxZQC",
                        "person_name" : "余瑜"
                },
                {
                        "person_id" : "2018110814232977K3PJOTsvrLC5twRq",
                        "person_name" : "何总"
                }
        ]            
}

以下是C2设备脸库管理请求参数:

以下是C2设备脸库管理回复参数.

C2设备脸库管理示例

type 1,注册请求：

{
    "facelib_manage":{"type":1,"seq":1579573779,"datas":[
    {"age":27,"face_url":"http://oss-cn-hangzhou.aliyuncs.com/jiafeigou-test/long/cm/13058172585/201907021356317Ptv3uA2AcAIVW2KhH.jpg?OSSAccessKeyId=xjBdwD1du8lf2wMI&Expires=1579573774&Signature=vwT4gGDbBanum%2BuY8tDMYpoS4RQ%3D","person_id":"m20190702135701NScfPqeva0r0fZrDYR","person_name":"小钟","sex":"male"},
    {"age":27,"face_url":"http://oss-cn-hangzhou.aliyuncs.com/jiafeigou-test/long/cm/13058172585/20190702140325qP57VvRhxpQj8W2DR5.jpg?OSSAccessKeyId=xjBdwD1du8lf2wMI&Expires=1579573774&Signature=5S4g8Za5VksXO6WrH%2FxiU%2FJiFh0%3D","person_id":"m20190702140406DVKugCr9QLMWJ648ET","person_name":"小王","sex":"male"},
    {"age":41,"face_url":"http://oss-cn-hangzhou.aliyuncs.com/jiafeigou-test/long/cm/13058172585/20191204163025RnscHe9eGiNJoRPcaV.jpg?OSSAccessKeyId=xjBdwD1du8lf2wMI&Expires=1579573774&Signature=lbwczB5nAGrBtXch3MzYqyCtMKI%3D","person_id":"m20191204163102b7rHD1QjgZ3Cihg64g","person_name":"老曹","sex":"male"}]
    }
}

type 1,注册回复：

{
    "cid":"293900000002",
    "result":[{"person_id":"m20190702135701NScfPqeva0r0fZrDYR","ret":0},
              {"person_id":"m20190702140406DVKugCr9QLMWJ648ET","ret":0},
              {"person_id":"m20191204163102b7rHD1QjgZ3Cihg64g","ret":0}
             ],
    "sign":"",
    "time":1579077769,
    "type":1
}

type 2,删除personids对应的人脸请求：

{
    "facelib_manage":
    {
        "type":2,
        "seq":1579573774,
        "person_ids":
        [
            "m20191204163102b7rHD1QjgZ3Cihg64g",
            "m20190702135701NScfPqeva0r0fZrDYR",
            "m20190702140406DVKugCr9QLMWJ648ET"
        ]
    }
}

type 2,删除personids对应的人脸回复：

{
    "cid":"293900000002",
    "result":
    [
        {"person_id":"m20191204163102b7rHD1QjgZ3Cihg64g","ret":0},
        {"person_id":"m20190702135701NScfPqeva0r0fZrDYR","ret":0},
        {"person_id":"m20190702140406DVKugCr9QLMWJ648ET","ret":0}
    ],
    "sign":"",
    "time":1579078006,
    "type":2
}

type 3,清空脸库请求：

{
    "facelib_manage":
    {
        "type":3,
        "seq":1579573778
    }
}

type 3,清空脸库回复：

{
    "cid":"293900000002",
    "result":[{"person_id":"","ret":0}],
    "sign":"",
    "time":1579078215,
    "type":3
}

type 6 清空脸库之后,再注册请求：

{
    "facelib_manage":{"type":6,"seq":1579573779,"datas":[
    {"age":27,"face_url":"http://oss-cn-hangzhou.aliyuncs.com/jiafeigou-test/long/cm/13058172585/201907021356317Ptv3uA2AcAIVW2KhH.jpg?OSSAccessKeyId=xjBdwD1du8lf2wMI&Expires=1579573774&Signature=vwT4gGDbBanum%2BuY8tDMYpoS4RQ%3D","person_id":"m20190702135701NScfPqeva0r0fZrDYR","person_name":"小钟","sex":"male"},
    {"age":27,"face_url":"http://oss-cn-hangzhou.aliyuncs.com/jiafeigou-test/long/cm/13058172585/20190702140325qP57VvRhxpQj8W2DR5.jpg?OSSAccessKeyId=xjBdwD1du8lf2wMI&Expires=1579573774&Signature=5S4g8Za5VksXO6WrH%2FxiU%2FJiFh0%3D","person_id":"m20190702140406DVKugCr9QLMWJ648ET","person_name":"小王","sex":"male"},
    {"age":41,"face_url":"http://oss-cn-hangzhou.aliyuncs.com/jiafeigou-test/long/cm/13058172585/20191204163025RnscHe9eGiNJoRPcaV.jpg?OSSAccessKeyId=xjBdwD1du8lf2wMI&Expires=1579573774&Signature=lbwczB5nAGrBtXch3MzYqyCtMKI%3D","person_id":"m20191204163102b7rHD1QjgZ3Cihg64g","person_name":"老曹","sex":"male"}]
    }
}

type 6 清空脸库之后,再注册回复：

{
    "cid":"293900000002",
    "result":[{"person_id":"m20190702135701NScfPqeva0r0fZrDYR","ret":0},
              {"person_id":"m20190702140406DVKugCr9QLMWJ648ET","ret":0},
              {"person_id":"m20191204163102b7rHD1QjgZ3Cihg64g","ret":0}
             ],
    "sign":"",
    "time":1579077769,
    "type":6
}

type 7,获取人脸库信息请求：

{
    "facelib_manage":{"type":7,"seq":1579573778}
}

type 7,获取人脸库信息回复：

 {
     "cid":"293900000002",
     "result":
     [
         {"person_id":"m20190702135701NScfPqeva0r0fZrDYR","person_name":"小钟"},
         {"person_id":"m20190702140406DVKugCr9QLMWJ648ET","person_name":"小王"},
         {"person_id":"m20191204163102b7rHD1QjgZ3Cihg64g","person_name":"老曹"}
     ],
     "sign":"",
     "time":1579078726,
     "total_face":3,
     "type":7
 }

第三方http服务器接收到设备的状态信息(即type值等于3)之后,可以将升级文件路径返回给设备,对设备进行升级.

第三方http服务器接收到设备的状态信息(即type值等于3)之后,可以修改第三方http服务器地址.

第三方http服务器接收到设备的状态信息(即type值等于3)之后,可以将校时信息返回给设备,对设备进行校时.

rtmp控制示例

{
    "rtmp": {
        "rtmp_enable": 1,
        "rtmp_timeout": 120,
        "rtmp_url": "rtmp://sz.jfgou.com/hls/%CID%"
    },
    "time_interval":60
}

升级推送示例

{
    "upgrade_url":"http://192.168.102.55:8000/JFG17WJCA_1gb_V3-3.5.3.560-App.bin"
}

校时示例

{
    "time_set": 
    {
        "time_stamp": 1566459660, 
        "time_zone": 28800
    }
}

第三方服务器地址修改示例

{
    "http_server_url":"http://192.168.102.55:8000",
    "time_interval":30
}

请求设备内的所有人脸的personid和名字name

{
    "facelib_manage": {
    "type": 5, 
    "seq": 1566358435
    },
    "time_interval":30
}

以上几个控制信息也可合并在同一个json中回复给设备

{
    "rtmp": 
    {
        "rtmp_enable": 1,
        "rtmp_timeout": 120,
        "rtmp_url": "rtmp://sz.jfgou.com/hls/%CID%"
    },
    "facelib_manage": 
    {
        "type": 1, 
        "seq": 1566358435,    
        "facelib_url": "http://192.168.102.55:8000/EFS_26.json.gz",
        "person_ids": "1530328053_xRW2UVaF,1530328061_4DKCgzJ7,1530328068_JHL0Fa8x,1530328075_lla9K0QQ"
    },
    "time_interval":120,
    "time_set": 
    {
        "time_stamp": 1566459660, 
        "time_zone": 28800
    },
    "upgrade_url":"http://192.168.102.55:8000/JFG17WJCA_1gb_V3-3.5.3.560-App.bin"
}

备注:

• 仅当使用无线网卡时上报wifi节点, 仅当使用有线网卡时上报lan节点, lan, wifi 只上报其中一个节点.
• 仅当打开gps开关时上报gps信息

请求示例

上报脸图信息(带场景图和离线识别信息)

curl -H "Content-Type: application/json" 
-X POST -d {
        "cid" : "290200001002",
        "front_value" : 89,
        "position" : 
        [
                "[688,240],[1520,1072]"
        ],
        "result" : 
        {
                "age" : "28",
                "confidence" : 0.63847750425338745,
                "person_id" : "20181025111910JWq9bNaycdmDXozub9",
                "person_name" : "小明",
                "person_type" : 1,
                "sex" : "male"
        },
        "scale_out_x" : 1.1000000238418579,
        "scale_out_y" : 0.5,
        "sharpen_ness" : 86,
        "time" : 1542433807,
        "track_id" : 139,
        "type" : 1,
        "upload_face_size" : 180,
        "upload_id" : 2,
         "faces": ["face_data..."],
         "image": ["base_data..."]
}

上报脸图信息(不带场景图和离线识别信息)

curl -H "Content-Type: application/json" 
-X POST -d {
        "cid" : "290200001002",
        "front_value" : 89,
        "position" : 
        [
                "[688,240],[1520,1072]"
        ],
        "scale_out_x" : 1.1000000238418579,
        "scale_out_y" : 0.5,
        "sharpen_ness" : 86,
        "time" : 1542433807,
        "track_id" : 139,
        "type" : 1,
        "upload_face_size" : 180,
        "upload_id" : 2,
         "faces": ["face_data..."],
}

C1客流统计数据信息

{
        "cid" : "290200001002",
        "from" : 1542384000,
        "time" : 1542435760,
        "track_exc" : 3,
        "track_inc" : 58,
        "track_upload" : 2,
        "type" : 2,
        "upload_success" : 4,
        "upload_total" : 4
}

C2客流统计数据信息

{
    "type" : 2,
    "time": 1540545494,
    "cid": "290200001002",
    "count_time": 1540483200,
    "total": 1100,
    "count_per_hour": [
        {
            "begin_time": 1540508400,
            "end_time": 1540511999,
            "number": 500,
        },
        {
            "begin_time": 1540512000,
            "end_time": 1540515599,
            "number": 600,
        }
    ]
}

设备状态信息(wifi)

{
        "app_version" : "1.5.1.888",
        "cid" : "290200001002",
        "gps" : 
        [
                0.0,
                0.0,
                0.0
        ],
        "mode" : 1,
        "time" : 1542430377,
        "type" : 3,
        "uptime" : 1542429740,
        "wifi" : 
        {
                "dhcp" : 1,
                "dns" : "192.168.100.3",
                "gw" : "192.168.100.3",
                "ip" : "192.168.104.130",
                "mac" : "EC:3D:FD:28:33:48",
                "netmask" : "255.255.0.0",
                "sig" : -59,
                "ssid" : "Xiaomi_ACF2"
        }
}

设备状态信息(lan)

{
        "app_version" : "1.5.1.888",
        "cid" : "290200001002",
        "gps" : 
        [
                0.0,
                0.0,
                0.0
        ],
        "mode" : 1,
        "time" : 1542430377,
        "type" : 3,
        "uptime" : 1542429740,
        "lan" : 
        {
                "dhcp" : 1,
                "dns" : "192.168.100.3",
                "gw" : "192.168.100.3",
                "ip" : "192.168.104.130",
                "mac" : "EC:3D:FD:28:33:48",
                "netmask" : "255.255.0.0",
        }
}

XD500上报格式

XD500设备状态信息

注：按指定间隔时间发送设备状态信息

示例：
{
 "app_version": "32-00-00-13",
 "cid": "330000000002",
 "gps": [0, 0, 0],
 "mode": 0,
 "time": 1639385565,
 "type": 3,
 "uptime": 1638867285,
 "lan": {
  "dhcp": 0,
  "dns1": "202.96.134.133",
  "dns2": "202.96.128.68",
  "gw": "192.168.0.1",
  "ip": "192.168.0.178",
  "mac": "30:57:ac:12:cc:13",
  "netmask": "255.255.255.0"
 }
}

XD500人脸信息

注：当检测到人脸时会上报人脸消息

示例：
{
    "DetectedFaceList":    {
        "IpAddr":    "192.168.0.178",
        "MACAddress":    "30:57:AC:12:CC:13",
        "DeviceID":    "1701080000",
        "DeviceCID":    "330000000002",
        "Count":    1,
        "Face_0":    {
            "FaceID":    13,
            "Position":    {
                "TopLeftX":    67,
                "TopLeftY":    309,
                "BottomRightX":    178,
                "BottomRightY":    531
            },
            "HumanPosition":    {
                "TopLeftX":    0,
                "TopLeftY":    161,
                "BottomRightX":    417,
                "BottomRightY":    999
            },
            "Clarity":    0.596436,
            "Quality":    0.865340,
            "Age":    13,
            "Glass":    "OrdinaryGlasses",
            "Beard":    "NoBeard",
            "Hair":    "LongHair",
            "Hat":    "None",
            "Respirator":    "OtherRespirator",
            "IsRegistered":    1,
            "RegisteredID":    1,
            "FeatureCode":    982645025,
            "Similarity":    0.836136,
            "Name":    "x",
            "CardType":    0,
            "CardNum":    "12345678",
            "Station":    "",
            "Department":    "",
            "Addr":    "",
            "Remarks":    "",
            "Gender":    "Female",
            "WBAttribute":    "White",
            "NodeID":    "",
            "Time":    "2021-12-17T16:01:53Z",
            "SnapshotNum":    12,
            "FaceSnapFile":    "face_13_44279.jpg",
            "FullSnapFile":    ""
        }
    }
}

XD500的c2客流统计数据

注：每10分钟上传一次数据

示例：
{
 "type": 2,
 "time": 1639294526,
 "cid": "330000000008",
 "count_time": 1639267200,
 "total": 3,
 "count_per_hour": [{
   "begin_time": 1639267200,
   "end_time": 1639270799,
   "number": 0
  }, {
   "begin_time": 1639270800,
   "end_time": 1639274399,
   "number": 3
  }]
}