基本配置

  1. 设置无线参数
  2. 设置无线参数(无需签名校验)
  3. 获取无线参数
  4. 获取无线扫描AP列表
  5. 获取无线扫描AP列表(无需签名校验)
  6. 获取IP参数
  7. 设置IP参数
  8. 调焦
  9. 手动聚焦
  10. 自动聚焦
  11. 调焦聚焦复位
  12. 获取调焦和聚焦参数
  13. 设置夜视模式
  14. 获取夜视模式
  15. 设置动态侦测
  16. 获取动态侦测参数
  17. 设置IPC名称
  18. 获取IPC名称
  19. 设置指示灯开关
  20. 获取指示灯开关
  21. 设置画面旋转角度
  22. 获取画面旋转角度
  23. 获取支持的画面旋转角度
  24. 格式化存储卡
  25. 获取存储卡状态
  26. 设置人脸识别算法参数
  27. 获取人脸识别算法参数
  28. 获取图像基本参数
  29. 重置图像基本参数
  30. 设置图像亮度
  31. 设置图像对比度
  32. 设置图像饱和度

1. 设置无线参数

描述

配置IPC连接AP的SSID和密码。

请求地址

https://192.168.0.1/openapi/config/setWifiConf,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见HTTP接口调用

参数名称 类型 描述是否必须 示例
ssid string要连接的AP的无线名称,也即SSID,不能超过32个字符Y WeWork
password string要连接的AP的密码,如果无加密,填空即可,不支持WEP,不能超过64个字符Y

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7、100、101,见错误码的描述

请求示例

POST /openapi/config/setWifiConf HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K& ssid=sunmi_ipc&password=1234567890

返回示例

{
    “code”: 0
}

2. 设置无线参数(无需签名校验)

描述

设备激活前无需签名校验配置 IPC 连接 AP 的 SSID 和密码;设备激活后此接口即失效。

请求地址

https://192.168.0.1/openapi/config/setWifiConfWithoutAuth,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有公共参数。

参数名称 类型 描述是否必须 示例
ssid string要连接的AP的无线名称,也即SSID,不能超过32个字符Y WeWork
password string要连接的AP的密码,如果无加密,填空即可,不支持WEP,不能超过64个字符Y

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7、12、100、101,见错误码的描述

请求示例

POST /openapi/config/setWifiConfWithoutAuth HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

ssid=sunmi_ipc&password=1234567890

返回示例

{
    “code”: 0
}

3. 获取无线参数

描述

获取当前IPC的无线参数。

请求地址

https://192.168.0.1/openapi/config/getWifiConf,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述
ssid string 当前连接的SSID
password string 当前SSID的密码

请求示例

POST /openapi/config/getWifiConf HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
    “code”: 0,
    “data”: {
        “ssid”: “SUNMI_IPC”,
        “password”: “1234567890”
    }
}

4. 获取无线扫描AP列表

描述

获取当前IPC无线扫描到的AP列表。

请求地址

https://192.168.0.1/openapi/config/getApList,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数 ,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述
num int 返回扫描到的AP个数
ssid string 扫描到AP的ssid
key_mgmt string 扫描到AP的加密方式

请求示例

POST /openapi/config/getApList HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
    “code”:0,
    “data”: 
    {
        “num”: 3,
        “ap_list”:[
            {
                “ssid”: “TP-LINK_3475”,
                “key_mgmt”: “WPA-PSK”
            },
            {
                “ssid”: “WeWork”,
                “key_mgmt”: “WPA-PSK”
            },
            {
                “ssid”: “WeWorkCorp”,
                “key_mgmt”: “WPA-PSK”
            }
        ]
    }
}

5. 获取无线扫描AP列表(无需签名校验)

描述

获取当前IPC无线扫描到的AP列表;设备激活后此接口即失效。

请求地址

https://192.168.0.1/openapi/config/getApListWithoutAuth,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数 ,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述
num int 返回扫描到的AP个数
ssid string 扫描到AP的ssid
key_mgmt string 扫描到AP的加密方式

请求示例

