Basic Configurations – Sunmi Developer Docs

Set WIFI Configurations
Set WIFI Configurations (without authentication)
Get WIFI Configurations
Get AP List
Get AP List (without authentication)
Set Zoom
Manual Focus
Automatic Focus
Reset Zoom and Focus
Get Zoom and Focus Configurations
Set IR Mode
Get IR Mode
Set Dynamic Detect
Get Dynamic Detect
Set IPC Name
Get IPC Name
Set LED
Get LED
Set Rotation
Get Rotation
Get Rotation Angles
Format SD-card
Get SD-card Status

1. Set WIFI Configurations

Description

Set the SSID and password for Internet connection.

Request Link

https://192.168.0.1/openapi/config/setWifiConf, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

Below are private parameters for this API, please refer to Public Parameters for more details.

Parameter	Type	Description	Required	Example
ssid	string	The name of wireless network or “SSID” to connect, maximum 32 characters	Y	WeWork
password	string	The password of the AP to connect, left blank if no password is required, WEP is not supported, maximum 64 characters	Y

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 100, 101, see Error Code for further details.

Request Example

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

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

Response Example

{
“code”: 0
}

2. Set WIFI Configurations (without authentication)

Description

Set the SSID and password for Internet connection before activation, invalid after activation.

Request Link

https://192.168.0.1/openapi/config/setWifiConfWithoutAuth, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

This API requires no public parameter.

Parameter	Type	Description	Required	Example
ssid	string	The name of wireless network or “SSID” to connect, maximum 32 characters	Y	WeWork
password	string	The password of the AP to connect, left blank if no password is required, WEP is not supported, maximum 64 characters	Y

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 12, 100, 101, see Error Code for further details.

Request Example

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

ssid=sunmi_ipc&password=1234567890

Response Example

{
“code”: 0
}

3. Get WIFI Configurations

Description

Get the WIFI configurations.

Request Link

https://192.168.0.1/openapi/config/getWifiConf, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

No private parameter for this API, please refer to Public Parameters for more details.

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, see Error Code for further details.
ssid	string	SSID
password	string	Password

Request Example

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

Response Example

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

4. Get AP List

Description

Get the AP list discovered by the IPC.

Request Link

https://192.168.0.1/openapi/config/getApList, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

No private parameter for this API, please refer to Public Parameters for more details.

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, see Error Code for further details.
num	int	Number of AP discovered
ssid	string	SSID
key_mgmt	string	Encryption method

Request Example

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

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

Response Example

