Class: TencentCloud::Essbasic::V20210526::ChannelCreateFlowByFilesRequest

Inherits:
Common::AbstractModel
  • Object
show all
Extended by:
Gem::Deprecate
Defined in:
lib/v20210526/models.rb

Overview

ChannelCreateFlowByFiles请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(agent = nil, flowname = nil, flowdescription = nil, flowapprovers = nil, fileids = nil, components = nil, deadline = nil, callbackurl = nil, unordered = nil, flowtype = nil, customshowmap = nil, customerdata = nil, needsignreview = nil, approververifytype = nil, signbeantag = nil, ccinfos = nil, ccnotifytype = nil, autosignscene = nil, operator = nil, flowdisplaytype = nil, needpreview = nil, previewtype = nil, opendynamicflow = nil, opendynamicsignflow = nil) ⇒ ChannelCreateFlowByFilesRequest

Returns a new instance of ChannelCreateFlowByFilesRequest.



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
 
# File 'lib/v20210526/models.rb', line 1906

def initialize(agent=nil, flowname=nil, flowdescription=nil, flowapprovers=nil, fileids=nil, components=nil, deadline=nil, callbackurl=nil, unordered=nil, flowtype=nil, customshowmap=nil, customerdata=nil, needsignreview=nil, approververifytype=nil, signbeantag=nil, ccinfos=nil, ccnotifytype=nil, autosignscene=nil, operator=nil, flowdisplaytype=nil, needpreview=nil, previewtype=nil, opendynamicflow=nil, opendynamicsignflow=nil)
  @Agent = agent
  @FlowName = flowname
  @FlowDescription = flowdescription
  @FlowApprovers = flowapprovers
  @FileIds = fileids
  @Components = components
  @Deadline = deadline
  @CallbackUrl = callbackurl
  @Unordered = unordered
  @FlowType = flowtype
  @CustomShowMap = customshowmap
  @CustomerData = customerdata
  @NeedSignReview = needsignreview
  @ApproverVerifyType = approververifytype
  @SignBeanTag = signbeantag
  @CcInfos = ccinfos
  @CcNotifyType = ccnotifytype
  @AutoSignScene = autosignscene
  @Operator = operator
  @FlowDisplayType = flowdisplaytype
  @NeedPreview = needpreview
  @PreviewType = previewtype
  @OpenDynamicFlow = opendynamicflow
  @OpenDynamicSignFlow = opendynamicsignflow
end

Instance Attribute Details

#Agent ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def Agent
  @Agent
end

#ApproverVerifyType ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def ApproverVerifyType
  @ApproverVerifyType
end

#AutoSignScene ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def AutoSignScene
  @AutoSignScene
end

#CallbackUrl ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def CallbackUrl
  @CallbackUrl
end

#CcInfos ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def CcInfos
  @CcInfos
end

#CcNotifyType ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def CcNotifyType
  @CcNotifyType
end

#Components ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def Components
  @Components
end

#CustomerData ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def CustomerData
  @CustomerData
end

#CustomShowMap ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def CustomShowMap
  @CustomShowMap
end

#Deadline ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def Deadline
  @Deadline
end

#FileIds ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def FileIds
  @FileIds
end

#FlowApprovers ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def FlowApprovers
  @FlowApprovers
end

#FlowDescription ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def FlowDescription
  @FlowDescription
end

#FlowDisplayType ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def FlowDisplayType
  @FlowDisplayType
end

#FlowName ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def FlowName
  @FlowName
end

#FlowType ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def FlowType
  @FlowType
end

#NeedPreview ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def NeedPreview
  @NeedPreview
end

#NeedSignReview ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def NeedSignReview
  @NeedSignReview
end

#OpenDynamicFlow ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def OpenDynamicFlow
  @OpenDynamicFlow
end

#OpenDynamicSignFlow ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def OpenDynamicSignFlow
  @OpenDynamicSignFlow
end

#Operator ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def Operator
  @Operator
end

#PreviewType ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def PreviewType
  @PreviewType
end

#SignBeanTag ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def SignBeanTag
  @SignBeanTag
end

#Unordered ⇒ Object

