CreateSignUrlsRequest (tencentcloud-sdk-java 3.1.1164 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.essbasic.v20210526.models.CreateSignUrlsRequest

public class CreateSignUrlsRequest
extends AbstractModel

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

Constructor Summary

Constructors
Constructor and Description
`CreateSignUrlsRequest()`
`CreateSignUrlsRequest(CreateSignUrlsRequest 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 Deprecated Methods
Modifier and Type	Method and Description
`Agent`	`getAgent()` Get 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经过实名认证
`Boolean`	`getAutoJumpBack()` Get 签署完成后是否自动回跳 false：否, 签署完成不会自动跳转回来(默认)true：是, 签署完成会自动跳转回来注: 1.
`String`	`getEndpoint()` Get 签署链接类型,可以设置的参数如下 WEIXINAPP :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链 CHANNEL :带有H5引导页的跳转电子签小程序的链接(GenerateType非ALL时候不能设置成CHANNEL) APP :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型 LONGURL2WEIXINAPP :跳转电子签小程序的链接, H5跳转适合此类型，此时返回长链注：动态签署人场景，如果签署链接类型设置为`APP`，则仅支持跳转到封面页。详细使用场景可以参考接口描述说明中的主要使用场景EndPoint分类**
`String`	`getFlowGroupId()` Get 合同组编号注：`该参数和合同流程ID数组必须二选一`
`FlowGroupUrlInfo`	`getFlowGroupUrlInfo()` Get 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
`String[]`	`getFlowIds()` Get 合同流程ID数组，最多支持100个。注: 1.
`String`	`getGenerateType()` Get 签署链接生成类型，可以选择的类型如下 ALL：（默认）为所有签署方生成签署链接，但不包括自动签署（静默签署）的签署方。注意：此中类型不支持多个合同ID（FlowIds）。 CHANNEL：适用于第三方子企业的员工签署方。 NOT_CHANNEL：适用于SaaS平台企业的员工签署方。 PERSON：适用于个人或自然人签署方。 FOLLOWER：适用于关注方，目前指合同的抄送方。 RECIPIENT：根据RecipientId生成对应的签署链接，适用于动态添加签署人的情况。
`Long[]`	`getHides()` Get 生成的签署链接在签署页面隐藏的按钮列表，可设置如下： 0 :合同签署页面更多操作按钮 1 :合同签署页面更多操作的拒绝签署按钮 2 :合同签署页面更多操作的转他人处理按钮 3 :签署成功页的查看详情按钮注: `字段为数组, 可以传值隐藏多个按钮`
`String`	`getIdCardNumber()` Get 证件号码，应符合以下规则居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
`String`	`getIdCardType()` Get 证件类型，支持以下类型 ID_CARD : 居民身份证 HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
`String`	`getJumpUrl()` Get 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。
`String`	`getMobile()` Get 合同流程里边签署方经办人手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。注: `GenerateType为"PERSON"或"FOLLOWER"时必填`
`String`	`getName()` Get 合同流程里边参与方的姓名。注: `GenerateType为"PERSON"(即个人签署方)时必填`
`String`	`getOpenId()` Get 第三方平台子客企业员工的标识OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人, 仅展示已经实名的经办人信息注：如果传进来的OpenId已经实名并且加入企业，则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参（会用此OpenId实名的身份证和登录的手机号覆盖）
`UserInfo`	`getOperator()` Deprecated.
`String`	`getOrganizationName()` Get SaaS平台企业员工签署方的企业名称如果名称中包含英文括号()，请使用中文括号（）代替。注: `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
`String`	`getOrganizationOpenId()` Get 第三方平台子客企业的企业的标识, 即OrganizationOpenId。注: `1.GenerateType为"CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`
`String[]`	`getRecipientIds()` Get 参与方角色ID，用于生成动态签署人链接完成领取。注：`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`，
`void`	`setAgent(Agent Agent)` Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经过实名认证
`void`	`setAutoJumpBack(Boolean AutoJumpBack)` Set 签署完成后是否自动回跳 false：否, 签署完成不会自动跳转回来(默认)true：是, 签署完成会自动跳转回来注: 1.
`void`	`setEndpoint(String Endpoint)` Set 签署链接类型,可以设置的参数如下 WEIXINAPP :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链 CHANNEL :带有H5引导页的跳转电子签小程序的链接(GenerateType非ALL时候不能设置成CHANNEL) APP :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型 LONGURL2WEIXINAPP :跳转电子签小程序的链接, H5跳转适合此类型，此时返回长链注：动态签署人场景，如果签署链接类型设置为`APP`，则仅支持跳转到封面页。详细使用场景可以参考接口描述说明中的主要使用场景EndPoint分类**
`void`	`setFlowGroupId(String FlowGroupId)` Set 合同组编号注：`该参数和合同流程ID数组必须二选一`
`void`	`setFlowGroupUrlInfo(FlowGroupUrlInfo FlowGroupUrlInfo)` Set 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
`void`	`setFlowIds(String[] FlowIds)` Set 合同流程ID数组，最多支持100个。注: 1.
`void`	`setGenerateType(String GenerateType)` Set 签署链接生成类型，可以选择的类型如下 ALL：（默认）为所有签署方生成签署链接，但不包括自动签署（静默签署）的签署方。注意：此中类型不支持多个合同ID（FlowIds）。 CHANNEL：适用于第三方子企业的员工签署方。 NOT_CHANNEL：适用于SaaS平台企业的员工签署方。 PERSON：适用于个人或自然人签署方。 FOLLOWER：适用于关注方，目前指合同的抄送方。 RECIPIENT：根据RecipientId生成对应的签署链接，适用于动态添加签署人的情况。
`void`	`setHides(Long[] Hides)` Set 生成的签署链接在签署页面隐藏的按钮列表，可设置如下： 0 :合同签署页面更多操作按钮 1 :合同签署页面更多操作的拒绝签署按钮 2 :合同签署页面更多操作的转他人处理按钮 3 :签署成功页的查看详情按钮注: `字段为数组, 可以传值隐藏多个按钮`
`void`	`setIdCardNumber(String IdCardNumber)` Set 证件号码，应符合以下规则居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
`void`	`setIdCardType(String IdCardType)` Set 证件类型，支持以下类型 ID_CARD : 居民身份证 HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
`void`	`setJumpUrl(String JumpUrl)` Set 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。
`void`	`setMobile(String Mobile)` Set 合同流程里边签署方经办人手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。注: `GenerateType为"PERSON"或"FOLLOWER"时必填`
`void`	`setName(String Name)` Set 合同流程里边参与方的姓名。注: `GenerateType为"PERSON"(即个人签署方)时必填`
`void`	`setOpenId(String OpenId)` Set 第三方平台子客企业员工的标识OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人, 仅展示已经实名的经办人信息注：如果传进来的OpenId已经实名并且加入企业，则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参（会用此OpenId实名的身份证和登录的手机号覆盖）
`void`	`setOperator(UserInfo Operator)` Deprecated.
`void`	`setOrganizationName(String OrganizationName)` Set SaaS平台企业员工签署方的企业名称如果名称中包含英文括号()，请使用中文括号（）代替。注: `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
`void`	`setOrganizationOpenId(String OrganizationOpenId)` Set 第三方平台子客企业的企业的标识, 即OrganizationOpenId。注: `1.GenerateType为"CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`
`void`	`setRecipientIds(String[] RecipientIds)` Set 参与方角色ID，用于生成动态签署人链接完成领取。注：`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`，
`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
  - CreateSignUrlsRequest
```
public CreateSignUrlsRequest()
```
  - CreateSignUrlsRequest
```
public CreateSignUrlsRequest(CreateSignUrlsRequest 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
  - getAgent
```
public Agent getAgent()
```
    Get 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。
    - 渠道应用标识: Agent.AppId
    - 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
    - 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId
    第三方平台子客企业和员工必须已经过实名认证
    Returns:
    Agent 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。
    
    渠道应用标识: Agent.AppId
    
    第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
    
    第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId
    
    第三方平台子客企业和员工必须已经过实名认证
  - setAgent
```
public void setAgent(Agent Agent)
```
    Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。
    - 渠道应用标识: Agent.AppId
    - 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
    - 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId
    第三方平台子客企业和员工必须已经过实名认证
    Parameters:
    Agent - 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。
    
    渠道应用标识: Agent.AppId
    
    第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
    
    第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId
    
    第三方平台子客企业和员工必须已经过实名认证
  - getFlowIds
```
public String[] getFlowIds()
```
    Get 合同流程ID数组，最多支持100个。注: 1. 必须选择提供此参数或合同组编号中的一个。 2. 当生成类型（GenerateType）设为“ALL”时，不可提供多个流程ID。
    
    Returns:
    
    FlowIds 合同流程ID数组，最多支持100个。注: 1. 必须选择提供此参数或合同组编号中的一个。 2. 当生成类型（GenerateType）设为“ALL”时，不可提供多个流程ID。
  - setFlowIds
```
public void setFlowIds(String[] FlowIds)
```
    Set 合同流程ID数组，最多支持100个。注: 1. 必须选择提供此参数或合同组编号中的一个。 2. 当生成类型（GenerateType）设为“ALL”时，不可提供多个流程ID。
    
    Parameters:
    
    FlowIds - 合同流程ID数组，最多支持100个。注: 1. 必须选择提供此参数或合同组编号中的一个。 2. 当生成类型（GenerateType）设为“ALL”时，不可提供多个流程ID。
  - getFlowGroupId
```
public String getFlowGroupId()
```
    Get 合同组编号注：`该参数和合同流程ID数组必须二选一`
    
    Returns:
    
    FlowGroupId 合同组编号注：`该参数和合同流程ID数组必须二选一`
  - setFlowGroupId
```
public void setFlowGroupId(String FlowGroupId)
```
    Set 合同组编号注：`该参数和合同流程ID数组必须二选一`
    
    Parameters:
    
    FlowGroupId - 合同组编号注：`该参数和合同流程ID数组必须二选一`
  - getEndpoint
```
public String getEndpoint()
```
    Get 签署链接类型,可以设置的参数如下
    - **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
    - **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(GenerateType非ALL时候不能设置成CHANNEL)
    - **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型
    - **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型，此时返回长链
    注：**动态签署人场景，如果签署链接类型设置为`APP`，则仅支持跳转到封面页。详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
    Returns:
    Endpoint 签署链接类型,可以设置的参数如下
    **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
    
    **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(GenerateType非ALL时候不能设置成CHANNEL)
    
    **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型
    
    **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型，此时返回长链
    注：**动态签署人场景，如果签署链接类型设置为`APP`，则仅支持跳转到封面页。详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
  - setEndpoint
```
public void setEndpoint(String Endpoint)
```
    Set 签署链接类型,可以设置的参数如下
    - **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
    - **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(GenerateType非ALL时候不能设置成CHANNEL)
    - **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型
    - **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型，此时返回长链
    注：**动态签署人场景，如果签署链接类型设置为`APP`，则仅支持跳转到封面页。详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
    Parameters:
    Endpoint - 签署链接类型,可以设置的参数如下
    **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
    
    **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(GenerateType非ALL时候不能设置成CHANNEL)
    
    **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型
    
    **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型，此时返回长链
    注：**动态签署人场景，如果签署链接类型设置为`APP`，则仅支持跳转到封面页。详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
  - getGenerateType
```
public String getGenerateType()
```
    Get 签署链接生成类型，可以选择的类型如下
    - ALL：（默认）为所有签署方生成签署链接，但不包括自动签署（静默签署）的签署方。注意：此中类型不支持多个合同ID（FlowIds）。
    - CHANNEL：适用于第三方子企业的员工签署方。
    - NOT_CHANNEL：适用于SaaS平台企业的员工签署方。
    - PERSON：适用于个人或自然人签署方。
    - FOLLOWER：适用于关注方，目前指合同的抄送方。
    - RECIPIENT：根据RecipientId生成对应的签署链接，适用于动态添加签署人的情况。
    Returns:
    GenerateType 签署链接生成类型，可以选择的类型如下
    ALL：（默认）为所有签署方生成签署链接，但不包括自动签署（静默签署）的签署方。注意：此中类型不支持多个合同ID（FlowIds）。
    
    CHANNEL：适用于第三方子企业的员工签署方。
    
    NOT_CHANNEL：适用于SaaS平台企业的员工签署方。
    
    PERSON：适用于个人或自然人签署方。
    
    FOLLOWER：适用于关注方，目前指合同的抄送方。
    
    RECIPIENT：根据RecipientId生成对应的签署链接，适用于动态添加签署人的情况。
  - setGenerateType
```
public void setGenerateType(String GenerateType)
```
    Set 签署链接生成类型，可以选择的类型如下
    - ALL：（默认）为所有签署方生成签署链接，但不包括自动签署（静默签署）的签署方。注意：此中类型不支持多个合同ID（FlowIds）。
    - CHANNEL：适用于第三方子企业的员工签署方。
    - NOT_CHANNEL：适用于SaaS平台企业的员工签署方。
    - PERSON：适用于个人或自然人签署方。
    - FOLLOWER：适用于关注方，目前指合同的抄送方。
    - RECIPIENT：根据RecipientId生成对应的签署链接，适用于动态添加签署人的情况。
    Parameters:
    GenerateType - 签署链接生成类型，可以选择的类型如下
    ALL：（默认）为所有签署方生成签署链接，但不包括自动签署（静默签署）的签署方。注意：此中类型不支持多个合同ID（FlowIds）。
    
    CHANNEL：适用于第三方子企业的员工签署方。
    
    NOT_CHANNEL：适用于SaaS平台企业的员工签署方。
    
    PERSON：适用于个人或自然人签署方。
    
    FOLLOWER：适用于关注方，目前指合同的抄送方。
    
    RECIPIENT：根据RecipientId生成对应的签署链接，适用于动态添加签署人的情况。
  - getOrganizationName
```
public String getOrganizationName()
```
    Get SaaS平台企业员工签署方的企业名称如果名称中包含英文括号()，请使用中文括号（）代替。注: `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
    
    Returns:
    
    OrganizationName SaaS平台企业员工签署方的企业名称如果名称中包含英文括号()，请使用中文括号（）代替。注: `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
  - setOrganizationName
```
public void setOrganizationName(String OrganizationName)
```
    Set SaaS平台企业员工签署方的企业名称如果名称中包含英文括号()，请使用中文括号（）代替。注: `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
    
    Parameters:
    
    OrganizationName - SaaS平台企业员工签署方的企业名称如果名称中包含英文括号()，请使用中文括号（）代替。注: `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
  - getName
```
public String getName()
```
    Get 合同流程里边参与方的姓名。注: `GenerateType为"PERSON"(即个人签署方)时必填`
    
    Returns:
    
    Name 合同流程里边参与方的姓名。注: `GenerateType为"PERSON"(即个人签署方)时必填`
  - setName
```
public void setName(String Name)
```
    Set 合同流程里边参与方的姓名。注: `GenerateType为"PERSON"(即个人签署方)时必填`
    
    Parameters:
    
    Name - 合同流程里边参与方的姓名。注: `GenerateType为"PERSON"(即个人签署方)时必填`
  - getMobile
```
public String getMobile()
```
    Get 合同流程里边签署方经办人手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。注: `GenerateType为"PERSON"或"FOLLOWER"时必填`
    
    Returns:
    
    Mobile 合同流程里边签署方经办人手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。注: `GenerateType为"PERSON"或"FOLLOWER"时必填`
  - setMobile
```
public void setMobile(String Mobile)
```
    Set 合同流程里边签署方经办人手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。注: `GenerateType为"PERSON"或"FOLLOWER"时必填`
    
    Parameters:
    
    Mobile - 合同流程里边签署方经办人手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。注: `GenerateType为"PERSON"或"FOLLOWER"时必填`
  - getIdCardType
```
public String getIdCardType()
```
    Get 证件类型，支持以下类型
    - ID_CARD : 居民身份证
    - HONGKONG_AND_MACAO : 港澳居民来往内地通行证
    - HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
    Returns:
    IdCardType 证件类型，支持以下类型
    ID_CARD : 居民身份证
    
    HONGKONG_AND_MACAO : 港澳居民来往内地通行证
    
    HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
  - setIdCardType
```
public void setIdCardType(String IdCardType)
```
    Set 证件类型，支持以下类型
    - ID_CARD : 居民身份证
    - HONGKONG_AND_MACAO : 港澳居民来往内地通行证
    - HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
    Parameters:
    IdCardType - 证件类型，支持以下类型
    ID_CARD : 居民身份证
    
    HONGKONG_AND_MACAO : 港澳居民来往内地通行证
    
    HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
  - getIdCardNumber
```
public String getIdCardNumber()
```
    Get 证件号码，应符合以下规则
    - 居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。
    - 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
    - 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
    Returns:
    IdCardNumber 证件号码，应符合以下规则
    居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。
    
    港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
    
    港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
  - setIdCardNumber
```
public void setIdCardNumber(String IdCardNumber)
```
    Set 证件号码，应符合以下规则
    - 居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。
    - 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
    - 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
    Parameters:
    IdCardNumber - 证件号码，应符合以下规则
    居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。
    
    港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
    
    港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
  - getOrganizationOpenId
```
public String getOrganizationOpenId()
```
    Get 第三方平台子客企业的企业的标识, 即OrganizationOpenId。注: `1.GenerateType为"CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`
    
    Returns:
    
    OrganizationOpenId 第三方平台子客企业的企业的标识, 即OrganizationOpenId。注: `1.GenerateType为"CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`
  - setOrganizationOpenId
```
public void setOrganizationOpenId(String OrganizationOpenId)
```
    Set 第三方平台子客企业的企业的标识, 即OrganizationOpenId。注: `1.GenerateType为"CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`
    
    Parameters:
    
    OrganizationOpenId - 第三方平台子客企业的企业的标识, 即OrganizationOpenId。注: `1.GenerateType为"CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`
  - getOpenId
```
public String getOpenId()
```
    Get 第三方平台子客企业员工的标识OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人, 仅展示已经实名的经办人信息注：如果传进来的OpenId已经实名并且加入企业，则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参（会用此OpenId实名的身份证和登录的手机号覆盖）
    
    Returns:
    
    OpenId 第三方平台子客企业员工的标识OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人, 仅展示已经实名的经办人信息注：如果传进来的OpenId已经实名并且加入企业，则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参（会用此OpenId实名的身份证和登录的手机号覆盖）
  - setOpenId
```
public void setOpenId(String OpenId)
```
    Set 第三方平台子客企业员工的标识OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人, 仅展示已经实名的经办人信息注：如果传进来的OpenId已经实名并且加入企业，则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参（会用此OpenId实名的身份证和登录的手机号覆盖）
    
    Parameters:
    
    OpenId - 第三方平台子客企业员工的标识OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人, 仅展示已经实名的经办人信息注：如果传进来的OpenId已经实名并且加入企业，则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参（会用此OpenId实名的身份证和登录的手机号覆盖）
  - 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，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）
  - getJumpUrl
```
public String getJumpUrl()
```
    Get 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。
    
    Returns:
    
    JumpUrl 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。
  - setJumpUrl
```
public void setJumpUrl(String JumpUrl)
```
    Set 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。
    
    Parameters:
    
    JumpUrl - 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。
  - getOperator
```
@Deprecated
public UserInfo getOperator()
```
    Deprecated.
    
    Get 暂未开放
    
    Returns:
    
    Operator 暂未开放
  - setOperator
```
@Deprecated
public void setOperator(UserInfo Operator)
```
    Deprecated.
    
    Set 暂未开放
    
    Parameters:
    
    Operator - 暂未开放
  - getHides
```
public Long[] getHides()
```
    Get 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
    - **0** :合同签署页面更多操作按钮
    - **1** :合同签署页面更多操作的拒绝签署按钮
    - **2** :合同签署页面更多操作的转他人处理按钮
    - **3** :签署成功页的查看详情按钮
    注: `字段为数组, 可以传值隐藏多个按钮`
    Returns:
    Hides 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
    **0** :合同签署页面更多操作按钮
    
    **1** :合同签署页面更多操作的拒绝签署按钮
    
    **2** :合同签署页面更多操作的转他人处理按钮
    
    **3** :签署成功页的查看详情按钮
    注: `字段为数组, 可以传值隐藏多个按钮`
  - setHides
```
public void setHides(Long[] Hides)
```
    Set 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
    - **0** :合同签署页面更多操作按钮
    - **1** :合同签署页面更多操作的拒绝签署按钮
    - **2** :合同签署页面更多操作的转他人处理按钮
    - **3** :签署成功页的查看详情按钮
    注: `字段为数组, 可以传值隐藏多个按钮`
    Parameters:
    Hides - 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
    **0** :合同签署页面更多操作按钮
    
    **1** :合同签署页面更多操作的拒绝签署按钮
    
    **2** :合同签署页面更多操作的转他人处理按钮
    
    **3** :签署成功页的查看详情按钮
    注: `字段为数组, 可以传值隐藏多个按钮`
  - getRecipientIds
```
public String[] getRecipientIds()
```
    Get 参与方角色ID，用于生成动态签署人链接完成领取。注：`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`，
    
    Returns:
    
    RecipientIds 参与方角色ID，用于生成动态签署人链接完成领取。注：`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`，
  - setRecipientIds
```
public void setRecipientIds(String[] RecipientIds)
```
    Set 参与方角色ID，用于生成动态签署人链接完成领取。注：`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`，
    
    Parameters:
    
    RecipientIds - 参与方角色ID，用于生成动态签署人链接完成领取。注：`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`，
  - getFlowGroupUrlInfo
```
public FlowGroupUrlInfo getFlowGroupUrlInfo()
```
    Get 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
    
    Returns:
    
    FlowGroupUrlInfo 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
  - setFlowGroupUrlInfo
```
public void setFlowGroupUrlInfo(FlowGroupUrlInfo FlowGroupUrlInfo)
```
    Set 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
    
    Parameters:
    
    FlowGroupUrlInfo - 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class CreateSignUrlsRequest

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

CreateSignUrlsRequest

CreateSignUrlsRequest

Method Detail

getAgent

setAgent

getFlowIds

setFlowIds

getFlowGroupId

setFlowGroupId

getEndpoint

setEndpoint

getGenerateType

setGenerateType

getOrganizationName

setOrganizationName

getName

setName

getMobile

setMobile

getIdCardType

setIdCardType

getIdCardNumber

setIdCardNumber

getOrganizationOpenId

setOrganizationOpenId

getOpenId

setOpenId

getAutoJumpBack

setAutoJumpBack

getJumpUrl

setJumpUrl

getOperator

setOperator

getHides

setHides

getRecipientIds

setRecipientIds

getFlowGroupUrlInfo

setFlowGroupUrlInfo

toMap