SUNMI Store Open Platform – Sunmi Developer Docs

Firmware Recovery

1 Introduction

This document is intended to help users manually update the corrupted IPC firmware.

2 Get Firmware

Please consult Sunmi Technology Customer Service for the latest firmware of your devices and do not use any third-party firmware which may cause malfunctions.

Release firmware for the Face Sense Camera (or FS & FM020): Download here.
Release firmware for the Store Sense Camera (or SS & FM010): Download here.

3 Notes

Firmware is not interchangeable and you should use correct firmware for your device.
Verification will be performed to ensure the firmware is correctly signed before actually updating. Please make sure the firmware comes from Sunmi Technology to prevent malfunctions or bricks after updating.

4 Update Procedure

4.1 Copy the firmware to the SD-card

Remove the SD-card from the IPC.
Plug the SD-card into a Microsoft Windows computer, format the SD-card with EXFAT file system and set the volume label to “SUNMI-XXXX” where “XXXX” is the last four digits of the MAC address which is on the label of the device.
Copy the firmware file to the SD-card’s root directory and rename it to “up.bin”.

4.2 Update

Insert the SD-card with firmware inside into the IPC.
Power on the IPC.
Wait for around 10 seconds until the red LED is on, indicating it is updating.
Wait for around 1 min, if the red LED is off and green LED is on that means the device is going to reboot. The updating procedure completes when the green LED is flashing or the blue LED is on.

4.3 Setup

After rebooting, hold the Reset button for a few seconds to restore the factory settings.
Follow the procedures in the User Manual to setup your device and bind it to your account.
Use the Sunmi Assistant App or go to https://store.sunmi.com and update the firmware to the latest version.
Remember to delete the “up.bin” file under the root directory in the SD-card, preventing any accidently update.

IPC OpenAPI Testing Tutorial

1. Introduction

This tutorial will show you how to test the IPC OpenAPI with Postman.

Consult the Sunmi Technology Customer Service and get materials in the table below except the IP and SN of your device. And please connect your IPC to the Internet and make sure the blue LED is solid before going through the following steps.

Item	Example in this tutorial
app_id	08BABCDABBB661234567
secret_key	ABCDEFG3F2BB03917123
Activation Code	abcd2986jnts8987hntl1234
OpenAPI Cert and its password	openapi.p12
Postman Collections	Sunmi_IPC_OpenAPI_Postman_Collection_202007001.json
IP	192.168.103.198
SN	C201000P00123

2. Postman Setup

Download Postman: Link, we use v7.27.1 in this tutorial.
And just follow the Installation Wizard.

3. Collection Import and Configuration

Launch Postman
Click File -> Import -> Upload Files, And open the Postman collection from Sunmi, i.e. “Sunmi_IPC_OpenAPI_Postman_Collection_202007001.json”, confirm and click “Import”.
Click File -> Settings -> Certificate, add the certificate file and its password, put the IP in the Host filed.

4. Open the General page, set “SSL certificate verificatio” to `OFF`.

5. Back to homepage of Postman, right click on “Sunmi IPC OpenAPI” collections, “Edit”, and update the corresponding settings at “CURRENT VALUE” in page “Variables”.

4. Activation Example

Activation use the activation code as the secret key, Make sure the value of secret_key in the Variables page is your activation code.
Open Sunmi IPC OpenAPI -> Basic -> 0. Activation, modify the “sn” to your device’s SN in the Body tab, click Send, activations succeed with “code” 0 in the response.

Please find the detailed docment about activation in Device Management.

5. API Test

This collection only includes several API example for testing. Each request needs to be correctly signed, see the Sign Rules.
Sign script are included in this collection in “Pre-request Scripts”, it will calculate the value of “app_id”, “timestamp”, “random” and “sign” in every request.

Initial Configurations

Wired Network
Wireless Network
Get the Device’s IP address
SUNMI Device Discovery Protocol

In order to use the IPC through OpenAPI, the user need to get the IP address of the IPC first.

The first step is to connect the IPC to the network. There are two ways to connect the device to Internet, wired and wireless. Wired network is preferred for its high stability and reliability.

1. Wired Network

For an IPC device with an Ethernet Port, you can connect it to a gateway(such as a wireless router) with an Ethernet cable, then the device can obtain the IP address through the DHCP server.

If the network is available, the LED on the IPC will soon turn blue, indicating that the IPC has connected to the Internet.

2. Wireless Network

The steps to connect to a wireless network are as follows:

Use your mobile phone or PC to scan the wireless hotspot of the IPC. The SSID of the wireless hotspot is SUNMI_XXXX, where XXXX is the hexadecimal number of the last 2 bytes of the MAC address. The MAC address can be found on the label on the back of the device or on the packaging box.
Use your mobile phone or PC to connect to the wireless hotspot. The mobile phone or PC will obtain an IP address assigned by the IPC, which is usually 192.168.200.XXX. The gateway address of mobile phone or PC is the address of IPC, which is usually 192.168.200.1.
Use the wireless configuration API to connect to wireless network. If everything is done correctly, the IPC will obtain the IP address from the gateway.
If the network is available, the LED on the IPC will soon turn blue, indicating that the IPC has connected to the Internet.

3. Get the Device’s IP address

After the setup of IPC’s network, the next step is to get the IP address of the IPC.

SUNMI provides Device Discovery Protocol for discovering all SUNMI devices that support this protocol on the same LAN. It’s used to scan and collect the basic information of the SUNMI devices, including serial number and IP addresss.

4. SUNMI Device Discovery Protocol

The SUNMI Device Discovery Protocol is for one device to broadcast UDP messages to find SUNMI devices in the same LAN, and other devices supporting this protocol will respond to those messages, which include basic informations of themselves.

4.1 Message Format

The Payload of UDP message is shown in the figure below. The whole message consists of header, Payload and CRC checksum.

4.1.1 Header

The Message Header, including flag, protocol version, message type and length.

Flag: currently fixed to 0xFFFF33FF.

Version: protocol version, currently only version 0x1 is supported.

Type: message type, 0x1 for the discovery request message and 0x2 for the discovery response message.

Len: length of the payload before base64 encoding.

4.1.2 Payload

This field contains the final payload. The raw data is in json format, and it needs to be base64 encoded before put on the payload.

4.1.3 CRC

This field contains the CRC32 (32-bit Cyclic Redundancy Check) value calculated from the header and payload fields. The receiver use this value to verify the message.

4.2 Protocol Port

Both sender and receiver use port 10001.

4.3 Discovery Request

When the sender wants to find devices support the SUNMI Device Discovery Protocol in the LAN, it need to send UDP broadcast message. The details are as follows:

In this message, field Type is 0x01, Len is 0x0, it means that the payload is empty.

4.4 Discovery Response

This message is sent by the receiver. It is used to tell the sender the informations of itself. The type is 0x02, and the length is calculated according to the data.

The payload content is shown in the figure below, which is the device information in json format.

ip: the IP address of the device.

mac: the MAC address of the device.

firmware: the firmware version of the device, such as 1.0.0

name: device name, currently fixed as SUNMI.

model: device model, such as FM020.

type: device type, currently fixed as IPC.

network: the mode of network connection about the sender. If the sender is connected to the wireless hotspot of IPC, the value is “AP”. If the sender is connected to same LAN of router with IPC, the value is “LAN”.

deviceid: device serial number.

4.5 Timeout handling

It is suggested to send Discovery Request messages with an interval of 1s, and 3 times at most. This is to prevent loss of messages from some devices.

After sending 3 Request Messages, the sender should set a timeout period of 2s, after which the Discovery Response message will not be received. That means the Discovery Response message can only be received in 5s after the first Discovery Request message.

After receiving a Discovery Request message, the receiver should reply with a Discovery Response message in unicast mode immediately.

1.Public Parameters

Public Parameters are required when an API is called. As shown in the table below.

Parameter	Type	Description	Required
app_id	string	User application ID, used as public parameter	Y
timestamp	long	Unix timestamp in second	Y
random	long	A 6-10 digits random number	Y
sign	string	Signature of the request	Y

