1. 功能配置

功能配置


1.1. 一脸通配置保存

基础信息

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

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json  

Body:

名称 类型 必须 默认值 备注
attendanceRecordCallbackUrl string 「已废弃,请使用业务数据订阅」
考勤管理-考勤记录回调地址
identifyRecordCallbackUrl string 「已废弃,请使用业务数据订阅」
门禁参数-识别记录回调地址
temperatureSwitch integer 门禁参数-测温开关-v1.0.1新增,0:关闭,1:打开
maskAlertSwitch integer 口罩提示开关,0:关闭,1:打开
healthKitSwitch integer 0 健康码检测开关,0:关闭,1:打开(兼容V1.0.2以上版本,默认为关闭)
natCheckSwitch integer 核酸检测开关,0:关闭,1:打开
healthVaccineCheckSwitch integer 疫苗接种开关,0:关闭,1:打开
ttsGlobalSwitch integer 0 TTS语音全局开关,0:关闭,1:打开

Body示例:

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

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─attendanceRecordCallbackUrl string 「已废弃,请使用业务数据订阅」
考勤管理-考勤记录回调地址
  |─identifyRecordCallbackUrl string 「已废弃,请使用业务数据订阅」
门禁参数-识别记录回调地址
  |─temperatureSwitch integer 门禁参数-测温开关-v1.0.1新增,0:关闭,1:打开
  |─maskAlertSwitch integer 口罩提示开关,0:关闭,1:打开
  |─healthKitSwitch integer 健康码检测开关,0:关闭,1:打开
  |─natCheckSwitch integer 核酸检测开关,0:关闭,1:打开
  |─healthVaccineCheckSwitch integer 疫苗接种开关,0:关闭,1:打开
  |─ttsGlobalSwitch integer TTS语音全局开关,0:关闭,1:打开

响应示例:

{
    "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:

名称 必须 备注
Content-Type application/json  

Body示例:

{}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─attendanceRecordCallbackUrl string 「已废弃,请使用业务数据订阅」
考勤管理-考勤记录回调地址
  |─identifyRecordCallbackUrl string 「已废弃,请使用业务数据订阅」
门禁参数-识别记录回调地址
  |─temperatureSwitch integer 门禁参数-测温开关-v1.0.1新增,0:关闭,1:打开
  |─maskAlertSwitch integer 口罩提示开关,0:关闭,1:打开
  |─healthKitSwitch integer 健康码检测开关,0:关闭,1:打开
  |─natCheckSwitch integer 核酸检测开关,0:关闭,1:打开
  |─healthVaccineCheckSwitch integer 疫苗接种开关,0:关闭,1:打开
  |─ttsGlobalSwitch integer TTS语音全局开关,0:关闭,1:打开

响应示例:

{
  "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:

名称 必须 备注
Content-Type application/json  

Body示例:

{}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─attendanceRecordCallbackUrl string 「已废弃,请使用业务数据订阅」
考勤管理-考勤记录回调地址
  |─identifyRecordCallbackUrl string 「已废弃,请使用业务数据订阅」
门禁参数-识别记录回调地址
  |─temperatureSwitch integer 门禁参数-测温开关-v1.0.1新增,0:关闭,1:打开
  |─maskAlertSwitch integer 口罩提示开关,0:关闭,1:打开
  |─healthKitSwitch integer 健康码检测开关,0:关闭,1:打开
  |─natCheckSwitch integer 核酸检测开关,0:关闭,1:打开
  |─healthVaccineCheckSwitch integer 疫苗接种开关,0:关闭,1:打开
  |─ttsGlobalSwitch integer TTS语音全局开关,0:关闭,1:打开

响应示例:

{
    "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:

名称 必须 备注
Content-Type application/json  

Body示例:

{}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─visitorQrCodeExpireTime integer 10 访客二维码失效时间,单位分钟,默认10
  |─staffQrCodeExpireTime integer 10 员工二维码失效时间,单位分钟,默认10

响应示例:

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

1.5. 保存二维码配置

基础信息

路径: /v1/api/sys/saveQrcodeExpireTimeConfigInfo

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json  

Body:

名称 类型 必须 默认值 备注
visitorQrCodeExpireTime integer 10 访客二维码失效时间,单位分钟,默认10,范围是5-1440之间的整数
staffQrCodeExpireTime integer 10 员工二维码失效时间,单位分钟,默认10,范围是5-1440之间的整数

Body示例:

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

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值

响应示例:

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

1.6. 查看入库标准

基础信息

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

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json  

Body示例:

{}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─level integer 等级(1:低,3:高)
入库参数标准 1.低 2.自定义 3.高)
  |─customConfig object 自定义配置,自定义时必有
    |─blur number 模糊度(自定义时必有),模糊度为0-1之间的数
    |─pitch number 垂直角度(自定义时必有),垂直角度为1-100之间的数
    |─roll number 旋转角度(自定义时必有),旋转角度为1-100之间的数
    |─yaw number 水平角度(自定义时必有),水平角度为1-100之间的数
    |─brightnessMin number 最小平均亮度(自定义时必有),最小平均亮度为1-1000之间的整数
    |─size number 最小人脸(自定义时必有),最小人脸为1-500之间的整数
    |─stdDeviation number 亮度标准差(自定义时必有),亮度标准差为1-1000之间的整数
    |─brightnessMax number 最大平均亮度(自定义时必有),最大平均亮度为1-1000之间的整数

响应示例:

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

1.7. 保存入库标准

基础信息

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

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json  

Body:

名称 类型 必须 默认值 备注
customConfig object 自定义配置
  |─blur number 0.0 模糊度,范围0-1
  |─pitch number 0.0 垂直角度,范围0-180
  |─roll number 0.0 旋转角度,范围0-180
  |─yaw number 0.0 水平角度,范围0-180
  |─brightnessMin number 0.0 最小平均亮度,范围0-255
  |─size number 0.0 最小人脸,范围0-500
  |─stdDeviation number 0.0 亮度标准差,范围0-255
  |─brightnessMax number 0.0 最大平均亮度,范围0-255
level integer 入库参数标准 1.低 2.自定义 3.高

Body示例:

{
  "level": 1
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─level integer 等级(1:低,3:高)
入库参数标准 1.低 2.自定义 3.高)
  |─customConfig object 自定义配置,自定义时必有
    |─blur number 模糊度(自定义时必有),模糊度为0-1之间的数
    |─pitch number 垂直角度(自定义时必有),垂直角度为1-100之间的数
    |─roll number 旋转角度(自定义时必有),旋转角度为1-100之间的数
    |─yaw number 水平角度(自定义时必有),水平角度为1-100之间的数
    |─brightnessMin number 最小平均亮度(自定义时必有),最小平均亮度为1-1000之间的整数
    |─size number 最小人脸(自定义时必有),最小人脸为1-500之间的整数
    |─stdDeviation number 亮度标准差(自定义时必有),亮度标准差为1-1000之间的整数
    |─brightnessMax number 最大平均亮度(自定义时必有),最大平均亮度为1-1000之间的整数

响应示例:

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

1.8. 重置入库标准

基础信息

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

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json  

Body示例:

{}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─level integer 等级(1:低,3:高)
等级:3-高

响应示例:

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

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

基础信息

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

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json  

Body示例:

{}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─temperatureSwitch integer 测温模式开关,0:关闭,1:打开
  |─maskAlertSwitch integer 口罩提示开关,0:关闭,1:打开
  |─healthKitSwitch integer 健康码检测开关,0:关闭,1:打开
  |─natCheckSwitch integer 0 核酸检测开关,0:关闭,1:打开,默认值:0
  |─healthVaccineCheckSwitch integer 0 疫苗接种开关,0:关闭,1:打开,默认值:0

响应示例:

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

1.10. 设置聚类参数

基础信息

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

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json  

Body:

名称 类型 必须 默认值 备注
fuzziness_threshold number 模糊度过滤阈值
模糊度过滤阈值,范围是0-1的数
horizontal_angle_threshold integer 人脸水平角度过滤阈值
人脸水平角度过滤阈值,范围是0-90的数
rotation_angle_threshold integer 人脸旋转角度过滤阈值
人脸旋转角度过滤阈值,范围是0-90的数
custom_tag integer 设置标志 0-默认/1-自定义
设置标志 0-默认/1-自定义
vertical_angle_threshold integer 人脸垂直角度过滤阈值
人脸垂直角度过滤阈值,范围是0-90的数

Body示例:

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

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值

响应示例:

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

1.11. 获取聚类参数

基础信息

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

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json  

Body示例:

{}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─fuzziness_threshold number 模糊度过滤阈值
模糊度过滤阈值,范围是0-1的数
  |─horizontal_angle_threshold integer 人脸水平角度过滤阈值
人脸水平角度过滤阈值,范围是0-90的数
  |─rotation_angle_threshold integer 人脸旋转角度过滤阈值
人脸旋转角度过滤阈值,范围是0-90的数
  |─custom_tag integer 设置标志 0-默认/1-自定义
设置标志 0-默认/1-自定义
  |─vertical_angle_threshold integer 人脸垂直角度过滤阈值
人脸垂直角度过滤阈值,范围是0-90的数

响应示例:

{
    "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:

名称 必须 备注
Content-Type application/json  

Body示例:

{}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─defaultFileds array 访客字段信息
    |─ object
      |─key string 字段Key
      |─name string 字段名称
      |─required boolean 字段是否必填
  |─visitCauses array 来访事由
    |─ object
      |─key string 来访事由key
      |─value string 来访事由value

响应示例:

{
    "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:

名称 必须 备注
Content-Type application/json  

Body:

名称 类型 必须 默认值 备注
templateCode string 短信模板Code

Body示例:

{
    "templateCode": "SMS_243951139"
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─templateContent string 短信模板详情
  |─templateCode string 短信模板code
  |─templateStatus integer 模板审核状态0:审核中 1:审核通过 2:审核失败
  |─templateName string 模板名称
  |─templateType integer 短信类型 0:验证码。1:短信通知。2:推广短信。3:国际/港澳台消息。

响应示例:

{
    "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": "成功"
}

1.14. 考勤调整类型查询或重置(删除添加的调整类型,暂无用)

基础信息

路径: /v1/api/sys/operationAdjustType

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json  

Body:

名称 类型 必须 默认值 备注
operation integer 操作类型、1、查询 2、重置

Body示例:

{
  "operation": 1
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data array 具体的返回值
  |─ object
    |─uuid string 调整UUID
UUID
    |─name string 请假名称
调整名称
    |─parentUuid string 父类型,0:表示顶级类型
父级UUID
    |─isDefault integer 是否默认 0-默认 1-非默认
是否默认 0-默认 1-非默认
    |─isUpdate integer 是否可被修改名字,0:表示不可修改;1:可修改
否可被修改名字,0:表示不可修改;1:可修改

响应示例:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "uuid": "",
      "name": "",
      "parentUuid": "",
      "isDefault": 0,
      "isUpdate": 0
    }
  ]
}

1.15. 考勤调整类型编辑名称

基础信息

路径: /v1/api/sys/editAdjustType

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json  

Body:

名称 类型 必须 默认值 备注
uuid string 考勤调整类型uuid
name string 考勤调整类型名称

Body示例:

{
  "uuid": "111",
  "name": "撸猫假"
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值

响应示例:

{
  "code": 0,
  "msg": "",
  "data": null
}

1.16. 考勤调整类型指定类型查询

基础信息

路径: /v1/api/sys/queryAdjustType

请求方法: POST

请求参数

Headers:

名称 必须 备注
Content-Type application/json  

Body:

名称 类型 必须 默认值 备注
parentUuid string 0 考勤调整父类型uuid
dd56adffff404c069ca500fcf1b2f483 :请假类型
dd56adffff404c069ca500fcf1b2f481 :补签类型
dd56adffff404c069ca500fcf1b2f486 :调班类型
dd56adffff404c069ca500fcf1b2f482 :调休类型
dd56adffff404c069ca500fcf1b2f484 :加班类型
dd56adffff404c069ca500fcf1b2f485 :出差类型
dd56adffff404c069ca500fcf1111481 :补签类型-补签到
dd56adffff404c069ca500fcf1112481 :补签类型-补签退
dd56adffff404c069ca500fcf1b21483 :请假类型-年假
dd56adffff404c069ca500fcf1b22483 :请假类型-病假
dd56adffff404c069ca500fcf1b23483 :请假类型-事假
dd56adffff404c069ca500fcf1b24483 :请假类型-产假
dd56adffff404c069ca500fcf1b25483 :请假类型-陪产假
dd56adffff404c069ca500fcf1b26483 :请假类型-婚假
dd56adffff404c069ca500fcf1b27483 :请假类型-丧假
dd56adffff404c069ca500fcf1b28483 :请假类型-请假类型1
dd56adffff404c069ca500fcf1b29483 :请假类型-请假类型2
dd56adffff404c069ca500fcf1b30483 :请假类型-请假类型3
dd56adffff404c069ca500fcf1b31483 :请假类型-请假类型4
dd56adffff404c069ca500fcf1b32483 :请假类型-请假类型5
dd56adffff404c069ca500fcf1b33483 :请假类型-请假类型6
dd56adffff404c069ca500fcf1b34483 :请假类型-请假类型7
dd56adffff404c069ca500fcf1b35483 :请假类型-请假类型8
dd56adffff404c069ca500fcf1b11486 :调班类型-个人调班
dd56adffff404c069ca500fcf1b12486 :调班类型-两人换班

Body示例:

{
  "parentUuid": ""
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8  

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data array 具体的返回值
  |─ object
    |─uuid string 调整UUID
UUID
    |─name string 请假名称
调整名称
    |─parentUuid string 父类型,0:表示顶级类型
父级UUID
    |─isDefault integer 是否默认 0-默认 1-非默认
是否默认 0-默认 1-非默认
    |─isUpdate integer 是否可被修改名字,0:表示不可修改;1:可修改
否可被修改名字,0:表示不可修改;1:可修改

响应示例:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "uuid": "",
      "name": "",
      "parentUuid": "",
      "isDefault": 0,
      "isUpdate": 0
    }
  ]
}

results matching ""

    No results matching ""