访客平台接口

1. 提交访客信息

接口地址：POST /open-api/visitor/add-order-record

接口说明：通过此接口将访客预约信息提交到EPO平台，EPO平台仅接受访客预约的审核结果，审批环节在第三方系统实现。

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

body域

名称	类型	可空	描述
personName	string	N	访客姓名
personMobile	string	N	访客手机号
toPersonMobile	string	N	被访人手机号注：邀约时此为邀约人的手机号
personCompany	string	N	访客单位
purpose	string	Y	来访目的
startTime	string	N	访问开始时间 yyyy-MM-dd-dd HH:mm
endTime	string	N	访问结束时间 yyyy-MM-dd HH:mm
vehicleCodes	string[]	Y	车牌号说明：["鲁A12345","鲁B12345"] 注：如果配置了联动停车，则车牌号可有权限通行
personNum	int	Y	来访人数
memo	string	N	备注
type	string	N	0 邀约 1预约
addressId	long	Y	到访区域提醒：区域下可以绑定门禁设备，代表访客可通行的门禁设备，如果不传入，则可通行设置的全部门禁设备

返回数据

名称	类型	可空	描述
code	int	N	返回状态
msg	string	N	返回说明
data	Object	N
+recordId	long	N	记录id

示例数据

{
"code": 0,
"msg": "操作成功",
"data":{
"recordId":1234567890123456789
}
}

2. 查询访客记录处理结果

接口地址：POST /open-api/visitor/get-order-record-result

接口说明：查询访客记录的处理结果。

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

body域

名称	类型	可空	默认	描述
recordId	long	N		记录id

返回数据

名称	类型	可空	默认	描述
code	int	N		返回状态
msg	string	N		返回说明

示例数据

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

3. 查询到访区域列表

接口地址：POST /open-api/visitor/address-list

接口说明：通过此接口可获取访客到访区域列表。

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

返回数据

名称	类型	可空	描述
code	int	N	0成功 1失败
msg	string	N
result	Object	N	返回结果
+data	Object[]
++addressId	long	N	区域id
++addressName	String	N	区域名称
++parkId	long		园区id
++parkName	String		园区名称

示例数据

{
"code": 0,
"msg": "操作成功",
"result":{
"data":[{"addressId":132132,"addressName":"北门","parkId":1,"parkName":"园区一"}]
}
}

4. 删除访客信息

接口地址：POST /open-api/visitor/address-list

接口说明：通过此接口将从EPO访客中删除访客信息。

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

body域

名称	类型	可空	默认	描述
recordId	long	N		访客记录id

返回数据

名称	类型	可空	默认	描述
code	int	N		返回状态
msg	string	N		返回说明

示例数据

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

5. 访客机核验回调数据(内测中)

接口说明：提供的回调url需接受 post application/json请求,核验多次会推送多次。

请求数据

header域

名称	类型	可空	描述
appKey	String	N	平台分配
timestamp	Long	N	当前时间，Unix毫秒时间戳
sign	String	N	MD5-32(appKey+timestamp+appSecret),32小写

body域

名称	类型	可空	描述
callbackType	String	N	VISITOR_CHECK
data	对象	N
+recordId	long	N	记录id
+code	int	N	0核验成功 1核验失败
+msg	string	Y

示例数据

{
"callbackType": "VISITOR_CHECK",
"data": {
"recordId":1234567890123456789,
"code":0,
"msg":"核验成功"
}
}

6. 访客预约回调数据

接口说明：提供的回调url需接受 post application/json请求。

请求数据

header域

名称	类型	可空	描述
appKey	String	N	平台分配
timestamp	Long	N	当前时间，Unix毫秒时间戳
sign	String	N	MD5-32(appKey+timestamp+appSecret),32小写

body域

