数据结构

Admin

企业超管信息

被如下接口引用：DescribeOrganizationGroupOrganizations。

名称	类型	描述
Name	String	超管名 注意：此字段可能返回 null，表示取不到有效值。
Mobile	String	超管手机号 注意：此字段可能返回 null，表示取不到有效值。

Agent

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

被如下接口引用：CancelFlow, CancelMultiFlowSignQRCode, CreateConvertTaskApi, CreateDocument, CreateFlow, CreateFlowByFiles, CreateFlowSignReview, CreateFlowSignUrl, CreateIntegrationEmployees, CreateIntegrationUserRoles, CreateMultiFlowSignQRCode, CreateSchemeUrl, CreateSealPolicy, DeleteIntegrationEmployees, DeleteIntegrationRoleUsers, DeleteSealPolicies, DescribeFileUrls, DescribeFlowBriefs, DescribeFlowInfo, DescribeFlowTemplates, DescribeIntegrationEmployees, DescribeIntegrationRoles, DescribeOrganizationSeals, GetTaskResultApi, StartFlow, UpdateIntegrationEmployees。

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

ApproverInfo

参与者信息

被如下接口引用：CreateFlowByFiles。

名称	类型	必选	描述
ApproverType	Integer	是	参与者类型： 0：企业 1：个人 3：企业静默签署 注：类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。
ApproverName	String	是	签署人的姓名
ApproverMobile	String	是	签署人的手机号，11位数字
SignComponents	Array of Component	是	签署人的签署控件列表
OrganizationName	String	否	如果签署方是企业签署方，则为企业名
ApproverIdCardNumber	String	否	签署人的身份证号
ApproverIdCardType	String	否	签署人的身份证件类型 ID_CARD 身份证 HONGKONG_AND_MACAO 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
NotifyType	String	否	签署通知类型：sms--短信，none--不通知
ApproverRole	Integer	否	签署人角色类型：1--收款人、2--开具人、3--见证人
VerifyChannel	Array of String	否	签署意愿确认渠道，默认为WEIXINAPP:人脸识别
PreReadTime	Integer	否	合同的强制预览时间：3~300s，未指定则按合同页数计算
UserId	String	否	签署人userId，传此字段则不用传姓名、手机号
ApproverSource	String	否	签署人用户来源，企微侧用户请传入：WEWORKAPP
CustomApproverTag	String	否	客户自定义签署人标识，64位长度，保证唯一，非企微场景不使用此字段
ApproverOption	ApproverOption	否	签署人个性化能力值
ApproverVerifyTypes	Array of Integer	否	签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1
ApproverSignTypes	Array of Integer	否	签署人签署合同时的认证方式 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2) 合同签署认证方式的优先级 verifyChannel>approverSignTypes

ApproverOption

签署人个性化能力信息

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

名称	类型	必选	描述
NoRefuse	Boolean	否	是否可以拒签 false-可以拒签,默认 true-不可以拒签
NoTransfer	Boolean	否	是否可以转发 false-可以转发,默认 true-不可以转发

ApproverRestriction

指定签署人限制项

被如下接口引用：CreateMultiFlowSignQRCode。

名称	类型	必选	描述
Name	String	否	指定签署人名字
Mobile	String	否	指定签署人手机号，11位数字
IdCardType	String	否	指定签署人证件类型，ID_CARD-身份证
IdCardNumber	String	否	指定签署人证件号码，字母大写

AuthorizedUser

授权用户

被如下接口引用：DescribeOrganizationSeals。

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

AutoSignConfig

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

被如下接口引用：CreateUserAutoSignEnableUrl。

名称	类型	必选	描述
UserInfo	UserThreeFactor	是	自动签开通个人用户的三要素
CallbackUrl	String	是	接受自动签开启的回调地址。需要保证post返回200
CertInfoCallback	Boolean	否	是否回调证书信息，默认false-不需要
UserDefineSeal	Boolean	否	是否支持用户自定义签名印章，默认false-不需要
SealImgCallback	Boolean	否	是否需要回调的时候返回印章(签名) 图片的 base64，默认false-不需要
VerifyChannels	Array of String	否	开通时候的验证方式，取值：WEIXINAPP（微信人脸识别），INSIGHT（慧眼人脸认别），TELECOM（运营商三要素验证）。如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接，支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。