Parameters:

  • Agent: (p) —

    合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

    此接口下面信息必填。

    • 渠道应用标识: Agent.AppId
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
    • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）

  • FlowName: (p) —

    合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

  • FlowDescription: (p) —

    合同流程描述信息(可自定义此描述)，最大长度1000个字符。

  • FlowApprovers: (p) —

    合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 签署方入参指引。

    如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。

  • FileIds: (p) —

    本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。

    注: 目前，此接口仅支持单个文件发起。

  • Components: (p) —

    模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

    • 单行文本控件
    • 多行文本控件
    • 勾选框控件
    • 数字控件
    • 图片控件
    • 数据表格等填写控件

    image

  • Deadline: (p) —

    合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
    如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。

  • CallbackUrl: (p) —

    该字段已废弃，请使用【应用号配置】中的回调地址

  • Unordered: (p) —

    合同流程的签署顺序类型：

    • false：(默认)有序签署, 本合同多个参与人需要依次签署
    • true：无序签署, 本合同多个参与人没有先后签署限制
    注: 有序签署时以传入FlowApprovers数组的顺序作为签署顺序

  • FlowType: (p) —

    合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。

  • CustomShowMap: (p) —

    您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：

    • 合同名称
    • 发起方企业
    • 发起方姓名
    • 签署方N企业
    • 签署方N姓名
    其中，N表示签署方的编号，从1开始，不能超过签署人的数量。

    例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子

    合同名称：租房合同
    发起方：腾讯公司(张三)
    签署方：李四

  • CustomerData: (p) —

    调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。

    在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

  • NeedSignReview: (p) —

    发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：

    • false：（默认）不需要审批，直接签署。
    • true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同

  • ApproverVerifyType: (p) —

    签署人校验方式
    VerifyCheck: 人脸识别（默认）
    MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
    参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。

  • SignBeanTag: (p) —

    签署方签署控件（印章/签名等）的生成方式：

    • 0：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
    • 1：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。

    注:
    1.发起后添加控件功能不支持添加签批控件
    2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5

  • CcInfos: (p) —

    合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。

    注

    1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
    2. 请确保抄送人列表中的成员不与任何签署人重复。

  • CcNotifyType: (p) —

    可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：

    • 0：合同发起时通知（默认值）
    • 1：签署完成后通知

  • AutoSignScene: (p) —

    个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：

    • E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签）
    • OTHER : 通用场景
    注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。

  • Operator: (p) —

    操作者的信息，不用传

  • FlowDisplayType: (p) —

    在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

    • 0 :合同（默认值）
    • 1 :文件
    • 2 :协议
    • 3 :文书
    效果如下:FlowDisplayType

  • NeedPreview: (p) —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。

  • PreviewType: (p) —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子
    注: 此参数在NeedPreview 为true时有效

  • OpenDynamicFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人

  • OpenDynamicSignFlow: (p) —

    是否开启动态合同（动态签署人2.0）

    • false :(默认) 不开启动态合同（动态签署人2.0）
    • true :开启动态合同（动态签署人2.0）,发起时不设置签署方，发起后可继续追加合同签署人



1897
1898
1899
 
# File 'lib/v20210526/models.rb', line 1897

def Unordered
  @Unordered
end

Instance Method Details

#deserialize(params) ⇒ Object 



1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/v20210526/models.rb', line 1933

def deserialize(params)
  unless params['Agent'].nil?
    @Agent = Agent.new
    @Agent.deserialize(params['Agent'])
  end
  @FlowName = params['FlowName']
  @FlowDescription = params['FlowDescription']
  unless params['FlowApprovers'].nil?
    @FlowApprovers = []
    params['FlowApprovers'].each do |i|
      flowapproverinfo_tmp = FlowApproverInfo.new
      flowapproverinfo_tmp.deserialize(i)
      @FlowApprovers << flowapproverinfo_tmp
    end
  end
  @FileIds = params['FileIds']
  unless params['Components'].nil?
    @Components = []
    params['Components'].each do |i|
      component_tmp = Component.new
      component_tmp.deserialize(i)
      @Components << component_tmp
    end
  end
  @Deadline = params['Deadline']
  @CallbackUrl = params['CallbackUrl']
  @Unordered = params['Unordered']
  @FlowType = params['FlowType']
  @CustomShowMap = params['CustomShowMap']
  @CustomerData = params['CustomerData']
  @NeedSignReview = params['NeedSignReview']
  @ApproverVerifyType = params['ApproverVerifyType']
  @SignBeanTag = params['SignBeanTag']
  unless params['CcInfos'].nil?
    @CcInfos = []
    params['CcInfos'].each do |i|
      ccinfo_tmp = CcInfo.new
      ccinfo_tmp.deserialize(i)
      @CcInfos << ccinfo_tmp
    end
  end
  @CcNotifyType = params['CcNotifyType']
  @AutoSignScene = params['AutoSignScene']
  unless params['Operator'].nil?
    @Operator = UserInfo.new
    @Operator.deserialize(params['Operator'])
  end
  @FlowDisplayType = params['FlowDisplayType']
  @NeedPreview = params['NeedPreview']
  @PreviewType = params['PreviewType']
  @OpenDynamicFlow = params['OpenDynamicFlow']
  @OpenDynamicSignFlow = params['OpenDynamicSignFlow']
end