数据结构

Agent

应用相关信息

被如下接口引用：ChannelBatchCancelFlows, ChannelCancelFlow, ChannelCancelMultiFlowSignQRCode, ChannelCancelUserAutoSignEnableUrl, ChannelCreateBatchCancelFlowUrl, ChannelCreateBatchSignUrl, ChannelCreateBoundFlows, ChannelCreateConvertTaskApi, ChannelCreateEmbedWebUrl, ChannelCreateFlowByFiles, ChannelCreateFlowGroupByFiles, ChannelCreateFlowGroupByTemplates, ChannelCreateFlowReminds, ChannelCreateFlowSignReview, ChannelCreateFlowSignUrl, ChannelCreateMultiFlowSignQRCode, ChannelCreateOrganizationModifyQrCode, ChannelCreatePrepareFlow, ChannelCreatePreparedPersonalEsign, ChannelCreateReleaseFlow, ChannelCreateRole, ChannelCreateSealPolicy, ChannelCreateUserAutoSignEnableUrl, ChannelCreateUserRoles, ChannelCreateWebThemeConfig, ChannelDeleteRole, ChannelDeleteRoleUsers, ChannelDeleteSealPolicies, ChannelDescribeEmployees, ChannelDescribeFlowComponents, ChannelDescribeOrganizationSeals, ChannelDescribeRoles, ChannelDescribeUserAutoSignStatus, ChannelDisableUserAutoSign, ChannelGetTaskResultApi, ChannelModifyRole, ChannelUpdateSealStatus, ChannelVerifyPdf, CreateChannelFlowEvidenceReport, CreateConsoleLoginUrl, CreateFlowsByTemplates, CreateSealByImage, CreateSignUrls, DescribeChannelFlowEvidenceReport, 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

签署人个性化能力信息

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

