人脸识别相机设备端CGI接口文档

适用于二代产品

• accessCheck
  • 设备登录密码验证
• modifyPasswd
  • 修改设备登录密码
• setNetcfg
  • 设置设备网络参数
• getNetcfg
  • 获取设备网络参数
• setCapture
  • 设置抓图及过滤参数
• getCapture
  • 获取抓图及过滤参数
• setInterface
  • 设置传图地址，推流地址等参数
• getInterface
  • 获取传图地址，推流地址等参数
• getDevInfo
  • 获取设备的基本信息，包括CID，固件版本号等
• setGpio
  • 设置门禁及闸机参数
• getGpio
  • 获取门禁及闸机参数
• setWarn
  • 设置报警计划参数
• getWarn
  • 获取报警计划参数
• uploadLog
  • 上传设备日志
• SetGpio0Level
  • 远程控制门禁或闸机
• FaceImageRegister
  • 使用人脸图片注册
• FaceImageRegisterByFeature
  • 使用人脸特征值注册
• GetFaceLib
  • 获取多个人脸信息（按顺序查找）
• DeleteMultiFace
  • 删除已注册人脸
• EditFaceLable
  • 编辑人脸标签

公共参数

accessCheck

用户名密码验证

参数（无）

返回值ret, 0：成功，负数：失败，-2：用户名密码错误

{
    "ret":    0,
}

例：

http://192.168.103.108:80/ctrl.cgi?Msg=accessCheck&user=admin&passwd=admin

modifyPasswd

修改用户密码

参数

返回值ret, 0：成功，负数：失败，-2：用户名密码错误

{
    "ret":    0,
}

setDevTime

设置设备时间

参数

返回值ret, 0：成功，负数：失败，-2：用户名密码错误

{
    "ret":    0,
}

例：

http://192.168.104.155/ctrl.cgi?Msg=setDevTime&user=admin&passwd=admin&time=1558346452&timeZone=28800&ntpServer=ntp.neu.edu.cn:123

getDevTime

获取设备时间

返回参数

返回值ret, 0：成功，负数：失败，-2：用户名密码错误

{
    "ret":    0,
    "time":    1558946607,
    "timeZone":    28800,
    "ntpServer":"ntp2.netwrx1.com:123"
}

例：

http://192.168.102.55/ctrl.cgi?Msg=getDevTime&user=admin&passwd=admin

例：

http://192.168.103.108:80/ctrl.cgi?Msg=modifyPasswd&user=admin&passwd=admin&newPasswd=admin

setNetcfg

设置网络参数

参数

返回值ret, 0：成功，负数：失败，-2：用户名密码错误

{
    "ret":    0,
}

例：

http://192.168.103.108/ctrl.cgi?Msg=setNetcfg&user=admin&passwd=admin&EnVitualNet=1&NetType=1&BuildType=1&IpEth0=192.168.103.108&NetmaskEth0=255.255.0.0&GetwayEth0=192.168.100.3&DnsServerEth0=192.168.100.3&IpRndis0=192.168.102.210&WifiSsid=Xiaomi_ACF2&WifiPsk=88888888

getNetcfg

获取网络参数

参数（无）

例：

http://192.168.103.108:80/ctrl.cgi?Msg=getNetcfg&user=admin&passwd=admin

返回json示例（getNetcfg）

{
    "NetType":    1,
    "BuildType":    0,
    "EnVitualNet":    0,
    "NetState":    1, "IpEth0":    "172.31.254.88",
    "NetmaskEth0":    "255.255.255.0",
    "GetwayEth0":    "192.168.1.1",
    "DnsServerEth0":    "192.168.1.1",
    "IpRndis0":    "172.168.1.10",
    "Cid":    "290200001002",
    "MacEth0":    "EC:3D:FD:28:33:48",
    "MacWlan0":    "EC:3D:FD:28:33:48",
    "WifiSsid":    "Xiaomi_ACF2",
    "WifiPsk":    "88888888"
}

SetTrackConfig

设置抓图参数

参数

返回值ret, 0：成功，负数：失败，-2：用户名密码错误

{
    "ret":    0,
}

例：

http://192.168.103.173/ctrl.cgi?Msg=setTrackConfig&user=admin&passwd=admin&minWidth=100&faceAngle=80&clarity=80&trackMode=1&captureType=2&recogType=1&snapInterval=30&snapMaxNum=20&confidence=80