2.Request Structure

Address

The URL is used to identify which interface is called.

OpenAPI URLs looks like https://ip/openapi/apiType/action

The fields of URL are described as follows:

ip	The IPC’s IP address
openapi	A uniform identifier that represents it is an OpenAPI URL
apiType	API functional types
action	the name of the corresponding interface

Protocol

For security, all APIs use HTTPS Protocol.

Request method

Only HTTP POST method is supported to call the interfaces. The Message content-type is application/x-www-form-urlencoded. Special cases will be described in the corresponding API.

Request parameters

Each interface should be called with parameters. There are public parameters (please refer to Public Parameters ) and private parameters according to the interface.

3. Sign Rules

Each HTTPS request message needs to be signed, and the IPC will verify the signature.

SUNMI store open platform will assign the following parameters to all OpenAPI users:

app_id: the unique identifier of a user ( for some special API, the app_id can be skipped)
secret_key: the signing key of the user

Sign rules

There must be a parameter named ‘random’, it is a random string combination of number and alphabets with a length of 6 to 10 digits.
There must be a parameter named ‘timestamp’, it is the current 10-digit unix timestamp, for details please visit: https://tool.chinaz.com/tools/unixtime.aspx
There must be a parameter named ‘app_id’
Sort all parameter in the key’s alphabetic order. Create a string which concatenate all key-value pair in such order.
Sort all key-value pairs in the key’s alphabetic order and concatenate them to a string.
Concatenate the user’s secret_key at the tail of the string. For details, please read the example
Generate the MD5 signature of the string and convert the MD5 sign to uppercase.

Validation

After receiving the request message, the IPC will use the same rules to check if the sign is valid.

Sign example

Suppose the parameter of the request is the following:

product_id: 389238
user_id: 29389
content: newproductmask
environment: test

Then, by the rules above, we can generate our sign below:

str1 = “app_id=2039dds&content=newproductmask&environment=test&product_id=389238&random=289192×tamp=1593029283&user_id=29389
str2 = str1 + “&key=kdsofkdsnflke9382938k”
sign = MD5(str2).upper()

By the code above, our final request will contains the parameters below:

app_id:2039dds
product_id: 389238
user_id: 29389
content: newproductmask
environment: test
sign: IDKNFLK392038KDS932K
timestamp: 1593029283 random:289192

4. Example

Request Example

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

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

Response Example

The response to the HTTP request is in json format. Here is a simple example.

As follows, the “code” field always exists, which presents the result of calling. The “data” field is optional depend on different APIs.

{
    "code": 0,
    "data": {
        "ssid": "SUNMI_IPC",
        "password": "1234567890"
    }
}

API Call Method

There are two ways to call OpenAPI: synchronous HTTPS Interfaces and asynchronous Message Channel.

HTTPS Interfaces

APIs that return synchronously after called.

Please refer to HTTPS Request.

Message Channel

Messages pushed by the IPC need to be received through Message Channel, so as to ensure real-time.

Please refer to Message Channel.

IPC Notification Center

1. Post Message
- 1.1 Signature
- 1.2 Subscribe
- 1.3 Post
2. Message Channel
- 2.1 Protocol
- 2.2 Connection Establishment
- 2.3 Hartbeat
- 2.4 Subscribe
- 2.5 Publish Message
- 2.6 Disconnect

There are two ways to get IPC message. Firstly, if some event is subscribed, the IPC will post a message to related callback url. Secondly, we can maintain a TCP connection to get related message.

1. Post Message

We can subscribe some topic to IPC, and the IPC will post a http message to the subscribers when something relative happened. It has the same function as Message Channel.

1. 1 Signature

Refer to Sign Rules.

1.2 Subscribe

1.2.1 Subscribe

Description

This API is used to subscribe some topic to IPC. The IPC will post a http message to the callback url passed in by this API when something related happened, thus the subscribe is informed.

Request link

https://192.168.0.1/openapi/hook/add, 192.168.0.1 needs to be replaced by the IP address of IPC.

Request Parameters

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

Parameter	Type	Description	Required
event_list	array[string]	Topic list, the following is allowed. “face_recog_event” is only supported by “FM020”. [“face_recog_event”,”dynamic_detect_event”]	Y
http_callback	string	Callback url. The IPC will post a message to this url when something related happened.	Y

Response Parameters

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

Request Example

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

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K&
event_list=[“face_recog_event”,”dynamic_detect_event”]&http_callback=http://192.168.0.100/msg

Response Example

{
    "code": 0
}

1.2.2 Unsubscribe

Description

This api is used to unsubscribe some topic that is already subscribed. The subscriber will not receive relative messages once relative topic unsubscribed.

Request link

https://192.168.0.1/openapi/hook/delete, 192.168.0.1 needs to be replaced by the IP address of IPC.

Request Parameters

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

Parameter	Type	Description	Required
event_list	array[string]	opic list, the following is allowed. “face_recog_event” is only supported by “FM020”. [“face_recog_event”,”dynamic_detect_event”]	Y
http_callback	string	Callback url. The IPC will only unsubscribe the topic that is already subscribed with this url.

Response Parameters

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

Request Example

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

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K&
event_list=[“dynamic_detect_event”,”face_recog_event”]&http_callback=http://192.168.0.100/msg

Response Example

{
    "code": 0
}

1.2.3 Query subscribed message

Description

This API is used to query all topics and callbacks that subscribed to the IPC. When something related happened, the IPC will post a http message to relative callback urls.

Request link

https://192.168.0.1/openapi/hook/query, needs to be replaced by the IP address of 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, 5, see Error Code for further details.
sub_event	array	Subscriber list
event	string	Topic
http_callback	array	Http callback of the topic
num	string	Number of the subscriber of the topic

Request Example

POST openapi/hook/query 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

{
    "data": {
        "num": 2,
        "sub_event": [
            {
                "event": "face_recog_event",
                "http_callback": [
                    "10.10.61.206:8000"
                ]
            },
            {
                "event": "dynamic_detect_event",
                "http_callback": [
                    "10.10.61.206:8000"
                ]
            }
        ]
    },
    "code": 0
}

1.3 Post

The IPC will post a http message to inform subscribers. The http post is formed in form table, the “Content-Type” is “multipart/form-data”, the payload of message is packaged in “payload”.

Dynamic Detect Message

The payload is formatted as follow：

POST / HTTP/1.1
Host: 10.10.61.206:8000
User-Agent: libcurl/7.52.1 OpenSSL/1.0.2p
Accept: */*
Content-Length: 826
Expect: 100-continue
Content-Type: multipart/form-data; boundary=————————c83c36cd4ee4082f

————————–c83c36cd4ee4082f
Content-Disposition: form-data; name=”app_id”

123
————————–c83c36cd4ee4082f
Content-Disposition: form-data; name=”random”

692777
————————–c83c36cd4ee4082f
Content-Disposition: form-data; name=”timestamp”

1579158766
————————–c83c36cd4ee4082f
Content-Disposition: form-data; name=”sign”

372F669601E8347737744FFC88B74665
————————–c83c36cd4ee4082f
Content-Disposition: form-data; name=”payload”

{“event_id”:1,”detect_type”:2,”video_url”:”https://10.10.63.19/mnt/sd-card/sunmi_video/video_detect/1579158761.flv?auth_key=1579158765-d701e761fecf0df84853440d4dbc3fe1″,”event_type”:”dynamic_detect_event”,”sn”:”SS101D8BS00080″,”report_time”:1579158765}
————————–c83c36cd4ee4082f–

The fields of the payload is described as follow.

Parameter	Type	Description
event_id	long	Event ID
event_type	string	Event Type
report_time	long	Timestamp of event
detect_type	int	Type of dynamic detect: 0: Motion Detected 1: Audio Detected 2: Motion and Audio Detected 3: Detected Human
video_url	string	Download url of the video
sn	string	Serial number of IPC which send this message

Face Recognize Message

The payload is formatted as follow.

POST / HTTP/1.1
Host: 192.168.103.173:8010
User-Agent: libcurl/7.52.1 OpenSSL/1.0.2p
Accept: */*
Content-Length: 906
Content-Type: multipart/form-data; boundary=————————7faeecefd4fb5aaf