名称	类型	必选	描述
HideOneKeySign	Boolean	否	是否隐藏一键签署 默认false-不隐藏true-隐藏 示例值：true
FillType	Integer	否	签署人信息补充类型，默认无需补充。 1 : ( 动态签署人（可发起合同后再补充签署人信息）

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	第三方应用平台的子客企业OpenId
Message	String	错误信息

AuthorizedUser

授权用户

被如下接口引用：ChannelDescribeOrganizationSeals。

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

AutoSignConfig

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

被如下接口引用：ChannelCreateUserAutoSignEnableUrl。

名称	类型	必选	描述
UserInfo	UserThreeFactor	是	自动签开通个人用户的三要素
CertInfoCallback	Boolean	否	是否回调证书信息
UserDefineSeal	Boolean	否	是否支持用户自定义签名印章
SealImgCallback	Boolean	否	是否需要回调的时候返回印章(签名) 图片的 base64
CallbackUrl	String	否	回调链接，如果渠道已经配置了，可以不传
VerifyChannels	Array of String	否	开通时候的验证方式，取值：WEIXINAPP（微信人脸识别），INSIGHT（慧眼人脸认别），TELECOM（运营商三要素验证）。如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接，支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
LicenseType	Integer	否	设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次

BaseFlowInfo

基础流程信息

被如下接口引用：ChannelCreatePrepareFlow。

名称	类型	必选	描述
FlowName	String	是	合同流程名称
FlowType	String	是	合同流程类型 客户自定义，用于合同分类展示 示例值："劳动合同"
FlowDescription	String	是	合同流程描述信息 示例值："与xxx的劳动合同"
Deadline	Integer	是	合同流程截止时间，unix时间戳，单位秒
Unordered	Boolean	否	是否顺序签署(true:无序签,false:顺序签) 默认false，有序签署合同
IntelligentStatus	String	否	是否打开智能添加填写区(默认开启，打开:"OPEN" 关闭："CLOSE")
FormFields	Array of FormField	否	填写控件内容
NeedSignReview	Boolean	否	本企业(发起方企业)是否需要签署审批 true：开启发起方签署审批 false：不开启发起方签署审批 开启后，使用ChannelCreateFlowSignReview接口提交审批结果，才能继续完成签署
UserData	String	否	用户流程自定义数据参数
CcInfos	Array of CcInfo	否	抄送人信息
NeedCreateReview	Boolean	否	是否需要开启发起方发起前审核 true：开启发起方发起前审核 false：不开启发起方发起前审核 当指定NeedCreateReview=true，则提交审核后，需要使用接口：ChannelCreateFlowSignReview，来完成发起前审核，审核通过后，可以继续查看，签署合同
Components	Array of Component	否	填写控件：文件发起使用

CcInfo

抄送信息

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

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

ChannelRole

渠道角色信息

被如下接口引用：ChannelDescribeRoles。

名称	类型	描述
RoleId	String	角色id 注意：此字段可能返回 null，表示取不到有效值。
RoleName	String	角色名 注意：此字段可能返回 null，表示取不到有效值。
RoleStatus	Integer	角色状态：1-启用；2-禁用 注意：此字段可能返回 null，表示取不到有效值。
PermissionGroups	Array of PermissionGroup	权限树 注意：此字段可能返回 null，表示取不到有效值。

CommonApproverOption

签署人配置信息

被如下接口引用：ChannelCreatePrepareFlow。

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

CommonFlowApprover

通用签署人信息

被如下接口引用：ChannelCreatePrepareFlow。

名称	类型	必选	描述
NotChannelOrganization	Boolean	是	指定当前签署人为第三方应用集成子客，默认false：当前签署人为第三方应用集成子客，true：当前签署人为saas企业用户
ApproverType	Integer	否	签署人类型,目前支持：0-企业签署人，1-个人签署人，3-企业静默签署人
OrganizationId	String	否	企业id
OrganizationOpenId	String	否	企业OpenId，第三方应用集成非静默签子客企业签署人发起合同必传
OrganizationName	String	否	企业名称，第三方应用集成非静默签子客企业签署人必传，saas企业签署人必传
UserId	String	否	用户id
OpenId	String	否	用户openId，第三方应用集成非静默签子客企业签署人必传
ApproverName	String	否	签署人名称，saas企业签署人，个人签署人必传
ApproverMobile	String	否	签署人手机号，saas企业签署人，个人签署人必传
RecipientId	String	否	签署人Id，使用模板发起是，对应模板配置中的签署人RecipientId 注意：模板发起时该字段必填
PreReadTime	Integer	否	签署前置条件：阅读时长限制，不传默认10s,最大300s，最小3s
IsFullText	Boolean	否	签署前置条件：阅读全文限制
NotifyType	String	否	通知类型：SMS（短信） NONE（不做通知）, 不传 默认SMS
ApproverOption	CommonApproverOption	否	签署人配置
SignComponents	Array of Component	否	签署控件：文件发起使用
ApproverVerifyTypes	Array of Integer	否	签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1 查看合同的认证方式 Flow层级的优先于approver层级的 （当手写签名方式为OCR_ESIGN时，合同认证方式2无效，因为这种签名方式依赖实名认证） 示例值：[1,2]
ApproverSignTypes	Array of Integer	否	签署人签署合同时的认证方式 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2) 示例值：[1,2,3]

Component

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

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

1. 绝对定位方式
2. 表单域(FIELD)定位方式
3. 关键字(KEYWORD)定位方式 可以参考官网说明 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

