tencentcloud-sdk-nodejs

/** * SyncProxyOrganization返回参数结构体 */ export interface SyncProxyOrganizationResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 批量签署合同相关信息，指定批量签署合同和签署方的信息，用于补充动态签署人。 */ export interface FlowBatchUrlInfo { /** * 批量签署合同和签署方的信息，用于补充动态签署人。 */ FlowBatchApproverInfos?: Array<FlowBatchApproverInfo>; } /** * ChannelCreateConvertTaskApi返回参数结构体 */ export interface ChannelCreateConvertTaskApiResponse { /** * 接口返回的文件转换任务Id，可以调用接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。 */ TaskId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateBatchAdminChangeInvitations返回参数结构体 */ export interface CreateBatchAdminChangeInvitationsResponse { /** * 批量生成企业认证链接的详细错误信息，顺序与输入参数子企业列表顺序一致。<ul><li>如果所有企业认证链接都成功生成，将不返回错误信息</li><li>如果存在任何错误，将返回具体的错误描述。（没有错误的企业返回空字符串）</li></ul> */ ErrorMessages?: Array<string>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChannelCreateFlowReminds返回参数结构体 */ export interface ChannelCreateFlowRemindsResponse { /** * 合同催办结果的详细信息列表。 */ RemindFlowRecords?: Array<RemindFlowRecords>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 此结构体 (Component) 用于描述控件属性。在通过文件发起合同时，对应的component有三种定位方式 1. 绝对定位方式（可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标） 2. 表单域(FIELD)定位方式 3. 关键字(KEYWORD)定位方式，使用关键字定位时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找 */ export interface Component { /** * 控件唯一ID。在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。例：<ul><li>如传入的关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（前后不能有其他字符）进行对应操作。</li><li>如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置（前后可以有其他字符）都会执行相应操作。</li></ul>注：<code>控件ID可以在一个PDF中不可重复</code> <a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentId在模板页面的位置</a> */ ComponentId?: string; /** * 如果是Component填写控件类型，则可选的字段为：<ul><li> TEXT : 普通文本控件，输入文本字符串；</li><li> MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；</li><li> CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li><li> FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；</li><li> DYNAMIC_TABLE : 动态表格控件；</li><li> ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li><li> SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；</li><li> DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li><li> DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li><li> VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容</li></ul>如果是SignComponent签署控件类型， 需要根据签署人的类型可选的字段为<ul><li>企业方<ul><li> SIGN_SEAL : 签署印章控件；</li><li> SIGN_DATE : 签署日期控件；</li><li> SIGN_SIGNATURE : 用户签名控件；</li><li> SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li><li> SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li><li> SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li><li> SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li><li> SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言</li><li> SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择</li><li> SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。</li></ul></li></ul><ul><li>个人方<ul><li> SIGN_DATE : 签署日期控件；</li><li> SIGN_SIGNATURE : 用户签名控件；</li><li> SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；</li><li> SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li><li> SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li><li> SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言</li><li> SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择</li></ul></li></ul>注：<code>表单域的控件不能作为印章和签名控件</code> */ ComponentType?: string; /** * 在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。注：<code>控件名可以在一个PDF中可以重复</code><a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentName在模板页面的位置</a> */ ComponentName?: string; /** * 如果是填写控件，ComponentRequired表示在填写页面此控件是否必填<ul><li>false（默认）：可以不填写</li><li>true ：必须填写此填写控件</li></ul>如果是签署控件，签批控件中签署意见等可以不填写，其他签署控件不受此字段影响 */ ComponentRequired?: boolean; /** * 在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可 */ ComponentRecipientId?: string; /** * 【暂未使用】控件所属文件的序号（取值为：0-N）。目前单文件的情况下，值一直为0 */ FileIndex?: number; /** * 控件生成的方式：<ul><li> NORMAL : 绝对定位控件</li><li> FIELD : 表单域</li><li> KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）</li></ul> */ GenerateMode?: string; /** * 在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。 */ ComponentWidth?: number; /** * 在绝对定位方式和关键字定位方式下，指定控件的高度，控件高度是指控件在PDF文件中的高度，单位为pt（点）。 */ ComponentHeight?: number; /** * 在绝对定位方式方式下，指定控件所在PDF文件上的页码 在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：<ol><li>页码编号是从1开始编号的。</li><li>页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。</li></ol> */ ComponentPage?: number; /** * 在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。 */ ComponentPosX?: number; /** * 在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。 */ ComponentPosY?: number; /** * 在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：<ul><li> Font：目前只支持黑体、宋体、仿宋</li><li> FontSize：范围6 :72</li><li> FontAlign： Left/Right/Center，左对齐/居中/右对齐</li><li> FontColor：字符串类型，格式为RGB颜色数字</li><li> Bold是否加粗：true/false</li></ul>参数样例：<code>{"FontColor":"255,0,0","FontSize":12,"Bold":false}</code>ComponentType为DATE时，支持以下参数：<ul><li> Font：目前只支持黑体、宋体、仿宋</li><li> FontSize：范围6 :72</li></ul>参数样例：<code>{"FontColor":"255,0,0","FontSize":12}</code>ComponentType为WATERMARK时，支持以下参数：<ul><li> Font：目前只支持黑体、宋体、仿宋</li><li> FontSize：范围6 :72</li><li> Opacity：透明度，范围0 :1</li><li> Rotate：水印旋转角度，范围0 :359</li><li> Density：水印样式，1-宽松，2-标准（默认值），3-密集，</li><li> Position：水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中</li><li> SubType：水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul>参数样例：<code>"{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"</code>ComponentType为FILL_IMAGE时，支持以下参数：<ul><li> NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li><li> FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>ComponentType为SELECTOR时，支持以下参数：<ul><li> WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成</li></ul>ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式<ul><li> HANDWRITE : 需要实时手写的手写签名</li><li> HANDWRITTEN_ESIGN : 长效手写签名，是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li><li> OCR_ESIGN : AI智能识别手写签名</li><li> ESIGN : 个人印章类型</li><li> SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li><li> IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>参考样例：<code>{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}</code>印章的对应关系参考下图![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg) ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型<ul><li> OFFICIAL : 企业公章</li><li> CONTRACT : 合同专用章</li><li> FINANCE : 财务专用章</li><li> PERSONNEL : 人事专用章</li><li> OTHER : 其他</li></ul>参考样例：<code>{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}</code> 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。 ComponentType为SIGN_DATE时，支持以下参数：<ul><li> Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"</li><li> FontSize : 数字类型，范围6-72，默认值为12</li><li> FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li><li> Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li><li> Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： <code>"{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"</code>ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：<ul><li> PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>参数样例：<code>"{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"</code>签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：<ul><li> Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li><li> RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul>参数样例：<code>{"Rotate":-30,"RotateRelation":"Component_Id1"}</code>签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：<ul><li> Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度</li></ul>参数样例：<code>{"Opacity":0.7}</code>签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：<ul><li> UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>参数样例：<code>{"UseSealSize":true}</code>签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：<ul><li> Values：签署意见预设的需要用户填写的文本</li><li> ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）</li></ul>参数样例：<code>{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}</code>关键字模式下支持关键字找不到的情况下不进行报错的设置<ul><li> IgnoreKeywordError :1-关键字查找不到时不进行报错</li></ul>场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例：<code>"{"IgnoreKeywordError":1}"</code>ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：<ul><li>Children: 绝对定位模式下，用来指定此签批控件的组合子控件 </li>参数样例： <code>{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}</code><li>ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件 </li>ChildrenComponent结构体定义:<table border="1"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td></tr><tr> <td>ComponentValue</td> <td>string</td> <td>子控件值（签署方不可设置）</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table>参数样例：<pre>{ "ChildrenComponents": [ { "ComponentType": "SIGN_SIGNATURE", "ComponentName": "个人签名", "Placeholder": "请签名", "ComponentOffsetX": 10, "ComponentOffsetY": 30, "ComponentWidth": 119, "ComponentHeight": 43, "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}" }, { "ComponentType": "SIGN_SELECTOR", "ComponentName": "是否同意此协议", "Placeholder": "", "ComponentOffsetX": 50, "ComponentOffsetY": 130, "ComponentWidth": 120, "ComponentHeight": 43, "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}" }, { "ComponentType": "SIGN_MULTI_LINE_TEXT", "ComponentName": "批注附言", "Placeholder": "", "ComponentOffsetX": 150, "ComponentOffsetY": 300, "ComponentWidth": 200, "ComponentHeight": 86, "ComponentExtra": "" } ]}</pre></ul> */ ComponentExtra?: string; /** * 控件填充vaule，ComponentType和传入值类型对应关系：<ul><li> TEXT : 文本内容</li><li> MULTI_LINE_TEXT : 文本内容，可以用 \n 来控制换行位置</li><li> CHECK_BOX : true/false</li><li> FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取</li><li> SELECTOR : 选项值</li><li> DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li><li> DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）</li><li> SIGN_SEAL : 印章ID，于控制台查询获取，[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li><li> SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li></ul>控件值约束说明：<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符，2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符，不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true，不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束，填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式：yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片，填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr><tr> <td>水印控件</td> <td>水印控件设置为CUSTOM_WATERMARK类型时的水印内容</td> </tr> </tbody> </table>注： <code>部分特殊控件需要在控制台配置模板形式创建</code> */ ComponentValue?: string; /** * 【暂未使用】日期签署控件的字号，默认为 12 */ ComponentDateFontSize?: number; /** * 【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可 */ DocumentId?: string; /** * 【暂未使用】控件描述，用户自定义，不影响合同发起流程 */ ComponentDescription?: string; /** * 如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。 注意： <code>向左调整设置为负数，向右调整设置成正数</code> */ OffsetX?: number; /** * 如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。 注意： <code>向上调整设置为负数，向下调整设置成正数</code> */ OffsetY?: number; /** * 【暂未使用】第三方应用集成平台模板控件 ID 标识 */ ChannelComponentId?: string; /** * 如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。<ul><li> Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列</li><li> Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列</li></ul>在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。 */ KeywordOrder?: string; /** * 如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。 */ KeywordPage?: number; /** * 如果控件是关键字定位方式，关键字生成的区域的对齐方式，可以设置下面的值<ul><li> Middle :居中</li><li> Below :正下方</li><li> Right :正右方</li><li> LowerRight :右下角</li><li> UpperRight :右上角。</li></ul>示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方 */ RelativeLocation?: string; /** * 如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的 */ KeywordIndexes?: Array<number | bigint>; /** * 填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。 注：<code>签署控件设置此字段无效</code> */ Placeholder?: string; /** * web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑<ul><li>false（默认）：不锁定控件值，允许在页面编辑控件值</li><li>true：锁定控件值，在页面无法编辑控件值</li></ul> */ LockComponentValue?: boolean; /** * web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件<ul><li> false（默认） :可以移动和删除控件</li><li> true : 禁止移动和删除控件</li></ul> */ ForbidMoveAndDelete?: boolean; } /** * DescribeUserFlowType返回参数结构体 */ export interface DescribeUserFlowTypeResponse { /** * 查询到的所有用户合同类型列表 */ AllUserFlowTypes?: Array<TemplateUserFlowType>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChannelDeleteSealPolicies请求参数结构体 */ export interface ChannelDeleteSealPoliciesRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 */ Agent: Agent; /** * 操作的印章ID */ SealId: string; /** * 需要删除授权的用户ID数组，可以传入电子签系统用户ID或OpenId。注: 1. `填写OpenId时，系统会通过组织+渠道+OpenId查询得到对应的UserId进行授权取消操作` */ UserIds: Array<string>; /** * 组织机构信息，不用传 * @deprecated */ Organization?: OrganizationInfo; /** * 操作人（用户）信息，不用传 * @deprecated */ Operator?: UserInfo; } /** * ChannelBatchCancelFlows返回参数结构体 */ export interface ChannelBatchCancelFlowsResponse { /** * 签署流程批量撤销失败原因，错误信息与流程Id一一对应，成功为"", 失败则对应失败原因注: `如果全部撤销成功, 此数组为空数组` */ FailMessages?: Array<string>; /** * 批量撤销任务编号，为32位字符串，可用于[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask) 或关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83) */ TaskId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 企业批量注册链接信息 */ export interface OrganizationAuthUrl { /** * 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表 <table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/SHORT_URL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>CHANNEL/SHORT_URL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/SHORT_URL/APP</td> <td>一年</td> </tr> </tbody> </table> 注： `1.链接仅单次有效，每次登录需要需要重新创建新的链接` `2.创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义` */ AuthUrl?: string; /** * 企业批量注册的错误信息，例如：企业三要素不通过 */ ErrorMessage?: string; /** * 企业批量注册传递过来的企业名称，方便客户定位企业 */ OrganizationName?: string; /** * 企业批量注册的唯一 Id，此 Id 可以用在[创建企业批量认证链接-单链接](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks)。 */ SubTaskId?: string; } /** * 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。 */ export interface FlowGroupUrlInfo { /** * 合同组子合同和签署方的信息，用于补充动态签署人。 */ FlowGroupApproverInfos?: Array<FlowGroupApproverInfo>; } /** * ChannelDescribeSignFaceVideo请求参数结构体 */ export interface ChannelDescribeSignFaceVideoRequest { /** * 合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。 */ FlowId: string; /** * 签署参与人在本流程中的编号ID(每个流程不同)，可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。 */ SignId: string; /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; } /** * ChannelDisableUserAutoSign返回参数结构体 */ export interface ChannelDisableUserAutoSignResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeExtendedServiceAuthDetail返回参数结构体 */ export interface DescribeExtendedServiceAuthDetailResponse { /** * 服务授权的信息列表，根据查询类型返回特定扩展服务的开通和授权状况。 */ AuthInfoDetail?: AuthInfoDetail; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 第三方应用集成员工部门信息 */ export interface Department { /** * 部门id */ DepartmentId?: string; /** * 部门名称 */ DepartmentName?: string; } /** * CreateLegalSealQrCode返回参数结构体 */ export interface CreateLegalSealQrCodeResponse { /** * 二维码图片base64值，二维码有效期7天（604800秒）二维码图片的样式如下图： ![image](https://qcloudimg.tencent-cloud.cn/raw/7ec2478761158a35a9c623882839a5df.png) */ QrcodeBase64?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 签署人配置信息。此参数对子客和自动签无效，不允许进行修改。 */ export interface CommonApproverOption { /** * 是否允许修改签署人信息 */ CanEditApprover?: boolean; /** * 是否可以拒签默认false-可以拒签 true-不可以拒签 */ NoRefuse?: boolean; /** * 是否可以转发默认false-可以转发 true-不可以转发 */ NoTransfer?: boolean; /** * 当签署方有多个签署区时候，是否隐藏一键所有的签署区false：（默认）不隐藏 true：隐藏，每个签署区要单独选择印章或者签名 */ HideOneKeySign?: boolean; /** * 签署人阅读合同限制参数 取值：<ul><li> LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底</li><li> LimitReadTime，阅读合同仅限制阅读时长</li><li> LimitBottom，阅读合同仅限制必须阅读到底</li><li> NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）</li></ul> */ FlowReadLimit?: string; /** * 禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）：<ul><li> 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件</li><li> 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件</li></ul> */ ForbidAddSignDate?: boolean; /** * 在嵌入式文件发起下,若合同是通过文件,当签署人控件指定了印章类型（或印章Id）,在嵌入页面上是否能修改 */ ForbidModifySealInfos?: boolean; } /** * DescribeCancelFlowsTask返回参数结构体 */ export interface DescribeCancelFlowsTaskResponse { /** * 批量撤销任务编号，为32位字符串。 */ TaskId?: string; /** * 任务状态，需要关注的状态<ul><li>PROCESSING - 任务执行中</li><li>END - 任务处理完成</li><li>TIMEOUT 任务超时未处理完成，用户未在批量撤销链接有效期内操作</li></ul> */ TaskStatus?: string; /** * 批量撤销成功的签署流程编号 */ SuccessFlowIds?: Array<string>; /** * 批量撤销失败的签署流程信息 */ FailureFlows?: Array<CancelFailureFlow>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateEmployeeQualificationSealQrCode返回参数结构体 */ export interface CreateEmployeeQualificationSealQrCodeResponse { /** * 二维码图片的Base64 注: `此二维码的有效时间为7天，过期后需要重新生成新的二维码图片` */ QrcodeBase64?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChannelCreateFlowGroupByTemplates返回参数结构体 */ export interface ChannelCreateFlowGroupByTemplatesResponse { /** * 合同组ID，为32位字符串。建议开发者妥善保存此合同组ID，以便于顺利进行后续操作。 */ FlowGroupId?: string; /** * 合同组中每个合同流程ID，每个ID均为32位字符串。注: `此数组的顺序和入参中的FlowInfos顺序一致` */ FlowIds?: Array<string>; /** * 复杂文档合成任务（如，包含动态表格的预览任务）的任务信息数组；如果文档需要异步合成，此字段会返回该异步任务的任务信息，后续可以通过ChannelGetTaskResultApi接口查询任务详情； */ TaskInfos?: Array<TaskInfo>; /** * 合同组签署方信息 */ Approvers?: Array<FlowGroupApprovers>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChannelCreateFlowSignReview请求参数结构体 */ export interface ChannelCreateFlowSignReviewRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; /** * 合同流程ID，为32位字符串。 */ FlowId: string; /** * 企业内部审核结果 <ul><li>PASS: 审核通过（流程可以继续签署或者发起）</li> <li>REJECT: 审核拒绝（流程状态不变，可以继续调用审核接口通过审核）</li> <li>SIGN_REJECT:拒签(流程终止，流程状态变为拒签状态)</li></ul> */ ReviewType: string; /** * 审核结果原因 <ul><li>字符串长度不超过200</li> <li>当ReviewType 是拒绝（REJECT）时此字段必填。</li> <li>当ReviewType 是拒绝（SIGN_REJECT）时此字段必填。</li></ul> */ ReviewMessage?: string; /** * 审核节点的签署人标志，用于指定当前审核的签署方。 注意：以下情况必须传递RecipientId <ul><li> **发起签署流程时，指定签署人需要审批（即签署人需要审批 <a href="https://qian.tencent.com/developers/partnerApis/dataTypes#flowapproverinfo" target="_blank">ApproverNeedSignReview</a>为true），则必须指定RecipientId**</li><li>**如果签署审核节点是个人，此参数必填**。</li></ul> */ RecipientId?: string; /** * 流程审核操作类型，取值如下： <ul><li>**SignReview**：（默认）签署审核</li> <li>**CreateReview**：发起审核</li> <li>注意：`该字段不传或者为空，则默认为SignReview签署审核，走签署审核流程`</li></ul> */ OperateType?: string; } /** * 授权出错信息 */ export interface AuthFailMessage { /** * 第三方平台子客企业的唯一标识，长度不能超过64，只能由字母和数字组成。开发者可自定义此字段的值，并需要保存此 ID 以便进行后续操作。一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的，不可更改，不可重复使用。例如，可以使用企业名称的哈希值，或者社会统一信用代码的哈希值，或者随机哈希值。 */ ProxyOrganizationOpenId?: string; /** * 错误信息 */ Message?: string; } /** * CreateFlowForwards请求参数结构体 */ export interface CreateFlowForwardsRequest { /** * 合同对应参与方需要修改的目标经办人对应的OpenId。注意：`需要保证目标经办人已经加入企业且已实名` */ TargetOpenId: string; /** * 企业签署方的合同及对应签署方 */ FlowForwardInfos: Array<FlowForwardInfo>; /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; } /** * DescribeFlowDetailInfo请求参数结构体 */ export interface DescribeFlowDetailInfoRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; /** * 需要查询的流程ID列表，最多可传入100个ID。如果要查询合同组的信息，则不需要传入此参数，只需传入 FlowGroupId 参数即可。 */ FlowIds?: Array<string>; /** * 需要查询的流程组ID，如果传入此参数，则会忽略 FlowIds 参数。合同组由<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles" target="_blank">通过多文件创建合同组签署流程</a>等接口创建。 */ FlowGroupId?: string; /** * 暂未开放 * @deprecated */ Operator?: UserInfo; } /** * ChannelCancelFlow返回参数结构体 */ export interface ChannelCancelFlowResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyExtendedService请求参数结构体 */ export interface ModifyExtendedServiceRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经过实名认证 */ Agent: Agent; /** * 扩展服务类型 <ul> <li>AUTO_SIGN 企业自动签（自动签署）</li> <li> OVERSEA_SIGN 企业与港澳台居民签署合同</li> <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li> <li> DOWNLOAD_FLOW 授权渠道下载合同 </li> <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li> <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li> </ul> */ ServiceType: string; /** * 操作类型 <ul> <li>OPEN : 开通</li> <li>CLOSE : 关闭</li> </ul> */ Operate: string; /** * 链接跳转类型，支持以下类型 <ul> <li>WEIXINAPP : 短链直接跳转到电子签小程序 (默认值)</li> <li>APP : 第三方APP或小程序跳转电子签小程序</li> <li>WEIXIN_QRCODE_URL：直接跳转至电子签小程序的二维码链接，无需通过中转页。您需要自行将其转换为二维码，使用微信扫码后可直接进入。请注意，直接点击链接是无效的。</li> </ul> */ Endpoint?: string; } /** * DescribeResourceUrlsByFlows请求参数结构体 */ export interface DescribeResourceUrlsByFlowsRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; /** * 需要下载的合同流程的ID, 至少需要1个, 做多50个 */ FlowIds?: Array<string>; /** * 操作者的信息，不用传 * @deprecated */ Operator?: UserInfo; } /** * CreateFileConvertTask请求参数结构体 */ export interface CreateFileConvertTaskRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; /** * 需要进行转换的资源文件类型 支持的文件类型如下：枚举值：<ul><li>doc： doc</li><li>docx： docx</li><li>xls： xls</li><li>xlsx： xlsx</li><li>jpg： jpg</li><li>jpeg： jpeg</li><li>png： png</li><li>bmp： bmp</li><li>html： html</li><li>txt： txt</li></ul> */ ResourceType: string; /** * 需要进行转换操作的文件资源名称，带资源后缀名。注: <code>资源名称长度限制为256个字符</code> */ ResourceName: string; /** * 需要进行转换操作的文件资源Id，通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。注: <code>目前，此接口仅支持单个文件进行转换。</code> */ ResourceId: string; } /** * 意愿核身问答模式结果。若未使用该意愿核身功能，该字段返回值可以不处理。 */ export interface IntentionQuestionResult { /** * 视频base64（其中包含全程问题和回答音频，mp4格式）注：`需进行base64解码获取视频文件` */ Video?: string; /** * 和答案匹配结果列表 */ ResultCode?: Array<string>; /** * 回答问题语音识别结果列表 */ AsrResult?: Array<string>; } /** * 企业扩展服务授权列表详情 */ export interface AuthInfoDetail { /** * 扩展服务类型，和入参一致 */ Type?: string; /** * 扩展服务名称 */ Name?: string; /** * 授权员工列表 */ HasAuthUserList?: Array<HasAuthUser>; /** * 授权企业列表（企业自动签时，该字段有值） */ HasAuthOrganizationList?: Array<HasAuthOrganization>; /** * 授权员工列表总数 */ AuthUserTotal?: number; /** * 授权企业列表总数 */ AuthOrganizationTotal?: number; } /** * CreateChannelOrganizationInfoChangeUrl返回参数结构体 */ export interface CreateChannelOrganizationInfoChangeUrlResponse { /** * 创建的企业信息变更链接。需要在移动端打开，会跳转到微信腾讯电子签小程序进行更换。 */ Url?: string; /** * 链接过期时间。链接7天有效。 */ ExpiredTime?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 催办接口返回的详细信息。 */ export interface RemindFlowRecords { /** * 合同流程是否可以催办： true - 可以，false - 不可以。若无法催办，将返回RemindMessage以解释原因。 */ CanRemind?: boolean; /** * 合同流程ID，为32位字符串。 */ FlowId?: string; /** * 在合同流程无法催办的情况下，系统将返回RemindMessage以阐述原因。 */ RemindMessage?: string; } /** * ChannelCreateFlowSignUrl返回参数结构体 */ export interface ChannelCreateFlowSignUrlResponse { /** * 签署人签署链接信息 */ FlowApproverUrlInfos?: Array<FlowApproverUrlInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 被授权的用户信息 */ export interface HasAuthUser { /** * 第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。 */ OpenId?: string; } /** * DescribeFileConvertTask返回参数结构体 */ export interface DescribeFileConvertTaskResponse { /** * 任务Id */ TaskId?: string; /** * 任务状态，需要关注的状态枚举值：<ul><li>0： NeedTranform - 任务已提交</li><li>4： Processing - 文档转换中</li><li>8： TaskEnd - 任务处理完成</li><li>-2： DownloadFailed - 下载失败</li><li>-6： ProcessFailed - 转换失败</li><li>-13： ProcessTimeout - 转换文件超时</li></ul> */ TaskStatus?: number; /** * 状态描述，需要关注的状态<ul><li> **NeedTranform** : 任务已提交</li><li> **Processing** : 文档转换中</li><li> **TaskEnd** : 任务处理完成</li><li> **DownloadFailed** : 下载失败</li><li> **ProcessFailed** : 转换失败</li><li> **ProcessTimeout** : 转换文件超时</li></ul> */ TaskMessage?: string; /** * 资源Id（即FileId），用于<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles">用PDF文件创建签署流程</a> */ ResourceId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChannelCreateBatchSignUrl返回参数结构体 */ export interface ChannelCreateBatchSignUrlResponse { /** * 批量签署链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。注: <ol><li>非小程序和APP集成使用</li><li>生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误）</li></ol> */ SignUrl?: string; /** * 链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。 */ ExpiredTime?: number; /** * 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径注: <ol><li>小程序和APP集成使用</li><li>生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误）</li></ol> */ MiniAppPath?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateBatchAdminChangeInvitationsUrl请求参数结构体 */ export interface CreateBatchAdminChangeInvitationsUrlRequest { /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识: Agent.AppId</li></ul> */ Agent: Agent; /** * 组织机构要变更的超管姓名。在超管变更流程中，必须是超管本人进行操作，需要更当前操作人的姓名保持一致。 */ NewAdminName?: string; /** * 组织机构要变更的超管手机号。在超管变更流程中，必须是超管本人进行操作，需要更当前操作人的手机号保持一致。超管手机号和超管证件号二选一必填。注意： 1. 如果新超管的个人身份在电子签进行了手机号的变更，之前提交的超管变更任务将无法获取。 */ NewAdminMobile?: string; /** * 组织机构要变更的超管证件类型支持以下类型<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证) 需要更当前操作人的证件类型保持一致。</li></ul>枚举值：<ul><li>ID_CARD：中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO：中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN：中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>默认值：ID_CARD */ NewAdminIdCardType?: string; /** * 组织机构要变更的超管证件号。在超管变更流程中，必须是超管本人进行操作，需要更当前操作人的证件号保持一致。超管手机号和超管证件号二选一必填。 */ NewAdminIdCardNumber?: string; /** * 要跳转的链接类型<ul><li> **HTTP**：跳转电子签小程序的http_url，短信通知或者H5跳转适合此类型，此时返回长链（默认类型）。</li><li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url，短信通知或者H5跳转适合此类型，此时返回短链。</li><li>**APP**：第三方APP或小程序跳转电子签小程序的path，APP或者小程序跳转适合此类型。</li><li>**QR_CODE**：跳转电子签小程序的http_url的二维码形式，可以在页面展示适合此类型。</li></ul>枚举值：<ul><li>HTTP：跳转电子签小程序的http_url，短信通知或者H5跳转适合此类型，此时返回长链（默认类型）。</li><li>HTTP_SHORT_URL：跳转电子签小程序的http_url，短信通知或者H5跳转适合此类型，此时返回短链。</li><li>APP：第三方APP或小程序跳转电子签小程序的path，APP或者小程序跳转适合此类型。</li><li>QR_CODE：跳转电子签小程序的http_url的二维码形式，可以在页面展示适合此类型。</li></ul>默认值：HTTP */ Endpoint?: string; } /** * ChannelCreatePrepareFlow返回参数结构体 */ export interface ChannelCreatePrepareFlowResponse { /** * 发起的合同嵌入链接，可以直接点击进入进行合同发起，有效期为5分钟 */ PrepareFlowUrl?: string; /** * 合同发起后预览链接，注意此时合同并未发起，仅只是展示效果，有效期为5分钟 */ PreviewFlowUrl?: string; /** * 发起的合同临时Id，只有当点击进入链接，成功发起合同后，此Id才有效 */ FlowId?: string; /** * 临时的草稿id（还未实际保存草稿），用户可以记录此字段对应后续页面保存的草稿，若在页面上未保存草稿，则此字段无效。 */ DraftId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateBatchInitOrganizationUrl返回参数结构体 */ export interface CreateBatchInitOrganizationUrlResponse { /** * 小程序路径，有效时间为7天 */ MiniAppPath?: string; /** * 操作长链，有效时间为7天 */ OperateLongUrl?: string; /** * 操作短链，有效时间为7天 */ OperateShortUrl?: string; /** * 操作二维码，有效时间为7天 */ QRCodeUrl?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 视频认证结果 */ export interface DetectInfoVideoData { /** * 活体视频的base64编码，mp4格式注:`需进行base64解码获取活体视频文件` */ LiveNessVideo?: string; } /** * OperateChannelTemplate返回参数结构体 */ export interface OperateChannelTemplateResponse { /** * 第三方应用平台的应用ID */ AppId?: string; /** * 合同模板ID */ TemplateId?: string; /** * 描述模板可见性更改的结果。 <ul> <li>all-success: 全部成功</li> <li>part-success: 部分成功,失败的会在FailMessageList中展示</li> <li>fail:全部失败, 失败的会在FailMessageList中展示</li> </ul> */ OperateResult?: string; /** * 模板可见范围: **all**: 所有本第三方应用合作企业可见 **part**: 指定的本第三方应用合作企业 */ AuthTag?: string; /** * 第三方平台子客企业标识列表，仅在select 模式下返回 */ ProxyOrganizationOpenIds?: Array<string>; /** * 操作失败信息数组 */ FailMessageList?: Array<AuthFailMessage>; /** * 授权的平台子企业数量，OperateType 为select 时返回。 */ Total?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ChannelCreateDynamicFlowApprover返回参数结构体 */ export interface ChannelCreateDynamicFlowApproverResponse { /** * 动态合同补充结果列表 */ DynamicFlowResultList?: Array<DynamicFlowResult>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 合同组中每个子合同的发起信息 */ export interface FlowFileInfo { /** * 签署文件资源Id列表，目前仅支持单个文件 */ FileIds: Array<string>; /** * 签署流程名称，长度不超过200个字符 */ FlowName: string; /** * 签署流程签约方列表，最多不超过5个参与方 */ FlowApprovers: Array<FlowApproverInfo>; /** * 签署流程截止时间，十位数时间戳，最大值为33162419560，即3020年 */ Deadline?: number; /** * 签署流程的描述，长度不超过1000个字符 */ FlowDescription?: string; /** * 签署流程的类型，长度不超过255个字符枚举值：<ul><li>入职合同：入职合同</li><li>劳动合同：劳动合同</li></ul> */ FlowType?: string; /** * 已废弃，请使用【应用号配置】中的回调地址统一接收消息 * @deprecated */ CallbackUrl?: string; /** * 第三方应用的业务信息，最大长度1000个字符。 */ CustomerData?: string; /** * 合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署 */ Unordered?: boolean; /** * 签署文件中的发起方的填写控件，需要在发起的时候进行填充 */ Components?: Array<Component>; /** * 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始 */ CustomShowMap?: string; /** * 本企业(发起方企业)是否需要签署审批 */ NeedSignReview?: boolean; /** * 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： <ul><li> 0 :合同（默认值）</li> <li> 1 :文件</li> <li> 2 :协议</li><li> 3 :文书</li></ul>效果如下:<img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"> */ FlowDisplayType?: number; } /** * 创建合同个性化参数 */ export interface CreateFlowOption { /** * 是否允许修改合同信息， **true**：可以 **false**：（默认）不可以 */ CanEditFlow?: boolean; /** * 是否允许发起合同弹窗隐藏合同名称 **true**：允许 **false**：（默认）不允许 */ HideShowFlowName?: boolean; /** * 是否允许发起合同弹窗隐藏合同类型， **true**：允许 **false**：（默认）不允许 */ HideShowFlowType?: boolean; /** * 是否允许发起合同弹窗隐藏合同到期时间 **true**：允许 **false**：（默认）不允许 */ HideShowDeadline?: boolean; /** * 是否允许发起合同步骤跳过指定签署方步骤 **true**：允许 **false**：（默认）不允许 */ CanSkipAddApprover?: boolean; /** * 是否可以编辑签署人包括新增，修改，删除 <ul><li>（默认） false -可以编辑签署人</li> <li> true - 禁止编辑签署人</li></ul> 注意： * 如果设置参数为 true，则参数签署人 [FlowApproverList](https://qian.tencent.com/developers/partnerApis/embedPages/ChannelCreatePrepareFlow) 不能为空 * 此参数对子客和自动签无效，不允许进行修改。 */ ForbidEditApprover?: boolean; /** * 定制化发起合同弹窗的描述信息，长度不能超过500，只能由中文、字母、数字和标点组成。 */ CustomCreateFlowDescription?: string; /** * 禁止编辑填写控件 **true**：禁止编辑填写控件 **false**：（默认）允许编辑填写控件 */ ForbidEditFillComponent?: boolean; /** * 跳过上传文件步骤 **true**：跳过 **false**：（默认）不跳过，需要传ResourceId */ SkipUploadFile?: boolean; /** * 签署控件的配置信息，用在嵌入式发起的页面配置，包括 - 签署控件是否默认展示日期. */ SignComponentConfig?: SignComponentConfig; /** * 是否禁止编辑（展示）水印控件属性 <ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul> */ ForbidEditWatermark?: boolean; /** * 发起成功后是否预览合同 <ul><li>（默认） false -否</li> <li> true - 展示预览按钮</li></ul> */ PreviewAfterStart?: boolean; /** * 发起成功之后是否签署合同，仅当前经办人作为签署人时生效 <ul><li>（默认） false -否</li> <li> true - 展示签署按钮</li></ul> */ SignAfterStart?: boolean; /** * 隐藏操作步骤: 具体的控件类型如下 <ul><li>1 : 选择文件及签署方</li> <li>2 : 补充文件内容</li> <li>4 : 发起前合同信息与设置确认</li> </ul> 注：仅对新版页面生效 */ HideOperationSteps?: Array<number | bigint>; /** * 本企业简称，注：仅对新版页面生效 */ SelfName?: string; /** * 发起后签署码隐藏，默认false，注：仅对新版页面生效 */ HideSignCodeAfterStart?: boolean; /** * 发起过程中是否保存草稿 */ NeedFlowDraft?: boolean; /** * 在发起流程的可嵌入页面要隐藏的控件列表，和 ShowComponentTypes 参数只能二选一使用（注: 空数组代表未指定），具体的控件类型如下 <ul><li>SIGN_SIGNATURE : 个人签名/印章</li> <li>SIGN_SEAL : 企业印章</li> <li>SIGN_PAGING_SEAL : 骑缝章</li> <li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li> <li>SIGN_APPROVE : 签批</li> <li>SIGN_OPINION : 签署意见</li> <li>SIGN_PAGING_SIGNATURE : 手写签名骑缝控件</li> <li>BUSI-FULL-NAME : 企业全称</li> <li>BUSI-CREDIT-CODE : 统一社会信用代码</li> <li>BUSI-LEGAL-NAME : 法人/经营者姓名</li> <li>PERSONAL-NAME : 签署人姓名</li> <li>PERSONAL-MOBILE : 签署人手机号</li> <li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li> <li>PERSONAL-IDCARD : 签署人证件号</li> <li>TEXT : 单行文本</li> <li>MULTI_LINE_TEXT : 多行文本</li> <li>CHECK_BOX : 勾选框</li> <li>SELECTOR : 选择器</li> <li>DIGIT : 数字</li> <li>DATE : 日期</li> <li>FILL_IMAGE : 图片</li> <li>ATTACHMENT : 附件</li> <li>EMAIL : 邮箱</li> <li>LOCATION : 地址</li> <li>EDUCATION : 学历</li> <li>GENDER : 性别</li> <li>DISTRICT : 省市区</li></ul> */ HideComponentTypes?: Array<string>; /** * 在发起流程的可嵌入页面要显示的控件列表，和 HideComponentTypes 参数只能二选一使用（注: 空数组代表未指定），具体的控件类型如下 <ul><li>SIGN_SIGNATURE : 个人签名/印章</li> <li>SIGN_SEAL : 企业印章</li> <li>SIGN_PAGING_SEAL : 骑缝章</li> <li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li> <li>SIGN_APPROVE : 签批</li> <li>SIGN_OPINION : 签署意见</li> <li>SIGN_PAGING_SIGNATURE : 手写签名骑缝控件</li> <li>BUSI-FULL-NAME : 企业全称</li> <li>BUSI-CREDIT-CODE : 统一社会信用代码</li> <li>BUSI-LEGAL-NAME : 法人/经营者姓名</li> <li>PERSONAL-NAME : 签署人姓名</li> <li>PERSONAL-MOBILE : 签署人手机号</li> <li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li> <li>PERSONAL-IDCARD : 签署人证件号</li> <li>TEXT : 单行文本</li> <li>MULTI_LINE_TEXT : 多行文本</li> <li>CHECK_BOX : 勾选框</li> <li>SELECTOR : 选择器</li> <li>DIGIT : 数字</li> <li>DATE : 日期</li> <li>FILL_IMAGE : 图片</li> <li>ATTACHMENT : 附件</li> <li>EMAIL : 邮箱</li> <li>LOCATION : 地址</li> <li>EDUCATION : 学历</li> <li>GENDER : 性别</li> <li>DISTRICT : 省市区</li></ul> */ ShowComponentTypes?: Array<string>; /** * 禁止添加签署方，若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮” */ ForbidAddApprover?: boolean; /** * 禁止设置签署流程属性 (顺序、合同签署认证方式等)，若为true则在发起流程的可嵌入页面隐藏签署流程设置面板 */ ForbidEditFlowProperties?: boolean; /** * 发起流程的可嵌入页面结果页配置 */ ResultPageConfig?: CreateResultPageConfig; } /** * ChannelCreateRole请求参数结构体 */ export interface ChannelCreateRoleRequest { /** * 角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。 */ Name: string; /** * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; /** * 角色描述，最大长度为50个字符 */ Description?: string; /** * 权限树，权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出 */ PermissionGroups?: Array<PermissionGroup>; } /** * CreateOrganizationAuthFile返回参数结构体 */ export interface CreateOrganizationAuthFileResponse { /** * 授权书链接，有效期5分钟。 */ FileUrl?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 基础流程信息 */ export interface BaseFlowInfo { /** * 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 */ FlowName: string; /** * 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。 */ Deadline: number; /** * 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。 */ FlowType?: string; /** * 合同流程描述信息(可自定义此描述)，最大长度1000个字符。 */ FlowDescription?: string; /** * 合同流程的签署顺序类型： **false**：(默认)有序签署, 本合同多个参与人需要依次签署 **true**：无序签署, 本合同多个参与人没有先后签署限制 */ Unordered?: boolean; /** * 是否打开智能添加填写区(默认开启，打开:"OPEN" 关闭："CLOSE") */ IntelligentStatus?: string; /** * 填写控件内容，填写的控制的ID-填写的内容对列表 */ FormFields?: Array<FormField>; /** * 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： <ul><li> **false**：（默认）不需要审批，直接签署。</li> <li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul> 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 <ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li> <li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直