{
    “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. Get AP List (without authentication)

Description

Get the AP list discovered by the IPC before activation, invalid after activation.

Request Link

https://192.168.0.1/openapi/config/getApListWithoutAuth, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

No private parameter for this API, please refer to Public Parameters for more details.

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, see Error Code for further details.
num	int	Number of AP discovered
ssid	string	SSID
key_mgmt	string	Encryption method

Request Example

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

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

Response Example

6. Set Zoom

Description

Set the zoom level of the lens.

Request Link

https://192.168.0.1/openapi/config/setZoom, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

Below are private parameters for this API, please refer to Public Parameters for more details.

Parameter	Type	Description	Required	Example
zoom	int	Zoom level, range is [0, 500].	Y	200

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, 110, see Error Code for further details.

Request Example

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

Response Example

{
“code”: 0
}

7. Manual Focus

Description

Set the focus level of the lens. This is used to manually adjust the focus level if automatic focus after zooming is not satisfying.

Request Link

https://192.168.0.1/openapi/config/manualFocus, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

Below are private parameters for this API, please refer to Public Parameters for more details.

Parameter	Type	Description	Required	Example
focus	int	Focus level, range is [0, 780].	Y	200

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, 111, see Error Code for further details.

Request Example

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

Response Example

{
“code”: 0
}

8. Automatic Focus

Description

Set to automatically focus to a given focus point.

Request Link

https://192.168.0.1/openapi/config/autoFocus, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

Below are private parameters for this API, please refer to Public Parameters for more details.

Parameter	Type	Description	Required	Example
focus_x	int	X-axis percentage of the focus point, range is [0, 100].	Y	50
focus_y	int	Y-axis percentage of the focus point, range is [0, 100].	Y	50

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, 112, see Error Code for further details.

Request Example

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

Response Example

{
“code”: 0
}

9. Reset Zoom and Focus

Description

Reset zoom and focus levels to defaults.

Request Link

https://192.168.0.1/openapi/config/resetZoomFocus, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

No private parameter for this API, please refer to Public Parameters for more details.

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, see Error Code for further details.

Request Example

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

Response Example

{
“code”: 0
}

10. Get Zoom and Focus Configurations

Description

Get zoom and focus configurations.

Request Link

https://192.168.0.1/openapi/config/getZoomFocusConf, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

No private parameter for this API, please refer to Public Parameters for more details.

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, see Error Code for further details.
max_zoom	int	Maximum zoom level
max_focus	int	Maximum focus level
zoom	int	Current zoom level
focus	int	Current focus level
focus_x	int	X-axis percentage of the focus point
focus_y	int	Y-axis percentage of the focus point

Request Example

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

Response Example

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

11. Set IR Mode

Description

Set IR mode of the lens.

Request Link

https://192.168.0.1/openapi/config/setIrMode, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

Below are private parameters for this API, please refer to Public Parameters for more details.

Parameter	Type	Description	Required	Example
irmode	int	0: off; 1: on; 2: auto. 2 is recommended.	Y	2

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, 113, see Error Code for further details.

Request Example

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

Response Example

{
“code”: 0
}

12. Get IR Mode

Description

Get IR mode of the lens.

Request Link

https://192.168.0.1/openapi/config/getIrMode, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

No private parameter for this API, please refer to Public Parameters for more details.

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, see Error Code for further details.
irmode	int	Current IR mode of the lens

Request Example

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

Response Example

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

13. Set Dynamic Detect

Description

Dynamic detection on the IPC supports detection and alarm motional and audio events. This API is used to set dynamic detection thresholds and period.

Request Link

https://192.168.0.1/openapi/config/setDynamicDetect, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

Below are private parameters for this API, please refer to Public Parameters for more details.

Parameter	Type	Description	Required	Example
motion_level	int	Motion detection level, range is [0, 3] where 3 is most sensitive.	Y	2
audio_level	int	Audio detection level, range is [0, 3] where 3 is most sensitive.	Y	2
weekday	int	Detection period in a week. Bits are used to represent the weekdays: bit 0 is for Monday, bit 1 is for Tuesday, bit 2 is for Wednesday, bit 3 is for Thursday, bit 4 is for Friday, bit 5 is for Saturday, bit 6 is for Sunday and bit 7 is for 7 x 24 hours. For example, 0b00001111 means detection is on from Monday to Thursday, 0b00010101 means detection is on at Monday, Wednesday and Friday.	Y	128 (decimal value of 0b10000000), 21 (decimal value of 0b00010101)
start_time	long	Start time of the day in minute, range is [0, 1440]. For example, 60 is 01:00, 121 is 02:01.	Y	200
stop_time	long	Stop time of the day in minute, range is [0, 1440]. For example, 60 is 01:00, 121 is 02:01.	Y	400

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, 114, 115, 116, 117, see Error Code for further details.

Request Example

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

Response Example

{
“code”: 0
}

14. Get Dynamic Detect

Description

Get configurations of the dynamic detection.

Request Link

https://192.168.0.1/openapi/config/getDynamicDetect, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

No private parameter for this API, please refer to Public Parameters for more details.

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, see Error Code for further details.
motion_level	int	Motion detection level, range is [0, 3] where 3 is most sensitive.
audio_level	int	Audio detection level, range is [0, 3] where 3 is most sensitive.
weekday	int	Detection period in a week. Bits are used to represent the weekdays: bit 0 is for Monday, bit 1 is for Tuesday, bit 2 is for Wednesday, bit 3 is for Thursday, bit 4 is for Friday, bit 5 is for Saturday, bit 6 is for Sunday and bit 7 is for 7 x 24 hours. For example, 0b00001111 means detection is on from Monday to Thursday, 0b00010101 means detection is on at Monday, Wednesday and Friday.
start_time	long	Start time of the day in minute, range is [0, 1440]. For example, 60 is 01:00, 121 is 02:01.
stop_time	long	Stop time of the day in minute, range is [0, 1440]. For example, 60 is 01:00, 121 is 02:01.

Request Example

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

Response Example

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

15. Set IPC Name

Description

Set the name of the IPC.

Request Link

https://192.168.0.1/openapi/config/updateName, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

Below are private parameters for this API, please refer to Public Parameters for more details.

Parameter	Type	Description	Required	Example
name	string	Name, maximum 36 characters	Y	Camera1

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, 118, see Error Code for further details.

Request Example

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

Response Example

{
“code”: 0
}

16. Get IPC Name

Description

Get the name of the IPC.

Request Link

https://192.168.0.1/openapi/config/getName, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

No private parameter for this API, please refer to Public Parameters for more details.

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, see Error Code for further details.
name	int	Name

Request Example

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

Response Example

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

17. Set LED

Description

Set the LED on the IPC.

Request Link

https://192.168.0.1/openapi/config/setLedSwitch, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

Below are private parameters for this API, please refer to Public Parameters for more details.

Parameter	Type	Description	Required	Example
led_switch	int	0: disable, 1: enable	Y	1

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, 119, see Error Code for further details.

Request Example

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

Response Example

{
“code”: 0
}

18. Get LED

Description

Get the setting of the LED on the IPC.

Request Link

https://192.168.0.1/openapi/config/getLedSwitch, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

No private parameter for this API, please refer to Public Parameters for more details.

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, see Error Code for further details.
led_switch	int	0: disable, 1: enable

Request Example

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

Response Example

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

19. Set Rotation

Description

Set the orientation of image, use Get Rotation Angles to get available angles.

Request Link

https://192.168.0.1/openapi/config/setRotation, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

Below are private parameters for this API, please refer to Public Parameters for more details.

Parameter	Type	Description	Required	Example
rotation	int	The orientation of image	Y	180

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, 120, see Error Code for further details.

Request Example

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

Response Example

{
“code”: 0
}

20. Get Rotation

Description

Get the orientation of image,.

Request Link

https://192.168.0.1/openapi/config/getRotation, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

No private parameter for this API, please refer to Public Parameters for more details.

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, see Error Code for further details.
rotation	int	The orientation of image

Request Example

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

Response Example

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

21. Get Rotation Angles

Description

Get supported rotation angles of image.

Request Link

https://192.168.0.1/openapi/config/getRotationAngles, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

No private parameter for this API, please refer to Public Parameters for more details.

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, see Error Code for further details.
angles	string list	List of supported rotation angles of image

Request Example

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

Response Example

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

22. Format SD-card

Description

Format the SD-card in the IPC.

Request Link

https://192.168.0.1/openapi/config/formatMemoryCard, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

No private parameter for this API, please refer to Public Parameters for more details.

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, 220, 221, see Error Code for further details.

Request Example

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

Response Example

{
“code”: 0
}

23. Get SD-card Status

Description

Get the status of the SD-card in the IPC.

Request Link

https://192.168.0.1/openapi/config/getMemoryCardStatus, 192.168.0.1 should be replaced by the IP address of the IPC.

Request Parameters

No private parameter for this API, please refer to Public Parameters for more details.

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, see Error Code for further details.
status	int	0: unplugged, 1: unformatted, 2: working；3: unknown

Request Example

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

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

Response Example

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