public class CreateFlowByFilesRequest extends AbstractModel
header, skipSign| Constructor and Description | 
|---|
| CreateFlowByFilesRequest() | 
| CreateFlowByFilesRequest(CreateFlowByFilesRequest 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 | 
|---|---|
| Agent | getAgent()Get 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 | 
| ApproverInfo[] | getApprovers()Get 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。 | 
| String | getApproverVerifyType()Get 指定个人签署方查看合同的校验方式
   **VerifyCheck**  :(默认)人脸识别,人脸识别后才能合同内容 
   **MobileCheck**  :  手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证) | 
| String | getAutoSignScene()Get 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
 **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签)   **OTHER** :  通用场景
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。` | 
| CcInfo[] | getCcInfos()Get 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
注
1. | 
| Long | getCcNotifyType()Get 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
 **0**:合同发起时通知(默认值)
 **1**:签署完成后通知 | 
| Component[] | getComponents()Get 发起的时候合成到PDF上的填写控件(需要提供填写控件的内容)
 单行文本控件      
 多行文本控件      
 勾选框控件        
 数字控件          
 图片控件          
 水印控件等          
 | 
| String | getCustomShowMap()Get 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
{合同名称}   
{发起方企业} 
{发起方姓名} 
{签署方N企业}
{签署方N姓名}
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
合同名称:租房合同 
发起方:腾讯公司(张三) 
签署方:李四
 | 
| Long | getDeadline()Get 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。 | 
| String[] | getFileIds()Get 本合同流程需包含的PDF文件资源编号列表,通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。
注:  `目前,此接口仅支持单个文件发起。` | 
| String | getFlowDescription()Get 合同流程描述信息(可自定义此描述),最大长度1000个字符。 | 
| Long | getFlowDisplayType()Get 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:   0 :合同(默认值)  1 :文件  2 :协议 3 :文书效果如下: | 
| String | getFlowName()Get 自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&)、(+)组成。
该名称还将用于合同签署完成后文件下载的默认文件名称。 | 
| String | getFlowType()Get 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
如果用户已经在控制台创建了自定义合同类型,可以将这里的类型名称传入。 如果没有创建,我们会自动给发起方公司创建此自定义合同类型。
 | 
| Boolean | getNeedPreview()Get 是否为预览模式,取值如下:
 **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。
 **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 | 
| Boolean | getNeedSignReview()Get 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
 **false**:(默认)不需要审批,直接签署。
 **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同` | 
| Boolean | getOpenDynamicSignFlow()Get 是否开启动态签署合同:
 **true**:开启动态签署合同,可在签署过程中追加签署人(必须满足:1,发起方企业开启了模块化计费能力;2,发起方企业在企业应用管理中开启了动态签署人2.0能力)    。
 **false**:不开启动态签署合同。 | 
| UserInfo | getOperator()Get 本合同的发起人  点击查看合同发起人展示的位置
注: 支持填入集团子公司经办人 userId 代发合同。 | 
| Long | getPreviewType()Get 预览模式下产生的预览链接类型 
 **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 
 **1** :H5链接 ,点开后在浏览器中展示合同的样子
注: `此参数在NeedPreview 为true时有效` | 
| Long | getRemindedOn()Get 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。 | 
| Long | getSignBeanTag()Get 签署方签署控件(印章/签名等)的生成方式:
 **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。
 **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。
注:签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署,不支持H5 | 
| Boolean | getUnordered()Get 合同流程的签署顺序类型:
 **false**:(默认)有序签署, 本合同多个参与人需要依次签署 
 **true**:无序签署, 本合同多个参与人没有先后签署限制 | 
| String | getUserData()Get 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。 | 
| void | setAgent(Agent Agent)Set 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 | 
| void | setApprovers(ApproverInfo[] Approvers)Set 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。 | 
| void | setApproverVerifyType(String ApproverVerifyType)Set 指定个人签署方查看合同的校验方式
   **VerifyCheck**  :(默认)人脸识别,人脸识别后才能合同内容 
   **MobileCheck**  :  手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证) | 
| void | setAutoSignScene(String AutoSignScene)Set 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
 **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签)   **OTHER** :  通用场景
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。` | 
| void | setCcInfos(CcInfo[] CcInfos)Set 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
注
1. | 
| void | setCcNotifyType(Long CcNotifyType)Set 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
 **0**:合同发起时通知(默认值)
 **1**:签署完成后通知 | 
| void | setComponents(Component[] Components)Set 发起的时候合成到PDF上的填写控件(需要提供填写控件的内容)
 单行文本控件      
 多行文本控件      
 勾选框控件        
 数字控件          
 图片控件          
 水印控件等          
 | 
| void | setCustomShowMap(String CustomShowMap)Set 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
{合同名称}   
{发起方企业} 
{发起方姓名} 
{签署方N企业}
{签署方N姓名}
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
合同名称:租房合同 
发起方:腾讯公司(张三) 
签署方:李四
 | 
| void | setDeadline(Long Deadline)Set 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。 | 
| void | setFileIds(String[] FileIds)Set 本合同流程需包含的PDF文件资源编号列表,通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。
注:  `目前,此接口仅支持单个文件发起。` | 
| void | setFlowDescription(String FlowDescription)Set 合同流程描述信息(可自定义此描述),最大长度1000个字符。 | 
| void | setFlowDisplayType(Long FlowDisplayType)Set 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:   0 :合同(默认值)  1 :文件  2 :协议 3 :文书效果如下: | 
| void | setFlowName(String FlowName)Set 自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&)、(+)组成。
该名称还将用于合同签署完成后文件下载的默认文件名称。 | 
| void | setFlowType(String FlowType)Set 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
如果用户已经在控制台创建了自定义合同类型,可以将这里的类型名称传入。 如果没有创建,我们会自动给发起方公司创建此自定义合同类型。
 | 
| void | setNeedPreview(Boolean NeedPreview)Set 是否为预览模式,取值如下:
 **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。
 **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 | 
| void | setNeedSignReview(Boolean NeedSignReview)Set 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
 **false**:(默认)不需要审批,直接签署。
 **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同` | 
| void | setOpenDynamicSignFlow(Boolean OpenDynamicSignFlow)Set 是否开启动态签署合同:
 **true**:开启动态签署合同,可在签署过程中追加签署人(必须满足:1,发起方企业开启了模块化计费能力;2,发起方企业在企业应用管理中开启了动态签署人2.0能力)    。
 **false**:不开启动态签署合同。 | 
| void | setOperator(UserInfo Operator)Set 本合同的发起人  点击查看合同发起人展示的位置
注: 支持填入集团子公司经办人 userId 代发合同。 | 
| void | setPreviewType(Long PreviewType)Set 预览模式下产生的预览链接类型 
 **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 
 **1** :H5链接 ,点开后在浏览器中展示合同的样子
注: `此参数在NeedPreview 为true时有效` | 
| void | setRemindedOn(Long RemindedOn)Set 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。 | 
| void | setSignBeanTag(Long SignBeanTag)Set 签署方签署控件(印章/签名等)的生成方式:
 **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。
 **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。
注:签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署,不支持H5 | 
| void | setUnordered(Boolean Unordered)Set 合同流程的签署顺序类型:
 **false**:(默认)有序签署, 本合同多个参与人需要依次签署 
 **true**:无序签署, 本合同多个参与人没有先后签署限制 | 
| void | setUserData(String UserData)Set 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。 | 
| 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, toJsonStringpublic CreateFlowByFilesRequest()
public CreateFlowByFilesRequest(CreateFlowByFilesRequest source)
public UserInfo getOperator()
public void setOperator(UserInfo Operator)
Operator - 本合同的发起人  点击查看合同发起人展示的位置
注: 支持填入集团子公司经办人 userId 代发合同。public String getFlowName()
public void setFlowName(String FlowName)
FlowName - 自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&)、(+)组成。
该名称还将用于合同签署完成后文件下载的默认文件名称。public ApproverInfo[] getApprovers()
public void setApprovers(ApproverInfo[] Approvers)
Approvers - 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。public String[] getFileIds()
public void setFileIds(String[] FileIds)
FileIds - 本合同流程需包含的PDF文件资源编号列表,通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。
注:  `目前,此接口仅支持单个文件发起。`public String getFlowDescription()
public void setFlowDescription(String FlowDescription)
FlowDescription - 合同流程描述信息(可自定义此描述),最大长度1000个字符。public String getFlowType()
public void setFlowType(String FlowType)
FlowType - 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
如果用户已经在控制台创建了自定义合同类型,可以将这里的类型名称传入。 如果没有创建,我们会自动给发起方公司创建此自定义合同类型。
public Component[] getComponents()
public void setComponents(Component[] Components)
Components - 发起的时候合成到PDF上的填写控件(需要提供填写控件的内容)
public CcInfo[] getCcInfos()
public void setCcInfos(CcInfo[] CcInfos)
CcInfos - 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
注
1. 抄送人名单中可以包括自然人以及本企业的员工。
2. 请确保抄送人列表中的成员不与任何签署人重复。public Long getCcNotifyType()
public void setCcNotifyType(Long CcNotifyType)
CcNotifyType - 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
public Boolean getNeedPreview()
public void setNeedPreview(Boolean NeedPreview)
NeedPreview - 是否为预览模式,取值如下:
public Long getPreviewType()
public void setPreviewType(Long PreviewType)
PreviewType - 预览模式下产生的预览链接类型 
public Long getDeadline()
public void setDeadline(Long Deadline)
Deadline - 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。public Boolean getUnordered()
public void setUnordered(Boolean Unordered)
Unordered - 合同流程的签署顺序类型:
public String getUserData()
public void setUserData(String UserData)
UserData - 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。public Long getRemindedOn()
public void setRemindedOn(Long RemindedOn)
RemindedOn - 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。public String getApproverVerifyType()
public void setApproverVerifyType(String ApproverVerifyType)
ApproverVerifyType - 指定个人签署方查看合同的校验方式
public Long getSignBeanTag()
public void setSignBeanTag(Long SignBeanTag)
SignBeanTag - 签署方签署控件(印章/签名等)的生成方式:
public String getCustomShowMap()
public void setCustomShowMap(String CustomShowMap)
CustomShowMap - 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
public Agent getAgent()
public void setAgent(Agent Agent)
Agent - 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。public String getAutoSignScene()
public void setAutoSignScene(String AutoSignScene)
AutoSignScene - 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
public Boolean getNeedSignReview()
public void setNeedSignReview(Boolean NeedSignReview)
NeedSignReview - 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
public Long getFlowDisplayType()
public void setFlowDisplayType(Long FlowDisplayType)
FlowDisplayType - 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:  public Boolean getOpenDynamicSignFlow()
public void setOpenDynamicSignFlow(Boolean OpenDynamicSignFlow)
OpenDynamicSignFlow - 是否开启动态签署合同:
Copyright © 2025. All rights reserved.