被如下接口引用：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 - 关键字 示例值：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格式。 不同类型的控件会有部分非通用参数 TEXT/MULTI_LINE_TEXT控件可以指定 1 Font：目前只支持黑体、宋体 2 FontSize： 范围12-72 3 FontAlign： Left/Right/Center，左对齐/居中/右对齐 例如：{"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":"{"PageRange":[{"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

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

被如下接口引用：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-不允许 示例值：true
HideShowFlowType	Boolean	否	是否允许发起合同弹窗隐藏合同类型，true-允许，false-不允许 示例值：true
HideShowDeadline	Boolean	否	是否允许发起合同弹窗隐藏合同到期时间，true-允许，false-不允许 示例值：true
CanSkipAddApprover	Boolean	否	是否允许发起合同步骤跳过指定签署方步骤，true-允许，false-不允许 示例值：true
CustomCreateFlowDescription	String	否	定制化发起合同弹窗的描述信息，描述信息最长500 示例值：""

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 授权平台企业下载合同 示例值：AUTO_SIGN
Name	String	扩展服务名称 示例值：企业静默签（自动签署）
Status	String	服务状态 ENABLE 开启 DISABLE 关闭 示例值：DISABLE
OperatorOpenId	String	最近操作人第三方应用平台的用户openid 注意：此字段可能返回 null，表示取不到有效值。
OperateOn	Integer	最近操作时间戳，单位秒 注意：此字段可能返回 null，表示取不到有效值。

FailedCreateRoleData

绑定失败的用户角色信息

被如下接口引用：ChannelCreateUserRoles。

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

FilledComponent

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

被如下接口引用：ChannelDescribeFlowComponents。

名称	类型	描述
ComponentId	String	控件Id 注意：此字段可能返回 null，表示取不到有效值。
ComponentName	String	控件名称 注意：此字段可能返回 null，表示取不到有效值。
ComponentFillStatus	String	控件填写状态；0-未填写；1-已填写 注意：此字段可能返回 null，表示取不到有效值。
ComponentValue	String	控件填写内容 注意：此字段可能返回 null，表示取不到有效值。
ImageUrl	String	图片填充控件下载链接，如果是图片填充控件时，这里返回图片的下载链接。 注意：此字段可能返回 null，表示取不到有效值。

Filter

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

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

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

FlowApproverDetail

签署人的流程信息明细

被如下接口引用：DescribeFlowDetailInfo。

名称	类型	描述
ReceiptId	String	模板配置时候的签署人id,与控件绑定
ProxyOrganizationOpenId	String	平台企业的第三方id 注意：此字段可能返回 null，表示取不到有效值。
ProxyOperatorOpenId	String	平台企业操作人的第三方id
ProxyOrganizationName	String	平台企业名称
Mobile	String	签署人手机号
SignOrder	Integer	签署人签署顺序
ApproveName	String	签署人姓名 注意：此字段可能返回 null，表示取不到有效值。
ApproveStatus	String	当前签署人的状态, 状态如下 PENDING 待签署 FILLPENDING 待填写 FILLACCEPT 填写完成 FILLREJECT 拒绝填写 WAITPICKUP 待领取 ACCEPT 已签署 REJECT 拒签 DEADLINE 过期没人处理 CANCEL 流程已撤回 FORWARD 已经转他人处理 STOP 流程已终止 RELIEVED 解除协议（已解除） 注意：此字段可能返回 null，表示取不到有效值。
ApproveMessage	String	签署人自定义信息 注意：此字段可能返回 null，表示取不到有效值。
ApproveTime	Integer	签署人签署时间戳，单位秒
ApproveType	String	参与者类型 ORGANIZATION：企业签署人 PERSON：个人签署人 注意：此字段可能返回 null，表示取不到有效值。
ApproverRoleName	String	自定义签署人角色 注意：此字段可能返回 null，表示取不到有效值。

FlowApproverInfo

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

其中签署方FlowApproverInfo需要传递的参数 非单C、单B、B2C合同，ApproverType、RecipientId（模板发起合同时）必传，建议都传。

其他身份标识

• 1-个人：Name、Mobile必传
• 2-第三方平台子客企业指定经办人：OpenId必传，OrgName必传、OrgOpenId必传；
• 3-第三方平台子客企业不指定经办人：OrgName必传、OrgOpenId必传；
• 4-非第三方平台子客企业：Name、Mobile必传，OrgName必传，且NotChannelOrganization=True。

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

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

名称	类型	必选	描述
Name	String	否	签署人姓名，最大长度50个字符 示例值：张三
IdCardType	String	否	签署人的证件类型 1.ID_CARD 居民身份证 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证 4.OTHER_CARD_TYPE 其他（需要使用该类型请先联系运营经理） 示例值：ID_CARD
IdCardNumber	String	否	签署人证件号（长度不超过18位） 示例值：110101192008317114
Mobile	String	否	签署人手机号，脱敏显示。大陆手机号为11位，暂不支持海外手机号。 示例值：13888888888
OrganizationName	String	否	企业签署方工商营业执照上的企业名称，签署方为非发起方企业场景下必传，最大长度64个字符； 示例值："xxx"
NotChannelOrganization	Boolean	否	指定签署人非第三方平台子客企业下员工，在ApproverType为ORGANIZATION时指定。 默认为false，即签署人位于同一个第三方平台应用号下；默认为false，即签署人位于同一个第三方应用号下； 示例值：false
OpenId	String	否	用户侧第三方id，最大长度64个字符 当签署方为同一第三方平台下的员工时，该字段若不指定，则发起【待领取】的流程 示例值：open_test_id
OrganizationOpenId	String	否	企业签署方在同一第三方平台应用下的其他合作企业OpenId，签署方为非发起方企业场景下必传，最大长度64个字符； 示例值："xxx"
ApproverType	String	否	签署人类型 PERSON-个人/自然人； PERSON_AUTO_SIGN-个人自动签署，适用于个人自动签场景 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。 ORGANIZATION-企业（企业签署方或模板发起时的企业静默签）； ENTERPRISESERVER-企业自动签（他方企业自动签署或文件发起时的本方企业自动签） 若要实现他方企业（同一应用下）自动签，需要满足3个条件： 条件1：ApproverType 设置为ENTERPRISESERVER 条件2：子客之间完成授权 条件3：联系对接的客户经理沟通 示例值：PERSON
RecipientId	String	否	签署流程签署人在模板中对应的签署人Id；在非单方签署、以及非B2C签署的场景下必传，用于指定当前签署方在签署流程中的位置； 示例值："xxx"
Deadline	Integer	否	签署截止时间戳，默认一年 示例值：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~300s，未指定则按合同页数计算 示例值：3
JumpUrl	String	否	签署完前端跳转的url，此字段的用法场景请联系客户经理确认 示例值：https://qq.com
ApproverOption	ApproverOption	否	签署人个性化能力值
ApproverNeedSignReview	Boolean	否	当前签署方进行签署操作是否需要企业内部审批，true 则为需要 示例值：false
ApproverVerifyTypes	Array of Integer	否	签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1 查看合同的认证方式 Flow层级的优先于approver层级的 （当手写签名方式为OCR_ESIGN时，合同认证方式2无效，因为这种签名方式依赖实名认证） 示例值：[1,2]
ApproverSignTypes	Array of Integer	否	签署人签署合同时的认证方式 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2) 示例值：[1,2,3]
SignId	String	否	签署ID - 发起流程时系统自动补充 - 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息
NotifyType	String	否	SMS: 短信(需确保“电子签短信通知签署方”功能是开启状态才能生效); NONE: 不发信息 默认为SMS(签署方为子客时该字段不生效) 示例值：SMS
AddSignComponentsLimits	Array of ComponentLimit	否	通过文件创建签署流程时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID）或签名方式。 注：限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个），他方企业或个人只支持限制控件类型。
ApproverRoleName	String	否	自定义签署方角色名称

FlowApproverItem

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

被如下接口引用：CreateFlowsByTemplates。

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

FlowApproverUrlInfo

签署人签署链接信息

被如下接口引用：ChannelCreateFlowSignUrl。

名称	类型	描述
SignUrl	String	签署短链接，不支持小程序嵌入，只支持移动端浏览器打开。注意该链接有效期为30分钟，同时需要注意保密，不要外泄给无关用户。
ApproverType	String	签署人类型 PERSON-个人 示例值：PERSON
Name	String	签署人姓名
Mobile	String	签署人手机号
LongUrl	String	签署长链接，支持小程序嵌入。注意该链接有效期为30分钟，同时需要注意保密，不要外泄给无关用户。 注意：此字段可能返回 null，表示取不到有效值。

FlowDetailInfo

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

被如下接口引用：DescribeFlowDetailInfo。

名称	类型	描述
FlowId	String	合同(流程)的Id
FlowName	String	合同(流程)的名字
FlowType	String	合同(流程)的类型
FlowStatus	String	合同(流程)的状态, 状态如下 INIT 合同创建 PART 合同签署中 REJECT 合同拒签 ALL 合同签署完成 DEADLINE 合同流签(合同过期) CANCEL 合同撤回 RELIEVED 解除协议（已解除）
FlowMessage	String	合同(流程)的信息
CreateOn	Integer	合同(流程)的创建时间戳，单位秒
DeadLine	Integer	合同(流程)的签署截止时间戳，单位秒
CustomData	String	用户自定义数据
FlowApproverInfos	Array of FlowApproverDetail	合同(流程)的签署人数组
CcInfos	Array of FlowApproverDetail	合同(流程)关注方信息列表
NeedCreateReview	Boolean	是否需要发起前审批，当NeedCreateReview为true，表明当前流程是需要发起前审核的合同，可能无法进行查看，签署操作，需要等审核完成后，才可以继续后续流程

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	否	发起方企业经办人（即签署人为发起方企业员工）是否需要对子合同进行独立的意愿确认： fasle：发起方企业经办人签署时对所有子合同进行统一的意愿确认 true：发起方企业经办人签署时需要对子合同进行独立的意愿确认 默认为fasle。 示例值：fasle
OtherApproverSignEach	Boolean	否	非发起方企业经办人（即：签署人为个人或者不为发起方企业的员工）是否需要对子合同进行独立的意愿确认： fasle：非发起方企业经办人签署时对所有子合同进行统一的意愿确认 true：非发起方企业经办人签署时需要对子合同进行独立的意愿确认 默认为false。 示例值：fasle