POST /openapi/config/getApListWithoutAuth HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
    “code”:0,
    “data”: 
    {
        “num”: 3,
        “ap_list”:[
            {
                “ssid”: “TP-LINK_3475”,
                “key_mgmt”: “WPA-PSK”
            },
            {
                “ssid”: “WeWork”,
                “key_mgmt”: “WPA-PSK”
            },
            {
                “ssid”: “WeWorkCorp”,
                “key_mgmt”: “WPA-PSK”
            }
        ]
    }
}

6. 获取IP参数

描述

获取IPC的IP地址相关信息。

请求地址

https://192.168.0.1/openapi/config/getIpConfiguration,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数 ,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述
proto string dhcp或者static
ipaddr string IPC的IP地址
netmask string IPC的子网掩码
gateway string IPC的网关
dns1 string dns地址
dns2 string dns地址

请求示例

POST /openapi/config/getIpConfiguration HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
   “code”: 0,
   “data”: {
      “proto”: “dhcp”,
      “ipaddr”: “192.168.1.107”,
      “netmask”: “255.255.255.0”,
      “gateway”: “192.168.1.1” ,
      “dns1”: “202.96.128.86”,
      “dns2”: “202.96.134.166”,
     }
}

7. 设置IP参数

描述

设置IPC获取IP地址的方式。

请求地址

https://192.168.0.1/openapi/config/setIpConfiguration,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见HTTP接口调用

参数名称类型描述是否必须示例
protostringIP地址的获取方式:dhcp或者staticYstatic
ipaddrstringIP地址,设置静态IP地址时必须传入N192.168.1.110
netmaskstring子网掩码,设置静态IP地址时必须传入N255.255.255.0
gatewaystring网关,设置静态IP地址时必须传入N192.168.1.100
dns1stringdns服务器地址N202.96.128.86
dns2string dns服务器地址 N202.96.134.166

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7,见错误码的描述

请求示例

POST /openapi/config/setIpConfiguration HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&proto=dhcp&timestamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
    “errcode”: 0
}

8. 调焦

描述

用户根据实际环境,调节镜头的焦距,使得拍摄的画面放大或者缩小。

请求地址

https://192.168.0.1/openapi/config/setZoom,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见HTTP接口调用

参数名称 类型 描述 是否必须 示例
zoom int 焦距大小,合理范围是[0, 500] Y 200

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、110,见错误码的描述

请求示例

POST /openapi/config/setZoom HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K& zoom=100

返回示例

{
    “code”: 0
}

9. 手动聚焦

描述

调焦后镜头会自动聚焦,如果对自动聚焦效果不满意,可以调用此接口手动进行微调。

请求地址

https://192.168.0.1/openapi/config/manualFocus,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见HTTP接口调用

参数名称 类型 描述 是否必须 示例
focus int 聚焦大小,合理范围是[0, 780] Y 200

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、111,见错误码的描述

请求示例

POST /openapi/config/manualFocus HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K& focus=100

返回示例

{
    “code”: 0
}

10. 自动聚焦

描述

设置焦距后,IPC会自动聚焦,可以设置自动聚焦以哪个点(坐标)为中心进行。

请求地址

https://192.168.0.1/openapi/config/autoFocus,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见HTTP接口调用

参数名称 类型 描述 是否必须 示例
focus_x int 聚焦点在x方向的像素百分比,合理范围是[0, 100] Y 50
focus_y int 聚焦点在y方向的像素百分比,合理范围是[0, 100] Y 50

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、112,见错误码的描述

请求示例

POST /openapi/config/autoFocus HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K& focus_x=50&focus_y=50

返回示例

{
    “code”: 0
}

11. 调焦聚焦复位

描述

用户可以通过此接口直接复位焦距和聚焦的参数。

请求地址

https://192.168.0.1/openapi/config/resetZoomFocus,192.168.0.1需要替换成实际的IPC地址。

请求参数

此接口没有私有参数,公共参数见HTTP接口调用

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述

请求示例

POST /openapi/config/resetZoomFocus HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
    “code”: 0
}

12. 获取调焦和聚焦参数

描述

获取当前IPC镜头的调焦聚焦参数。

请求地址

