数据结构

Agent

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

注:

不同的业务系统可以采用不同的应用，不同应用下的数据是隔离的, 应用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, ChannelDescribeUserAutoSignStatus, ChannelDisableUserAutoSign, ChannelGetTaskResultApi, ChannelModifyRole, ChannelUpdateSealStatus, ChannelVerifyPdf, CreateChannelFlowEvidenceReport, CreateChannelOrganizationInfoChangeUrl, CreateConsoleLoginUrl, CreateFlowsByTemplates, CreateSealByImage, CreateSignUrls, DescribeBillUsageDetail, DescribeChannelFlowEvidenceReport, DescribeChannelSealPolicyWorkflowUrl, DescribeExtendedServiceAuthInfo, DescribeFlowDetailInfo, DescribeResourceUrlsByFlows, DescribeTemplates, DescribeUsage, GetDownloadFlowUrl, ModifyExtendedService, OperateChannelTemplate, PrepareFlows, SyncProxyOrganization, SyncProxyOrganizationOperators, UploadFiles。

名称	类型	必选	描述
AppId	String	是	应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下:
ProxyOrganizationOpenId	String	否	第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串
ProxyOperator	UserInfo	否	第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。
ProxyAppId	String	否	不用填写，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。

ApproverComponentLimitType

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

被如下接口引用：ChannelCreateMultiFlowSignQRCode。

名称	类型	必选	描述
RecipientId	String	是	签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
Values	Array of String	否	签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE）时，可选的签名方式。签名方式： HANDWRITE-手写签名 ESIGN-个人印章类型 OCR_ESIGN-AI智能识别手写签名 SYSTEM_ESIGN-系统签名

ApproverItem

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

被如下接口引用：ChannelCreateFlowByFiles, CreateFlowsByTemplates。

名称	类型	描述
SignId	String	签署方唯一编号在动态补充签署人场景下，可以用此编号确定参与方注意：此字段可能返回 null，表示取不到有效值。
RecipientId	String	签署方角色编号在动态补充签署人场景下，可以用此编号确定参与方注意：此字段可能返回 null，表示取不到有效值。
ApproverRoleName	String	签署方角色名称注意：此字段可能返回 null，表示取不到有效值。

ApproverOption

签署人个性化能力信息

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

名称	类型	必选	描述
NoRefuse	Boolean	否	是否可以拒签默认false-可以拒签 true-不可以拒签示例值：true
NoTransfer	Boolean	否	是否可以转发默认false-可以转发 true-不可以转发示例值：true
HideOneKeySign	Boolean	否	是否隐藏一键签署默认false-不隐藏true-隐藏示例值：true
FillType	Integer	否	签署人信息补充类型，默认无需补充。 1 : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`
FlowReadLimit	String	否	签署人阅读合同限制参数取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）

ApproverRestriction

指定签署人限制项

被如下接口引用：ChannelCreateMultiFlowSignQRCode。

名称	类型	必选	描述
Name	String	否	指定签署人姓名示例值：张三
Mobile	String	否	指定签署人手机号，11位数字示例值：13000000000
IdCardType	String	否	指定签署人证件类型，ID_CARD-身份证，HONGKONG_AND_MACAO-港澳居民来往内地通行证，HONGKONG_MACAO_AND_TAIWAN-港澳台居民居住证示例值：ID_CARD
IdCardNumber	String	否	指定签署人证件号码，其中字母大写示例值：4500000000000000000

AuthFailMessage

授权出错信息

被如下接口引用：OperateChannelTemplate。

名称	类型	描述
ProxyOrganizationOpenId	String	第三方平台子客企业的唯一标识，长度不能超过64，只能由字母和数字组成。开发者可自定义此字段的值，并需要保存此 ID 以便进行后续操作。一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的，不可更改，不可重复使用。例如，可以使用企业名称的哈希值，或者社会统一信用代码的哈希值，或者随机哈希值。示例值：organization_open_id_xxxx
Message	String	错误信息

AuthorizedUser

授权用户

被如下接口引用：ChannelDescribeOrganizationSeals。

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

AutoSignConfig

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

被如下接口引用：ChannelCreateUserAutoSignEnableUrl。

名称	类型	必选	描述
UserInfo	UserThreeFactor	是	自动签开通个人用户信息, 包括名字,身份证等
CertInfoCallback	Boolean	否	是否回调证书信息: false: 不需要(默认) true:需要
UserDefineSeal	Boolean	否	是否支持用户自定义签名印章: false: 不能自己定义(默认) true: 可以自己定义
SealImgCallback	Boolean	否	回调中是否需要自动签将要使用的印章（签名）图片的 base64: false: 不需要(默认) true: 需要
CallbackUrl	String	否	回调链接，如果渠道已经配置了，可以不传
VerifyChannels	Array of String	否	开通时候的身份验证方式, 取值为： WEIXINAPP : 微信人脸识别 INSIGHT : 慧眼人脸认别 TELECOM : 运营商三要素验证注：如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP 如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT
LicenseType	Integer	否	设置用户开通自动签时是否绑定个人自动签账号许可。 0: (默认) 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人` 1: 不绑定自动签账号许可开通，后续使用合同份额进行合同发起

BaseFlowInfo

基础流程信息

被如下接口引用：ChannelCreatePrepareFlow。

名称	类型	必选	描述
FlowName	String	是	合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。示例值：张三的入职合同
FlowType	String	是	合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。示例值：销售合同
FlowDescription	String	是	合同流程描述信息(可自定义此描述)，最大长度1000个字符。示例值：张三2023年的入职公司财务部的合同
Deadline	Integer	是	合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。示例值：1604912664
Unordered	Boolean	否	合同流程的签署顺序类型： false：(默认)有序签署, 本合同多个参与人需要依次签署 true：无序签署, 本合同多个参与人没有先后签署限制示例值：true
IntelligentStatus	String	否	是否打开智能添加填写区(默认开启，打开:"OPEN" 关闭："CLOSE")
FormFields	Array of FormField	否	填写控件内容，填写的控制的ID-填写的内容对列表
NeedSignReview	Boolean	否	发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： false：（默认）不需要审批，直接签署。 true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
UserData	String	否	调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。示例值：QmFzZTY05YaF5a65
CcInfos	Array of CcInfo	否	合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。注:`此功能为白名单功能，使用前请联系对接的客户经理沟通。`
NeedCreateReview	Boolean	否	发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，发起审核结果需通过接口提交企业签署流程审批结果通知电子签，审核通过后，发起方企业签署人方可进行发起操作，否则会阻塞其发起操作。
Components	Array of Component	否	填写控件：文件发起使用

BillUsageDetail

用户计费使用情况详情

被如下接口引用：DescribeBillUsageDetail。

名称	类型	描述
FlowId	String	合同流程ID，为32位字符串。建议开发者妥善保存此流程ID，以便于顺利进行后续操作。注意：此字段可能返回 null，表示取不到有效值。示例值：ydxxxxxxxx
OperatorName	String	合同经办人名称如果有多个经办人用分号隔开。注意：此字段可能返回 null，表示取不到有效值。示例值：刘二;张三
CreateOrganizationName	String	发起方组织机构名称注意：此字段可能返回 null，表示取不到有效值。示例值：张三公司
FlowName	String	合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。注意：此字段可能返回 null，表示取不到有效值。示例值：张三发起的合同
Status	Integer	当前合同状态,如下是状态码对应的状态。 0-还没有发起 1-等待签署 2-部分签署 3-拒签 4-已签署 5-已过期 6-已撤销 7-还没有预发起 8-等待填写 9-部分填写 10-拒填 11-已解除注意：此字段可能返回 null，表示取不到有效值。示例值：4
QuotaType	String	套餐类型对应关系如下 CloudEnterprise-企业版合同 SingleSignature-单方签章 CloudProve-签署报告 CloudOnlineSign-腾讯会议在线签约 ChannelWeCard-微工卡 SignFlow-合同套餐 SignFace-签署意愿（人脸识别） SignPassword-签署意愿（密码） SignSMS-签署意愿（短信） PersonalEssAuth-签署人实名（腾讯电子签认证） PersonalThirdAuth-签署人实名（信任第三方认证） OrgEssAuth-签署企业实名 FlowNotify-短信通知 AuthService-企业工商信息查询注意：此字段可能返回 null，表示取不到有效值。示例值：CloudEnterprise
UseCount	Integer	合同使用量注意：此字段可能返回 null，表示取不到有效值。示例值：1
CostTime	Integer	消耗的时间戳，格式为Unix标准时间戳（秒）。注意：此字段可能返回 null，表示取不到有效值。示例值：1680162193
QuotaName	String	消耗的套餐名称注意：此字段可能返回 null，表示取不到有效值。示例值：企业版运营礼包
CostType	Integer	消耗类型 1.扣费 2.撤销返还注意：此字段可能返回 null，表示取不到有效值。示例值：1
Remark	String	备注注意：此字段可能返回 null，表示取不到有效值。

