3. 访客

API列表

编号 API名称 路径 版本
1.0 访客for H5 /v1/iot/door/doorVisitor/transport 1.0
1.1 添加访客 /v1/iot/door/doorVisitor/insert 1.0
1.2 访客详情 /v1/iot/door/doorVisitor/visitor/{id} 1.0
1.3 访客修改 /v1/iot/door/doorVisitor/update 1.0
1.4 访客审核列表 /v1/iot/door/doorVisitor/queryAuthList 1.0
1.5 访客状态列表 /v1/iot/door/doorVisitor/queryStateList 1.0
2.1 访客查询门禁授权列表 /v1/iot/door/doorVisitor/queryAuthorizationForVisitor 1.0
2.2 访客查询梯控授权列表 /v1/iot/door/doorVisitor/queryLiftAuthorizationForVisitor 1.0
3.1 访客的门禁多个设备授权的下发接口 /v1/iot/door/face/doorFaceRecognition/sendToDevice 1.0
3.2 访客的梯控多个设备授权的下发接口 /v1/iot/door/face/doorFaceRecognition/lift/sendToDevice 1.0
4.1 访客开门-查看 开门及记录1.2接口 /v1/iot/door/openRecord/doorOpenRecord/openDoor 1.0
4.2 访客远程呼梯 /v1/iot/door/doorVisitor/remoteLiftCall 1.0
4.3 访客车辆记录 /v1/iot/door/openRecord/doorOpenRecord/carLog 1.0
4.4 访客车辆记录推送 /v1/iot/door/openRecord/doorOpenRecord/carLog/push 1.0
5.1 案场访客添加 /v1/iot/door/doorVisitor/insert/marketing 1.0

API调用

1.0: 访客for H5

描述 添加访客

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/app/visitor/transport

方法：POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
url body string y 透传url ,对比原来的url去掉 v1/iot/door/
body body string y body
method body string y post

请求Body描述(非Form表单数据)

{
    "url": "doorVisitor/visitor/90000097",
    "msgId":"1",
    "body": {
    }
}

返回参数 返回字段来的，不用传

名称 位置 类型 必填 描述
state body int n 访客状态 ,1待访问 2访问中 3滞留中 4以访问 5已过期 6已取消
allowOpeningTimes body string n 允许开门次数
leaveTime body string n 离开时间
返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
    "id":999111    
}
}

1.1: 添加访客

描述 添加访客

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/doorVisitor/insert

方法：POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
openId body string n 微信openId,使用微信申请时穿入
name body string y name
phone body string y phone
type body int y 访客类型id
typeName body int y 访客类型名称
certificateCode body string n 证件编码
plateCode body string n 车牌号码
periodFlag body int n 是否周期访问, 0 否 1 是
effectiveTime body string y 生效时间, 格式 yyyy-MM-dd HH:mm:ss
expiredTime body string y 失效时间, 格式 yyyy-MM-dd HH:mm:ss
start body string n 周期性性访问必填， 开始时间
finish body string n 周期性性访问必填， 结束时间
registrantId body string n 登记人id
registrantRole body string n 登记人角色, 1住户 2员工
registrantTime body string n 登记时间
projectId body string y 项目id
projectName body string n 项目name
authState body int y 审核状态 1待审核 2通过 3驳回 4过期 5审核取消
authStateName body int n 审核状态 待审核 审核通过 审核驳回 过期失效
faceUrl body string n 访客人脸图片url
visitManId body string y 拜访人id
visitManName body string y 拜访人name
visitManType body string y 拜访人角色, 1住户 2员工
visitManPhone body string y 拜访人手机号码
visitManAddress body string y 拜访人房产、组织
authUserId body string y 审核人id
authUserName body string y 审核人name
authUserTime body string y 审核时间
clientType body int y 来源 1后台 2app 3微信
remark body int string 备注
belong body string n 所属组织 个人/团体
allowOpeningTimes body string n 允许开门次数

请求Body描述(非Form表单数据)

