跳到主要内容

数据结构

Admin

企业超管信息

被如下接口引用:DescribeOrganizationGroupOrganizations。

名称类型描述
NameString超管名
注意:此字段可能返回 null,表示取不到有效值。
MobileString超管手机号,打码显示
示例值:138****1569

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

Agent

代理相关应用信息,如集团主企业代子企业操作

被如下接口引用:BindEmployeeUserIdWithClientOpenId, CancelFlow, CancelMultiFlowSignQRCode, CancelUserAutoSignEnableUrl, CreateBatchCancelFlowUrl, CreateBatchQuickSignUrl, CreateBatchSignUrl, CreateConvertTaskApi, CreateDocument, CreateEmbedWebUrl, CreateExtendedServiceAuthInfos, CreateFlow, CreateFlowApprovers, CreateFlowByFiles, CreateFlowEvidenceReport, CreateFlowGroupByFiles, CreateFlowGroupByTemplates, CreateFlowGroupSignReview, CreateFlowReminds, CreateFlowSignReview, CreateFlowSignUrl, CreateIntegrationDepartment, CreateIntegrationEmployees, CreateIntegrationRole, CreateIntegrationUserRoles, CreateMultiFlowSignQRCode, CreateOrganizationBatchSignUrl, CreateOrganizationInfoChangeUrl, CreatePersonAuthCertificateImage, CreatePrepareFlow, CreatePreparedPersonalEsign, CreateReleaseFlow, CreateSchemeUrl, CreateSeal, CreateSealPolicy, CreateUserAutoSignEnableUrl, CreateUserAutoSignSealUrl, CreateWebThemeConfig, DeleteExtendedServiceAuthInfos, DeleteIntegrationDepartment, DeleteIntegrationEmployees, DeleteIntegrationRoleUsers, DeleteSealPolicies, DescribeBillUsageDetail, DescribeCancelFlowsTask, DescribeExtendedServiceAuthDetail, DescribeExtendedServiceAuthInfos, DescribeFileUrls, DescribeFlowBriefs, DescribeFlowComponents, DescribeFlowEvidenceReport, DescribeFlowInfo, DescribeFlowTemplates, DescribeIntegrationDepartments, DescribeIntegrationEmployees, DescribeIntegrationRoles, DescribeOrganizationSeals, DescribePersonCertificate, DescribeSignFaceVideo, DescribeThirdPartyAuthCode, DescribeUserAutoSignStatus, DisableUserAutoSign, GetTaskResultApi, ModifyApplicationCallbackInfo, ModifyExtendedService, ModifyFlowDeadline, ModifyIntegrationDepartment, ModifyIntegrationRole, RenewAutoSignLicense, StartFlow, UnbindEmployeeUserIdWithClientOpenId, UpdateIntegrationEmployees, UploadFiles, VerifyPdf。

名称类型必选描述
ProxyOrganizationIdString被代理机构在电子签平台的机构编号,集团代理下场景必传

ApproverComponentLimitType

签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式

被如下接口引用:CreateMultiFlowSignQRCode。

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

签名方式:

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

ApproverInfo

合同参与者信息。

被如下接口引用:CreateFlowByFiles, CreateFlowGroupByFiles, CreateFlowGroupByTemplates。

名称类型必选描述
ApproverTypeInteger在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
0:企业
1:个人
3:企业静默签署
注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
7: 个人自动签署,适用于个人自动签场景。
注: 个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。
ApproverNameString签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
ApproverMobileString签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此合同签署方。
OrganizationNameString组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号(),请使用中文括号()代替。
如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
SignComponentsArray of Component合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
  • 个人签名/印章
  • 企业印章
  • 骑缝章等签署控件
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位字符串。

示例值:xxx
NotifyTypeString通知签署方经办人的方式, 有以下途径:
  • sms : (默认)短信
  • none : 不通知

<br/>注意:<br/>如果使用的是通过文件发起合同(CreateFlowByFiles),NotifyType必须 是 sms 才会发送短信<br/>
示例值:sms
ApproverRoleInteger收据场景设置签署人角色类型, 可以设置如下**类型**:
  • 1 :收款人
  • 2 :开具人
  • 3 :见证人

注: 收据场景为白名单功能,使用前请联系对接的客户经理沟通。
示例值:1
ApproverRoleNameString可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。

注: 如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的
示例值:收款人
VerifyChannelArray of String签署意愿确认渠道,默认为WEIXINAPP:人脸识别

注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
示例值:["WEIXINAPP"]
PreReadTimeInteger签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。

若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
  • 合同页数少于等于2页,阅读时间为3秒;
  • 合同页数为3到5页,阅读时间为5秒;
  • 合同页数大于等于6页,阅读时间为10秒。

示例值:3
UserIdString签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得

注:
如果传进来的UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参(会用此UserId实名的身份证和登录的手机号覆盖)
ApproverSourceString在企微场景下使用,需设置参数为WEWORKAPP,以表明合同来源于企微。
CustomApproverTagString在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
所有参与或签的人员均需具备该标识。
注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。
ApproverOptionApproverOption可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。
详细操作可以参考开发者中心的ApproverOption结构体。
ApproverVerifyTypesArray of Integer指定个人签署方查看合同的校验方式,可以传值如下:
  • 1 : (默认)人脸识别,人脸识别后才能合同内容
  • 2 : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)

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

示例值:[1,2]
ApproverSignTypesArray of Integer您可以指定签署方签署合同的认证校验方式,可传递以下值:
  • 1:人脸认证,需进行人脸识别成功后才能签署合同;
  • 2:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;
  • 3:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。


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

注:
1. 用模板创建合同场景, 签署人的认证方式需要在配置模板的时候指定, 在创建合同重新指定无效
3. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考运营商支持列表类得到具体的支持说明
示例值:[1,2,3]
ApproverNeedSignReviewBoolean发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
  • false:(默认)不需要审批,直接签署。
  • true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。

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


注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
AddSignComponentsLimitsArray of ComponentLimit用PDF文件创建签署流程时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID)或签名方式。

注:限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。
SignInstructionContentString签署须知:支持传入富文本,最长字数:500个中文字符
DeadlineInteger签署人的签署截止时间,格式为Unix标准时间戳(秒)

注: 若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同
示例值:1705977064
ComponentsArray of Component签署人在合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
  • 单行文本控件
  • 多行文本控件
  • 勾选框控件
  • 数字控件
  • 图片控件
  • 数据表格等填写控件


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

注:此参数仅在通过文件发起合同或者合同组时生效

ApproverItem

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

被如下接口引用:CreateDocument, CreateFlowByFiles, CreateFlowGroupByFiles, CreateFlowGroupByTemplates。

名称类型描述
SignIdString签署方唯一编号
注意:此字段可能返回 null,表示取不到有效值。
RecipientIdString签署方角色编号
注意:此字段可能返回 null,表示取不到有效值。
ApproverRoleNameString签署方角色名称
注意:此字段可能返回 null,表示取不到有效值。

ApproverOption

签署人个性化能力信息

被如下接口引用:CreateBatchQuickSignUrl, CreateFlow, CreateFlowByFiles, CreateFlowGroupByFiles, CreateFlowGroupByTemplates, CreateFlowSignUrl, CreatePrepareFlow。

名称类型必选描述
NoRefuseBoolean签署方是否可以拒签

  • false : ( 默认)可以拒签
  • true :不可以拒签

示例值:true
NoTransferBoolean签署方是否可以转他人处理

  • false : ( 默认)可以转他人处理
  • true :不可以转他人处理

示例值:true
CanEditApproverBoolean允许编辑签署人信息(嵌入式使用) 默认true-可以编辑 false-不可以编辑
示例值:true
FillTypeInteger签署人信息补充类型,默认无需补充。

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


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

取值:

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

ApproverRestriction

指定签署人限制项

被如下接口引用:CreateMultiFlowSignQRCode。

名称类型必选描述
NameString指定签署人名字
示例值:张三
MobileString指定签署人手机号,11位数字
示例值:13000000000
IdCardTypeString指定签署人证件类型,ID_CARD-身份证
示例值:ID_CARD
IdCardNumberString指定签署人证件号码,字母大写
示例值:4500000000000000000

