public class ApproverInfo extends AbstractModel
header, skipSign
Constructor and Description |
---|
ApproverInfo() |
ApproverInfo(ApproverInfo 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.
|
Modifier and Type | Method and Description |
---|---|
ComponentLimit[] |
getAddSignComponentsLimits()
Get [用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID或者印章类型)或签名方式。
注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
|
String |
getApproverIdCardNumber()
Get 签署方经办人的证件号码,应符合以下规则
中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。
中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。
|
String |
getApproverIdCardType()
Get 签署方经办人的证件类型,支持以下类型,样式可以参考常见个人证件类型介绍
ID_CARD 中国大陆居民身份证 (默认值)
HONGKONG_AND_MACAO 港澳居民来往内地通行证
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
OTHER_CARD_TYPE 其他证件
注:
1.
|
String |
getApproverMobile()
Get 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此合同签署方。
|
String |
getApproverName()
Get 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
Boolean |
getApproverNeedSignReview()
Get 此签署人(员工或者个人)签署前,是否需要发起方企业审批,取值如下:
**false**:(默认)不需要审批,直接签署。
**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
注:`此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同`

|
ApproverOption |
getApproverOption()
Get 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。
详细操作可以参考开发者中心的ApproverOption结构体。
|
Long |
getApproverRole()
Get 收据场景设置签署人角色类型, 可以设置如下类型:
**1** :收款人
**2** :开具人
**3** :见证人
注: `收据场景为白名单功能,使用前请联系对接的客户经理沟通。`
|
String |
getApproverRoleName()
Get 可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。
注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
|
Long[] |
getApproverSignTypes()
Get 您可以指定签署方签署合同的认证校验方式,可传递以下值:
**1**:人脸认证,需进行人脸识别成功后才能签署合同;
**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;
**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)
**5**:设备指纹识别,需要对比手机机主预留的指纹信息,校验一致才能成功进行合同签署。(iOS系统暂不支持该校验方式)
**6**:设备面容识别,需要对比手机机主预留的人脸信息,校验一致才能成功进行合同签署。(Android系统暂不支持该校验方式)
默认为:
1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)
注:
1.
|
String |
getApproverSource()
Get 在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。
|
Long |
getApproverType()
Get 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
0**:企业
1**:个人
3**:企业静默签署
注:`类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。`
7**: 个人自动签署,适用于个人自动签场景。
注: `个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。`
|
Long[] |
getApproverVerifyTypes()
Get 指定个人签署方查看合同的校验方式,可以传值如下:
**1** : (默认)人脸识别,人脸识别后才能合同内容
**2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
注:
如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
此字段可传多个校验方式
|
Component[] |
getComponents()
Get 签署人在合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
单行文本控件
多行文本控件
勾选框控件
数字控件
图片控件
具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/company/createFlowByFiles/#指定签署方填写控件)
注:`此参数仅在通过文件发起合同或者合同组时生效`
|
String |
getCustomApproverTag()
Get 在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
所有参与或签的人员均需具备该标识。
注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。
|
Long |
getDeadline()
Get 签署人的签署截止时间,格式为Unix标准时间戳(秒)
注: `若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同`
|
String |
getNotifyType()
Get 通知签署方经办人的方式, 有以下途径:
**sms** : (默认)短信
**none** : 不通知
注意:
`如果使用的是通过文件发起合同(CreateFlowByFiles),NotifyType必须 是 sms 才会发送短信`
|
String |
getOrganizationName()
Get 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号(),请使用中文括号()代替。
如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
|
Long |
getPreReadTime()
Get 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
合同页数少于等于2页,阅读时间为3秒;
合同页数为3到5页,阅读时间为5秒;
合同页数大于等于6页,阅读时间为10秒。
|
Component[] |
getSignComponents()
Get 合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
个人签名/印章
企业印章
骑缝章等签署控件
|
String[] |
getSignEndpoints()
Get 进入签署流程的限制,目前支持以下选项:
空值(默认) :无限制,可在任何场景进入签署流程。 link :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。
|
String |
getSignInstructionContent()
Get 签署须知:支持传入富文本,最长字数:500个中文字符
|
String |
getUserId()
Get 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
注:
如果传进来的UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参(会用此UserId实名的身份证和登录的手机号覆盖)
|
String[] |
getVerifyChannel()
Get 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
|
void |
setAddSignComponentsLimits(ComponentLimit[] AddSignComponentsLimits)
Set [用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID或者印章类型)或签名方式。
注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
|
void |
setApproverIdCardNumber(String ApproverIdCardNumber)
Set 签署方经办人的证件号码,应符合以下规则
中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。
中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。
|
void |
setApproverIdCardType(String ApproverIdCardType)
Set 签署方经办人的证件类型,支持以下类型,样式可以参考常见个人证件类型介绍
ID_CARD 中国大陆居民身份证 (默认值)
HONGKONG_AND_MACAO 港澳居民来往内地通行证
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
OTHER_CARD_TYPE 其他证件
注:
1.
|
void |
setApproverMobile(String ApproverMobile)
Set 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此合同签署方。
|
void |
setApproverName(String ApproverName)
Set 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
void |
setApproverNeedSignReview(Boolean ApproverNeedSignReview)
Set 此签署人(员工或者个人)签署前,是否需要发起方企业审批,取值如下:
**false**:(默认)不需要审批,直接签署。
**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
注:`此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同`