{
    "phone": "13002200",
    "type": "1",
    "typeName": "亲戚",
    "plateCode": "粤A11111",
    "periodFlag": 1,
    "start": "9:00",
    "finish": "11:00",
    "visitManType":1,
    "effectiveTime": "2021-01-08 11:11:11",
    "expiredTime": "2021-01-08 11:11:11",
    "registrantId": "111",
    "registrantRole": "",
    "projectId": "123",
    "authState": "2",
    "face_url": "ssxxx",
    "visitManId": "111",
    "authUserName": "111",
    "authUserTime": "2021-01-08 11:11:11",
    "clientType": 1,
    "remark": "6个人"

}

返回参数 返回字段来的，不用传

名称 位置 类型 必填 描述
state body int n 访客状态 ,1待访问 2访问中 3滞留中 4以访问 5已过期 6已取消
allowOpeningTimes body string n 允许开门次数
leaveTime body string n 离开时间
返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
    "id":999111    
}
}

1.2: 访客详情

描述 添加访客

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/doorVisitor/visitor/{id}

方法：POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

返回参数 返回字段来的，不用传

名称 位置 类型 必填 描述
state body int n 访客状态 ,1待访问 2访问中 3滞留中 4以访问 5已过期 6已取消
allowOpeningTimes body string n 允许开门次数
leaveTime body string n 离开时间
返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "id": 15,
        "phone": "13002200",
        "type": "1",
        "typeName": "亲戚",
        "plateCode": "粤A11111",
        "periodFlag": "1",
        "effectiveTime": "2021-01-08 11:11:11",
        "expiredTime": "2021-01-08 11:11:11",
        "start": "9:00",
        "finish": "11:00",
        "registrantId": "111",
        "registrantRole": "",
        "projectId": "123",
        "authState": 3,
        "visitManId": "111",
        "visitManType": 1,
        "authUserName": "111",
        "authUserTime": "2021-01-08 11:11:11",
        "clientType": "1",
        "remark": "6个人"
    }
}

1.3: 访客修改

描述 访客修改

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/doorVisitor/update

方法：POST

名称 位置 类型 必填 描述
id body string y 访客id
type body string n 访客性质id
typeName body string n 访客性质名称
authState body int y 审核状态 1待审核 2通过 3驳回 4过期 5审核取消
state body int n 访客状态 ,1待访问 2访问中 3滞留中 4以访问 5已过期 6已取消
。。。。。。 body int n 新增访客的字段,都支持传入 修改
authUserId body string y 审核人id
authUserName body string y 审核人name
authUserTime body string y 审核时间

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

{
  "authState": 1,
  "type": 1,
  "id": 1
}

返回参数 返回字段来的，不用传

| 名称 | 位置 | 类型 | 必填 | 描述 | | authState | body | int | y | 审核状态 1待审核 2通过 3驳回 4过期 5审核取消|

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
data 顶层 boolean 是 响应数据对象
返回结果示例

1.4: 访客审核列表

描述 访客修改

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/doorVisitor/queryAuthList

方法：POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
query body string n 名称或者电话号码的那个输入栏
projectId body string y projectId
openId body string n openId
pageSize body string n pageSize
pageNo body string n pageNo
authState body int n 审核状态 1待审核 2通过 3驳回 4过期 5审核取消
registrantId body string n 登记人id

请求Body描述(非Form表单数据)

{
    "code": "200",
    "success": true,
    "data": {
        "records": [
            {
                "id": 16,
                "phone": "13002201111110",
                "type": "1",
                "typeName": "亲戚",
                "plateCode": "粤A11111",
                "periodFlag": "1",
                "effectiveTime": "2021-01-08 11:11:11",
                "expiredTime": "2021-01-08 11:11:11",
                "start": "9:00",
                "finish": "11:00",
                "registrantId": "111",
                "registrantRole": "",
                "projectId": "123",
                "authState": 3,
                "authStateName": "审核驳回",
                "visitManId": "111",
                "visitManType": 1,
                "authUserName": "111",
                "authUserTime": "2021-01-08 11:11:11",
                "clientType": "1",
                "remark": "6个人"
            }
        ],
        "total": 0,
        "size": 10,
        "current": 1,
        "orders": [],
        "optimizeCountSql": true,
        "hitCount": false,
        "searchCount": true,
        "pages": 0
    }
}