AuthInfoDetail

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

被如下接口引用:DescribeExtendedServiceAuthDetail。

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

AuthorizedUser

授权用户

被如下接口引用:DescribeOrganizationSeals。

名称类型描述
UserIdString电子签系统中的用户id

AutoSignConfig

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

被如下接口引用:CreateUserAutoSignEnableUrl。

名称类型必选描述
UserInfoUserThreeFactor自动签开通个人用户信息, 包括名字,身份证等
CertInfoCallbackBoolean是否回调证书信息:
  • false: 不需要(默认)
  • true:需要
UserDefineSealBoolean是否支持用户自定义签名印章:
  • false: 不能自己定义(默认)
  • true: 可以自己定义
SealImgCallbackBoolean回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
  • false: 不需要(默认)
  • true: 需要
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

BillUsageDetail

用户计费使用情况详情

被如下接口引用:DescribeBillUsageDetail。

名称类型描述
FlowIdString合同流程ID,为32位字符串。
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
示例值:yDwFdUUckps**uzcbXwoXbRF6ja3
OperatorNameString合同经办人名称
如果有多个经办人用分号隔开。
示例值:典子谦
CreateOrganizationNameString发起方组织机构名称
示例值:典子谦示例企业
FlowNameString合同流程的名称。
示例值:典子谦示例合同
StatusInteger当前合同状态,如下是状态码对应的状态。

  • 0: 还没有发起
  • 1: 等待签署
  • 2: 部分签署
  • 3: 拒签
  • 4: 已签署
  • 5: 已过期
  • 6: 已撤销
  • 7: 还没有预发起
  • 8: 等待填写
  • 9: 部分填写
  • 10: 拒填
  • 11: 已解除


示例值:4
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备注
示例值:空

CallbackInfo

企业应用回调信息

被如下接口引用:ModifyApplicationCallbackInfo。

名称类型必选描述
CallbackUrlString回调url,。请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
示例值:https://tsign.tencent.com/callback
CallbackKeyString回调加密key,用于回调消息加解密。
示例值:8DD3B29CE10D469D8978393074A767FD
CallbackTokenString回调验签token,用于回调通知校验。
示例值:5AF866900CA34D1A95382C48C678A085

Caller

此结构体 (Caller) 用于描述调用方属性。

被如下接口引用:UploadFiles。

名称类型必选描述
OperatorIdString经办人的用户ID,同UserId
示例值:88fb0c591044be771f60aa382cc5ed0e

CancelFailureFlow

撤销失败的流程信息

被如下接口引用:DescribeCancelFlowsTask。

名称类型必选描述
FlowIdString合同流程ID,为32位字符串。
ReasonString撤销失败原因

CcInfo

抄送信息

被如下接口引用:CreateFlow, CreateFlowByFiles, CreatePrepareFlow。

名称类型必选描述
MobileString被抄送方手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此业务通知方。
示例值:13200000000
NameString被抄送方姓名。
抄送方的姓名将用于身份认证,请确保填写的姓名为抄送方的真实姓名,而非昵称等代名。
示例值:典子谦
CcTypeInteger被抄送方类型, 可设置以下类型:
  • 0 :个人抄送方
  • 1 :企业员工抄送方

示例值:1
CcPermissionInteger被抄送方权限, 可设置如下权限:
  • 0 :可查看合同内容
  • 1 :可查看合同内容也可下载原文

示例值:1
NotifyTypeString通知签署方经办人的方式, 有以下途径:
  • sms : (默认)短信
  • none : 不通知

示例值:sms

Component

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

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

  1. 绝对定位方式 (可以通过 PDF坐标计算助手计算控件的坐标)
  2. 表单域(FIELD)定位方式
  3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找 可以参考官网说明 https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E

被如下接口引用:CreateBatchQuickSignUrl, CreateFlow, CreateFlowByFiles, CreateFlowGroupByFiles, CreateFlowGroupByTemplates, CreateFlowSignUrl, CreatePrepareFlow, DescribeFlowTemplates。

名称类型必选描述
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
ComponentHeightFloat在绝对定位方式和关键字定位方式下,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。
ComponentWidthFloat在绝对定位方式和关键字定位方式下,指定控件宽度,控件宽度是指控件在PDF文件中的宽度,单位为pt(点)。
ComponentPageInteger在绝对定位方式方式下,指定控件所在PDF文件上的页码

注:
1. 页码编号是从1开始编号的。
2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。
ComponentPosXFloat在绝对定位方式和关键字定位方式下,可以指定控件横向位置的位置,单位为pt(点)。
ComponentPosYFloat在绝对定位方式和关键字定位方式下,可以指定控件纵向位置的位置,单位为pt(点)。
FileIndexInteger【暂未使用】控件所属文件的序号(取值为:0-N)。 目前单文件的情况下,值一直为0
示例值:0
GenerateModeString控件生成的方式:
  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)
ComponentIdString控件唯一ID。

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

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

例:

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


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

点击查看ComponentId在模板编辑页面的位置
ComponentNameString在绝对定位方式方式下,ComponentName为控件名,长度不能超过20,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。

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

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

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

如果是签署控件,签批控件中签署意见等可以不填写, 其他签署控件不受此字段影响
ComponentRecipientIdString在通过接口拉取控件信息场景下,为出参参数,此控件归属的参与方的角色ID角色(即RecipientId),发起合同时候不要填写此字段留空即可
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 : 手写签名
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

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

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}]}"


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

场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。
参数样例 "{"IgnoreKeywordError":1}"
IsFormTypeBoolean在通过接口拉取控件信息场景下,为出参参数,此控件是否通过表单域定位方式生成,默认false-不是,发起合同时候不要填写此字段留空即可
ComponentValueString控件填充vaule,ComponentType和传入值类型对应关系:
  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId,需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容,详见说明:数据表格
  • DATE : 默认是格式化为xxxx年xx月xx日
  • 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标准
地址控件 只允许输入中文,英文,数字,中英文标点符号,不支持表情
省市区控件 只允许输入中文,英文,数字,中英文标点符号,不支持表情
性别控件 选择值中的字符串
学历控件 选择值中的字符串

注: 部分特殊控件需要在控制台配置模板形式创建
OffsetXFloat如果控件是关键字定位方式,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。
注意: 向左调整设置为负数, 向右调整设置成正数
注意:此字段可能返回 null,表示取不到有效值。
OffsetYFloat如果控件是关键字定位方式,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。
注意: 向上调整设置为负数, 向下调整设置成正数
注意:此字段可能返回 null,表示取不到有效值。
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开始计数的
LockComponentValueBooleanweb嵌入发起合同场景下, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
  • false(默认):不锁定控件值,允许在页面编辑控件值
  • true:锁定控件值,在页面编辑控件值

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

注意:此字段可能返回 null,表示取不到有效值。
ComponentDateFontSizeInteger【暂未使用】日期签署控件的字号,默认为 12
ChannelComponentIdString【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSourceInteger【暂未使用】第三方应用集成中子客企业控件来源。
  • 0 :平台指定;
  • 1 :用户自定义

ComponentLimit

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

被如下接口引用:CreateFlowByFiles, CreateFlowGroupByFiles, CreateFlowGroupByTemplates。

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

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

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

  • HANDWRITE : 手写签名
  • OCR_ESIGN : OCR印章(智慧手写签名)
  • ESIGN : 个人印章
  • SYSTEM_ESIGN : 系统印章


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

CreateFlowOption

创建合同个性化参数

被如下接口引用:CreatePrepareFlow。

名称类型必选描述
CanEditFlowBoolean是否允许修改发起合同时确认弹窗的合同信息(合同名称、合同类型、签署截止时间),若不允许编辑,则表单字段将被禁止输入。

true:允许编辑
false:不允许编辑(默认值)

示例值:true
CanEditFormFieldBoolean是否允许编辑模板控件

true:允许编辑模板控件信息

false:不允许编辑模板控件信息(默认值)


示例值:true
HideShowFlowNameBoolean发起页面隐藏合同名称展示

true:发起页面隐藏合同名称展示

false:发起页面不隐藏合同名称展示(默认值)


示例值:true
HideShowFlowTypeBoolean发起页面隐藏合同类型展示

true:发起页面隐藏合同类型展示