名称	类型	可空	描述
callbackType	String	N	VISITOR_ORDER
data	对象	N
+id	string	N	访客预约id AES加密
+personName	string	N	访客姓名AES加密
+personMobile	string	N	访客手机号AES加密
+personFaceUrl	String	N	访客人脸照片url AES加密
+toPersonName	string	N	被访人姓名AES加密
+toPersonMobile	string	N	被访人手机号AES加密说明：被访人姓名为空的话被访人手机号必填
+personCompany	string	N	访客单位
+purpose	string	N	来访目的
+startTime	string	N	访问开始时间
+endTime	string	N	访问结束时间
+vehicleCodes	string[]	Y	车牌号说明：["鲁A12345","鲁B12345"]
+personNum	int	N	来访人数
+memo	string	N
+type	string	N	0 邀约 1预约
+parkId	String		园区Id
+checkQrcode	string	Y	访客核验码
+payParkingFlag	boolean	Y	是否代付停车费

示例数据

{
"callbackType": "VISITOR_ORDER",
"data": {
"id":"encryptedId123",
"personName":"encryptedName",
"personMobile":"encryptedMobile",
"personFaceUrl":"encryptedUrl",
"toPersonName":"encryptedToName",
"toPersonMobile":"encryptedToMobile",
"personCompany":"测试公司",
"purpose":"商务洽谈",
"startTime":"2025-05-01 09:00",
"endTime":"2025-05-01 18:00",
"vehicleCodes":["鲁A12345"],
"personNum":1,
"memo":"无特殊备注",
"type":"1",
"parkId":"park123",
"checkQrcode":"qrcode123",
"payParkingFlag":true
}
}

7. 访客登记回调数据

接口说明：提供的回调url需接受 post application/json请求。

请求数据

header域

名称	类型	可空	描述
appKey	String	N	平台分配
timestamp	Long	N	当前时间，Unix毫秒时间戳
sign	String	N	MD5-32(appKey+timestamp+appSecret),32小写

body域

名称	类型	可空	描述
callbackType	String	N	VISITOR_CHECK
data	对象	N
+name	string	N	访客姓名AES加密
+mobile	string	N	访客手机号AES加密
+idcard	string	N	身份证号AES加密
+regTime	string	N	登记时间
+purpose	string	N	来访目的

示例数据

{
"callbackType": "VISITOR_CHECK",
"data": {
"name":"encryptedName",
"mobile":"encryptedMobile",
"idcard":"encryptedIdcard",
"regTime":"2025-05-01 10:00:00",
"purpose":"参观学习"
}
}

8. 获取访客预约列表

接口地址：POST /open-api/visitor/order-list

接口说明：通过此接口获取访客预约列表。

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

body域

名称	类型	可空	描述
pageNo	int		页码
pageSize	int		每页最大1000条
faceFlag	int	Y	是否返回访客照片0不返回1返回,默认为不返回

返回数据

名称	类型	可空	描述
code	int		0成功 1失败
msg	string
result	Object		返回结果
+has_more	boolean		是否还有更多数据 true:有 false:没有
+data	Object[]
++id	string	N	预约id AES加密
++personName	string	N	访客姓名 AES加密
++personMobile	string	N	访客手机号 AES加密
++personFaceUrl	String	N	访客人脸照片url AES加密
++toPersonName	string	N	被访人姓名AES加密
++toPersonMobile	string	N	被访人手机号AES加密说明：被访人姓名为空的话被访人手机号必填
++personCompany	string	N	访客单位
++purpose	string	N	来访目的
++startTime	string	N	访问开始时间
++endTime	string	N	访问结束时间
++vehicleCodes	string[]	Y	车牌号说明：["鲁A12345","鲁B12345"]
++personNum	int	N	来访人数
++memo	string	N	备注
++checkQrcode	string	Y	访客核验码(内测字段)

示例数据

