Description: Verify administrator username and password.

Request Example

{
    "cmd": "login",
    "username": "admin",
    "password": "device password"
}

Response Example (Success)

{
    "ret": "login",
    "sn": "device serial number",
    "result": true
}

Description: Device registers with the server, reporting device information and status.

Request Example

{
    "cmd": "reg",
    "password": "device password"
}

Response Example

{
    "ret": "reg",
    "sn": "device serial number",
    "devinfo": {
        "modelname": "AiFace",
        "manufacturer": "manufacturer name",
        "fpalgo": "thbio3.0",
        "firmware": "firmware version",
        "time": "2025-05-17 10:30:00",
        "curip": "192.168.1.100",
        "timezone": "GMT+8",
        "usersize": 3000,
        "facesize": 3000,
        "logsize": 100000,
        "useduser": 100,
        "usedface": 80,
        "usedlog": 5000
        // ... other status fields
    }
}

Description: Get the current language used by the device.

Request Example

{
    "cmd": "getlang",
    "password": "device password"
}

Response Example

{
    "ret": "getlang",
    "sn": "device serial number",
    "result": true,
    "lang": "en-US"
}

Description: Get all language options supported by the device.

Request Example

{
    "cmd": "getlangoption",
    "password": "device password"
}

Response Example

{
    "ret": "getlangoption",
    "sn": "device serial number",
    "result": true,
    "langs": [
        {"lvalue": 0, "ltitle": "English"},
        {"lvalue": 1, "ltitle": "Simplified Chinese"}
    ]
}

Description: Get basic information of all users by pagination. stn: true means start reading from beginning.

Request Example

{
    "cmd": "getuserlist",
    "password": "device password",
    "stn": true
}

Response Example

{
    "ret": "getuserlist",
    "sn": "device serial number",
    "result": true,
    "count": 100,
    "record": [
        {
            "id": "1",
            "name": "John Doe",
            "admin": 0,
            "face": 1,
            "card": 12345678
        }
    ]
}

Description: Get the list of all user IDs (without detailed information).

Request Example

{
    "cmd": "getuserids",
    "password": "device password"
}

Response Example

{
    "ret": "getuserids",
    "sn": "device serial number",
    "result": true,
    "count": 100,
    "record": ["1", "2", "3", "100"]
}

Description: Get an available empty user ID for adding a new user.

Request Example

{
    "cmd": "getunuserdid",
    "password": "device password"
}

Response Example

{
    "ret": "getunuserdid",
    "sn": "device serial number",
    "result": true,
    "enrollid": "101"
}

Description: Check whether the specified user ID already exists.

Request Example

{
    "cmd": "checkuserid",
    "password": "device password",
    "enrollid": "1"
}

Response Example

{
    "ret": "checkuserid",
    "sn": "device serial number",
    "result": true,
    "exists": true
}

Description: Get complete information of a specified user. Use backupnum to specify data type (0: FP, 50: Face Photo, 51: Face Feature).

Request Example

{
    "cmd": "getuserinfo",
    "password": "device password",
    "enrollid": "1"
}

Response Example

{
    "ret": "getuserinfo",
    "sn": "device serial number",
    "result": true,
    "enrollid": "1",
    "name": "John Doe",
    "card": 12345678,
    "faceflag": 1
}

Description: Add or update user information (fingerprint, card, password, face, etc.).

Request Example (Set Basic Info)

{
    "cmd": "setuserinfo",
    "password": "device password",
    "enrollid": "1",
    "name": "John Doe",
    "card": 12345678
}

Response Example

{
    "ret": "setuserinfo",
    "sn": "device serial number",
    "result": true,
    "enrollid": "1"
}

Description: Delete a user or specific templates. backupnum: 13 deletes the entire user.

Request Example

{
    "cmd": "deleteuser",
    "password": "device password",
    "enrollid": "1",
    "backupnum": 13
}

Response Example

{
    "ret": "deleteuser",
    "sn": "device serial number",
    "result": true,
    "enrollid": "1"
}

Description: Delete the face data of a specified user.

Request Example

{
    "cmd": "deleteuserface",
    "password": "device password",
    "enrollid": "1"
}

Description: Delete all fingerprint data of a specified user.

Request Example

{
    "cmd": "deleteuserfp",
    "password": "device password",
    "enrollid": "1"
}

Description: Delete all palmprint data of a specified user.

Request Example

{
    "cmd": "deleteuserpalm",
    "password": "device password",
    "enrollid": "1"
}

Description: Delete multiple users in batch.

Request Example

{
    "cmd": "deleteusers",
    "password": "device password",
    "list": ["1", "2", "3"]
}

Description: Delete all user data.

Request Example

{
    "cmd": "cleanuser",
    "password": "device password"
}