————————–7faeecefd4fb5aaf
Content-Disposition: form-data; name=”app_id”

KJQJ89V956U9O9UI
————————–7faeecefd4fb5aaf
Content-Disposition: form-data; name=”random”

956429
————————–7faeecefd4fb5aaf
Content-Disposition: form-data; name=”timestamp”

1597894809
————————–7faeecefd4fb5aaf
Content-Disposition: form-data; name=”sign”

004B3CD3FACB562E06CC04A0935410A5
————————–7faeecefd4fb5aaf
Content-Disposition: form-data; name=”payload”

{“event_id”:2,”faceid”:”358526″,”group_name”:”db_0″,”age”:0,”age_range”:5,”gender”:0,”arrive_times”:3,”pic_url”:”https://192.168.103.117/mnt/sd-card/sunmi_image/snap/1597894624456_7.jpg?auth_key=1597894624-f88c2f9a6e69834430648c2f4931ffae”,”event_type”:”face_recog_event”,”sn”:”FS101D8BS00080″,”report_time”:1597894809}
————————–7faeecefd4fb5aaf–

The payload is formatted as follow.

Parameter	Type	Description
event_id	long	Event ID
event_type	string	Event Type
sn	string	Serial number of IPC which send this message
report_time	long	Timestamp of event
faceid	string	Face ID
group_name	string	Name of group which the face belong to
age	int	Age, if it’s blank, it means that the age of this face has not set yet
age_range	int	Range of age 1 — 1 to 6 years old 2 — 7 to 12 years old 3 — 13 to 18 years old 4 — 19 to 28 years old 5 — 29 to 35 years old 6 — 36 to 45 years old 7 — 45 to 55 years old 8 — 55 to 100 years old
gender	int	Gender 0 — Undefined 1 — Male 2 — Female
arrive_times	int	Total times of arrival
pic_url	string	Url of face picture
item1	string	User-defined attribute, only returned if exist
item2	string	User-defined attribute, only returned if exist
item3	string	User-defined attribute, only returned if exist
item4	string	User-defined attribute, only returned if exist
item5	string	User-defined attribute, only returned if exist

2. Message Channel

Message channel allows user to maintain a tcp connect with IPC to communicate with IPC, it has the same function as Post Message.

2.1. Protocol

Protocol

The message channel use TCP connection with SSL to ensure the security of data. The protocol is implemented as Client/Server mode where the IPC is the server on port 10021.

Protocol Format

The protocol message, which consists of header, payload and CRC checksum, is described briefly in this section, as shown in the figure below.

Header

Flag

The “Flag” is fixed to 0xFF3E3EFF indicating it is using message channel.

Version

The “Version” describes the version of the protocol, it’s 0x01 for the moment. The protocol is backward compatible.

Packet Type

Type	Value	Direction	Description
Reserved	0	Prohibit	Reserved
CONNECT	1	Client to Server	Client send this message to establish connection
CONNACK	2	Server to Client	Connection acknowledge message sent by server, the content marks whether the connection is legal or not
PINGREQ	3	Client to Server	Heartbeat request
PINGRESP	4	Server to Client	Heartbeat response
SUBSCRIBE	5	Client to Server	Client send this message to subscribe events
SUBACK	6	Server to Client	Confirmation of subscription
UNSUBSCRIBE	7	CLient to Server	Client send this message to unsubscribe events
UNSUBACK	8	Server to Client	Confirm of unsubscription
PUBLISH	9	Client to Server, or Server to Client	Only server can publish message to client for the moment
PUBACK	10	Client to Server, or Server to Client	Acknowledge to published message
DISCONNECT	11	Client to Server, or Server to Client	Disconnect

Length

“Length” is the length of the payload, which range from 0 to 65535.

Payload

“Payload” is the actual content of the message, which formatted with json. The payload is different for each packet type.

CRC Checksum

“CRC” is the CRC(Cyclic Redundancy Check) checksum of payload, which occupies 4 bytes.

2.2 Connection Establishment

The connection is initiated by client, and IPC act as server.

Initiate connection

The Packet Type of the message is 0x01, and the payload is formatted as bellow. The client will insert some parameters in payload, and sign the payload with secret key. The signature rule is described in Sign Rules section. The server check whether the content is legal with the same signature rule.

{
    "app_id": "mdk923idkf",
    "timestamp": "15930292837",
    "random": "289192",
    "sign": "IDKNFLK392038KDS932K",
    "keep_alive": 30
}

keep_alive: The period of heartbeat in unit of second, which can be specified by client.

Acknowledge to connection

The Packet Type of the message is 0x02, and the payload is formatted as bellow. The “code” represents the request result, possible return codes are 0, 1, 2, 3, 5, 7, refer to Error Code for more details.

{
    "code": 0
}

2.3 Heartbeat

The client send heartbeat message to server with specified period, and the server will disconnect after 3 heartbeat messages.

Heartbeat request

The header of the message is 0x03, and the payload is empty.

Heartbeat response

The header of the message is 0x04, and the payload is empty.

2.4 Subscribe

The client subscribes message to server.

Subscribe or unsubscribe

The header of the message is 0x05 or 0x07, and the payload is formatted as bellow.

{
    "event_list": [
        "dynamic_detect_event",
        "face_recog_event"
    ]
}

The fields of the payload is described as bellow.

Parameter	Type	Description
event_list	string	List of events to be subscribed

The supported events is listed bellow.

Event Type	Description
dynamic_detect_event	Dynamic detect event
face_recog_event	Face recognition event

Response of subscribe or unsubscribe

The header of the message is 0x06 or 0x07, and the payload is formatted as follow. The “code” represents the request result, possible return codes are 0, 1, 2, 3, 5, 7, 310, 311, refer to Error Code for more details.

{
    "code": 0
}

2.5 Publish message

Publish

The IPC server publishe messages to client. The header of the message is 0x09, and the payload is different with event.

Dynamic detect message

The payload is formatted as follow.

{
    "event_id": 1,
    "event_type": "dynamic_detect_event",
    "sn": "FS101D8BS00106",
    "report_time": 15930292837,
    "detect_type": 1,
    "video_url": "https://192.168.0.1/mnt/sd-card/sunmi_video/video_detect/1565535983.flv?auth_key=1564129415215f61f3c5f552c5bf8f43ccef5c66a9"
}

The fields of the payload is described as follow.

Name	Type	Description
event_id	long	Event ID
event_type	string	Event Type
report_time	long	Timestamp of the event
detect_type	int	Type of dynamic detect: 1: picture changed 2: voice changed 3: picture and voice changed
video_url	string	URL of video
sn	string	Serial number of the IPC which send this message

Face recognize message

The payload is formatted as follow.

{
    "event_id": 2,
    "event_type": "face_recog_event",
    "sn": "FS101D8BS00106",
    "report_time": 15930292837,
    "group_name": "vip",
    "faceid": "00000001",
    "age": 10,
    "gender": 2,
    "arrive_times": 4,
    "pic_url":"https://192.168.103.117/mnt/sd-card/sunmi_image/snap/1597894624456_7.jpg?auth_key=1597894624-f88c2f9a6e69834430648c2f4931ffae",
    "vip_level": "1",
    "hobby": "tennis",
    "weight": "60",
    "height": "180"
}

The fields of the payload is described as follow.

Name	Type	Description
event_id	long	Event ID
event_type	string	Event Type
sn	string	Serial number of IPC which send this message
report_time	long	Timestamp of event
faceid	string	Face ID
group_name	string	Name of group which the face belong to
age	int	Age, if it’s blank, it means that the age of this face has not set yet
age_range	int	Range of age 1– 1 to 6 yeares old; 2– 7 to 12 years old; 3– 13 to 18 years old; 4– 19 to 28 years old; 5– 29 to 35 years old; 6– 36 to 45 years old; 7– 45 to 55 years old; 8– 55 to 100 years old.
gender	int	Gender 0– Undefined; 1– Male; 2– Female.
arrive_times	int	Total times of arrival
pic_url	string	Url of face picture
item1	string	User-defined attribute, only returned if exist.
item2	string	User-defined attribute, only returned if exist.
item3	string	User-defined attribute, only returned if exist.
item4	string	User-defined attribute, only returned if exist.
item5	string	User-defined attribute, only returned if exist.

Acknowledge to publish

If the subscriber received this message, it should return acknowledge. The header of the message is 0x0a, and the payload is formatted as fellow.

{
    "event_id": 1
}

The fields of the payload is described as follow.

Name	Type	Description
event_id	long	Event ID

2.6 Disconnect

The header of this message is 0x11, and the payload is empty.

Face Recognition

Create Face Group
Edit Face Group
Configure The Stranger-to-regular Conditions
Delete Face Group
Get The List of Face Group
Add Attributes to A Face Group
Delete Attributes of A Face Group
Get List of User-defined Attributes of A Face Group
Add Face Record
Delete Face Record
Update Face Record
Get Face Record
Get List of Face Records
Get Face Records That Don’t Arrival For The Longgest Time

1. Create Face Group

Description

Create a new face group via this interface and configure its attributes. The IPC supports up to 10 face groups including the default stranger group and regular group and maximum 8 user groups.

Request link

https://192.168.0.1/ openapi/face/createGroup, 192.168.0.1 needs to be replaced with the actual IP address of 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	The name of group, maximum 96 characters. The system has two default group, stranger and regular.	Y	vip
capacity	int	Capacity of group, the sum of all group capacities shall not exceed 30000.	Y	10000
Description	string	Description of group, maximum 150 characters.	Y	Customers with gold card.

Note:

1. The first character of name shall not be a blank space;

2. By default, the name of stranger group is stranger, the name of regular group is regular.

Response Parameters

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

Request Example

POST openapi/face/createGroup 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=vip&capacity=10000&description=Customers with gold card.

Response Example

{
    "code": 0
}

2. Edit Face Group

Description

This API is used to edit attributes of a face group.

Request link

https://192.168.0.1/openapi/face/updateGroup, 192.168.0.1 needs to be replaced with the actual IP address of IPC.

Request Parameters

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

Parameter	Type	Description	Required	Example
old_name	string	The name of Face Group you want to modify.	Y	vip
name	string	The new name of Face Group, can be same with old_name.	Y	svip
capacity	int	The new capacity of Face Group, can be same with the old capacity.	Y	10000
Description	string	Description of group, maximum 150 characters.	Y	Customers with platinum card.

Note:

1.name must be same with old_name when you edit stranger group or regular group, in other words, the name of default groups art not allowed to be modified;

2.The first character of name shall not be a blank space.

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 200, 201, 202, 204, 211, 212, 220, see Error Code for further details.

Request Example

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

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K& old_name=vip&name=svip&capacity=10000&description=Customers with platinum card.

Response Example

{
    "code": 0
}

3. Configure The Stranger-to-regular Conditions

Description

Stranger and regular face groups will be created once the IPC is activated. The records in stranger face group will be moved to the regular face group when they meet the moving conditions which is 5 times in 7 days by default. This API is used to Configure The Stranger-to-regular Conditions.

Request Link

https://192.168.0.1/openapi/face/updateMigration, 192.168.0.1 needs to be replaced with the actual IP address of IPC.

Request Parameters

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

Parameter	Type	Description	Required	Example
arrive_times	int	value range 1~10.	Y	5
period	int	value range 1~100, unit: day.	Y	20

Note:

It means that record will be move from stranger to regular while the face was captured more than [arrive_times] times in [period] days. So this api is only applicable to the stranger face group.

Response Parameters

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

Request Example

POST openapi/face/updateMigrationHTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K&arrive_times=5&period=3

Response Example

{
    "code": 0
}

4. Delete Face Group

Description

Delete the specified face group.

Request Link

https://192.168.0.1/openapi/face/deleteGroup, 192.168.0.1 needs to be replaced with the actual IP address of 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	The name of group to be deleted, stranger and regular group art not allowed to be deleted. The group should be empty before it is deleted.	Y	vip

Response Parameters

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

Request Example

POST openapi/face/deleteGroup 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=vip

Response Example

{
    "code": 0
}

5. Get The List of Face Group

Description

This API is used to get infomations of all groups.

Request Link

https://192.168.0.1/openapi/face/getGroupList, 192.168.0.1 needs to be replaced with the actual IP address of 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, 2, 3, 5, 7, 211, 220, see Error Code for further details.
num	int	number of groups
name	string	name of group
capacity	int	capacity of group.
Description	string	description of group.
times	int	attribute only for stranger.
period	int	attribute only for stranger.
count	int	number of records in the group.

Request Example

POST openapi/face/getGroupList 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

{
    "data": {
        "face_group": [
            {
                "capacity": 5000,
                "count": 0,
                "name": "regular",
                "description": "this is regular group"
            },
            {
                "capacity": 1000,
                "count": 0,
                "name": "employee",
                "description": "this is employee group"
            },
            {
                "capacity": 1000,
                "count": 0,
                "name": "blacklist",
                "description": "this is blacklist group"
            },
            {
                "name": "stranger",
                "times": 5,
                "capacity": 1000,
                "count": 0,
                "period": 2,
                "description": "this is stranger group"
            }
        ],
        "num": 4
    },
    "code": 0
}

6. Add Attributes to A Face Group

Description

Each face group has 5 user-defined fields or attributes that can be filled with string with up to 50 characters for every records, except the default groups.

It is strongly recommended to add user-defined attributes after creating the face group and before adding any record with this interface.

Request Link

https://192.168.0.1/openapi/face/addFaceInfoItem, 192.168.0.1 needs to be replaced with the actual IP address of IPC.

Request Parameters

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

Parameter	Type	Description	Required	Example
num	int	Number of attributes to add.	Y	1
group_name	string	Name of group.	Y	vip
name_list	string array	Attribute name list, maximum 50 characters in length for each name.	Y	[“hobby”]

Note:

1. The default groups (stranger and regular) are not allowed to add attributes;

2. The following names are reserved and can not be used as attribute names: group_name, pic, age, gender, faceid, age_range, arrive_times, pic_url, total_num, return_num。

Response Parameters

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

Request Example

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

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K& num=2&group_name=vip&name_list=[“phone_num”, “weight”]

Response Example

{
    "code": 0
}

7. Delete Attributes of A Face Group

Description

This interface is used to delete user-defined attributes in a specified face group.

Request Link

https://192.168.0.1/openapi/face/removeFaceInfoItem, 192.168.0.1 needs to be replaced with the actual IP address of IPC.

Request Parameters

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

Parameter	Type	Description	Required	Example
num	int	Number of attributes to delete.	Y	1
group_name	string	Name of group	Y	vip
name_list	string	Attribute name list, maximum 50 characters in length for each name.	Y	[“hobby”]

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 204, 211, 220, 240, 241, 242, 243, see Error Code for further details.

Request Example

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

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K& num=2&group_name=vip&name_list=[“phone_num”, “weight”]

Response Example

{
    "code": 0
}

8. Get List of User-defined Attributes of A Face Group

Description

This interface is used to get the list of user-defined attribute of a specified group.

Request Link

https://192.168.0.1/openapi/face/getFaceInfoItem, 192.168.0.1 needs to be replaced with the actual IP address of IPC.

Request Parameters

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

Parameter	Type	Description	Required	Example
group_name	string	name of group	Y	stranger

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 204, 211, 220, see Error Code for further details.
num	int	Number of attributes.
name_list	string	Attribute name list.

Request Example

POST openapi/face/getFaceInfoItemHTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K& num=2&group_name=vip

Response Example

{
    "code": 0,
    "data": {
        "num": 3,
        "name_list": [
            "phone",
            "address",
            "vip_level"
        ]
    }
}

9. Add Face Record

Description

This API is used to add a face record in the specified group.

Request Type

Content-Type is multipart/form-data, and all arguments except file are signed according to the signature rules.

Request Link

https://192.168.0.1/openapi/face/addFace, 192.168.0.1 needs to be replaced with the actual IP address of IPC.

Request Parameters

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

Parameter	Type	Description	Required	Example
faceid	string	Faceid, a positive 64-bit numeric string, the device will generate if not supply	N	123456
pic	file	Face photo file in jpg/png format, maximum resulution is 1920*1080, the size of file must not exceed 1M bytes.	N	example.jpg
group_name	string	name of group	Y	stranger
age	int	preset attribute, age	N	14
gender	int	preset attribute , gender, 0 for unknown, 1 for male, 2 for female	N	1
item1	string	user-defined attribute 1	N	value1
item2	string	user-defined attribute 2	N	value2
item3	string	user-defined attribute 3	N	value3
item4	string	user-defined attribute 4	N	value4
item5	string	user-defined attribute 5	N	value5

Note:

1.The preset attributes above are built-in attribute of face record in the databse, and others include item1/item2/item3/item4/item5 are user-defined attributes. Users must call the interface to add user-defined attributes before using; The IPC will ignore the parameters if the corresponding attributes are not found.

2.If the attribute age is not provided, the age range will be set automatically by the IPC;

3. If the attribute gender is not provided, this field will be set automatically by the IPC.

Response Parameters

Parameter	Type	Description	Example
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 204, 206, 208, 210, 211, 220, see Error Code for further details.
faceid	string	Face ID.	105

Request Example

POST /openapi/face/addFace HTTP/1.1
Host: 192.168.0.1
Content-Type: multipart/form-data; boundary=————————–962974737227706390007700
Content-Length: 1683

—————————-962974737227706390007700
Content-Disposition: form-data; name=”app_id”

mdk923idk
—————————-962974737227706390007700
Content-Disposition: form-data; name=”random”

289192
—————————-962974737227706390007700
Content-Disposition: form-data; name=”timestamp”

15930292837
—————————-962974737227706390007700
Content-Disposition: form-data; name=”sign”

IDKNFLK392038KDS932K
—————————-962974737227706390007700
Content-Disposition: form-data; name=”group_name”

VIP
—————————-962974737227706390007700
Content-Disposition: form-data; name=”age”

21
—————————-962974737227706390007700
Content-Disposition: form-data; name=”gender”

1
—————————-962974737227706390007700
Content-Disposition: form-data; name=”hobby”

hiking
—————————-962974737227706390007700
Content-Disposition: form-data; name=”vip_level”

2
—————————-962974737227706390007700
Content-Disposition: form-data; name=”weight”

60
—————————-962974737227706390007700
Content-Disposition: form-data; name=”phone_num”

1234
—————————-962974737227706390007700
Content-Disposition: form-data; name=”pic”; filename=”11024.jpg”
Content-Type: image/jpeg

(binary data of picture)
—————————-962974737227706390007700–

Note:

The above hobby, vip_level, weight and phone_num are user-defined attributes, should be added before using them.

Response Example

{
    "code": 0,
    "data": {
        "faceid": "105"
    }
}

10. Delete Face Record

Description

This API is used to delete the face records from the specified group.

Request Link

https://192.168.0.1/openapi/face/deleteFace, 192.168.0.1 needs to be replaced with the actual IP address of IPC.

Request Parameters

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

Parameter	Type	Description	Required	Example
num	int	Number of face records to delete	Y	1
group_name	string	Name of group	Y	Example
faceid_list	string array	List of face record to delete.	Y	[“105”]

Response Parameters

Paramter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 204, 211, 220, see Error Code for further details.
success_list	string array	List of face records that have been deleted
failed_list	string array	List of failed deleting face records
not_exist_list	string array	List of face records that are not exist.

Request Example

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

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K& group_name=vip&faceid_list=[“000001”, “0000002”]&num=2

Response Example

{
    "code": 0,
    "data": {
        "success_list": [
            "000001",
            "000002"
        ],
        "failed_list": [],
        "not_exist_list": [
            "000003"
        ]
    }
}

11. Update Face Record

Description

Update the information of the specified face record.

Request Link

https://192.168.0.1/openapi/face/updateFace, 192.168.0.1 needs to be replaced with the actual IP address of IPC.

Request Method

Content-Type is multipart/form-data, and all arguments except file are signed according to the signature rules.

Request Parameters

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

Parameter	Type	Description	Required	Example
group_name	string	Name of group	Y	svip
faceid	string	Face ID	Y	21
new_group_name	string	New group name, the record will be moved to this group if provided.	N	vip
pic	file	Face photo file in jpg/png format, maximum resulution is 1920*1080, the size of file must not exceed 1M bytes.	N	example.jpg
age	int	preset attribute, age	N	10
gender	int	preset attribute , gender, 0 for unknown, 1 for male, 2 for female	N	1
item1	string	user-defined attribute 1	N	value1
item2	string	user-defined attribute 2	N	value2
item3	string	user-defined attribute 3	N	value3
item4	string	user-defined attribute 4	N	value4
item5	string	user-defined attribute 5	N	value5

Response Parameters

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

Request Example

POST /openapi/face/addFace HTTP/1.1
Host: 192.168.0.1
Content-Type: multipart/form-data; boundary=————————–962974737227706390007700
Content-Length: 1683

—————————-962974737227706390007700
Content-Disposition: form-data; name=”app_id”

mdk923idk
—————————-962974737227706390007700
Content-Disposition: form-data; name=”random”

289192
—————————-962974737227706390007700
Content-Disposition: form-data; name=”timestamp”

15930292837
—————————-962974737227706390007700
Content-Disposition: form-data; name=”sign”

IDKNFLK392038KDS932K
—————————-962974737227706390007700
Content-Disposition: form-data; name=”group_name”

stranger
—————————-962974737227706390007700
Content-Disposition: form-data; name=”facdid”

21
—————————-962974737227706390007700
Content-Disposition: form-data; name=”new_group_name”

VIP
—————————-962974737227706390007700
Content-Disposition: form-data; name=”hobby”

hiking
—————————-962974737227706390007700
Content-Disposition: form-data; name=”vip_level”

2
—————————-962974737227706390007700
Content-Disposition: form-data; name=”weight”

60
—————————-962974737227706390007700
Content-Disposition: form-data; name=”phone_num”

1234
—————————-962974737227706390007700–

Note:

The above hobby, vip_level, weight and phone_num are user-defined attributes, should be added before using them.

Response Example

{
    "code": 0
}

12. Get Face Record

Description

Get information of the face record by face ID.

Request Link

https://192.168.0.1/openapi/face/getFace, 192.168.0.1 needs to be replaced with the actual IP address of IPC.

Request Parameters

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

Parameter	Type	Description	Required	Example
faceid	string	ace ID	Y	4

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 211, see Error Code for further details.
faceid	string	Face ID
group_name	string	Group name
age	int	age, NULL means user has not set the age of the face record.
age_range	int	age range, 1 means 1~6 years old, 2 means 7~12 years old, 3 means 13~18 years old, 5 means 19~28 years old, 5 means 29~35 years old, 6 means 36~45 years old, 7 means 45~55 years old, 8 means 55~100 years old
gender	int	gender, 0 means unknown, 1 means male, 2 means female
arrive_count	int	Total number of arrivals
arrive_time	int	Timestamp of the last arrival
item1	string	User-defined attribute 1, only returned if exist.
item2	string	User-defined attribute 2, only returned if exist.
item3	string	User-defined attribute 3, only returned if exist.
item4	string	User-defined attribute 4, only returned if exist.
item5	string	User-defined attribute 5, only returned if exist.

Request Example

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

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

Response Example

{
    "code": 0,
    "data": {
        "arrive_time": 1566215943,
        "arrive_count": 2,
        "faceid": "4",
        "group_name": "vip",
        "point": "113",
        "gender": 1,
        "age": 10,
        "age_range": 2,
        "vip_level": "1",
        "hobby": "tennis",
        "weight": "60",
        "height": "180"
    }
}

Note:

The above hobby, vip_level, weight and phone_num are user-defined attributes, should be added before using them.

13. Get List of Face Records

Description

Get list of the face records in the specified group.

Request Link

https://192.168.0.1/openapi/face/getFaceList, 192.168.0.1 needs to be replaced with the actual IP address of IPC.

Request Parameters

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

Parameter	Type	Description	Required	Example
group_name	string	name of group	Y	vip
page_num	int	Current page number, default and minimum is 1	N	4
page_size	int	Current page entries, default is 10, range is [1, 100]	N	10

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 211, see Error Code for further details.
total_num	int	Total number of face records
return_num	int	Number of face records currently returned
faceid	string	Face ID
age	int	age, NULL means user has not set the age of the face record.
age_range	int	age range, 1 means 1~6 years old, 2 means 7~12 years old, 3 means 13~18 years old, 5 means 19~28 years old, 5 means 29~35 years old, 6 means 36~45 years old, 7 means 45~55 years old, 8 means 55~100 years old
gender	int	gender, 0 for unknown, 1 for male, 2 for female
arrive_count	int	Total number of arrivals
arrive_time	int	Timestamp of the last arrival
item1	string	User-defined attribute 1, only returned if exist.
item2	string	User-defined attribute 2, only returned if exist.
item3	string	User-defined attribute 3, only returned if exist.
item4	string	User-defined attribute 4, only returned if exist.
item5	string	User-defined attribute 6, only returned if exist.

Request Example

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

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

Response Example

{
    "code": 0,
    "data": {
        "total_num": 2,
        "num": 2,
        "faceid_list": [
            {
                "arrive_time": 1566215929,
                "arrive_count": 2,
                "faceid": "3",
                "point": "113",
                "gender": 2,
                "vip_level": "3",
                "hobby": "tennis",
                "weight": "60",
                "height": "180",
                "age": 10,
                "age_range": 2
            },
            {
                "arrive_time": 1566215998,
                "arrive_count": 1,
                "faceid": "4",
                "point": "113",
                "gender": 1,
                "vip_level": "1",
                "hobby": "tennis",
                "weight": "60",
                "height": "180",
                "age": 10,
                "age_range": 2
            }
        ]
    }
}

14. Get Face Records That Don’t Arrive For The Longest Time

Description

Get list of last N face records sorted by the “last arrival” time.

Request Link

https://192.168.0.1/openapi/face/getFaceByArrival, 192.168.0.1 needs to be replaced with the actual IP address of IPC.

Request Parameters

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

Parameter	Type	Description	Required	Example
group_name	string	Name of group	Y	vip
num	int	Number of face records, range is 1~10, default is 1.	N	2

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 207, 211, see Error Code for further details.
return_num	int	Number of face records currently returned
faceid	string	Face ID
age	int	Age, NULL means user has not set the age of the face record.
age_range	int	age range, 1 means 1~6 years old, 2 means 7~12 years old, 3 means 13~18 years old, 5 means 19~28 years old, 5 means 29~35 years old, 6 means 36~45 years old, 7 means 45~55 years old, 8 means 55~100 years old
gender	int	Gender, 0 for unknown, 1 for male, 2 for female
arrive_count	int	Total number of arrivals
arrive_time	int	Timestamp of the last arrival
item1	string	User-defined attribute 1, only returned if exist.
item2	string	User-defined attribute 2, only returned if exist.
item3	string	User-defined attribute 3, only returned if exist.
item4	string	User-defined attribute 4, only returned if exist.
item5	string	User-defined attribute 5, only returned if exist.

Request Example

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

app_id=mdk923idkf&random=289192&timestamp=15930292837&sign=IDKNFLK392038KDS932K& group_name=vip&num=2

Response Example

{
    "code": 0,
    "data": {
        "return_num": 2,
        "faceid_list": [
            {
                "faceid": "8",
                "arrive_time": 1566215929,
                "arrive_count": 7,
                "age_range": 5,
                "gender": 1,
                "age": 0,
                "item1": "value1",
                "item2": "value2",
                "item3": "value3",
                "item4": "value4",
                "item5": "value5"
            },
            {
                "faceid": "10",
                "arrive_time": 1566110525,
                "arrive_count": 6,
                "age_range": 4,
                "gender": 2,
                "age": 0,
                "item1": "value1",
                "item2": "value2",
                "item3": "value3",
                "item4": "value4",
                "item5": "value5"
            }
        ]
    }
}

Customer Flow Statistics

1.Set The Coordinates of Door Threshold
2.Get The Coordinates of Door Threshold
3.Get Inflow Customer Statistics For A Specified Time
4.Get Pass-by Customer Statistics For A Specified Time
5.Get Outflow Customer Statistics For A Specified Time
6.Get The List of Vistors In A Specified Time
7.Get The Visit Records of A Specified Face ID

1.Set The Coordinates of Door Threshold

Description

The the door threshold is used to judge whether a person has came in or not. This API is used to set the coordinates of door threshold.

Request link

https://192.168.0.1/openapi/peopleFlow/setDoorLine, 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
resolution	int	Resolution of the image, 0 for 1080p, 1 for 720P	Y	0
start_x	int	The x-coordinate of the starting point of the door threshold, range is [0, 1920] for 1080p, and range is [0, 1280] for 720p	Y	500
start_y	int	The y-coordinate of the starting point of the door threshold, range is [0, 1080] for 1080p, and range is [0, 720] for 720p	Y	500
end_x	int	The x-coordinate of the end point of the door threshold, range is [0, 1920] for 1080p, and range is [0, 1280] for 720p	Y	500
end_y	int	The y-coordinate of the end point of the door threshold, range is [0, 1080] for 1080p, and range is [0, 720] for 720p	Y	500

Response Parameters

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

Request Example

POST openapi/peopleFlow/setDoorLineHTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded

app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K&resolution=0&start_x=1200&start_y=900&end_x =1500&end_y=900

Response Example

{
"code":  0
}

2.Get The Coordinates of Door Threshold

Description

Get the coordinates of door threshold.

Request link

https://192.168.0.1/openapi/peopleFlow/getDoorLine, 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, 2, 3, 5, 7, 260, 261, 262, 263, 264, 276, 277, 279, see Error Code for further details.
resolution	int	Resolution of the image, 0 for 1080p, 1 for 720P
start_x	int	The x-coordinate of the starting point of the door threshold, range is [0, 1920] for 1080p, and range is [0, 1280] for 720p
start_y	int	The y-coordinate of the starting point of the door threshold, range is [0, 1080] for 1080p, and range is [0, 720] for 720p
end_x	int	The x-coordinate of the end point of the door threshold, range is [0, 1920] for 1080p, and range is [0, 1280] for 720p
end_y	int	The y-coordinate of the end point of the door threshold, range is [0, 1080] for 1080p, and range is [0, 720] for 720p

Request Example

POST openapi/peopleFlow/getDoorLine 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": {
    "resolution": 0,
    "start_x": 1200,
    "start_y": 900,
    "end_x": 1500,
    "end_y": 900
    }
}

3.Get Inflow Customer Statistics For A Specified Time

Description

Get inflow customer statistics in a specified time. Error will be returned if no record is found.

Request link

https://192.168.0.1/openapi/peopleFlow/getPeopleStat, 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
start_time	long	Start time, UNIX format timestamp in second.	Y	1578969264
end_time	long	End time, UNIX format timestamp in second.	Y	1579055640
period	int	Time granularity, 1: half an hour; 2: one hour; 3: one day.	Y	2

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 211, 220, 265, 266, 267, 277, 280, see Error Code for further details.
total	int	Total number of people
start_time	long	Start time of Statistics
end_time	long	End time of Statistics
male_num_stat	array	There are 8 integers in the integer array, representing the male statistical data of 1-6 years old, 7-12 years old, 13-18 years old, 19-28 years old, 29-35 years old, 36-45 years old, 46-55 years old and 56-100 years old respectively.
female_num_stat	array	There are 8 integers in the integer array, representing the female statistical data of 1-6 years old, 7-12 years old, 13-18 years old, 19-28 years old, 29-35 years old, 36-45 years old, 46-55 years old and 56-100 years old respectively.

Request Example

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

app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K&start_time=1561910400&end_time=1562083200&period=3

Note: This example is to get the customer flow statistics from 2019-07-01 to 2019-07-02 with the time granularity of one day.