CallbackInfo

应用回调信息

被如下接口引用：ModifyApplicationCallbackInfo。

名称	类型	必选	描述
CallbackUrl	String	是	回调url
CallbackKey	String	否	回调加密key
CallbackToken	String	否	回调验签token

Caller

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

被如下接口引用：UploadFiles。

名称	类型	必选	描述
OperatorId	String	否	经办人的用户ID，同UserId

CcInfo

抄送信息

被如下接口引用：CreateFlow, CreateFlowByFiles。

名称	类型	必选	描述
Mobile	String	否	被抄送人手机号，11位数字
Name	String	否	被抄送人姓名
CcType	Integer	否	被抄送人类型, 0--个人 1--员工
CcPermission	Integer	否	被抄送人权限 0--可查看 1--可查看也可下载

Component

模板控件信息

被如下接口引用：CreateFlowByFiles, DescribeFlowTemplates。

名称	类型	必选	描述
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 - 企业法定代表人控件。 表单域的控件不能作为印章和签名控件
FileIndex	Integer	是	控件所属文件的序号（取值为：0-N）。目前单文件的情况下，值是0
ComponentHeight	Float	是	参数控件高度，单位pt
ComponentWidth	Float	是	参数控件宽度，单位pt
ComponentPage	Integer	是	参数控件所在页码，取值为：1-N
ComponentPosX	Float	是	参数控件X位置，单位pt
ComponentPosY	Float	是	参数控件Y位置，单位pt
ComponentId	String	否	查询时返回控件唯一Id。使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
ComponentName	String	否	查询时返回控件名。使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称
ComponentRequired	Boolean	否	是否必选，默认为false
ComponentRecipientId	String	否	控件关联的签署人ID
ComponentExtra	String	否	扩展参数： 为JSON格式。 ComponentType为FILL_IMAGE时，支持以下参数： NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true: 不居中 FillMethod: int. 填充方式。0-铺满（默认）；1-等比例缩放 ComponentType为SIGN_SIGNATURE类型可以控制签署方式 {“ComponentTypeLimit”: [“xxx”]} xxx可以为： HANDWRITE – 手写签名 BORDERLESS_ESIGN – 自动生成无边框腾讯体 OCR_ESIGN -- AI智能识别手写签名 ESIGN -- 个人印章类型 SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署） 如：{“ComponentTypeLimit”: [“BORDERLESS_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\"}",
IsFormType	Boolean	否	是否是表单域类型，默认不false-不是
ComponentValue	String	否	控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTILINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo DATE - 默认是格式化为xxxx年xx月xx日 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/ 地址控件： 同单行文本控件约束 省市区控件： 同单行文本控件约束 性别控件： 同单行文本控件约束，填写选择值中的字符串 学历控件： 同单行文本控件约束，填写选择值中的字符串
GenerateMode	String	否	NORMAL 正常模式，使用坐标制定签署控件位置 FIELD 表单域，需使用ComponentName指定表单域名称 KEYWORD 关键字，使用ComponentId指定关键字
ComponentDateFontSize	Integer	否	日期签署控件的字号，默认为 12
ChannelComponentId	String	否	第三方应用集成平台模板控件 id 标识
OffsetX	Float	否	指定关键字时横坐标偏移量，单位pt
OffsetY	Float	否	指定关键字时纵坐标偏移量，单位pt
ChannelComponentSource	Integer	否	第三方应用集成中子客企业控件来源。0-平台指定；1-用户自定义
KeywordOrder	String	否	指定关键字排序规则，Positive-正序，Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的最后一个关键字。
KeywordPage	Integer	否	指定关键字页码，可选参数，指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来
RelativeLocation	String	否	关键字位置模式，Middle-居中，Below-正下方，Right-正右方，LowerRight-右上角，UpperRight-右下角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
KeywordIndexes	Array of Integer	否	关键字索引，可选参数，如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。示例：[0,2]，说明使用PDF文件内第1个和第3个关键字位置。

CreateStaffResult

创建员工的结果

被如下接口引用：CreateIntegrationEmployees。

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

DeleteStaffsResult

删除员工结果

被如下接口引用：DeleteIntegrationEmployees。

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

Department

集成版员工部门信息

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

名称	类型	描述
DepartmentId	String	部门id
DepartmentName	String	部门名称

FailedCreateRoleData

绑定角色失败信息

被如下接口引用：CreateIntegrationUserRoles。

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

FailedCreateStaffData

创建员工的失败数据

被如下接口引用：CreateIntegrationEmployees。

名称	类型	描述
DisplayName	String	员工名
Mobile	String	员工手机号
Reason	String	失败原因

FailedDeleteStaffData

删除员工失败数据

被如下接口引用：DeleteIntegrationEmployees。

名称	类型	描述
UserId	String	员工在电子签的userId 注意：此字段可能返回 null，表示取不到有效值。
OpenId	String	员工在第三方平台的openId 注意：此字段可能返回 null，表示取不到有效值。
Reason	String	失败原因

FailedUpdateStaffData

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

被如下接口引用：UpdateIntegrationEmployees。

名称	类型	描述
DisplayName	String	用户传入的名称
Mobile	String	用户传入的手机号
Reason	String	失败原因
UserId	String	用户Id
OpenId	String	员工在第三方平台的openId

FileInfo

模板中文件的信息结构

被如下接口引用：DescribeFlowTemplates。

名称	类型	必选	描述
FileId	String	否	文件Id
FileName	String	否	文件名
FileSize	Integer	否	文件大小，单位为Byte
CreatedOn	Integer	否	文件上传时间，10位时间戳（精确到秒）

FileUrl

下载文件的URL信息

被如下接口引用：DescribeFileUrls。

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

FillApproverInfo

补充签署人信息

被如下接口引用：CreateFlowApprovers。

名称	类型	必选	描述
RecipientId	String	是	对应模板中的参与方ID
ApproverSource	String	是	签署人来源 WEWORKAPP: 企业微信
CustomUserId	String	是	企业自定义账号ID WEWORKAPP场景下指企业自有应用获取企微明文的userid

Filter

查询过滤条件

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

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

FlowApproverDetail

签署人详情信息

被如下接口引用：DescribeFlowInfo。

名称	类型	描述
ApproveMessage	String	签署时的相关信息 注意：此字段可能返回 null，表示取不到有效值。
ApproveName	String	签署方姓名
ApproveStatus	Integer	签署方的签署状态 0：还没有发起 1：流程中 没有开始处理 2：待签署 3：已签署 4：已拒绝 5：已过期 6：已撤销 7：还没有预发起 8：待填写 9：因为各种原因而终止 10：填写完成 15：已解除 19：转他人处理
ReceiptId	String	模板配置中的参与方ID,与控件绑定
CustomUserId	String	客户自定义的用户ID 注意：此字段可能返回 null，表示取不到有效值。
Mobile	String	签署人手机号
SignOrder	Integer	签署顺序，如果是有序签署，签署顺序从小到大
ApproveTime	Integer	签署人签署时间，时间戳，单位秒
ApproveType	String	签署方类型，ORGANIZATION-企业员工，PERSON-个人，ENTERPRISESERVER-企业静默签 注意：此字段可能返回 null，表示取不到有效值。
ApproverSource	String	签署方侧用户来源，如WEWORKAPP-企业微信等 注意：此字段可能返回 null，表示取不到有效值。
CustomApproverTag	String	客户自定义签署方标识 注意：此字段可能返回 null，表示取不到有效值。
OrganizationId	String	签署方企业Id 注意：此字段可能返回 null，表示取不到有效值。
OrganizationName	String	签署方企业名称 注意：此字段可能返回 null，表示取不到有效值。

FlowApproverUrlInfo

签署链接信息

被如下接口引用：CreateFlowSignUrl。

名称	类型	描述
SignUrl	String	签署链接。注意该链接有效期为30分钟，同时需要注意保密，不要外泄给无关用户。 注意：此字段可能返回 null，表示取不到有效值。
ApproverType	Integer	签署人类型 1-个人 注意：此字段可能返回 null，表示取不到有效值。
ApproverName	String	签署人姓名 注意：此字段可能返回 null，表示取不到有效值。
ApproverMobile	String	签署人手机号 注意：此字段可能返回 null，表示取不到有效值。
LongUrl	String	签署长链接。注意该链接有效期为30分钟，同时需要注意保密，不要外泄给无关用户。 注意：此字段可能返回 null，表示取不到有效值。

FlowBrief

流程信息摘要

被如下接口引用：DescribeFlowBriefs。

名称	类型	描述
FlowId	String	流程的编号ID
FlowName	String	流程的名称
FlowDescription	String	流程的描述信息 注意：此字段可能返回 null，表示取不到有效值。
FlowType	String	流程的类型
FlowStatus	Integer	流程状态 - 0 还没有发起 - 1 待签署 - 2 部分签署 - 3 已拒签 - 4 已签署 - 5 已过期 - 6 已撤销 - 7 还没有预发起 - 8 等待填写 - 9 部分填写 - 10 拒填 - 21 已解除 注意：此字段可能返回 null，表示取不到有效值。
CreatedOn	Integer	流程创建的时间戳，单位秒 注意：此字段可能返回 null，表示取不到有效值。
FlowMessage	String	拒签或者取消的原因描述 注意：此字段可能返回 null，表示取不到有效值。
Creator	String	合同发起人userId 注意：此字段可能返回 null，表示取不到有效值。
Deadline	Integer	合同过期时间，时间戳，单位秒 注意：此字段可能返回 null，表示取不到有效值。

FlowCreateApprover

创建流程的签署方信息

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

名称	类型	必选	描述
ApproverType	Integer	是	参与者类型： 0：企业 1：个人 3：企业静默签署 注：类型为3（企业静默签署）时，会默认完成该签署方的签署。静默签署仅进行盖章操作，不能是手写签名。
OrganizationName	String	否	如果签署方为企业，需要填入企业全称
ApproverName	String	否	签署方经办人姓名
ApproverMobile	String	否	签署方经办人手机号码
ApproverIdCardType	String	否	签署方经办人证件类型ID_CARD 身份证 HONGKONG_AND_MACAO 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
ApproverIdCardNumber	String	否	签署方经办人证件号码
RecipientId	String	否	签署方经办人在模板中的参与方ID
VerifyChannel	Array of String	否	签署意愿确认渠道,WEIXINAPP:人脸识别
NotifyType	String	否	是否发送短信，sms--短信通知，none--不通知，默认为sms；发起方=签署方时不发送短信
IsFullText	Boolean	否	合同强制需要阅读全文，无需传此参数
PreReadTime	Integer	否	合同的强制预览时间：3~300s，未指定则按合同页数计算
UserId	String	否	签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个。
Required	Boolean	否	当前只支持true，默认为true
ApproverSource	String	否	签署人用户来源,企微侧用户请传入：WEWORKAPP
CustomApproverTag	String	否	客户自定义签署人标识，64位长度，保证唯一。非企微场景不使用此字段
RegisterInfo	RegisterInfo	否	快速注册相关信息，目前暂未开放！
ApproverOption	ApproverOption	否	签署人个性化能力值

FlowDetailInfo

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

被如下接口引用：DescribeFlowInfo。

名称	类型	描述
FlowId	String	合同(流程)的ID
FlowName	String	合同(流程)的名字
FlowType	String	合同(流程)的类型 注意：此字段可能返回 null，表示取不到有效值。
FlowStatus	Integer	流程状态 - 0 还没有发起 - 1 待签署 - 2 部分签署 - 3 已拒签 - 4 已签署 - 5 已过期 - 6 已撤销 - 7 还没有预发起 - 8 等待填写 - 9 部分填写 - 10 拒填 - 21 已解除
FlowMessage	String	合同(流程)的信息 注意：此字段可能返回 null，表示取不到有效值。
FlowDescription	String	流程的描述 注意：此字段可能返回 null，表示取不到有效值。
CreatedOn	Integer	合同(流程)的创建时间戳，单位秒
FlowApproverInfos	Array of FlowApproverDetail	合同(流程)的签署方数组
CcInfos	Array of FlowApproverDetail	合同(流程)的关注方信息列表
Creator	String	合同发起人UserId 注意：此字段可能返回 null，表示取不到有效值。

FormField

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

【数据表格传参说明】 当模板的 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"
            }
        ]
    }
}

表格参数说明

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

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

被如下接口引用：CreateDocument。

名称	类型	必选	描述
ComponentValue	String	是	控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
ComponentId	String	否	控件id，和ComponentName选择一项传入即可
ComponentName	String	否	控件名字，最大长度不超过30字符，和ComponentId选择一项传入即可

GroupOrganization

成员企业信息

被如下接口引用：DescribeOrganizationGroupOrganizations。

名称	类型	描述
Name	String	成员企业名 注意：此字段可能返回 null，表示取不到有效值。
Alias	String	成员企业别名 注意：此字段可能返回 null，表示取不到有效值。
OrganizationId	String	成员企业id 注意：此字段可能返回 null，表示取不到有效值。
UpdateTime	Integer	更新时间，时间戳，单位秒 注意：此字段可能返回 null，表示取不到有效值。
Status	Integer	成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入 注意：此字段可能返回 null，表示取不到有效值。
IsMainOrganization	Boolean	是否为集团主企业 注意：此字段可能返回 null，表示取不到有效值。
IdCardNumber	String	企业社会信用代码 注意：此字段可能返回 null，表示取不到有效值。
AdminInfo	Admin	企业超管信息 注意：此字段可能返回 null，表示取不到有效值。
License	String	企业许可证 注意：此字段可能返回 null，表示取不到有效值。
LicenseExpireTime	Integer	企业许可证过期时间，时间戳，单位秒 注意：此字段可能返回 null，表示取不到有效值。
JoinTime	Integer	成员企业加入集团时间，时间戳，单位秒 注意：此字段可能返回 null，表示取不到有效值。
FlowEngineEnable	Boolean	是否使用审批流引擎，true-是，false-否 注意：此字段可能返回 null，表示取不到有效值。

IntegrateRole

企业角色数据信息

被如下接口引用：DescribeIntegrationRoles。

名称	类型	描述
RoleId	String	角色id 注意：此字段可能返回 null，表示取不到有效值。
RoleName	String	角色名 注意：此字段可能返回 null，表示取不到有效值。
RoleStatus	Integer	角色状态，1-启用，2-禁用 注意：此字段可能返回 null，表示取不到有效值。
IsGroupRole	Boolean	是否是集团角色，true-是，false-否 注意：此字段可能返回 null，表示取不到有效值。
SubOrgIdList	Array of String	管辖的子企业列表 注意：此字段可能返回 null，表示取不到有效值。

IntegrationMainOrganizationUser

主企业员工账号信息

被如下接口引用：DescribeIntegrationMainOrganizationUser。

名称	类型	描述
MainOrganizationId	String	主企业id 注意：此字段可能返回 null，表示取不到有效值。
MainUserId	String	主企业员工UserId 注意：此字段可能返回 null，表示取不到有效值。
UserName	String	主企业员工名 注意：此字段可能返回 null，表示取不到有效值。

OccupiedSeal

持有的电子印章信息

被如下接口引用：DescribeOrganizationSeals。

名称	类型	描述
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-合同专用章,ORGANIZATIONSEAL-企业印章(本地上传印章类型),LEGAL_PERSON_SEAL-法人印章
IsAllTime	Boolean	用印申请是否为永久授权，true-是，false-否
AuthorizedUsers	Array of AuthorizedUser	授权人列表 注意：此字段可能返回 null，表示取不到有效值。

OrganizationInfo

机构信息

被如下接口引用：CreateConvertTaskApi, CreateFlowSignUrl, DescribeFlowTemplates, GetTaskResultApi。

名称	类型	必选	描述

PdfVerifyResult

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

被如下接口引用：VerifyPdf。

名称	类型	描述
VerifyResult	Integer	验签结果。0-签名域未签名；1-验签成功； 3-验签失败；4-未找到签名域：文件内没有签名域；5-签名值格式不正确。
SignPlatform	String	签署平台，如果文件是在腾讯电子签平台签署，则返回腾讯电子签，如果文件不在腾讯电子签平台签署，则返回其他平台。
SignerName	String	签署人名称
SignTime	Integer	签署时间戳，单位秒
SignAlgorithm	String	签名算法
CertSn	String	签名证书序列号
CertNotBefore	Integer	证书起始时间戳，单位秒
CertNotAfter	Integer	证书过期时间戳，单位秒
ComponentPosX	Float	签名域横坐标，单位pt
ComponentPosY	Float	签名域纵坐标，单位pt
ComponentWidth	Float	签名域宽度，单位pt
ComponentHeight	Float	签名域高度，单位pt
ComponentPage	Integer	签名域所在页码，1～N

Recipient

签署参与者信息

被如下接口引用：DescribeFlowTemplates。