https://192.168.0.1/openapi/config/getZoomFocusConf,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述
max_zoom int 能够调整的焦距最大值
max_focus int 能够调整的聚焦最大值
zoom int 当前的焦距
focus int 当前的聚焦值
focus_x int 聚焦点在x方向的像素百分比
focus_y int 聚焦点在y方向的像素百分比

请求示例

POST /openapi/config/getZoomFocusConf HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
    “code”: 0,
    “data”: {
        “zoom”: 0,
        “max_zoom”: 500,
        “max_focus”: 780,
        “focus”: 0,
        “focused_x”: 50,
        “focused_y”: 50
    }
}

13. 设置夜视模式

描述

配置镜头的夜视模式。

请求地址

https://192.168.0.1/openapi/config/setIrMode,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见HTTP接口调用

参数名称 类型 描述 是否必须 示例
irmode int 0表示关闭,1表示开启,2表示自动。一般选2。 Y 2

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、113,见错误码的描述

请求示例

POST /openapi/config/setIrMode HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K& irmode=1

返回示例

{
    “code”: 0
}

14. 获取夜视模式

描述

获取当前IPC的夜视模式。

请求地址

https://192.168.0.1/openapi/config/getIrMode,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述
irmode int 返回码成功才会有此字段,当前夜视模式

请求示例

POST /openapi/config/getIrMode HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
    “code”: 0,
    “data”: {
          “irmode”: 1
    }
}

15. 设置动态侦测

描述

IPC的动态侦测支持根据画面变化和声音变化灵敏度来检测和报警,通过本API可以设置相关灵敏度和动态侦测的时间。

请求地址

https://192.168.0.1/openapi/config/setDynamicDetect,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见HTTP接口调用

参数名称 类型 描述 是否必须 示例
motion_level int 范围[0, 3],0表示关闭,数值越大,越灵敏。 Y 2
audio_level int 范围[0, 3],0表示关闭,数值越大,越灵敏。 Y 2
weekday int 以周为一个循环,用0xYY来表示选择哪一天,具体是0x80直接表示7×24小时,其余的,
以7bit来表示哪一天被选上,0x01表示选择周一,0x02表示选择周二,0x40表示选择
周天,0x7f表示选择一个礼拜的7天,与0x80的区别只是0x80直接默认724小时,而
0x7f选了7天后,还可以设置具体的开始时间和结束时间。
Y 128(0x80 的十进制)
start_time long 用分钟来表示,以一天24小时为例,以分钟为最小粒度,总共24*60这样的时间数值,
60表示01:00,121表示02:01,依次类推。范围[0,1440]
Y 200
stop_time long 用分钟来表示,以一天24小时为例,以分钟为最小粒度,总共24*60这样的时间数值,
60表示01:00,121表示02:01,依次类推。范围[0,1440]
Y 400

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述

请求示例

POST /openapi/config/setDynamicDetect HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K motion_level=1&audio_level=1&weekday=128&start_time=1260&stop_time=540

返回示例

{
    “code”: 0
}

16. 获取动态侦测参数

描述

获取当前IPC镜头的动态侦测参数。

请求地址

https://192.168.0.1/openapi/config/getDynamicDetect,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述
motion_level int 范围[0, 3],0表示关闭,数值越大,越灵敏。
audio_level int 范围[0, 3],0表示关闭,数值越大,越灵敏。
weekday int 以周为一个循环,用0xYY来表示选择哪一天,具体是0x80直接表示7×24小时,其余的,
以7bit来表示哪一天被选上,0x01表示选择周一,0x02表示选择周二,0x40表示选择
周天,0x7f表示选择一个礼拜的7天,与0x80的区别只是0x80直接默认724小时,而
0x7f选了7天后,还可以设置具体的开始时间和结束时间。
start_time long 用分钟来表示,以一天24小时为例,以分钟为最小粒度,总共24*60这样的时间数值,
60表示01:00,121表示02:01,依次类推。范围[0,1440]
stop_time long 用分钟来表示,以一天24小时为例,以分钟为最小粒度,总共24*60这样的时间数值,
60表示01:00,121表示02:01,依次类推。范围[0,1440]

请求示例

POST /openapi/config/getDynamicDetect HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded


app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
    “code”: 0,
    “data”: {
          “motion_level”: 1,
         “audio_level”: 1,
         “weekday”: 7,
         “start_time”: 120
         “stop_time”: 240,
    }
}

17. 设置IPC名称

描述

用户可以设置IPC的名称,以便区分不同的IPC设备。

请求地址

https://192.168.0.1/openapi/config/updateName,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见HTTP接口调用

参数名称 类型 描述 是否必须 示例
name string 36个字符以内,12汉字以内 Y 示例名称

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、118,见错误码的描述

请求示例

POST /openapi/config/updateName HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K&
name=front_door

返回示例

{
    “code”: 0
}

18. 获取IPC名称

描述

获取当前IPC的名称。

请求地址

https://192.168.0.1/openapi/config/getName,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7,见错误码的描述
name int IPC名称

请求示例

POST /openapi/config/getName HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
    “code”: 0,
    “data”: {
         “name”: “front_door”
    }
}

19. 设置指示灯开关

描述

设置指示灯是否需要关闭。

请求地址

https://192.168.0.1/openapi/config/setLedSwitch,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见HTTP接口调用

参数名称 类型 描述 是否必须 示例
led_switch int 0表示关闭指示灯,1表示开启指示灯,即可以亮 Y 1

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、119, 见错误码的描述

请求示例

POST /openapi/config/setLedSwitch HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K& led_switch=1

返回示例

{
    “code”: 0
}

20. 获取指示灯开关

描述

获取当前IPC的指示灯状态。

请求地址

https://192.168.0.1/openapi/config/getLedSwitch,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7, 见错误码的描述
led_switch int 0表示关闭指示灯,1表示开启指示灯,即可以亮

请求示例

POST /openapi/config/getLedSwitch HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
    “code”: 0,
    “data”: {
         “led_switch”: 1
    }
}

21. 设置画面旋转角度

描述

设置拍摄的画面是否需要旋转一定角度,可用的旋转角度可通过获取支持的画面旋转角度获取到。

请求地址

https://192.168.0.1/openapi/config/setRotation,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见HTTP接口调用

参数名称 类型 描述 是否必须 示例
rotation int 画面旋转角度
对于FM010,支持的参数有0,90,180,270;
对于FM020,支持的参数有0,180
Y 180

响应参数

字段名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、120, 见错误码的描述

请求示例

POST /openapi/config/setRotation HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K& rotation=180

返回示例

{
    “code”: 0
}

22. 获取画面旋转角度

描述

获取当前IPC当前的画面旋转角度。

请求地址

https://192.168.0.1/openapi/config/getRotation,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7, 见错误码的描述
rotation int 当前画面的旋转角度
对于FM010,支持的参数有0,90,180,270;
对于FM020,支持的参数有0,180

请求示例

POST /openapi/config/getRotation HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
    “code”: 0,
    “data”: {
        “rotation”: 180
    }

23. 获取支持的画面旋转角度

描述

获取当前IPC设备支持的画面旋转角度。

请求地址

https://192.168.0.1/openapi/config/getRotationAngles,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7, 见错误码的描述
angles string list 当前IPC设备支持的画面旋转角度列表
对于FM010,支持的参数有0,90,180,270;
对于FM020,支持的参数有0,180

请求示例

POST /openapi/config/getRotation HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
    “code”: 0,
    “data”: {
        “angles”: [
            “0”,
            “90”,
            “180”,
            “270”
        ]
    }
}

24. 格式化存储卡

描述

格式化插入IPC里面的存储卡。

请求地址

https://192.168.0.1/openapi/config/formatMemoryCard,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、220、221, 见错误码的描述

请求示例

POST /openapi/config/formatMemoryCard HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K
  • 返回示例
{
    “code”: 0
}

25. 获取存储卡状态

描述

获取IPC上存储卡状态

请求地址

https://192.168.0.1/openapi/config/getMemoryCardStatus,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7, 见错误码的描述
status int 0表示未插入SD卡;1表示已插入SD卡但未初始化;2表示SD卡已插入且正常;3表示SD卡无法识别

请求示例

POST /openapi/config/getMemoryCardStatus HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K

返回示例

{
    “code”: 0,
    “data”: {
         “status”: 2
    }
}

26. 设置人脸识别算法参数