Description: Get attendance/access records by pagination.

Request Example

{
    "cmd": "getlog",
    "password": "device password",
    "index": 0,
    "from": "2025-05-01",
    "to": "2025-05-31"
}

Response Example

{
    "ret": "getlog",
    "sn": "device serial number",
    "result": true,
    "record": [
        {
            "enrollid": "1",
            "name": "John Doe",
            "time": "2025-05-17 08:30:00",
            "event": 1
        }
    ]
}

Description: Get real-time records (automatically deleted after retrieval).

Request Example

{
    "cmd": "getrtlog",
    "password": "device password"
}

Description: Manually add attendance records.

Request Example

{
    "cmd": "setlogs",
    "password": "device password",
    "records": [
        { "id": "1", "event": 1, "time": "2025-05-17 08:30:00" }
    ]
}

Description: Delete all attendance records.

Description: Clear all users and records, restore some settings.

Description: Get the current time of the device.

Response Example

{
    "ret": "gettime",
    "sn": "device serial number",
    "time": "2025-05-17 10:30:00"
}

Description: Set the device time.

Request Example

{
    "cmd": "settime",
    "password": "device password",
    "cloudtime": "2025-05-17 12:00:00"
}

Description: Clear administrator privileges for all users.

Description: Delete inactive users.

Description: Delete all photos saved in logs.

Description: Restore menu-related settings to default values.

Description: Clear the database and trigger a reboot.

Description: Set various configuration parameters (Volume, Language, IP, etc.).

Request Example

{
    "cmd": "setdevinfo",
    "password": "device password",
    "VOLUME": 6,
    "LANGUAGE": 0,
    "NETIPADDRESS": "192.168.1.100"
}

Description: Get all configuration parameters of the device.

Description: Get the capacity and usage of each device module (Users, Faces, Logs).

Description: Control the access control to open the door.

Request Example

{
    "cmd": "opendoor",
    "password": "device password",
    "enrollid": "1",
    "msg": "Door opened"
}

Description: Control the door lock status (1=Normally open, 2=Normally closed, 3=Restore normal).

Description: Enable or disable a user (enflag: 1=Enable, 0=Disable).

Description: Set device access control related parameters like open delay, sensors, timezones.

Description: Get the device access control configuration parameters.

Description: Get the access parameters of a specified user.

Description: Batch set access parameters for users (verifymode, weekzone, etc.).

Description: Delete the access parameters of a specified user.

Description: Clear access parameters for all users.

Description: Get the current door status (0=Closed, 1=Open).

Description: Set, delete single, or clear all screensaver images of the device.

Description: Get the shift schedule configuration of the device.

Description: Set the shift schedule configuration of the device.

Description: Get the bell time configuration of the device.

Description: Set the bell time configuration of the device.

Description: Get the attendance report data for a user within a date range.

Request Example

{
    "cmd": "getreport",
    "password": "device password",
    "enrollid": "1",
    "from": "2025-05-01",
    "to": "2025-05-31"
}

Description: Reboot the device. Note: The device reboots immediately, no response will be sent.

Description: Temporarily disable device functions such as face recognition.

Description: Restore normal functions of the device.

Description: Trigger the device's active enrollment mode for fingerprint or face.

Request Example

{
    "cmd": "adduser",
    "password": "device password",
    "enrollid": "1",
    "backupnum": 50
}

Description: Query the progress and result of active enrollment triggered by adduser.

Description: Configure the questionnaire function (e.g., temperature check questions).

Description: Get the questionnaire configuration.

Description: Clear the questionnaire configuration.

Description: Set the company name displayed on the device.

Description: Get the company name displayed on the device.

Description: Set holiday configuration with specific date ranges.

Description: Get the holiday configuration.

Description: Upload firmware upgrade package in blocks.

Request Example

{
    "cmd": "upgrade",
    "password": "device password",
    "filename": "firmware.pkg",
    "md5": "...",
    "index": 0,
    "record": "base64 encoded data"
}

Description: Upload or play custom voice files (WAV format).

Description: Control the display of the on-screen keypad.

Description: Remotely send face/fingerprint data to the device for comparison.

Request Example

{
    "cmd": "verify",
    "password": "device password",
    "enrollid": "1",
    "face": "base64 encoded image"
}

Description: Elevator control: Grant access to all floors.

Description: Elevator control: Revoke access to all floors.

Description: Elevator control: Grant access to specified floors (e.g., "3,5,7").

Description: Elevator control: Revoke access to specified floors.

Description: Get the list of files in a directory on the device.

Description: Get the content of a file on the device (Base64 encoded).

Description: Write a file to the device storage.

Description: Trigger the generation of an attendance report file on the device.

Description: Query the progress of report generation triggered by generatereport.