CreateBatchSignUrlRequest (tencentcloud-sdk-java 3.1.1355 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.ess.v20201111.models.CreateBatchSignUrlRequest

public class CreateBatchSignUrlRequest
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor and Description
`CreateBatchSignUrlRequest()`
`CreateBatchSignUrlRequest(CreateBatchSignUrlRequest source)` 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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Agent`	`getAgent()` Get 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
`Boolean`	`getAutoJumpBack()` Get 签署完成后是否自动回跳 false：否, 签署完成不会自动跳转回来(默认)true：是, 签署完成会自动跳转回来注: 1.
`Boolean`	`getCanBatchReject()` Get 是否允许此链接中签署方批量拒签。 false (默认): 不允许批量拒签 true : 允许批量拒签。注：`1.
`Boolean`	`getCanSkipReadFlow()` Get 是否允许此链接中签署方批量确认已读文件。 false (默认): 不允许批量确认已读文件。 true : 允许批量确认已读文件。注：`1.
`FlowBatchUrlInfo`	`getFlowBatchUrlInfo()` Get 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
`String[]`	`getFlowIds()` Get 批量签署的合同流程ID数组，此参数必传。注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
`String`	`getIdCardNumber()` Get 证件号码，应符合以下规则中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。注： 1.
`String`	`getIdCardType()` Get 证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同中国大陆居民身份证) 注： 1.
`Boolean`	`getJumpToDetail()` Get 是否直接跳转至合同内容页面进行签署 false: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认) true: 跳过合同流程列表, 直接进入合同内容页面进行签署
`String`	`getMobile()` Get 手机号码，支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。注：请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息。在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。
`String`	`getName()` Get 签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。注：请确保和合同中填入的一致。在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。
`String`	`getNotifyType()` Get 通知用户方式： NONE : 不通知（默认） SMS : 短信通知（发送短信通知到Mobile参数所传的手机号）
`UserInfo`	`getOperator()` Get 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
`String`	`getOrganizationName()` Get 目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。注：请确认该名称与企业营业执照中注册的名称一致。如果名称中包含英文括号()，请使用中文括号（）代替。请确保此企业已完成腾讯电子签企业认证。
`Long[]`	`getSignatureTypes()` Get 指定批量签署合同的签名类型，可传递以下值：0：手写签名1：OCR楷体2：姓名印章3：图片印章4：系统签名5：长效手写签名（包含手写签名）注：不传值的情况则计算所有合同中个人签署区的签名类型，规则如下：1.如果所有合同中所有的个人签署区方式包含多种则是手写2.如果所有合同中所有个人签名区签名类型仅为一种则就是那一种签名方式（例如合同1有多个签署区都是指定OCR楷体，合同2中也是多个签署区都是指定OCR楷体...则使用OCR楷体）该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数若签署方为企业员工，此参数无效，签名方式将以合同中为准。
`String`	`getUrlUseEnv()` Get 仅公众号 H5 跳转电子签小程序时，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 WeChatOfficialAccounts，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
`void`	`setAgent(Agent Agent)` Set 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
`void`	`setAutoJumpBack(Boolean AutoJumpBack)` Set 签署完成后是否自动回跳 false：否, 签署完成不会自动跳转回来(默认)true：是, 签署完成会自动跳转回来注: 1.
`void`	`setCanBatchReject(Boolean CanBatchReject)` Set 是否允许此链接中签署方批量拒签。 false (默认): 不允许批量拒签 true : 允许批量拒签。注：`1.
`void`	`setCanSkipReadFlow(Boolean CanSkipReadFlow)` Set 是否允许此链接中签署方批量确认已读文件。 false (默认): 不允许批量确认已读文件。 true : 允许批量确认已读文件。注：`1.
`void`	`setFlowBatchUrlInfo(FlowBatchUrlInfo FlowBatchUrlInfo)` Set 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
`void`	`setFlowIds(String[] FlowIds)` Set 批量签署的合同流程ID数组，此参数必传。注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
`void`	`setIdCardNumber(String IdCardNumber)` Set 证件号码，应符合以下规则中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。注： 1.
`void`	`setIdCardType(String IdCardType)` Set 证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同中国大陆居民身份证) 注： 1.
`void`	`setJumpToDetail(Boolean JumpToDetail)` Set 是否直接跳转至合同内容页面进行签署 false: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认) true: 跳过合同流程列表, 直接进入合同内容页面进行签署
`void`	`setMobile(String Mobile)` Set 手机号码，支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。注：请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息。在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。
`void`	`setName(String Name)` Set 签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。注：请确保和合同中填入的一致。在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。
`void`	`setNotifyType(String NotifyType)` Set 通知用户方式： NONE : 不通知（默认） SMS : 短信通知（发送短信通知到Mobile参数所传的手机号）
`void`	`setOperator(UserInfo Operator)` Set 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
`void`	`setOrganizationName(String OrganizationName)` Set 目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。注：请确认该名称与企业营业执照中注册的名称一致。如果名称中包含英文括号()，请使用中文括号（）代替。请确保此企业已完成腾讯电子签企业认证。
`void`	`setSignatureTypes(Long[] SignatureTypes)` Set 指定批量签署合同的签名类型，可传递以下值：0：手写签名1：OCR楷体2：姓名印章3：图片印章4：系统签名5：长效手写签名（包含手写签名）注：不传值的情况则计算所有合同中个人签署区的签名类型，规则如下：1.如果所有合同中所有的个人签署区方式包含多种则是手写2.如果所有合同中所有个人签名区签名类型仅为一种则就是那一种签名方式（例如合同1有多个签署区都是指定OCR楷体，合同2中也是多个签署区都是指定OCR楷体...则使用OCR楷体）该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数若签署方为企业员工，此参数无效，签名方式将以合同中为准。
`void`	`setUrlUseEnv(String UrlUseEnv)` Set 仅公众号 H5 跳转电子签小程序时，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 WeChatOfficialAccounts，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
`void`	`toMap(HashMap<String,String> map, String prefix)` Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CreateBatchSignUrlRequest
```
public CreateBatchSignUrlRequest()
```
  - CreateBatchSignUrlRequest
```
public CreateBatchSignUrlRequest(CreateBatchSignUrlRequest source)
```
    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.
- Method Detail
  - getOperator
```
public UserInfo getOperator()
```
    Get 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    
    Returns:
    
    Operator 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
  - setOperator
```
public void setOperator(UserInfo Operator)
```
    Set 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    
    Parameters:
    
    Operator - 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
  - getName
```
public String getName()
```
    Get 签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。注：
    - 请确保和合同中填入的一致。
    - 在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。
    Returns:
    Name 签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。注：
    
    请确保和合同中填入的一致。
    
    在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。
  - setName
```
public void setName(String Name)
```
    Set 签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。注：
    - 请确保和合同中填入的一致。
    - 在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。
    Parameters:
    Name - 签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。注：
    
    请确保和合同中填入的一致。
    
    在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。
  - getMobile
```
public String getMobile()
```
    Get 手机号码，支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。注：
    - 请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息。
    - 在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。
    Returns:
    Mobile 手机号码，支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。注：
    请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息。
    在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。
  - setMobile
```
public void setMobile(String Mobile)
```
    Set 手机号码，支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。注：
    - 请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息。
    - 在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。
    Parameters:
    Mobile - 手机号码，支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。注：
    请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息。
    在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。
  - getAgent
```
public Agent getAgent()
```
    Get 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    
    Returns:
    
    Agent 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
  - setAgent
```
public void setAgent(Agent Agent)
```
    Set 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    
    Parameters:
    
    Agent - 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
  - getIdCardType
```
public String getIdCardType()
```
    Get 证件类型，支持以下类型
    - ID_CARD : 中国大陆居民身份证 (默认值)
    - HONGKONG_AND_MACAO : 港澳居民来往内地通行证
    - HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同中国大陆居民身份证)
    注： 1. `请确保和合同中填入的一致`。 2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。`
    Returns:
    IdCardType 证件类型，支持以下类型
    ID_CARD : 中国大陆居民身份证 (默认值)
    
    HONGKONG_AND_MACAO : 港澳居民来往内地通行证
    
    HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同中国大陆居民身份证)
    注： 1. `请确保和合同中填入的一致`。 2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。`
  - setIdCardType
```
public void setIdCardType(String IdCardType)
```
    Set 证件类型，支持以下类型
    - ID_CARD : 中国大陆居民身份证 (默认值)
    - HONGKONG_AND_MACAO : 港澳居民来往内地通行证
    - HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同中国大陆居民身份证)
    注： 1. `请确保和合同中填入的一致`。 2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。`
    Parameters:
    IdCardType - 证件类型，支持以下类型
    ID_CARD : 中国大陆居民身份证 (默认值)
    
    HONGKONG_AND_MACAO : 港澳居民来往内地通行证
    
    HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同中国大陆居民身份证)
    注： 1. `请确保和合同中填入的一致`。 2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。`
  - getSignatureTypes
```
public Long[] getSignatureTypes()
```
    Get 指定批量签署合同的签名类型，可传递以下值：
    - **0**：手写签名
    - **1**：OCR楷体
    - **2**：姓名印章
    - **3**：图片印章
    - **4**：系统签名
    - **5**：长效手写签名（包含手写签名）
    注：
    - 不传值的情况则计算所有合同中个人签署区的签名类型，规则如下：
      1.如果所有合同中所有的个人签署区方式包含多种则是手写
      2.如果所有合同中所有个人签名区签名类型仅为一种则就是那一种签名方式（例如合同1有多个签署区都是指定OCR楷体，合同2中也是多个签署区都是指定OCR楷体...则使用OCR楷体）
    - 该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数
    - 若签署方为企业员工，此参数无效，签名方式将以合同中为准。
    Returns:
    SignatureTypes 指定批量签署合同的签名类型，可传递以下值：
    **0**：手写签名
    **1**：OCR楷体
    **2**：姓名印章
    **3**：图片印章
    **4**：系统签名
    **5**：长效手写签名（包含手写签名）
    注：
    不传值的情况则计算所有合同中个人签署区的签名类型，规则如下：
    1.如果所有合同中所有的个人签署区方式包含多种则是手写
    2.如果所有合同中所有个人签名区签名类型仅为一种则就是那一种签名方式（例如合同1有多个签署区都是指定OCR楷体，合同2中也是多个签署区都是指定OCR楷体...则使用OCR楷体）
    该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数
    若签署方为企业员工，此参数无效，签名方式将以合同中为准。
  - setSignatureTypes
```
public void setSignatureTypes(Long[] SignatureTypes)
```
    Set 指定批量签署合同的签名类型，可传递以下值：
    - **0**：手写签名
    - **1**：OCR楷体
    - **2**：姓名印章
    - **3**：图片印章
    - **4**：系统签名
    - **5**：长效手写签名（包含手写签名）
    注：
    - 不传值的情况则计算所有合同中个人签署区的签名类型，规则如下：
      1.如果所有合同中所有的个人签署区方式包含多种则是手写
      2.如果所有合同中所有个人签名区签名类型仅为一种则就是那一种签名方式（例如合同1有多个签署区都是指定OCR楷体，合同2中也是多个签署区都是指定OCR楷体...则使用OCR楷体）
    - 该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数
    - 若签署方为企业员工，此参数无效，签名方式将以合同中为准。
    Parameters:
    SignatureTypes - 指定批量签署合同的签名类型，可传递以下值：
    **0**：手写签名
    **1**：OCR楷体
    **2**：姓名印章
    **3**：图片印章
    **4**：系统签名
    **5**：长效手写签名（包含手写签名）
    注：
    不传值的情况则计算所有合同中个人签署区的签名类型，规则如下：
    1.如果所有合同中所有的个人签署区方式包含多种则是手写
    2.如果所有合同中所有个人签名区签名类型仅为一种则就是那一种签名方式（例如合同1有多个签署区都是指定OCR楷体，合同2中也是多个签署区都是指定OCR楷体...则使用OCR楷体）
    该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数
    若签署方为企业员工，此参数无效，签名方式将以合同中为准。
  - getIdCardNumber
```
public String getIdCardNumber()
```
    Get 证件号码，应符合以下规则
    - 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
    - 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。
    - 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
    注： 1. `请确保和合同中填入的一致`。 2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
    Returns:
    IdCardNumber 证件号码，应符合以下规则
    中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
    
    中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。
    
    中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
    注： 1. `请确保和合同中填入的一致`。 2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
  - setIdCardNumber
```
public void setIdCardNumber(String IdCardNumber)
```
    Set 证件号码，应符合以下规则
    - 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
    - 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。
    - 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
    注： 1. `请确保和合同中填入的一致`。 2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
    Parameters:
    IdCardNumber - 证件号码，应符合以下规则
    中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
    
    中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。
    
    中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
    注： 1. `请确保和合同中填入的一致`。 2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
  - getNotifyType
```
public String getNotifyType()
```
    Get 通知用户方式：
    - **NONE** : 不通知（默认）
    - **SMS** : 短信通知（发送短信通知到Mobile参数所传的手机号）
    Returns:
    NotifyType 通知用户方式：
    
    **NONE** : 不通知（默认）
    
    **SMS** : 短信通知（发送短信通知到Mobile参数所传的手机号）
  - setNotifyType
```
public void setNotifyType(String NotifyType)
```
    Set 通知用户方式：
    - **NONE** : 不通知（默认）
    - **SMS** : 短信通知（发送短信通知到Mobile参数所传的手机号）
    Parameters:
    NotifyType - 通知用户方式：
    
    **NONE** : 不通知（默认）
    
    **SMS** : 短信通知（发送短信通知到Mobile参数所传的手机号）
  - getFlowIds
```
public String[] getFlowIds()
```
    Get 批量签署的合同流程ID数组，此参数必传。注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
    
    Returns:
    
    FlowIds 批量签署的合同流程ID数组，此参数必传。注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
  - setFlowIds
```
public void setFlowIds(String[] FlowIds)
```
    Set 批量签署的合同流程ID数组，此参数必传。注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
    
    Parameters:
    
    FlowIds - 批量签署的合同流程ID数组，此参数必传。注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
  - getOrganizationName
```
public String getOrganizationName()
```
    Get 目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。注：
    - 请确认该名称与企业营业执照中注册的名称一致。
    - 如果名称中包含英文括号()，请使用中文括号（）代替。
    - 请确保此企业已完成腾讯电子签企业认证。
    Returns:
    OrganizationName 目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。注：
    
    请确认该名称与企业营业执照中注册的名称一致。
    
    如果名称中包含英文括号()，请使用中文括号（）代替。
    
    请确保此企业已完成腾讯电子签企业认证。
  - setOrganizationName
```
public void setOrganizationName(String OrganizationName)
```
    Set 目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。注：
    - 请确认该名称与企业营业执照中注册的名称一致。
    - 如果名称中包含英文括号()，请使用中文括号（）代替。
    - 请确保此企业已完成腾讯电子签企业认证。
    Parameters:
    OrganizationName - 目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。注：
    
    请确认该名称与企业营业执照中注册的名称一致。
    
    如果名称中包含英文括号()，请使用中文括号（）代替。
    
    请确保此企业已完成腾讯电子签企业认证。
  - getJumpToDetail
```
public Boolean getJumpToDetail()
```
    Get 是否直接跳转至合同内容页面进行签署
    - **false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)
    - **true**: 跳过合同流程列表, 直接进入合同内容页面进行签署
    Returns:
    JumpToDetail 是否直接跳转至合同内容页面进行签署
    
    **false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)
    
    **true**: 跳过合同流程列表, 直接进入合同内容页面进行签署
  - setJumpToDetail
```
public void setJumpToDetail(Boolean JumpToDetail)
```
    Set 是否直接跳转至合同内容页面进行签署
    - **false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)
    - **true**: 跳过合同流程列表, 直接进入合同内容页面进行签署
    Parameters:
    JumpToDetail - 是否直接跳转至合同内容页面进行签署
    
    **false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)
    
    **true**: 跳过合同流程列表, 直接进入合同内容页面进行签署
  - getFlowBatchUrlInfo
```
public FlowBatchUrlInfo getFlowBatchUrlInfo()
```
    Get 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
    
    Returns:
    
    FlowBatchUrlInfo 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
  - setFlowBatchUrlInfo
```
public void setFlowBatchUrlInfo(FlowBatchUrlInfo FlowBatchUrlInfo)
```
    Set 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
    
    Parameters:
    
    FlowBatchUrlInfo - 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
  - getAutoJumpBack
```
public Boolean getAutoJumpBack()
```
    Get 签署完成后是否自动回跳
    - false：否, 签署完成不会自动跳转回来(默认)
    - true：是, 签署完成会自动跳转回来
    注: 1. 该参数只针对APP类型（电子签小程序跳转贵方小程序）场景的签署链接有效 2. 手机应用APP 或微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object) 3. 电子签小程序跳转贵方APP，不支持自动跳转，必须用户手动点击完成按钮（微信的限制）
    Returns:
    AutoJumpBack 签署完成后是否自动回跳
    false：否, 签署完成不会自动跳转回来(默认)
    true：是, 签署完成会自动跳转回来
    注: 1. 该参数只针对APP类型（电子签小程序跳转贵方小程序）场景的签署链接有效 2. 手机应用APP 或微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object) 3. 电子签小程序跳转贵方APP，不支持自动跳转，必须用户手动点击完成按钮（微信的限制）
  - setAutoJumpBack
```
public void setAutoJumpBack(Boolean AutoJumpBack)
```
    Set 签署完成后是否自动回跳
    - false：否, 签署完成不会自动跳转回来(默认)
    - true：是, 签署完成会自动跳转回来
    注: 1. 该参数只针对APP类型（电子签小程序跳转贵方小程序）场景的签署链接有效 2. 手机应用APP 或微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object) 3. 电子签小程序跳转贵方APP，不支持自动跳转，必须用户手动点击完成按钮（微信的限制）
    Parameters:
    AutoJumpBack - 签署完成后是否自动回跳
    false：否, 签署完成不会自动跳转回来(默认)
    true：是, 签署完成会自动跳转回来
    注: 1. 该参数只针对APP类型（电子签小程序跳转贵方小程序）场景的签署链接有效 2. 手机应用APP 或微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object) 3. 电子签小程序跳转贵方APP，不支持自动跳转，必须用户手动点击完成按钮（微信的限制）
  - getUrlUseEnv
```
public String getUrlUseEnv()
```
    Get 仅公众号 H5 跳转电子签小程序时，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
    
    Returns:
    
    UrlUseEnv 仅公众号 H5 跳转电子签小程序时，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
  - setUrlUseEnv
```
public void setUrlUseEnv(String UrlUseEnv)
```
    Set 仅公众号 H5 跳转电子签小程序时，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
    
    Parameters:
    
    UrlUseEnv - 仅公众号 H5 跳转电子签小程序时，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
  - getCanBatchReject
```
public Boolean getCanBatchReject()
```
    Get 是否允许此链接中签署方批量拒签。
    - false (默认): 不允许批量拒签
    - true : 允许批量拒签。
    注：`1. 当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作，以达到拒签整个合同组的效果。2. 如果是链接直接跳转至详情页（JumpToDetail参数为true），也不支持批量拒签功能`
    Returns:
    CanBatchReject 是否允许此链接中签署方批量拒签。
    false (默认): 不允许批量拒签
    
    true : 允许批量拒签。
    注：`1. 当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作，以达到拒签整个合同组的效果。2. 如果是链接直接跳转至详情页（JumpToDetail参数为true），也不支持批量拒签功能`
  - setCanBatchReject
```
public void setCanBatchReject(Boolean CanBatchReject)
```
    Set 是否允许此链接中签署方批量拒签。
    - false (默认): 不允许批量拒签
    - true : 允许批量拒签。
    注：`1. 当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作，以达到拒签整个合同组的效果。2. 如果是链接直接跳转至详情页（JumpToDetail参数为true），也不支持批量拒签功能`
    Parameters:
    CanBatchReject - 是否允许此链接中签署方批量拒签。
    false (默认): 不允许批量拒签
    
    true : 允许批量拒签。
    注：`1. 当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作，以达到拒签整个合同组的效果。2. 如果是链接直接跳转至详情页（JumpToDetail参数为true），也不支持批量拒签功能`
  - getCanSkipReadFlow
```
public Boolean getCanSkipReadFlow()
```
    Get 是否允许此链接中签署方批量确认已读文件。
    - false (默认): 不允许批量确认已读文件。
    - true : 允许批量确认已读文件。
    注：`1. 此功能为白名单功能，使用前请联系对应客户经理进行开通。2. 使用此功能时，FlowIds参数必传。3. 对于企业签署方，如果对印章/签名控件有限制要求，需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致，否则无法使用此功能。`
    Returns:
    CanSkipReadFlow 是否允许此链接中签署方批量确认已读文件。
    false (默认): 不允许批量确认已读文件。
    
    true : 允许批量确认已读文件。
    注：`1. 此功能为白名单功能，使用前请联系对应客户经理进行开通。2. 使用此功能时，FlowIds参数必传。3. 对于企业签署方，如果对印章/签名控件有限制要求，需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致，否则无法使用此功能。`
  - setCanSkipReadFlow
```
public void setCanSkipReadFlow(Boolean CanSkipReadFlow)
```
    Set 是否允许此链接中签署方批量确认已读文件。
    - false (默认): 不允许批量确认已读文件。
    - true : 允许批量确认已读文件。
    注：`1. 此功能为白名单功能，使用前请联系对应客户经理进行开通。2. 使用此功能时，FlowIds参数必传。3. 对于企业签署方，如果对印章/签名控件有限制要求，需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致，否则无法使用此功能。`
    Parameters:
    CanSkipReadFlow - 是否允许此链接中签署方批量确认已读文件。
    false (默认): 不允许批量确认已读文件。
    
    true : 允许批量确认已读文件。
    注：`1. 此功能为白名单功能，使用前请联系对应客户经理进行开通。2. 使用此功能时，FlowIds参数必传。3. 对于企业签署方，如果对印章/签名控件有限制要求，需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致，否则无法使用此功能。`
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel
    
    Parameters:
    
    map - The map to populate with the model's parameters.
    
    prefix - A string prefix for the keys.

Class CreateBatchSignUrlRequest

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

CreateBatchSignUrlRequest

CreateBatchSignUrlRequest

Method Detail

getOperator

setOperator

getName

setName

getMobile

setMobile

getAgent

setAgent

getIdCardType

setIdCardType

getSignatureTypes

setSignatureTypes

getIdCardNumber

setIdCardNumber

getNotifyType

setNotifyType

getFlowIds

setFlowIds

getOrganizationName

setOrganizationName

getJumpToDetail

setJumpToDetail

getFlowBatchUrlInfo

setFlowBatchUrlInfo

getAutoJumpBack

setAutoJumpBack

getUrlUseEnv

setUrlUseEnv

getCanBatchReject

setCanBatchReject

getCanSkipReadFlow

setCanSkipReadFlow

toMap