返回参数 返回字段来的，不用传

名称 位置 类型 必填 描述
返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "records": [
            {
                "id": 4,
                "name": "张1三1",
                "phone": "13002200",
                "type": "123",
                "typeName": "亲戚",
                "plateCode": "粤A11111",
                "periodFlag": "1",
                "effectiveTime": "2021-01-08 11:11:11",
                "expiredTime": "2021-01-08 11:11:11",
                "start": "9:00",
                "finish": "11:00",
                "registrantId": 111,
                "registrantRole": "",
                "projectId": "123",
                "authState": 1,
                "authStateName": "待审核",
                "visitManId": "111",
                "authUserName": "111",
                "authUserTime": "2021-01-08 11:11:11",
                "clientType": "1",
                "remark": "6个人"
            },
            {
                "id": 5,
                "name": "张1三1",
                "phone": "13002200",
                "type": "123",
                "typeName": "亲戚",
                "plateCode": "粤A11111",
                "periodFlag": "1",
                "effectiveTime": "2021-01-08 11:11:11",
                "expiredTime": "2021-01-08 11:11:11",
                "start": "9:00",
                "finish": "11:00",
                "registrantId": 111,
                "registrantRole": "",
                "projectId": "123",
                "authState": 1,
                "authStateName": "待审核",
                "visitManId": "111",
                "authUserName": "111",
                "authUserTime": "2021-01-08 11:11:11",
                "clientType": "1",
                "remark": "6个人"
            }
        ],
        "total": 0,
        "size": 10,
        "current": 1,
        "orders": [],
        "optimizeCountSql": true,
        "hitCount": false,
        "searchCount": true,
        "pages": 0
    }
}

1.5: 访客状态列表

描述 访客状态列表

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/doorVisitor/queryStateList

方法：POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
query body string n 名称或者电话号码的那个输入栏
projectId body string n phone
openId body string n openId
state body int n 访客状态 ,1待访问 2访问中 3滞留中 4以访问 5已过期 6已取消
pageSize body string n pageSize
pageNo body string n pageNo
registrantId body string n 登记人id

请求Body描述(非Form表单数据)

{
  "query": "老张",
  "state": "1",
  "pageSize": 10,
  "pageNo": 1
}

返回参数 返回字段来的，不用传

名称 位置 类型 必填 描述
返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "records": [
            {
                "id": 17,
                "name": "审核通过",
                "phone": "13002200",
                "type": "1",
                "typeName": "亲戚",
                "plateCode": "粤A11111",
                "periodFlag": "1",
                "effectiveTime": "2021-01-05 11:11:11",
                "expiredTime": "2021-01-12 11:11:11",
                "start": "9:00",
                "finish": "11:00",
                "registrantId": "111",
                "registrantRole": "",
                "projectId": "123",
                "authState": 2,
                "visitManId": "111",
                "visitManType": 1,
                "authUserName": "111",
                "authUserTime": "2021-01-08 11:11:11",
                "clientType": "1",
                "remark": "6个人"
            }
        ],
        "total": 0,
        "size": 10,
        "current": 1,
        "orders": [],
        "optimizeCountSql": true,
        "hitCount": false,
        "searchCount": true,
        "pages": 0
    }
}

2.1: 访客查询门禁授权列表

描述 访客状态列表

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/doorVisitor/queryAuthorizationForVisitor

方法：POST

名称 位置 类型 必填 描述
projectId body string y projectId
personId body string y 拜访人的id， 比如员工id或者业主id
visitorId body string y visitorId

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

{
  "projectId": "610",
  "personId": 23482,
  "visitorId": 90000001
}

返回参数 返回字段来的，不用传

