简体中文
简体中文
English
联系我们
注册
登录
layout空间导航

访客通行

更新时间:2022-02-17 06:50:02下载pdf

功能介绍

TuyaCommunityVisitorService 用于访客通行的一些操作服务,包括创建访客通行证、查询是否驾车、查询通行证信息、查询访客事由列表、访客记录、删除邀请等 API。

查询来访事由列表

在提交访客信息生成通行证时,需要上传来访的事由,这些事由是动态配置,需要从接口进行查询。

接口说明

- (void)getVisitorReasonListWithCommunityId:(NSString *)communityId
                                    success:(void(^)(NSArray<TuyaCommunityVisitorReasonModel *> *list))success
                                    failure:(void(^)(NSError *error))failure;

请求参数

参数 说明
communityId 小区 ID,可以从 TuyaCommunityHouseModel 中查询到

返回参数

参数 说明
success 请求成功后,返回访客通行的访客事由列表 NSArray<TuyaCommunityVisitorReasonModel *> *list
failure 失败回调,回调中展示失败原因

示例代码

     TuyaCommunityHouseModel *houseModel = <#从房屋列表接口中查询的当前登录的其中一个家庭#>;
    [self.service getVisitorReasonListWithCommunityId:houseModel.communityId success:^(NSArray<TuyaCommunityVisitorReasonModel *> * _Nonnull list) {
            // success handler
    } failure:^(NSError * _Nonnull error) {
            // failure handler
    }];

查询社区是否支持驾车

在提交访客信息生成通行证时,需要提交访客是否驾车的信息。此接口可以查询当前小区是否支持驾车通行。

查询接口成功会返回一个布尔类型,True 为可以驾车,反则不可驾车。

接口说明

 - (void)getCarConfigWithCommunityId:(NSString *)communityId
                            success:(void(^)(BOOL hasCar))success
                            failure:(void(^)(NSError *error))failure;

参数说明

参数 说明
communityId 小区 ID

返回参数

参数 说明
success(BOOL hasCar) true 为可以配置是否驾车,false为不可配置是否驾车
failure 失败回调,回调中展示失败原因

示例代码

    TuyaCommunityHouseModel *houseModel = <#从房屋列表接口中查询的当前登录的其中一个家庭#>;
    [self.service getCarConfigWithCommunityId:houseModel.communityId success:^(BOOL hasCar) {
         // success handler
    } failure:^(NSError * _Nonnull error) {
          // failure handler
    }];

生成通行证

提交姓名、性别、手机号码和来访事由等信息,可以生成一条访客通行证。

是否驾车和来访事由列表可以由以上接口进行查询。

接口说明

- (void)createPassWithCommunityId:(NSString *)communityId
                      visitorName:(NSString *)visitorName
                     visitorPhone:(NSString *)visitorPhone
                              sex:(NSInteger)sex
                    visitorReason:(NSString *)visitorReason
                        startTime:(long long)startTime
                          endTime:(long long)endTime
                 visitorAddressId:(NSString *)visitorAddressId
                         driveCar:(NSInteger)driveCar
                           carNum:(NSString * _Nullable)carNum
                      visitorFrom:(TuyaCommunityVisitorFromEnum)visitorForm
                          success:(void(^)(NSString *visitorId))success
                          failure:(void(^)(NSError *error))failure;

参数说明

参数 是否必填 类型 说明
communityId NSString 小区 ID,从TuyaCommunityHouseModel中查询communityId
visitorName NSString 访客的姓名
visitorPhone NSString 访客的手机号码
sex int 访客性别,0 表示男,1 表示女
visitorReasonId NSString 来访原因 ID
startTime long 来访时间
endTime long 离开时间
roomId NSString 房屋ID
driveCar int 是否开车:
1:是
2:否
需要先访问是否驾车的接口,如果返回的true,这里才可以配置是否开车,否则上传无效
carNum NSString 车牌号。车访时为必填参数
visitorFrom enum(TuyaCommunityVisitorFromEnum) 访客来源:
1:物业登记
2:业主邀请

示例代码

 TuyaCommunityHouseModel *houseModel = <#从房屋列表接口中查询的当前登录的其中一个家庭#>;
[self.service createPassWithCommunityId:houseModel.communityId visitorName:nameStr visitorPhone:phoneNumberStr sex:1 visitorReason:visitorReason startTime:startTime endTime:endTime visitorAddressId:houseModel.roomId driveCar:0 carNum:@"xxxx" visitorFrom:2 success:^(NSString * _Nonnull visitorId) {
    // success handler
} failure:^(NSError * _Nonnull error) {
    // failure handler
}];

删除邀请

在访客到访开始时间之前,可以对提出的访客通行进行取消,取消后该访客则不能通行,可重新进行申请。

接口说明

- (void)deletePassWithCommunityId:(NSString *)communityId
                        visitorId:(NSString *)visitorId
                          success:(void(^)(BOOL rs))success
                          failure:(void(^)(NSError *error))failure;

请求参数

