com.tencentcloudapi.ess.v20201111.models.FlowCreateApprover Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-ess Show documentation
Show all versions of tencentcloud-sdk-java-ess Show documentation
Tencent Cloud Open API SDK for Java
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.ess.v20201111.models;
import com.tencentcloudapi.common.AbstractModel;
import com.tencentcloudapi.common.SSEResponseModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class FlowCreateApprover extends AbstractModel {
/**
* 在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下：
- 0 :企业B端。
- 1 :个人C端。
- 3 :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考自动签署使用说明文档。
- 7 :个人C端自动签署，适用于个人自动签场景。注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。
*/
@SerializedName("ApproverType")
@Expose
private Long ApproverType;
/**
* 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定`
*/
@SerializedName("OrganizationName")
@Expose
private String OrganizationName;
/**
* 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
在未指定签署人电子签UserId情况下，为必填参数
*/
@SerializedName("ApproverName")
@Expose
private String ApproverName;
/**
* 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。
注：`在未指定签署人电子签UserId情况下，为必填参数`
*/
@SerializedName("ApproverMobile")
@Expose
private String ApproverMobile;
/**
* 证件类型，支持以下类型
- ID_CARD: 居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
*/
@SerializedName("ApproverIdCardType")
@Expose
private String ApproverIdCardType;
/**
* 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
*/
@SerializedName("ApproverIdCardNumber")
@Expose
private String ApproverIdCardNumber;
/**
* 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
模板发起合同时，该参数为必填项，可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。
文件发起合同时，该参数无需传值。
如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。
*/
@SerializedName("RecipientId")
@Expose
private String RecipientId;
/**
* 签署意愿确认渠道，默认为WEIXINAPP:人脸识别
注: 将要废弃, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置`
*/
@SerializedName("VerifyChannel")
@Expose
private String [] VerifyChannel;
/**
* 通知签署方经办人的方式, 有以下途径:
- **sms** : (默认)短信
- **none** : 不通知
注: `既是发起方又是签署方时，不给此签署方发送短信`
*/
@SerializedName("NotifyType")
@Expose
private String NotifyType;
/**
* 合同强制需要阅读全文，无需传此参数
*/
@SerializedName("IsFullText")
@Expose
private Boolean IsFullText;
/**
* 签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。
若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：
- 合同页数少于等于2页，阅读时间为3秒；
- 合同页数为3到5页，阅读时间为5秒；
- 合同页数大于等于6页，阅读时间为10秒。
*/
@SerializedName("PreReadTime")
@Expose
private Long PreReadTime;
/**
* 签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得
注：
如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）
*/
@SerializedName("UserId")
@Expose
private String UserId;
/**
* 字段已经废弃，当前只支持true，默认为true
*/
@SerializedName("Required")
@Expose
private Boolean Required;
/**
* 在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。
*/
@SerializedName("ApproverSource")
@Expose
private String ApproverSource;
/**
* 在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。
所有参与或签的人员均需具备该标识。
注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。
如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。
*/
@SerializedName("CustomApproverTag")
@Expose
private String CustomApproverTag;
/**
* 已经废弃, 快速注册相关信息
*/
@SerializedName("RegisterInfo")
@Expose
private RegisterInfo RegisterInfo;
/**
* 签署人个性化能力值，如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。
*/
@SerializedName("ApproverOption")
@Expose
private ApproverOption ApproverOption;
/**
* 签署完前端跳转的url，暂未使用
*/
@SerializedName("JumpUrl")
@Expose
private String JumpUrl;
/**
* 签署人的签署ID
- 在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数，电子签后台系统会自动生成。
- 在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时，可以通过查询详情接口获取签署人的SignId，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。
*/
@SerializedName("SignId")
@Expose
private String SignId;
/**
* 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
*/
@SerializedName("ApproverNeedSignReview")
@Expose
private Boolean ApproverNeedSignReview;
/**
* 签署人签署控件， 此参数仅针对文件发起（CreateFlowByFiles）生效
合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
- 个人签名/印章
- 企业印章
- 骑缝章等签署控件
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
*/
@SerializedName("SignComponents")
@Expose
private Component [] SignComponents;
/**
* 签署人填写控件 此参数仅针对文件发起（CreateFlowByFiles）生效
合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 动态表格等填写控件
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
*/
@SerializedName("Components")
@Expose
private Component [] Components;
/**
* 当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：
- HANDWRITE :需要实时手写的手写签名。
- HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)
- OCR_ESIGN :AI智能识别手写签名。
- ESIGN :个人印章类型。
- IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。
- SYSTEM_ESIGN :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。
各种签名的样式可以参考下图：
*/
@SerializedName("ComponentLimitType")
@Expose
private String [] ComponentLimitType;
/**
* 指定个人签署方查看合同的校验方式,可以传值如下:
- **1** : （默认）人脸识别,人脸识别后才能合同内容
- **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
注:
- 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
- 此字段可传多个校验方式
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
.
*/
@SerializedName("ApproverVerifyTypes")
@Expose
private Long [] ApproverVerifyTypes;
/**
* 您可以指定签署方签署合同的认证校验方式，可传递以下值：
- **1**：人脸认证，需进行人脸识别成功后才能签署合同；
- **2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；
- **3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。（如果是港澳台客户，建议不要选择这个）
- **5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式）
- **6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式）
注：
- 默认情况下，认证校验方式为人脸认证和签署密码两种形式；
- 您可以传递多种值，表示可用多种认证校验方式。
- 校验方式不允许只包含设备指纹识别和设备面容识别，至少需要再增加一种其他校验方式。
- 设备指纹识别和设备面容识别只支持小程序使用，其他端暂不支持。
注:
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
*/
@SerializedName("ApproverSignTypes")
@Expose
private Long [] ApproverSignTypes;
/**
* 生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
- **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；
- **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。
注：
`不指定该值时，默认为签署方自行选择。`
*/
@SerializedName("SignTypeSelector")
@Expose
private Long SignTypeSelector;
/**
* 签署人的签署截止时间，格式为Unix标准时间戳（秒）, 超过此时间未签署的合同变成已过期状态，不能在继续签署
注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
*/
@SerializedName("Deadline")
@Expose
private Long Deadline;
/**
* 只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。
您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。
注意：
1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。
2. 使用视频认证时，生成H5签署链接必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。
3. 签署完成后，可以通过查询签署认证人脸视频获取到当时的视频。
*/
@SerializedName("Intention")
@Expose
private Intention Intention;
/**
* Get 在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下：
- 0 :企业B端。
- 1 :个人C端。
- 3 :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考自动签署使用说明文档。
- 7 :个人C端自动签署，适用于个人自动签场景。注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。
* @return ApproverType 在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下：
- 0 :企业B端。
- 1 :个人C端。
- 3 :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考自动签署使用说明文档。
- 7 :个人C端自动签署，适用于个人自动签场景。注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。
*/
public Long getApproverType() {
return this.ApproverType;
}
/**
* Set 在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下：
- 0 :企业B端。
- 1 :个人C端。
- 3 :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考自动签署使用说明文档。
- 7 :个人C端自动签署，适用于个人自动签场景。注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。
* @param ApproverType 在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下：
- 0 :企业B端。
- 1 :个人C端。
- 3 :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考自动签署使用说明文档。
- 7 :个人C端自动签署，适用于个人自动签场景。注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。
*/
public void setApproverType(Long ApproverType) {
this.ApproverType = ApproverType;
}
/**
* Get 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定`
* @return OrganizationName 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定`
*/
public String getOrganizationName() {
return this.OrganizationName;
}
/**
* Set 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定`
* @param OrganizationName 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定`
*/
public void setOrganizationName(String OrganizationName) {
this.OrganizationName = OrganizationName;
}
/**
* Get 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
在未指定签署人电子签UserId情况下，为必填参数
* @return ApproverName 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
在未指定签署人电子签UserId情况下，为必填参数
*/
public String getApproverName() {
return this.ApproverName;
}
/**
* Set 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
在未指定签署人电子签UserId情况下，为必填参数
* @param ApproverName 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
在未指定签署人电子签UserId情况下，为必填参数
*/
public void setApproverName(String ApproverName) {
this.ApproverName = ApproverName;
}
/**
* Get 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。
注：`在未指定签署人电子签UserId情况下，为必填参数`
* @return ApproverMobile 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。
注：`在未指定签署人电子签UserId情况下，为必填参数`
*/
public String getApproverMobile() {
return this.ApproverMobile;
}
/**
* Set 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。
注：`在未指定签署人电子签UserId情况下，为必填参数`
* @param ApproverMobile 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。
注：`在未指定签署人电子签UserId情况下，为必填参数`
*/
public void setApproverMobile(String ApproverMobile) {
this.ApproverMobile = ApproverMobile;
}
/**
* Get 证件类型，支持以下类型
- ID_CARD: 居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
* @return ApproverIdCardType 证件类型，支持以下类型
- ID_CARD: 居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
*/
public String getApproverIdCardType() {
return this.ApproverIdCardType;
}
/**
* Set 证件类型，支持以下类型
- ID_CARD: 居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
* @param ApproverIdCardType 证件类型，支持以下类型
- ID_CARD: 居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
*/
public void setApproverIdCardType(String ApproverIdCardType) {
this.ApproverIdCardType = ApproverIdCardType;
}
/**
* Get 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
* @return ApproverIdCardNumber 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
*/
public String getApproverIdCardNumber() {
return this.ApproverIdCardNumber;
}
/**
* Set 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
* @param ApproverIdCardNumber 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
*/
public void setApproverIdCardNumber(String ApproverIdCardNumber) {
this.ApproverIdCardNumber = ApproverIdCardNumber;
}
/**
* Get 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
模板发起合同时，该参数为必填项，可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。
文件发起合同时，该参数无需传值。
如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。
* @return RecipientId 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
模板发起合同时，该参数为必填项，可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。
文件发起合同时，该参数无需传值。
如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。
*/
public String getRecipientId() {
return this.RecipientId;
}
/**
* Set 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
模板发起合同时，该参数为必填项，可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。
文件发起合同时，该参数无需传值。
如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。
* @param RecipientId 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
模板发起合同时，该参数为必填项，可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。
文件发起合同时，该参数无需传值。
如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。
*/
public void setRecipientId(String RecipientId) {
this.RecipientId = RecipientId;
}
/**
* Get 签署意愿确认渠道，默认为WEIXINAPP:人脸识别
注: 将要废弃, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置`
* @return VerifyChannel 签署意愿确认渠道，默认为WEIXINAPP:人脸识别
注: 将要废弃, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置`
*/
public String [] getVerifyChannel() {
return this.VerifyChannel;
}
/**
* Set 签署意愿确认渠道，默认为WEIXINAPP:人脸识别
注: 将要废弃, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置`
* @param VerifyChannel 签署意愿确认渠道，默认为WEIXINAPP:人脸识别
注: 将要废弃, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置`
*/
public void setVerifyChannel(String [] VerifyChannel) {
this.VerifyChannel = VerifyChannel;
}
/**
* Get 通知签署方经办人的方式, 有以下途径:
- **sms** : (默认)短信
- **none** : 不通知
注: `既是发起方又是签署方时，不给此签署方发送短信`
* @return NotifyType 通知签署方经办人的方式, 有以下途径:
- **sms** : (默认)短信
- **none** : 不通知
注: `既是发起方又是签署方时，不给此签署方发送短信`
*/
public String getNotifyType() {
return this.NotifyType;
}
/**
* Set 通知签署方经办人的方式, 有以下途径:
- **sms** : (默认)短信
- **none** : 不通知
注: `既是发起方又是签署方时，不给此签署方发送短信`
* @param NotifyType 通知签署方经办人的方式, 有以下途径:
- **sms** : (默认)短信
- **none** : 不通知
注: `既是发起方又是签署方时，不给此签署方发送短信`
*/
public void setNotifyType(String NotifyType) {
this.NotifyType = NotifyType;
}
/**
* Get 合同强制需要阅读全文，无需传此参数
* @return IsFullText 合同强制需要阅读全文，无需传此参数
*/
public Boolean getIsFullText() {
return this.IsFullText;
}
/**
* Set 合同强制需要阅读全文，无需传此参数
* @param IsFullText 合同强制需要阅读全文，无需传此参数
*/
public void setIsFullText(Boolean IsFullText) {
this.IsFullText = IsFullText;
}
/**
* Get 签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。
若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：
- 合同页数少于等于2页，阅读时间为3秒；
- 合同页数为3到5页，阅读时间为5秒；
- 合同页数大于等于6页，阅读时间为10秒。
* @return PreReadTime 签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。
若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：
- 合同页数少于等于2页，阅读时间为3秒；
- 合同页数为3到5页，阅读时间为5秒；
- 合同页数大于等于6页，阅读时间为10秒。
*/
public Long getPreReadTime() {
return this.PreReadTime;
}
/**
* Set 签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。
若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：
- 合同页数少于等于2页，阅读时间为3秒；
- 合同页数为3到5页，阅读时间为5秒；
- 合同页数大于等于6页，阅读时间为10秒。
* @param PreReadTime 签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。
若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：
- 合同页数少于等于2页，阅读时间为3秒；
- 合同页数为3到5页，阅读时间为5秒；
- 合同页数大于等于6页，阅读时间为10秒。
*/
public void setPreReadTime(Long PreReadTime) {
this.PreReadTime = PreReadTime;
}
/**
* Get 签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得
注：
如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）
* @return UserId 签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得
注：
如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）
*/
public String getUserId() {
return this.UserId;
}
/**
* Set 签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得
注：
如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）
* @param UserId 签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得
注：
如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）
*/
public void setUserId(String UserId) {
this.UserId = UserId;
}
/**
* Get 字段已经废弃，当前只支持true，默认为true
* @return Required 字段已经废弃，当前只支持true，默认为true
*/
public Boolean getRequired() {
return this.Required;
}
/**
* Set 字段已经废弃，当前只支持true，默认为true
* @param Required 字段已经废弃，当前只支持true，默认为true
*/
public void setRequired(Boolean Required) {
this.Required = Required;
}
/**
* Get 在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。
* @return ApproverSource 在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。
*/
public String getApproverSource() {
return this.ApproverSource;
}
/**
* Set 在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。
* @param ApproverSource 在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。
*/
public void setApproverSource(String ApproverSource) {
this.ApproverSource = ApproverSource;
}
/**
* Get 在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。
所有参与或签的人员均需具备该标识。
注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。
如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。
* @return CustomApproverTag 在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。
所有参与或签的人员均需具备该标识。
注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。
如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。
*/
public String getCustomApproverTag() {
return this.CustomApproverTag;
}
/**
* Set 在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。
所有参与或签的人员均需具备该标识。
注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。
如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。
* @param CustomApproverTag 在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。
所有参与或签的人员均需具备该标识。
注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。
如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。
*/
public void setCustomApproverTag(String CustomApproverTag) {
this.CustomApproverTag = CustomApproverTag;
}
/**
* Get 已经废弃, 快速注册相关信息
* @return RegisterInfo 已经废弃, 快速注册相关信息
*/
public RegisterInfo getRegisterInfo() {
return this.RegisterInfo;
}
/**
* Set 已经废弃, 快速注册相关信息
* @param RegisterInfo 已经废弃, 快速注册相关信息
*/
public void setRegisterInfo(RegisterInfo RegisterInfo) {
this.RegisterInfo = RegisterInfo;
}
/**
* Get 签署人个性化能力值，如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。
* @return ApproverOption 签署人个性化能力值，如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。
*/
public ApproverOption getApproverOption() {
return this.ApproverOption;
}
/**
* Set 签署人个性化能力值，如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。
* @param ApproverOption 签署人个性化能力值，如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。
*/
public void setApproverOption(ApproverOption ApproverOption) {
this.ApproverOption = ApproverOption;
}
/**
* Get 签署完前端跳转的url，暂未使用
* @return JumpUrl 签署完前端跳转的url，暂未使用
* @deprecated
*/
@Deprecated
public String getJumpUrl() {
return this.JumpUrl;
}
/**
* Set 签署完前端跳转的url，暂未使用
* @param JumpUrl 签署完前端跳转的url，暂未使用
* @deprecated
*/
@Deprecated
public void setJumpUrl(String JumpUrl) {
this.JumpUrl = JumpUrl;
}
/**
* Get 签署人的签署ID
- 在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数，电子签后台系统会自动生成。
- 在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时，可以通过查询详情接口获取签署人的SignId，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。
* @return SignId 签署人的签署ID
- 在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数，电子签后台系统会自动生成。
- 在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时，可以通过查询详情接口获取签署人的SignId，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。
*/
public String getSignId() {
return this.SignId;
}
/**
* Set 签署人的签署ID
- 在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数，电子签后台系统会自动生成。
- 在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时，可以通过查询详情接口获取签署人的SignId，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。
* @param SignId 签署人的签署ID
- 在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数，电子签后台系统会自动生成。
- 在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时，可以通过查询详情接口获取签署人的SignId，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。
*/
public void setSignId(String SignId) {
this.SignId = SignId;
}
/**
* Get 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
* @return ApproverNeedSignReview 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
*/
public Boolean getApproverNeedSignReview() {
return this.ApproverNeedSignReview;
}
/**
* Set 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
* @param ApproverNeedSignReview 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
*/
public void setApproverNeedSignReview(Boolean ApproverNeedSignReview) {
this.ApproverNeedSignReview = ApproverNeedSignReview;
}
/**
* Get 签署人签署控件， 此参数仅针对文件发起（CreateFlowByFiles）生效
合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
- 个人签名/印章
- 企业印章
- 骑缝章等签署控件
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
* @return SignComponents 签署人签署控件， 此参数仅针对文件发起（CreateFlowByFiles）生效
合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
- 个人签名/印章
- 企业印章
- 骑缝章等签署控件
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
*/
public Component [] getSignComponents() {
return this.SignComponents;
}
/**
* Set 签署人签署控件， 此参数仅针对文件发起（CreateFlowByFiles）生效
合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
- 个人签名/印章
- 企业印章
- 骑缝章等签署控件
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
* @param SignComponents 签署人签署控件， 此参数仅针对文件发起（CreateFlowByFiles）生效
合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
- 个人签名/印章
- 企业印章
- 骑缝章等签署控件
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
*/
public void setSignComponents(Component [] SignComponents) {
this.SignComponents = SignComponents;
}
/**
* Get 签署人填写控件 此参数仅针对文件发起（CreateFlowByFiles）生效
合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 动态表格等填写控件
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
* @return Components 签署人填写控件 此参数仅针对文件发起（CreateFlowByFiles）生效
合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 动态表格等填写控件
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
*/
public Component [] getComponents() {
return this.Components;
}
/**
* Set 签署人填写控件 此参数仅针对文件发起（CreateFlowByFiles）生效
合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 动态表格等填写控件
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
* @param Components 签署人填写控件 此参数仅针对文件发起（CreateFlowByFiles）生效
合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 动态表格等填写控件
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
*/
public void setComponents(Component [] Components) {
this.Components = Components;
}
/**
* Get 当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：
- HANDWRITE :需要实时手写的手写签名。
- HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)
- OCR_ESIGN :AI智能识别手写签名。
- ESIGN :个人印章类型。
- IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。
- SYSTEM_ESIGN :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。
各种签名的样式可以参考下图：
* @return ComponentLimitType 当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：
- HANDWRITE :需要实时手写的手写签名。
- HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)
- OCR_ESIGN :AI智能识别手写签名。
- ESIGN :个人印章类型。
- IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。
- SYSTEM_ESIGN :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。
各种签名的样式可以参考下图：
*/
public String [] getComponentLimitType() {
return this.ComponentLimitType;
}
/**
* Set 当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：
- HANDWRITE :需要实时手写的手写签名。
- HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)
- OCR_ESIGN :AI智能识别手写签名。
- ESIGN :个人印章类型。
- IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。
- SYSTEM_ESIGN :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。
各种签名的样式可以参考下图：
* @param ComponentLimitType 当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：
- HANDWRITE :需要实时手写的手写签名。
- HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)
- OCR_ESIGN :AI智能识别手写签名。
- ESIGN :个人印章类型。
- IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。
- SYSTEM_ESIGN :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。
各种签名的样式可以参考下图：
*/
public void setComponentLimitType(String [] ComponentLimitType) {
this.ComponentLimitType = ComponentLimitType;
}
/**
* Get 指定个人签署方查看合同的校验方式,可以传值如下:
- **1** : （默认）人脸识别,人脸识别后才能合同内容
- **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
注:
- 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
- 此字段可传多个校验方式
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
.
* @return ApproverVerifyTypes 指定个人签署方查看合同的校验方式,可以传值如下:
- **1** : （默认）人脸识别,人脸识别后才能合同内容
- **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
注:
- 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
- 此字段可传多个校验方式
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
.
*/
public Long [] getApproverVerifyTypes() {
return this.ApproverVerifyTypes;
}
/**
* Set 指定个人签署方查看合同的校验方式,可以传值如下:
- **1** : （默认）人脸识别,人脸识别后才能合同内容
- **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
注:
- 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
- 此字段可传多个校验方式
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
.
* @param ApproverVerifyTypes 指定个人签署方查看合同的校验方式,可以传值如下:
- **1** : （默认）人脸识别,人脸识别后才能合同内容
- **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
注:
- 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
- 此字段可传多个校验方式
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
.
*/
public void setApproverVerifyTypes(Long [] ApproverVerifyTypes) {
this.ApproverVerifyTypes = ApproverVerifyTypes;
}
/**
* Get 您可以指定签署方签署合同的认证校验方式，可传递以下值：
- **1**：人脸认证，需进行人脸识别成功后才能签署合同；
- **2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；
- **3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。（如果是港澳台客户，建议不要选择这个）
- **5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式）
- **6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式）
注：
- 默认情况下，认证校验方式为人脸认证和签署密码两种形式；
- 您可以传递多种值，表示可用多种认证校验方式。
- 校验方式不允许只包含设备指纹识别和设备面容识别，至少需要再增加一种其他校验方式。
- 设备指纹识别和设备面容识别只支持小程序使用，其他端暂不支持。
注:
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
* @return ApproverSignTypes 您可以指定签署方签署合同的认证校验方式，可传递以下值：
- **1**：人脸认证，需进行人脸识别成功后才能签署合同；
- **2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；
- **3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。（如果是港澳台客户，建议不要选择这个）
- **5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式）
- **6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式）
注：
- 默认情况下，认证校验方式为人脸认证和签署密码两种形式；
- 您可以传递多种值，表示可用多种认证校验方式。
- 校验方式不允许只包含设备指纹识别和设备面容识别，至少需要再增加一种其他校验方式。
- 设备指纹识别和设备面容识别只支持小程序使用，其他端暂不支持。
注:
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
*/
public Long [] getApproverSignTypes() {
return this.ApproverSignTypes;
}
/**
* Set 您可以指定签署方签署合同的认证校验方式，可传递以下值：
- **1**：人脸认证，需进行人脸识别成功后才能签署合同；
- **2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；
- **3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。（如果是港澳台客户，建议不要选择这个）
- **5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式）
- **6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式）
注：
- 默认情况下，认证校验方式为人脸认证和签署密码两种形式；
- 您可以传递多种值，表示可用多种认证校验方式。
- 校验方式不允许只包含设备指纹识别和设备面容识别，至少需要再增加一种其他校验方式。
- 设备指纹识别和设备面容识别只支持小程序使用，其他端暂不支持。
注:
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
* @param ApproverSignTypes 您可以指定签署方签署合同的认证校验方式，可传递以下值：
- **1**：人脸认证，需进行人脸识别成功后才能签署合同；
- **2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；
- **3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。（如果是港澳台客户，建议不要选择这个）
- **5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式）
- **6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式）
注：
- 默认情况下，认证校验方式为人脸认证和签署密码两种形式；
- 您可以传递多种值，表示可用多种认证校验方式。
- 校验方式不允许只包含设备指纹识别和设备面容识别，至少需要再增加一种其他校验方式。
- 设备指纹识别和设备面容识别只支持小程序使用，其他端暂不支持。
注:
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
*/
public void setApproverSignTypes(Long [] ApproverSignTypes) {
this.ApproverSignTypes = ApproverSignTypes;
}
/**
* Get 生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
- **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；
- **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。
注：
`不指定该值时，默认为签署方自行选择。`
* @return SignTypeSelector 生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
- **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；
- **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。
注：
`不指定该值时，默认为签署方自行选择。`
*/
public Long getSignTypeSelector() {
return this.SignTypeSelector;
}
/**
* Set 生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
- **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；
- **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。
注：
`不指定该值时，默认为签署方自行选择。`
* @param SignTypeSelector 生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
- **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；
- **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。
注：
`不指定该值时，默认为签署方自行选择。`
*/
public void setSignTypeSelector(Long SignTypeSelector) {
this.SignTypeSelector = SignTypeSelector;
}
/**
* Get 签署人的签署截止时间，格式为Unix标准时间戳（秒）, 超过此时间未签署的合同变成已过期状态，不能在继续签署
注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
* @return Deadline 签署人的签署截止时间，格式为Unix标准时间戳（秒）, 超过此时间未签署的合同变成已过期状态，不能在继续签署
注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
*/
public Long getDeadline() {
return this.Deadline;
}
/**
* Set 签署人的签署截止时间，格式为Unix标准时间戳（秒）, 超过此时间未签署的合同变成已过期状态，不能在继续签署
注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
* @param Deadline 签署人的签署截止时间，格式为Unix标准时间戳（秒）, 超过此时间未签署的合同变成已过期状态，不能在继续签署
注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
*/
public void setDeadline(Long Deadline) {
this.Deadline = Deadline;
}
/**
* Get 只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。
您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。
注意：
1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。
2. 使用视频认证时，生成H5签署链接必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。
3. 签署完成后，可以通过查询签署认证人脸视频获取到当时的视频。
* @return Intention 只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。
您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。
注意：
1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。
2. 使用视频认证时，生成H5签署链接必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。
3. 签署完成后，可以通过查询签署认证人脸视频获取到当时的视频。
*/
public Intention getIntention() {
return this.Intention;
}
/**
* Set 只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。
您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。
注意：
1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。
2. 使用视频认证时，生成H5签署链接必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。
3. 签署完成后，可以通过查询签署认证人脸视频获取到当时的视频。
* @param Intention 只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。
您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。
注意：
1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。
2. 使用视频认证时，生成H5签署链接必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。
3. 签署完成后，可以通过查询签署认证人脸视频获取到当时的视频。
*/
public void setIntention(Intention Intention) {
this.Intention = Intention;
}
public FlowCreateApprover() {
}
/**
* NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
* and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
*/
public FlowCreateApprover(FlowCreateApprover source) {
if (source.ApproverType != null) {
this.ApproverType = new Long(source.ApproverType);
}
if (source.OrganizationName != null) {
this.OrganizationName = new String(source.OrganizationName);
}
if (source.ApproverName != null) {
this.ApproverName = new String(source.ApproverName);
}
if (source.ApproverMobile != null) {
this.ApproverMobile = new String(source.ApproverMobile);
}
if (source.ApproverIdCardType != null) {
this.ApproverIdCardType = new String(source.ApproverIdCardType);
}
if (source.ApproverIdCardNumber != null) {
this.ApproverIdCardNumber = new String(source.ApproverIdCardNumber);
}
if (source.RecipientId != null) {
this.RecipientId = new String(source.RecipientId);
}
if (source.VerifyChannel != null) {
this.VerifyChannel = new String[source.VerifyChannel.length];
for (int i = 0; i < source.VerifyChannel.length; i++) {
this.VerifyChannel[i] = new String(source.VerifyChannel[i]);
}
}
if (source.NotifyType != null) {
this.NotifyType = new String(source.NotifyType);
}
if (source.IsFullText != null) {
this.IsFullText = new Boolean(source.IsFullText);
}
if (source.PreReadTime != null) {
this.PreReadTime = new Long(source.PreReadTime);
}
if (source.UserId != null) {
this.UserId = new String(source.UserId);
}
if (source.Required != null) {
this.Required = new Boolean(source.Required);
}
if (source.ApproverSource != null) {
this.ApproverSource = new String(source.ApproverSource);
}
if (source.CustomApproverTag != null) {
this.CustomApproverTag = new String(source.CustomApproverTag);
}
if (source.RegisterInfo != null) {
this.RegisterInfo = new RegisterInfo(source.RegisterInfo);
}
if (source.ApproverOption != null) {
this.ApproverOption = new ApproverOption(source.ApproverOption);
}
if (source.JumpUrl != null) {
this.JumpUrl = new String(source.JumpUrl);
}
if (source.SignId != null) {
this.SignId = new String(source.SignId);
}
if (source.ApproverNeedSignReview != null) {
this.ApproverNeedSignReview = new Boolean(source.ApproverNeedSignReview);
}
if (source.SignComponents != null) {
this.SignComponents = new Component[source.SignComponents.length];
for (int i = 0; i < source.SignComponents.length; i++) {
this.SignComponents[i] = new Component(source.SignComponents[i]);
}
}
if (source.Components != null) {
this.Components = new Component[source.Components.length];
for (int i = 0; i < source.Components.length; i++) {
this.Components[i] = new Component(source.Components[i]);
}
}
if (source.ComponentLimitType != null) {
this.ComponentLimitType = new String[source.ComponentLimitType.length];
for (int i = 0; i < source.ComponentLimitType.length; i++) {
this.ComponentLimitType[i] = new String(source.ComponentLimitType[i]);
}
}
if (source.ApproverVerifyTypes != null) {
this.ApproverVerifyTypes = new Long[source.ApproverVerifyTypes.length];
for (int i = 0; i < source.ApproverVerifyTypes.length; i++) {
this.ApproverVerifyTypes[i] = new Long(source.ApproverVerifyTypes[i]);
}
}
if (source.ApproverSignTypes != null) {
this.ApproverSignTypes = new Long[source.ApproverSignTypes.length];
for (int i = 0; i < source.ApproverSignTypes.length; i++) {
this.ApproverSignTypes[i] = new Long(source.ApproverSignTypes[i]);
}
}
if (source.SignTypeSelector != null) {
this.SignTypeSelector = new Long(source.SignTypeSelector);
}
if (source.Deadline != null) {
this.Deadline = new Long(source.Deadline);
}
if (source.Intention != null) {
this.Intention = new Intention(source.Intention);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamSimple(map, prefix + "ApproverType", this.ApproverType);
this.setParamSimple(map, prefix + "OrganizationName", this.OrganizationName);
this.setParamSimple(map, prefix + "ApproverName", this.ApproverName);
this.setParamSimple(map, prefix + "ApproverMobile", this.ApproverMobile);
this.setParamSimple(map, prefix + "ApproverIdCardType", this.ApproverIdCardType);
this.setParamSimple(map, prefix + "ApproverIdCardNumber", this.ApproverIdCardNumber);
this.setParamSimple(map, prefix + "RecipientId", this.RecipientId);
this.setParamArraySimple(map, prefix + "VerifyChannel.", this.VerifyChannel);
this.setParamSimple(map, prefix + "NotifyType", this.NotifyType);
this.setParamSimple(map, prefix + "IsFullText", this.IsFullText);
this.setParamSimple(map, prefix + "PreReadTime", this.PreReadTime);
this.setParamSimple(map, prefix + "UserId", this.UserId);
this.setParamSimple(map, prefix + "Required", this.Required);
this.setParamSimple(map, prefix + "ApproverSource", this.ApproverSource);
this.setParamSimple(map, prefix + "CustomApproverTag", this.CustomApproverTag);
this.setParamObj(map, prefix + "RegisterInfo.", this.RegisterInfo);
this.setParamObj(map, prefix + "ApproverOption.", this.ApproverOption);
this.setParamSimple(map, prefix + "JumpUrl", this.JumpUrl);
this.setParamSimple(map, prefix + "SignId", this.SignId);
this.setParamSimple(map, prefix + "ApproverNeedSignReview", this.ApproverNeedSignReview);
this.setParamArrayObj(map, prefix + "SignComponents.", this.SignComponents);
this.setParamArrayObj(map, prefix + "Components.", this.Components);
this.setParamArraySimple(map, prefix + "ComponentLimitType.", this.ComponentLimitType);
this.setParamArraySimple(map, prefix + "ApproverVerifyTypes.", this.ApproverVerifyTypes);
this.setParamArraySimple(map, prefix + "ApproverSignTypes.", this.ApproverSignTypes);
this.setParamSimple(map, prefix + "SignTypeSelector", this.SignTypeSelector);
this.setParamSimple(map, prefix + "Deadline", this.Deadline);
this.setParamObj(map, prefix + "Intention.", this.Intention);
}
}