false:发起页面不隐藏合同类型展示(默认值)



示例值:true
HideShowDeadlineBoolean发起页面隐藏合同截止日期展示

true:发起页面隐藏合同截止日期展示

false:发起页面不隐藏合同截止日期展示(默认值)


示例值:true
CanSkipAddApproverBoolean发起页面允许跳过添加签署人环节

true:发起页面允许跳过添加签署人环节

false:发起页面不允许跳过添加签署人环节(默认值)



示例值:true
SkipUploadFileBoolean文件发起页面跳过文件上传步骤

true:文件发起页面跳过文件上传步骤

false:文件发起页面不跳过文件上传步骤(默认值)


示例值:true
ForbidEditFillComponentBoolean禁止编辑填写控件

true:禁止编辑填写控件

false:允许编辑填写控件(默认值)


示例值:true
CustomCreateFlowDescriptionString定制化发起合同弹窗的描述信息,描述信息最长500字符

示例值:""
ForbidAddApproverBoolean禁止添加签署方,若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮”
ForbidEditFlowPropertiesBoolean禁止设置设置签署流程属性 (顺序、合同签署认证方式等),若为true则在发起流程的可嵌入页面隐藏签署流程设置面板
HideComponentTypesArray of String在发起流程的可嵌入页面要隐藏的控件列表,和 ShowComponentTypes 参数 只能二选一使用,具体的控件类型如下
  • SIGN_SIGNATURE : 个人签名/印章
  • SIGN_SEAL : 企业印章
  • SIGN_PAGING_SEAL : 骑缝章
  • SIGN_LEGAL_PERSON_SEAL : 法定代表人章
  • SIGN_APPROVE : 签批
  • SIGN_OPINION : 签署意见
  • BUSI-FULL-NAME : 企业全称
  • BUSI-CREDIT-CODE : 统一社会信用代码
  • BUSI-LEGAL-NAME : 法人/经营者姓名
  • PERSONAL-NAME : 签署人姓名
  • PERSONAL-MOBILE : 签署人手机号
  • PERSONAL-IDCARD-TYPE : 签署人证件类型
  • PERSONAL-IDCARD : 签署人证件号
  • TEXT : 单行文本
  • MULTI_LINE_TEXT : 多行文本
  • CHECK_BOX : 勾选框
  • SELECTOR : 选择器
  • DIGIT : 数字
  • DATE : 日期
  • FILL_IMAGE : 图片
  • ATTACHMENT : 附件
  • EMAIL : 邮箱
  • LOCATION : 地址
  • EDUCATION : 学历
  • GENDER : 性别
  • DISTRICT : 省市区
ShowComponentTypesArray of String在发起流程的可嵌入页面要显示的控件列表,和 HideComponentTypes 参数 只能二选一使用,具体的控件类型如下
  • SIGN_SIGNATURE : 个人签名/印章
  • SIGN_SEAL : 企业印章
  • SIGN_PAGING_SEAL : 骑缝章
  • SIGN_LEGAL_PERSON_SEAL : 法定代表人章
  • SIGN_APPROVE : 签批
  • SIGN_OPINION : 签署意见
  • BUSI-FULL-NAME : 企业全称
  • BUSI-CREDIT-CODE : 统一社会信用代码
  • BUSI-LEGAL-NAME : 法人/经营者姓名
  • PERSONAL-NAME : 签署人姓名
  • PERSONAL-MOBILE : 签署人手机号
  • PERSONAL-IDCARD-TYPE : 签署人证件类型
  • PERSONAL-IDCARD : 签署人证件号
  • TEXT : 单行文本
  • MULTI_LINE_TEXT : 多行文本
  • CHECK_BOX : 勾选框
  • SELECTOR : 选择器
  • DIGIT : 数字
  • DATE : 日期
  • FILL_IMAGE : 图片
  • ATTACHMENT : 附件
  • EMAIL : 邮箱
  • LOCATION : 地址
  • EDUCATION : 学历
  • GENDER : 性别
  • DISTRICT : 省市区
ResultPageConfigArray of CreateResultPageConfig发起流程的可嵌入页面结果页配置

CreateResultPageConfig

发起流程的可嵌入页面操作结果页配置

被如下接口引用:CreatePrepareFlow。

名称类型必选描述
TypeInteger
TitleString结果页标题,不超过50字
DescriptionString结果页描述,不超过200字

CreateStaffResult

创建员工的结果

被如下接口引用:CreateIntegrationEmployees。

名称类型描述
SuccessEmployeeDataArray of SuccessCreateStaffData创建员工的成功列表
注意:此字段可能返回 null,表示取不到有效值。
FailedEmployeeDataArray of FailedCreateStaffData创建员工的失败列表
注意:此字段可能返回 null,表示取不到有效值。

DeleteStaffsResult

删除员工结果

被如下接口引用:DeleteIntegrationEmployees。

名称类型描述
SuccessEmployeeDataArray of SuccessDeleteStaffData删除员工的成功数据
注意:此字段可能返回 null,表示取不到有效值。
FailedEmployeeDataArray of FailedDeleteStaffData删除员工的失败数据
注意:此字段可能返回 null,表示取不到有效值。

Department

集成版员工部门信息。

被如下接口引用:CreateIntegrationEmployees, DeleteIntegrationEmployees, DescribeIntegrationEmployees, UpdateIntegrationEmployees。

名称类型必选描述
DepartmentIdString部门ID。
示例值:dp**155f2
DepartmentNameString部门名称。
示例值:测试部门

DetectInfoVideoData

视频认证结果

被如下接口引用:DescribeSignFaceVideo。

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

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

EmbedUrlOption

个性化参数

被如下接口引用:CreateEmbedWebUrl。

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

true:允许在合同详情页展示控件

false:不允许在合同详情页展示控件

默认false,合同详情页不展示控件
示例值:true
ShowTemplateComponentBoolean模板预览,允许展示模板控件信息

true:允许在模板预览页展示控件

false:不允许在模板预览页展示控件

默认false,模板预览页不展示控件
示例值:true

ExtendAuthInfo

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

被如下接口引用:DescribeExtendedServiceAuthInfos。

名称类型必选描述
TypeString扩展服务的类型,可能是以下值:
  • OPEN_SERVER_SIGN:企业自动签署
  • BATCH_SIGN:批量签署
  • OVERSEA_SIGN:企业与港澳台居民签署合同
  • AGE_LIMIT_EXPANSION:拓宽签署方年龄限制
  • MOBILE_CHECK_APPROVER:个人签署方仅校验手机号
  • HIDE_OPERATOR_DISPLAY:隐藏合同经办人姓名
  • ORGANIZATION_OCR_FALLBACK:正楷临摹签名失败后更换其他签名类型
  • ORGANIZATION_FLOW_NOTIFY_TYPE:短信通知签署方
  • HIDE_ONE_KEY_SIGN:个人签署方手动签字
  • PAGING_SEAL:骑缝章
  • ORGANIZATION_FLOW_PASSWD_NOTIFY:签署密码开通引导

示例值:BATCH_SIGN
NameString扩展服务的名称
示例值:批量签署
StatusString扩展服务的开通状态:

  • ENABLE : 已开通
  • DISABLE : 未开通


示例值:ENABLE
OperatorUserIdString操作扩展服务的操作人UserId,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
注意:此字段可能返回 null,表示取不到有效值。
示例值:yDR****CLU
OperateOnInteger扩展服务的操作时间,格式为Unix标准时间戳(秒)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1693557098
HasAuthUserListArray of HasAuthUser该扩展服务若可以授权,此参数对应授权人员的列表
注意:此字段可能返回 null,表示取不到有效值。

FailedCreateRoleData

绑定角色失败信息

被如下接口引用:CreateIntegrationUserRoles。

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

FailedCreateStaffData

创建员工的失败数据

被如下接口引用:CreateIntegrationEmployees。

名称类型描述
DisplayNameString员工名
MobileString员工手机号
WeworkOpenIdString传入的企微账号id
ReasonString失败原因

FailedDeleteStaffData

删除员工失败数据

被如下接口引用:DeleteIntegrationEmployees。