getTrackConfig

获取抓图参数

例：

http://192.168.103.173/ctrl.cgi?Msg=getTrackConfig&user=admin&passwd=admin

返回json示例（getTrackConfig）

{
    "snapInterval":    3,
    "snapMaxNum":    2,
    "minWidth":    100,
    "faceAngle":    80,
    "clarity":    80,
    "confidence":    80,
    "captureType":    1,
    "recogType":    1,
    "trackMode":    0
}

setInterface

设置接口参数

参数

返回值ret, 0：成功，负数：失败，-2：用户名密码错误

{
    "ret":    0,
}

例：

http://192.168.103.173/ctrl.cgi?Msg=setInterface&user=admin&passwd=admin&UploadFace=1&UploadBackground=0&RtmpEnable=1&FaceInfo=1&FaceRect=1&HumanRect=1&PlateRect=1&VehicleRect=1&TestToolEnable=1&HumanCntInterval=600&DevInfoInterval=60&RtmpUrl=http://192.168.102.55&ProtocolType=2 &HttpUrl=http://192.168.102.55:8091/devicewarn&FtpAnonymous=1&FtpUser=llm&FtpPasswd=123456&FtpUrl=ftp://192.168.102.55/%25CID%25

getInterface

获取接口参数

例：

http://192.168.103.173/ctrl.cgi?Msg=getInterface&user=admin&passwd=admin

返回json示例（getInterface）

{
    "UploadFace":    1,
    "UploadBackground":    1,
    "RtmpEnable":    0,
    "FaceInfo":    0,
    "FaceRect":    1,
    "HumanRect":    0,
    "PlateRect":    0,
    "VehicleRect":    0,
    "HumanCntInterval":    600,
    "DevInfoInterval": 600,
    "HttpUrl":    "http://192.168.103.55:8091/devicewarn",
    "RtmpUrl":    "rtmp://192.168.103.55/hls/%CID%",
    "TestToolEnable":    1,
    "ProtocolType":    0,
    "FtpAnonymous":    0,
    "FtpUrl":    "",
    "FtpUser":    "",
    "FtpPasswd":  ""
}

getDevInfo

获取设备信息

返回参数

例：

http://192.168.103.173/ctrl.cgi?Msg=getDevInfo&user=admin&passwd=admin

返回json示例（getDevInfo）

{
    "ret":    0,
    "Cid":    "293900000002",
    "appVersion":    "4.1.0.999",
    "confVersion":    "1.3.2.1",
    "RtmpServerUrl":    "rtmp://192.168.103.173:1935"
}

setGpio

设置GPIO参数

参数

例：

http://192.168.103.108:80/ctrl.cgi?Msg=setGpio&user=admin&passwd=admin&Gpio0Enable=1&Gpio0Direction=1&Gpio0Level=1&Gpio0TimeOut=1

返回值ret, 0：成功，负数：失败，-2：用户名密码错误

{
    "ret":    0
}

getGpio

获取GPIO参数

返回参数

例：

http://192.168.103.108:80/ctrl.cgi?Msg=getGpio&user=admin&passwd=admin

返回json示例（getGpio）

{
   "Gpio0Enable":    1,
   "Gpio0Direction":    1,
   "Gpio0Level":    1,
   "Gpio0TimeOut":    1
}

setWarn

设置抓拍计划

参数

例：

http://192.168.104.131:80/ctrl.cgi?Msg=setWarn&user=admin&passwd=admin&WarnEnable=1&CommandEnable=0&CommandType=1&WarnBegin=0&WarnEnd=5947&WarnWeek=127&WarnRectEnable=1

返回值ret, 0：成功，负数：失败，-2：用户名密码错误

{
    "ret":    0
}

getWarn

获取报警计划参数

参数

例：

http://192.168.104.131:80/ctrl.cgi?Msg=getWarn&user=admin&passwd=admin

返回json示例（getWarn）

{
   "WarnEnable":    1,
   "CommandEnable":    0,
   "CommandType":    0,
   "WarnBegin":    0,
   "WarnEnd":    5947,
   "WarnWeek":    127
}

uploadLog

获取日志

参数

无

例：

http://192.168.103.108:80/ctrl.cgi?Msg=uploadLog&user=admin&passwd=admin

返回参数

返回值ret, 0：成功，负数：失败，-2：用户名密码错误

