访客通行

本文介绍了集智社区访客通行模块的 SDK 使用方法。包括创建访客通行证、查询通行记录、取消邀请和通行信息配置等。

功能说明

• 您需要先从房屋管理里查询当前的小区 ID。

• 相关类：

  类名	说明
  getVisitorInstance()	访客通行管理

• 来访事由数据模型 TuyaCommunityVisitorReasonBean

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

• 访客通行证信息 TuyaCommunityVisitorInfoBean

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

• 访客通行列表数据 TuyaCommunityVisitorBean

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

查询来访事由列表

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

接口说明

void getVisitorReasonList(String communityId, ITuyaCommunityResultCallback<ArrayList<TuyaCommunityVisitorReasonBean>> callback);

请求参数

参数	类型	说明
communityId	String	小区 ID

返回参数

参数	说明
onSuccess(ArrayList bean)	访问事由的列表
onFailure(String s, String s1)	s 表示错误码，s1 表示接口访问失败的详情

示例代码

TuyaCommunitySDK.getVisitorInstance().getVisitorReasonList(communityId, new ITuyaCommunityResultCallback<ArrayList<TuyaCommunityVisitorReasonBean>>() {
			@Override
			public void onSuccess(ArrayList<TuyaCommunityVisitorReasonBean> bean) {
			}

			@Override
			public void onFailure(String s, String s1) {

			}
		});

查询社区是否支持驾车通行

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

查询接口成功会返回一个boolean类型，true 为可以驾车，反则不可驾车。

接口说明

void getCarConfig(String communityId, ITuyaCommunityResultCallback<Boolean> callback);

参数说明

参数	说明
communityId	小区 ID

返回参数

参数	说明
onSuccess(Boolean aBoolean)	true：可以配置是否驾车 false：不可配置是否驾车
onFailure(String s, String s1)	s 表示错误码，s1 表示接口访问失败的详情

示例代码

TuyaCommunitySDK.getVisitorInstance().getCarConfig(communityId, new ITuyaCommunityResultCallback<Boolean>() {
			@Override
			public void onSuccess(Boolean aBoolean) {
			}

			@Override
			public void onFailure(String s, String s1) {
			}
		});

生成通行证

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

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

接口说明

void createPass(String communityId, String visitorName, String visitorPhone, int sex, String visitorReason, long startTime, long endTime, String visitorAddressId, int driveCar, @Nullable String carNum, TuyaCommunityVisitorFromEnum visitorFrom, ITuyaCommunityResultCallback<String> callback);

参数说明

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

示例代码

TuyaCommunitySDK.getVisitorInstance().createPass(communityId,visitorName,visitorPhone, TuyaCommunityGenderType.Female,visitorReason,startTime,endTime,rommId,driveCar,carNum, TuyaCommunityVisitorFromEnum.Owner,new ITuyaCommunityResultCallback<String>() {
			@Override
			public void onSuccess(String s) {
				callback.onSuccess(s);
			}

			@Override
			public void onFailure(String s, String s1) {
				callback.onFailure(s, s1);
			}
		});

取消通行

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

接口说明

void cancelPass(String communityId, String visitorId, ITuyaCommunityResultCallback<Boolean> callback);

请求参数

参数	类型	说明
communityId	String	小区 ID
visitorId	String	访客ID（通行记录列表包含此 ID）

返回参数

参数	说明
onSuccess(Boolean aBoolean)	true 为取消成功 ，false为取消失败
onFailure(String s, String s1)	s 表示错误码，s1 表示接口访问失败的详情

示例代码

TuyaCommunitySDK.getVisitorInstance().cancelPass(communityId, visitorId, new ITuyaCommunityResultCallback<Boolean>() {
			@Override
			public void onSuccess(Boolean result) {
			}

			@Override
			public void onFailure(String s, String s1) {
			}
		});

查询通行证信息

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

接口说明

void getVisitorPassInfo(String communityId, String visitorId, ITuyaCommunityResultCallback<TuyaCommunityVisitorInfoBean> callback);

请求参数

参数	类型	说明
communityId	String	小区 ID
visitorId	String	访客ID（通行记录列表包含此ID）

返回参数

参数	说明
onSuccess(TuyaCommunityVisitorInfoBean tuyaCommunityVisitorInfoBean)	返回通行详情信息
onFailure(String s, String s1)	s 表示错误码，s1 表示接口访问失败的详情

示例代码

TuyaCommunitySDK.ggetVisitorInstance().getVisitorPassInfo(communityId, visitorId, new ITuyaCommunityResultCallback<TuyaCommunityVisitorInfoBean>() {
			@Override
			public void onSuccess(TuyaCommunityVisitorInfoBean tuyaCommunityVisitorInfoBean) {
			}

			@Override
			public void onFailure(String s, String s1) {
			}
		});

访客通行记录

此接口可查看该账号下所有的通信信息，包括未到访、逾期未到访、已取消和已到访状态下的数据。因为记录的数据较多，所以需要用到分页加载。

接口说明

void getVisitorRecordList(String communityId, String roomId, int pageNo, int pageSize, ITuyaCommunityResultCallback<TuyaCommunityVisitorRecordListBean> callback);

请求参数

参数	类型	说明
communityId	String	小区 ID
roomId	String	房号 ID
pageNo	int	分页的第几页
pageSize	int	每页的数量

返回参数

参数	说明
onSuccess(TuyaCommunityVisitorRecordListBean bean	返回的通行证列表
onFailure(String s, String s1)	s 表示错误码，s1 表示接口访问失败的详情

示例代码

TuyaCommunitySDK.getVisitorInstance().getVisitorRecordList(communityId, roomId, pageNo, pageSize,
				new ITuyaCommunityResultCallback<TuyaCommunityVisitorRecordListBean>() {
					@Override
					public void onSuccess(TuyaCommunityVisitorRecordListBean bean) {
					}

					@Override
					public void onFailure(String s, String s1) {

					}
				});