跳到主要内容

数据结构

Agent

应用相关信息, 整体应用的层级图如下

注:

  1. 不同的业务系统可以采用不同的应用,不同应用下的数据是隔离的, 应用A中的某个企业已经实名, 在应用B中此企业还需要重新认证

被如下接口引用:ChannelBatchCancelFlows, ChannelCancelFlow, ChannelCancelMultiFlowSignQRCode, ChannelCancelUserAutoSignEnableUrl, ChannelCreateBatchCancelFlowUrl, ChannelCreateBatchQuickSignUrl, ChannelCreateBatchSignUrl, ChannelCreateBoundFlows, ChannelCreateConvertTaskApi, ChannelCreateEmbedWebUrl, ChannelCreateFlowApprovers, ChannelCreateFlowByFiles, ChannelCreateFlowGroupByFiles, ChannelCreateFlowGroupByTemplates, ChannelCreateFlowReminds, ChannelCreateFlowSignReview, ChannelCreateFlowSignUrl, ChannelCreateMultiFlowSignQRCode, ChannelCreateOrganizationBatchSignUrl, ChannelCreateOrganizationModifyQrCode, ChannelCreatePrepareFlow, ChannelCreatePreparedPersonalEsign, ChannelCreateReleaseFlow, ChannelCreateRole, ChannelCreateSealPolicy, ChannelCreateUserAutoSignEnableUrl, ChannelCreateUserAutoSignSealUrl, ChannelCreateUserRoles, ChannelCreateWebThemeConfig, ChannelDeleteRole, ChannelDeleteRoleUsers, ChannelDeleteSealPolicies, ChannelDescribeBillUsageDetail, ChannelDescribeEmployees, ChannelDescribeFlowComponents, ChannelDescribeOrganizationSeals, ChannelDescribeRoles, ChannelDescribeSignFaceVideo, ChannelDescribeUserAutoSignStatus, ChannelDisableUserAutoSign, ChannelGetTaskResultApi, ChannelModifyRole, ChannelRenewAutoSignLicense, ChannelUpdateSealStatus, ChannelVerifyPdf, CreateBatchOrganizationRegistrationTasks, CreateChannelFlowEvidenceReport, CreateChannelOrganizationInfoChangeUrl, CreateConsoleLoginUrl, CreateEmployeeQualificationSealQrCode, CreateFlowBlockchainEvidenceUrl, CreateFlowGroupSignReview, CreateFlowsByTemplates, CreateLegalSealQrCode, CreatePartnerAutoSignAuthUrl, CreateSealByImage, CreateSignUrls, DescribeBatchOrganizationRegistrationUrls, DescribeCancelFlowsTask, DescribeChannelFlowEvidenceReport, DescribeChannelOrganizations, DescribeChannelSealPolicyWorkflowUrl, DescribeExtendedServiceAuthDetail, DescribeExtendedServiceAuthInfo, DescribeFlowDetailInfo, DescribeResourceUrlsByFlows, DescribeTemplates, DescribeUsage, GetDownloadFlowUrl, ModifyExtendedService, ModifyFlowDeadline, OperateChannelTemplate, PrepareFlows, SyncProxyOrganization, SyncProxyOrganizationOperators, UploadFiles。

名称类型必选描述
AppIdString应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下:

image
ProxyOrganizationOpenIdString第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串
ProxyOperatorUserInfo第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
ProxyAppIdString不用填写,在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。

ApproverComponentLimitType

指定签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。

被如下接口引用:ChannelCreateMultiFlowSignQRCode。

名称类型必选描述
RecipientIdString签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
ValuesArray of String签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。

签名方式:

  • HANDWRITE-手写签名
  • ESIGN-个人印章类型
  • OCR_ESIGN-AI智能识别手写签名
  • SYSTEM_ESIGN-系统签名

ApproverItem

签署方信息,发起合同后可获取到对应的签署方信息,如角色ID,角色名称

被如下接口引用:ChannelCreateFlowByFiles, ChannelCreateFlowGroupByFiles, ChannelCreateFlowGroupByTemplates, CreateFlowsByTemplates。

名称类型描述
SignIdString签署方唯一编号

动态补充签署人场景下,可以用此编号确定参与方
注意:此字段可能返回 null,表示取不到有效值。
RecipientIdString签署方角色编号

动态补充签署人场景下,可以用此编号确定参与方
注意:此字段可能返回 null,表示取不到有效值。
ApproverRoleNameString签署方角色名称
注意:此字段可能返回 null,表示取不到有效值。

ApproverOption

签署人个性化能力信息

被如下接口引用:ChannelCreateBatchQuickSignUrl, ChannelCreateFlowByFiles, ChannelCreateFlowSignUrl。

名称类型必选描述
NoRefuseBoolean是否可以拒签 默认false-可以拒签 true-不可以拒签
示例值:true
NoTransferBoolean是否可以转发 默认false-可以转发 true-不可以转发
示例值:true
HideOneKeySignBoolean是否隐藏一键签署 默认false-不隐藏true-隐藏
示例值:true
FillTypeInteger签署人信息补充类型,默认无需补充。

  • 1 : ( 动态签署人(可发起合同后再补充签署人信息)注:企业自动签不支持动态补充


注:
使用动态签署人能力前,需登陆腾讯电子签控制台打开服务开关
FlowReadLimitString签署人阅读合同限制参数

取值:

  • LimitReadTimeAndBottom,阅读合同必须限制阅读时长并且必须阅读到底
  • LimitReadTime,阅读合同仅限制阅读时长
  • LimitBottom,阅读合同仅限制必须阅读到底
  • NoReadTimeAndBottom,阅读合同不限制阅读时长且不限制阅读到底(白名单功能,请联系客户经理开白使用)

ApproverRestriction

指定签署人限制项

被如下接口引用:ChannelCreateMultiFlowSignQRCode。

名称类型必选描述
NameString指定签署人姓名
示例值:张三
MobileString指定签署人手机号,11位数字
示例值:13000000000
IdCardTypeString指定签署人证件类型,ID_CARD-身份证,HONGKONG_AND_MACAO-港澳居民来往内地通行证,HONGKONG_MACAO_AND_TAIWAN-港澳台居民居住证
示例值:ID_CARD
IdCardNumberString指定签署人证件号码,其中字母大写
示例值:4500000000000000000

AuthFailMessage

授权出错信息

被如下接口引用:OperateChannelTemplate。

名称类型描述
ProxyOrganizationOpenIdString第三方平台子客企业的唯一标识,长度不能超过64,只能由字母和数字组成。开发者可自定义此字段的值,并需要保存此 ID 以便进行后续操作。

一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。例如,可以使用企业名称的哈希值,或者社会统一信用代码的哈希值,或者随机哈希值。
示例值:organization_open_id_xxxx
MessageString错误信息

AuthInfoDetail

企业扩展服务授权列表详情

被如下接口引用:DescribeExtendedServiceAuthDetail。

名称类型必选描述
TypeString扩展服务类型,和入参一致
注意:此字段可能返回 null,表示取不到有效值。
NameString扩展服务名称
注意:此字段可能返回 null,表示取不到有效值。
HasAuthUserListArray of HasAuthUser授权员工列表
注意:此字段可能返回 null,表示取不到有效值。
HasAuthOrganizationListArray of HasAuthOrganization授权企业列表(企业自动签时,该字段有值)
注意:此字段可能返回 null,表示取不到有效值。
AuthUserTotalInteger授权员工列表总数
注意:此字段可能返回 null,表示取不到有效值。
AuthOrganizationTotalInteger授权企业列表总数
注意:此字段可能返回 null,表示取不到有效值。

AuthorizedUser

授权用户

被如下接口引用:ChannelDescribeOrganizationSeals。

名称类型描述
OpenIdString第三方应用平台的用户openid

AutoSignConfig

自动签开启、签署相关配置

被如下接口引用:ChannelCreateUserAutoSignEnableUrl。

名称类型必选描述
UserInfoUserThreeFactor自动签开通个人用户信息, 包括名字,身份证等
CertInfoCallbackBoolean是否回调证书信息:
  • false: 不需要(默认)
  • true:需要
UserDefineSealBoolean是否支持用户自定义签名印章:
  • false: 不能自己定义(默认)
  • true: 可以自己定义
SealImgCallbackBoolean回调中是否需要自动签将要使用的印章(签名)图片的 base64:
  • false: 不需要(默认)
  • true: 需要
CallbackUrlString回调链接,如果渠道已经配置了,可以不传
VerifyChannelsArray of String开通时候的身份验证方式, 取值为:
  • WEIXINAPP : 微信人脸识别
  • INSIGHT : 慧眼人脸认别
  • TELECOM : 运营商三要素验证

注:
  • 如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP
  • 如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT
LicenseTypeInteger设置用户开通自动签时是否绑定个人自动签账号许可。

  • 0: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: 不可解绑释放更换他人
  • 1: 不绑定自动签账号许可开通,后续使用合同份额进行合同发起
JumpUrlString开通成功后前端页面跳转的url,此字段的用法场景请联系客户经理确认。

注:仅支持H5开通场景, 跳转链接仅支持 https:// , qianapp:// 开头

跳转场景:
  • 贵方H5 -> 腾讯电子签H5 -> 贵方H5 : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。
  • 贵方原生App -> 腾讯电子签H5 -> 贵方原生App : JumpUrl格式: qianapp://YOUR_CUSTOM_URL,只需满足 qianapp:// 开头的URL即可。APP实现方,需要拦截Webview地址跳转,发现url是qianapp:// 开头时跳转到原生页面。APP拦截地址跳转可参考:AndroidIOS


成功结果返回:
若贵方需要在跳转回时通过链接query参数提示开通成功,JumpUrl中的query应携带如下参数:appendResult=qian。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功,例如:qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess

BaseFlowInfo

基础流程信息

被如下接口引用:ChannelCreatePrepareFlow。

名称类型必选描述
FlowNameString合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
示例值:张三的入职合同
FlowTypeString合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
示例值:销售合同
FlowDescriptionString合同流程描述信息(可自定义此描述),最大长度1000个字符。
示例值:张三2023年的入职公司财务部的合同
DeadlineInteger合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
示例值:1604912664
UnorderedBoolean合同流程的签署顺序类型:
false:(默认)有序签署, 本合同多个参与人需要依次签署
true:无序签署, 本合同多个参与人没有先后签署限制
示例值:true
IntelligentStatusString是否打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
FormFieldsArray of FormField填写控件内容, 填写的控制的ID-填写的内容对列表
NeedSignReviewBoolean发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
  • false:(默认)不需要审批,直接签署。
  • true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。

企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
  • 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
  • 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。

注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
UserDataString调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。

在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
示例值:QmFzZTY05YaF5a65
CcInfosArray of CcInfo合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
NeedCreateReviewBoolean发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。

若设置为true,发起审核结果需通过接口 提交企业签署流程审批结果通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。

ComponentsArray of Component填写控件:文件发起使用

CancelFailureFlow

撤销失败的流程信息

被如下接口引用:DescribeCancelFlowsTask。

名称类型描述
FlowIdString签署流程编号,为32位字符串
ReasonString撤销失败原因

CcInfo

抄送信息

被如下接口引用:ChannelCreateFlowByFiles, ChannelCreateFlowGroupByTemplates, ChannelCreatePrepareFlow, CreateFlowsByTemplates, PrepareFlows。

名称类型必选描述
MobileString被抄送人手机号,大陆11位手机号
示例值:xxx
NameString被抄送人姓名
CcTypeInteger被抄送人类型
0--个人. 1--员工
CcPermissionInteger被抄送人权限
0--可查看
1--可查看也可下载

ChannelBillUsageDetail

用户计费使用情况详情

被如下接口引用:ChannelDescribeBillUsageDetail。

名称类型描述
FlowIdString合同流程ID,为32位字符串。
示例值:yDwFdUUckps**uzcbXwoXbRF6ja3
OperatorNameString合同经办人名称
如果有多个经办人用分号隔开。
示例值:典子谦;张三
CreateOrganizationNameString发起方组织机构名称
示例值:典子谦示例企业
FlowNameString合同流程的名称。
示例值:典子谦示例合同
FlowStatusString合同流程当前的签署状态, 会存在下列的状态值

  • INIT: 合同创建
  • PART: 合同签署中(至少有一个签署方已经签署)
  • REJECT: 合同拒签
  • ALL: 合同签署完成
  • DEADLINE: 合同流签(合同过期)
  • CANCEL: 合同撤回
  • RELIEVED: 解除协议(已解除)
  • WILLEXPIRE: 合同即将过期
  • EXCEPTION: 合同异常


示例值:ALL
QuotaTypeString查询的套餐类型
对应关系如下:

  • CloudEnterprise: 企业版合同
  • SingleSignature: 单方签章
  • CloudProve: 签署报告
  • CloudOnlineSign: 腾讯会议在线签约
  • ChannelWeCard: 微工卡
  • SignFlow: 合同套餐
  • SignFace: 签署意愿(人脸识别)
  • SignPassword: 签署意愿(密码)
  • SignSMS: 签署意愿(短信)
  • PersonalEssAuth: 签署人实名(腾讯电子签认证)
  • PersonalThirdAuth: 签署人实名(信任第三方认证)
  • OrgEssAuth: 签署企业实名
  • FlowNotify: 短信通知
  • AuthService: 企业工商信息查询


示例值:CloudEnterprise
UseCountInteger合同使用量
注: 如果消耗类型是撤销返还,此值为负值代表返还的合同数量
示例值:1
CostTimeInteger消耗的时间戳,格式为Unix标准时间戳(秒)。
示例值:1680162193
QuotaNameString消耗的套餐名称
示例值:企业版运营礼包
CostTypeInteger消耗类型
1.扣费
2.撤销返还
示例值:1
RemarkString备注

ChannelOrganizationInfo

渠道企业信息

被如下接口引用:DescribeChannelOrganizations。

名称类型必选描述
OrganizationIdString电子签平台给企业分配的ID(在不同应用下同一个企业会分配通用的ID)
示例值:yDRSRUUgygj6qnwfUuO4zjEwc193c2hH
OrganizationOpenIdString第三方平台子客企业的唯一标识
示例值:n9527
OrganizationNameString第三方平台子客企业名称
示例值:典子谦示例企业
UnifiedSocialCreditCodeString企业的统一社会信用代码
LegalNameString企业法定代表人的姓名
示例值:典子谦
LegalOpenIdString企业法定代表人作为第三方平台子客企业员工的唯一标识
示例值:n9527
AdminNameString企业超级管理员的姓名
示例值:典子谦
AdminOpenIdString企业超级管理员作为第三方平台子客企业员工的唯一标识
示例值:n9527
AdminMobileString企业超级管理员的手机号码
手机号码脱敏(隐藏部分用*替代)
示例值:186****0000
AuthorizationStatusString企业认证状态字段。值如下:

  • "UNVERIFIED": 未认证的企业

  • "VERIFYINGLEGALPENDINGAUTHORIZATION": 认证中待法人授权的企业

  • "VERIFYINGAUTHORIZATIONFILEPENDING": 认证中授权书审核中的企业

  • "VERIFYINGAUTHORIZATIONFILEREJECT": 认证中授权书已驳回的企业

  • "VERIFYING": 认证中的企业

  • "VERIFIED": 已认证的企业


示例值:VERIFIED
AuthorizationTypeString企业认证方式字段。值如下:

  • "AuthorizationInit": 暂未选择授权方式

  • "AuthorizationFile": 授权书

  • "AuthorizationLegalPerson": 法人授权超管

  • "AuthorizationLegalIdentity": 法人直接认证


示例值:AuthorizationLegalIdentity

ChannelRole

角色信息

被如下接口引用:ChannelDescribeRoles。

名称类型描述
RoleIdString角色ID,为32位字符串
注意:此字段可能返回 null,表示取不到有效值。
示例值:69997f600a7c8e9accc71f4241a8a091
RoleNameString角色的名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:管理员角色
RoleStatusInteger此角色状态
1: 已经启用
2: 已经禁用
PermissionGroupsArray of PermissionGroup此角色对应的权限列表
注意:此字段可能返回 null,表示取不到有效值。

CommonApproverOption

签署人配置信息

被如下接口引用:ChannelCreatePrepareFlow。

名称类型必选描述
CanEditApproverBoolean是否允许修改签署人信息

CommonFlowApprover

通用签署人信息

被如下接口引用:ChannelCreatePrepareFlow。

名称类型必选描述
NotChannelOrganizationBoolean指定签署人非第三方平台子客企业下员工还是SaaS平台企业,在ApproverType为ORGANIZATION时指定。

  • false: 默认值,第三方平台子客企业下员工
  • true: SaaS平台企业下的员工



示例值:true
ApproverTypeInteger在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:

0 :企业/企业员工(企业签署方或模板发起时的企业静默签)
1 :个人/自然人
3 :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)

注:类型为3(企业/企业员工自动签)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
使用自动签时,请确保企业已经开通自动签功能,开通方式:控制台 -> 企业设置 -> 扩展服务 -> 企业自动签。
使用文件发起自动签时使用前请联系对接的客户经理沟通。

示例值:1
OrganizationIdString电子签平台给企业生成的企业id
示例值:yDRSRUUgygj6qnwfUuO4zjEwc193c2hH
OrganizationOpenIdString企业OpenId,第三方应用集成非静默签子客企业签署人发起合同必传
示例值:org_diziqian
OrganizationNameString企业名称,第三方应用集成非静默签子客企业签署人必传,saas企业签署人必传
示例值:典子谦示例企业
UserIdString电子签平台给企业员工或者自热人生成的用户id
示例值:yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
OpenIdString第三方平台子客企业员工的唯一标识
示例值:n9527
ApproverNameString签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
示例值:典子谦
ApproverMobileString签署人手机号,saas企业签署人,个人签署人必传
示例值:13888888888
ApproverIdCardTypeString签署方经办人的证件类型,支持以下类型
  • ID_CARD : 居民身份证 (默认值)
  • HONGKONG_AND_MACAO : 港澳居民来往内地通行证
  • HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
  • OTHER_CARD_TYPE : 其他证件


注: 其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。
示例值:ID_CARD
ApproverIdCardNumberString签署方经办人的证件号码,应符合以下规则
  • 居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
  • 港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。
  • 港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。

示例值:110101192008317114
RecipientIdString签署人Id,使用模板发起是,对应模板配置中的签署人RecipientId
注意:模板发起时该字段必填
示例值:yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS
PreReadTimeInteger签署前置条件:阅读时长限制,不传默认10s,最大300s,最小3s
示例值:5
IsFullTextBoolean签署前置条件:阅读全文限制
示例值:true
NotifyTypeString通知签署方经办人的方式, 有以下途径:
  • SMS :(默认)短信
  • NONE : 不通知


注: 签署方为第三方子客企业时会被置为NONE, 不会发短信通知
示例值:NONE
ApproverOptionCommonApproverOption签署人配置,用于控制签署人相关属性
SignComponentsArray of Component使用PDF文件直接发起合同时,签署人指定的签署控件;
使用模板发起合同时,指定本企业印章签署控件的印章ID:
通过ComponentId或ComponenetName指定签署控件,ComponentValue为印章ID。
ApproverVerifyTypesArray of Integer指定个人签署方查看合同的校验方式,可以传值如下:
  • 1 : (默认)人脸识别,人脸识别后才能合同内容
  • 2 : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)

注:
  • 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
  • 此字段可传多个校验方式

示例值:[1,2]
ApproverSignTypesArray of Integer签署人签署合同时的认证方式
  • 1 :人脸认证
  • 2 :签署密码
  • 3 :运营商三要素


默认为1(人脸认证 ),2(签署密码)

注:
1. 用模板创建合同场景, 签署人的认证方式需要在配置模板的时候指定, 在创建合同重新指定无效
2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考运营商支持列表类得到具体的支持说明
示例值:[1,2,3]

Component

此结构体 (Component) 用于描述控件属性。

在通过文件发起合同时,对应的component有三种定位方式

  1. 绝对定位方式 (可以通过 PDF坐标计算助手计算控件的坐标)
  2. 表单域(FIELD)定位方式
  3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找

被如下接口引用:ChannelCreateBatchQuickSignUrl, ChannelCreateFlowByFiles, ChannelCreateFlowGroupByFiles, ChannelCreateFlowSignUrl, ChannelCreatePrepareFlow, DescribeTemplates。

名称类型必选描述
ComponentIdString控件唯一ID。

在绝对定位方式方式下,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。

在关键字定位方式下,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

例:

- 如传入的关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方(前后不能有其他字符)进行对应操作。
- 如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置(前后可以有其他字符)都会执行相应操作。


注:控件ID可以在一个PDF中不可重复
点击查看ComponentId在模板页面的位置

示例值:ComponentId
ComponentTypeString如果是Component填写控件类型,则可选的字段为

  • TEXT : 普通文本控件,输入文本字符串;
  • MULTI_LINE_TEXT : 多行文本控件,输入文本字符串;
  • CHECK_BOX : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
  • FILL_IMAGE : 图片控件,ComponentValue 填写图片的资源 ID;
  • DYNAMIC_TABLE : 动态表格控件;
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;
  • SELECTOR : 选择器控件,ComponentValue填写选择的字符串内容;
  • DATE : 日期控件;默认是格式化为xxxx年xx月xx日字符串;
  • DISTRICT : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;


如果是SignComponent签署控件类型,
需要根据签署人的类型可选的字段为

企业方
  • SIGN_SEAL : 签署印章控件;
  • SIGN_DATE : 签署日期控件;
  • SIGN_SIGNATURE : 用户签名控件;
  • SIGN_PAGING_SEAL : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
  • SIGN_OPINION : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;
  • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。


个人方
  • SIGN_DATE : 签署日期控件;
  • SIGN_SIGNATURE : 用户签名控件;


注: 表单域的控件不能作为印章和签名控件
示例值:SIGN_SEAL
ComponentNameString在绝对定位方式方式下,ComponentName为控件名,长度不能超过20,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。

在表单域定位方式下,ComponentName不仅为控件名,也是表单域名称。

注:控件名可以在一个PDF中可以重复

点击查看ComponentName在模板页面的位置
示例值:ComponentName
ComponentRequiredBoolean如果是填写控件,ComponentRequired表示在填写页面此控件是否必填
  • false(默认):可以不填写
  • true :必须填写此填写控件

如果是签署控件,签批控件中签署意见等可以不填写, 其他签署控件不受此字段影响
示例值:false
ComponentRecipientIdString在通过接口拉取控件信息场景下,为出参参数,此控件归属的参与方的角色ID角色(即RecipientId),发起合同时候不要填写此字段留空即可
示例值:ComponentRecipientId
FileIndexInteger【暂未使用】控件所属文件的序号(取值为:0-N)。 目前单文件的情况下,值一直为0
示例值:0
GenerateModeString控件生成的方式:
  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)

示例值:NORMAL
ComponentWidthFloat在绝对定位方式和关键字定位方式下,指定控件宽度,控件宽度是指控件在PDF文件中的宽度,单位为pt(点)。

示例值:10
ComponentHeightFloat在绝对定位方式和关键字定位方式下,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。

示例值:10
ComponentPageInteger在绝对定位方式方式下,指定控件所在PDF文件上的页码
在使用文件发起的情况下,绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码,使用负数时,页码从最后一页开始。例如:ComponentPage设置为-1,即代表在PDF文件的最后一页,以此类推。

注:
1. 页码编号是从1开始编号的。
2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。
示例值:1
ComponentPosXFloat在绝对定位方式和关键字定位方式下,可以指定控件横向位置的位置,单位为pt(点)。
示例值:10
ComponentPosYFloat在绝对定位方式和关键字定位方式下,可以指定控件纵向位置的位置,单位为pt(点)。
示例值:10
ComponentExtraString在所有的定位方式下,控件的扩展参数,为JSON格式,不同类型的控件会有部分非通用参数。

ComponentType为TEXT、MULTI_LINE_TEXT时,支持以下参数:
  • Font:目前只支持黑体、宋体
  • FontSize: 范围12 :72
  • FontAlign: Left/Right/Center,左对齐/居中/右对齐
  • FontColor:字符串类型,格式为RGB颜色数字

参数样例{"FontColor":"255,0,0","FontSize":12}

ComponentType为DATE时,支持以下参数:
  • Font:目前只支持黑体、宋体
  • FontSize: 范围12 :72

参数样例{"FontColor":"255,0,0","FontSize":12}

ComponentType为FILL_IMAGE时,支持以下参数:
  • NotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满(默认);1-等比例缩放


ComponentType为SIGN_SIGNATURE类型时,可以ComponentTypeLimit参数控制签署方式
  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

参考样例{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}
印章的对应关系参考下图
image


ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时,可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型,支持指定以下印章类型
  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章

参考样例{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。



ComponentType为SIGN_DATE时,支持以下参数:
  • Font :字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"
  • FontSize : 数字类型,范围6-72,默认值为12
  • FontAlign : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐
  • Format : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。
  • Gaps : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数

如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
参数样例 "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

ComponentType为SIGN_SEAL类型时,支持以下参数:
  • PageRanges :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)

参数样例 "{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

签署印章旋转功能,当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时,可以通过以下参数设置签署图片的旋转角度:
  • Rotate:旋转角度,支持范围:-360:360,为正整数时,为顺时针旋转;为负整数时,为逆时针旋转。
  • RotateRelation:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。

参数样例{"Rotate":-30,"RotateRelation":"Component_Id1"}

关键字模式下支持关键字找不到的情况下不进行报错的设置
  • IgnoreKeywordError :1-关键字查找不到时不进行报错

场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。
参数样例 "{"IgnoreKeywordError":1}"
示例值:ComponentExtra
ComponentValueString控件填充vaule,ComponentType和传入值类型对应关系:
  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容, 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId,需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容,详见说明:数据表格
  • DATE : 格式化:xxxx年xx月xx日(例如:2024年05月28日)
  • SIGN_SEAL : 印章ID,于控制台查询获取,点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID,于控制台查询获取,点击查看在控制上的位置



控件值约束说明
特殊控件 填写约束
企业全称控件 企业名称中文字符中文括号
统一社会信用代码控件 企业注册的统一社会信用代码
法人名称控件 最大50个字符,2到25个汉字或者1到50个字母
签署意见控件 签署意见最大长度为50字符
签署人手机号控件 国内手机号 13,14,15,16,17,18,19号段长度11位
签署人身份证控件 合法的身份证号码检查
控件名称 控件名称最大长度为20字符,不支持表情
单行文本控件 只允许输入中文,英文,数字,中英文标点符号,不支持表情
多行文本控件 只允许输入中文,英文,数字,中英文标点符号,不支持表情
勾选框控件 选择填字符串true,不选填字符串false
选择器控件 同单行文本控件约束,填写选择值中的字符串
数字控件 请输入有效的数字(可带小数点)
日期控件 格式:yyyy年mm月dd日
附件控件 JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID
图片控件 JPG或PNG图片,填写上传的图片资源ID
邮箱控件 有效的邮箱地址, w3c标准
地址控件 只允许输入中文,英文,数字,中英文标点符号,不支持表情
省市区控件 只允许输入中文,英文,数字,中英文标点符号,不支持表情
性别控件 选择值中的字符串
学历控件 选择值中的字符串
水印控件 水印控件设置为CUSTOM_WATERMARK类型时的水印内容

注: 部分特殊控件需要在控制台配置模板形式创建
示例值:ComponentValue
ComponentDateFontSizeInteger【暂未使用】日期签署控件的字号,默认为 12
示例值:12
DocumentIdString【暂未使用】控件归属的文档的ID, 发起合同时候不要填写此字段留空即可
示例值:c17bdf9c2a7bdcb32611f4d0200fee3d
ComponentDescriptionString【暂未使用】控件描述,用户自定义,不影响合同发起流程
示例值:Desc
OffsetXFloat如果控件是关键字定位方式,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。
注意: 向左调整设置为负数, 向右调整设置成正数
OffsetYFloat如果控件是关键字定位方式,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。
注意: 向上调整设置为负数, 向下调整设置成正数
ChannelComponentIdString【暂未使用】第三方应用集成平台模板控件 ID 标识
KeywordOrderString如果控件是关键字定位方式,指定关键字排序规则时,可以选择Positive或Reverse两种排序方式。
  • Positive :表示正序,即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序,即根据关键字在PDF文件内的反序进行排列


在指定KeywordIndexes时,如果使用Positive排序方式,0代表在PDF内查找内容时,查找到的第一个关键字;如果使用Reverse排序方式,0代表在PDF内查找内容时,查找到的最后一个关键字。
示例值:Positive\Reverse
KeywordPageInteger如果控件是关键字定位方式,在KeywordPage中指定关键字页码时,将只会在该页码中查找关键字,非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。
RelativeLocationString如果控件是关键字定位方式,关键字生成的区域的对齐方式, 可以设置下面的值
  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
KeywordIndexesArray of Integer如果控件是关键字定位方式,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

注意:关键字索引是从0开始计数的
PlaceholderString填写控件在腾讯电子签小程序填写界面展示的提示信息,例如,在身份证号码填写控件中,提示信息可以设置成“请输入18位身份证号码”。
注:签署控件设置此字段无效
注意:此字段可能返回 null,表示取不到有效值。
LockComponentValueBooleanweb嵌入发起合同场景下, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
  • false(默认):不锁定控件值,允许在页面编辑控件值
  • true:锁定控件值,在页面编辑控件值

注意:此字段可能返回 null,表示取不到有效值。
ForbidMoveAndDeleteBooleanweb嵌入发起合同场景下,是否禁止移动和删除填写和签署控件
  • false(默认) :不禁止移动和删除控件
  • true : 可以移动和删除控件

注意:此字段可能返回 null,表示取不到有效值。

ComponentLimit

签署控件的类型和范围限制条件,用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。

被如下接口引用:ChannelCreateBatchQuickSignUrl, ChannelCreateFlowByFiles, ChannelCreateFlowSignUrl。

名称类型必选描述
ComponentTypeString控件类型,支持以下类型
  • SIGN_SEAL : 印章控件
  • SIGN_PAGING_SEAL : 骑缝章控件
  • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件
  • SIGN_SIGNATURE : 用户签名控件
ComponentValueArray of String签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围

1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)或者以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章


注:限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略

2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : OCR印章(智慧手写签名)
  • ESIGN : 个人印章
  • SYSTEM_ESIGN : 系统印章


3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。

CreateFlowOption

创建合同个性化参数

被如下接口引用:ChannelCreatePrepareFlow。

名称类型必选描述
CanEditFlowBoolean是否允许修改合同信息,
true:可以
false:(默认)不可以
示例值:true
HideShowFlowNameBoolean是否允许发起合同弹窗隐藏合同名称
true:允许
false:(默认)不允许
示例值:false
HideShowFlowTypeBoolean是否允许发起合同弹窗隐藏合同类型,
true:允许
false:(默认)不允许
示例值:true
HideShowDeadlineBoolean是否允许发起合同弹窗隐藏合同到期时间
true:允许
false:(默认)不允许
示例值:true
CanSkipAddApproverBoolean是否允许发起合同步骤跳过指定签署方步骤
true:允许
false:(默认)不允许
示例值:false
CustomCreateFlowDescriptionString定制化发起合同弹窗的描述信息,长度不能超过500,只能由中文、字母、数字和标点组成。
示例值:本合同已经经过法务评估
ForbidEditFillComponentBoolean禁止编辑填写控件

true:禁止编辑填写控件
false:(默认)允许编辑填写控件
示例值:false
SkipUploadFileBoolean跳过上传文件步骤

true:跳过
false:(默认)不跳过,需要传ResourceId
示例值:false

Department

第三方应用集成员工部门信息

被如下接口引用:ChannelDescribeEmployees。

名称类型描述
DepartmentIdString部门id
注意:此字段可能返回 null,表示取不到有效值。
DepartmentNameString部门名称
注意:此字段可能返回 null,表示取不到有效值。

DetectInfoVideoData

视频认证结果

被如下接口引用:ChannelDescribeSignFaceVideo。

名称类型描述
LiveNessVideoString活体视频的base64编码,mp4格式

注:需进行base64解码获取活体视频文件
注意:此字段可能返回 null,表示取不到有效值。

DownloadFlowInfo

签署流程下载信息

被如下接口引用:GetDownloadFlowUrl。

名称类型必选描述
FileNameString文件夹名称
示例值:测试合同文件夹
FlowIdListArray of String签署流程的标识数组
示例值:["FlowId1","FlowId2"]

EmbedUrlOption

创建嵌入式页面url个性化参数

被如下接口引用:ChannelCreateEmbedWebUrl。

名称类型必选描述
ShowFlowDetailComponentBoolean合同详情预览,允许展示控件信息

  • true:允许在合同详情页展示控件
  • false:(默认)不允许在合同详情页展示控件


示例值:true
ShowTemplateComponentBoolean模板预览,允许展示模板控件信息
  • true :允许在模板预览页展示控件
  • false :(默认)不允许在模板预览页展示控件

示例值:true

ExtentServiceAuthInfo

扩展服务开通和授权的详细信息

被如下接口引用:DescribeExtendedServiceAuthInfo。

名称类型描述
TypeString扩展服务类型

  • AUTO_SIGN 企业自动签(自动签署)
  • OVERSEA_SIGN 企业与港澳台居民签署合同
  • MOBILE_CHECK_APPROVER 使用手机号验证签署方身份
  • DOWNLOAD_FLOW 授权渠道下载合同
  • AGE_LIMIT_EXPANSION 拓宽签署方年龄限制
  • HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名


示例值:AUTO_SIGN
NameString扩展服务名称
示例值:企业静默签(自动签署)
StatusString扩展服务的开通状态
ENABLE:开通
DISABLE:未开通
示例值:DISABLE
OperatorOpenIdString操作扩展服务的操作人第三方应用平台的用户openid
注意:此字段可能返回 null,表示取不到有效值。
OperateOnInteger扩展服务的操作时间,格式为Unix标准时间戳(秒)。
注意:此字段可能返回 null,表示取不到有效值。

FailedCreateRoleData

绑定失败的用户角色信息

被如下接口引用:ChannelCreateUserRoles。

名称类型描述
UserIdString用户userId
注意:此字段可能返回 null,表示取不到有效值。
RoleIdsArray of String角色RoleId列表
注意:此字段可能返回 null,表示取不到有效值。

FillApproverInfo

指定补充签署人信息

  • RecipientId 必须指定
  • 补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充

被如下接口引用:ChannelCreateFlowApprovers。

名称类型必选描述
RecipientIdString签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
OpenIdString指定企业经办签署人OpenId
ApproverNameString签署人姓名
ApproverMobileString签署人手机号码
OrganizationNameString企业名称
OrganizationOpenIdString企业OpenId
NotChannelOrganizationBoolean签署企业非渠道子客,默认为false,即表示同一渠道下的企业;如果为true,则目前表示接收方企业为SaaS企业, 为渠道子客时,OrganizationOpenId 必传
ApproverIdCardTypeString签署方经办人的证件类型,支持以下类型
  • ID_CARD 中国大陆居民身份证
  • HONGKONG_AND_MACAO 港澳居民来往内地通行证
  • HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
  • OTHER_CARD_TYPE 其他证件


注: 1.其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。
2.补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。
示例值:ID_CARD
ApproverIdCardNumberString签署方经办人的证件号码,应符合以下规则
  • 居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
  • 港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。
  • 港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。


注:补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。
FlowIdString合同流程ID,补充合同组子合同动态签署人时必传。
示例值:yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm

FillError

批量补充签署人时,补充失败的报错说明

被如下接口引用:ChannelCreateFlowApprovers。

名称类型描述
RecipientIdString为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。
注意:此字段可能返回 null,表示取不到有效值。
ErrMessageString补充失败错误说明
注意:此字段可能返回 null,表示取不到有效值。

FilledComponent

文档内的填充控件返回结构体,返回控件的基本信息和填写内容值

被如下接口引用:ChannelDescribeFlowComponents。

名称类型描述
ComponentIdString填写控件ID
示例值:Component_1
ComponentNameString控件名称
示例值:商品价格
ComponentFillStatusString此填写控件的填写状态
0 : 此填写控件未填写
1 : 此填写控件已填写
示例值:1
ComponentValueString控件填写内容
示例值:100
ImageUrlString图片填充控件下载链接,如果是图片填充控件时,这里返回图片的下载链接。

注: 链接不是永久链接, 默认有效期5分钟后, 到期后链接失效
示例值:https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=ffe60eceb87e57f6d25

Filter

此结构体 (Filter) 用于描述查询过滤条件。

被如下接口引用:ChannelDescribeEmployees, ChannelDescribeRoles。

名称类型必选描述
KeyString查询过滤条件的Key
ValuesArray of String查询过滤条件的Value列表

FlowApproverDetail

签署人的流程信息明细

被如下接口引用:DescribeFlowDetailInfo。

名称类型描述
ReceiptIdString模板配置时候的签署人角色ID(用PDF文件发起也可以指定,如果不指定则自动生成此角色ID), 所有的填写控件和签署控件都归属不同的角色
示例值:yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS
ProxyOrganizationOpenIdString第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体
注意:此字段可能返回 null,表示取不到有效值。
示例值:org_dianziqian
ProxyOperatorOpenIdString第三方平台子客企业员工的唯一标识
示例值:n9527
ProxyOrganizationNameString第三方平台子客企业名称,与企业营业执照中注册的名称一致。
示例值:典子谦示例企业
MobileString签署人手机号
示例值:13888888888
SignOrderInteger签署顺序,如果是有序签署,签署顺序从小到大
ApproveNameString签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:典子谦
ApproveStatusString当前签署人的状态, 状态如下
  • PENDING :待签署
  • FILLPENDING :待填写
  • FILLACCEPT :填写完成
  • FILLREJECT :拒绝填写
  • WAITPICKUP :待领取
  • ACCEPT :已签署
  • REJECT :拒签
  • DEADLINE :过期没人处理
  • CANCEL :流程已撤回
  • FORWARD :已经转他人处理
  • STOP :流程已终止
  • RELIEVED :解除协议(已解除)

注意:此字段可能返回 null,表示取不到有效值。
示例值:ACCEPT
ApproveMessageString签署人拒签等情况的时候填写的原因
注意:此字段可能返回 null,表示取不到有效值。
ApproveTimeInteger签署人签署时间戳,单位秒
示例值:1689688460
ApproveTypeString参与者类型
  • ORGANIZATION :企业签署人
  • PERSON :个人签署人

注意:此字段可能返回 null,表示取不到有效值。
示例值:PERSON
ApproverRoleNameString自定义签署人的角色名, 如: 收款人、开具人、见证人等
注意:此字段可能返回 null,表示取不到有效值。
示例值:卖方

FlowApproverInfo

创建签署流程签署人入参。

各种场景传参说明:

场景编号 发起方类型 签署方类型 签署方传参说明
场景一 第三方子企业A员工 第三方子企业A员工
  • (选填)IdCardNumber和IdCardType:证件类型和证件号
  • (必传)Name:签署方的名字
  • (必传)Mobile:签署方的手机号
  • (必传)OpenId:企业员工标识
  • (必传)OrganizationName:子企业名称
  • (必传)OrganizationOpenId:子企业的标识
  • (固定)ApproverType:需设置为ORGANIZATION
场景二 第三方子企业A员工 第三方子企业B(不指定经办人走领取方式)
  • (必传)OrganizationName:子企业名称
  • (必传)OrganizationOpenId:子企业的标识
  • (固定)ApproverType:需设置为ORGANIZATION
  • (固定)ApproverOption.FillType:需设置为1
场景三 第三方子企业A员工 第三方子企业B员工
  • (选填)IdCardNumber和IdCardType:证件类型和证件号
  • (必传)Name:签署方的名字
  • (必传)Mobile:签署方的手机号
  • (必传)OpenId:企业员工标识
  • (必传)OrganizationName:子企业名称
  • (必传)OrganizationOpenId:子企业的标识
  • (固定)ApproverType:需设置为ORGANIZATION
场景四 第三方子企业A员工 个人/自然人
  • (选填)IdCardNumber和IdCardType:证件类型和证件号
  • (必传)Name:签署方的名字
  • (必传)Mobile:签署方的手机号
  • (固定)ApproverType:需设置为PERSON
场景五 第三方子企业A员工 SaaS平台企业员工
  • (选填)IdCardNumber和IdCardType:证件类型和证件号
  • (必传)OrganizationName:SaaS企业的名字
  • (必传)Name:签署方的名字
  • (必传)Mobile:签署方的手机号
  • (不传)OrganizationOpenId:子企业的标识
  • (不传)OpenId:企业员工标识
  • (固定)ApproverType:需设置为ORGANIZATION
  • (固定)NotChannelOrganization:需设置为True

注1: 使用模板发起合同时,RecipientId(模板发起合同时)必传

RecipientId参数获取: 从DescribeFlowTemplates接口接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId。

注2: 如果发起的是动态签署方(即ApproverOption.FillType指定为1),可以不指定具体签署人信息, 动态签署方可以参考此文档

被如下接口引用:ChannelCreateBatchQuickSignUrl, ChannelCreateFlowByFiles, ChannelCreateFlowGroupByFiles, ChannelCreateFlowGroupByTemplates, ChannelCreateFlowSignUrl, CreateFlowsByTemplates, PrepareFlows。

名称类型必选描述
NameString签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
示例值:张三
IdCardTypeString签署方经办人的证件类型,支持以下类型
  • ID_CARD : 中国大陆居民身份证 (默认值)
  • HONGKONG_AND_MACAO : 港澳居民来往内地通行证
  • HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
  • OTHER_CARD_TYPE : 其他证件


注: 其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。
示例值:ID_CARD
IdCardNumberString签署方经办人的证件号码,应符合以下规则
  • 居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
  • 港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。
  • 港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。

示例值:110101192008317114
MobileString签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符), 不支持海外手机号。
请确认手机号所有方为此合同签署方。
示例值:13888888888
OrganizationNameString组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号(),请使用中文括号()代替。
示例值:典子谦示例企业
NotChannelOrganizationBoolean指定签署人非第三方平台子客企业下员工还是SaaS平台企业,在ApproverType为ORGANIZATION时指定。

  • false: 默认值,第三方平台子客企业下员工
  • true: SaaS平台企业下的员工



示例值:false
OpenIdString第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成

当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程

注:
如果传进来的OpenId已经实名并且加入企业, 则忽略Name,IdCardType,IdCardNumber,Mobile这四个入参(会用此OpenId实名的身份证和登录的手机号覆盖)
示例值:userdianziqian
OrganizationOpenIdString同应用下第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样,签署方为非发起方企业场景下必传,最大长度64个字符
示例值:orgtencent
ApproverTypeString在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
  • PERSON :个人/自然人
  • PERSON_AUTO_SIGN :个人/自然人自动签署,适用于个人自动签场景
  • ORGANIZATION :企业/企业员工(企业签署方或模板发起时的企业静默签)
  • ENTERPRISESERVER :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)


注:
1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。
2. 若要实现他方企业(同一应用下)自动签,需要满足3个条件:
  • 条件1:ApproverType 设置为ENTERPRISESERVER
  • 条件2:子客之间完成授权
  • 条件3:联系对接的客户经理沟通如何使用

示例值:PERSON
RecipientIdString签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
示例值:yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS
DeadlineInteger签署人的签署截止时间,格式为Unix标准时间戳(秒)

注: 若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同
示例值:1689688460
SignComponentsArray of Component使用PDF文件直接发起合同时,签署人指定的签署控件;
使用模板发起合同时,指定本企业印章签署控件的印章ID:
通过ComponentId或ComponenetName指定签署控件,ComponentValue为印章ID。
ComponentLimitTypeArray of String当签署方控件类型为 SIGN_SIGNATURE 时,可以指定签署方签名方式。如果不指定,签署人可以使用所有的签名类型,可指定的签名类型包括:

  • HANDWRITE :需要实时手写的手写签名。
  • HANDWRITTEN_ESIGN :长效手写签名, 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)
  • OCR_ESIGN :AI智能识别手写签名。
  • ESIGN :个人印章类型。
  • IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。
  • SYSTEM_ESIGN :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。


各种签名的样式可以参考下图:
image
示例值:["OCR_ESIGN"]
PreReadTimeInteger签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。

若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:

  • 合同页数少于等于2页,阅读时间为3秒;
  • 合同页数为3到5页,阅读时间为5秒;
  • 合同页数大于等于6页,阅读时间为10秒。


示例值:3
JumpUrlString签署完前端跳转的url,此字段的用法场景请联系客户经理确认
示例值:https://www.qq.com/success
ApproverOptionApproverOption可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人、是否为动态补充签署人等。
详细操作可以参考开发者中心的ApproverOption结构体。
ApproverNeedSignReviewBoolean发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
  • false:(默认)不需要审批,直接签署。
  • true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。

企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
  • 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
  • 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。


注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
示例值:false
ApproverVerifyTypesArray of Integer指定个人签署方查看合同的校验方式,可以传值如下:
  • 1 : (默认)人脸识别,人脸识别后才能合同内容
  • 2 : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)

注:
  • 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
  • 此字段可传多个校验方式

示例值:[1,2]
ApproverSignTypesArray of Integer签署人签署合同时的认证方式
  • 1 :人脸认证
  • 2 :签署密码
  • 3 :运营商三要素


默认为1(人脸认证 ),2(签署密码),3(运营商三要素)

注:
1. 用模板创建合同场景, 签署人的认证方式需要在配置模板的时候指定, 在创建合同重新指定无效
2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考运营商支持列表类得到具体的支持说明
示例值:[1,2,3]
SignIdString签署ID
- 发起流程时系统自动补充
- 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
NotifyTypeString通知签署方经办人的方式, 有以下途径:
  • SMS :(默认)短信
  • NONE : 不通知


注: 签署方为第三方子客企业时会被置为NONE, 不会发短信通知
示例值:SMS
AddSignComponentsLimitsArray of ComponentLimit通过文件创建签署流程时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID,或者印章类型)或签名方式。

注:限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。
ApproverRoleNameString可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。

注: 如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的
SignTypeSelectorInteger生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:
  • 0:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;
  • 1:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。

注:
不指定该值时,默认为签署方自行选择。
示例值:0
ComponentsArray of Component签署人在合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
  • 单行文本控件
  • 多行文本控件
  • 勾选框控件
  • 数字控件
  • 图片控件
  • 数据表格等填写控件


具体使用说明可参考为签署方指定填写控件


注:此参数仅在通过文件发起合同或者合同组时生效
IntentionIntention视频核身意图配置,可指定问答模式或者点头模式的语音文本。

注:
1.视频认证为白名单功能,使用前请联系对接的客户经理沟通。
2.使用视频认证必须指定签署认证方式为人脸(即ApproverSignTypes)。

FlowApproverItem

签署方信息,如角色ID、角色名称等

被如下接口引用:CreateFlowsByTemplates。

名称类型描述
FlowIdString合同编号
注意:此字段可能返回 null,表示取不到有效值。
ApproversArray of ApproverItem签署方信息,如角色ID、角色名称等
注意:此字段可能返回 null,表示取不到有效值。

FlowApproverUrlInfo

签署人签署链接信息。

被如下接口引用:ChannelCreateBatchQuickSignUrl, ChannelCreateFlowSignUrl。

名称类型描述
SignUrlString签署短链接。

注意:
1. 该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
2. 该链接不支持小程序嵌入,仅支持移动端浏览器打开。
3. 生成的链路后面不能再增加参数(会出现覆盖链接中已有参数导致错误)
示例值:https://essurl.cn/M**XE
ApproverTypeString签署人类型。
- PERSON: 个人
示例值:PERSON
NameString签署人姓名。
示例值:典子谦
MobileString签署人手机号。
示例值:13200000000
LongUrlString签署长链接。

注意:
1. 该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
2. 该链接不支持小程序嵌入,仅支持移动端浏览器打开。
3. 生成的链路后面不能再增加参数(会出现覆盖链接中已有参数导致错误)
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://quick.qian.tencent.cn/home?ApproverIdCardNumber=MioqK**Kio2&ApproverMobile=MTkx**%3D&ApproverName=%25E**2A&ApproverType=1&Code=yDS**w3u2Mg8q&CodeType=QUICK&FlowId=yDSLVUU**MszDy&ShowHeader=1&shortKey=yDwq5U**GlG1c&token=M**XE"

FlowBatchApproverInfo

批量签署合同相关信息,指定批量签署合同和签署方的信息,用于补充动态签署人。

被如下接口引用:ChannelCreateBatchSignUrl。

名称类型必选描述
FlowIdString合同流程ID。
示例值:yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
RecipientIdString签署节点ID,用于生成动态签署人链接完成领取。注:生成动态签署人补充链接时必传。

FlowBatchUrlInfo