名称	类型	必选	描述
RecipientId	String	否	签署参与者ID
RecipientType	String	否	参与者类型。默认为空。ENTERPRISE-企业；INDIVIDUAL-个人；PROMOTER-发起方
Description	String	否	描述信息
RoleName	String	否	角色名称
RequireValidation	Boolean	否	是否需要验证，默认为false
RequireSign	Boolean	否	是否需要签署，默认为true
RoutingOrder	Integer	否	添加序列，0～N
RequireDelivery	Boolean	否	是否需要发送，默认为true
Email	String	否	邮箱地址
Mobile	String	否	电话号码
UserId	String	否	关联的用户ID
DeliveryMethod	String	否	发送方式。默认为EMAIL。EMAIL-邮件；MOBILE-手机短信；WECHAT-微信通知
RecipientExtra	String	否	附属信息

RegisterInfo

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

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

名称	类型	必选	描述
LegalName	String	是	法人姓名
Uscc	String	是	社会统一信用代码

ReleasedApprover

解除协议的签署人，如不指定，默认使用待解除流程（即原流程）中的签署人。 注意：不支持更换C端（个人身份类型）签署人，如果原流程中含有C端签署人，默认使用原流程中的该C端签署人。

被如下接口引用：CreateReleaseFlow。

名称	类型	必选	描述
Name	String	是	签署人姓名，最大长度50个字符
Mobile	String	是	签署人手机号
RelievedApproverReceiptId	String	是	要替换的参与人在原合同参与人列表中的签署人编号,通过DescribeFlowInfo 接口获取（即FlowDetailInfos. FlowApproverInfos 结构中的ReceiptId ）

RelieveInfo

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

被如下接口引用：CreateReleaseFlow。

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

RemindFlowRecords

催办接口返回详细信息

被如下接口引用：CreateFlowReminds。

名称	类型	描述
CanRemind	Boolean	是否能够催办，true-是，false-否
FlowId	String	合同id
RemindMessage	String	催办详情信息

SignQrCode

一码多扫签署二维码对象

被如下接口引用：CreateMultiFlowSignQRCode。

名称	类型	描述
QrCodeId	String	二维码id
QrCodeUrl	String	二维码url
ExpiredTime	Integer	二维码过期时间戳，单位秒

SignUrl

一码多扫签署二维码签署信息

被如下接口引用：CreateMultiFlowSignQRCode。

名称	类型	描述
AppSignUrl	String	小程序签署链接
EffectiveTime	String	签署链接有效时间
HttpSignUrl	String	移动端签署链接

Staff

企业员工信息

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

名称	类型	必选	描述
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	否	员工实名时间戳，单位秒 注意：此字段可能返回 null，表示取不到有效值。
QuiteJob	Integer	否	员工是否离职：0-未离职，1-离职 注意：此字段可能返回 null，表示取不到有效值。
ReceiveUserId	String	否	员工离职交接人用户id
ReceiveOpenId	String	否	员工离职交接人用户OpenId

StaffRole

集成版企业角色信息

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

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

SuccessCreateStaffData

创建员工的成功数据

被如下接口引用：CreateIntegrationEmployees。

名称	类型	描述
DisplayName	String	员工名
Mobile	String	员工手机号
UserId	String	员工在电子签平台的id
Note	String	提示，当创建已存在未实名用户时，改字段有值 注意：此字段可能返回 null，表示取不到有效值。