Response Example

{
    "code": 0,
    "data": {
    "total": 2998,
    "stat_list": [{
            "start_time": 1561910400,
            "end_time": 1561996800,
            "total": 1499,
            "male_num_stat": [10, 20, 50, 109, 280, 380, 156, 10],
            "female_num_stat": [11, 34, 50, 78, 132, 45, 123, 11]
        },
        {
            "start_time": 1561996800,
            "end_time": 1562083200,
            "total": 1499,
            "male_num_stat": [10, 20, 50, 109, 280, 380, 156, 10],
            "female_num_stat": [11, 34, 50, 78, 132, 45, 123, 11]
        }]
    }
}

4.Get Pass-by Customer Statistics For A Specified Time

Description

Get pass-by customer statistics in a specified time. Error will be returned if no record is found.

Request link

https://192.168.0.1/openapi/peopleFlow/getPeopleStatPass, 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
start_time	long	Start time, UNIX format timestamp in second.	Y	1578969264
end_time	long	End time, UNIX format timestamp in second.	Y	1579055640
period	int	Time granularity, 1: half an hour; 2: one hour; 3: one day.	Y	2

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 211, 220, 265, 266, 267, 277, 280, see Error Code for further details.
total	int	Total number of people
start_time	long	Start time of Statistics
end_time	long	End time of Statistics