|
void |
setApproverOption(ApproverOption ApproverOption)
Set 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。
详细操作可以参考开发者中心的ApproverOption结构体。
|
void |
setApproverRole(Long ApproverRole)
Set 收据场景设置签署人角色类型, 可以设置如下类型:
**1** :收款人
**2** :开具人
**3** :见证人
注: `收据场景为白名单功能,使用前请联系对接的客户经理沟通。`
|
void |
setApproverRoleName(String ApproverRoleName)
Set 可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。
注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
|
void |
setApproverSignTypes(Long[] ApproverSignTypes)
Set 您可以指定签署方签署合同的认证校验方式,可传递以下值:
**1**:人脸认证,需进行人脸识别成功后才能签署合同;
**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;
**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)
**5**:设备指纹识别,需要对比手机机主预留的指纹信息,校验一致才能成功进行合同签署。(iOS系统暂不支持该校验方式)
**6**:设备面容识别,需要对比手机机主预留的人脸信息,校验一致才能成功进行合同签署。(Android系统暂不支持该校验方式)
默认为:
1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)
注:
1.
|
void |
setApproverSource(String ApproverSource)
Set 在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。
|
void |
setApproverType(Long ApproverType)
Set 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
0**:企业
1**:个人
3**:企业静默签署
注:`类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。`
7**: 个人自动签署,适用于个人自动签场景。
注: `个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。`
|
void |
setApproverVerifyTypes(Long[] ApproverVerifyTypes)
Set 指定个人签署方查看合同的校验方式,可以传值如下:
**1** : (默认)人脸识别,人脸识别后才能合同内容
**2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
注:
如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
此字段可传多个校验方式
|
void |
setComponents(Component[] Components)
Set 签署人在合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
单行文本控件
多行文本控件
勾选框控件
数字控件
图片控件
具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/company/createFlowByFiles/#指定签署方填写控件)
注:`此参数仅在通过文件发起合同或者合同组时生效`
|
void |
setCustomApproverTag(String CustomApproverTag)
Set 在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
所有参与或签的人员均需具备该标识。
注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。
|
void |
setDeadline(Long Deadline)
Set 签署人的签署截止时间,格式为Unix标准时间戳(秒)
注: `若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同`
|
void |
setNotifyType(String NotifyType)
Set 通知签署方经办人的方式, 有以下途径:
**sms** : (默认)短信
**none** : 不通知
注意:
`如果使用的是通过文件发起合同(CreateFlowByFiles),NotifyType必须 是 sms 才会发送短信`
|
void |
setOrganizationName(String OrganizationName)
Set 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号(),请使用中文括号()代替。
如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
|
void |
setPreReadTime(Long PreReadTime)
Set 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
合同页数少于等于2页,阅读时间为3秒;
合同页数为3到5页,阅读时间为5秒;
合同页数大于等于6页,阅读时间为10秒。
|
void |
setSignComponents(Component[] SignComponents)
Set 合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
个人签名/印章
企业印章
骑缝章等签署控件
|
void |
setSignEndpoints(String[] SignEndpoints)
Set 进入签署流程的限制,目前支持以下选项:
空值(默认) :无限制,可在任何场景进入签署流程。 link :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。
|
void |
setSignInstructionContent(String SignInstructionContent)
Set 签署须知:支持传入富文本,最长字数:500个中文字符
|
void |
setUserId(String UserId)
Set 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
注:
如果传进来的UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参(会用此UserId实名的身份证和登录的手机号覆盖)
|
void |
setVerifyChannel(String[] VerifyChannel)
Set 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public ApproverInfo()
public ApproverInfo(ApproverInfo source)
public Long getApproverType()
public void setApproverType(Long ApproverType)
ApproverType
- 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
0**:企业
1**:个人
3**:企业静默签署
注:`类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。`
7**: 个人自动签署,适用于个人自动签场景。
注: `个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。`public String getApproverName()
public void setApproverName(String ApproverName)
ApproverName
- 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。public String getApproverMobile()
public void setApproverMobile(String ApproverMobile)
ApproverMobile
- 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此合同签署方。public String getOrganizationName()
public void setOrganizationName(String OrganizationName)
OrganizationName
- 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号(),请使用中文括号()代替。
如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。public Component[] getSignComponents()
public void setSignComponents(Component[] SignComponents)
SignComponents
- 合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
public String getApproverIdCardType()
public void setApproverIdCardType(String ApproverIdCardType)
ApproverIdCardType
- 签署方经办人的证件类型,支持以下类型,样式可以参考常见个人证件类型介绍
public String getApproverIdCardNumber()
public void setApproverIdCardNumber(String ApproverIdCardNumber)
ApproverIdCardNumber
- 签署方经办人的证件号码,应符合以下规则
public String getNotifyType()
public void setNotifyType(String NotifyType)
NotifyType
- 通知签署方经办人的方式, 有以下途径:
public Long getApproverRole()
public void setApproverRole(Long ApproverRole)
ApproverRole
- 收据场景设置签署人角色类型, 可以设置如下类型:
public String getApproverRoleName()
public void setApproverRoleName(String ApproverRoleName)
ApproverRoleName
- 可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。
注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`public String[] getVerifyChannel()
public void setVerifyChannel(String[] VerifyChannel)
VerifyChannel
- 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置public Long getPreReadTime()
public void setPreReadTime(Long PreReadTime)
PreReadTime
- 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
public String getUserId()
public void setUserId(String UserId)
UserId
- 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
注:
如果传进来的UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参(会用此UserId实名的身份证和登录的手机号覆盖)public String getApproverSource()
public void setApproverSource(String ApproverSource)
ApproverSource
- 在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。public String getCustomApproverTag()
public void setCustomApproverTag(String CustomApproverTag)
CustomApproverTag
- 在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
所有参与或签的人员均需具备该标识。
注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。public ApproverOption getApproverOption()
public void setApproverOption(ApproverOption ApproverOption)
ApproverOption
- 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。
详细操作可以参考开发者中心的ApproverOption结构体。public Long[] getApproverVerifyTypes()
public void setApproverVerifyTypes(Long[] ApproverVerifyTypes)
ApproverVerifyTypes
- 指定个人签署方查看合同的校验方式,可以传值如下:
public Long[] getApproverSignTypes()
public void setApproverSignTypes(Long[] ApproverSignTypes)
ApproverSignTypes
- 您可以指定签署方签署合同的认证校验方式,可传递以下值:
public Boolean getApproverNeedSignReview()
public void setApproverNeedSignReview(Boolean ApproverNeedSignReview)
ApproverNeedSignReview
- 此签署人(员工或者个人)签署前,是否需要发起方企业审批,取值如下:
public ComponentLimit[] getAddSignComponentsLimits()
public void setAddSignComponentsLimits(ComponentLimit[] AddSignComponentsLimits)
AddSignComponentsLimits
- [用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID或者印章类型)或签名方式。
注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`public String getSignInstructionContent()
public void setSignInstructionContent(String SignInstructionContent)
SignInstructionContent
- 签署须知:支持传入富文本,最长字数:500个中文字符public Long getDeadline()
public void setDeadline(Long Deadline)
Deadline
- 签署人的签署截止时间,格式为Unix标准时间戳(秒)
注: `若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同`public Component[] getComponents()
public void setComponents(Component[] Components)
Components
- 签署人在合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
public String[] getSignEndpoints()
public void setSignEndpoints(String[] SignEndpoints)
SignEndpoints
- 进入签署流程的限制,目前支持以下选项:
Copyright © 2025. All rights reserved.