名称 位置 类型 必填 描述
返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
data 顶层 boolean 是 响应数据对象
bizFaceAuthFlag data 0，1 是 用于标识有无人脸授权，0为无，1有
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "result": [
            {
                "effectiveTime": "2021-01-07 00:00:00",
                "isOnline": "N",
                "type": 1,
                "deviceId": "bde6297cc5c629b8",
                "deviceName": "大华门禁1000012",
                "deleteFace": 0,
                "effective": "2021-01-07至2021-01-15",
                "sendFace": 0,
                "enable": 1,
                "id": 278829,
                "state": 1,
                "bizFaceAuthFlag": 0,
                "productId": "90f7c8364eaa4aadae4c7f05ace3130c",
                "openMode": "远程,人脸",
                "doorTypename": "大门门禁",
                "authorizedMode": "人工授权",
                "updateTime": 1610003688000,
                "authScope": "7栋,6栋",
                "expiresTime": "2021-01-15 00:00:00",
                "personName": "自动化",
                "createTime": 1610003688000,
                "phone": "18038758060",
                "autoDelete": 0,
                "personId": "23482",
                "projectId": 610
            }
        ],
        "total": 1
    }
}

2.2: 访客查询梯控授权列表

描述 访客状态列表

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/doorVisitor/queryLiftAuthorizationForVisitor

方法：POST

名称 位置 类型 必填 描述
projectId body string y projectId
userId body string y 拜访人的id， 比如员工id或者业主id
visitorId body string y 访客id

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

{"projectId":"23414","userId":"24087"  ,"visitorId":"123"  }

返回参数 返回字段来的，不用传

名称 位置 类型 必填 描述
liftAuthorizeId data.list string 是 授权Id
deviceName data.list string 是 设备名
deviceId data.list string 是 设备Id
deviceSn data.list string 是 设备sn
mac data.list string 是 mac
status data.list int 是 在离线状态
areaId list string y 项目id
areaName list string y 项目名
buildId list string y 建筑id
buildName list string y 建筑名
unitNames list JSONArray y 单元名
unitIds list JSONArray y 单元Id
callType list JSONArray y 单元Id
numList list JSONArray y 楼层列表
publicFloors list JSONArray y 公共楼层
nonPublicFloors list JSONArray y 非公共楼层
endTime list string y 授权结束时间
startTime list string y 授权开始时间
authorizeType list int y 授权方式 0 自动 1手动
authorizePerson list string y 授权人
instanceId list string y 实例标识
allowedOpeningTimes list int y 剩余呼梯次数
authValidFlag list int y 授权时间有效标示 0 有效 1 授权过期 2 授权时间未到
userId list string y 用户标识
isOnline list bool y 设备在线状态
prohibit list bool y 梯控是否被禁用
isEnable list int y 0-禁用；1-启用
authorizationUserIds list JSONArray y 授权用户标识
bizFaceAuthFlag list int y 人脸授权标识
nums list JSONArray y 楼层列表
projectId list string y 项目Id
productId list string y 产品Id
bizFaceAuthFlag data 0，1 是 用于标识有无人脸授权，0为无，1有
返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
data 顶层 boolean 是 响应数据对象
bizFaceAuthFlag data 0，1 是 用于标识有无人脸授权，0为无，1有
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "result": [
            {
                "prohibit": false,
                "unitNames": [
                    "1单元"
                ],
                "publicFloors": [
                    "-2F",
                    "-1F",
                    "3F"
                ],
                "deviceName": "观光梯",
                "deviceId": "41c08029d48ca2d1",
                "deviceSn": "234234",
                "mac": "A23902342",
                "callType": [
                    "LONG_RANGE",
                    "FACE"
                ],
                "isEnable": 1,
                "authorizeType": 1,
                "instanceId": "16079369916050349",
                "startTime": "2020-12-16 00:00:00",
                "nonPublicFloors": [
                    "4F"
                ],
                "nums": [
                    -2,
                    -1,
                    3,
                    4
                ],
                "bizFaceAuthFlag": 0,
                "buildName": "2栋",
                "productId": "08c494bdc83338b7f6c913f3d19af1d0",
                "buildId": "5201",
                "userId": "410009",
                "liftAuthorizeId": "16081007720801698",
                "authorizationUserIds": [],
                "authorizePerson": "李向虹",
                "endTime": "2020-12-31 23:59:59",
                "numList": [
                    "-2F",
                    "-1F",
                    "3F",
                    "4F"
                ],
                "projectId": "610",
                "status": 0,
                "unitIds": [
                    "8297"
                ]
            },
            {
                "prohibit": false,
                "unitNames": [
                    "1单元"
                ],
                "publicFloors": [
                    "-2F",
                    "-1F",
                    "3F"
                ],
                "deviceName": "观光梯",
                "deviceId": "41c08029d48ca2d1",
                "deviceSn": "234234",
                "mac": "A23902342",
                "callType": [
                    "LONG_RANGE",
                    "FACE"
                ],
                "isEnable": 1,
                "authorizeType": 1,
                "instanceId": "16079369916050349",
                "nonPublicFloors": [],
                "nums": [
                    -2,
                    -1,
                    3
                ],
                "bizFaceAuthFlag": 0,
                "buildName": "2栋",
                "productId": "08c494bdc83338b7f6c913f3d19af1d0",
                "buildId": "5201",
                "userId": "120004ba87eb9600",
                "liftAuthorizeId": "16079539742757457",
                "authorizationUserIds": [],
                "authorizePerson": "庄立兵",
                "numList": [
                    "-2F",
                    "-1F",
                    "3F"
                ],
                "projectId": "610",
                "status": 0,
                "unitIds": [
                    "8297"
                ]
            },
            {
                "prohibit": false,
                "unitNames": [
                    "1单元"
                ],
                "publicFloors": [
                    "-2F",
                    "-1F",
                    "3F"
                ],
                "deviceName": "观光梯",
                "deviceId": "41c08029d48ca2d1",
                "deviceSn": "234234",
                "mac": "A23902342",
                "callType": [
                    "LONG_RANGE",
                    "FACE"
                ],
                "isEnable": 1,
                "authorizeType": 1,
                "instanceId": "16079369916050349",
                "startTime": "2020-12-15 00:00:00",
                "nonPublicFloors": [],
                "nums": [
                    -2,
                    -1,
                    3
                ],
                "bizFaceAuthFlag": 0,
                "buildName": "2栋",
                "productId": "08c494bdc83338b7f6c913f3d19af1d0",
                "buildId": "5201",
                "userId": "410001",
                "liftAuthorizeId": "16079455164226066",
                "authorizationUserIds": [],
                "authorizePerson": "庄立兵",
                "endTime": "2020-12-17 23:59:59",
                "numList": [
                    "-2F",
                    "-1F",
                    "3F"
                ],
                "projectId": "610",
                "status": 0,
                "unitIds": [
                    "8297"
                ]
            }
        ],
        "total": 129
    }
}

3.1: 访客的门禁多个设备授权的下发接口

描述 门禁多个设备授权的下发接口

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/doorVisitor/sendToDevice

方法：POST

名称 位置 类型 必填 描述
projectId body string y projectId
visitorId body string y visitorId
deviceIds body list y 设备ids的集合
optType body string y 1添加

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

{
  "projectId": "111",
  "visitorId": 865,
  "deviceIds": [   "qwqeq1wexzcv","qwqeq1wexzcv1","112323"],
  "optType": 0

}

返回参数 返回字段来的，不用传

名称 位置 类型 必填 描述
返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": [
            "success","success","fail"
    ]
}

3.2: 访客的梯控多个设备授权的下发接口

描述 访客的梯控多个设备授权的下发接口

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/doorVisitor/lift/sendToDevice

方法：POST

名称 位置 类型 必填 描述
instanceId body string y instanceId
visitorId body string y visitorId
deviceId body list y 设备id
floors body list y 楼层集合

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

{
  "instanceId": "111",
  "visitorId": 865,
  "deviceId": "1",
  "floors": [1,3,4]

}

返回参数 返回字段来的，不用传

名称 位置 类型 必填 描述
返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": "success"
}

4.2: 访客远程呼梯

描述 访客远程呼梯

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/doorVisitor/remoteLiftCall

方法：POST

名称 位置 类型 必填 描述
projectId body string y projectId
visitorId body string y visitorId
deviceId body string y 设备id
floorNum body string y 到的楼层
userId body string y 拜访的业主id，或者员工id

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

{
    "projectId": "21441121",
    "deviceId":"50411629",
    "floorNum":3,
    "userId":"50411629",
  "visitorId":"50411629"
}

返回参数 返回字段来的，不用传

