com.tencentcloudapi.essbasic.v20210526.models

Class ChannelCreateBatchSignUrlRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.essbasic.v20210526.models.ChannelCreateBatchSignUrlRequest

public class ChannelCreateBatchSignUrlRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ChannelCreateBatchSignUrlRequest()
ChannelCreateBatchSignUrlRequest(ChannelCreateBatchSignUrlRequest 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

Modifier and Type	Method and Description
Agent	getAgent() Get 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经过实名认证
FlowBatchUrlInfo	getFlowBatchUrlInfo() Get 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
String[]	getFlowIds() Get 批量签署的合同流程ID数组。 注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
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** : 港澳台居民居住证(格式同居民身份证) 注：`请确保和合同中填入的一致`
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 目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。 注： 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。 请确保此企业已完成腾讯电子签企业认证。 暂时仅支持给`自建应用集成企业` 生成员工批签链接，不支持子客企业。
void	setAgent(Agent Agent) Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经过实名认证
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位字符串。 注：`请确保和合同中填入的一致`
void	setIdCardType(String IdCardType) Set 证件类型，支持以下类型 **ID_CARD** : 居民身份证 (默认值) **HONGKONG_AND_MACAO** : 港澳居民来往内地通行证 **HONGKONG_MACAO_AND_TAIWAN** : 港澳台居民居住证(格式同居民身份证) 注：`请确保和合同中填入的一致`
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	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

ChannelCreateBatchSignUrlRequest

public ChannelCreateBatchSignUrlRequest()

ChannelCreateBatchSignUrlRequest

public ChannelCreateBatchSignUrlRequest(ChannelCreateBatchSignUrlRequest 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

第三方平台子客企业和员工必须已经过实名认证

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前缀或其他字符)。 请确认手机号所有方为此业务通知方。 注：`请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`

getOperator

public UserInfo getOperator()

Get 执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`

Returns:

Operator 执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`

setOperator

public void setOperator(UserInfo Operator)

Set 执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`

Parameters:

Operator - 执行本接口操作的员工信息。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`

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位字符串。

注：`请确保和合同中填入的一致`

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 - 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel