Class: TencentCloud::Ess::V20201111::CreateMultiFlowSignQRCodeRequest

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

Overview

CreateMultiFlowSignQRCode请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(operator = nil, templateid = nil, flowname = nil, maxflownum = nil, qreffectiveday = nil, floweffectiveday = nil, restrictions = nil, userdata = nil, callbackurl = nil, agent = nil, approverrestrictions = nil, approvercomponentlimittypes = nil, forbidpersonalmultiplesign = nil, flownameappendscannerinfo = nil, qrcodename = nil, qrcodeexpiredon = nil) ⇒ CreateMultiFlowSignQRCodeRequest

Returns a new instance of CreateMultiFlowSignQRCodeRequest.



6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
# File 'lib/v20201111/models.rb', line 6064

def initialize(operator=nil, templateid=nil, flowname=nil, maxflownum=nil, qreffectiveday=nil, floweffectiveday=nil, restrictions=nil, userdata=nil, callbackurl=nil, agent=nil, approverrestrictions=nil, approvercomponentlimittypes=nil, forbidpersonalmultiplesign=nil, flownameappendscannerinfo=nil, qrcodename=nil, qrcodeexpiredon=nil)
  @Operator = operator
  @TemplateId = templateid
  @FlowName = flowname
  @MaxFlowNum = maxflownum
  @QrEffectiveDay = qreffectiveday
  @FlowEffectiveDay = floweffectiveday
  @Restrictions = restrictions
  @UserData = userdata
  @CallbackUrl = callbackurl
  @Agent = agent
  @ApproverRestrictions = approverrestrictions
  @ApproverComponentLimitTypes = approvercomponentlimittypes
  @ForbidPersonalMultipleSign = forbidpersonalmultiplesign
  @FlowNameAppendScannerInfo = flownameappendscannerinfo
  @QrCodeName = qrcodename
  @QrCodeExpiredOn = qrcodeexpiredon
end

Instance Attribute Details

#AgentObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def Agent
  @Agent
end

#ApproverComponentLimitTypesObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def ApproverComponentLimitTypes
  @ApproverComponentLimitTypes
end

#ApproverRestrictionsObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def ApproverRestrictions
  @ApproverRestrictions
end

#CallbackUrlObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def CallbackUrl
  @CallbackUrl
end

#FlowEffectiveDayObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def FlowEffectiveDay
  @FlowEffectiveDay
end

#FlowNameObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def FlowName
  @FlowName
end

#FlowNameAppendScannerInfoObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def FlowNameAppendScannerInfo
  @FlowNameAppendScannerInfo
end

#ForbidPersonalMultipleSignObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def ForbidPersonalMultipleSign
  @ForbidPersonalMultipleSign
end

#MaxFlowNumObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def MaxFlowNum
  @MaxFlowNum
end

#OperatorObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def Operator
  @Operator
end

#QrCodeExpiredOnObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def QrCodeExpiredOn
  @QrCodeExpiredOn
end

#QrCodeNameObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def QrCodeName
  @QrCodeName
end

#QrEffectiveDayObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def QrEffectiveDay
  @QrEffectiveDay
end

#RestrictionsObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def Restrictions
  @Restrictions
end

#TemplateIdObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def TemplateId
  @TemplateId
end

#UserDataObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 该名称还将用于合同签署完成后的下载文件名。 一旦发起流程数超越该限制,该二维码将自动失效。 一旦超过二维码的有效期限,该二维码将自动失效。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 回调的相关说明可参考开发者中心的回调通知模块。
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • TemplateId:

    合同模板ID,为32位字符串。

  • FlowName:

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

  • MaxFlowNum:

    通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。

  • QrEffectiveDay:

    二维码的有效期限,默认为7天,最高设定不得超过90天。

  • FlowEffectiveDay:

    合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。

  • Restrictions:

    指定签署人信息。

  • UserData:

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

  • CallbackUrl:

    已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置

  • Agent:

    代理企业和员工的信息。

  • ApproverRestrictions:

    限制二维码用户条件(已弃用)

  • ApproverComponentLimitTypes:

    指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。

  • ForbidPersonalMultipleSign:

    禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。

  • FlowNameAppendScannerInfo:

    合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。

  • QrCodeName:

    签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName

  • QrCodeExpiredOn:

    签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。



6055
6056
6057
# File 'lib/v20201111/models.rb', line 6055

def UserData
  @UserData
end

Instance Method Details

#deserialize(params) ⇒ Object



6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
# File 'lib/v20201111/models.rb', line 6083

def deserialize(params)
  unless params['Operator'].nil?
    @Operator = UserInfo.new
    @Operator.deserialize(params['Operator'])
  end
  @TemplateId = params['TemplateId']
  @FlowName = params['FlowName']
  @MaxFlowNum = params['MaxFlowNum']
  @QrEffectiveDay = params['QrEffectiveDay']
  @FlowEffectiveDay = params['FlowEffectiveDay']
  unless params['Restrictions'].nil?
    @Restrictions = []
    params['Restrictions'].each do |i|
      approverrestriction_tmp = ApproverRestriction.new
      approverrestriction_tmp.deserialize(i)
      @Restrictions << approverrestriction_tmp
    end
  end
  @UserData = params['UserData']
  @CallbackUrl = params['CallbackUrl']
  unless params['Agent'].nil?
    @Agent = Agent.new
    @Agent.deserialize(params['Agent'])
  end
  unless params['ApproverRestrictions'].nil?
    @ApproverRestrictions = ApproverRestriction.new
    @ApproverRestrictions.deserialize(params['ApproverRestrictions'])
  end
  unless params['ApproverComponentLimitTypes'].nil?
    @ApproverComponentLimitTypes = []
    params['ApproverComponentLimitTypes'].each do |i|
      approvercomponentlimittype_tmp = ApproverComponentLimitType.new
      approvercomponentlimittype_tmp.deserialize(i)
      @ApproverComponentLimitTypes << approvercomponentlimittype_tmp
    end
  end
  @ForbidPersonalMultipleSign = params['ForbidPersonalMultipleSign']
  @FlowNameAppendScannerInfo = params['FlowNameAppendScannerInfo']
  @QrCodeName = params['QrCodeName']
  @QrCodeExpiredOn = params['QrCodeExpiredOn']
end