{
"code": 0,
"msg": "操作成功",
"result":{
"hasMore":true,
"data":[
{"id":"encryptedId1","personName":"encryptedName1","personMobile":"encryptedMobile1","personFaceUrl":"encryptedUrl1","toPersonName":"encryptedToName1","toPersonMobile":"encryptedToMobile1","personCompany":"公司A","purpose":"业务合作","startTime":"2025-05-01 09:00","endTime":"2025-05-01 18:00","vehicleCodes":["鲁A12345"],"personNum":2,"memo":"无","checkQrcode":"qrcode1"},
{"id":"encryptedId2","personName":"encryptedName2","personMobile":"encryptedMobile2","personFaceUrl":"encryptedUrl2","toPersonName":"encryptedToName2","toPersonMobile":"encryptedToMobile2","personCompany":"公司B","purpose":"技术交流","startTime":"2025-05-02 10:00","endTime":"2025-05-02 16:00","vehicleCodes":[],"personNum":1,"memo":"携带资料","checkQrcode":"qrcode2"}
]
}
}

9. 更新访客到访状态回调数据

接口说明：提供的回调url需接受 post application/json请求。

请求数据

header域

名称	类型	可空	描述
appKey	String	N	平台分配
timestamp	Long	N	当前时间，Unix毫秒时间戳
sign	String	N	MD5-32(appKey+timestamp+appSecret),32小写

body域

名称	类型	可空	描述
callbackType	String	N	VISITOR_CHECK
data	对象	N
+recordId	long	N	记录id
+status	String	N	0 未审核/未到访 1 审核通过/已到访 2 已拒绝/已签退
+type	string	Y	0 审核状态 1 来访状态

示例数据

{
"callbackType": "VISITOR_CHECK",
"data": {
"recordId":1234567890123456789,
"status":"1",
"type":"1"
}
}

10. 获取园区列表

接口地址：POST /open-api/visitor/park-list

接口说明：通过此接口获取组织下所有的园区数据。

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

返回数据

名称	类型	可空	描述
code	int	N	0成功 1失败
msg	string	N
result	Object	N	返回结果
+data	Object[]
++id	string		园区id
++name	String	N	园区名称

示例数据

{
"code": 0,
"msg": "操作成功",
"result":{
"data":[{"id":"132132","name":"北门园区"},{"id":"132133","name":"南门园区"}]
}
}

11. 获取魔点访客id

接口地址：POST /open-api/visitor/getMoidByVisitorId

接口说明：通过此接口获取魔点访客id。

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

body域

名称	类型	可空	默认	描述
visitorId	string	N		访客id

返回数据

名称	类型	可空	描述
code	int	N	0成功 1失败
msg	string	N
result	Object	N	返回结果
+data	Object[]
++ddVisitorId	string		魔点访客id

示例数据

{
"code": 0,
"msg": "操作成功",
"result":{
"data":[{"ddVisitorId":"132132"}]
}
}

12. 访客门禁通行回调数据

接口说明：提供的回调url需接受 post application/json请求,用于接收访客门禁通行的回调数据。。

请求数据

header域

名称	类型	可空	描述
appKey	String	N	平台分配
timestamp	Long	N	当前时间，Unix毫秒时间戳
sign	String	N	MD5-32(appKey+timestamp+appSecret),32小写

body域

名称	类型	可空	描述
callbackType	String	N	MO_DIAN_VISITOR
callbackTag	String	N	魔点回调事件
data	对象	N	回调参数，根据魔点中的回调参数，魔点文档https://open.moredian.com/#/doc/interface/1/10006/38

示例数据

{
"callbackType": "MO_DIAN_VISITOR",
"callbackTag": "VISITOR_PASS",
"data": {
"visitorId": "123456",
"deviceId": "device789",
"passTime": "2025-05-01 11:00:00",
"direction": "in"
}
}

13. 访客码核验接口

接口地址：POST /open-api/visitor/code-check

接口说明：通过此接口核验访客码有效性。

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

body域

名称	类型	可空	默认	描述
code	string	N		二维码数据

返回数据

