1 方案介绍

门禁一体机标准协议支持人脸识别、二维码、刷卡、蓝牙、可视对讲、梯控功能接入物业管理一体机。

2 通用

门禁机对接边缘服务器，访问10000端口。

边缘服务器访问门禁机的端口由设备厂商自定义，定义后固定不变。

所有HTTP 报文的首部信息中，不能带有Connection: Keep-Alive字段，可以设置为Connection:Close。

物业管理一体机，以下简称“边缘服务器”。

下面接口是必须实现的通用接口。

2.1 建立连接

调用此接口建立门禁机与边缘服务器的双向通信连接，门禁设备跟边缘服务器互为客户端和服务端。

URL：http://[边缘服务器IP 或 门禁机IP]:[端口]/connect
Method：POST
Content-Type：application/json

说明

连接建立流程：

请求参数

返回参数

示例

请求示例

{
    "sn": "123456789",
    "time": 1589472000,
    "ip": "192.168.1.128",
    "mac": "00-16-EA-AE-3D-40",
    "keepalive": 30,
    "signMethod": "md5",
    "sign": "4db51117ad87cef349f45a3b14c05142"
}

正常返回示例

{
    "code": 0,
    "message": "success",
    "data":{
        "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128"
    }
}

错误码

附录查看更多错误码

2.2 心跳保活

门禁机与边缘服务器之间定期发送心跳消息，以确保消息通道的连通性，维持对方的在线状态。

URL：http://[边缘服务器IP 或 门禁机IP]:[端口]/keepalive
Method：POST
Content-Type：application/json

说明

建立连接后，服务器会向客户端颁发一个token，心跳消息中需要携带此token。当发送心跳时，对方返回token无效，那么需要重新建立连接，获取有效token。

请求参数

返回参数

示例

请求示例