名称 位置 类型 必填 描述
返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "500",
    "success": false,
    "message": "当前设备不存在，请检查后再试"
}

4.3: 访客车辆记录

描述 访客远程呼梯

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/openRecord/doorOpenRecord/carLog

方法：POST

名称 位置 类型 必填 描述
projectId body string y projectId
personId body string y visitorId
pageSize body string n
pageNo body string n

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

{    "pageNo": 1,
    "pageSize": 10,
    "projectId": "23414",
    "personId":"90000002"
}

返回参数 返回字段来的，不用传

名称 位置 类型 必填 描述
返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "000000",
    "msg": "请求成功",
    "data": {
        "list": [
            {
                "id": "5cbd05ce81c710549b7a8c8ab28c7173",
                "project_id": "23414",
                "project_name": "上华产业园项目",
                "parkinglot_id": "23430",
                "parkinglot_no": "001",
                "parkinglot_name": "A区园区露天停车场A",
                "create_date": null,
                "update_date": "2021-01-11T08:15:00.712Z",
                "deleted": false,
                "create_by": null,
                "create_by_id": null,
                "update_by": "系统",
                "update_by_id": null,
                "delete_date": null,
                "car_plate_no": "粤A00004",
                "car_pass_type": null,
                "pass_in_id": null,
                "in_time": "2021-01-11T08:10:27.000Z",
                "in_area_id": null,
                "in_area_name": null,
                "in_channel_id": null,
                "in_channel_name": null,
                "in_device_id": null,
                "in_device_name": null,
                "pass_out_id": "ca659f80000145a8991531c2337645ea",
                "out_time": "2021-01-11T08:10:27.000Z",
                "out_area_id": "98b19ffb522d11eb8b26e0be0313fc20",
                "out_area_name": "睿住智能停车场",
                "out_channel_id": "98e70d6b522d11eb8b26e0be0313fc20",
                "out_channel_name": "大车场入口",
                "out_device_id": "af4d672f55b14d059bee0afc69573324",
                "out_device_name": "小车场出口",
                "order_id": null,
                "bill_payable": null,
                "real_pay": null,
                "roll_money": null,
                "coupon_money": null,
                "uneven_money": null,
                "in_event_id": null,
                "out_event_id": "ca659f80000145a8991531c2337645ea",
                "free_pass_type": null,
                "free_pass_reason": null,
                "free_pass_oper_man_name": null,
                "free_pass_oper_man_no": null,
                "exception_types": [
                    1,
                    2
                ],
                "except": true,
                "parking_time": null,
                "in_pic": null,
                "out_pic": null,
                "free": false
            }
        ],
        "count": 2
    },
    "status": 200
}

4.4: 访客车辆记录推送

描述 访客车辆记录推送

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/openRecord/doorOpenRecord/carLog/push

方法：POST

名称 位置 类型 必填 描述
projectId body string y projectId
carPlateNo body string y 车牌
msgId body string 唯一id

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

{    "msgId": 15555,
    "carPlateNo": "粤11111",
    "projectId": "23414"
}

返回参数 返回字段来的，不用传

名称 位置 类型 必填 描述
返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "000000",
    "msg": "请求成功",
    "data": {},
    "status": 200
}

5.0: 案场添加访客

描述 添加访客

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/doorVisitor/insert/marketing

方法：POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
openId body string y 微信openId,使用微信申请时穿入
name body string y name
phone body string y phone
plateCode body string y 车牌号码
effectiveTime body string y 生效时间, 格式 yyyy-MM-dd HH:mm:ss
expiredTime body string y 失效时间, 格式 yyyy-MM-dd HH:mm:ss
projectId body string y 项目id
visitingManName body string y 销售顾问名字

请求Body描述(非Form表单数据)

{
    "phone": "13002200",
    "plateCode": "粤A11111",
    "openId": "1",
    "effectiveTime": "2021-01-08 11:11:11",
    "expiredTime": "2021-01-08 11:11:11",
    "projectId": "123",
    "visitingManName": "123"
}

返回参数 返回字段来的，不用传

名称 位置 类型 必填 描述
返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
data 顶层 boolean 是 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
    "id":999111    
    }
}

results matching ""

    No results matching ""