名称类型描述
UserIdString员工在电子签的userId
注意:此字段可能返回 null,表示取不到有效值。
OpenIdString员工在第三方平台的openId
注意:此字段可能返回 null,表示取不到有效值。
ReasonString失败原因

FailedUpdateStaffData

更新员工信息失败返回的数据信息

被如下接口引用:UpdateIntegrationEmployees。

名称类型描述
DisplayNameString用户传入的名称
MobileString用户传入的手机号,明文展示
ReasonString失败原因
UserIdString员工在腾讯电子签平台的唯一身份标识,为32位字符串。
可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
OpenIdString员工在第三方平台的openId

FileInfo

模板中文件的信息结构

被如下接口引用:DescribeFlowTemplates。

名称类型必选描述
FileIdString文件ID
FileNameString文件名
FileSizeInteger文件大小,单位为Byte
CreatedOnInteger文件上传时间,格式为Unix标准时间戳(秒)

FileUrl

下载文件的URL信息

被如下接口引用:DescribeFileUrls。

名称类型必选描述
UrlString下载文件的URL,有效期为输入的UrlTtl,默认5分钟
OptionString下载文件的附加信息。如果是pdf文件,会返回pdf文件每页的有效高宽
注意:此字段可能返回 null,表示取不到有效值。

FillApproverInfo

补充签署人信息

  • RecipientId 必须指定
  • 通过企业微信自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
  • 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填,ApproverSource设置为空
  • 补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充

被如下接口引用:CreateFlowApprovers。

名称类型必选描述
RecipientIdString签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
模板发起合同时,该参数为必填项。
文件发起合同是,该参数无需传值。
如果开发者后序用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
示例值:yDwhSUUckp3lqxlpUu6Ni3SvjJPoxxxx
ApproverSourceString签署人来源
WEWORKAPP: 企业微信

仅【企微或签】时指定WEWORKAPP
示例值:WEWORKAPP
CustomUserIdString企业微信UserId

当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企业微信的UserId
示例值:zhangsan
ApproverNameString补充企业签署人员工姓名
示例值:张三
ApproverMobileString补充企业签署人员工手机号
示例值:18800000000
OrganizationNameString补充企业动态签署人时,需要指定对应企业名称
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

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

被如下接口引用:CreateFlowApprovers。

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

FilledComponent

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

被如下接口引用:DescribeFlowComponents。

名称类型描述
ComponentIdString控件Id
注意:此字段可能返回 null,表示取不到有效值。
ComponentNameString控件名称
注意:此字段可能返回 null,表示取不到有效值。
ComponentFillStatusString控件填写状态;0-未填写;1-已填写
注意:此字段可能返回 null,表示取不到有效值。
ComponentValueString控件填写内容
注意:此字段可能返回 null,表示取不到有效值。
ComponentRecipientIdString控件所属参与方Id
注意:此字段可能返回 null,表示取不到有效值。
ImageUrlString图片填充控件下载链接,如果是图片填充控件时,这里返回图片的下载链接。
注意:此字段可能返回 null,表示取不到有效值。

Filter

查询过滤条件

被如下接口引用:DescribeFlowTemplates, DescribeIntegrationEmployees, DescribeIntegrationRoles。

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

FlowApproverDetail

签署人详情信息

被如下接口引用:DescribeFlowInfo。

名称类型描述
ApproveMessageString签署时的相关信息
注意:此字段可能返回 null,表示取不到有效值。
ApproveNameString签署方姓名
ApproveStatusInteger签署方的签署状态
0:还没有发起
1:流程中 没有开始处理
2:待签署
3:已签署
4:已拒绝
5:已过期
6:已撤销
7:还没有预发起
8:待填写
9:因为各种原因而终止
10:填写完成
15:已解除
19:转他人处理
ReceiptIdString模板配置中的参与方ID,与控件绑定
CustomUserIdString客户自定义的用户ID
注意:此字段可能返回 null,表示取不到有效值。
MobileString签署人手机号
SignOrderInteger签署顺序,如果是有序签署,签署顺序从小到大
ApproveTimeInteger签署人签署时间,时间戳,单位秒
ApproveTypeString签署方类型,ORGANIZATION-企业员工,PERSON-个人,ENTERPRISESERVER-企业静默签
注意:此字段可能返回 null,表示取不到有效值。
ApproverSourceString签署方侧用户来源,如WEWORKAPP-企业微信等
注意:此字段可能返回 null,表示取不到有效值。
CustomApproverTagString客户自定义签署方标识
注意:此字段可能返回 null,表示取不到有效值。
OrganizationIdString签署方企业Id
注意:此字段可能返回 null,表示取不到有效值。
OrganizationNameString签署方企业名称
注意:此字段可能返回 null,表示取不到有效值。
SignIdString签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
注意:此字段可能返回 null,表示取不到有效值。
示例值:yDw**y0S
ApproverRoleNameString自定义签署人角色
注意:此字段可能返回 null,表示取不到有效值。

FlowApproverUrlInfo

签署链接信息。

被如下接口引用:CreateBatchQuickSignUrl, CreateFlowSignUrl。

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

FlowBrief

合同流程的基础信息

被如下接口引用:DescribeFlowBriefs。

名称类型描述
FlowIdString合同流程ID,为32位字符串。
示例值:yDRCLUUgygq2xun5UuO4zjEwg0vjoimj
FlowNameString合同流程的名称。
示例值:测试合同-1
FlowDescriptionString合同流程描述信息。
注意:此字段可能返回 null,表示取不到有效值。
示例值:测试流程的描述信息
FlowTypeString合同流程的类别分类(如销售合同/入职合同等)。
示例值:入职合同
FlowStatusInteger合同流程当前的签署状态, 会存在下列的状态值
  • 0 : 未开启流程(合同中不存在填写环节)
  • 1 : 待签署
  • 2 : 部分签署
  • 3 : 已拒签
  • 4 : 已签署
  • 5 : 已过期
  • 6 : 已撤销
  • 7 : 未开启流程(合同中存在填写环节)
  • 8 : 等待填写
  • 9 : 部分填写
  • 10 : 已拒填
  • 21 : 已解除

注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreatedOnInteger合同流程创建时间,格式为Unix标准时间戳(秒)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1604910798
FlowMessageString当合同流程状态为已拒签(即 FlowStatus=3)或已撤销(即 FlowStatus=6)时,此字段 FlowMessage 为拒签或撤销原因。
注意:此字段可能返回 null,表示取不到有效值。
示例值:因合同中的预付款金额错误所以撤销此合同
CreatorString合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
注意:此字段可能返回 null,表示取不到有效值。
示例值:yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy
DeadlineInteger合同流程的签署截止时间,格式为Unix标准时间戳(秒)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1606910798

FlowCreateApprover

创建流程的签署方信息

被如下接口引用:CreateBatchQuickSignUrl, CreateFlow, CreateFlowSignUrl, CreatePrepareFlow。

名称类型必选描述
ApproverTypeInteger在指定签署方时,可以选择企业B端或个人C端等不同的参与者类型,可选类型如下:

  • 0 :企业B端。
  • 1 :个人C端。
  • 3 :企业B端静默(自动)签署,无需签署人参与,自动签署可以参考自动签署使用说明文档。
  • 7 :个人C端自动签署,适用于个人自动签场景。注: 个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。

示例值:1
OrganizationNameString组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号(),请使用中文括号()代替。

注: 当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时,必须指定

ApproverNameString签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。

在未指定签署人电子签UserId情况下,为必填参数
ApproverMobileString签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境,请确认手机号所有方为此合同签署方。

注:在未指定签署人电子签UserId情况下,为必填参数
ApproverIdCardTypeString证件类型,支持以下类型
  • ID_CARD: 居民身份证 (默认值)
  • HONGKONG_AND_MACAO : 港澳居民来往内地通行证
  • HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)

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

示例值:620000198802020000
RecipientIdString签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。

模板发起合同时,该参数为必填项,可以通过查询模版信息接口获得。
文件发起合同时,该参数无需传值。

如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
VerifyChannelArray of String签署意愿确认渠道,默认为WEIXINAPP:人脸识别

注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
示例值:["WEIXINAPP"]
NotifyTypeString通知签署方经办人的方式, 有以下途径:
  • sms : (默认)短信
  • none : 不通知


注: 既是发起方又是签署方时,不给此签署方发送短信
IsFullTextBoolean合同强制需要阅读全文,无需传此参数
PreReadTimeInteger签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。

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

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

UserIdString签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得

注:
如果传进来的UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参(会用此UserId实名的身份证和登录的手机号覆盖)
RequiredBoolean字段已经废弃,当前只支持true,默认为true
ApproverSourceString在企微场景下使用,需设置参数为WEWORKAPP,以表明合同来源于企微。
CustomApproverTagString在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
所有参与或签的人员均需具备该标识。
注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。
RegisterInfoRegisterInfo已经废弃, 快速注册相关信息
ApproverOptionApproverOption签署人个性化能力值,如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。
SignIdString签署人的签署ID


  • 在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数,电子签后台系统会自动生成。
  • 在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时,可以通过查询详情接口获取签署人的SignId,然后可以将此值传入,为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。

ApproverNeedSignReviewBoolean发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
  • false:(默认)不需要审批,直接签署。
  • true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。

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


注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
SignComponentsArray of Component签署人签署控件, 此参数仅针对文件发起(CreateFlowByFiles)生效

合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
  • 个人签名/印章
  • 企业印章
  • 骑缝章等签署控件


此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主
ComponentsArray of Component签署人填写控件 此参数仅针对文件发起(CreateFlowByFiles)生效

合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
  • 单行文本控件
  • 多行文本控件
  • 勾选框控件
  • 数字控件
  • 图片控件
  • 动态表格等填写控件


此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主
ComponentLimitTypeArray of String当签署方控件类型为 SIGN_SIGNATURE 时,可以指定签署方签名方式。如果不指定,签署人可以使用所有的签名类型,可指定的签名类型包括:

  • HANDWRITE :手写签名。
  • OCR_ESIGN :AI智能识别手写签名。
  • ESIGN :个人印章类型。
  • IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。
  • SYSTEM_ESIGN :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。


各种签名的样式可以参考下图:
image
ApproverVerifyTypesArray of Integer指定个人签署方查看合同的校验方式,可以传值如下:
  • 1 : (默认)人脸识别,人脸识别后才能合同内容
  • 2 : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)

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


此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主

.
示例值:[1,2]
ApproverSignTypesArray of Integer您可以指定签署方签署合同的认证校验方式,可传递以下值:
  • 1:人脸认证,需进行人脸识别成功后才能签署合同;
  • 2:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;
  • 3:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。

注:
  • 默认情况下,认证校验方式为人脸认证和签署密码两种形式;
  • 您可以传递多种值,表示可用多种认证校验方式。


注:
此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主
示例值:[1,2]
SignTypeSelectorInteger生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:
  • 0:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;
  • 1:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。

注:
不指定该值时,默认为签署方自行选择。
示例值:0
DeadlineInteger签署人的签署截止时间,格式为Unix标准时间戳(秒), 超过此时间未签署的合同变成已过期状态,不能在继续签署

注: 若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同
示例值:1604912664
IntentionIntention视频核身意图配置,可指定问答模式或者点头模式的语音文本。

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

FlowDetailInfo

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

被如下接口引用:DescribeFlowInfo。

名称类型描述
FlowIdString合同流程ID,为32位字符串。
示例值:yDRCLUUgygq2xun5UuO4zjEwg0vjoimj
FlowNameString合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
示例值:购买50吨西瓜的采购合同
FlowTypeString合同流程的类别分类(如销售合同/入职合同等)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:入职合同
FlowStatusInteger合同流程当前的签署状态, 会存在下列的状态值
  • 0 : 未开启流程(合同中不存在填写环节)
  • 1 : 待签署
  • 2 : 部分签署
  • 3 : 已拒签
  • 4 : 已签署
  • 5 : 已过期
  • 6 : 已撤销
  • 7 : 未开启流程(合同中存在填写环节)
  • 8 : 等待填写
  • 9 : 部分填写
  • 10 : 已拒填
  • 21 : 已解除

示例值:1
FlowMessageString当合同流程状态为已拒签(即 FlowStatus=3)或已撤销(即 FlowStatus=6)时,此字段 FlowMessage 为拒签或撤销原因。
注意:此字段可能返回 null,表示取不到有效值。
示例值:因合同中的预付款金额错误所以撤销此合同
FlowDescriptionString合同流程描述信息。
注意:此字段可能返回 null,表示取不到有效值。
示例值:测试流程的描述信息
CreatedOnInteger合同流程的创建时间戳,格式为Unix标准时间戳(秒)。
示例值:1606910798
FlowApproverInfosArray of FlowApproverDetail合同流程的签署方数组
CcInfosArray of FlowApproverDetail合同流程的关注方信息数组
CreatorString合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
注意:此字段可能返回 null,表示取不到有效值。
示例值:yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy

FlowGroupApproverInfo

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

被如下接口引用:CreateSchemeUrl。

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

FlowGroupApprovers

合同组签署方信息

被如下接口引用:CreateFlowGroupByFiles, CreateFlowGroupByTemplates。

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

FlowGroupInfo

此结构体(FlowGroupInfo)描述的是合同组(流程组)的单个合同(流程)信息

被如下接口引用:CreateFlowGroupByFiles, CreateFlowGroupByTemplates。

名称类型必选描述
FlowNameString合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
ApproversArray of ApproverInfo签署流程参与者信息,最大限制50方
注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。
FileIdsArray of String文件资源ID,通过多文件上传UploadFiles接口获得,为32位字符串。
建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。
TemplateIdString合同模板ID,为32位字符串。
建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
FlowTypeString签署流程的类型(如销售合同/入职合同等),最大长度200个字符
示例值:劳务合同
FlowDescriptionString签署流程描述,最大长度1000个字符
DeadlineInteger签署流程的签署截止时间。

值为unix时间戳,精确到秒,不传默认为当前时间一年后
示例值:1604912664
UserDataString调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
UnorderedBoolean发送类型:
true:无序签
false:有序签
注:默认为false(有序签),请和模板中的配置保持一致
示例值:true
ComponentsArray of Component模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
  • 单行文本控件
  • 多行文本控件
  • 勾选框控件
  • 数字控件
  • 图片控件
  • 动态表格等填写控件
NeedSignReviewBoolean发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。

注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
示例值:true
AutoSignSceneString个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
示例值:E_PRESCRIPTION_AUTO_SIGN

FlowGroupOptions

此结构体(FlowGroupOptions)描述的是合同组的个性化配置,支持控制是否发送短信、未实名个人签署方查看合同组时是否需要实名认证(仅在合同组文件发起配置时生效)

被如下接口引用:CreateFlowGroupByFiles, CreateFlowGroupByTemplates。

名称类型必选描述
ApproverVerifyTypeString签署人校验方式,支持以下类型
  • VerifyCheck : 人脸识别 (默认值)
  • MobileCheck : 手机号验证

参数说明:此参数仅在合同组文件发起有效,可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
SelfOrganizationApproverNotifyTypeString发起合同(流程)组本方企业经办人通知方式
签署通知类型,支持以下类型
  • sms : 短信 (默认值)
  • none : 不通知
OtherApproverNotifyTypeString发起合同(流程)组他方经办人通知方式
签署通知类型,支持以下类型
  • sms : 短信 (默认值)
  • none : 不通知

FlowGroupUrlInfo

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

被如下接口引用:CreateSchemeUrl。

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

FormField

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

当控件的 ComponentType=‘SIGN_SEAL'时,FormField.ComponentValue填入印章id。

  • 可用于指定自动签模板未设置自动签印章时,可由接口传入自动签印章
  • 若指定的控件上已设置ComponentValue,那以已经设置的ComponentValue为准
FormField输入示例:
{
"ComponentId": "componentId1",
"ComponentValue": "sealId(印章id)"
}

当控件的 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; 支持的文件类型包括doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf

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

被如下接口引用:CreateDocument。

名称类型必选描述
ComponentValueString控件填充vaule,ComponentType和传入值类型对应关系:
TEXT : 文本内容
MULTI_LINE_TEXT :文本内容
CHECK_BOX :true/false
FILL_IMAGE、ATTACHMENT : 附件的FileId,需要通过UploadFiles接口上传获取
SELECTOR : 选项值
DYNAMIC_TABLE :传入json格式的表格内容,具体见数据结构点击查看
示例值:ComponentValue
ComponentIdString控件id,和ComponentName选择一项传入即可

点击查看在模板中找到控件ID的方式
示例值:componentId
ComponentNameString控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可

点击查看在模板中找到控件名字的方式
示例值:ComponentName

GroupOrganization

成员企业信息

被如下接口引用:DescribeOrganizationGroupOrganizations。

名称类型描述
NameString成员企业名
注意:此字段可能返回 null,表示取不到有效值。
AliasString成员企业别名
注意:此字段可能返回 null,表示取不到有效值。
OrganizationIdString成员企业id,为 32 位字符串,可在电子签PC 控制台,企业设置->企业电子签账号 获取
注意:此字段可能返回 null,表示取不到有效值。
UpdateTimeInteger记录更新时间, unix时间戳,单位秒
注意:此字段可能返回 null,表示取不到有效值。
StatusInteger成员企业加入集团的当前状态
  • 1:待授权
  • 2:已授权待激活
  • 3:拒绝授权
  • 4:已解除
  • 5:已加入



注意:此字段可能返回 null,表示取不到有效值。
IsMainOrganizationBoolean是否为集团主企业
注意:此字段可能返回 null,表示取不到有效值。
IdCardNumberString企业社会信用代码
注意:此字段可能返回 null,表示取不到有效值。
AdminInfoAdmin企业超管信息
注意:此字段可能返回 null,表示取不到有效值。
LicenseString企业许可证Id,此字段暂时不需要关注
注意:此字段可能返回 null,表示取不到有效值。
LicenseExpireTimeInteger企业许可证过期时间,unix时间戳,单位秒
注意:此字段可能返回 null,表示取不到有效值。
JoinTimeInteger成员企业加入集团时间,unix时间戳,单位秒
注意:此字段可能返回 null,表示取不到有效值。
FlowEngineEnableBoolean是否使用自建审批流引擎(即不是企微审批流引擎)
  • true:是
  • false:否

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

HasAuthOrganization

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

被如下接口引用:DescribeExtendedServiceAuthDetail。

名称类型必选描述
OrganizationIdString授权企业id
注意:此字段可能返回 null,表示取不到有效值。
OrganizationNameString授权企业名称
注意:此字段可能返回 null,表示取不到有效值。
AuthorizedOrganizationIdString被授权企业id
注意:此字段可能返回 null,表示取不到有效值。
AuthorizedOrganizationNameString被授权企业名称
注意:此字段可能返回 null,表示取不到有效值。
TemplateIdString授权模板id(仅当授权方式为模板授权时有值)
注意:此字段可能返回 null,表示取不到有效值。
TemplateNameString授权模板名称(仅当授权方式为模板授权时有值)
注意:此字段可能返回 null,表示取不到有效值。
AuthorizeTimeInteger授权时间,格式为时间戳,单位s
注意:此字段可能返回 null,表示取不到有效值。

HasAuthUser

被授权的用户信息

被如下接口引用:DescribeExtendedServiceAuthDetail, DescribeExtendedServiceAuthInfos。

名称类型必选描述
UserIdString员工在腾讯电子签平台的唯一身份标识,为32位字符串。
注意:此字段可能返回 null,表示取不到有效值。
BelongToString当前员工的归属情况,可能值是:
MainOrg:在集团企业的场景下,返回此值代表是归属主企业
CurrentOrg:在普通企业场景下返回此值;或者在集团企业的场景下,返回此值代表归属子企业
注意:此字段可能返回 null,表示取不到有效值。
MainOrganizationIdString集团主企业id,当前企业为集团子企业时,该字段有值
注意:此字段可能返回 null,表示取不到有效值。

IntegrateRole

企业角色数据信息

被如下接口引用:DescribeIntegrationRoles。

名称类型描述
RoleIdString角色id
注意:此字段可能返回 null,表示取不到有效值。
RoleNameString角色名
注意:此字段可能返回 null,表示取不到有效值。
RoleStatusInteger角色状态,1-启用,2-禁用
注意:此字段可能返回 null,表示取不到有效值。
IsGroupRoleBoolean是否是集团角色,true-是,false-否
注意:此字段可能返回 null,表示取不到有效值。
SubOrgIdListArray of String管辖的子企业列表
注意:此字段可能返回 null,表示取不到有效值。
PermissionGroupsArray of PermissionGroup权限树
注意:此字段可能返回 null,表示取不到有效值。

IntegrationDepartment

部门信息

被如下接口引用:DescribeIntegrationDepartments。

名称类型描述
DeptIdString部门ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:dp**155f2
DeptNameString部门名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:测试部门
ParentDeptIdString父部门ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:yD**m1221
DeptOpenIdString客户系统部门ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:dept_open_1
OrderNoInteger序列号。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

Intention

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

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

被如下接口引用:CreateBatchQuickSignUrl, CreateFlow, CreateFlowSignUrl, CreatePrepareFlow。

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


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

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

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

IntentionAction

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

被如下接口引用:CreateBatchQuickSignUrl, CreateFlow, CreateFlowSignUrl, CreatePrepareFlow。

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

IntentionActionResult

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

被如下接口引用:DescribeSignFaceVideo。

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

IntentionActionResultDetail

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

被如下接口引用:DescribeSignFaceVideo。

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

IntentionQuestion

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

被如下接口引用:CreateBatchQuickSignUrl, CreateFlow, CreateFlowSignUrl, CreatePrepareFlow。

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

IntentionQuestionResult

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

被如下接口引用:DescribeSignFaceVideo。

名称类型描述
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位字符串。
OrganizationNameString组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号(),请使用中文括号()代替。
如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。

OccupiedSeal

持有的电子印章信息

被如下接口引用:DescribeOrganizationSeals。

名称类型描述
SealIdString电子印章编号
SealNameString电子印章名称
CreateOnInteger电子印章授权时间戳,单位秒
CreatorString电子印章授权人的UserId
SealPolicyIdString电子印章策略Id
SealStatusString印章状态,有以下六种:CHECKING(审核中)SUCCESS(已启用)FAIL(审核拒绝)CHECKING-SADM(待超管审核)DISABLE(已停用)STOPPED(已终止)
FailReasonString审核失败原因
注意:此字段可能返回 null,表示取不到有效值。
UrlString印章图片url,5分钟内有效
SealTypeString印章类型,OFFICIAL-企业公章, CONTRACT-合同专用章,ORGANIZATIONSEAL-企业印章(本地上传印章类型),LEGAL_PERSON_SEAL-法人印章
IsAllTimeBoolean用印申请是否为永久授权,true-是,false-否
AuthorizedUsersArray of AuthorizedUser授权人列表
注意:此字段可能返回 null,表示取不到有效值。

PdfVerifyResult

合同文件验签单个结果结构体

被如下接口引用:VerifyPdf。

名称类型描述
VerifyResultInteger验签结果。0-签名域未签名;1-验签成功; 3-验签失败;4-未找到签名域:文件内没有签名域;5-签名值格式不正确。
SignPlatformString签署平台
如果文件是在腾讯电子签平台签署,则为腾讯电子签
如果文件不在腾讯电子签平台签署,则为其他平台
SignerNameString申请证书的主体的名字

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

如果在其他平台签署的, 主体的名字参考其他平台的说明
SignTimeInteger签署时间的Unix时间戳,单位毫秒
SignAlgorithmString证书签名算法, 如SHA1withRSA等算法
CertSnStringCA供应商下发给用户的证书编号

注意:腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下
CertNotBeforeInteger证书起始时间的Unix时间戳,单位毫秒
CertNotAfterInteger证书过期时间的时间戳,单位毫秒
ComponentPosXFloat签名域横坐标,单位px
ComponentPosYFloat签名域纵坐标,单位px
ComponentWidthFloat签名域宽度,单位px
ComponentHeightFloat签名域高度,单位px
ComponentPageInteger签名域所在页码,1~N

Permission

权限树节点权限

被如下接口引用:CreateIntegrationRole, ModifyIntegrationRole。

名称类型必选描述
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

权限树中的权限组

被如下接口引用:CreateIntegrationRole, DescribeIntegrationRoles, ModifyIntegrationRole。

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

