public class FlowInfo extends AbstractModel
header, skipSign| Constructor and Description | 
|---|
| FlowInfo() | 
| FlowInfo(FlowInfo 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 | 
|---|---|
| String | getAutoSignScene()Get 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
 **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签)   **OTHER** :  通用场景
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。` | 
| String | getCallbackUrl()Deprecated.   | 
| CcInfo[] | getCcInfos()Get 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
注
1. | 
| Long | getCcNotifyType()Get 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
 **0** :合同发起时通知通知对方来查看合同(默认)
 **1** : 签署完成后通知对方来查看合同 | 
| String | getCustomerData()Get 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。 | 
| String | getCustomShowMap()Get 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
{合同名称}   
{发起方企业} 
{发起方姓名} 
{签署方N企业}
{签署方N姓名}
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
合同名称:租房合同 
发起方:腾讯公司(张三) 
签署方:李四
 | 
| Long | getDeadline()Get 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
示例值:1604912664 | 
| FlowApproverInfo[] | getFlowApprovers()Get 合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)
注:  
  在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。
例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。
[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png) | 
| String | getFlowDescription()Get 合同流程描述信息(可自定义此描述),最大长度1000个字符。 | 
| Long | getFlowDisplayType()Get 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:   0 :合同(默认值)  1 :文件  2 :协议 3 :文书效果如下: | 
| String | getFlowName()Get 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。 | 
| String | getFlowType()Get 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。 | 
| FormField[] | getFormFields()Get 发起方角色的填写控件的填充内容。
注:只有在控制台编辑模板时,归属给发起方的填写控件(如下图)才能在创建文档的时候进行内容填充。(白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方)。
 | 
| Boolean | getNeedSignReview()Get 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
 **false**:(默认)不需要审批,直接签署。
 **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同` | 
| String | getTemplateId()Get 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
如果使用模板发起接口,此参数为必填。
可以通过生成子客登录链接登录企业控制台, 在**企业模板**中得到合同模板ID。
[点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png) | 
| void | setAutoSignScene(String AutoSignScene)Set 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
 **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签)   **OTHER** :  通用场景
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。` | 
| void | setCallbackUrl(String CallbackUrl)Deprecated.   | 
| void | setCcInfos(CcInfo[] CcInfos)Set 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
注
1. | 
| void | setCcNotifyType(Long CcNotifyType)Set 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
 **0** :合同发起时通知通知对方来查看合同(默认)
 **1** : 签署完成后通知对方来查看合同 | 
| void | setCustomerData(String CustomerData)Set 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。 | 
| void | setCustomShowMap(String CustomShowMap)Set 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
{合同名称}   
{发起方企业} 
{发起方姓名} 
{签署方N企业}
{签署方N姓名}
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
合同名称:租房合同 
发起方:腾讯公司(张三) 
签署方:李四
 | 
| void | setDeadline(Long Deadline)Set 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
示例值:1604912664 | 
| void | setFlowApprovers(FlowApproverInfo[] FlowApprovers)Set 合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)
注:  
  在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。
例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。
[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png) | 
| 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 | setFormFields(FormField[] FormFields)Set 发起方角色的填写控件的填充内容。
注:只有在控制台编辑模板时,归属给发起方的填写控件(如下图)才能在创建文档的时候进行内容填充。(白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方)。
 | 
| void | setNeedSignReview(Boolean NeedSignReview)Set 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
 **false**:(默认)不需要审批,直接签署。
 **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同` | 
| void | setTemplateId(String TemplateId)Set 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
如果使用模板发起接口,此参数为必填。
可以通过生成子客登录链接登录企业控制台, 在**企业模板**中得到合同模板ID。
[点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png) | 
| 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 FlowInfo()
public FlowInfo(FlowInfo source)
public String getFlowName()
public void setFlowName(String FlowName)
FlowName - 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。public Long getDeadline()
public void setDeadline(Long Deadline)
Deadline - 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
示例值:1604912664public String getTemplateId()
public void setTemplateId(String TemplateId)
TemplateId - 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
如果使用模板发起接口,此参数为必填。
可以通过生成子客登录链接登录企业控制台, 在**企业模板**中得到合同模板ID。
[点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)public FlowApproverInfo[] getFlowApprovers()
public void setFlowApprovers(FlowApproverInfo[] FlowApprovers)
FlowApprovers - 合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)
注:  
  在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。
例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。
[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)public FormField[] getFormFields()
public void setFormFields(FormField[] FormFields)
FormFields - 发起方角色的填写控件的填充内容。
注:只有在控制台编辑模板时,归属给发起方的填写控件(如下图)才能在创建文档的时候进行内容填充。(白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方)。
@Deprecated public String getCallbackUrl()
@Deprecated public void setCallbackUrl(String CallbackUrl)
CallbackUrl - 该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息public String getFlowType()
public void setFlowType(String FlowType)
FlowType - 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。public String getFlowDescription()
public void setFlowDescription(String FlowDescription)
FlowDescription - 合同流程描述信息(可自定义此描述),最大长度1000个字符。public String getCustomerData()
public void setCustomerData(String CustomerData)
CustomerData - 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。public String getCustomShowMap()
public void setCustomShowMap(String CustomShowMap)
CustomShowMap - 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
public CcInfo[] getCcInfos()
public void setCcInfos(CcInfo[] CcInfos)
CcInfos - 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
注
1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。
2. 请确保抄送人列表中的成员不与任何签署人重复。public Boolean getNeedSignReview()
public void setNeedSignReview(Boolean NeedSignReview)
NeedSignReview - 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
public Long getCcNotifyType()
public void setCcNotifyType(Long CcNotifyType)
CcNotifyType - 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
public String getAutoSignScene()
public void setAutoSignScene(String AutoSignScene)
AutoSignScene - 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
public Long getFlowDisplayType()
public void setFlowDisplayType(Long FlowDisplayType)
FlowDisplayType - 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:  Copyright © 2025. All rights reserved.