访客登记（预约）

功能描述

社区访客预约登记。

若访客权限在设备上下发失败，将通过访客门禁权限下发状态订阅消息进行通知。

返回码

返回码	返回消息	描述
510001	参数错误	必填项为空、参数长度不符合等参数异常情况
511015	手机格式错误
511033	没有该设备权限
511036	日期校验失败	日期格式不合法
511037	请选择您自己的户室
511045	所选户室不存在
511049	离开时间不能早于当前时间
511050	离开时间不能早于来访时间
511051	访客预约时长不能超过72小时
511052	访客姓名需在2~10个字符间
511058	预约人员不存在
511059	租户信息不匹配	不能预约其他租户的房屋
511081	查询人员信息失败
511138	设备列表参数格式错误
511150	房屋和设备参数不能同时为空
511151	不支持一次为多个小区预约访客

curl --location --request POST 'https://api2.hik-cloud.com/api/v1/estate/visitors' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data-raw '{ "personId": "00a795f4a25d4de09edd091f28747eb4", "personType": 1, "visitorName": "张三", "gender": 1, "phone": "13325478454", "roomId": "00a795f4a25d4de09edd091f28747eb4", "visitorEffectiveTime": "2018-01-01T12:00:00+08:00", "visitorLeaveTime": "2018-01-02T12:00:00+08:00", "visitReason": "访问故友", "deviceIds": "00a795f4a25d4de09edd091f28747eb4,00a795f4a25d4de09edd091f28747eb4", "openTimes": 1 }'

{ "code": 200, "message": "操作成功", "data": { "reservationId": "00a795f4a25d4de09edd091f28747eb4", "visitorCode": "VjAwMSuk5WP0ZGlMa9WVEbhsLHro4vInm5BfCyn3dBgU3LrjvnYiKbgt6OLvA4UhH0h/wLY=" } }

请求参数

Header 参数

Authorization

string

可选

默认值:

Bearer {{access_token}}

Body 参数application/json

personId

string

人员ID

必需

personType

integer

人员类型

必需

[0]物业;[1]住户;

visitorName

string

访客姓名

必需

gender

integer

访客性别

必需

[0]女[1]男

phone

string

访客手机号

必需

roomId

string

访问的户室ID

必需

visitorEffectiveTime

string

来访开始时间（UTC+08:00）

必需

visitorLeaveTime

string

离开时间（UTC+08:00）

必需

离开时间和开始时间差不能超过3天

visitReason

string

访问原由

可选

deviceIds

string

需要下发访客权限的设备列表

可选

指定需要下发访客权限的设备列表,如有多个以英文逗号分隔

openTimes

integer

二维码开门次数

可选

最大支持9次，不填默认可使用4次

示例

application/json

Body

code

integer

返回码

必需

message

string

返回消息

必需

data

object

节点对象

必需

reservationId

string

预约记录id

必需

visitorCode

string

加密二维码信息

必需

请求参数

返回响应