Request Example

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

app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K&start_time=1561910400&end_time=1562083200&period=3

Note: This example is to get the customer flow statistics from 2019-07-01 to 2019-07-02 with the time granularity of one day.

Response Example

{
    "code": 0,
    "data": {
    "total": 2998,
    "stat_list": [{
            "start_time": 1561910400,
            "end_time": 1561996800,
            "total": 1499,
        },
        {
            "start_time": 1561996800,
            "end_time": 1562083200,
            "total": 1499,
        }]
    }
}

5.Get Outflow Customer Statistics For A Specified Time

Description

Get outflow customer statistics in a specified time. Error will be returned if no record is found.

Request link

https://192.168.0.1/openapi/peopleFlow/getPeopleStatOut, 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
start_time	long	Start time, UNIX format timestamp in second.	Y	1578969264
end_time	long	End time, UNIX format timestamp in second.	Y	1579055640
period	int	Time granularity, 1: half an hour; 2: one hour; 3: one day.	Y	2

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 211, 220, 265, 266, 267, 277, 280, see Error Code for further details.
total	int	Total number of people
start_time	long	Start time of Statistics
end_time	long	End time of Statistics

Request Example

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

app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K&start_time=1561910400&end_time=1562083200&period=3

Note: This example is to get the customer flow statistics from 2019-07-01 to 2019-07-02 with the time granularity of one day.