{
    "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128"
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

错误码

附录查看更多错误码

2.3 远程开门

边缘服务器发送开门指令给门禁机。

URL：http://[门禁机IP]:[端口]/remoteOpen
Method：POST
Content-Type：application/json

说明

云端调用IoT设备的远程开门服务，边缘端接收到消息后，发送开门指令给门禁机，设备收到指令后开门放行。

请求参数

返回参数

示例

请求示例

{
    "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128"
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

错误码

附录查看更多错误码

2.4 报警事件

门禁机上报报警事件给边缘服务器。

URL：http://[边缘服务器IP]:[端口]/alarmEvent
Method：POST
Content-Type：application/json

说明

门禁机上报设备报警事件给边缘服务器，边缘服务器发送事件到云端。

请求参数

返回参数

示例

请求示例

{
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "alarmType":2,
    "cardId":"777342461"
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

错误码

附录查看更多错误码

2.5 设置常开状态

边缘服务器设置门禁设备的常开状态。

URL：http://[门禁机IP]:[端口]/setKeepOpen
Method：POST
Content-Type：application/json

说明

目前设置门常开状态的功能只支持具有刷卡功能的门禁设备。

请求参数

返回参数

示例

请求示例

{
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "data":{
        "keeOpen": 1
    }
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

错误码

附录查看更多错误码

2.6 查询常开状态

边缘服务器查询门禁设备的常开状态。

URL：http://[门禁机IP]:[端口]/getKeepOpen
Method：POST
Content-Type：application/json

说明

目前查询门常开状态的功能只支持具有刷卡功能的门禁设备。

请求参数

返回参数

示例

请求示例

{
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128"
}

正常返回示例

{
    "code": 0,
    "message": "success",
    "data":{
        "keepOpen": 0
    }
}

错误码

附录查看更多错误码

2.7 设置测温规则

边缘服务器设置门禁的测温开关和测温的阈值。

URL：http://[门禁机IP]:[端口]/setTempCheckRule
Method：POST
Content-Type：application/json

说明

对门禁机设置用户通行认证的测温规则，包括测温开关，温度上下限。

请求参数

返回参数

示例

请求示例

{
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "data":{
        "isCheck": 1,
        "maxThreshold": "37.5",
        "minThreshold": "36.5"
    }
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

3 人脸

3.1 【边缘端识别】人脸识别

门禁机抓拍通行人员的人脸照片，向边缘服务器发起人脸识别请求。

URL：http://[边缘服务器IP]:[端口]/recognize
Method：POST
Content-Type：multipart/form-data

说明

当有人员通行时，门禁设备向边缘服务器发起人脸识别。边缘认证成功后，返回给门禁设备允许放行，并上报人脸匹配通行事件。如果认证失败，返回失败结果给设备。

如果开启体温检测功能，体温值超过正常范围，则不允许通行。体温的正常范围由后台配置。

图片质量要求：

• 抓拍的图片中需要包含完整人脸像素

• 可根据自身设备能力选择在设备端或者边缘端完成人脸抠图处理（推荐设备端完成）

• 如果设备端进行人脸抠图，要求图片尺寸（宽、高）保证一致

• 图片分辨率不低于120 * 120 像素，大小不超过1MB

请求参数

返回参数

示例

请求示例

token: "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128"
photo: xxx.jpg
disableEdgeDetectFace: "1"
temperature: "36.5"

正常返回示例

{
    "code": 0,
    "message": "success",
    "data":{
        "faceId": "ac4af1c2-31a7-4206-9c8d-2a69cdaac066",
        "name": "王小飞",
        "photoId": "d8a0e59a-ddeb-11ea-a8c7-6c96cfdfd355",
        "userId": "123456"
    }
}

错误码

附录查看更多错误码

3.2 【设备端识别】同步人脸信息

边缘服务器同步人脸特征值信息到门禁机。

URL：http://[门禁机IP]:[端口]/faceAC/syncFaces
Method：POST
Content-Type：application/json

说明

当人脸数据超过50条，会被拆分为多次同步调用。每次同步最大50条，每次同步超时时间为10秒。

请求参数

返回参数

示例

请求示例

{
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "faces":[
        {
            "type":4
        },
        {
            "type":1,
            "faceId":"452f3570-4717-4a39-910b-d72542550001",
            "userInfo":{
                "userName":"张三",
                "expiryTime":"1599892792000",
                "isInBlackList":false
            },
            "userInfoMd5":"25984f381c98bfc842280b528f424701",
            "feature":[0.0069077396765351295, 0.06679696589708328,  ...],
            "featureMd5":"4be6f1e4bda138a555416b866a90530c"
        },
        {
            "type":3,
            "faceId":"452f3570-4717-4a39-910b-d72542550002",
            "feature":[0.0069077396765351295, 0.06679696589708328,  ...],
            "featureMd5":"4be6f1e4bda138a555416b866a90530c"
        },
        {
            "type":3,
            "faceId":"452f3570-4717-4a39-910b-d72542550003",
            "userInfo":{
                "userName":"李四",
                "expiryTime":"1599892792111",
                "isInBlackList":true
            },
            "userInfoMd5":"25984f381c98bfc842280b528f424703"
        },
        {
            "type":3,
            "faceId":"452f3570-4717-4a39-910b-d72542550004",
            "userInfo":{
                "userName":"赵五",
                "expiryTime":"1599892792222",
                "isInBlackList":false
            },
            "userInfoMd5":"25984f381c98bfc842280b528f424704",
            "feature":[0.0069077396765351295, 0.06679696589708328,  ...],
            "featureMd5":"4be6f1e4bda138a555416b866a90530c"
        },
        {
            "type":2,
            "faceId":"452f3570-4717-4a39-910b-d72542550009"
        }
    ]
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

错误码

附录查看更多错误码

3.3 【设备端识别】查询设备上人脸库信息

边缘服务器查询设备上的人脸特征值信息。

URL：http://[门禁机IP]:[端口]/faceAC/queryFaces
Method：POST
Content-Type：application/json

说明

当门禁机首次连接到边缘服务器或重新连接到边缘服务器时，获取设备上的人脸特征值存储情况，用于计算还需要同步到设备端的人脸数据。每次查询超时时间为10秒。

当人脸数量较多时，支持分页查询。边缘服务器先向设备发送全量查询请求，如果设备上的人脸数超过设备可处理的最大值，那么设备返回第1页的人脸数据和分页信息，之后边缘服务器会进行分页查询。

请求参数

返回参数

说明：faceInfo中元素顺序固定。

示例

请求示例

{
    "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "currentPage": 1,
    "pageSize": 200
}

正常返回示例

{
    "code": 0,
    "message": "success",
    "data": {
        "currentPage": 1,
        "pageCount": 93,
        "pageSize": 200,
        "total": 18483,
        "faceInfo": [
            [
                "452f3570-4717-4a39-910b-d72542550001",
                "25984f381c98bfc842280b528f424701",
                "4be6f1e4bda138a555416b866a90530c"
            ],
            [
                "452f3570-4717-4a39-910b-d72542550004",
                "25984f381c98bfc842280b528f424704",
                "4be6f1e4bda138a555416b866a90530c"
            ]
        ]
    }
}

错误码

附录查看更多错误码

3.4 【设备端识别】人脸通行事件

门禁机上报通行人员识别人脸的通行事件给边缘服务器。

URL：http://[边缘服务器IP]:[端口]/faceAC/passEvent
Method：POST
Content-Type：multipart/form-data

说明

门禁机上报通行人员刷脸成功的事件给边缘服务器，边缘服务器发送事件到云端。

请求参数

返回参数

示例

请求示例

token: "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128"
faceId: "ac4af1c2-31a7-4206-9c8d-2a69cdaac066"
photo: xxx.jpg
similarity: "0.78654"
temperature: "36.5"

正常返回示例

{
    "code": 0,
    "message": "success",
    "data":{
        "photoId": "d8a0e59a-ddeb-11ea-a8c7-6c96cfdfd355"
    }
}

错误码

附录查看更多错误码

4 二维码

4.1 二维码识别

门禁机识别通行人员的手机二维码，向边缘服务器发起二维码识别请求。

URL：http://[边缘服务器IP]:[端口]/qrcode
Method：POST
Content-Type：application/json

说明

当有人员通行时，门禁设备向边缘服务器发起二维码识别。边缘认证成功后，返回给门禁设备允许放行，并上报通行事件。如果认证失败，返回失败结果给设备。

请求参数

返回参数

示例

请求示例

{
    "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "qrCode": "ALI1234567890azxswdfghggfgsgERTG"
}

正常返回示例

{
    "code": 0,
    "message": "success",
    "data": {
     "userId": "123456"
    }
}

错误码

附录查看更多错误码

5 门禁卡

5.1 同步卡权限

边缘服务器同步卡权限信息到门禁机。

URL：http://[门禁机IP]:[端口]/cardAC/syncPermissions
Method：POST
Content-Type：application/json

说明

边缘服务器接收云端下发的卡权限信息，调用此接口发送到设备端。每次同步最大200条，同步超时时间为5秒。

请求参数

返回参数

示例

请求示例

{
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "permissions":[
        {
            "type":1,
            "cardId":"777342461",
            "effectiveTime":"1589472000000",
            "expiryTime":"1905004800000"
        },
        {
            "type":2,
            "cardId":"777342461",
            "effectiveTime":"1589472000000",
            "expiryTime":"1905004800000"
        },
        {
            "type":3,
            "cardId":"777342461",
            "effectiveTime":"1589472000000",
            "expiryTime":"1905004800000"
        }
    ]
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

错误码

附录查看更多错误码

5.2 刷卡通行事件

门禁机上报刷卡通行事件给边缘服务器。

URL：http://[边缘服务器IP]:[端口]/cardAC/passEvent
Method：POST
Content-Type：application/json

说明

门禁机上报人员刷卡通行的事件给边缘服务器，边缘服务器发送事件到云端。

请求参数

返回参数

示例

请求示例

{
    "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "cardId": "777342461"
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

错误码

附录查看更多错误码

6 蓝牙

6.1 同步蓝牙权限

边缘服务器同步蓝牙权限信息到门禁机。

URL：http://[门禁机IP]:[端口]/bleAC/syncPermissions
Method：POST
Content-Type：application/json

说明

边缘服务器接收云端下发的蓝牙权限信息，调用此接口发送到设备端。每次同步最大200条，同步超时时间为5秒。

请求参数

返回参数

示例

请求示例

{
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "permissions":[
        {
            "type":1,
            "cardId":"777342461",
            "effectiveTime":"1589472000000",
            "expiryTime":"1905004800000"
        },
        {
            "type":2,
            "cardId":"777342461",
            "effectiveTime":"1589472000000",
            "expiryTime":"1905004800000"
        },
        {
            "type":3,
            "cardId":"777342461",
            "effectiveTime":"1589472000000",
            "expiryTime":"1905004800000"
        }
    ]
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

错误码

附录查看更多错误码

6.2 蓝牙通行事件

门禁机上报蓝牙通行事件给边缘服务器。

URL：http://[边缘服务器IP]:[端口]/bleAC/passEvent
Method：POST
Content-Type：application/json

说明

门禁机上报人员蓝牙通行的事件给边缘服务器，边缘服务器发送事件到云端。

请求参数

返回参数

示例

请求示例

{
    "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "cardId":"777342461"
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

错误码

附录查看更多错误码

7 对讲

7.1 颁发门禁机SIP Number

边缘服务器同步SIP Number给门禁机。

URL：http://[门禁机IP]:[端口]/visualIntercom/syncSipNumber
Method：POST
Content-Type：application/json

说明

当云端下发的SIP账号时，边缘服务器推送SIP Number等信息给到门禁机。

每次门禁机与边缘服务器建立连接后，边缘服务器会再次同步SIP Number给门禁机。

请求参数

返回参数

示例

请求示例

{
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "sipNumber": "MNUtFSr9soldjp34IxYCBz",
    "password": "******",
    "sipServerAddr": "47.103.XX.XXX",
    "sipServerPort": "6050"
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

错误码

附录查看更多错误码

7.2 获取groupID

门禁机向边缘服务器查询房号的SIP组ID。

URL：http://[边缘服务器IP]:[端口]/visualIntercom/getGroupId
Method：POST
Content-Type：application/json

说明

用户输入呼叫的房号时，门禁机向边缘服务器查询房号对应的SIP group ID。

请求参数

返回参数

示例

请求示例

{
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "roomId": "1-9-3-1202"
}

正常返回示例

{
    "code": 0,
    "message": "success",
    "groupId": "4sewsEXT8ezMnlHlbWkjbL"
}

错误码

附录查看更多错误码

7.3 验证手机号

门禁机向边缘服务器查询房号的SIP组ID。

URL：http://[边缘服务器IP]:[端口]/visualIntercom/checkPhoneNumber
Method：POST
Content-Type：application/json

说明

由门禁机通过边缘服务器向云端发送手机号校验请求。边缘服务器返回给门禁机的结果只能表明边缘服务器是否已成功向云端发起校验请求，并不能代表校验结果。校验结果会通过“7.4 手机号校验结果”接口异步下发，因此设备需要自己处理等待校验结果超时的情况。

请求参数

返回参数

示例

请求示例

{
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "phoneNumber": "139****1111"
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

错误码

附录查看更多错误码

7.4 手机号校验结果

云端将手机号校验结果，通过边缘服务器下发给门禁机。

URL：http://[门禁机IP]:[端口]/visualIntercom/verifyPhoneResult
Method：POST
Content-Type：application/json

说明

请求参数

返回参数

示例

请求示例

{
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "phoneNumber": "139****1111",
    "result": 0
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

错误码

附录查看更多错误码

7.5 上报开门事件

门禁机向边缘服务器上报对讲开门事件。

URL：http://[边缘服务器IP]:[端口]/visualIntercom/reportOpenDoor
Method：POST
Content-Type：application/json

说明

请求参数

返回参数

示例

请求示例

{
    "token":"6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
    "type": 0,
    "number": "MNUtFSr9soldjp34IxYCBz",
    "roomId": "1-9-3-1202"
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

8 梯控接口

8.1 上报电梯运行状态

梯控上报电梯的运行状态给边缘服务器。

URL：http://[边缘服务器IP]:[端口]/elevator/reportRunState
Method：POST
Content-Type：application/json

说明

每次建立连接后，上报一次电梯运行状态。当电梯运行状态变化时，立即上报实时的电梯工作状态。

限制

调用该接口的每秒请求数（QPS）最大限制为100。

请求参数

返回参数

示例

请求示例

{
  "version": "2021-12-13",
  "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
  "data": [
    {
      "elevatorId": "01",
      "currentFloor": "9",
      "carState": 1,
      "carDirection": 2
    },
    {
      "elevatorId": "02",
      "currentFloor": "1",
      "carState": 0,
      "carDirection": 0
    }
  ]
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

8.2 查询电梯运行状态

边缘服务器获取电梯当前运行状态。

URL：http://[门禁机IP]:[端口]/elevator/getRunState
Method：POST
Content-Type：application/json

说明

可以查询一个或多个电梯的运行状态，如果未指定电梯ID，需要返回全部电梯的运行状态。

限制

调用该接口的每秒请求数（QPS）最大限制为100。

请求参数

返回参数

示例

请求示例

{
  "version": "2021-12-13",
  "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
  "data": [
    "01",
    "02"
  ]
}

正常返回示例

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "elevatorId": "01",
      "currentFloor": "9",
      "carState": 1,
      "carDirection": 2
    },
    {
      "elevatorId": "02",
      "currentFloor": "1",
      "carState": 0,
      "carDirection": 0
    }
  ]
}

8.3 释放受控楼层

边缘服务器发送释放楼层控制指令，通知电梯开放指定楼层，允许用户选择已被授权的楼层。

URL：http://[门禁机IP]:[端口]/elevator/releaseFloors
Method：POST
Content-Type：application/json

说明

当用户在轿厢内进行权限认证时，例如刷卡，电梯释放其所在楼层权限。多用于用户拥有多楼层权限的情况，由用户手动选择目的楼层。

限制

调用该接口的每秒请求数（QPS）最大限制为100。

请求参数

返回参数

示例

请求示例

{
  "version": "2021-12-13",
  "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
  "elevatorId": "01",
  "floorRoomList": [
    {
      "floor": "9",
      "room": "901"
    },
    {
      "floor": "6",
      "room": "602"
    }
  ]
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

8.4 点亮目标楼层

边缘服务器发送点亮楼层控制指令，电梯自动选中并点亮指定楼层。

URL：http://[门禁机IP]:[端口]/elevator/activateFloor
Method：POST
Content-Type：application/json

说明

当用户在轿厢内进行权限认证时，例如刷卡，电梯自动点亮其所在楼层权限。多用于用户只拥有某一楼层权限的情况。

一次接口调用可点亮多个楼层。

限制

调用该接口的每秒请求数（QPS）最大限制为100。

请求参数

返回参数

示例

请求示例

{
  "version": "2021-12-13",
  "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
  "elevatorId": "01",
  "floorRoomList": [
    {
      "floor": "9",
      "roomNumber": "901"
    },
    {
      "floor": "6",
      "roomNumber": "602"
    }
  ]
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

8.5 呼叫电梯

边缘服务器发送呼叫电梯指令，控制电梯到指定楼层。

URL：http://[门禁机IP]:[端口]/elevator/call
Method：POST
Content-Type：application/json

说明

限制

调用该接口的每秒请求数（QPS）最大限制为100。

请求参数

返回参数

示例

请求示例

{
  "version": "2021-12-13",
  "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
  "elevatorId": "01",
  "startFloor": "1",
  "startRoom": "01",
  "targetFloor": 8,
  "targetRoom": "02"
}

正常返回示例

{
    "code": 0,
    "message": "success"
}

8.6 获取电梯信息

边缘服务器获取梯控的电梯ID和用户楼层房间信息。

URL：http://[门禁机IP]:[端口]/elevator/info/get
Method：POST
Content-Type：application/json

请求参数

返回参数

示例

请求示例

{
  "version": "2021-12-13",
  "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128"
}

正常返回示例

{
  "code": 0,
  "message": "success",
  "data": {
    "elevatorMode": "ALL",
    "floorInfoList": [
      {
        "elevatorId": "01",
        "elevatorName": "dongti",
        "isDualCardDoor": true,
        "floorInfo": [
          {
            "floor": "5",
            "roomList": [
              "501",
              "502"
            ]
          },
          {
            "floor": "6",
            "roomList": [
              "601",
              "602"
            ]
          }
        ]
      }
    ]
  }
}

9 人梯联动

9.1 同步用户电梯规则

边缘服务器同步用户电梯规则信息到梯控。

URL：http://[门禁机IP]:[端口]/elevator/rule/sync
Method：POST
Content-Type：application/json

说明

当数据超过200条，会被拆分为多次同步调用。每次同步最大200条，每次同步超时时间为10秒。

请求参数

说明：

此模式下需要传入参数：

返回参数

示例

请求示例

{
  "version": "2021-12-13",
  "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
  "rules": [
    {
      "ruleId": "fa1a6-31a7-3**098",
      "userId": "ac1c2-31a7-3**066",
      "elevatorId": "01",
      "controlMode": "CALL_WITH_TARGET",
      "startFloor": "01",
      "startRoom": "601",
      "targetFloorRoomList": [
        {
          "floor": "9",
          "roomNumber": "01"
        }
      ],
      "delaySeconds": 10,
      "effectiveTime": "1589472000000",
      "expiryTime": "1905004800000"
    }
  ]
}

正常返回示例

{
    "code":0,
    "message":"success"
}

9.2 获取用户电梯规则

边缘服务器从梯控获取用户电梯规则。

URL：http://[门禁机IP]:[端口]/elevator/rule/get
Method：POST
Content-Type：application/json

请求参数

返回参数

示例

请求示例

{
  "version": "2021-12-13",
  "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
  "currentPage": "01",
  "pageSize": "01"
}

正常返回示例

{
  "code": 0,
  "message": "success",
  "data": {
    "currentPage": 1,
    "pageCount": 10,
    "pageSize": 2,
    "userData": [
      {
        "ruleId": "fa1a6-31a7-3**098",
        "userId": "ac1c2-31a7-3**066",
        "elevatorId": "01",
        "controlMode": "CALL_WITH_TARGET",
        "startFloor": "01",
        "startRoom": "601",
        "targetFloorRoomList": [
          {
            "floor": "9",
            "roomNumber": "01"
          }
        ],
        "delaySeconds": 10,
        "effectiveTime": "1589472000000",
        "expiryTime": "1905004800000"
      }
    ]
  }
}

9.3 上报人梯联动事件

梯控系统向边缘服务器上报人梯联动结果。

URL：http://[边缘服务器IP]:[端口]/elevator/rule/report
Method：POST
Content-Type：application/json

说明

当用户在电梯内刷门禁卡、蓝牙卡、扫描二维码、人脸识别后呼梯或释放楼层，执行完成后由梯控系统向边缘服务器发起事件上报请求。

请求参数

controlMode为CALL_ONLY：

controlMode为CALL_WITH_TARGET：

controlMode为RELEASE_ONLY：

controlMode为ACTIVATE_ONLY：

返回参数

示例

请求示例

{
  "version": "2021-12-13",
  "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
  "ruleId": "fa1a6-31a7-3**098",
  "elevatorId": "01",
  "userId": "ac1c2-31a7-3**066",
  "authType": "face",
  "authContent": "452f3570-4717-4a39-910b-d72542550001",
  "controlMode": "CALL_WITH_TARGET",
  "startFloor": "01",
  "startRoom": "601",
  "targetFloorRoomList": [
    {
      "floor": "9",
      "roomNumber": "01"
    }
  ],
  "delaySeconds": 10
}

正常返回示例

{
    "code":0,
    "message":"success",
}

9.4 设置人梯联动开关

边缘服务器同步人梯联动规则使能信息到梯控。

URL：http://[门禁机IP]:[端口]/elevator/rule/setAvailability
Method：POST
Content-Type：application/json

请求参数

返回参数

示例

请求示例

{
  "version": "2021-12-13",
  "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128",
  "availability": "enable"
}

正常返回示例

{
    "code":0,
    "message":"success"
}

9.5 获取人梯联动开关状态

边缘服务器获取人梯联动规则使能信息。

URL：http://[门禁机IP]:[端口]/elevator/rule/getAvailability
Method：POST
Content-Type：application/json

请求参数

返回参数

示例

请求示例

{
  "version": "2021-12-13",
  "token": "6f2ae65e-d7f3-11ea-9a16-6c96cfdfd355-192-168-1-128"
}

正常返回示例

{
  "code": 0,
  "message": "success",
  "data": {
    "availability": "enable"
  }
}

错误码

附录查看更多错误码

附录

错误码