CcInfo

抄送信息

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

名称	类型	必选	描述
Mobile	String	否	被抄送人手机号，大陆11位手机号示例值：xxx
Name	String	否	被抄送人姓名
CcType	Integer	否	被抄送人类型 0--个人. 1--员工
CcPermission	Integer	否	被抄送人权限 0--可查看 1--可查看也可下载

ChannelBillUsageDetail

用户计费使用情况详情

被如下接口引用：ChannelDescribeBillUsageDetail。

名称	类型	描述
FlowId	String	合同流程ID，为32位字符串。示例值：yDwFdUUckps**uzcbXwoXbRF6ja3
OperatorName	String	合同经办人名称如果有多个经办人用分号隔开。示例值：典子谦;张三
CreateOrganizationName	String	发起方组织机构名称示例值：典子谦示例企业
FlowName	String	合同流程的名称。示例值：典子谦示例合同
FlowStatus	String	合同流程当前的签署状态, 会存在下列的状态值 INIT: 合同创建 PART: 合同签署中(至少有一个签署方已经签署) REJECT: 合同拒签 ALL: 合同签署完成 DEADLINE: 合同流签(合同过期) CANCEL: 合同撤回 RELIEVED: 解除协议（已解除） WILLEXPIRE: 合同即将过期 EXCEPTION: 合同异常示例值：ALL
QuotaType	String	查询的套餐类型对应关系如下: CloudEnterprise: 企业版合同 SingleSignature: 单方签章 CloudProve: 签署报告 CloudOnlineSign: 腾讯会议在线签约 ChannelWeCard: 微工卡 SignFlow: 合同套餐 SignFace: 签署意愿（人脸识别） SignPassword: 签署意愿（密码） SignSMS: 签署意愿（短信） PersonalEssAuth: 签署人实名（腾讯电子签认证） PersonalThirdAuth: 签署人实名（信任第三方认证） OrgEssAuth: 签署企业实名 FlowNotify: 短信通知 AuthService: 企业工商信息查询示例值：CloudEnterprise
UseCount	Integer	合同使用量注: `如果消耗类型是撤销返还，此值为负值代表返还的合同数量` 示例值：1
CostTime	Integer	消耗的时间戳，格式为Unix标准时间戳（秒）。示例值：1680162193
QuotaName	String	消耗的套餐名称示例值：企业版运营礼包
CostType	Integer	消耗类型 1.扣费 2.撤销返还示例值：1
Remark	String	备注

ChannelRole

角色信息

被如下接口引用：ChannelDescribeRoles。

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

CommonApproverOption

签署人配置信息

被如下接口引用：ChannelCreatePrepareFlow。

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

CommonFlowApprover

通用签署人信息

被如下接口引用：ChannelCreatePrepareFlow。

名称	类型	必选	描述
NotChannelOrganization	Boolean	是	指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。 false: 默认值，第三方平台子客企业下员工 true: SaaS平台企业下的员工示例值：true
ApproverType	Integer	否	在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: 0 :企业/企业员工（企业签署方或模板发起时的企业静默签） 1 :个人/自然人 3 :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签）注：类型为3（企业/企业员工自动签）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。示例值：1
OrganizationId	String	否	电子签平台给企业生成的企业id 示例值：yDRSRUUgygj6qnwfUuO4zjEwc193c2hH
OrganizationOpenId	String	否	企业OpenId，第三方应用集成非静默签子客企业签署人发起合同必传示例值：org_diziqian
OrganizationName	String	否	企业名称，第三方应用集成非静默签子客企业签署人必传，saas企业签署人必传示例值：典子谦示例企业
UserId	String	否	电子签平台给企业员工或者自热人生成的用户id 示例值：yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
OpenId	String	否	第三方平台子客企业员工的唯一标识示例值：n9527
ApproverName	String	否	签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。示例值：典子谦
ApproverMobile	String	否	签署人手机号，saas企业签署人，个人签署人必传示例值：13888888888
ApproverIdCardType	String	否	签署方经办人的证件类型，支持以下类型 ID_CARD : 居民身份证 (默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证) OTHER_CARD_TYPE : 其他证件注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。` 示例值：ID_CARD
ApproverIdCardNumber	String	否	签署方经办人的证件号码，应符合以下规则居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。示例值：110101192008317114
RecipientId	String	否	签署人Id，使用模板发起是，对应模板配置中的签署人RecipientId 注意：模板发起时该字段必填示例值：yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS
PreReadTime	Integer	否	签署前置条件：阅读时长限制，不传默认10s,最大300s，最小3s 示例值：5
IsFullText	Boolean	否	签署前置条件：阅读全文限制示例值：true
NotifyType	String	否	通知签署方经办人的方式, 有以下途径: SMS :(默认)短信 NONE : 不通知注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知` 示例值：NONE
ApproverOption	CommonApproverOption	否	签署人配置
SignComponents	Array of Component	否	使用PDF文件直接发起合同时，签署人指定的签署控件；使用模板发起合同时，指定本企业印章签署控件的印章ID: 通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。
ApproverVerifyTypes	Array of Integer	否	指定个人签署方查看合同的校验方式,可以传值如下: 1 : （默认）人脸识别,人脸识别后才能合同内容 2 : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）注: 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式此字段可传多个校验方式示例值：[1,2]
ApproverSignTypes	Array of Integer	否	签署人签署合同时的认证方式 1 :人脸认证 2 :签署密码 3 :运营商三要素默认为1(人脸认证 ),2(签署密码) 注: 1. 用模板创建合同场景, 签署人的认证方式需要在配置模板的时候指定, 在创建合同重新指定无效 2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考运营商支持列表类得到具体的支持说明示例值：[1,2,3]

Component

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

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