参数 类型 说明
communityId NSString 小区 ID
visitorId NSString 访客 ID(通行记录列表包含此 ID)

返回参数

参数 说明
success true 为删除成功,false 为取消失败
failure 失败回调

示例代码

[self.service deletePassWithCommunityId:communityId
                         visitorId:visitorId
                           success:(void(^)(BOOL rs)) {
    // success handler
} failure:^(NSError * _Nonnull error) {
    // failure handler
}];

查询通行证信息

查看某条通行证详情信息,包括是否到访、姓名、性别、开始时间、结束时间和到访地等。

接口说明

- (void)getVisitorPassInfoWithCommunityId:(NSString *)communityId
                                visitorId:(NSString *)visitorId
                                  success:(void(^)(TuyaCommunityVisitorInfoModel *result))success
                                  failure:(void(^)(NSError *error))failure;

请求参数

参数 类型 说明
communityId NSString 小区 ID
visitorId NSString 访客 ID(通行记录列表和访客生成包含此 ID)

返回参数

参数 说明
success(TuyaCommunityVisitorInfoModel *model) 返回通行详情信息
failure 失败回调

示例代码

TuyaCommunityHouseModel *houseModel = <#从房屋列表接口中查询的当前登录的其中一个家庭#>;
[self.service getVisitorPassInfoWithCommunityId:houseModel.communityId visitorId:visitorId success:^(TuyaCommunityVisitorInfoModel * _Nonnull result) {

	// success handler
} failure:^(NSError * _Nonnull error) {
	// failure handler
}];

访客通行记录

此接口可查看该账号下所有的通行信息,包括未到访、逾期未到访、已取消和已到访状态下的数据。

数据较多,需要用到分页加载。

接口说明

 - (void)getVisitorRecordListWithCommunityId:(NSString *)communityId
                                      roomId:(NSString *)roomId
                                      pageNo:(NSInteger)pageNo
                                    pageSize:(NSInteger)pageSize
                                     success:(void(^)(TuyaCommunityVisitorRecordListModel *result))success
                                     failure:(void(^)(NSError *error))failure;

请求参数

参数 说明
communityId 小区 ID,可以从 TuyaCommunityHouseModel 中查询到
roomId 房号ID,从TuyaCommunityHouseModel中查询roomId,下同
pageNo 分页的第几页
pageSize 每页的数量

返回参数

参数 说明
success(TuyaCommunityVisitorRecordListModel *result 返回的通行证列表
failure 失败回调

示例代码

TuyaCommunityHouseModel *houseModel = <#从房屋列表接口中查询的当前登录的其中一个家庭#>;
[self.service getVisitorRecordListWithCommunityId:houseModel.communityId roomId:houseModel.roomId pageNo:pageNo pageSize:pageSize success:^(TuyaCommunityVisitorRecordListModel * _Nonnull result) {
	// success handler
} failure:^(NSError * _Nonnull error) {
	// failure handler
}];

对象说明

TuyaCommunityVisitorReasonModel

来访事由数据模型

属性 类型 说明
visitorReasonId NSString 访问事由 ID
visitorReason NSString 访问事由
remark NSString 备注
timeLimitType int 时间限制类型
1:小时
2:天
3:不限
timeLimitValue int 时间限制值

TuyaCommunityVisitorInfoModel

访客通行证信息

属性 类型 说明
visitorId NSString 访客 ID
visitorName NSString 访客姓名
visitorPhone NSString 访客电话
sex NSString 访客性别,0 表示男,1 表示女
visitorReason NSString 访问事由
visitorAddressId NSString 访问地址 ID(同房号下的roomId)
visitorAddress NSString 访问地址
visitorTime long 访问时间
visitorStatus int 访问状态
0:未到访
1:已到访
2:逾期未到访
visitorFrom int 访客来源:
1:物业登记
2:业主邀请
hasCar int 是否有车 1是2否
carNum NSString 车牌号
visitorFace NSString 访客人脸
startTime long long 访问开始时间
endTime long long 访问结束时间
intervieweeName NSString 受访人的姓名
intervieweePhone NSString 受访人的手机
visitorCapabilityList NSArray<NSNumber > 可以进行访客的方式
1:二维码
2:人脸

TuyaCommunityVisitorRecordListModel

访客通行列表数据

属性 类型 说明
visitorId NSString 访客 ID
visitorName NSString 访客姓名
phone NSString 访客电话
sex NSString 访客性别
0:表示男
1:表示女
visitorReason NSString 访问事由
visitorAddress NSString 访问地址
intervieweeName NSString 受访人姓名
intervieweePhone NSString 受访人手机号码
visitorTime long long 访问时间
visitorStatus int 访问状态
0:未到访
1:已到访
2:逾期未到访
visitorStatusStr NSString 访问状态String
visitorFrom int 访客来源:
1:物业登记
2:业主邀请
applyTime long long 申请时间
startTime long long 访问开始时间
endTime long long 访问结束时间
carNum NSString 车牌号