1. 功能配置

功能配置

1.1. 一脸通配置保存

基础信息

路径: /v1/api/sys/config/saveAFaceConfig

请求方法: POST

请求参数

Headers:

Body:

Body示例:

{
    "healthKitSwitch": 1,
    "healthVaccineCheckSwitch": 1,
    "maskAlertSwitch": 1,
    "natCheckSwitch": 1,
    "temperatureSwitch": 0,
    "ttsGlobalSwitch": 1,
    "attendanceRecordCallbackUrl": "www.baidu.com",
    "identifyRecordCallbackUrl": "www.baidu.com"
}

返回数据

Headers:

Body:

响应示例:

{
    "code": 0,
    "data": {
        "attendanceRecordCallbackUrl": "www.baidu.com",
        "healthKitSwitch": 1,
        "healthVaccineCheckSwitch": 1,
        "identifyRecordCallbackUrl": "www.baidu.com",
        "maskAlertSwitch": 1,
        "natCheckSwitch": 1,
        "temperatureSwitch": 0,
        "ttsGlobalSwitch": 1
    },
    "msg": "成功"
}

1.2. 获取一脸通配置

基础信息

路径: /v1/api/sys/config/queryAFaceConfig

请求方法: POST

请求参数

Headers:

Body示例:

{}

返回数据

Headers:

Body:

响应示例:

{
  "code": 0,
  "msg": "",
  "data": {
    "attendanceRecordCallbackUrl": "",
    "identifyRecordCallbackUrl": "",
    "temperatureSwitch": 0,
    "maskAlertSwitch": 0,
    "healthKitSwitch": 0,
    "natCheckSwitch": 0,
    "healthVaccineCheckSwitch": 0,
    "ttsGlobalSwitch": 0
  }
}

1.3. 重置一脸通配置

基础信息

路径: /v1/api/sys/config/resetAFaceConfig

请求方法: POST

请求参数

Headers:

Body示例:

{}

返回数据

Headers:

Body:

响应示例:

{
    "code": 0,
    "data": {
        "attendanceRecordCallbackUrl": "",
        "healthKitSwitch": 0,
        "healthVaccineCheckSwitch": 0,
        "identifyRecordCallbackUrl": "",
        "maskAlertSwitch": 0,
        "natCheckSwitch": 0,
        "temperatureSwitch": 0,
        "ttsGlobalSwitch": 0
    },
    "msg": "成功"
}

1.4. 获取二维码配置

基础信息

路径: /v1/api/sys/queryQrcodeExpireTimeConfigInfo

请求方法: POST

请求参数

Headers:

Body示例:

{}

返回数据

Headers:

Body:

响应示例:

{
    "code": 0,
    "data": {
        "staffQrCodeExpireTime": 10,
        "visitorQrCodeExpireTime": 10
    },
    "msg": "成功"
}

1.5. 保存二维码配置

基础信息

路径: /v1/api/sys/saveQrcodeExpireTimeConfigInfo

请求方法: POST

请求参数

Headers:

Body:

Body示例:

{
    "staffQrCodeExpireTime": 11,
    "visitorQrCodeExpireTime": 10
}

返回数据

Headers:

Body:

响应示例:

{
    "code": 0,
    "msg": "成功"
}

1.6. 查看入库标准

基础信息

路径: /v1/api/sys/storageCriteria/info

请求方法: POST

请求参数

Headers:

Body示例:

{}

返回数据

Headers:

Body:

响应示例:

{
    "code": 0,
    "data": {
        "customConfig": {
            "blur": 0.0,
            "brightnessMax": 1.0,
            "brightnessMin": 1.0,
            "pitch": 0.0,
            "roll": 1.0,
            "sdtDeviation": 0.0,
            "size": 1.0,
            "yaw": 0.0
        },
        "level": 1
    },
    "msg": "成功"
}

1.7. 保存入库标准

基础信息

路径: /v1/api/sys/storageCriteria/save

请求方法: POST

请求参数

Headers:

Body:

Body示例:

{
  "level": 1
}

返回数据

Headers:

Body:

响应示例:

{
  "code": 0,
  "msg": "",
  "data": {
    "level": 1
  }
}