绝对定位方式
表单域(FIELD)定位方式
关键字(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

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

名称	类型	必选	描述
ComponentId	String	否	控件编号 CreateFlowByTemplates发起合同时优先以ComponentId（不为空）填充；否则以ComponentName填充注：当GenerateMode=KEYWORD时，通过"^"来决定是否使用关键字整词匹配能力。例：当GenerateMode=KEYWORD时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。创建控件时，此值为空查询时返回完整结构示例值：ComponentId
ComponentType	String	否	如果是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_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）； SIGN_PAGING_SEAL - 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight SIGN_OPINION - 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认; SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。表单域的控件不能作为印章和签名控件示例值：SIGN_SEAL
ComponentName	String	否	控件简称，不超过30个字符示例值：ComponentName
ComponentRequired	Boolean	否	控件是否为必填项，默认为false-非必填示例值：false
ComponentRecipientId	String	否	控件关联的参与方ID，对应Recipient结构体中的RecipientId 示例值：ComponentRecipientId
FileIndex	Integer	否	控件所属文件的序号 (文档中文件的排列序号，从0开始) 示例值：0
GenerateMode	String	否	控件生成的方式： NORMAL - 普通控件 FIELD - 表单域 KEYWORD - 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）示例值：NORMAL
ComponentWidth	Float	否	参数控件宽度，默认100，单位px 表单域和关键字转换控件不用填示例值：10
ComponentHeight	Float	否	参数控件高度，默认100，单位px 表单域和关键字转换控件不用填示例值：10
ComponentPage	Integer	否	参数控件所在页码，从1开始示例值：0
ComponentPosX	Float	否	参数控件X位置，单位px 示例值：10
ComponentPosY	Float	否	参数控件Y位置，单位px 示例值：10
ComponentExtra	String	否	扩展参数：为JSON格式。不同类型的控件会有部分非通用参数 ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： 1 Font：目前只支持黑体、宋体 2 FontSize：范围12-72 3 FontAlign： Left/Right/Center，左对齐/居中/右对齐 4 FontColor：字符串类型，格式为RGB颜色数字参数样例：{\"FontColor\":\"255,0,0\",\"FontSize\":12} ComponentType为FILL_IMAGE时，支持以下参数： NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true: 不居中 FillMethod: int. 填充方式。0-铺满（默认）；1-等比例缩放 ComponentType为SIGN_SIGNATURE类型可以控制签署方式 {“ComponentTypeLimit”: [“xxx”]} xxx可以为： HANDWRITE – 手写签名 OCR_ESIGN -- AI智能识别手写签名 ESIGN -- 个人印章类型 SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）如：{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]} ComponentType为SIGN_DATE时，支持以下参数： 1 Font：字符串类型目前只支持"黑体"、"宋体"，如果不填默认为"黑体" 2 FontSize：数字类型，范围6-72，默认值为12 3 FontAlign：字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐 4 Format：字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。 5 Gaps:：字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "ComponentExtra": "{"Format":“yyyy m d”,"FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}" ComponentType为SIGN_SEAL类型时，支持以下参数： 1.PageRanges：PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）参数样例： "ComponentExtra":"{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}" 示例值：ComponentExtra
ComponentValue	String	否	控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTILINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DATE - 默认是格式化为xxxx年xx月xx日 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo SIGN_SEAL - 印章ID SIGN_PAGING_SEAL - 可以指定印章ID 控件值约束说明：企业全称控件：约束：企业名称中文字符中文括号检查正则表达式：/^[\u3400-\u4dbf\u4e00-\u9fa5（）]+$/ 统一社会信用代码控件：检查正则表达式：/^[A-Z0-9]{1,18}$/ 法人名称控件：约束：最大50个字符，2到25个汉字或者1到50个字母检查正则表达式：/^([\u3400-\u4dbf\u4e00-\u9fa5.·]{2,25}\|[a-zA-Z·,\s-]{1,50})$/ 签署意见控件：约束：签署意见最大长度为50字符签署人手机号控件：约束：国内手机号 13,14,15,16,17,18,19号段长度11位签署人身份证控件：约束：合法的身份证号码检查控件名称：约束：控件名称最大长度为20字符单行文本控件：约束：只允许输入中文，英文，数字，中英文标点符号多行文本控件：约束：只允许输入中文，英文，数字，中英文标点符号勾选框控件：约束：选择填字符串true，不选填字符串false 选择器控件：约束：同单行文本控件约束，填写选择值中的字符串数字控件：约束：请输入有效的数字(可带小数点) 检查正则表达式：/^(-\|+)?\d+(.\d+)?$/ 日期控件：约束：格式：yyyy年mm月dd日附件控件：约束：JPG或PNG图片，上传数量限制，1到6个，最大6个附件图片控件：约束：JPG或PNG图片，填写上传的图片资源ID 邮箱控件：约束：请输入有效的邮箱地址, w3c标准检查正则表达式：/^([A-Za-z0-9-.!#$%&])+@([A-Za-z0-9_-.])+.([A-Za-z]{2,4})$/ 参考：https://emailregex.com/ 地址控件：同单行文本控件约束省市区控件：同单行文本控件约束性别控件：同单行文本控件约束，填写选择值中的字符串学历控件：同单行文本控件约束，填写选择值中的字符串示例值：ComponentValue
ComponentDateFontSize	Integer	否	日期签署控件的字号，默认为 12 签署区日期控件会转换成图片格式并带存证，需要通过字体决定图片大小示例值：12
DocumentId	String	否	控件所属文档的Id, 模板相关接口为空值示例值：c17bdf9c2a7bdcb32611f4d0200fee3d
ComponentDescription	String	否	控件描述，不超过30个字符示例值：Desc
OffsetX	Float	否	指定关键字时横坐标偏移量，单位pt
OffsetY	Float	否	指定关键字时纵坐标偏移量，单位pt
ChannelComponentId	String	否	平台企业控件ID。如果不为空，属于平台企业预设控件；
KeywordOrder	String	否	指定关键字排序规则， Positive-正序， Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的最后一个关键字。示例值：Positive\Reverse
KeywordPage	Integer	否	指定关键字页码。指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来
RelativeLocation	String	否	关键字位置模式， Middle-居中， Below-正下方， Right-正右方， LowerRight-右上角， UpperRight-右下角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
KeywordIndexes	Array of Integer	否	关键字索引，如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。示例[0,2]，说明使用PDF文件内第1个和第3个关键字位置。
Placeholder	String	否	填写提示的内容注意：此字段可能返回 null，表示取不到有效值。
LockComponentValue	Boolean	否	是否锁定控件值不允许编辑（嵌入式发起使用）默认false：不锁定控件值，允许在页面编辑控件值注意：此字段可能返回 null，表示取不到有效值。
ForbidMoveAndDelete	Boolean	否	是否禁止移动和删除控件默认false，不禁止移动和删除控件注意：此字段可能返回 null，表示取不到有效值。

ComponentLimit

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

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

名称	类型	必选	描述
ComponentType	String	是	控件类型，支持以下类型 SIGN_SEAL : 印章控件 SIGN_PAGING_SEAL : 骑缝章控件 SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件 SIGN_SIGNATURE : 用户签名控件
ComponentValue	Array 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

创建合同个性化参数

被如下接口引用：ChannelCreatePrepareFlow。

名称	类型	必选	描述
CanEditFlow	Boolean	否	是否允许修改合同信息， true：可以 false：（默认）不可以示例值：true
HideShowFlowName	Boolean	否	是否允许发起合同弹窗隐藏合同名称 true：允许 false：（默认）不允许示例值：false
HideShowFlowType	Boolean	否	是否允许发起合同弹窗隐藏合同类型， true：允许 false：（默认）不允许示例值：true
HideShowDeadline	Boolean	否	是否允许发起合同弹窗隐藏合同到期时间 true：允许 false：（默认）不允许示例值：true
CanSkipAddApprover	Boolean	否	是否允许发起合同步骤跳过指定签署方步骤 true：允许 false：（默认）不允许示例值：false
CustomCreateFlowDescription	String	否	定制化发起合同弹窗的描述信息，长度不能超过500，只能由中文、字母、数字和标点组成。示例值：本合同已经经过法务评估
ForbidEditFillComponent	Boolean	否	禁止编辑填写控件 true：禁止编辑填写控件 false：（默认）允许编辑填写控件示例值：false
SkipUploadFile	Boolean	否	跳过上传文件步骤 true：跳过 false：（默认）不跳过，需要传ResourceId 示例值：false

Department

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

被如下接口引用：ChannelDescribeEmployees。

名称	类型	描述
DepartmentId	String	部门id 注意：此字段可能返回 null，表示取不到有效值。
DepartmentName	String	部门名称注意：此字段可能返回 null，表示取不到有效值。

DownloadFlowInfo

签署流程下载信息

被如下接口引用：GetDownloadFlowUrl。

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

ExtentServiceAuthInfo

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

被如下接口引用：DescribeExtendedServiceAuthInfo。

名称	类型	描述
Type	String	扩展服务类型 AUTO_SIGN 企业自动签（自动签署） OVERSEA_SIGN 企业与港澳台居民*签署合同 MOBILE_CHECK_APPROVER 使用手机号验证签署方身份 PAGING_SEAL 骑缝章 DOWNLOAD_FLOW 授权渠道下载合同 AGE_LIMIT_EXPANSION 拓宽签署方年龄限制示例值：AUTO_SIGN
Name	String	扩展服务名称示例值：企业静默签（自动签署）
Status	String	扩展服务的开通状态 ENABLE：开通 DISABLE：未开通示例值：DISABLE
OperatorOpenId	String	操作扩展服务的操作人第三方应用平台的用户openid 注意：此字段可能返回 null，表示取不到有效值。
OperateOn	Integer	扩展服务的操作时间，格式为Unix标准时间戳（秒）。注意：此字段可能返回 null，表示取不到有效值。

FailedCreateRoleData

绑定失败的用户角色信息

被如下接口引用：ChannelCreateUserRoles。

名称	类型	描述
UserId	String	用户userId 注意：此字段可能返回 null，表示取不到有效值。
RoleIds	Array of String	角色RoleId列表注意：此字段可能返回 null，表示取不到有效值。

FillApproverInfo

指定补充签署人信息

RecipientId 必须指定

被如下接口引用：ChannelCreateFlowApprovers。

名称	类型	必选	描述
RecipientId	String	是	签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
OpenId	String	否	指定企业经办签署人OpenId
ApproverName	String	否	签署人姓名
ApproverMobile	String	否	签署人手机号码
OrganizationName	String	否	企业名称
OrganizationOpenId	String	否	企业OpenId
NotChannelOrganization	Boolean	否	签署企业非渠道子客，默认为false，即表示同一渠道下的企业；如果为true，则目前表示接收方企业为SaaS企业, 为渠道子客时，OrganizationOpenId 必传

FillError

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

被如下接口引用：ChannelCreateFlowApprovers。

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

FilledComponent

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

被如下接口引用：ChannelDescribeFlowComponents。

名称	类型	描述
ComponentId	String	填写控件ID 示例值：Component_1
ComponentName	String	控件名称示例值：商品价格
ComponentFillStatus	String	此填写控件的填写状态 0 : 此填写控件未填写 1 : 此填写控件已填写示例值：1
ComponentValue	String	控件填写内容示例值：100
ImageUrl	String	图片填充控件下载链接，如果是图片填充控件时，这里返回图片的下载链接。注: `链接不是永久链接, 默认有效期5分钟后, 到期后链接失效` 示例值：https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=ffe60eceb87e57f6d25

Filter

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

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

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

FlowApproverDetail

签署人的流程信息明细

被如下接口引用：DescribeFlowDetailInfo。

名称	类型	描述
ReceiptId	String	模板配置时候的签署人角色ID(用PDF文件发起也可以指定,如果不指定则自动生成此角色ID), 所有的填写控件和签署控件都归属不同的角色示例值：yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS
ProxyOrganizationOpenId	String	第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体注意：此字段可能返回 null，表示取不到有效值。示例值：org_dianziqian
ProxyOperatorOpenId	String	第三方平台子客企业员工的唯一标识示例值：n9527
ProxyOrganizationName	String	第三方平台子客企业名称，与企业营业执照中注册的名称一致。示例值：典子谦示例企业
Mobile	String	签署人手机号示例值：13888888888
SignOrder	Integer	签署顺序，如果是有序签署，签署顺序从小到大
ApproveName	String	签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。注意：此字段可能返回 null，表示取不到有效值。示例值：典子谦
ApproveStatus	String	当前签署人的状态, 状态如下 PENDING :待签署 FILLPENDING :待填写 FILLACCEPT :填写完成 FILLREJECT :拒绝填写 WAITPICKUP :待领取 ACCEPT :已签署 REJECT :拒签 DEADLINE :过期没人处理 CANCEL :流程已撤回 FORWARD :已经转他人处理 STOP :流程已终止 RELIEVED :解除协议（已解除）注意：此字段可能返回 null，表示取不到有效值。示例值：ACCEPT
ApproveMessage	String	签署人拒签等情况的时候填写的原因注意：此字段可能返回 null，表示取不到有效值。
ApproveTime	Integer	签署人签署时间戳，单位秒示例值：1689688460
ApproveType	String	参与者类型 ORGANIZATION :企业签署人 PERSON :个人签署人注意：此字段可能返回 null，表示取不到有效值。示例值：PERSON
ApproverRoleName	String	自定义签署人的角色名, 如: 收款人、开具人、见证人等注意：此字段可能返回 null，表示取不到有效值。示例值：卖方

FlowApproverInfo

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

各种场景传参说明:

场景编号	可作为发起方类型	可作为签署方的类型	签署方传参说明
场景一	第三方子企业A员工	第三方子企业A员工	OpenId、OrganizationName、OrganizationOpenId必传 ,ApproverType设置为ORGANIZATION
场景二	第三方子企业A员工	第三方子企业B(不指定经办人)	OrganizationName、OrganizationOpenId必传 ,ApproverType设置为ORGANIZATION
场景三	第三方子企业A员工	第三方子企业B员工	OpenId、OrganizationOpenId、OrganizationName必传, ApproverType设置为ORGANIZATION
场景四	第三方子企业A员工	个人/自然人	Name、Mobile必传, ApproverType设置为PERSON
场景五	第三方子企业A员工	SaaS平台企业员工	Name、Mobile、OrganizationName必传，且NotChannelOrganization=True。 ApproverType设置为ORGANIZATION

注1: 使用模板发起合同时，RecipientId（模板发起合同时）必传

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

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

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

名称	类型	必选	描述
Name	String	否	签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。示例值：张三
IdCardType	String	否	签署方经办人的证件类型，支持以下类型 ID_CARD : 居民身份证 (默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证) OTHER_CARD_TYPE : 其他证件注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。` 示例值：ID_CARD
IdCardNumber	String	否	签署方经办人的证件号码，应符合以下规则居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。示例值：110101192008317114
Mobile	String	否	签署方经办人手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)，不支持海外手机号。请确认手机号所有方为此合同签署方。示例值：13888888888
OrganizationName	String	否	组织机构名称。请确认该名称与企业营业执照中注册的名称一致。如果名称中包含英文括号()，请使用中文括号（）代替。示例值：典子谦示例企业
NotChannelOrganization	Boolean	否	指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。 false: 默认值，第三方平台子客企业下员工 true: SaaS平台企业下的员工示例值：false
OpenId	String	否	第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成当签署方为同一第三方平台下的员工时，该字段若不指定，则发起【待领取】的流程示例值：userdianziqian
OrganizationOpenId	String	否	同应用下第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样，签署方为非发起方企业场景下必传，最大长度64个字符示例值：orgtencent
ApproverType	String	否	在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下: PERSON :个人/自然人 PERSON_AUTO_SIGN :个人/自然人自动签署，适用于个人自动签场景 ORGANIZATION :企业/企业员工（企业签署方或模板发起时的企业静默签） ENTERPRISESERVER :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签）注: `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。` `2. 若要实现他方企业（同一应用下）自动签，需要满足3个条件：` 条件1：ApproverType 设置为ENTERPRISESERVER 条件2：子客之间完成授权条件3：联系对接的客户经理沟通如何使用示例值：PERSON
RecipientId	String	否	签署流程签署人在模板中对应的签署人Id；在非单方签署、以及非B2C签署的场景下必传，用于指定当前签署方在签署流程中的位置；示例值：yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS
Deadline	Integer	否	本签署人在此合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。示例值：1689688460
SignComponents	Array of Component	否	使用PDF文件直接发起合同时，签署人指定的签署控件；使用模板发起合同时，指定本企业印章签署控件的印章ID: 通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。
ComponentLimitType	Array of String	否	签署方控件类型为 SIGN_SIGNATURE时，可以指定签署方签名方式 HANDWRITE – 手写签名 OCR_ESIGN -- AI智能识别手写签名 ESIGN -- 个人印章类型 SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）示例值：["OCR_ESIGN"]
PreReadTime	Integer	否	签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：合同页数少于等于2页，阅读时间为3秒；合同页数为3到5页，阅读时间为5秒；合同页数大于等于6页，阅读时间为10秒。示例值：3
JumpUrl	String	否	签署完前端跳转的url，此字段的用法场景请联系客户经理确认示例值：https://www.qq.com/success
ApproverOption	ApproverOption	否	可以控制签署方在签署合同时能否进行某些操作，例如拒签、转交他人、是否为动态补充签署人等。详细操作可以参考开发者中心的ApproverOption结构体。
ApproverNeedSignReview	Boolean	否	当前签署方进行签署操作是否需要企业内部审批，true 则为需要示例值：false
ApproverVerifyTypes	Array of Integer	否	指定个人签署方查看合同的校验方式,可以传值如下: 1 : （默认）人脸识别,人脸识别后才能合同内容 2 : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）注: 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式此字段可传多个校验方式示例值：[1,2]
ApproverSignTypes	Array of Integer	否	签署人签署合同时的认证方式 1 :人脸认证 2 :签署密码 3 :运营商三要素默认为1(人脸认证 ),2(签署密码) 注: 1. 用模板创建合同场景, 签署人的认证方式需要在配置模板的时候指定, 在创建合同重新指定无效 2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考运营商支持列表类得到具体的支持说明示例值：[1,2,3]
SignId	String	否	签署ID - 发起流程时系统自动补充 - 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息
NotifyType	String	否	通知签署方经办人的方式, 有以下途径: SMS :(默认)短信 NONE : 不通知注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知` 示例值：SMS
AddSignComponentsLimits	Array of ComponentLimit	否	通过文件创建签署流程时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID）或签名方式。注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个），他方企业或个人只支持限制控件类型。`
ApproverRoleName	String	否	可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`

FlowApproverItem

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

被如下接口引用：CreateFlowsByTemplates。

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

FlowApproverUrlInfo

签署人签署链接信息。

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

名称	类型	描述
SignUrl	String	签署短链接。注意: - 该链接有效期为30分钟，同时需要注意保密，不要外泄给无关用户。 - 该链接不支持小程序嵌入，仅支持移动端浏览器打开。示例值：https://essurl.cn/M**XE
ApproverType	String	签署人类型。 - PERSON: 个人示例值：PERSON
Name	String	签署人姓名。示例值：典子谦
Mobile	String	签署人手机号。示例值：13200000000
LongUrl	String	签署长链接。注意: - 该链接有效期为30分钟，同时需要注意保密，不要外泄给无关用户。 - 该链接不支持小程序嵌入，仅支持移动端浏览器打开。注意：此字段可能返回 null，表示取不到有效值。示例值：https://quick.qian.tencent.cn/home?ApproverIdCardNumber=MioqKKio2&ApproverMobile=MTkx%3D&ApproverName=%25E2A&ApproverType=1&Code=yDSw3u2Mg8q&CodeType=QUICK&FlowId=yDSLVUUMszDy&ShowHeader=1&shortKey=yDwq5UGlG1c&token=M**XE"

FlowDetailInfo

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

被如下接口引用：DescribeFlowDetailInfo。

名称	类型	描述
FlowId	String	合同流程ID，为32位字符串。示例值：yDRCLUUgygq2xun5UuO4zjEwg0vjoimj
FlowName	String	合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。示例值：购买50吨西瓜的采购合同
FlowType	String	合同流程的类别分类（如销售合同/入职合同等）。示例值：入职合同
FlowStatus	String	合同流程当前的签署状态, 会存在下列的状态值 INIT :合同创建 PART :合同签署中(至少有一个签署方已经签署) REJECT :合同拒签 ALL :合同签署完成 DEADLINE :合同流签(合同过期) CANCEL :合同撤回 RELIEVED :解除协议（已解除）
FlowMessage	String	当合同流程状态为已拒签（即 FlowStatus=REJECT）或已撤销（即 FlowStatus=CANCEL ）时，此字段 FlowMessage 为拒签或撤销原因。
CreateOn	Integer	合同流程的创建时间戳，格式为Unix标准时间戳（秒）。示例值：1606910798
DeadLine	Integer	签署流程的签署截止时间, 值为unix时间戳, 精确到秒。示例值：1604912664
CustomData	String	调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
FlowApproverInfos	Array of FlowApproverDetail	合同流程的签署方数组
CcInfos	Array of FlowApproverDetail	合同流程的关注方信息数组
NeedCreateReview	Boolean	是否需要发起前审批当NeedCreateReview为true，表明当前流程是需要发起前审核的合同，可能无法进行查看，签署操作，需要等审核完成后，才可以继续后续流程当NeedCreateReview为false，不需要发起前审核的合同示例值：false

FlowFileInfo

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

被如下接口引用：ChannelCreateFlowGroupByFiles。

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

FlowGroupOptions

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

被如下接口引用：ChannelCreateFlowGroupByFiles。

名称	类型	必选	描述
SelfOrganizationApproverSignEach	Boolean	否	发起方企业经办人（即签署人为发起方企业员工）是否需要对子合同进行独立的意愿确认 false（默认）：发起方企业经办人签署时对所有子合同进行统一的意愿确认。 true：发起方企业经办人签署时需要对子合同进行独立的意愿确认。示例值：fasle
OtherApproverSignEach	Boolean	否	非发起方企业经办人（即：签署人为个人或者不为发起方企业的员工）是否需要对子合同进行独立的意愿确认 false（默认）：非发起方企业经办人签署时对所有子合同进行统一的意愿确认。 true：非发起方企业经办人签署时需要对子合同进行独立的意愿确认。示例值：fasle

FlowInfo

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

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

名称	类型	必选	描述
FlowName	String	是	合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。示例值：张三的入职合同
Deadline	Integer	是	合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。示例值：1604912664 示例值：1698827057
TemplateId	String	否	用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。如果使用模板发起接口，此参数为必填。可以通过生成子客登录链接登录企业控制台, 在企业模板中得到合同模板ID。示例值：yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc
FlowApprovers	Array of FlowApproverInfo	否	多个签署人信息，最大支持50个签署方示例值：签署人信息
FormFields	Array of FormField	否	表单K-V对列表示例值：表单K-V对列表
CallbackUrl	String	否	合同状态变动结的通知回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性，最大长度1000个字符。腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。回调的相关说明可参考开发者中心的回调通知模块示例值：https://capi.qq.com/callback
FlowType	String	否	合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。示例值：入职合同
FlowDescription	String	否	合同流程描述信息(可自定义此描述)，最大长度1000个字符。示例值：张三2023年的入职公司财务部的合同
CustomerData	String	否	调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。示例值：QmFzZTY05YaF5a65
CustomShowMap	String	否	您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量： {合同名称} {发起方企业} {发起方姓名} {签署方N企业} {签署方N姓名} 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子合同名称：租房合同发起方：腾讯公司(张三) 签署方：李四示例值：合同名称:{合同名称} {发起方企业} {发起方姓名};国家:中国;发起方:{发起方企业};签署方1: {签署方1企业};签署
CcInfos	Array of CcInfo	否	合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。示例值：
NeedSignReview	Boolean	否	发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： false：（默认）不需要审批，直接签署。 true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同` 示例值：true
CcNotifyType	Integer	否	若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型： 0 :合同发起时通知通知对方来查看合同（默认） 1 : 签署完成后通知对方来查看合同示例值：0
AutoSignScene	String	否	个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： E_PRESCRIPTION_AUTO_SIGN：处方单（医疗自动签）注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。` 示例值：E_PRESCRIPTION_AUTO_SIGN

FlowResourceUrlInfo

流程对应资源链接信息

被如下接口引用：DescribeResourceUrlsByFlows。

名称	类型	描述
FlowId	String	合同流程的ID 注意：此字段可能返回 null，表示取不到有效值。示例值：xxx
ResourceUrlInfos	Array 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"}
            }
        ]
    }
}

表格参数说明

名称	类型	描述
headers	Array	表头：不超过10列，不支持单元格合并，字数不超过100
rowCount	Integer	表格内容最大行数
cells.N.rowStart	Integer	单元格坐标：行起始index
cells.N.rowEnd	Integer	单元格坐标：行结束index
cells.N.columnStart	Integer	单元格坐标：列起始index
cells.N.columnEnd	Integer	单元格坐标：列结束index
cells.N.content	String	单元格内容，字数不超过100
cells.N.style	String	单元格字体风格配置，风格配置的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"; bold ：是否加粗， true ：加粗 false：不加粗; align: 对其方式，支持 LEFT / RIGHT / CENTER

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

名称	类型	必选	描述
ComponentValue	String	是	控件填充值，ComponentType和传入值格式对应关系如下： TEXT - 普通文本控件，需输入文本字符串； MULTI_LINE_TEXT - 多行文本控件，需输入文本字符串； CHECK_BOX - 勾选框控件，若选中需填写ComponentValue，填写 true或者 false 字符串； FILL_IMAGE - 图片控件，需填写ComponentValue为图片的资源 ID； DYNAMIC_TABLE - 动态表格控件； ATTACHMENT - 附件控件，需填写ComponentValue为附件图片的资源 ID列表，以逗号分割； DATE - 日期控件；格式为 xxxx年xx月xx日字符串； DISTRICT - 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容；示例值：Name
ComponentId	String	否	表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。注意：此字段可能返回 null，表示取不到有效值。示例值：391963b9d3cb2de35dedc6eb0a60e535
ComponentName	String	否	控件的名字，跟ComponentId二选一，不能全为空注意：此字段可能返回 null，表示取不到有效值。示例值：住房地址
LockComponentValue	Boolean	否	是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定注意：此字段可能返回 null，表示取不到有效值。示例值：false

OccupiedSeal

持有的电子印章信息

被如下接口引用：ChannelDescribeOrganizationSeals。

名称	类型	描述
SealId	String	电子印章编号
SealName	String	电子印章名称
CreateOn	Integer	电子印章授权时间戳，单位秒
Creator	String	电子印章授权人，电子签的UserId
SealPolicyId	String	电子印章策略Id
SealStatus	String	印章状态，有以下六种：CHECKING（审核中）SUCCESS（已启用）FAIL（审核拒绝）CHECKING-SADM（待超管审核）DISABLE（已停用）STOPPED（已终止）
FailReason	String	审核失败原因注意：此字段可能返回 null，表示取不到有效值。
Url	String	印章图片url，5分钟内有效
SealType	String	印章类型，OFFICIAL-企业公章，CONTRACT-合同专用章，LEGAL_PERSON_SEAL-法人章
IsAllTime	Boolean	用印申请是否为永久授权
AuthorizedUsers	Array of AuthorizedUser	授权人列表

PdfVerifyResult

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

被如下接口引用：ChannelVerifyPdf。

名称	类型	描述
VerifyResult	Integer	验签结果详情，每个签名域对应的验签结果。状态值如下 1 :验签成功，在电子签签署 2 :验签成功，在其他平台签署 3 :验签失败 4 :pdf文件没有签名域 5 :文件签名格式错误示例值：1
SignPlatform	String	签署平台如果文件是在腾讯电子签平台签署，则为腾讯电子签，如果文件不在腾讯电子签平台签署，则为其他平台。示例值：腾讯电子签
SignerName	String	申请证书的主体的名字如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下企业: ESS@企业名称@平台生成的数字编码个人: ESS@个人姓名@证件号@平台生成的数字编码如果在其他平台签署的, 主体的名字参考其他平台的说明示例值：ESS@张三@37000019890303000X@808854
SignTime	Integer	签署时间的Unix时间戳，单位毫秒示例值：1699252071000
SignAlgorithm	String	证书签名算法, 如SHA1withRSA等算法示例值：SHA1withRSA
CertSn	String	CA供应商下发给用户的证书编号注意：`腾讯电子签接入多家CA供应商以提供容灾能力，不同CA下发的证书编号区别较大，但基本都是由数字和字母组成，长度在200以下`。示例值：6c8e2911fadf70ea
CertNotBefore	Integer	证书起始时间的Unix时间戳，单位毫秒示例值：1681301253000
CertNotAfter	Integer	证书过期时间的时间戳，单位毫秒示例值：1712837253000
SignType	Integer	签名类型, 保留字段, 现在全部为0 示例值：0
ComponentPosX	Float	签名域横坐标，单位px 示例值：177.05
ComponentPosY	Float	签名域纵坐标，单位px 示例值：90.25
ComponentWidth	Float	签名域宽度，单位px 示例值：119
ComponentHeight	Float	签名域高度，单位px 示例值：13.7
ComponentPage	Integer	签名域所在页码，1～N 示例值：1

Permission

权限树节点权限

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

名称	类型	必选	描述
Name	String	否	权限名称注意：此字段可能返回 null，表示取不到有效值。
Key	String	否	权限key 注意：此字段可能返回 null，表示取不到有效值。
Type	Integer	否	权限类型 1前端，2后端注意：此字段可能返回 null，表示取不到有效值。
Hide	Integer	否	是否隐藏注意：此字段可能返回 null，表示取不到有效值。
DataLabel	Integer	否	数据权限标签 1:表示根节点，2:表示叶子结点注意：此字段可能返回 null，表示取不到有效值。
DataType	Integer	否	数据权限独有，1:关联其他模块鉴权，2:表示关联自己模块鉴权注意：此字段可能返回 null，表示取不到有效值。
DataRange	Integer	否	数据权限独有，表示数据范围，1：全公司，2:部门及下级部门，3:自己注意：此字段可能返回 null，表示取不到有效值。
DataTo	String	否	关联权限, 表示这个功能权限要受哪个数据权限管控注意：此字段可能返回 null，表示取不到有效值。
ParentKey	String	否	父级权限key 注意：此字段可能返回 null，表示取不到有效值。
IsChecked	Boolean	否	是否选中注意：此字段可能返回 null，表示取不到有效值。
Children	Array of Permission	否	子权限集合注意：此字段可能返回 null，表示取不到有效值。

PermissionGroup

权限树中的权限组

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

名称	类型	必选	描述
GroupName	String	否	权限组名称注意：此字段可能返回 null，表示取不到有效值。
GroupKey	String	否	权限组key 注意：此字段可能返回 null，表示取不到有效值。
Hide	Integer	否	是否隐藏分组，0否1是注意：此字段可能返回 null，表示取不到有效值。
Permissions	Array of Permission	否	权限集合注意：此字段可能返回 null，表示取不到有效值。

ProxyOrganizationOperator

同步的员工的信息

被如下接口引用：SyncProxyOrganizationOperators。

名称

类型

必选

描述

String

是

员工的唯一标识(即OpenId), 定义Agent中的OpenId一样, 可以参考Agent结构体
示例值：n9527

Name

String

否

员工的姓名，最大长度50个字符
员工的姓名将用于身份认证和电子签名，请确保填写的姓名为真实姓名，而非昵称等代名。
示例值：张三

IdCardType

String

否

签署方经办人的证件类型，支持以下类型

ID_CARD : 居民身份证 (默认值)
HONGKONG_AND_MACAO : 港澳居民来往内地通行证
HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)