批量签署合同相关信息,指定批量签署合同和签署方的信息,用于补充动态签署人。

被如下接口引用:ChannelCreateBatchSignUrl。

名称类型必选描述
FlowBatchApproverInfosArray of FlowBatchApproverInfo批量签署合同和签署方的信息,用于补充动态签署人。

FlowDetailInfo

此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息

被如下接口引用:DescribeFlowDetailInfo。

名称类型描述
FlowIdString合同流程ID,为32位字符串。
示例值:yDRCLUUgygq2xun5UuO4zjEwg0vjoimj
FlowNameString合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
示例值:购买50吨西瓜的采购合同
FlowTypeString合同流程的类别分类(如销售合同/入职合同等)。
示例值:入职合同
FlowStatusString合同流程当前的签署状态, 会存在下列的状态值
  • INIT :合同创建
  • PART :合同签署中(至少有一个签署方已经签署)
  • REJECT :合同拒签
  • ALL :合同签署完成
  • DEADLINE :合同流签(合同过期)
  • CANCEL :合同撤回
  • RELIEVED :解除协议(已解除)

FlowMessageString当合同流程状态为已拒签(即 FlowStatus=REJECT)或已撤销(即 FlowStatus=CANCEL )时,此字段 FlowMessage 为拒签或撤销原因。
CreateOnInteger合同流程的创建时间戳,格式为Unix标准时间戳(秒)。
示例值:1606910798
DeadLineInteger签署流程的签署截止时间, 值为unix时间戳, 精确到秒。
示例值:1604912664
CustomDataString调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 1000长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
FlowApproverInfosArray of FlowApproverDetail合同流程的签署方数组
CcInfosArray of FlowApproverDetail合同流程的关注方信息数组
NeedCreateReviewBoolean是否需要发起前审批
  • 当NeedCreateReview为true,表明当前流程是需要发起前审核的合同,可能无法进行查看,签署操作,需要等审核完成后,才可以继续后续流程
  • 当NeedCreateReview为false,不需要发起前审核的合同

示例值:false

FlowFileInfo

合同组中每个子合同的发起信息

被如下接口引用:ChannelCreateFlowGroupByFiles。

名称类型必选描述
FileIdsArray of String签署文件资源Id列表,目前仅支持单个文件
示例值:["xxx"]
FlowNameString签署流程名称,长度不超过200个字符
示例值:"xxx"
FlowApproversArray of FlowApproverInfo签署流程签约方列表,最多不超过5个参与方
DeadlineInteger签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
示例值:1662110622
FlowDescriptionString签署流程的描述,长度不超过1000个字符
示例值:"xxx"
FlowTypeString签署流程的类型,长度不超过255个字符
示例值:"xxx"
CallbackUrlString签署流程回调地址,长度不超过255个字符
示例值:"xxx"
CustomerDataString第三方应用的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
示例值:"xxx"
UnorderedBoolean合同签署顺序类型(无序签,顺序签),默认为false,即有序签署
示例值:false
ComponentsArray of Component签署文件中的发起方的填写控件,需要在发起的时候进行填充
CustomShowMapString合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
示例值:"xxx"
NeedSignReviewBoolean本企业(发起方企业)是否需要签署审批
示例值:flase

FlowGroupApproverInfo

合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。

被如下接口引用:CreateSignUrls。

名称类型必选描述
FlowIdString合同流程ID。
示例值:yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
RecipientIdString签署节点ID,用于生成动态签署人链接完成领取。注:生成动态签署人补充链接时必传。

FlowGroupApprovers

合同组签署方信息

被如下接口引用:ChannelCreateFlowGroupByFiles, ChannelCreateFlowGroupByTemplates。

名称类型描述
FlowIdString合同流程ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
ApproversArray of ApproverItem签署方信息,包含合同ID和角色ID用于定位RecipientId。
注意:此字段可能返回 null,表示取不到有效值。

FlowGroupOptions

合同组的配置项信息包括:在合同组签署过程中,是否需要对每个子合同进行独立的意愿确认。

被如下接口引用:ChannelCreateFlowGroupByFiles。

名称类型必选描述
SelfOrganizationApproverSignEachBoolean发起方企业经办人(即签署人为发起方企业员工)是否需要对子合同进行独立的意愿确认
  • false(默认):发起方企业经办人签署时对所有子合同进行统一的意愿确认。
  • true:发起方企业经办人签署时需要对子合同进行独立的意愿确认。

示例值:fasle
OtherApproverSignEachBoolean非发起方企业经办人(即:签署人为个人或者不为发起方企业的员工)是否需要对子合同进行独立的意愿确认
  • false(默认):非发起方企业经办人签署时对所有子合同进行统一的意愿确认。
  • true:非发起方企业经办人签署时需要对子合同进行独立的意愿确认。

示例值:fasle

FlowGroupUrlInfo

合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。

被如下接口引用:CreateSignUrls。

名称类型必选描述
FlowGroupApproverInfosArray of FlowGroupApproverInfo合同组子合同和签署方的信息,用于补充动态签署人。

FlowInfo

此结构体 (FlowInfo) 用于描述签署流程信息。

被如下接口引用:ChannelCreateFlowGroupByTemplates, CreateFlowsByTemplates, PrepareFlows。

名称类型必选描述
FlowNameString合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
示例值:张三的入职合同
DeadlineInteger合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
示例值:1604912664
示例值:1698827057
TemplateIdString用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
如果使用模板发起接口,此参数为必填。

可以通过生成子客登录链接登录企业控制台, 在企业模板中得到合同模板ID。

点击产看模板Id在控制台上的位置

示例值:yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc
FlowApproversArray of FlowApproverInfo合同流程的参与方列表,最多可支持50个参与方

注:
在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。
例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。


点击查看模板参与人顺序定义位置

示例值:签署人信息
FormFieldsArray of FormField发起方角色的填写控件的填充内容。

注:只有在控制台编辑模板时,归属给发起方的填写控件(如下图)才能在创建文档的时候进行内容填充。(白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方)。
image
示例值:表单K-V对列表
CallbackUrlString合同状态变动结的通知回调URL,该URL仅支持HTTP或HTTPS协议,建议采用HTTPS协议以保证数据传输的安全性,最大长度1000个字符。

腾讯电子签服务器将通过POST方式,application/json格式通知执行结果,请确保外网可以正常访问该URL。
回调的相关说明可参考开发者中心的回调通知模块
示例值:https://capi.qq.com/callback
FlowTypeString合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
示例值:入职合同
FlowDescriptionString合同流程描述信息(可自定义此描述),最大长度1000个字符。
示例值:张三2023年的入职公司财务部的合同
CustomerDataString调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。

在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
示例值:QmFzZTY05YaF5a65
CustomShowMapString您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
  • {合同名称}
  • {发起方企业}
  • {发起方姓名}
  • {签署方N企业}
  • {签署方N姓名}

其中,N表示签署方的编号,从1开始,不能超过签署人的数量。

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

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

image

示例值:合同名称:{合同名称};发起方: {发起方企业}的{发起方姓名}大佬!;净重: 100吨;品类: 铁矿石
CcInfosArray of CcInfo合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
示例值:
NeedSignReviewBoolean发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
  • false:(默认)不需要审批,直接签署。
  • true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。

企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
  • 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
  • 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。

注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
示例值:true
CcNotifyTypeInteger若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
  • 0 :合同发起时通知通知对方来查看合同(默认)
  • 1 : 签署完成后通知对方来查看合同

示例值:0
AutoSignSceneString个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
  • E_PRESCRIPTION_AUTO_SIGN:电子处方单(医疗自动签)
  • OTHER : 通用场景

注: 个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。
示例值:E_PRESCRIPTION_AUTO_SIGN

FlowResourceUrlInfo

流程对应资源链接信息

被如下接口引用:DescribeResourceUrlsByFlows。

名称类型描述
FlowIdString合同流程的ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
ResourceUrlInfosArray of ResourceUrlInfo对应的合同流程的PDF下载链接
注意:此字段可能返回 null,表示取不到有效值。

FormField

电子文档的控件填充信息。按照控件类型进行相应的填充。

当控件的 ComponentType='TEXT'时,FormField.ComponentValue填入文本内容

FormField输入示例:
{
"ComponentId": "componentId1",
"ComponentValue": "文本内容"
}

当控件的 ComponentType='MULTI_LINE_TEXT'时,FormField.ComponentValue填入文本内容,支持自动换行。

FormField输入示例:
{
"ComponentId": "componentId1",
"ComponentValue": "多行文本内容"
}

当控件的 ComponentType='CHECK_BOX'时,FormField.ComponentValue填入true或false文本

FormField输入示例:
{
"ComponentId": "componentId1",
"ComponentValue": "true"
}

当控件的 ComponentType='FILL_IMAGE'时,FormField.ComponentValue填入图片的资源ID

FormField输入示例:
{
"ComponentId": "componentId1",
"ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue填入附件图片的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;

FormField输入示例:
{
"ComponentId": "componentId1",
"ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
}

当控件的 ComponentType='SELECTOR'时,FormField.ComponentValue填入选择的选项内容;

FormField输入示例:
{
"ComponentId": "componentId1",
"ComponentValue": "选择的内容"
}

当控件的 ComponentType='DATE'时,FormField.ComponentValue填入日期内容;

FormField输入示例:
{
"ComponentId": "componentId1",
"ComponentValue": "2023年01月01日"
}

当控件的 ComponentType='DISTRICT'时,FormField.ComponentValue填入省市区内容;

FormField输入示例:
{
"ComponentId": "componentId1",
"ComponentValue": "广东省深圳市福田区"
}

【数据表格传参说明】 当控件的 ComponentType='DYNAMIC_TABLE'时,FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并) 输入示例1:

{
"headers":[
{
"content":"head1"
},
{
"content":"head2"
},
{
"content":"head3"
}
],
"rowCount":3,
"body":{
"cells":[
{
"rowStart":1,
"rowEnd":1,
"columnStart":1,
"columnEnd":1,
"content":"123"
},
{
"rowStart":2,
"rowEnd":3,
"columnStart":1,
"columnEnd":2,
"content":"456"
},
{
"rowStart":3,
"rowEnd":3,
"columnStart":3,
"columnEnd":3,
"content":"789"
}
]
}
}

输入示例2(表格表头宽度比例配置):

{
"headers":[
{
"content":"head1",
"widthPercent": 30
},
{
"content":"head2",
"widthPercent": 30
},
{
"content":"head3",
"widthPercent": 40
}
],
"rowCount":3,
"body":{
"cells":[
{
"rowStart":1,
"rowEnd":1,
"columnStart":1,
"columnEnd":1,
"content":"123"
},
{
"rowStart":2,
"rowEnd":3,
"columnStart":1,
"columnEnd":2,
"content":"456"
},
{
"rowStart":3,
"rowEnd":3,
"columnStart":3,
"columnEnd":3,
"content":"789"
}
]
}
}

输入示例3(表格设置字体加粗颜色):

{
"headers":[
{
"content":"head1"
},
{
"content":"head2"
},
{
"content":"head3"
}
],
"rowCount":3,
"body":{
"cells":[
{
"rowStart":1,
"rowEnd":1,
"columnStart":1,
"columnEnd":1,
"content":"123",
"style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "CENTER"}
},
{
"rowStart":2,
"rowEnd":3,
"columnStart":1,
"columnEnd":2,
"content":"456",
"style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "LEFT"}
},
{
"rowStart":3,
"rowEnd":3,
"columnStart":3,
"columnEnd":3,
"content":"789",
"style": {"color": "#b500bf", "fontSize": 12,"bold": false,"align": "RIGHT"}
}
]
}
}

表格参数说明

名称类型描述
headersArray表头:不超过10列,不支持单元格合并,字数不超过100
rowCountInteger表格内容最大行数
cells.N.rowStartInteger单元格坐标:行起始index
cells.N.rowEndInteger单元格坐标:行结束index
cells.N.columnStartInteger单元格坐标:列起始index
cells.N.columnEndInteger单元格坐标:列结束index
cells.N.contentString单元格内容,字数不超过100
cells.N.styleString单元格字体风格配置 ,风格配置的json字符串 如: {"font":"黑体","fontSize":12,"color":"#FFFFFF","bold":true,"align":"CENTER"}

表格参数headers说明 widthPercent Integer 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35

content String 表头单元格内容,字数不超过100