1.8. 重置入库标准

基础信息

路径: /v1/api/sys/storageCriteria/setDefault

请求方法: POST

请求参数

Headers:

Body示例:

{}

返回数据

Headers:

Body:

响应示例:

{
    "code": 0,
    "data": {
        "level": 1
    },
    "msg": "成功"
}

1.9. 测温、口罩、健康码开关查询

基础信息

路径: /v1/api/sys/config/temperatureConfig

请求方法: POST

请求参数

Headers:

Body示例:

{}

返回数据

Headers:

Body:

响应示例:

{
    "code": 0,
    "data": {
        "healthKitSwitch": 0,
        "healthVaccineCheckSwitch": 0,
        "maskAlertSwitch": 0,
        "natCheckSwitch": 0,
        "temperatureSwitch": 0
    },
    "msg": "成功"
}

1.10. 设置聚类参数

基础信息

路径: /v1/api/sys/config/prismsFaceClusterConfig

请求方法: POST

请求参数

Headers:

Body:

Body示例:

{
    "custom_tag": 1,
    "fuzziness_threshold": 0.6,
    "horizontal_angle_threshold": 35,
    "rotation_angle_threshold": 45,
    "vertical_angle_threshold": 45
}

返回数据

Headers:

Body:

响应示例:

{
    "code": 0,
    "msg": "成功"
}

1.11. 获取聚类参数

基础信息

路径: /v1/api/sys/config/prismsFaceClusterConfigInfo

请求方法: POST

请求参数

Headers:

Body示例:

{}

返回数据

Headers:

Body:

响应示例:

{
    "code": 0,
    "data": {
        "custom_tag": 1,
        "fuzziness_threshold": 0.6,
        "horizontal_angle_threshold": 35,
        "rotation_angle_threshold": 45,
        "vertical_angle_threshold": 45
    },
    "msg": "成功"
}

1.12. 获取访客配置项详情接口

基础信息

路径: /v1/api/sys/visitor/item

请求方法: POST

请求参数

Headers:

Body示例:

{}

返回数据

Headers:

Body:

响应示例:

{
    "code": 0,
    "data": {
        "defaultFileds": [
            {
                "key": "name",
                "name": "姓名",
                "required": true
            },
            {
                "key": "sex",
                "name": "性别",
                "required": false
            },
            {
                "key": "phone",
                "name": "手机",
                "required": true
            },
            {
                "key": "identifyNum",
                "name": "身份证号",
                "required": false
            },
            {
                "key": "email",
                "name": "邮箱",
                "required": false
            },
            {
                "key": "visitFirm",
                "name": "公司",
                "required": false
            },
            {
                "key": "visitTime",
                "name": "来访时间",
                "required": true
            },
            {
                "key": "visitType",
                "name": "访客类型",
                "required": false
            },
            {
                "key": "groupList",
                "name": "访客组",
                "required": true
            },
            {
                "key": "visitReason",
                "name": "来访事由",
                "required": true
            },
            {
                "key": "visited",
                "name": "被访人",
                "required": false
            },
            {
                "key": "imageUri",
                "name": "底库照片",
                "required": false
            },
            {
                "key": "profilePhotoUri",
                "name": "头像",
                "required": false
            }
        ],
        "visitCauses": []
    },
    "msg": "成功"
}

1.13. 获取阿里云短信模板

基础信息

路径: /v1/api/sys/sms/template

请求方法: POST

请求参数

Headers:

Body:

Body示例:

{
    "templateCode": "SMS_243951139"
}

返回数据

Headers:

Body:

响应示例:

{
    "code": 0,
    "data": {
        "templateCode": "SMS_243951139",
        "templateContent": "尊敬的${visitor_name}先生/女士，您预约于${visit_start_time}-${visit_end_time}到访，接待人：${visited_name}，访客二维码获取地址：https://hongtu.megvii-demo.com/${visit_qr_address}，如需修改个人信息请点击：https://hongtu.megvii-demo.com/${visit_msg_address}。期待您的光临！",
        "templateName": "鸿图-邀约-通知访客",
        "templateStatus": 1,
        "templateType": 1
    },
    "msg": "成功"
}