示例值：ID_CARD

IdCardNumber

String

否

经办人证件号

Mobile

String

否

员工的手机号，支持国内手机号11位数字(无需加+86前缀或其他字符)，不支持海外手机号。
示例值：1850000000

DefaultRole

String

否

预先分配员工的角色, 可以分配的角色如下:

可以分配的角色	角色名称	角色描述
admin	业务管理员（IT 系统负责人，e.g. CTO）	有企业合同模块、印章模块、模板模块等全量功能及数据权限。
channel-normal-operator	经办人（企业法务负责人）	有发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看企业所有合同数据。
channel-sales-man	业务员（一般为销售员、采购员）	有发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看自己相关所有合同数据。

示例值：channel-normal-operator

Recipient

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

被如下接口引用：DescribeTemplates。

名称	类型	必选	描述
RecipientId	String	否	合同参与方的角色ID 示例值：ed68bc6904fbd4795b4658c480214e4e
RecipientType	String	否	参与者类型, 可以选择的类型如下: ENTERPRISE :此角色为企业参与方 INDIVIDUAL :此角色为个人参与方 PROMOTER :此角色是发起方示例值：ENTERPRISE
Description	String	否	合同参与方的角色描述，长度不能超过100，只能由中文、字母、数字和下划线组成。
RoleName	String	否	合同参与方的角色名字，长度不能超过20，只能由中文、字母、数字和下划线组成。示例值：卖方
RequireValidation	Boolean	否	是否需要校验， true-是， false-否示例值：true
RequireSign	Boolean	否	是否必须填写， true-是， false-否示例值：true
SignType	Integer	否	内部字段，签署类型示例值：0
RoutingOrder	Integer	否	签署顺序：数字越小优先级越高示例值：0
IsPromoter	Boolean	否	是否是发起方， true-是 false-否示例值：true
ApproverVerifyTypes	Array of Integer	否	签署人查看合同校验方式, 支持的类型如下: 1 :实名认证查看 2 :手机号校验查看示例值：[1,2]
ApproverSignTypes	Array of Integer	否	签署人进行合同签署时的认证方式，支持的类型如下: 1 :人脸认证 2 :签署密码 3 :运营商三要素认证 4 :UKey认证示例值：[1,2,3]

RecipientComponentInfo

参与方填写控件信息

被如下接口引用：ChannelDescribeFlowComponents。

名称	类型	描述
RecipientId	String	参与方的角色ID 示例值：yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR
RecipientFillStatus	String	参与方填写状态 0 : 还没有填写 1 : 已经填写示例值：1
IsPromoter	Boolean	此角色是否是发起方角色 true : 是发起方角色 false : 不是发起方角色注意：此字段可能返回 null，表示取不到有效值。示例值：true
Components	Array of FilledComponent	此角色的填写控件列表注意：此字段可能返回 null，表示取不到有效值。

ReleasedApprover

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

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

如果需要指定B端(企业身份类型)签署人，其中ReleasedApprover需要传递的参数如下： ApproverNumber, OrganizationName, ApproverType必传。
对于其他身份标识：

子客企业指定经办人：OpenId必传，OrganizationOpenId必传；
非子客企业经办人：Name、Mobile必传。

被如下接口引用：ChannelCreateReleaseFlow。

名称	类型	必选	描述
ApproverNumber	Integer	是	签署人在原合同签署人列表中的顺序序号(从0开始，按顺序依次递增)。可以通过DescribeFlowDetailInfo接口查看原流程中的签署人列表。示例值：0
ApproverType	String	是	指定签署人类型，目前支持 ORGANIZATION：企业(默认值) ENTERPRISESERVER：企业静默签示例值：ORGANIZATION
Name	String	否	签署人姓名，最大长度50个字。示例值：典子谦
IdCardType	String	否	签署方经办人的证件类型，支持以下类型 ID_CARD : 居民身份证(默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证) 示例值：ID_CARD
IdCardNumber	String	否	证件号码，应符合以下规则居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母(但“I”、“O”除外)，后7位为阿拉伯数字。港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。示例值：620000198802020000
Mobile	String	否	签署人手机号。示例值：13200000000
OrganizationName	String	否	组织机构名称。请确认该名称与企业营业执照中注册的名称一致。如果名称中包含英文括号()，请使用中文括号（）代替。如果签署方是企业签署方(approverType = 0 或者 approverType = 3)，则企业名称必填。示例值：典子谦示例企业
OrganizationOpenId	String	否	第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体。当为子客企业指定经办人时，此OrganizationOpenId必传。示例值：org_dianziqian
OpenId	String	否	第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成。当签署方为同一第三方平台下的员工时，此OpenId必传。示例值：n9527
ApproverSignComponentType	String	否	签署控件类型，支持自定义企业签署方的签署控件类型 SIGN_SEAL：默认为印章控件类型(默认值) SIGN_SIGNATURE：手写签名控件类型
ApproverSignRole	String	否	参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`，以此类推。如果需改动此参与人的角色名字，可用此字段指定，由汉字,英文字符,数字组成，最大20个字。示例值：供应商

RelieveInfo

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

被如下接口引用：ChannelCreateReleaseFlow。

名称	类型	必选	描述
Reason	String	是	解除理由，最大支持200个字示例值：xxx
RemainInForceItem	String	否	解除后仍然有效的条款，保留条款，最大支持200个字示例值：xxx
OriginalExpenseSettlement	String	否	原合同事项处理-费用结算，最大支持200个字示例值：xxx
OriginalOtherSettlement	String	否	原合同事项处理-其他事项，最大支持200个字示例值：xxx
OtherDeals	String	否	其他约定，最大支持200个字示例值：xxx

RemindFlowRecords

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

被如下接口引用：ChannelCreateFlowReminds。

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

ResourceUrlInfo

资源链接信息

被如下接口引用：DescribeResourceUrlsByFlows。

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

SignQrCode

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

被如下接口引用：ChannelCreateMultiFlowSignQRCode。

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

SignUrl

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

被如下接口引用：ChannelCreateMultiFlowSignQRCode。

名称	类型	描述
AppSignUrl	String	跳转至电子签名小程序签署的链接地址。适用于客户端APP及小程序直接唤起电子签名小程序。示例值：pages/guide?from=default&where=mini&autoJumpBack=true&to=CHANNEL_CONTRACT_COVER&xxx
EffectiveTime	String	签署链接有效时间，格式类似"2022-08-05 15:55:01" 示例值：2022-08-05 15:55:01
HttpSignUrl	String	跳转至电子签名小程序签署的链接地址，格式类似于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。

名称	类型	描述
SignUrl	String	签署链接，过期时间为90天注意：此字段可能返回 null，表示取不到有效值。示例值：https://essurl.cn/hJi85U8ewE
Deadline	Integer	合同过期时间戳，单位秒注意：此字段可能返回 null，表示取不到有效值。示例值：1706254213
SignOrder	Integer	当流程为顺序签署此参数有效时，数字越小优先级越高，暂不支持并行签署可选注意：此字段可能返回 null，表示取不到有效值。示例值：1
SignId	String	签署人编号注意：此字段可能返回 null，表示取不到有效值。示例值：yDwiBUUckpo27hodUuLiduRyFBtECOgN
Name	String	用户姓名注意：此字段可能返回 null，表示取不到有效值。示例值：张三
Mobile	String	用户手机号码注意：此字段可能返回 null，表示取不到有效值。示例值：18888888888
OrganizationName	String	签署参与者机构名字注意：此字段可能返回 null，表示取不到有效值。示例值：张三示例企业
ApproverType	String	参与者类型, 类型如下: ORGANIZATION:企业经办人 PERSON: 自然人注意：此字段可能返回 null，表示取不到有效值。示例值：ORGANIZATION
IdCardNumber	String	经办人身份证号注意：此字段可能返回 null，表示取不到有效值。
FlowId	String	签署链接对应流程Id 注意：此字段可能返回 null，表示取不到有效值。示例值：yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
OpenId	String	企业经办人用户在渠道的编号注意：此字段可能返回 null，表示取不到有效值。示例值：n9527
FlowGroupId	String	合同组签署链接对应的合同组id 注意：此字段可能返回 null，表示取不到有效值。示例值：yDRS4UUgygqdcj5pUuO4zjEu602GFIe6
SignQrcodeUrl	String	二维码，在生成动态签署人跳转封面页链接时返回注意：此字段可能返回 null，表示取不到有效值。示例值：https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d**2f0db15e6b

Staff

企业员工信息

被如下接口引用：ChannelDescribeEmployees。

名称	类型	描述
UserId	String	员工在电子签平台的用户ID
DisplayName	String	显示的员工名
Mobile	String	员工手机号
Email	String	员工邮箱注意：此字段可能返回 null，表示取不到有效值。
OpenId	String	员工在第三方应用平台的用户ID 注意：此字段可能返回 null，表示取不到有效值。
Roles	Array of StaffRole	员工角色注意：此字段可能返回 null，表示取不到有效值。
Department	Department	员工部门注意：此字段可能返回 null，表示取不到有效值。
Verified	Boolean	员工是否实名
CreatedOn	Integer	员工创建时间戳，单位秒
VerifiedOn	Integer	员工实名时间戳，单位秒
QuiteJob	Integer	员工是否离职：0-未离职，1-离职

StaffRole

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

被如下接口引用：ChannelDescribeEmployees。

名称	类型	描述
RoleId	String	角色id 注意：此字段可能返回 null，表示取不到有效值。
RoleName	String	角色名称注意：此字段可能返回 null，表示取不到有效值。

SyncFailReason

同步员工失败原因

被如下接口引用：SyncProxyOrganizationOperators。

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

TaskInfo

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

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

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

TemplateInfo

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

模板组成
一个模板通常会包含以下结构信息
模板基本信息
签署参与方 Recipients，在模板发起合同时用于指定参与方
填写控件 Components
签署控件 SignComponents

被如下接口引用：DescribeTemplates。

名称	类型	描述
TemplateId	String	模板ID，模板的唯一标识
TemplateName	String	模板名
Description	String	模板描述信息
Components	Array of Component	模板的填充控件列表
Recipients	Array of Recipient	模板中的签署参与方列表
SignComponents	Array of Component	模板中的签署控件列表
TemplateType	Integer	模板类型：1-静默签；3-普通模板示例值：3
Creator	String	模板的创建者信息，电子签系统用户ID
CreatedOn	Integer	模板创建的时间戳，格式为Unix标准时间戳（秒）
PreviewUrl	String	模板的H5预览链接,有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。（此功能开放需要联系客户经理）注意：此字段可能返回 null，表示取不到有效值。
PdfUrl	String	第三方应用集成-模板PDF文件链接，有效期5分钟。请求参数WithPdfUrl=true时返回（此功能开放需要联系客户经理）。注意：此字段可能返回 null，表示取不到有效值。
ChannelTemplateId	String	本模板关联的第三方应用平台企业模板ID
ChannelTemplateName	String	本模板关联的三方应用平台平台企业模板名称注意：此字段可能返回 null，表示取不到有效值。
ChannelAutoSave	Integer	0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板注意：此字段可能返回 null，表示取不到有效值。
TemplateVersion	String	模板版本，全数字字符。默认为空，初始版本为yyyyMMdd001。注意：此字段可能返回 null，表示取不到有效值。
Available	Integer	模板可用状态： 1启用（默认） 2停用注意：此字段可能返回 null，表示取不到有效值。

UploadFile

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

被如下接口引用：UploadFiles。

名称	类型	必选	描述
FileBody	String	是	Base64编码后的文件内容
FileName	String	否	文件名

UsageDetail

用量明细

被如下接口引用：DescribeUsage。

名称	类型	描述
ProxyOrganizationOpenId	String	子客企业标识
ProxyOrganizationName	String	子客企业名注意：此字段可能返回 null，表示取不到有效值。
Date	Date	对应的消耗日期, 如果是汇总数据则为1970-01-01 注意：此字段可能返回 null，表示取不到有效值。示例值：2021-08-31
Usage	Integer	消耗合同数量示例值：50
Cancel	Integer	撤回合同数量注意：此字段可能返回 null，表示取不到有效值。示例值：1
FlowChannel	String	消耗渠道注意：此字段可能返回 null，表示取不到有效值。示例值：企业版

UserInfo

接口调用的员工信息

名称	类型	必选	描述
OpenId	String	否	第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。注意: 1. OpenId在子客企业对应一个真实员工，本应用唯一, 不可重复使用，最大64位字符串 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId 3. 员工加入企业后, 可以通过生成子客登录链接登录子客控制台后, 在组织架构模块查看员工们的OpenId, 样式如下图

UserThreeFactor

用户的三要素：姓名，证件号，证件类型

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

名称	类型	必选	描述
Name	String	是	签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。示例值：小明
IdCardType	String	是	证件类型，支持以下类型 ID_CARD : 居民身份证 (默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证) 示例值：ID_CARD
IdCardNumber	String	是	证件号码，应符合以下规则居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。示例值：610*1X

WebThemeConfig

主题配置

被如下接口引用：ChannelCreateWebThemeConfig。

名称	类型	必选	描述
DisplaySignBrandLogo	Boolean	否	是否显示页面底部电子签logo，取值如下： true：页面底部显示电子签logo false：页面底部不显示电子签logo（默认）示例值：true
WebEmbedThemeColor	String	否	主题颜色：支持十六进制颜色值以及RGB格式颜色值，例如：#D54941，rgb(213, 73, 65) 示例值：#D54941

Agent​

ApproverComponentLimitType​

ApproverItem​

ApproverOption​

ApproverRestriction​

AuthFailMessage​

AuthorizedUser​

AutoSignConfig​

BaseFlowInfo​

BillUsageDetail​

CcInfo​

ChannelBillUsageDetail​

ChannelRole​

CommonApproverOption​

CommonFlowApprover​

Component​

ComponentLimit​

CreateFlowOption​

Department​

DownloadFlowInfo​

ExtentServiceAuthInfo​

FailedCreateRoleData​

FillApproverInfo​

FillError​

FilledComponent​

Filter​

FlowApproverDetail​

FlowApproverInfo​

FlowApproverItem​

FlowApproverUrlInfo​

FlowDetailInfo​

FlowFileInfo​

FlowGroupOptions​

FlowInfo​

FlowResourceUrlInfo​

FormField​

OccupiedSeal​

PdfVerifyResult​

Permission​

PermissionGroup​

ProxyOrganizationOperator​

Recipient​

RecipientComponentInfo​

ReleasedApprover​

RelieveInfo​

RemindFlowRecords​

ResourceUrlInfo​

SignQrCode​

SignUrl​

SignUrlInfo​

Staff​

StaffRole​

SyncFailReason​

TaskInfo​

TemplateInfo​

UploadFile​

UsageDetail​

UserInfo​

UserThreeFactor​

WebThemeConfig​

Agent

ApproverComponentLimitType

ApproverItem

ApproverOption

ApproverRestriction

AuthFailMessage

AuthorizedUser

AutoSignConfig

BaseFlowInfo

BillUsageDetail

CcInfo

ChannelBillUsageDetail

ChannelRole

CommonApproverOption

CommonFlowApprover

Component

ComponentLimit

CreateFlowOption

Department

DownloadFlowInfo

ExtentServiceAuthInfo

FailedCreateRoleData

FillApproverInfo

FillError

FilledComponent

Filter

FlowApproverDetail

FlowApproverInfo

FlowApproverItem

FlowApproverUrlInfo

FlowDetailInfo

FlowFileInfo

FlowGroupOptions

FlowInfo

FlowResourceUrlInfo

FormField

OccupiedSeal

PdfVerifyResult

Permission

PermissionGroup

ProxyOrganizationOperator

Recipient

RecipientComponentInfo

ReleasedApprover

RelieveInfo

RemindFlowRecords

ResourceUrlInfo

SignQrCode

SignUrl

SignUrlInfo

Staff

StaffRole

SyncFailReason

TaskInfo

TemplateInfo

UploadFile

UsageDetail

UserInfo

UserThreeFactor

WebThemeConfig