{
    "ret":    0
    "cfgUrl":http://192.168.104.10:80/290200000788_20181207-09:44:20_log.zip
}

SetGpio0Level

远程控制门禁或闸机

参数

无

例：

http://192.168.103.108:80/ctrl.cgi?Msg=SetGpio0Level&user=admin&passwd=admin&Gpio0Level=1

返回值ret, 0：成功，负数：失败，-2：用户名密码错误

{
    "ret":    0
}

GetGpio0Level

获取开门GPIO参数

返回参数

例：

http://192.168.103.108:80/ctrl.cgi?Msg=GetGpio0Level&user=admin&passwd=admin

SetVolumeAndLight

设置音量和白光灯状态

参数

例：

http://192.168.103.173/ctrl.cgi?Msg=SetVolumeAndLight&user=admin&passwd=admin&volume=50&light=0

GetVolumeAndLight

获取音量和白光灯状态

参数

例：

http://192.168.103.173/ctrl.cgi?Msg=GetVolumeAndLight&user=admin&passwd=admin

FaceImageRegister

使用人脸图片注册

参数

(如果resultFeature设置非0，设备不保存注册人脸信息，当作获取人脸特征值服务端)

(人脸图片格式要求： 1：不超过60k 2：yuv420的jpeg格式 3：无遮挡清晰人脸，人脸区域大于100100像素，即瞳距大于等于50像素 4：图片小于等于1280720，且边长尺寸为16的倍数，推荐800*640)

例：

http://192.168.103.171/ctrl.cgi?Msg=FaceImageRegister&user=admin&passwd=admin&PersonID=20190318150659n0ymnEi9EOs3IP0XA6&Name=ronaldo

返回值ret, 0：成功,成功时会返回本次注册产生的PersonID，负数：失败，-2：用户名密码错误

{
    "ret":    0
}

FaceImageRegisterByFeature

使用人脸特征值注册

参数

例：

http://192.168.103.171/ctrl.cgi?Msg=FaceImageRegisterByFeature&user=admin&passwd=admin&PersonID=1530327995_hW7UO03m&Name=ronaldo

返回值ret, 0：成功；负数：失败，-2：用户名密码错误, -3：有数据为空，-4：特征值不对

{
    "ret": 0,
    "PersonID": "m2019090414232300000002064324484",
}

GetFaceLib

获取多个人脸信息（按顺序查找）

参数

返回参数

例：

http://192.168.103.171/ctrl.cgi?Msg=GetFaceLib&user=admin&passwd=admin&Number=20&Offset=0

返回值ret, 0：成功，负数：失败

{
    {
        "ret":    0,
        "Number":    2,
        "Data":
        [
            { "PersonID":    "20190318150659n0ymnEi9EOs3IP0XA5", "Name":    "小王", "Lable":""},
            { "PersonID": "20190318164310SMnMlvdZylYF8MSUx7", "Name":    "老李", "Lable":""}
        ]
    }
}

GetFaceLib

获取多个人脸信息(按条件查找)

参数

返回参数

例：

http://192.168.103.171/ctrl.cgi?Msg=GetFaceLib&user=admin&passwd=admin&Number=20&Offset=0Condition=1530328068_JHL0Fa8x

返回值ret, 0：成功，负数：失败

{
    {
        "ret":    0,
        "Number":    2,
        "Data":
        [
            { "PersonID":    "20190318150659n0ymnEi9EOs3IP0XA5", "Name":    "小王", "Lable":""},
            { "PersonID": "20190318164310SMnMlvdZylYF8MSUx7", "Name":    "老李", "Lable":""}
        ]
    }
}

DeleteMultiFace

删除已注册人脸

参数

例：

http://192.168.103.171/ctrl.cgi?Msg=DeleteMultiFace&user=admin&passwd=admin&PersonNum=3&PersonID=20190318164310SMnMlvdZylYF8MSUx7,20190318150659n0ymnEi9EOs3IP0XA5

返回值ret, 0：成功，负数：失败

{
    "ret":    0
}

EditFaceLable

编辑人脸标签

参数

例：

http://192.168.103.171/ctrl.cgi?Msg=EditFaceLable&user=admin&passwd=admin&PersonID=20190318150659n0ymnEi9EOs3IP0XA6&Name=ronaldo&Lable=footballplayer

返回值ret, 0：成功，负数：失败

{
    "ret":    0
}