FlowInfo

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

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

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

名称	类型	必选	描述
FlowName	String	是	合同名字，最大长度200个字符 示例值：签署流程名称
Deadline	Integer	是	签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年 示例值：截止时间
TemplateId	String	否	模板ID 示例值：模板Id数组
FlowApprovers	Array of FlowApproverInfo	否	多个签署人信息，最大支持50个签署方 示例值：签署人信息
FormFields	Array of FormField	否	表单K-V对列表 示例值：表单K-V对列表
CallbackUrl	String	否	回调地址，最大长度1000个字符 示例值：回调地址
FlowType	String	否	合同类型，如：1. “劳务”；2. “销售”；3. “租赁”；4. “其他”，最大长度200个字符 示例值：签署流程类型
FlowDescription	String	否	合同描述，最大长度1000个字符 示例值：签署流程详情
CustomerData	String	否	第三方应用平台的业务信息，最大长度1000个字符。 示例值："xxx"
CustomShowMap	String	否	合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始 示例值：合同名称:{合同名称} {发起方企业} {发起方姓名};国家:中国;发起方:{发起方企业};签署方1: {签署方1企业};签署
CcInfos	Array of CcInfo	否	被抄送人的信息列表，抄送功能暂不开放 示例值：xxx
NeedSignReview	Boolean	否	发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。 示例值：true
CcNotifyType	Integer	否	给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知 示例值：0
AutoSignScene	String	否	个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN 示例值：E_PRESCRIPTION_AUTO_SIGN

FlowResourceUrlInfo

流程对应资源链接信息

被如下接口引用：DescribeResourceUrlsByFlows。

名称	类型	描述
FlowId	String	流程对应Id 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxx
ResourceUrlInfos	Array of ResourceUrlInfo	流程对应资源链接信息数组 注意：此字段可能返回 null，表示取不到有效值。

FormField

此结构 (FormField) 用于描述内容控件填充结构。

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

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。

名称	类型	必选	描述
Id	String	是	对应Agent-ProxyOperator-OpenId。第三方应用平台自定义，对子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工，不可在其他子客企业内重复使用。（例如，可以使用经办人企业名+员工身份证的hash值，需要第三方应用平台保存），最大64位字符串
Name	String	否	经办人姓名，最大长度50个字符
IdCardType	String	否	经办人身份证件类型 1.ID_CARD 居民身份证 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
IdCardNumber	String	否	经办人证件号
Mobile	String	否	经办人手机号，大陆手机号输入11位，暂不支持海外手机号。
DefaultRole	String	否	默认角色，值为以下三个对应的英文： 业务管理员：admin 经办人：channel-normal-operator 业务员：channel-sales-man

Recipient

流程中参与方的信息结构

被如下接口引用：DescribeTemplates。