style String 为字体风格设置 风格支持: font : 目前支持 黑体、宋体; fontSize: 6-72; color:000000-FFFFFF 字符串形如: "#FFFFFF" 或者 "0xFFFFFF"; bold : 是否加粗, true : 加粗 false: 不加粗; align: 对其方式, 支持 LEFT / RIGHT / CENTER

被如下接口引用:ChannelCreateFlowGroupByTemplates, ChannelCreatePrepareFlow, CreateFlowsByTemplates, PrepareFlows。

名称类型必选描述
ComponentValueString控件填充值,ComponentType和传入值格式对应关系如下:
  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容, 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId,需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容,详见说明:数据表格
  • DATE : 格式化:xxxx年xx月xx日(例如:2024年05月28日)
  • DISTRICT : 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容




控件值约束说明
特殊控件 填写约束
企业全称控件 企业名称中文字符中文括号
统一社会信用代码控件 企业注册的统一社会信用代码
法人名称控件 最大50个字符,2到25个汉字或者1到50个字母
签署意见控件 签署意见最大长度为50字符
签署人手机号控件 国内手机号 13,14,15,16,17,18,19号段长度11位
签署人身份证控件 合法的身份证号码检查
控件名称 控件名称最大长度为20字符,不支持表情
单行文本控件 只允许输入中文,英文,数字,中英文标点符号,不支持表情
多行文本控件 只允许输入中文,英文,数字,中英文标点符号,不支持表情
勾选框控件 选择填字符串true,不选填字符串false
选择器控件 同单行文本控件约束,填写选择值中的字符串
数字控件 请输入有效的数字(可带小数点)
日期控件 格式:yyyy年mm月dd日
附件控件 JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID
图片控件 JPG或PNG图片,填写上传的图片资源ID
邮箱控件 有效的邮箱地址, w3c标准
地址控件 只允许输入中文,英文,数字,中英文标点符号,不支持表情
省市区控件 只允许输入中文,英文,数字,中英文标点符号,不支持表情
性别控件 选择值中的字符串
学历控件 选择值中的字符串


示例值:Name
ComponentIdString表单域或控件的ID,跟ComponentName二选一,不能全为空;
CreateFlowsByTemplates 接口不使用此字段。

点击此处查看模板上控件ID的获取方式
注意:此字段可能返回 null,表示取不到有效值。
示例值:391963b9d3cb2de35dedc6eb0a60e535
ComponentNameString控件的名字,跟ComponentId二选一,不能全为空

点击此处查看模板上控件名字的获取方式
注意:此字段可能返回 null,表示取不到有效值。
示例值:住房地址
LockComponentValueBoolean是否锁定模板控件值,锁定后无法修改(用于嵌入式发起合同),true-锁定,false-不锁定
注意:此字段可能返回 null,表示取不到有效值。
示例值:false

HasAuthOrganization

授权企业列表(目前仅用于“企业自动签 -> 合作企业授权”)

被如下接口引用:DescribeExtendedServiceAuthDetail。

名称类型必选描述
OrganizationOpenIdString授权企业openid,
注意:此字段可能返回 null,表示取不到有效值。
OrganizationNameString授权企业名称
注意:此字段可能返回 null,表示取不到有效值。
AuthorizedOrganizationOpenIdString被授权企业openid,
注意:此字段可能返回 null,表示取不到有效值。
AuthorizedOrganizationNameString被授权企业名称
注意:此字段可能返回 null,表示取不到有效值。
AuthorizeTimeInteger授权时间,格式为时间戳,单位s
注意:此字段可能返回 null,表示取不到有效值。

HasAuthUser

被授权的用户信息

被如下接口引用:DescribeExtendedServiceAuthDetail。

名称类型必选描述
OpenIdString第三方应用平台自定义,对应第三方平台子客企业员工的唯一标识。


注意:此字段可能返回 null,表示取不到有效值。

Intention

视频核身意图配置,可指定问答模式或者点头模式的语音文本。

注: 视频认证为白名单功能,使用前请联系对接的客户经理沟通。

被如下接口引用:ChannelCreateBatchQuickSignUrl, ChannelCreateFlowByFiles, ChannelCreateFlowSignUrl。

名称类型必选描述
IntentionTypeInteger视频认证类型,支持以下类型
  • 1 : 问答模式
  • 2 : 点头模式


注: 视频认证为白名单功能,使用前请联系对接的客户经理沟通。
示例值:1
IntentionQuestionsArray of IntentionQuestion意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。

注:选择问答模式时,此字段可不传,不传则使用默认语音文本:请问,您是否同意签署本协议?可语音回复“同意”或“不同意”。
IntentionActionsArray of IntentionAction意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。

注:选择点头模式时,此字段可不传,不传则使用默认语音文本:请问,您是否同意签署本协议?可点头同意。

IntentionAction

意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。

被如下接口引用:ChannelCreateBatchQuickSignUrl, ChannelCreateFlowByFiles, ChannelCreateFlowSignUrl。

名称类型必选描述
TextString点头确认模式下,系统语音播报使用的问题文本,问题最大长度为150个字符。
示例值:请问您本次业务是本人自愿办理吗?如是,请点头确认。

IntentionActionResult

意愿核身点头确认模式结果

被如下接口引用:ChannelDescribeSignFaceVideo。

名称类型描述
DetailsArray of IntentionActionResultDetail意愿核身结果详细数据,与每段点头确认过程一一对应
注意:此字段可能返回 null,表示取不到有效值。

IntentionActionResultDetail

意愿核身点头确认模式结果详细数据

被如下接口引用:ChannelDescribeSignFaceVideo。

名称类型描述
VideoString视频base64编码(其中包含全程提示文本和点头音频,mp4格式)
注意:此字段可能返回 null,表示取不到有效值。

IntentionQuestion

意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。

被如下接口引用:ChannelCreateBatchQuickSignUrl, ChannelCreateFlowByFiles, ChannelCreateFlowSignUrl。

名称类型必选描述
QuestionString当选择语音问答模式时,系统自动播报的问题文本,最大长度为150个字符。
示例值:请问您本次业务是本人自愿办理吗?如是,请回复“我同意”。
AnswersArray of String当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表,传入后可自动判断用户回答文本是否在标准文本列表中。
示例值:“同意”,“我同意”,“确认”,“我确认”

IntentionQuestionResult

意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。

被如下接口引用:ChannelDescribeSignFaceVideo。

名称类型描述
VideoString视频base64(其中包含全程问题和回答音频,mp4格式)

注:需进行base64解码获取视频文件
注意:此字段可能返回 null,表示取不到有效值。
ResultCodeArray of String和答案匹配结果列表
注意:此字段可能返回 null,表示取不到有效值。
AsrResultArray of String回答问题语音识别结果列表
注意:此字段可能返回 null,表示取不到有效值。

NeedReviewApproverInfo

需要进行签署审核的签署人信息

被如下接口引用:CreateFlowGroupSignReview。

名称类型必选描述
ApproverTypeString签署方经办人的类型,支持以下类型
  • ORGANIZATION 企业(含企业自动签)
  • PERSON 个人(含个人自动签)
ApproverNameString签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
ApproverMobileString签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
ApproverIdCardTypeString签署方经办人的证件类型,支持以下类型
  • ID_CARD 中国大陆居民身份证 (默认值)
  • HONGKONG_AND_MACAO 港澳居民来往内地通行证
  • HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
  • OTHER_CARD_TYPE 其他证件


注: 其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。
示例值:ID_CARD
ApproverIdCardNumberString签署方经办人的证件号码,应符合以下规则
  • 居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
  • 港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。。
  • 港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。

示例值:620000198802020000
OrganizationNameString组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号(),请使用中文括号()代替。
如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。

OccupiedSeal

持有的电子印章信息

被如下接口引用:ChannelDescribeOrganizationSeals。

名称类型描述
SealIdString电子印章编号
SealNameString电子印章名称
CreateOnInteger电子印章授权时间戳,单位秒
CreatorString电子印章授权人,电子签的UserId
SealPolicyIdString电子印章策略Id
SealStatusString印章状态,有以下六种:CHECKING(审核中)SUCCESS(已启用)FAIL(审核拒绝)CHECKING-SADM(待超管审核)DISABLE(已停用)STOPPED(已终止)
FailReasonString审核失败原因
注意:此字段可能返回 null,表示取不到有效值。
UrlString印章图片url,5分钟内有效
SealTypeString电子印章类型 , 可选类型如下:
  • OFFICIAL: (默认)公章
  • CONTRACT: 合同专用章;
  • FINANCE: 财务专用章;
  • PERSONNEL: 人事专用章
  • INVOICE: 发票专用章

IsAllTimeBoolean用印申请是否为永久授权
AuthorizedUsersArray of AuthorizedUser授权人列表

OrganizationAuthUrl

企业批量注册链接信息

被如下接口引用:DescribeBatchOrganizationRegistrationUrls。

名称类型描述
AuthUrlString跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
子客企业状态 子客企业员工状态 Endpoint 链接有效期限
企业未激活 员工未认证 PC 5分钟
企业未激活 员工未认证 CHANNEL/SHORT_URL/APP 一年
企业已激活 员工未认证 PC 5分钟
企业已激活 员工未认证 CHANNEL/SHORT_URL/APP 一年
企业已激活 员工已认证 PC 5分钟
企业已激活 员工已认证 CHANNEL/SHORT_URL/APP 一年

注:
1.链接仅单次有效,每次登录需要需要重新创建新的链接
2.创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
ErrorMessageString企业批量注册的错误信息,例如:企业三要素不通过

PdfVerifyResult

合同验签每个签署区的信息

被如下接口引用:ChannelVerifyPdf。

名称类型描述
VerifyResultInteger验签结果详情,每个签名域对应的验签结果。状态值如下
  • 1 :验签成功,在电子签签署
  • 2 :验签成功,在其他平台签署
  • 3 :验签失败
  • 4 :pdf文件没有签名域
  • 5 :文件签名格式错误

示例值:1
SignPlatformString签署平台
如果文件是在腾讯电子签平台签署,则为腾讯电子签
如果文件不在腾讯电子签平台签署,则为其他平台
示例值:腾讯电子签
SignerNameString申请证书的主体的名字

如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
企业: ESS@企业名称@平台生成的数字编码
个人: ESS@个人姓名@证件号@平台生成的数字编码

如果在其他平台签署的, 主体的名字参考其他平台的说明
示例值:ESS@张三@37000019890303000X@808854
SignTimeInteger签署时间的Unix时间戳,单位毫秒
示例值:1699252071000
SignAlgorithmString证书签名算法, 如SHA1withRSA等算法
示例值:SHA1withRSA
CertSnStringCA供应商下发给用户的证书编号

注意:腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下
示例值:6c8e2911fadf70ea
CertNotBeforeInteger证书起始时间的Unix时间戳,单位毫秒
示例值:1681301253000
CertNotAfterInteger证书过期时间的时间戳,单位毫秒
示例值:1712837253000
SignTypeInteger签名类型, 保留字段, 现在全部为0


示例值:0
ComponentPosXFloat签名域横坐标,单位px
示例值:177.05
ComponentPosYFloat签名域纵坐标,单位px
示例值:90.25
ComponentWidthFloat签名域宽度,单位px
示例值:119
ComponentHeightFloat签名域高度,单位px
示例值:13.7
ComponentPageInteger签名域所在页码,1~N
示例值:1

Permission

权限树节点权限

被如下接口引用:ChannelCreateRole, ChannelModifyRole。

名称类型必选描述
NameString权限名称
注意:此字段可能返回 null,表示取不到有效值。
KeyString权限key
注意:此字段可能返回 null,表示取不到有效值。
TypeInteger权限类型 1前端,2后端
注意:此字段可能返回 null,表示取不到有效值。
HideInteger是否隐藏
注意:此字段可能返回 null,表示取不到有效值。
DataLabelInteger数据权限标签 1:表示根节点,2:表示叶子结点
注意:此字段可能返回 null,表示取不到有效值。
DataTypeInteger数据权限独有,1:关联其他模块鉴权,2:表示关联自己模块鉴权
注意:此字段可能返回 null,表示取不到有效值。
DataRangeInteger数据权限独有,表示数据范围,1:全公司,2:部门及下级部门,3:自己
注意:此字段可能返回 null,表示取不到有效值。
DataToString关联权限, 表示这个功能权限要受哪个数据权限管控
注意:此字段可能返回 null,表示取不到有效值。
ParentKeyString父级权限key
注意:此字段可能返回 null,表示取不到有效值。
IsCheckedBoolean是否选中
注意:此字段可能返回 null,表示取不到有效值。
ChildrenArray of Permission子权限集合
注意:此字段可能返回 null,表示取不到有效值。