描述

人脸识别算法分析视频数据时,需要从视频流中优选质量相对较好的图像进行识别匹配,此接口用于设置优选过程的参数。

请求地址

https://192.168.0.1/openapi/config/setFaceOption,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见HTTP接口调用

参数名称类型描述是否必须实例
optimize_secondsint优选图像的时间范围,单位为秒。在画面中出现人脸后则尝试 选出 在这个时间范围内最好的人脸图像进行特征提取。Y2

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、2、3、5、7, 见错误码的描述

请求示例

POST /openapi/config/setFaceOption HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

timestamp=15930292837&app_id=mdk923idkf&random=289192&optimize_seconds=2&sign=IDKNFLK392038KDS932K

返回示例

{
 "code": 0
} 

27. 获取人脸识别算法参数

描述

人脸识别算法分析视频数据时,需要从视频流中优选质量相对较好的图像进行识别匹配,此接口用于获取优选过程的参数。

请求地址

https://192.168.0.1/openapi/config/getFaceOption,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0、1、3、5、7、279, 见错误码的描述

请求示例

POST /openapi/config/getFaceOption HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

timestamp=15930292837&app_id=mdk923idkf&random=289192sign=IDKNFLK392038KDS932K

返回示例

{
  "code": 0,
  "data": {
    "optimize_seconds": "2"
  }
} 

28. 获取图像基本参数

描述

该接口获取图像的亮度,对比度,饱和度参数。

请求地址

https://192.168.0.1/openapi/media/ get_pqparam,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0见错误码的描述
brightnessint返回的亮度值范围0-100
contrastint返回的对比度值范围0-100
saturationint返回的饱和度值范围0-100

请求示例

POST /openapi/media/get_pqparam HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

timestamp=15930292837&app_id=mdk923idkf&random=289192sign=IDKNFLK392038KDS932K

返回示例

{
  "code": 0
} 

29. 重置图像基本参数

描述

该接口将图像的亮度,对比度,饱和度参数重置为默认值。

请求地址

https://192.168.0.1/openapi/media/ reset_pqparam ,192.168.0.1需要替换成实际的IPC地址。

请求参数

本接口没有私有参数,公共参数见HTTP接口调用

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0见错误码的描述

请求示例

POST /openapi/media/reset_pqparamHTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

timestamp=15930292837&app_id=mdk923idkf&random=289192sign=IDKNFLK392038KDS932K

返回示例

{
  "code": 0
} 

30. 设置图像亮度

描述

该接口将设置图像亮度为目标值。

请求地址

https://192.168.0.1/openapi/media/ set_brightness ,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见HTTP接口调用

参数名称类型描述是否必须实例
brightnessint目标亮度值。Y50

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0见错误码的描述

请求示例

POST /openapi/media/set_brightness HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

timestamp=15930292837&app_id=mdk923idkf&random=289192&compensation=50&sign=IDKNFLK392038KDS932K

返回示例

{
“code”: 0
}

31.设置图像对比度

描述

该接口将设置图像对比度为目标值。

请求地址

https://192.168.0.1/openapi/media/ set_contrast ,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见HTTP接口调用

参数名称类型描述是否必须实例
contrastint目标对比度值。Y50

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0见错误码的描述

请求示例

POST /openapi/media/set_contrast HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

timestamp=15930292837&app_id=mdk923idkf&random=289192&contrast=50&sign=IDKNFLK392038KDS932K

返回示例

{
“code”: 0
}

32.设置图像饱和度

描述

该接口将设置图像饱和度为目标值。

请求地址

https://192.168.0.1/openapi/media/ set_saturation ,192.168.0.1需要替换成实际的IPC地址。

请求参数

这里只列出接口的私有参数,公共参数见HTTP接口调用

参数名称类型描述是否必须实例
saturationint目标饱和度值。Y50

响应参数

参数名称 类型 描述
code int 返回码,表示操作的结果;
本接口返回码有:0见错误码的描述

请求示例

POST /openapi/media/set_saturation HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

timestamp=15930292837&app_id=mdk923idkf&random=289192&saturation=50&sign=IDKNFLK392038KDS932K

返回示例

{
“code”: 0
}