Recipient

流程中参与方的信息结构

被如下接口引用:DescribeFlowTemplates。

名称类型必选描述
RecipientIdString签署参与者ID,唯一标识
RecipientTypeString参与者类型。
默认为空。
ENTERPRISE-企业;
INDIVIDUAL-个人;
PROMOTER-发起方
示例值:ENTERPRISE
DescriptionString描述信息
RoleNameString角色名称
RequireValidationBoolean是否需要验证,
默认为false-不需要验证
RequireSignBoolean是否需要签署,
默认为true-需要签署
RoutingOrderInteger此参与方添加的顺序,从0~N
RequireDeliveryBoolean是否需要发送,
默认为true-需要发送
EmailString邮箱地址
MobileString电话号码
UserIdString关联的用户ID,电子签系统的用户ID
DeliveryMethodString发送方式,默认为EMAIL。
EMAIL-邮件;
MOBILE-手机短信;
WECHAT-微信通知
示例值:EMAIL
RecipientExtraString参与方的一些附属信息,json格式
ApproverVerifyTypesArray of Integer签署人查看合同校验方式, 支持的类型如下:
  • 1 :实名认证查看
  • 2 :手机号校验查看
ApproverSignTypesArray of Integer签署人进行合同签署时的认证方式,支持的类型如下:
  • 1 :人脸认证
  • 2 :签署密码
  • 3 :运营商三要素认证
  • 4 :UKey认证

RecipientComponentInfo

参与方填写控件信息

被如下接口引用:DescribeFlowComponents。

名称类型描述
RecipientIdString参与方Id
注意:此字段可能返回 null,表示取不到有效值。
RecipientFillStatusString参与方填写状态
  • 0-未填写
  • 1-已填写

注意:此字段可能返回 null,表示取不到有效值。
IsPromoterBoolean是否为发起方
  • true-发起方
  • false-参与方

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

RegisterInfo

发起流程快速注册相关信息

被如下接口引用:CreateBatchQuickSignUrl, CreateFlow, CreateFlowSignUrl, CreatePrepareFlow。

名称类型必选描述
LegalNameString法人姓名
UnifiedSocialCreditCodeString社会统一信用代码

ReleasedApprover

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

被如下接口引用:CreateReleaseFlow。

名称类型必选描述
NameString签署人姓名,最大长度50个字。

示例值:典子谦
MobileString签署人手机号。
示例值:13200000000
RelievedApproverReceiptIdString要更换的原合同参与人RecipientId编号。(可通过接口DescribeFlowInfo查询签署人的RecipientId编号)
ApproverTypeString指定签署人类型,目前仅支持
  • ORGANIZATION:企业(默认值)
  • ENTERPRISESERVER:企业静默签

示例值:ORGANIZATION
ApproverSignComponentTypeString签署控件类型,支持自定义企业签署方的签署控件类型
  • SIGN_SEAL:默认为印章控件类型(默认值)
  • SIGN_SIGNATURE:手写签名控件类型
ApproverSignRoleString参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫甲方,第二个叫乙方, 第三个叫丙方,以此类推。

如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。

示例值:供应商

RelieveInfo

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

被如下接口引用:CreateReleaseFlow。

名称类型必选描述
ReasonString解除理由,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
RemainInForceItemString解除后仍然有效的条款,保留条款,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
OriginalExpenseSettlementString原合同事项处理-费用结算,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
OriginalOtherSettlementString原合同事项处理-其他事项,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
OtherDealsString其他约定,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。

RemindFlowRecords

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

被如下接口引用:CreateFlowReminds。

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

ReviewerInfo

关注方信息

被如下接口引用:CreateEmbedWebUrl。

名称类型必选描述
NameString姓名
MobileString手机号

SealInfo

模板中指定的印章信息

被如下接口引用:DescribeFlowTemplates。

名称类型必选描述
SealIdString印章ID
注意:此字段可能返回 null,表示取不到有效值。
SealTypeString印章类型。LEGAL_PERSON_SEAL: 法定代表人章;
ORGANIZATIONSEAL:企业印章;
OFFICIAL:企业公章;
CONTRACT:合同专用章
注意:此字段可能返回 null,表示取不到有效值。
SealNameString印章名称
注意:此字段可能返回 null,表示取不到有效值。

SignQrCode

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

被如下接口引用:CreateMultiFlowSignQRCode。

名称类型描述
QrCodeIdString二维码ID,为32位字符串。
示例值:yDRS*Swc
QrCodeUrlString二维码URL,可通过转换二维码的工具或代码组件将此URL转化为二维码,以便用户扫描进行流程签署。
示例值:https://xxxx
ExpiredTimeInteger二维码的有截止时间,格式为Unix标准时间戳(秒)。
一旦超过二维码的有效期限,该二维码将自动失效。
示例值:1693814798

SignUrl

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

被如下接口引用:CreateMultiFlowSignQRCode。

名称类型描述
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

Staff

企业员工信息。

被如下接口引用:CreateIntegrationEmployees, DeleteIntegrationEmployees, DescribeIntegrationEmployees, UpdateIntegrationEmployees。

名称类型必选描述
UserIdString员工在腾讯电子签平台的唯一身份标识,为32位字符串。
注:创建和更新场景无需填写。
示例值:yDRCLUUgygq2xun5UuO4zjEwg0vjoimj
DisplayNameString显示的用户名/昵称。
示例值:张三
MobileString用户手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
示例值:13200000000
EmailString用户邮箱。
注意:此字段可能返回 null,表示取不到有效值。
示例值:testtest@tencent.com
OpenIdString用户在第三方平台ID。
注:如需在此接口提醒员工实名,该参数不传。
注意:此字段可能返回 null,表示取不到有效值。
示例值:open_user1
RolesArray of StaffRole员工角色信息。
注:创建和更新场景无需填写。
注意:此字段可能返回 null,表示取不到有效值。
DepartmentDepartment员工部门信息。
注意:此字段可能返回 null,表示取不到有效值。
VerifiedBoolean员工是否实名。
注:创建和更新场景无需填写。
示例值:false
CreatedOnInteger员工创建时间戳,单位秒。
注:创建和更新场景无需填写。
示例值:1691563315
VerifiedOnInteger员工实名时间戳,单位秒。
注:创建和更新场景无需填写。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1691563315
QuiteJobInteger员工是否离职:
  • 0:未离职
  • 1:离职

注:创建和更新场景无需填写。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ReceiveUserIdString员工离职交接人用户ID。
注:创建和更新场景无需填写。
示例值:yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy
ReceiveOpenIdString员工离职交接人用户OpenId。
注:创建和更新场景无需填写。
示例值:open_user2
WeworkOpenIdString企业微信用户账号ID。
注:仅企微类型的企业创建员工接口支持该字段。
注意:此字段可能返回 null,表示取不到有效值。
示例值:wework_open1

StaffRole

集成版企业角色信息。

被如下接口引用:CreateIntegrationEmployees, DeleteIntegrationEmployees, DescribeIntegrationEmployees, UpdateIntegrationEmployees。

名称类型必选描述
RoleIdString角色ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:4dff1**10b
RoleNameString角色名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:业务员

SuccessCreateStaffData

创建/修改员工成功返回的信息 现在支持saas/企微/H5端进行加入。

被如下接口引用:CreateIntegrationEmployees。

名称类型描述
DisplayNameString员工名
MobileString员工手机号
UserIdString员工在电子签平台的id
NoteString提示,当创建已存在未实名用户时,该字段有值
注意:此字段可能返回 null,表示取不到有效值。
WeworkOpenIdString传入的企微账号id
UrlString员工邀请返回链接 根据入参的 InvitationNotifyType 和 Endpoint 返回链接
链接类型有效期示例
HTTP_SHORT_URL(短链)一天https://test.essurl.cn/fvG7UBEd0F
HTTP(长链)一天https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?where=mini&from=MSG&to=USER_VERIFY&verifyToken=yDCVbUUckpwocmfpUySko7IS83LTV0u0&expireTime=1710840183
H530 天https://quick.test.qian.tencent.cn/guide?Code=yDCVbUUckpwtvxqoUbTw4VBBjLbfAtW7&CodeType=QUICK&shortKey=yDCVbUY7lhqV7mZlCL2d
APP一天/pages/guide/index?to=USER_VERIFY&verifyToken=yDCVbUUckpwocm96UySko7ISvEIZH7Yz&expireTime=1710840455

