社区云
社区云
项目列表
区域管理
楼宇管理
房屋管理
人员管理
来访登记
访客设置
离开登记
出入记录
报修管理
服务电话
公告管理
门禁设备
门禁设备组
门禁时间组
梯控设备
梯控权限组
发卡器
人员同步
社区配置
小程序设置
门禁通道
泊链云
项目管理
楼宇管理
房屋管理
人员管理
访客管理
数据统计
一码App
入住小区
访客登记
我的小区
基本信息
成员管理
出入提醒
访客管理
物业人员-人员管理
物业人员-时间校验
通行码
一键开门
一键乘梯
访客凭证
访客码
服务电话
公告
报修
微信公众号关联小程序
时间校验
微信服务号菜单跳转小程序入驻社区
微信公众号H5
门禁梯控H5页面
开放API
梯控联动物业缴费API
物业人脸管家
设备接入使用手册
门禁设备
设备类型-BJX-D001
设备类型-BJX-D002
设备类型-BL-L001
设备类型-BL-L002
设备类型-DA-L001
设备类型-HA-L001
设备类型-HQ-L001
设备类型-HQ-L002
设备类型-TH-D001
设备类型-XSJ-F001
设备类型-ZBX-A001
设备类型-ZBX-L001
设备类型-YF
设备类型-H7
梯控设备
BJX-D001
BJX-D002
TH-D001
访客机
发卡器
社区上报
江苏省
江苏省非煤矿安全风险监测预警系统
四川省
荷花池健康码
成都公安(人行)
四川人口信息服务网
专题文档
社区云功能开通指导
门禁设备支持清单
社区云设备对接说明
社区云-物业服务
访客机硬件
通用访客码API接口
文档云
-
+
首页
通用访客码API接口
## 外部-获取通用表单配置 **接口URL** > /open/face-caller/config?comid=35519 | 环境 | URL | | ------- | --------------------------------- | | sztest2 | https://sztest2.bolink.club/cloud | **Mock URL** > /open/face-caller/config?apipost_id=b2c556d3e4018 **请求方式** > GET **Content-Type** > json **请求Header参数** | 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 | | --------- | ------------------------------------------- | -------- | -------- | -------- | | X-App-Id | 0bd62d77c27cda8febd20db64f66a5c8 | string | 是 | - | | X-Api-Key | g5t63N5LBT8y1x8YlW_7dLC_MrqDRdPgv0t2lLB9dUI | string | 是 | - | **请求Query参数** | 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 | | ------ | ------ | -------- | -------- | -------- | | comid | 35519 | integer | 是 | 车场id | **请求Body参数** ```javascript 暂无数据 ``` **响应示例** * 成功(200) ```javascript { "msg": "查询成功", "advanceNotifyList": [ 352, 355, 356, 357, 358, 359, 360, 361, 362, 363, 364, 365, 366, 367, 368, 369 ], "state": 1, "advanceNotifyData": [ { "is_required": 1, "can_delete": 0, "name": "手机号", "sort": 0, "value": 353, "param_name": "mobile", "selected": 0, "as_name": "手机号" }, { "is_required": 0, "can_delete": 0, "name": "车辆类型", "sort": 0, "value": 362, "param_name": "car_type", "selected": 1, "as_name": "车辆类型" }, { "is_required": 0, "can_delete": 0, "name": "车牌号码", "sort": 0, "value": 363, "param_name": "car_number", "selected": 1, "as_name": "车牌号码" }, { "is_required": 1, "can_delete": 0, "name": "访客人数", "sort": 0, "value": 364, "param_name": "people_number", "selected": 1, "as_name": "访客人数" }, { "is_required": 0, "can_delete": 0, "name": "体温", "sort": 0, "value": 365, "param_name": "temperature", "selected": 1, "as_name": "体温" }, { "is_required": 0, "can_delete": 0, "name": "物品名称", "sort": 0, "value": 366, "param_name": "item_name", "selected": 1, "as_name": "物品名称" }, { "is_required": 0, "can_delete": 0, "name": "物品数量", "sort": 0, "value": 367, "param_name": "item_number", "selected": 1, "as_name": "物品数量" }, { "is_required": 1, "can_delete": 1, "name": "被访人姓名", "sort": 0, "value": 368, "param_name": "null", "selected": 1, "as_name": "被访人姓名" }, { "is_required": 1, "can_delete": 1, "name": "被访人手机号", "sort": 0, "value": 369, "param_name": "null", "selected": 1, "as_name": "被访人手机号" }, { "is_required": 1, "can_delete": 0, "name": "被访人部门", "sort": 0, "value": 419, "param_name": "user_department", "selected": 0, "as_name": "被访人部门" }, { "is_required": 1, "can_delete": 0, "name": "被访人姓名", "sort": 0, "value": 439, "param_name": "user_name", "selected": 0, "as_name": "被访人姓名" }, { "is_required": 1, "can_delete": 0, "name": "被访人手机", "sort": 0, "value": 445, "param_name": "user_telephone", "selected": 0, "as_name": "被访人手机" }, { "is_required": 1, "can_delete": 0, "name": "姓名", "sort": 0, "value": 352, "param_name": "name", "selected": 1, "as_name": "姓名" }, { "is_required": 1, "can_delete": 0, "name": "手机验证码", "sort": 0, "value": 354, "param_name": "code", "selected": 0, "as_name": "手机验证码" }, { "is_required": 0, "can_delete": 0, "name": "人脸照片", "sort": 0, "value": 355, "param_name": "photo", "selected": 1, "as_name": "人脸照片" }, { "is_required": 1, "can_delete": 0, "name": "来访时间", "sort": 0, "value": 356, "param_name": "in_time", "selected": 1, "as_name": "来访时间" }, { "is_required": 1, "can_delete": 0, "name": "计划离开时间", "sort": 0, "value": 357, "param_name": "out_time", "selected": 1, "as_name": "计划离开时间" }, { "is_required": 1, "can_delete": 0, "name": "被访房屋", "sort": 0, "value": 358, "param_name": "houseid", "selected": 1, "as_name": "被访房屋" }, { "is_required": 0, "can_delete": 0, "name": "备注", "sort": 0, "value": 359, "param_name": "remark", "selected": 1, "as_name": "备注" }, { "is_required": 0, "can_delete": 0, "name": "证件类型", "sort": 0, "value": 360, "param_name": "id_card_type", "selected": 1, "as_name": "证件类型" }, { "is_required": 0, "can_delete": 0, "name": "证件号码", "sort": 0, "value": 361, "param_name": "id_card", "selected": 1, "as_name": "证件号码" } ] } ``` ## 外部-提交表单 **接口URL** > /open/face-caller/commit | 环境 | URL | | ------- | --------------------------------- | | sztest2 | https://sztest2.bolink.club/cloud | **Mock URL** > /open/face-caller/commit?apipost_id=b3368833e416f **请求方式** > POST **Content-Type** > json **请求Header参数** | 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 | | --------- | ------------------------------------------- | -------- | -------- | -------- | | X-App-Id | 0bd62d77c27cda8febd20db64f66a5c8 | string | 是 | - | | X-Api-Key | g5t63N5LBT8y1x8YlW_7dLC_MrqDRdPgv0t2lLB9dUI | string | 是 | - | **请求Body参数** ```javascript { "comid": 35519, "code": null, "check_list_advance": [ { "is_required": 1, "can_delete": 0, "name": "人脸照片", "value": 3068, "param_name": "photo", "selected": 0, "field_type": 1, "param_value": "" }, { "is_required": 0, "can_delete": 0, "name": "证件类型", "value": 3087, "param_name": "id_card_type", "selected": 0, "field_type": 1, "param_value": "" }, { "is_required": 0, "can_delete": 0, "name": "证件号码", "value": 3088, "param_name": "id_card", "selected": 0, "field_type": 1, "param_value": "" }, { "is_required": 0, "can_delete": 0, "name": "车辆类型", "value": 3089, "param_name": "car_type", "selected": 0, "field_type": 1, "param_value": "" }, { "is_required": 0, "can_delete": 0, "name": "车牌号码", "value": 3090, "param_name": "car_number", "selected": 0, "field_type": 1, "param_value": "" }, { "is_required": 0, "can_delete": 0, "name": "体温", "value": 3092, "param_name": "temperature", "selected": 0, "field_type": 1, "param_value": "" }, { "is_required": 0, "can_delete": 0, "name": "物品名称", "value": 3093, "param_name": "item_name", "selected": 0, "field_type": 1, "param_value": "" }, { "is_required": 0, "can_delete": 0, "name": "物品数量", "value": 3094, "param_name": "item_number", "selected": 0, "field_type": 1, "param_value": "" }, { "is_required": 1, "can_delete": 0, "name": "被访房屋", "value": 3125, "param_name": "houseid", "selected": 1, "field_type": 1, "value_on": "115814", "param_value": "车公庙绿景大厦B栋单元二1层302" }, { "is_required": 0, "can_delete": 0, "name": "备注", "value": 3126, "param_name": "remark", "selected": 0, "field_type": 1, "param_value": "" }, { "is_required": 1, "can_delete": 0, "name": "访客人数", "value": 3127, "param_name": "people_number", "selected": 0, "field_type": 1, "param_value": "" }, { "is_required": 1, "can_delete": 0, "name": "被访人手机", "value": 3128, "param_name": "user_telephone", "selected": 1, "field_type": 1, "param_value": "13203394521" }, { "is_required": 1, "can_delete": 0, "name": "被访人姓名", "value": 3129, "param_name": "user_name", "selected": 1, "field_type": 1, "param_value": "付亚全" }, { "is_required": 1, "can_delete": 0, "name": "被访人部门", "value": 3130, "param_name": "user_department", "selected": 1, "field_type": 1, "param_value": "软件开发部" }, { "is_required": 1, "can_delete": 0, "name": "姓名", "value": 3131, "param_name": "name", "selected": 1, "field_type": 1, "param_value": "小小怪下士" }, { "is_required": 1, "can_delete": 0, "name": "手机号", "value": 3132, "param_name": "mobile", "selected": 0, "field_type": 1, "param_value": "" }, { "is_required": 1, "can_delete": 0, "name": "手机验证码", "value": 3133, "param_name": "code", "selected": 0, "field_type": 1, "param_value": "" }, { "is_required": 1, "can_delete": 0, "name": "来访时间", "value": 3134, "param_name": "in_time", "selected": 1, "field_type": 1, "param_value": "2025-09-22 00:00:00" }, { "is_required": 1, "can_delete": 0, "name": "计划离开时间", "value": 3135, "param_name": "out_time", "selected": 1, "field_type": 1, "param_value": "2025-09-22 23:59:59" } ], "mobile": null } ``` | 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 | | ------------------------------ | ------ | -------- | -------- | -------- | | comid | 35519 | number | 是 | 车场id | | code | - | null | 是 | - | | check_list_advance | - | array | 是 | - | | check_list_advance.is_required | 1 | number | 是 | 是否必选 | | check_list_advance.can_delete | 0 | number | 是 | 是否可以删除 | | check_list_advance.name | 姓名 | string | 是 | 字段参数名称 | | check_list_advance.value | 3109 | number | 是 | 字段参数值 | | check_list_advance.param_name | name | string | 是 | 字段名称 | | check_list_advance.selected | 1 | number | 是 | 是否被选中 | | check_list_advance.param_value | 大大怪 | string | 是 | 字段值 | | check_list_advance.as_name | 别名 | string | 是 | 别名 | | check_list_advance.sort | 0 | number | 是 | 排序 | | mobile | - | null | 是 | - | **响应示例** * 成功(200) ```javascript { "msg": "查询成功", "advanceNotifyList": [ 3098, 3099, 3100, 3068, 3101, 3102 ], "state": 1, "advanceNotifyData": [ { "is_required": 1, "can_delete": 0, "name": "人脸照片", "value": 3068, "param_name": "photo", "selected": 1 }, { "is_required": 1, "can_delete": 0, "name": "被访房屋", "value": 3085, "param_name": "houseid", "selected": 0 }, { "is_required": 0, "can_delete": 0, "name": "备注", "value": 3086, "param_name": "remark", "selected": 0 }, { "is_required": 0, "can_delete": 0, "name": "证件类型", "value": 3087, "param_name": "id_card_type", "selected": 0 }, { "is_required": 0, "can_delete": 0, "name": "证件号码", "value": 3088, "param_name": "id_card", "selected": 0 }, { "is_required": 0, "can_delete": 0, "name": "车辆类型", "value": 3089, "param_name": "car_type", "selected": 0 }, { "is_required": 0, "can_delete": 0, "name": "车牌号码", "value": 3090, "param_name": "car_number", "selected": 0 }, { "is_required": 1, "can_delete": 0, "name": "访客人数", "value": 3091, "param_name": "people_number", "selected": 0 }, { "is_required": 0, "can_delete": 0, "name": "体温", "value": 3092, "param_name": "temperature", "selected": 0 }, { "is_required": 0, "can_delete": 0, "name": "物品名称", "value": 3093, "param_name": "item_name", "selected": 0 }, { "is_required": 0, "can_delete": 0, "name": "物品数量", "value": 3094, "param_name": "item_number", "selected": 0 }, { "is_required": 1, "can_delete": 0, "name": "被访人手机", "value": 3095, "param_name": "user_telephone", "selected": 0 }, { "is_required": 1, "can_delete": 0, "name": "被访人姓名", "value": 3096, "param_name": "user_name", "selected": 0 }, { "is_required": 1, "can_delete": 0, "name": "被访人部门", "value": 3097, "param_name": "user_department", "selected": 0 }, { "is_required": 1, "can_delete": 0, "name": "姓名", "value": 3098, "param_name": "name", "selected": 1 }, { "is_required": 1, "can_delete": 0, "name": "手机号", "value": 3099, "param_name": "mobile", "selected": 1 }, { "is_required": 1, "can_delete": 0, "name": "手机验证码", "value": 3100, "param_name": "code", "selected": 1 }, { "is_required": 1, "can_delete": 0, "name": "来访时间", "value": 3101, "param_name": "in_time", "selected": 1 }, { "is_required": 1, "can_delete": 0, "name": "计划离开时间", "value": 3102, "param_name": "out_time", "selected": 1 } ] } ``` ## 外部-查看访客记录详情 **接口URL** > /open/face-caller/{id} | 环境 | URL | | ------- | --------------------------------- | | sztest2 | https://sztest2.bolink.club/cloud | **Mock URL** > /open/face-caller/{id}?apipost_id=f0973b23e4052 **请求方式** > GET **Content-Type** > json **请求Header参数** | 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 | | --------- | ------------------------------------------- | -------- | -------- | -------- | | X-App-Id | 0bd62d77c27cda8febd20db64f66a5c8 | string | 是 | - | | X-Api-Key | g5t63N5LBT8y1x8YlW_7dLC_MrqDRdPgv0t2lLB9dUI | string | 是 | - | **路径变量** | 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 | | ------ | ------ | -------- | -------- | -------- | | id | 1747 | string | 是 | - | **请求Body参数** ```javascript 暂无数据 ``` **响应示例** * 成功(200) ```javascript { "data": { // ===== 基本信息 ===== "name": "访客1", // 访客姓名 "callerNo": "caller-1842", // 访客编号 "memo": "1233", // 备注(页面显示在“单位信息”) "planInTime": 1693843200, // 计划进场时间(时间戳,单位秒) "planOutTime": 1693929599, // 计划离开时间(时间戳,单位秒) // ===== 图片信息 ===== "facePhoto": null, // 人脸照片 "idCardPhoto": null, // 证件照片 "snapPhoto": null, // 抓拍照片 // ===== 访客信息 ===== "faceUserId": null, // 人脸库ID(可用于识别) "mobile": null, // 手机号 "cardSn": null, // 访客卡号 "idCardType": null, // 证件类型(如身份证、护照等) "idCard": null, // 证件号码 "nationality": null, // 国籍 "carNumber": null, // 车牌号 "carType": null, // 车辆类型(小车/大车等) "temperature": null, // 体温 "peopleNumber": null, // 来访人数 "cause": null, // 来访事由 "itemName": null, // 携带物品名称 "itemNumber": null, // 携带物品数量 // ===== 被访人信息 ===== "userTelephone": "13077561727", // 被访人手机号 "addressName": "福田区,C栋,1层,101", // 被访人地址 "houseId": 115552, // 被访人房屋ID // ===== 权限信息 ===== "deviceIds": [ "785-1376" ], // 门禁设备ID(数组) "liftDeviceFloorIds": [], // 梯控楼层ID(数组) // ===== 来访控制信息 ===== "inTime": null, // 实际进场时间 "outTime": null, // 实际离开时间 "inAndOutTimes": null, // 进出记录次数(暂无) "status": 1, // 当前状态(例如:1=有效,2=已过期) "state": 1, // 状态标志,可能用于审核流转 // ===== 项目信息 ===== "projectId": 104, // 项目ID "projectName": "二号小区", // 项目名称 // ===== 系统信息(开发使用)===== "id": 1842, // 访客记录主键 "comid": 35519, // 所属物业公司ID "source": 1, // 来源:1=手动录入,2=微信预约,等 "time": null, // 系统记录时间 "unitName": null, // 单位名称(页面未展示) "departmentName": null, // 部门名称(页面未展示) "openid": null, // 微信openId "qrcodestr": null, // 生成二维码的字符串(如有) "detail": null, // 补充说明信息 "reasonId": null, // 来访原因字典ID(如配置) "reasonTypeLabel": null, // 原因类型文字 "tkKindsName": null, // 证件类型中文名 "deviceIdsName": null, // 门禁设备中文名 "virtualCardNo": null, // 虚拟访客卡号 "callerDeviceSerialNumber": null, // 访客登记设备序列号 "callerNumber": null, // 登记编号 "callerLevel": null, // 来访级别(如重要/普通) "expand": "{}", // 扩展字段 "faceUserName": null, // 人脸库姓名(如果不同于 name) "faceUserMobile": null // 人脸库手机号(如果不同于 mobile) }, "state": 0 } ``` | 参数名 | 示例值 | 参数类型 | 参数描述 | | ----------------------------- | ------------------ | -------- | ---------------------------------------------------------- | | data | - | object | - | | data.name | 访客1 | string | 访客姓名 | | data.callerNo | caller-1842 | string | 访客编号 | | data.memo | 1233 | string | 备注(页面显示在“单位信息”) | | data.planInTime | 1693843200 | number | 计划进场时间(时间戳,单位秒) | | data.planOutTime | 1693929599 | number | 计划离开时间(时间戳,单位秒) | | data.facePhoto | - | null | 人脸照片 | | data.idCardPhoto | - | null | 证件照片 | | data.snapPhoto | - | null | 抓拍照片 | | data.faceUserId | - | null | 人脸库ID(可用于识别) | | data.mobile | - | null | 手机号 | | data.cardSn | - | null | 访客卡号 | | data.idCardType | - | null | 证件类型(如身份证、护照等) | | data.idCard | - | null | 证件号码 | | data.nationality | - | null | 国籍 | | data.carNumber | - | null | 车牌号 | | data.carType | - | null | 车辆类型(小车/大车等) | | data.temperature | - | null | 体温 | | data.peopleNumber | - | null | 来访人数 | | data.cause | - | null | 来访事由 | | data.itemName | - | null | 携带物品名称 | | data.itemNumber | - | null | 携带物品数量 | | data.userTelephone | 13077561727 | string | 被访人手机号 | | data.addressName | 福田区,C栋,1层,101 | string | 被访人地址 | | data.houseId | 115552 | number | 被访人房屋ID | | data.deviceIds | - | array | 设备ID数组中的一个设备ID,示例值为device1 。 | | data.liftDeviceFloorIds | - | array | 电梯设备楼层ID数组中的一个楼层ID,示例值为1 。 | | data.inTime | - | null | 实际进场时间 | | data.outTime | - | null | 实际离开时间 | | data.inAndOutTimes | - | null | 进出记录次数(暂无) | | data.status | 1 | number | 0-已删除,1-未删除 | | data.state | 1 | number | 0-未审核,1-已审核,2-已拒绝,3-在访,4-访问完毕,5-已过期 | | data.projectId | 104 | number | 项目ID | | data.projectName | 二号小区 | string | 项目名称 | | data.id | 1842 | number | 访客记录主键 | | data.comid | 35519 | number | 所属物业公司ID | | data.source | 1 | number | 来源:1=手动录入,2=微信预约,等 | | data.time | - | null | 系统记录时间 | | data.unitName | - | null | 单位名称(页面未展示) | | data.departmentName | - | null | 部门名称(页面未展示) | | data.openid | - | null | 微信openId | | data.qrcodestr | - | null | 生成二维码的字符串(如有) | | data.detail | - | null | 补充说明信息 | | data.reasonId | - | null | 来访原因字典ID(如配置) | | data.reasonTypeLabel | - | null | 原因类型文字 | | data.tkKindsName | - | null | 证件类型中文名 | | data.deviceIdsName | - | null | 门禁设备中文名 | | data.virtualCardNo | - | null | 虚拟访客卡号 | | data.callerDeviceSerialNumber | - | null | 访客登记设备序列号 | | data.callerNumber | - | null | 登记编号 | | data.callerLevel | - | null | 来访级别(如重要/普通) | | data.expand | {} | string | 扩展字段 | | data.faceUserName | - | null | 人脸库姓名(如果不同于 name) | | data.faceUserMobile | - | null | 人脸库手机号(如果不同于 mobile) | | state | 0 | number | 状态标志 | ## 外部-查看访客记录列表 **接口URL** > /open/face-caller/list?comid=35519&phone=&name=&projectId=10002 | 环境 | URL | | ------- | --------------------------------- | | sztest2 | https://sztest2.bolink.club/cloud | **Mock URL** > /open/face-caller/list?apipost_id=f1447b7be4062 **请求方式** > GET **Content-Type** > json **请求Header参数** | 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 | | --------- | ------------------------------------------- | -------- | -------- | -------- | | X-App-Id | 0bd62d77c27cda8febd20db64f66a5c8 | string | 是 | - | | X-Api-Key | g5t63N5LBT8y1x8YlW_7dLC_MrqDRdPgv0t2lLB9dUI | string | 是 | - | **请求Query参数** | 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 | | --------- | ------ | -------- | -------- | ------------ | | comid | 35519 | integer | 是 | 车场id | | phone | - | string | 否 | 被访人手机号 | | name | - | string | 否 | 被访人姓名 | | projectId | 10002 | integer | 否 | 项目id | **请求Body参数** ```javascript 暂无数据 ``` **响应示例** * 成功(200) ```javascript { "data": [ { "id": 2047, "comid": 35519, "faceUserId": null, "name": "513488", "planInTime": 1729158809, "planOutTime": 1729158809, "peopleNumber": null, "cause": null, "facePhoto": null, "state": 1, "callerNo": "caller-2047", "detail": null, "qrcodestr": null, "openid": null, "status": 1, "reasonId": null, "memo": null, "mobile": "13077561727", "houseId": 116018, "source": 1, "expand": "{}", "callerDeviceSerialNumber": null, "callerNumber": null, "callerLevel": null, "nationality": null, "carNumber": null, "inAndOutTimes": null, "idCardType": null, "idCard": null, "temperature": null, "carType": null, "itemName": null, "itemNumber": null, "idCardPhoto": null, "snapPhoto": null, "outTime": null, "time": null, "unitName": null, "userTelephone": null, "cardSn": null, "tkKindsName": null, "deviceIdsName": null, "projectId": 104, "projectName": "二号小区", "virtualCardNo": null, "inTime": null, "auditObject": 1 } ], "state": 0 } ```
admin
2025年9月30日 16:45
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码