名称	类型	可空	描述
code	int	N	0成功 1失败
msg	string	N
result	Object	N	返回结果
+data	Object[]
++checkStatus	int	N	0有效 1不在访问时间内
++visitorName	string	N	访客姓名

返回数据

{
"code": 0,
"msg": "操作成功",
"result":{
"data":[{"checkStatus":0,"visitorName":"张三"}]
}
}

14. 查询访客类型字段

接口地址：POST /open-api/visitor/query-visitor-type

接口说明：通过此接口查询访客类型字段。

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

body域：无参数

返回数据

名称	类型	可空	描述
code	int	N	0成功 1失败
msg	string	N
data	Object[]
+id	string	N	访客类型id
+name	string	N	访客类型名称

示例数据

{
"code": 0,
"msg": "操作成功",
"data" : [ {
"name" : "测试类型1",
"id" : "1087328893825720320"
}, {
"name" : "测试类型2",
"id" : "1090066155650949120"
}, {
"name" : "测试类型3",
"id" : "1103250156309979136"
} ]
}

15. 查询访客详情

接口地址：POST /open-api/visitor/get-order-record-detail

接口说明：通过此接口查询访客详情。

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

body域

名称	类型	可空	默认	描述
visitorId	string	N		访客id

返回数据

名称	类型	可空	描述
code	int	N	0成功 1失败
msg	string	N
data	Object
+personName	string	N	访客姓名 AES加密
+personMobile	string	N	访客手机号 AES加密
+personFaceUrl	String	N	访客人脸照片url AES加密
+toPersonName	string	N	被访人姓名AES加密
+visitorType	String	Y	访客类型
+toPersonMobile	string	N	被访人手机号AES加密说明：被访人姓名为空的话被访人手机号必填
+personCompany	string	N	访客单位
+purpose	string	N	来访目的
+startTime	string	N	访问开始时间
+endTime	string	N	访问结束时间
+vehicleCodes	string[]	Y	车牌号说明：["鲁A12345","鲁B12345"]
+personNum	int	N	来访人数
+memo	string	N	备注
+checkQrcode	string	Y	访客核验码(内测字段)

示例数据

{
"code": 0,
"msg": "操作成功",
"data" : {
"personName" : "g7v7xeo5lYbIzzJHructsw==",
"personMobile" : "vo0umyaJmgoHAIsN8Z1r5Q==",
"personFaceUrl" : "encryptedUrl",
"toPersonName" : "TdFrd5oKXvBvmbWX/PzD+A==",
"visitorType" : "商务访客",
"toPersonMobile" : "9t3ajqjLPeMv+1QTW69osA==",
"personCompany" : "测试单位",
"purpose" : "商务洽谈",
"startTime" : "2025-04-28 10:10",
"endTime" : "2025-04-28 23:59",
"vehicleCodes":["鲁A12345"],
"personNum" : 1,
"memo" : "无特殊备注",
"checkQrcode" : "qrcode123"
}
}

1. 提交访客信息#

2. 查询访客记录处理结果#

3. 查询到访区域列表#

4. 删除访客信息#

5. 访客机核验回调数据(内测中)#

6. 访客预约回调数据#

7. 访客登记回调数据#

8. 获取访客预约列表#

9. 更新访客到访状态回调数据#

10. 获取园区列表#

11. 获取魔点访客id#

12. 访客门禁通行回调数据#

13. 访客码核验接口#

14. 查询访客类型字段#

15. 查询访客详情#

1. 提交访客信息

2. 查询访客记录处理结果

3. 查询到访区域列表

4. 删除访客信息

5. 访客机核验回调数据(内测中)

6. 访客预约回调数据

7. 访客登记回调数据

8. 获取访客预约列表

9. 更新访客到访状态回调数据

10. 获取园区列表

11. 获取魔点访客id

12. 访客门禁通行回调数据

13. 访客码核验接口

14. 查询访客类型字段

15. 查询访客详情