PermissionGroup

权限树中的权限组

被如下接口引用:ChannelCreateRole, ChannelDescribeRoles, ChannelModifyRole。

名称类型必选描述
GroupNameString权限组名称
注意:此字段可能返回 null,表示取不到有效值。
GroupKeyString权限组key
注意:此字段可能返回 null,表示取不到有效值。
HideInteger是否隐藏分组,0否1是
注意:此字段可能返回 null,表示取不到有效值。
PermissionsArray of Permission权限集合
注意:此字段可能返回 null,表示取不到有效值。

ProxyOrganizationOperator

同步的员工的信息

被如下接口引用:SyncProxyOrganizationOperators。

名称类型必选描述
IdString员工的唯一标识(即OpenId), 定义Agent中的OpenId一样, 可以参考Agent结构体
示例值:n9527
NameString员工的姓名,最大长度50个字符
员工的姓名将用于身份认证和电子签名,请确保填写的姓名为真实姓名,而非昵称等代名。
示例值:张三
IdCardTypeString签署方经办人的证件类型,支持以下类型
  • ID_CARD : 中国大陆居民身份证 (默认值)
  • HONGKONG_AND_MACAO : 港澳居民来往内地通行证
  • HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)


示例值:ID_CARD
IdCardNumberString经办人证件号
MobileString员工的手机号,支持国内手机号11位数字(无需加+86前缀或其他字符),不支持海外手机号。
示例值:1850000000
DefaultRoleString预先分配员工的角色, 可以分配的角色如下:
可以分配的角色 角色名称 角色描述
admin 业务管理员(IT 系统负责人,e.g. CTO) 有企业合同模块、印章模块、模板模块等全量功能及数据权限。
channel-normal-operator 经办人(企业法务负责人) 有发起合同、签署合同(含填写、拒签)、撤销合同、持有印章等权限能力,可查看企业所有合同数据。
channel-sales-man 业务员(一般为销售员、采购员) 有发起合同、签署合同(含填写、拒签)、撤销合同、持有印章等权限能力,可查看自己相关所有合同数据。

示例值:channel-normal-operator

Recipient

流程中签署方和填写方(如果有填写控件存证时)的信息

被如下接口引用:DescribeTemplates。

名称类型必选描述
RecipientIdString合同参与方的角色ID
示例值:ed68bc6904fbd4795b4658c480214e4e
RecipientTypeString参与者类型, 可以选择的类型如下:
  • ENTERPRISE :此角色为企业参与方
  • INDIVIDUAL :此角色为个人参与方
  • PROMOTER :此角色是发起方

示例值:ENTERPRISE
DescriptionString合同参与方的角色描述,长度不能超过100,只能由中文、字母、数字和下划线组成。
RoleNameString合同参与方的角色名字,长度不能超过20,只能由中文、字母、数字和下划线组成。
示例值:卖方
RequireValidationBoolean是否需要校验,
true-是,
false-否
示例值:true
RequireSignBoolean是否必须填写,
true-是,
false-否
示例值:true
SignTypeInteger内部字段,签署类型
示例值:0
RoutingOrderInteger签署顺序:数字越小优先级越高
示例值:0
IsPromoterBoolean是否是发起方,
true-是
false-否
示例值:true
ApproverVerifyTypesArray of Integer签署人查看合同校验方式, 支持的类型如下:
  • 1 :实名认证查看
  • 2 :手机号校验查看

示例值:[1,2]
ApproverSignTypesArray of Integer签署人进行合同签署时的认证方式,支持的类型如下:
  • 1 :人脸认证
  • 2 :签署密码
  • 3 :运营商三要素认证
  • 4 :UKey认证

示例值:[1,2,3]

RecipientComponentInfo

参与方填写控件信息

被如下接口引用:ChannelDescribeFlowComponents。

名称类型描述
RecipientIdString参与方的角色ID
示例值:yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR
RecipientFillStatusString参与方填写状态

  • 0 : 还没有填写
  • 1 : 已经填写

示例值:1
IsPromoterBoolean此角色是否是发起方角色

  • true : 是发起方角色
  • false : 不是发起方角色

注意:此字段可能返回 null,表示取不到有效值。
示例值:true
ComponentsArray of FilledComponent此角色的填写控件列表
注意:此字段可能返回 null,表示取不到有效值。

RegistrationOrganizationInfo

企业认证信息参数, 需要保证这些参数跟营业执照中的信息一致。

被如下接口引用:CreateBatchOrganizationRegistrationTasks。

名称类型必选描述
OrganizationNameString组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号(),请使用中文括号()代替。
OrganizationOpenIdString机构在贵司业务系统中的唯一标识,用于与腾讯电子签企业账号进行映射,确保在同一应用内不会出现重复。
该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
OpenIdString员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一应用内不会出现重复。
该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
UniformSocialCreditCodeString组织机构企业统一社会信用代码。
请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。
LegalNameString组织机构法人的姓名。
请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。
AddressString组织机构企业注册地址。
请确认该企业注册地址与企业营业执照中注册的地址一致。
示例值:深圳市南山区高新区科技中一路腾讯大厦35层
AdminNameString组织机构超管姓名。
在注册流程中,必须是超管本人进行操作。
如果法人作为超管管理组织机构,超管姓名就是法人姓名
AdminMobileString组织机构超管手机号。
在注册流程中,这个手机号必须跟操作人在电子签注册的个人手机号一致。
AuthorizationTypesArray of Integer可选的此企业允许的授权方式, 可以设置的方式有:
1:上传授权书
2:法人授权超管
5:授权书+对公打款


注:
1. 当前仅支持一种认证方式
2. 如果当前的企业类型是政府/事业单位, 则只支持上传授权书+对公打款
3. 如果当前操作人是法人,则是法人认证
AdminIdCardTypeString经办人的证件类型,支持以下类型
  • ID_CARD : 居民身份证 (默认值)
  • HONGKONG_AND_MACAO : 港澳居民来往内地通行证
  • HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)

AdminIdCardNumberString经办人的证件号
BusinessLicenseString营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
PowerOfAttorneysArray of String授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。
p.s. 如果上传授权书 ,需遵循以下条件
1. 超管的信息(超管姓名,超管身份证,超管手机号)必须为必填参数。
2. 超管的个人身份必须在电子签已经实名。
2. 认证方式AuthorizationTypes必须只能是上传授权书方式

ReleasedApprover

解除协议的签署人,如不指定,默认使用待解除流程(原流程)中的签署人。
注意:

  • 不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该签署人。
  • 目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。
  • 当指定C端签署人的签署方自定义控件别名不空时,除参数ApproverNumber外,可以只传参数ApproverSignRole。

如果需要指定B端(企业身份类型)签署人,其中ReleasedApprover需要传递的参数如下: (ApproverNumber, ReleasedApproverRecipientId这两个二选一), OrganizationName, ApproverType必传。
对于其他身份标识:

  • 子客企业指定经办人:OpenId必传,OrganizationOpenId必传;
  • 非子客企业经办人:Name、Mobile必传。

被如下接口引用:ChannelCreateReleaseFlow。

名称类型必选描述
ApproverNumberInteger签署人在原合同签署人列表中的顺序序号(从0开始,按顺序依次递增)。
可以通过DescribeFlowDetailInfo接口查看原流程中的签署人列表。
示例值:0
ApproverTypeString指定签署人类型,目前支持
  • ORGANIZATION:企业(默认值)
  • ENTERPRISESERVER:企业静默签

示例值:ORGANIZATION
ReleasedApproverRecipientIdString签署人在原合同中的RecipientId,可以通过DescribeFlowDetailInfo接口查看原流程中的签署人信息,可参考返回结构体FlowApproverDetail中的RecipientId。
注意:当指定了此参数后,ApproverNumber即失效,会以本参数作为原合同参与人的选取。与ApproverNumber二选一。
示例值:yDCb7UUckpwm3x62UEXHVn8B2hB9q8hT
NameString签署人姓名,最大长度50个字。
示例值:典子谦
IdCardTypeString签署方经办人的证件类型,支持以下类型
  • ID_CARD : 居民身份证(默认值)
  • HONGKONG_AND_MACAO : 港澳居民来往内地通行证
  • HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)

示例值:ID_CARD
IdCardNumberString证件号码,应符合以下规则
  • 居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
  • 港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。
  • 港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。

示例值:620000198802020000
MobileString签署人手机号。
示例值:13200000000
OrganizationNameString组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号(),请使用中文括号()代替。
如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
示例值:典子谦示例企业
OrganizationOpenIdString第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体
当为子客企业指定经办人时,此OrganizationOpenId必传。
示例值:org_dianziqian
OpenIdString第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成。
当签署方为同一第三方平台下的员工时,此OpenId必传。
示例值:n9527
ApproverSignComponentTypeString签署控件类型,支持自定义企业签署方的签署控件类型
  • SIGN_SEAL:默认为印章控件类型(默认值)
  • SIGN_SIGNATURE:手写签名控件类型
ApproverSignRoleString参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫甲方,第二个叫乙方, 第三个叫丙方,以此类推。
如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。
示例值:供应商
ApproverSignSealIdString印章Id,签署控件类型为印章时,用于指定本企业签署方在解除协议中使用那个印章进行签署

RelieveInfo

解除协议文档中内容信息,包括但不限于:解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。

被如下接口引用:ChannelCreateReleaseFlow。

名称类型必选描述
ReasonString解除理由,最大支持200个字
示例值:xxx
RemainInForceItemString解除后仍然有效的条款,保留条款,最大支持200个字
示例值:xxx
OriginalExpenseSettlementString原合同事项处理-费用结算,最大支持200个字
示例值:xxx
OriginalOtherSettlementString原合同事项处理-其他事项,最大支持200个字
示例值:xxx
OtherDealsString其他约定,最大支持200个字
示例值:xxx

RemindFlowRecords

催办接口返回的详细信息。

被如下接口引用:ChannelCreateFlowReminds。

名称类型描述
CanRemindBoolean合同流程是否可以催办: true - 可以,false - 不可以。 若无法催办,将返回RemindMessage以解释原因。
示例值:true
FlowIdString合同流程ID,为32位字符串。
示例值:yDwxxxxxxxW72Qaxm
RemindMessageString在合同流程无法催办的情况下,系统将返回RemindMessage以阐述原因。
示例值:""

ResourceUrlInfo

资源链接信息

被如下接口引用:DescribeResourceUrlsByFlows。

名称类型描述
UrlString资源链接地址,过期时间5分钟
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://file.test.ess.tencent.cn/file/FLOW/yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh/0/0.PDF?hkey=70b***99
NameString资源名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:合同250151025185515.pdf
TypeString资源类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:PDF

SignQrCode

签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。

被如下接口引用:ChannelCreateMultiFlowSignQRCode。

名称类型描述
QrCodeIdString二维码ID,为32位字符串。

注: 需要保留此二维码ID, 用于后序通过取消一码多扫二维码关闭这个二维码的签署功能。
示例值:PDSLZUUckpooi1ltUxCsD3RSTG9BEWhR
QrCodeUrlString二维码URL,可通过转换二维码的工具或代码组件将此URL转化为二维码,以便用户扫描进行流程签署。
示例值:https://dyn.test.ess.tencent.cn/imgs/multiSignQrCodes/QrCode/yDSLZUUckpoourf9UE6T6Qd1aK59.png
ExpiredTimeInteger二维码的有截止时间,格式为Unix标准时间戳(秒),可以通过入参的QrEffectiveDay来设置有效期,默认为7天有效期。
一旦超过二维码的有效期限,该二维码将自动失效。
示例值:1693814798

SignUrl

流程签署二维码的签署信息,适用于客户系统整合二维码功能。 通过链接,用户可直接访问电子签名小程序并签署合同。

被如下接口引用:ChannelCreateMultiFlowSignQRCode。