SuccessDeleteStaffData

删除员工的成功数据

被如下接口引用：DeleteIntegrationEmployees。

名称	类型	描述
DisplayName	String	员工名
Mobile	String	员工手机号
UserId	String	员工在电子签平台的id

SuccessUpdateStaffData

更新员工信息成功返回的数据信息

被如下接口引用：UpdateIntegrationEmployees。

名称	类型	描述
DisplayName	String	传入的用户名称
Mobile	String	传入的手机号
UserId	String	用户Id

TemplateInfo

企业模板的信息结构

被如下接口引用：DescribeFlowTemplates。

名称	类型	必选	描述
TemplateId	String	否	模板ID
TemplateName	String	否	模板名字
Description	String	否	模板描述信息
DocumentResourceIds	Array of String	否	模板关联的资源ID列表
FileInfos	Array of FileInfo	否	返回的文件信息结构
AttachmentResourceIds	Array of String	否	附件关联的资源ID
SignOrder	Array of Integer	否	签署顺序
Recipients	Array of Recipient	否	签署参与者的信息
Components	Array of Component	否	模板信息结构
SignComponents	Array of Component	否	签署区模板信息结构
Status	Integer	否	模板状态(-1:不可用；0:草稿态；1:正式态)
Creator	String	否	模板的创建人UserId
CreatedOn	Integer	否	模板创建的时间戳，单位秒
Promoter	Recipient	否	发起人角色信息
TemplateType	Integer	否	模板类型 取值： 1 静默签, 3 普通模板
Available	Integer	否	模板可用状态，取值：1启用（默认），2停用
OrganizationId	String	否	创建模板的机构id
PreviewUrl	String	否	模板预览链接，有效时间5分钟 注意：此字段可能返回 null，表示取不到有效值。
TemplateVersion	String	否	模板版本。默认为空时，全数字字符，初始版本为yyyyMMdd001。 注意：此字段可能返回 null，表示取不到有效值。
Published	Boolean	否	模板是否已发布。true-已发布；false-未发布 注意：此字段可能返回 null，表示取不到有效值。

UploadFile

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

被如下接口引用：UploadFiles。

名称	类型	必选	描述
FileBody	String	是	Base64编码后的文件内容
FileName	String	否	文件名，最大长度不超过200字符

UserInfo

用户信息

被如下接口引用：BindEmployeeUserIdWithClientOpenId, CancelFlow, CancelMultiFlowSignQRCode, CreateBatchCancelFlowUrl, CreateChannelSubOrganizationModifyQrCode, CreateConvertTaskApi, CreateDocument, CreateFlow, CreateFlowApprovers, CreateFlowByFiles, CreateFlowEvidenceReport, CreateFlowReminds, CreateFlowSignReview, CreateFlowSignUrl, CreateIntegrationEmployees, CreateIntegrationUserRoles, CreateMultiFlowSignQRCode, CreatePrepareFlow, CreatePreparedPersonalEsign, CreateReleaseFlow, CreateSchemeUrl, CreateSealPolicy, CreateUserAutoSignEnableUrl, DeleteIntegrationEmployees, DeleteIntegrationRoleUsers, DeleteSealPolicies, DescribeFileUrls, DescribeFlowBriefs, DescribeFlowEvidenceReport, DescribeFlowInfo, DescribeFlowTemplates, DescribeIntegrationEmployees, DescribeIntegrationMainOrganizationUser, DescribeIntegrationRoles, DescribeOrganizationGroupOrganizations, DescribeOrganizationSeals, DescribeUserAutoSignStatus, DisableUserAutoSign, GetTaskResultApi, ModifyApplicationCallbackInfo, StartFlow, UnbindEmployeeUserIdWithClientOpenId, UpdateIntegrationEmployees, VerifyPdf。

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

UserThreeFactor

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

被如下接口引用：CreateUserAutoSignEnableUrl, DescribeUserAutoSignStatus, DisableUserAutoSign。

名称	类型	必选	描述
Name	String	是	姓名
IdCardType	String	是	证件类型: ID_CARD 身份证 HONGKONG_AND_MACAO 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
IdCardNumber	String	是	证件号，如果有 X 请大写