Response Example

{
    "code": 0,
    "data": {
    "total": 2998,
    "stat_list": [{
            "start_time": 1561910400,
            "end_time": 1561996800,
            "total": 1499,
        },
        {
            "start_time": 1561996800,
            "end_time": 1562083200,
            "total": 1499,
        }]
    }
}

6. Get The List of Vistors In A Specified Time

Description

Get the list of vistors sorted by arrival times in a specified time.

Request link

https://192.168.0.1/openapi/peopleFlow/getVisitorList, 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
start_time	long	UNIX format timestamp in second.	Y	1578969264
end_time	long	UNIX format timestamp in second.	Y	1579055640
order	int	Number of records sorted by arrival times.	Y	50
group_name	string	Specify a face group, default to all face groups.	N	vip
gender	int	Gender, 1 for male, 2 for female, both male and female if this parameter not provided.	N	1
age_range	int	Age group: 1 for [1,6], 2 for [7,12], 3 for [13,18], 4 for [19,28], 5 for [29,35], 6 for [36,45], 7 for [46,55], 8 for [56, 100]	N	4
age	int	Age and age range are mutually exclusive. First query the faces that meet the age. If the age is not provided but the age range is provided, query the faces that meet the age range; if the age and the age range are not provided, query the faces of all ages.	N	4
item1	string	It can be matched according to the custom attribute, and the match of the custom attribute 1. If you need to use the custom attribute query, make sure that the specified face group has added the corresponding custom attribute, otherwise the query fails (you cannot add the custom attribute for the group of strangers and regular)	N	value1
item2	string	Match of custom attribute 2	N	value2
item3	string	Match of custom attribute 3	N	value3
item4	string	Match of custom attribute 4	N	value4
item5	string	Match of custom attribute 5	N	value5
page_num	int	Current page number, default and minimum is 1	N	1
page_size	int	Current page entries, default is 10, range is [1, 100]	N	10

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 211, 220, 266, 267, 268, 269, 270, 271, 272, 273, 274, 277, 280, 281, 282, see Error Code for further details.
total_num	int	Total number of faces meeting the specified conditions
return_num	int	Current number of faces
faceid	string	Face ID
group_name	string	Group name
age	string	Age. If it is blank, the real age is not set
age_range	int	1 for [1,6], 2 for [7,12], 3 for [13,18], 4 for [19,28], 5 for [29,35], 6 for [36,45], 7 for [46,55], 8 for [56, 100]
gender	int	Gender, 0 for unknown, 1 for male, 2 for female
arrive_times	int	Number of arrivals
item1	string	Custom attribute 1, which will be returned only after the user has added it
item2	string	Custom attribute 2, which will be returned only after the user has added it
item3	string	Custom attribute 3, which will be returned only after the user has added it
item4	string	Custom attribute 4, which will be returned only after the user has added it
item5	string	Custom attribute 5, which will be returned only after the user has added it

Request Example

The following is a list of face ID information obtained from 30-year-old male VIP guests who have visited most times in two days from June 14, 2019 to June 15, 2019.

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

app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K&
order=2&start_date=1560441600&end_date=1560528000&gropu_name=vip&age=30&gender=1&item1=value1&&item2=value2&&item3=value3&&item4=value5&&item5=value5

Response Example

{
    "code": 0,
    "data": {
    "total_num": 2,
    "return_num": 2,
    "face_list": [{
        "faceid": "000001",
        "group_name": "vip",
        "age": "32",
        "age_range": 5,
        "gender': 1, 
        "arrive_times": 100,
        "item1": value1, //Custom attribute 
        "item2": value2, //Custom attribute 
        "item3": value3, //Custom attribute 
        "item4": value4, //Custom attribute
        "item5": value5 //Custom attribute 
        }, {
        "faceid": "000002",
        "group_name": "vip",
        "age": "30",
        "age_range": 5,
        "gender": 1,
        "arrive_times": 99,
        "item1": value1, //Custom attribute 
        "item2": value2, //Custom attribute
        "item3": value3, //Custom attribute
        "item4": value4, //Custom attribute 
        "item5": value5 //Custom attribute
        }]
    }
}

7. Get The Visit Records of A Specified Face ID

Description

Get the visit records of a specified face ID within a specified time.

Request link

https://192.168.0.1/openapi/peopleFlow/getFaceVisitDetail, 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
start_time	long	UNIX format timestamp in second.	Y	1578969264
end_time	long	UNIX format timestamp in second.	Y	1579055640
faceid	string	Face ID	Y	000001

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 211, 220, 266, 267, 275, 277, 280, see Error Code for further details.
total_times	int	Total visits
came_in_time	long array	List of visit times

Request Example

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

app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K&start_time=1561910400&end_time=1562083200&faceid=000002

Note: This example is to get the visit list of faceid “000002” from July 1, 2019 to July 2, 2019.

Response Example

{
    "code": 0,
    "data": {
    "total_times": 2,
    "came_in_time": [1561910400, 1561996800]
    }
}

Error Codes