名称类型描述
AppSignUrlString跳转至电子签名小程序签署的链接地址。 适用于客户端APP及小程序直接唤起电子签名小程序。
示例值:pages/guide?from=default&where=mini&autoJumpBack=true&to=CHANNEL_CONTRACT_COVER&xxx
EffectiveTimeString签署链接有效时间,格式类似"2022-08-05 15:55:01"
示例值:2022-08-05 15:55:01
HttpSignUrlString跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
示例值:https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=MSG&to=CHANNEL_CONTRACT_COVER&xxx

SignUrlInfo

签署链接内容

被如下接口引用:CreateSignUrls。

名称类型描述
SignUrlString签署链接,过期时间为90天

注:生成的链路后面不能再增加参数(会出现覆盖链接中已有参数导致错误)
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://essurl.cn/hJi85U8ewE
DeadlineInteger合同过期时间戳,单位秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1706254213
SignOrderInteger当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SignIdString签署人编号
注意:此字段可能返回 null,表示取不到有效值。
示例值:yDwiBUUckpo27hodUuLiduRyFBtECOgN
NameString用户姓名
注意:此字段可能返回 null,表示取不到有效值。
示例值:张三
MobileString用户手机号码
注意:此字段可能返回 null,表示取不到有效值。
示例值:18888888888
OrganizationNameString签署参与者机构名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:张三示例企业
ApproverTypeString参与者类型, 类型如下:
ORGANIZATION:企业经办人
PERSON: 自然人
注意:此字段可能返回 null,表示取不到有效值。
示例值:ORGANIZATION
IdCardNumberString经办人身份证号
注意:此字段可能返回 null,表示取不到有效值。
FlowIdString签署链接对应流程Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
OpenIdString企业经办人 用户在渠道的编号
注意:此字段可能返回 null,表示取不到有效值。
示例值:n9527
FlowGroupIdString合同组签署链接对应的合同组id
注意:此字段可能返回 null,表示取不到有效值。
示例值:yDRS4UUgygqdcj5pUuO4zjEu602GFIe6
SignQrcodeUrlString二维码,在生成动态签署人跳转封面页链接时返回
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d**2f0db15e6b

Staff

企业员工信息

被如下接口引用:ChannelDescribeEmployees。

名称类型描述
UserIdString员工在电子签平台的用户ID
DisplayNameString显示的员工名
注意:2024-07-08 及之后创建的应用号,该字段返回的是打码信息
MobileString员工手机号
注意:2024-07-08 及之后创建的应用号,该字段返回的是打码信息
EmailString员工邮箱
注意:此字段可能返回 null,表示取不到有效值。
OpenIdString员工在第三方应用平台的用户ID
注意:此字段可能返回 null,表示取不到有效值。
RolesArray of StaffRole员工角色
注意:此字段可能返回 null,表示取不到有效值。
DepartmentDepartment员工部门
注意:此字段可能返回 null,表示取不到有效值。
VerifiedBoolean员工是否实名
CreatedOnInteger员工创建时间戳,单位秒
VerifiedOnInteger员工实名时间戳,单位秒
QuiteJobInteger员工是否离职:0-未离职,1-离职

StaffRole

第三方应用集成员工角色信息

被如下接口引用:ChannelDescribeEmployees。

名称类型描述
RoleIdString角色id
注意:此字段可能返回 null,表示取不到有效值。
RoleNameString角色名称
注意:此字段可能返回 null,表示取不到有效值。

SyncFailReason

同步员工失败原因

被如下接口引用:SyncProxyOrganizationOperators。

名称类型描述
IdString企业员工标识(即OpenId)
示例值:n9725
MessageString新增员工或者员工离职失败原因, 可能存证ID不符合规范、证件号码不合法等原因
注意:此字段可能返回 null,表示取不到有效值。
示例值:Id不符合规范

TaskInfo

复杂文档合成任务的任务信息

被如下接口引用:ChannelCreateFlowGroupByTemplates, CreateFlowsByTemplates。

名称类型描述
TaskIdString合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:"xxx"
TaskStatusString任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
注意:此字段可能返回 null,表示取不到有效值。
示例值:NOTREADY

TemplateInfo

此结构体 (TemplateInfo) 用于描述模板的信息。

模板组成

一个模板通常会包含以下结构信息

  • 模板基本信息
  • 签署参与方 Recipients,在模板发起合同时用于指定参与方
  • 填写控件 Components
  • 签署控件 SignComponents

被如下接口引用:DescribeTemplates。

名称类型描述
TemplateIdString模板ID,模板的唯一标识
示例值:yDSLKUUckpoqt3vzUP7DfuSBwaJfz7M1
TemplateNameString模板名
示例值:西红柿采购模板
DescriptionString模板描述信息
示例值:2023年西红柿采购模板
ComponentsArray of Component模板的填充控件列表
RecipientsArray of Recipient此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。
SignComponentsArray of Component此模板中的签署控件列表
TemplateTypeInteger模板类型:1-静默签;3-普通模板
示例值:3
CreatorString模板的创建者名字
示例值:张三
CreatedOnInteger模板创建的时间戳,格式为Unix标准时间戳(秒)
示例值:1699259970
PreviewUrlString模板的H5预览链接,有效期5分钟。
可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://embed.beta.qian.tencent.cn/document-url-preview?channel=PROXYCHANNEL&scene=SINGLEPAGE&code=yDSxNUUckptbbq64UEly7FaCkhsBlSLj&codeType=QUICK&businessType=TEMPLATE&businessId=yDSLVUUckpo3pub6UE5dPdv8pkDsrbEn&channel=PROXYCHANNEL
PdfUrlString第三方应用集成-模板PDF文件链接,有效期5分钟。
请求参数WithPdfUrl=true时返回
(此功能开放需要联系客户经理)。
注意:此字段可能返回 null,表示取不到有效值。
ChannelTemplateIdString本模板关联的第三方应用平台企业模板ID
示例值:yDSLKUUckpoqcjljUyzyvt7xDAq3564r
ChannelTemplateNameString本模板关联的三方应用平台平台企业模板名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:西红柿采购模板
ChannelAutoSaveInteger0-需要子客企业手动领取平台企业的模板(默认);
1-平台自动设置子客模板
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TemplateVersionString模板版本,由全数字字符组成。
默认为空,模板版本号由日期和序号组成,初始版本为yyyyMMdd001,yyyyMMdd002表示第二个版本,以此类推。
注意:此字段可能返回 null,表示取不到有效值。
示例值:20231106004
AvailableInteger模板可用状态的取值通常为以下两种:

  • 1:启用(默认),表示模板处于启用状态,可以被用户正常使用。
  • 2:停用,表示模板处于停用状态,禁止用户使用该模板。

注意:此字段可能返回 null,表示取不到有效值。
示例值:1

UploadFile

此结构体 (UploadFile) 用于描述多文件上传的文件信息。

被如下接口引用:UploadFiles。

名称类型必选描述
FileBodyStringBase64编码后的文件内容
FileNameString文件名,最大长度不超过200字符

UsageDetail

用量明细

被如下接口引用:DescribeUsage。

名称类型描述
ProxyOrganizationOpenIdString子客企业标识
ProxyOrganizationNameString子客企业名
注意:此字段可能返回 null,表示取不到有效值。
DateDate对应的消耗日期, 如果是汇总数据则为1970-01-01
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-08-31
UsageInteger消耗合同数量
示例值:50
CancelInteger撤回合同数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
FlowChannelString消耗渠道
注意:此字段可能返回 null,表示取不到有效值。
示例值:企业版

UserInfo

接口调用的员工信息

被如下接口引用:ChannelBatchCancelFlows, ChannelCancelFlow, ChannelCancelMultiFlowSignQRCode, ChannelCancelUserAutoSignEnableUrl, ChannelCreateBatchCancelFlowUrl, ChannelCreateBatchQuickSignUrl, ChannelCreateBatchSignUrl, ChannelCreateBoundFlows, ChannelCreateConvertTaskApi, ChannelCreateEmbedWebUrl, ChannelCreateFlowApprovers, ChannelCreateFlowByFiles, ChannelCreateFlowGroupByFiles, ChannelCreateFlowGroupByTemplates, ChannelCreateFlowReminds, ChannelCreateFlowSignReview, ChannelCreateFlowSignUrl, ChannelCreateMultiFlowSignQRCode, ChannelCreateOrganizationBatchSignUrl, ChannelCreateOrganizationModifyQrCode, ChannelCreatePrepareFlow, ChannelCreatePreparedPersonalEsign, ChannelCreateReleaseFlow, ChannelCreateRole, ChannelCreateSealPolicy, ChannelCreateUserAutoSignEnableUrl, ChannelCreateUserAutoSignSealUrl, ChannelCreateUserRoles, ChannelCreateWebThemeConfig, ChannelDeleteRole, ChannelDeleteRoleUsers, ChannelDeleteSealPolicies, ChannelDescribeBillUsageDetail, ChannelDescribeEmployees, ChannelDescribeFlowComponents, ChannelDescribeOrganizationSeals, ChannelDescribeRoles, ChannelDescribeSignFaceVideo, ChannelDescribeUserAutoSignStatus, ChannelDisableUserAutoSign, ChannelGetTaskResultApi, ChannelModifyRole, ChannelRenewAutoSignLicense, ChannelUpdateSealStatus, ChannelVerifyPdf, CreateBatchOrganizationRegistrationTasks, CreateChannelFlowEvidenceReport, CreateChannelOrganizationInfoChangeUrl, CreateConsoleLoginUrl, CreateEmployeeQualificationSealQrCode, CreateFlowBlockchainEvidenceUrl, CreateFlowGroupSignReview, CreateFlowsByTemplates, CreateLegalSealQrCode, CreatePartnerAutoSignAuthUrl, CreateSealByImage, CreateSignUrls, DescribeBatchOrganizationRegistrationUrls, DescribeCancelFlowsTask, DescribeChannelFlowEvidenceReport, DescribeChannelOrganizations, DescribeChannelSealPolicyWorkflowUrl, DescribeExtendedServiceAuthDetail, DescribeExtendedServiceAuthInfo, DescribeFlowDetailInfo, DescribeResourceUrlsByFlows, DescribeTemplates, DescribeUsage, GetDownloadFlowUrl, ModifyExtendedService, ModifyFlowDeadline, OperateChannelTemplate, PrepareFlows, SyncProxyOrganization, SyncProxyOrganizationOperators, UploadFiles。

名称类型必选描述
OpenIdString第三方应用平台自定义,对应第三方平台子客企业员工的唯一标识。


注意:
1. OpenId在子客企业对应一个真实员工,本应用唯一, 不可重复使用,最大64位字符串
2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId
3. 员工加入企业后, 可以通过生成子客登录链接登录子客控制台后, 在组织架构模块查看员工们的OpenId, 样式如下图
image

UserThreeFactor

用户的三要素:姓名,证件号,证件类型

被如下接口引用:ChannelCancelUserAutoSignEnableUrl, ChannelCreateUserAutoSignEnableUrl, ChannelCreateUserAutoSignSealUrl, ChannelDescribeUserAutoSignStatus, ChannelDisableUserAutoSign, ChannelRenewAutoSignLicense。

名称类型必选描述
NameString签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
示例值:小明
IdCardTypeString证件类型,支持以下类型
  • ID_CARD : 中国大陆居民身份证 (默认值)
  • HONGKONG_AND_MACAO : 港澳居民来往内地通行证
  • HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)

示例值:ID_CARD
IdCardNumberString证件号码,应符合以下规则
  • 居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
  • 港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。
  • 港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。

示例值:620000198802020000

WebThemeConfig

主题配置

被如下接口引用:ChannelCreateWebThemeConfig。

名称类型必选描述
DisplaySignBrandLogoBoolean是否显示页面底部电子签logo,取值如下:
  • true:页面底部显示电子签logo
  • false:页面底部不显示电子签logo(默认)

示例值:true
WebEmbedThemeColorString主题颜色:
支持十六进制颜色值以及RGB格式颜色值,例如:#D54941,rgb(213, 73, 65)


示例值:#D54941
AuthenticateBackgroundString企业认证页背景图(base64图片)
HideAuthenticateNavigationBarBoolean隐藏企业认证页面导航栏,取值如下:
  • true:隐藏企业认证页面导航栏
  • false:显示企业认证页面导航栏(默认)

示例值:true
HideAuthenticateTopLogoBoolean隐藏企业认证顶部logo,取值如下:
  • true:隐藏企业认证顶部logo
  • false:显示企业认证顶部logo(默认)

示例值:true
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062