名称	类型	必选	描述
RecipientId	String	否	签署人唯一标识，在通过模板发起合同的时候对应签署方ID 示例值：ed68bc6904fbd4795b4658c480214e4e
RecipientType	String	否	参与者类型，默认为空。 ENTERPRISE-企业； INDIVIDUAL-个人； PROMOTER-发起方 示例值：ENTERPRISE
Description	String	否	描述信息
RoleName	String	否	角色名称
RequireValidation	Boolean	否	是否需要校验， true-是， false-否 示例值：true
RequireSign	Boolean	否	是否必须填写， true-是， false-否 示例值：true
SignType	Integer	否	内部字段，签署类型 示例值：0
RoutingOrder	Integer	否	签署顺序：数字越小优先级越高 示例值：0
IsPromoter	Boolean	否	是否是发起方， true-是 false-否 示例值：true

RecipientComponentInfo

参与方填写控件信息

被如下接口引用：ChannelDescribeFlowComponents。

名称	类型	描述
RecipientId	String	参与方Id 注意：此字段可能返回 null，表示取不到有效值。
RecipientFillStatus	String	参与方填写状态 注意：此字段可能返回 null，表示取不到有效值。
IsPromoter	Boolean	是否发起方 注意：此字段可能返回 null，表示取不到有效值。
Components	Array of FilledComponent	填写控件内容 注意：此字段可能返回 null，表示取不到有效值。

ReleasedApprover

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

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

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

被如下接口引用：ChannelCreateReleaseFlow。

名称	类型	必选	描述
OrganizationName	String	是	企业签署方工商营业执照上的企业名称，签署方为非发起方企业场景下必传，最大长度64个字符 示例值：xxx
ApproverNumber	Integer	是	签署人在原流程中的签署人列表中的顺序序号（从0开始，按顺序依次递增），如果不清楚原流程中的签署人列表，可以通过DescribeFlows接口查看 示例值：0
ApproverType	String	是	签署人类型，目前仅支持 ORGANIZATION-企业 ENTERPRISESERVER-企业静默签 示例值：ORGANIZATION
Name	String	否	签署人姓名，最大长度50个字符 示例值：张三
IdCardType	String	否	签署人身份证件类型 1.ID_CARD 居民身份证 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证 示例值：ID_CARD
IdCardNumber	String	否	签署人证件号 示例值：110101192008317114
Mobile	String	否	签署人手机号，脱敏显示。大陆手机号为11位，暂不支持海外手机号 示例值：13888888888
OrganizationOpenId	String	否	企业签署方在同一第三方应用下的其他合作企业OpenId，签署方为非发起方企业场景下必传，最大长度64个字符 示例值：xxx
OpenId	String	否	用户侧第三方id，最大长度64个字符 当签署方为同一第三方应用下的员工时，该字必传 示例值：xxx
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-否 示例值：true
FlowId	String	合同id 示例值：xxx
RemindMessage	String	催办详情信息 示例值：xxx

ResourceUrlInfo

资源链接信息

被如下接口引用：DescribeResourceUrlsByFlows。

名称	类型	描述
Url	String	资源链接地址，过期时间5分钟 注意：此字段可能返回 null，表示取不到有效值。 示例值："xxx"
Name	String	资源名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：test.pdf
Type	String	资源类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：PDF

SignQrCode

一码多扫签署二维码对象

被如下接口引用：ChannelCreateMultiFlowSignQRCode。

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

SignUrl

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

被如下接口引用：ChannelCreateMultiFlowSignQRCode。

名称	类型	描述
AppSignUrl	String	小程序签署链接
EffectiveTime	String	签署链接有效时间 示例值：2022-08-05 15:55:01
HttpSignUrl	String	移动端签署链接

SignUrlInfo

签署链接内容

被如下接口引用：CreateSignUrls。

名称	类型	描述
SignUrl	String	签署链接，过期时间为90天 注意：此字段可能返回 null，表示取不到有效值。 示例值：https://essurl.cn/xxxx
Deadline	Integer	合同过期时间戳，单位秒 注意：此字段可能返回 null，表示取不到有效值。
SignOrder	Integer	当流程为顺序签署此参数有效时，数字越小优先级越高，暂不支持并行签署 可选 注意：此字段可能返回 null，表示取不到有效值。
SignId	String	签署人编号 注意：此字段可能返回 null，表示取不到有效值。
Name	String	用户姓名 注意：此字段可能返回 null，表示取不到有效值。
Mobile	String	用户手机号码 注意：此字段可能返回 null，表示取不到有效值。
OrganizationName	String	签署参与者机构名字 注意：此字段可能返回 null，表示取不到有效值。
ApproverType	String	参与者类型: ORGANIZATION 企业经办人 PERSON 自然人 注意：此字段可能返回 null，表示取不到有效值。
IdCardNumber	String	经办人身份证号 注意：此字段可能返回 null，表示取不到有效值。
FlowId	String	签署链接对应流程Id 注意：此字段可能返回 null，表示取不到有效值。 示例值："test-flow-id"
OpenId	String	企业经办人 用户在渠道的编号 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_open_id
FlowGroupId	String	合同组签署链接对应的合同组id 注意：此字段可能返回 null，表示取不到有效值。 示例值："test-flow-group-id"
SignQrcodeUrl	String	二维码，在生成动态签署人跳转封面页链接时返回 注意：此字段可能返回 null，表示取不到有效值。

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	对应Agent-ProxyOperator-OpenId。第三方应用平台自定义，对子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工，不可在其他子客企业内重复使用。（例如，可以使用经办人企业名+员工身份证的hash值，需要第三方应用平台保存），最大64位字符串 示例值：operator_id1
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	日期，当需要汇总数据时日期为空 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-08-31
Usage	Integer	消耗数量 示例值：50
Cancel	Integer	撤回数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
FlowChannel	String	消耗渠道 注意：此字段可能返回 null，表示取不到有效值。 示例值：企业版

UserInfo

接口调用者信息

被如下接口引用：ChannelBatchCancelFlows, ChannelCancelFlow, ChannelCancelMultiFlowSignQRCode, ChannelCancelUserAutoSignEnableUrl, ChannelCreateBatchCancelFlowUrl, ChannelCreateBatchSignUrl, ChannelCreateBoundFlows, ChannelCreateConvertTaskApi, ChannelCreateEmbedWebUrl, ChannelCreateFlowByFiles, ChannelCreateFlowGroupByFiles, ChannelCreateFlowGroupByTemplates, ChannelCreateFlowReminds, ChannelCreateFlowSignReview, ChannelCreateFlowSignUrl, ChannelCreateMultiFlowSignQRCode, ChannelCreateOrganizationModifyQrCode, ChannelCreatePrepareFlow, ChannelCreatePreparedPersonalEsign, ChannelCreateReleaseFlow, ChannelCreateRole, ChannelCreateSealPolicy, ChannelCreateUserAutoSignEnableUrl, ChannelCreateUserRoles, ChannelCreateWebThemeConfig, ChannelDeleteRole, ChannelDeleteRoleUsers, ChannelDeleteSealPolicies, ChannelDescribeEmployees, ChannelDescribeFlowComponents, ChannelDescribeOrganizationSeals, ChannelDescribeRoles, ChannelDescribeUserAutoSignStatus, ChannelDisableUserAutoSign, ChannelGetTaskResultApi, ChannelModifyRole, ChannelUpdateSealStatus, ChannelVerifyPdf, CreateChannelFlowEvidenceReport, CreateConsoleLoginUrl, CreateFlowsByTemplates, CreateSealByImage, CreateSignUrls, DescribeChannelFlowEvidenceReport, DescribeExtendedServiceAuthInfo, DescribeFlowDetailInfo, DescribeResourceUrlsByFlows, DescribeTemplates, DescribeUsage, GetDownloadFlowUrl, ModifyExtendedService, OperateChannelTemplate, PrepareFlows, SyncProxyOrganization, SyncProxyOrganizationOperators, UploadFiles。

名称	类型	必选	描述
OpenId	String	否	第三方应用平台自定义，对应第三方平台子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工，不可在其他子客企业内重复使用。（例如，可以使用经办人企业名+员工身份证的hash值，需要第三方应用平台保存），最大64位字符串

UserThreeFactor

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

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

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

WebThemeConfig

主题配置

被如下接口引用：ChannelCreateWebThemeConfig。

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