The list of all error codes returned by the API call is as follows：

Error Code	Description
0	Normal, operation successful
1	App_id is Illegal
2	Validity check failed
3	Unknown error
4	The device requesting activation is not networked
5	App_id or secret key error
6	URL error
7	Device not activated
8	Device activation failed
9	Device activated, no need to reactivate
10	Device bound, activation failed
11	SN error, activation failed
12	Illegal operation
13	Operation is not supported
100	SSID does not meet specification
101	Illegal password
102	Wifi is not supported
110	Illegal focus range
111	Illegal focus area
112	Auto focus percentage error
113	Illegal parameters of night vision mode
114	The sensitivity of dynamic detection screen is illegal
115	The sensitivity of dynamic sound detection is illegal
116	Illegal date for dynamic detection
117	Illegal start time or end time of dynamic detection
118	Name length out of range
119	Parameter error of indicator switch
120	Illegal rotation parameter
121	Video data does not exist in the specified time period
122	he specified page number does not exist
200	Face group duplicate name
201	Illegal face group name
202	Packet capacity out of range
203	Face group ID does not exist
204	The specified face group does not exist
205	To delete face groups and faces, please delete all faces in the group first
206	The same face ID exists
207	The specified face ID does not exist
208	Beyond the capacity of face grouping
209	Face ID operation not allowed
210	Face photo is unqualified
211	Face service not started
212	Illegal face grouping description
220	SD card does not exist
221	SD card format failed for unknown reason
230	Incorrect parameters for playback time
231	Incorrect parameters for querying recording time
232	RTSP service not started
233	Screenshot unsuccessful
234	The page parameter of the query video is incorrect
235	Video does not exist
240	Illegal face attribute name
241	Duplicate name of face attribute
242	The number of face attributes exceeds the maximum limit
243	The specified face attribute does not exist
260	X coordinate of left end point of mixing line is out of range
261	Y coordinate of left end point of mixing line is out of range
262	X coordinate of right end point of mixing line is out of range
263	Y coordinate of right end point of mixing line is out of range
264	Resolution setting out of range
265	People flow statistics granularity parameter out of range
266	Start time setting exception, UNIX time stamp must be used
267	End time setting exception, UNIX time stamp must be used
268	Query parameter (order) setting exception
269	Query parameter (group name) setting exception
270	Query parameter (gender) setting exception
271	Query parameter (age) setting exception
272	Query parameter (age_range) setting exception
273	Query parameter (page_num) setting exception
274	Query parameter (page_size) setting exception
275	Query parameter (faceid) setting exception
276	X coordinate difference between right end point of mixing line and left end point of mixing line is less than 100
277	The passed in parameter is not a reasonable JSON table format
278	Configuration save failed
279	Configuration read failed
280	No face information found in database
281	Query parameter (user added face attribute) setting exception
282	Query parameter (user added face attribute value) data type setting exception
310	The subscribed message event does not exist

Video Streaming

1.Get Live Streaming
2.Get Playback Streaming
3.Get Record List
4.Get Snapshot
5.Get Video Clip

1.Get Live Streaming

Description

This API is used to get live streaming of the IPC.

Request link

https://192.168.0.1/openapi/media/getLiveStream, 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, 232, see Error Code for further details.
hd_live_url	string	High-Definition live streaming of the IPC using RTSP.
fhd_live_url	string	Full High-Definition live streaming of the IPC using RTSP.

Request Example

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

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

Response Example

{
   “code”:              0,
   “data”: {
      “hd_live_url”: “rtsp://192.168.0.1/ed98eeead4c843f898fef1c203313364/live_hd.sdp”,
      “fhd_live_url”: “rtsp://192.168.0.1/ed98eeead4c843f898fef1c203313364/live_fhd.sdp”
  }
}

2.Get Playback Streaming

Description

This API is used to get playback streaming of the IPC.

Request link

https://192.168.0.1/openapi/media/getPlaybackStream, 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
start_time	long	Start time of the playback streaming, seconds in UNIX format.	Y	1578969264
end_time	long	End time of the playback streaming, seconds in UNIX format.	Y	1579055640

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, 230, 235, see Error Code for further details.
playback_url	string	Playback streaming of the IPC using RTSP.

Request Example

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

app_id=mdk923idkf&random=289192×tamp=1564565937&sign=IDKNFLK392038KDS932K&start_time=1564565637&end_time=1564565697

Response Example

{
   “code”:              0,
   “data”: {
       “playback_url”: “rtsp://192.168.0.1/ed98eeead4c843f898fef1c203313364/pb.sdp”
    }
}

3.Get Record List

Description

This API is used to get record list of the IPC.

Request link

https://192.168.0.1/openapi/media/getRecordList, 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
start_time	long	Start time of record files, seconds in UNIX format.	Y	1578969264
end_time	long	End time of record files, seconds in UNIX format.	Y	1579055640
page_num	int	Current page, default is 1, minimum is 1.	N	1
page_size	int	Number of record files in one page, default is 10, range is [0, 500].	N	10

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 3, 5, 7, 231, 234, 235, see Error Code for further details.
total_num	int	Total number of the eligible record files, about one minute per record file.
return_num	int	Returned number this time.
start_time	long	Start time of the record file.
end_time	long	End time of the record file.
url	string	Download address of the record file.

Request Example

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

app_id=mdk923idkf&random=289192×tamp=1564565937&sign=IDKNFLK392038KDS932K&start_time=1564565216&end_time=1564565697&page_num=2&page_size=30

Response Example

{
   “code”:              0,
   “data”: {
    “total_num”: 100,
    “return_num”: 30,
    “record_list”:[{
    “start_time”: 1564565216,
    “end_time”: 1564565276,
    “url”: “https://192.168.0.1/mnt/sd-card/sunmi_video/video_plan/20190731172656_20190731172756.flv?auth_key=1564643800-efc1f64efb0d1d8fab35f0fe8c823a34”}, …]
   }
}

4.Get Snapshot

Description

This API is used to get snapshot of the IPC.

Request link

https://192.168.0.1/openapi/media/getSnapshot, 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, 233, see Error Code for further details.
snapshot_url	string	Download address of the snapshot.

Request Example

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

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

Response Example

{
   “code”:              0,
   “data”: {
      “snapshot_url”:  “https://192.168.0.1/tmp/snapshot/FM0101122334455_20190726162335.jpg?auth_key=1564129415-215f61f3c5f552c5bf8f43ccef5c66a9”
  }
}

5.Get Video Clip

Description

Get a video clip before and after a period of time.

When this api called, the IPC will get a video clip which the period is a multiple of 4 seconds. The spanning of the video clip depends on the parameters passed in. The return parameter of the api is the download link of the video clip.

The download link of the video clip will take effect in 4 to 12 seconds. The Effective time is related to parameters passed in.

Request link

https://192.168.0.1/openapi/media/getCurVideos

Request Parameters

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

Parameter	Type	Description	Required	Example
preceding	int	Time period before current. 0, 4, and 8 allowed only.	Y	0
following	int	Time period after current. 0, 4, and 8 allowed only.	Y	8

Response Parameters

Parameter	Type	Description
code	int	Return code, represent the request result, possible return codes are 0, 1, 2, 3, 5, 7, 236, 237, see Error Code for further details.
url	string	Download link of the video clip, which will take effect after 4 to 12 seconds.

Request Example

POST /openapi/media/getCurVideos HTTP/1.1
Host: 10.10.61.206
Content-Type: application/json
Content-Length: 111
Connection: Keep-Alive
Accept-Encoding: gzip, deflate
Accept-Language: zh-CN,en,*
User-Agent: Mozilla/5.0
app_id=123&timestamp=1585743081&random=7783515117&following=0&preceding=0&sign=F4A04BDBE60D9C656A23CD945F703DA2

Response Example

{
“data”:
{
“url”:”https://10.10.63.19/mnt/sd-card/video_slicer/1585741874923_0_0.flv?auth_key=1585741878-c41f9a8751fe0c259b3d00b3842aa668″
},
“code”:0
}