SuccessDeleteStaffData

删除员工的成功数据

被如下接口引用:DeleteIntegrationEmployees。

名称类型描述
DisplayNameString员工名
MobileString员工手机号
UserIdString员工在电子签平台的id

SuccessUpdateStaffData

更新员工信息成功返回的数据信息, 仅支持未实名的用户进行更新 会通过短信、企微消息或者H5Url 链接 如果是通过H5邀请加入的方式,会返回H5 链接

被如下接口引用:UpdateIntegrationEmployees。

名称类型描述
DisplayNameString传入的用户名称
MobileString传入的手机号,没有打码
UserIdString员工在腾讯电子签平台的唯一身份标识,为32位字符串。
可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
UrlStringH5端员工实名链接

只有入参 InvitationNotifyType = H5的时候才会进行返回。

TemplateInfo

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

模板组成

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

  • 模板基本信息
  • 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
  • 填写控件 Components
  • 签署控件 SignComponents
  • 生成模板的文件基础信息 FileInfos

被如下接口引用:DescribeFlowTemplates。

名称类型必选描述
TemplateIdString模板ID,模板的唯一标识
示例值:yDSLKUUckpoqt3vzUP7DfuSBwaJfz7M1
TemplateNameString模板的名字
示例值:西红柿采购模板
RecipientsArray of Recipient此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。

点击查看在模板中配置的签署参与方角色列表的样子

ComponentsArray of Component模板的填充控件列表

点击查看在模板中配置的填充控件的样子
SignComponentsArray of Component此模板中的签署控件列表

点击查看在模板中配置的签署控件的样子
DescriptionString模板描述信息
示例值:2023年西红柿采购模板
DocumentResourceIdsArray of String此模板的资源ID
FileInfosArray of FileInfo生成模板的文件基础信息
AttachmentResourceIdsArray of String此模板里边附件的资源ID
SignOrderArray of Integer签署人参与签署的顺序,可以分为以下两种方式:

无序:不限定签署人的签署顺序,签署人可以在任何时间签署。此种方式值为 :{-1}
有序:通过序列数字标识签署顺序,从0开始编码,数字越大签署顺序越靠后,签署人按照指定的顺序依次签署。此种方式值为: {0,1,2,3………}
示例值:1
StatusInteger此模板的状态可以分为以下几种:

-1:不可用状态。
0:草稿态,即模板正在编辑或未发布状态。
1:正式态,只有正式态的模板才可以发起合同。
CreatorString模板的创建者信息,用户的名字

注: 是创建者的名字,而非创建者的用户ID
示例值:张三
CreatedOnInteger模板创建的时间戳,格式为Unix标准时间戳(秒)
PromoterRecipient此模板创建方角色信息。

点击查看在模板中配置的创建方角色的样子
TemplateTypeInteger模板类型可以分为以下两种:

1:带有本企业自动签署的模板,即签署过程无需签署人手动操作,系统自动完成签署。
3:普通模板,即签署人需要手动进行签署操作。
AvailableInteger模板可用状态可以分为以下两种:

1:(默认)启用状态,即模板可以正常使用。
2:停用状态,即模板暂时无法使用。

可到控制台启停模板
OrganizationIdString创建模板的企业ID,电子签的机构ID
CreatorIdString模板创建人用户ID
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
UserFlowTypeUserFlowType用户自定义合同类型。

返回配置模板的时候选择的合同类型。点击查看配置的位置

自定义合同类型配置的地方如链接图所示。点击查看自定义合同类型管理的位置

注意:此字段可能返回 null,表示取不到有效值。
TemplateVersionString模板版本的编号,旨在标识其独特的版本信息,通常呈现为一串字符串,由日期和递增的数字组成
注意:此字段可能返回 null,表示取不到有效值。
示例值:20240205005
PublishedBoolean模板是否已发布可以分为以下两种状态:

true:已发布状态,表示该模板已经发布并可以正常使用。
false:未发布状态,表示该模板还未发布,无法使用。
注意:此字段可能返回 null,表示取不到有效值。
ShareTemplateIdString集体账号场景下: 集团账号分享给子企业的模板的来源模板ID。
注意:此字段可能返回 null,表示取不到有效值。
TemplateSealsArray of SealInfo此模板配置的预填印章列表(包括自动签署指定的印章)
注意:此字段可能返回 null,表示取不到有效值。

UploadFile

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

被如下接口引用:UploadFiles。

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

UserFlowType

用户自定义合同类型, 自定义合同类型的管理可以点击查看在控制台位置的截图

被如下接口引用:DescribeFlowTemplates。

名称类型必选描述
UserFlowTypeIdString合同类型ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:yDCNsUUg9tk6n6UtJrNd1S1ueFygJh9D
NameString合同类型名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:分销合同
DescriptionString合同类型说明
注意:此字段可能返回 null,表示取不到有效值。
示例值:由主承销人、国际协调人和全体承销商签署的旨在明确承销团成员间权利义务关系的协议

UserInfo

用户信息

被如下接口引用:BindEmployeeUserIdWithClientOpenId, CancelFlow, CancelMultiFlowSignQRCode, CancelUserAutoSignEnableUrl, CreateBatchCancelFlowUrl, CreateBatchQuickSignUrl, CreateBatchSignUrl, CreateConvertTaskApi, CreateDocument, CreateEmbedWebUrl, CreateExtendedServiceAuthInfos, CreateFlow, CreateFlowApprovers, CreateFlowByFiles, CreateFlowEvidenceReport, CreateFlowGroupByFiles, CreateFlowGroupByTemplates, CreateFlowGroupSignReview, CreateFlowReminds, CreateFlowSignReview, CreateFlowSignUrl, CreateIntegrationDepartment, CreateIntegrationEmployees, CreateIntegrationRole, CreateIntegrationUserRoles, CreateMultiFlowSignQRCode, CreateOrganizationBatchSignUrl, CreateOrganizationInfoChangeUrl, CreatePersonAuthCertificateImage, CreatePrepareFlow, CreatePreparedPersonalEsign, CreateReleaseFlow, CreateSchemeUrl, CreateSeal, CreateSealPolicy, CreateUserAutoSignEnableUrl, CreateUserAutoSignSealUrl, CreateWebThemeConfig, DeleteExtendedServiceAuthInfos, DeleteIntegrationDepartment, DeleteIntegrationEmployees, DeleteIntegrationRoleUsers, DeleteSealPolicies, DescribeCancelFlowsTask, DescribeExtendedServiceAuthDetail, DescribeExtendedServiceAuthInfos, DescribeFileUrls, DescribeFlowBriefs, DescribeFlowComponents, DescribeFlowEvidenceReport, DescribeFlowInfo, DescribeFlowTemplates, DescribeIntegrationDepartments, DescribeIntegrationEmployees, DescribeIntegrationRoles, DescribeOrganizationGroupOrganizations, DescribeOrganizationSeals, DescribePersonCertificate, DescribeSignFaceVideo, DescribeThirdPartyAuthCode, DescribeUserAutoSignStatus, DisableUserAutoSign, GetTaskResultApi, ModifyApplicationCallbackInfo, ModifyExtendedService, ModifyFlowDeadline, ModifyIntegrationDepartment, ModifyIntegrationRole, RenewAutoSignLicense, StartFlow, UnbindEmployeeUserIdWithClientOpenId, UpdateIntegrationEmployees, VerifyPdf。

名称类型必选描述
UserIdString用户在平台的编号

UserThreeFactor

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

被如下接口引用:CancelUserAutoSignEnableUrl, CreateUserAutoSignEnableUrl, CreateUserAutoSignSealUrl, DescribePersonCertificate, DescribeUserAutoSignStatus, DisableUserAutoSign, RenewAutoSignLicense。

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

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

示例值:610*1X

WebThemeConfig

页面主题配置

被如下接口引用:CreateWebThemeConfig。

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

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


示例值:#D54941
更多开发者交流反馈
购买咨询
4006-808-062
4006-808-062