tencentcloud-sdk-nodejs 4.1.309 → 4.1.310

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/adp/v20260520/adp_client.js +147 -132
  3. package/es/services/ams/index.js +2 -2
  4. package/es/services/antiddos/index.js +2 -2
  5. package/es/services/btoe/index.js +2 -2
  6. package/es/services/chdfs/index.js +2 -2
  7. package/es/services/cii/index.js +2 -2
  8. package/es/services/dataagent/v20250513/dataagent_client.js +3 -3
  9. package/es/services/dbbrain/index.js +2 -2
  10. package/es/services/dts/index.js +2 -2
  11. package/es/services/emr/v20190103/emr_client.js +11 -5
  12. package/es/services/es/index.js +2 -2
  13. package/es/services/facefusion/index.js +2 -2
  14. package/es/services/ims/index.js +2 -2
  15. package/es/services/iotcloud/index.js +2 -2
  16. package/es/services/iotvideo/index.js +2 -2
  17. package/es/services/irp/index.js +2 -2
  18. package/es/services/monitor/index.js +2 -2
  19. package/es/services/organization/index.js +2 -2
  20. package/es/services/rce/index.js +4 -4
  21. package/es/services/teo/index.js +2 -2
  22. package/es/services/thpc/index.js +2 -2
  23. package/es/services/tione/index.js +2 -2
  24. package/es/services/tke/index.js +2 -2
  25. package/es/services/tms/index.js +2 -2
  26. package/es/services/tsw/index.js +2 -2
  27. package/es/services/vm/index.js +2 -2
  28. package/es/services/yunsou/index.js +2 -2
  29. package/package.json +1 -1
  30. package/tencentcloud/common/sdk_version.d.ts +1 -1
  31. package/tencentcloud/common/sdk_version.js +1 -1
  32. package/tencentcloud/services/adp/v20260520/adp_client.d.ts +169 -149
  33. package/tencentcloud/services/adp/v20260520/adp_client.js +251 -221
  34. package/tencentcloud/services/adp/v20260520/adp_models.d.ts +607 -43
  35. package/tencentcloud/services/ams/index.d.ts +4 -4
  36. package/tencentcloud/services/ams/index.js +2 -2
  37. package/tencentcloud/services/antiddos/index.d.ts +4 -4
  38. package/tencentcloud/services/antiddos/index.js +2 -2
  39. package/tencentcloud/services/btoe/index.d.ts +4 -4
  40. package/tencentcloud/services/btoe/index.js +2 -2
  41. package/tencentcloud/services/chdfs/index.d.ts +4 -4
  42. package/tencentcloud/services/chdfs/index.js +2 -2
  43. package/tencentcloud/services/cii/index.d.ts +4 -4
  44. package/tencentcloud/services/cii/index.js +2 -2
  45. package/tencentcloud/services/cloudstudio/v20230508/cloudstudio_models.d.ts +14 -18
  46. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +4 -0
  47. package/tencentcloud/services/dataagent/v20250513/dataagent_client.d.ts +5 -5
  48. package/tencentcloud/services/dataagent/v20250513/dataagent_client.js +6 -6
  49. package/tencentcloud/services/dataagent/v20250513/dataagent_models.d.ts +93 -164
  50. package/tencentcloud/services/dbbrain/index.d.ts +4 -4
  51. package/tencentcloud/services/dbbrain/index.js +2 -2
  52. package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +9 -9
  53. package/tencentcloud/services/dbdc/v20201029/dbdc_models.d.ts +27 -3
  54. package/tencentcloud/services/dts/index.d.ts +4 -4
  55. package/tencentcloud/services/dts/index.js +2 -2
  56. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +15 -7
  57. package/tencentcloud/services/emr/v20190103/emr_client.js +21 -9
  58. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +260 -128
  59. package/tencentcloud/services/es/index.d.ts +4 -4
  60. package/tencentcloud/services/es/index.js +2 -2
  61. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +17 -7
  62. package/tencentcloud/services/ess/v20201111/ess_client.js +17 -7
  63. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +64 -93
  64. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +53 -15
  65. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +53 -15
  66. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +28 -21
  67. package/tencentcloud/services/facefusion/index.d.ts +4 -4
  68. package/tencentcloud/services/facefusion/index.js +2 -2
  69. package/tencentcloud/services/hai/v20230812/hai_models.d.ts +1 -1
  70. package/tencentcloud/services/ims/index.d.ts +4 -4
  71. package/tencentcloud/services/ims/index.js +2 -2
  72. package/tencentcloud/services/ioa/v20220601/ioa_models.d.ts +72 -0
  73. package/tencentcloud/services/iotcloud/index.d.ts +4 -4
  74. package/tencentcloud/services/iotcloud/index.js +2 -2
  75. package/tencentcloud/services/iotvideo/index.d.ts +4 -4
  76. package/tencentcloud/services/iotvideo/index.js +2 -2
  77. package/tencentcloud/services/irp/index.d.ts +4 -4
  78. package/tencentcloud/services/irp/index.js +2 -2
  79. package/tencentcloud/services/lkeap/v20240522/lkeap_client.d.ts +1 -1
  80. package/tencentcloud/services/lkeap/v20240522/lkeap_client.js +1 -1
  81. package/tencentcloud/services/monitor/index.d.ts +4 -4
  82. package/tencentcloud/services/monitor/index.js +2 -2
  83. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +294 -232
  84. package/tencentcloud/services/organization/index.d.ts +4 -4
  85. package/tencentcloud/services/organization/index.js +2 -2
  86. package/tencentcloud/services/rce/index.d.ts +6 -6
  87. package/tencentcloud/services/rce/index.js +4 -4
  88. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +1 -1
  89. package/tencentcloud/services/teo/index.d.ts +4 -4
  90. package/tencentcloud/services/teo/index.js +2 -2
  91. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +2 -2
  92. package/tencentcloud/services/teo/v20220901/teo_client.js +2 -2
  93. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +12 -12
  94. package/tencentcloud/services/thpc/index.d.ts +4 -4
  95. package/tencentcloud/services/thpc/index.js +2 -2
  96. package/tencentcloud/services/tione/index.d.ts +4 -4
  97. package/tencentcloud/services/tione/index.js +2 -2
  98. package/tencentcloud/services/tke/index.d.ts +4 -4
  99. package/tencentcloud/services/tke/index.js +2 -2
  100. package/tencentcloud/services/tms/index.d.ts +4 -4
  101. package/tencentcloud/services/tms/index.js +2 -2
  102. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +17 -4
  103. package/tencentcloud/services/tsw/index.d.ts +4 -4
  104. package/tencentcloud/services/tsw/index.js +2 -2
  105. package/tencentcloud/services/vm/index.d.ts +4 -4
  106. package/tencentcloud/services/vm/index.js +2 -2
  107. package/tencentcloud/services/yunsou/index.d.ts +4 -4
  108. package/tencentcloud/services/yunsou/index.js +2 -2
@@ -2146,21 +2146,25 @@ export interface RegistrationOrganizationInfo {
2146
2146
  */
2147
2147
  export interface TemplateUserFlowType {
2148
2148
  /**
2149
- * 合同类型id
2149
+ * <p>合同类型id</p>
2150
2150
  */
2151
2151
  UserFlowTypeId?: string;
2152
2152
  /**
2153
- * 合同类型名称
2153
+ * <p>合同类型名称</p>
2154
2154
  */
2155
2155
  Name?: string;
2156
2156
  /**
2157
- * 合同类型的具体描述
2157
+ * <p>合同类型的具体描述</p>
2158
2158
  */
2159
2159
  Description?: string;
2160
2160
  /**
2161
- * 每个合同类型绑定的模板数量
2161
+ * <p>每个合同类型绑定的模板数量</p>
2162
2162
  */
2163
2163
  TemplateNum?: number;
2164
+ /**
2165
+ * <p>自定义合同类型状态</p><p>枚举值:</p><ul><li>0: 未启用</li><li>1: 启用</li></ul>
2166
+ */
2167
+ Status?: number;
2164
2168
  }
2165
2169
  /**
2166
2170
  * ModifyIntegrationRole请求参数结构体
@@ -4185,6 +4189,10 @@ export interface DescribeFlowTemplatesRequest {
4185
4189
  * <p>是否获取模板预览链接。</p><ul><li><strong>false</strong>:不获取(默认)</li><li><strong>true</strong>:需要获取</li></ul>设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
4186
4190
  */
4187
4191
  WithPreviewUrl?: boolean;
4192
+ /**
4193
+ * <p>是否在模板预览页面展示模板控件。<br><br><ul><li><strong>false</strong>:不展示(默认),返回嵌入式预览链接,预览页面仅显示模板文件内容<br><img src="https://qcloudimg.tencent-cloud.cn/raw/7524b0fba5ad2b83a53ee9d7d486d233.png" alt="ShowTemplateControls=false"></li><li><strong>true</strong>:展示,返回嵌入式预览链接,预览页面在文件上叠加展示模板中的填写控件与签署控件,并增加模拟签署的特性。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/ff1b707408f9b3a7ef2e39b8ad659135.png" alt="ShowTemplateControls=true"></li></ul><br>注:仅在 <strong>WithPreviewUrl=true</strong> 时生效;当 <strong>WithPreviewUrl=false</strong> 时不生成预览链接,本参数被忽略。<br><br><strong>适用场景</strong>:当业务方需要在发起合同前预览模板中各角色的填写控件与签署控件的位置和布局,以便确认用户使用模板的控件配置是否正确时,可将此参数设置为 true。<br>示例值:false</p>
4194
+ */
4195
+ ShowPreviewComponents?: boolean;
4188
4196
  }
4189
4197
  /**
4190
4198
  * DescribeFlowEvidenceReport返回参数结构体
@@ -5951,7 +5959,7 @@ export interface Component {
5951
5959
  */
5952
5960
  ComponentRecipientId?: string;
5953
5961
  /**
5954
- * <p><strong>在所有的定位方式下</strong>,控件的扩展参数,为<font color="red">JSON格式</font>,不同类型的控件会有部分非通用参数。</p><p><font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:</p><ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>: 范围6 :72</li><li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li><li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li><li> <b>Bold</b>是否加粗:true/false</li></ul><b>参数样例</b>:<code>{&quot;FontColor&quot;:&quot;255,0,0&quot;,&quot;FontSize&quot;:12,&quot;Bold&quot;:false}</code><p><font color="red">ComponentType为DATE时</font>,支持以下参数:</p><ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>: 范围6 :72</li></ul><b>参数样例</b>:<code>{&quot;FontColor&quot;:&quot;255,0,0&quot;,&quot;FontSize&quot;:12}</code><p><font color="red">ComponentType为WATERMARK时</font>,支持以下参数:</p><ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>: 范围6 :72</li><li> <b>Opacity</b>: 透明度,范围0 :1</li><li> <b>Rotate</b>: 水印旋转角度,范围0 :359</li><li> <b>Density</b>: 水印样式,1-宽松,2-标准(默认值),3-密集,</li><li> <b>Position</b>: 水印位置,None-平铺(默认值),LeftTop-左上,LeftBottom-左下,RightTop-右上,RightBottom-右下,Center-居中</li><li> <b>SubType</b>: 水印类型:CUSTOM_WATERMARK-自定义内容,PERSON_INFO_WATERMARK-访问者信息</li></ul><b>参数样例</b>:<code>&quot;{\&quot;Font\&quot;:\&quot;黑体\&quot;,\&quot;FontSize\&quot;:20,\&quot;Opacity\&quot;:0.1,\&quot;Density\&quot;:2,\&quot;SubType\&quot;:\&quot;PERSON_INFO_WATERMARK\&quot;}&quot;</code><p><font color="red">ComponentType为FILL_IMAGE时</font>,支持以下参数:</p><ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li><li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul><p><font color="red">ComponentType为SELECTOR时</font>,支持以下参数:</p><ul><li> <b>WordWrap</b>:bool。是否支持选择控件内容自动折行合成。false:不支持(默认)。 true : 支持自动折行合成</li></ul><p><font color="red">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>,可以通过<strong>ComponentTypeLimit</strong>参数控制签名方式</p><ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li><li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li><li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li><li> <b>ESIGN</b> : 个人印章类型</li><li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li><li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul><b>参考样例</b>:<code>{&quot;ComponentTypeLimit&quot;: [&quot;SYSTEM_ESIGN&quot;]}</code>印章的对应关系参考下图![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br><p><font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过<strong>ComponentTypeLimit</strong>参数控制签署方签署时要使用的印章类型,支持指定以下印章类型</p><ul><li> <b>OFFICIAL</b> : 企业公章</li><li> <b>CONTRACT</b> : 合同专用章</li><li> <b>FINANCE</b> : 财务专用章</li><li> <b>PERSONNEL</b> : 人事专用章</li><li> <b>OTHER</b> : 其他</li></ul><b>参考样例</b>:<code>{\&quot;ComponentTypeLimit\&quot;:[\&quot;PERSONNEL\&quot;,\&quot;FINANCE\&quot;]}</code> 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br><p><font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:</p><ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"、"仿宋",如果不填默认为"黑体"</li><li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li><li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li><li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li><li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)<b>参数样例</b>: <code>&quot;{&quot;Format&quot;:&quot;yyyy m d&quot;,&quot;FontSize&quot;:12,&quot;Gaps&quot;:&quot;2,2&quot;, &quot;FontAlign&quot;:&quot;Right&quot;}&quot;</code><p><font color="red">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>,支持以下参数:</p><ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul><b>参数样例</b>:<code>&quot;{&quot;PageRanges&quot;:[{&quot;BeginPage&quot;:1,&quot;EndPage&quot;:-1}]}&quot;</code><p><font color="red">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:</p><ul><li> <b>Opacity</b>:印章透明度,支持范围:0.6-1,0.7表示70%的透明度,1表示无透明度</li></ul><b>参数样例</b>:<code>{&quot;Opacity&quot;:0.7}</code><p><font color="red">签署印章大小功能设置,</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:</p><ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul><b>参数样例</b>:<code>{&quot;UseSealSize&quot;:true}</code><p><font color="red">签署意见功能设置,</font>当ComponentType为SIGN_OPINION时,可以通过以下参数设置签署意见的相关内容:</p><ul><li> <b>Values</b>:签署意见预设的需要用户填写的文本</li><li> <b>ValuesArray</b>:签署意见需要用户按顺序点击的分词(组合后应和Values内容一致)</li></ul><b>参数样例</b>:<code>{&quot;Values&quot;:&quot;我已知晓内容并同意签署&quot;,&quot;ValuesArray&quot;:[&quot;我&quot;,&quot;已知晓&quot;,&quot;内容&quot;,&quot;并&quot;,&quot;同意&quot;,&quot;签署&quot;]}</code><p><font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font></p><ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。<b>参数样例</b>:<code>&quot;{&quot;IgnoreKeywordError&quot;:1}&quot;</code><p><font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时</font>,支持以下参数:</p><ul><li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li><b>参数样例</b>:<br><code>{&quot;Children&quot;:[&quot;ComponentId_29&quot;,&quot;ComponentId_27&quot;,&quot;ComponentId_28&quot;,&quot;ComponentId_30&quot;]}</code><li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </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><b>参数样例</b>:<p>输入:</p><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>
5962
+ * <p><strong>在所有的定位方式下</strong>,控件的扩展参数,为<font color="red">JSON格式</font>,不同类型的控件会有部分非通用参数。</p><p><font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:</p><ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>: 范围6 :72</li><li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li><li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li><li> <b>Bold</b>是否加粗:true/false</li></ul><b>参数样例</b>:<code>{&quot;FontColor&quot;:&quot;255,0,0&quot;,&quot;FontSize&quot;:12,&quot;Bold&quot;:false}</code><p><font color="red">ComponentType为DATE时</font>,支持以下参数:</p><ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>: 范围6 :72</li></ul><b>参数样例</b>:<code>{&quot;FontColor&quot;:&quot;255,0,0&quot;,&quot;FontSize&quot;:12}</code><p><font color="red">ComponentType为WATERMARK时</font>,支持以下参数:</p><ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>: 范围6 :72</li><li> <b>Opacity</b>: 透明度,范围0 :1</li><li> <b>Rotate</b>: 水印旋转角度,范围0 :359</li><li> <b>Density</b>: 水印样式,1-宽松,2-标准(默认值),3-密集,</li><li> <b>Position</b>: 水印位置,None-平铺(默认值),LeftTop-左上,LeftBottom-左下,RightTop-右上,RightBottom-右下,Center-居中</li><li> <b>SubType</b>: 水印类型:CUSTOM_WATERMARK-自定义内容,PERSON_INFO_WATERMARK-访问者信息</li></ul><b>参数样例</b>:<code>&quot;{\&quot;Font\&quot;:\&quot;黑体\&quot;,\&quot;FontSize\&quot;:20,\&quot;Opacity\&quot;:0.1,\&quot;Density\&quot;:2,\&quot;SubType\&quot;:\&quot;PERSON_INFO_WATERMARK\&quot;}&quot;</code><p><font color="red">ComponentType为FILL_IMAGE时</font>,支持以下参数:</p><ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li><li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul><p><font color="red">ComponentType为SELECTOR时</font>,支持以下参数:</p><ul><li> <b>WordWrap</b>:bool。是否支持选择控件内容自动折行合成。false:不支持(默认)。 true : 支持自动折行合成</li></ul><p><font color="red">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>,可以通过<strong>ComponentTypeLimit</strong>参数控制签名方式</p><ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li><li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li><li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li><li> <b>ESIGN</b> : 个人印章类型</li><li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li><li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul><b>参考样例</b>:<code>{&quot;ComponentTypeLimit&quot;: [&quot;SYSTEM_ESIGN&quot;]}</code>印章的对应关系参考下图![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br><p><font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过<strong>ComponentTypeLimit</strong>参数控制签署方签署时要使用的印章类型,支持指定以下印章类型</p><ul><li> <b>OFFICIAL</b> : 企业公章</li><li> <b>CONTRACT</b> : 合同专用章</li><li> <b>FINANCE</b> : 财务专用章</li><li> <b>PERSONNEL</b> : 人事专用章</li><li> <b>OTHER</b> : 其他</li></ul><b>参考样例</b>:<code>{\&quot;ComponentTypeLimit\&quot;:[\&quot;PERSONNEL\&quot;,\&quot;FINANCE\&quot;]}</code> 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br><p><font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:</p><ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"、"仿宋",如果不填默认为"黑体"</li><li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li><li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li><li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”,”yyyy m d HH:MM:SS”,”yyyy/m/d HH:MM:SS”,”yyyy-m-d HH:MM:SS”,”yyyy.m.d HH:MM:SS”。</li><li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)<b>参数样例</b>: <code>&quot;{&quot;Format&quot;:&quot;yyyy m d&quot;,&quot;FontSize&quot;:12,&quot;Gaps&quot;:&quot;2,2&quot;, &quot;FontAlign&quot;:&quot;Right&quot;}&quot;</code><p><font color="red">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>,支持以下参数:</p><ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul><b>参数样例</b>:<code>&quot;{&quot;PageRanges&quot;:[{&quot;BeginPage&quot;:1,&quot;EndPage&quot;:-1}]}&quot;</code><p><font color="red">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:</p><ul><li> <b>Opacity</b>:印章透明度,支持范围:0.6-1,0.7表示70%的透明度,1表示无透明度</li></ul><b>参数样例</b>:<code>{&quot;Opacity&quot;:0.7}</code><p><font color="red">签署印章大小功能设置,</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:</p><ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul><b>参数样例</b>:<code>{&quot;UseSealSize&quot;:true}</code><p><font color="red">签署意见功能设置,</font>当ComponentType为SIGN_OPINION时,可以通过以下参数设置签署意见的相关内容:</p><ul><li> <b>Values</b>:签署意见预设的需要用户填写的文本</li><li> <b>ValuesArray</b>:签署意见需要用户按顺序点击的分词(组合后应和Values内容一致)</li><li> <b>SignMethod</b>:签署方式,目前支持1-词组拼接方式</li></ul><b>参数样例</b>:<code>{&quot;Values&quot;:&quot;我已知晓内容并同意签署&quot;,&quot;ValuesArray&quot;:[&quot;我&quot;,&quot;已知晓&quot;,&quot;内容&quot;,&quot;并&quot;,&quot;同意&quot;,&quot;签署&quot;],&quot;SignMethod&quot;:1}</code><p><font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font></p><ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。<b>参数样例</b>:<code>&quot;{&quot;IgnoreKeywordError&quot;:1}&quot;</code><p><font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时</font>,支持以下参数:</p><ul><li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li><b>参数样例</b>:<br><code>{&quot;Children&quot;:[&quot;ComponentId_29&quot;,&quot;ComponentId_27&quot;,&quot;ComponentId_28&quot;,&quot;ComponentId_30&quot;]}</code><li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </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><b>参数样例</b>:<p>输入:</p><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>
5955
5963
  */
5956
5964
  ComponentExtra?: string;
5957
5965
  /**
@@ -7233,7 +7241,7 @@ export interface CreateFlowOption {
7233
7241
  */
7234
7242
  SignAfterStart?: boolean;
7235
7243
  /**
7236
- * <p>发起过程中是否保存草稿</p>
7244
+ * <p>发起过程中是否展示“保存草稿”按钮<br><img src="https://qcloudimg.tencent-cloud.cn/raw/9e863549f7f53c8bab2fa3c4b43c1715.png" alt="image"></p><ol><li>点击保存后,可以通过CreatePrepareFlow返回的DraftId保存草稿id</li><li>可以用于二次发起合同: <a href="https://qian.tencent.com/developers/companyApis/embedPages/CreatePrepareFlow/">CreatePrepareFlow</a>,ResourceType =3 //草稿</li></ol>
7237
7245
  */
7238
7246
  NeedFlowDraft?: boolean;
7239
7247
  /**
@@ -7332,7 +7340,7 @@ export interface CreateOrganizationAuthUrlRequest {
7332
7340
  */
7333
7341
  AutoJumpUrl?: string;
7334
7342
  /**
7335
- * <p>营业执照企业地址</p>
7343
+ * <p>营业执照企业地址</p><p>入参限制:最大长度500个字符</p>
7336
7344
  */
7337
7345
  OrganizationAddress?: string;
7338
7346
  /**
@@ -7719,142 +7727,103 @@ export interface DescribeBatchOrganizationRegistrationUrlsRequest {
7719
7727
  */
7720
7728
  export interface TemplateInfo {
7721
7729
  /**
7722
- * 模板ID,模板的唯一标识
7730
+ * <p>模板ID,模板的唯一标识</p>
7723
7731
  */
7724
7732
  TemplateId?: string;
7725
7733
  /**
7726
- * 模板的名字
7734
+ * <p>模板的名字</p>
7727
7735
  */
7728
7736
  TemplateName?: string;
7729
7737
  /**
7730
- * 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。
7731
-
7732
- [点击查看在模板中配置的签署参与方角色列表的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)
7733
-
7734
-
7738
+ * <p>此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png">点击查看在模板中配置的签署参与方角色列表的样子</a></p>
7735
7739
  */
7736
7740
  Recipients?: Array<Recipient>;
7737
7741
  /**
7738
- * 模板的填充控件列表
7739
-
7740
- [点击查看在模板中配置的填充控件的样子](https://qcloudimg.tencent-cloud.cn/raw/cb2f58529fca8d909258f9d45a56f7f4.png)
7742
+ * <p>模板的填充控件列表</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/cb2f58529fca8d909258f9d45a56f7f4.png">点击查看在模板中配置的填充控件的样子</a></p>
7741
7743
  */
7742
7744
  Components?: Array<Component>;
7743
7745
  /**
7744
- * 此模板中的签署控件列表
7745
-
7746
- [点击查看在模板中配置的签署控件的样子](https://qcloudimg.tencent-cloud.cn/raw/29bc6ed753a5a0fce4a3ab02e2c0d955.png)
7746
+ * <p>此模板中的签署控件列表</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/29bc6ed753a5a0fce4a3ab02e2c0d955.png">点击查看在模板中配置的签署控件的样子</a></p>
7747
7747
  */
7748
7748
  SignComponents?: Array<Component>;
7749
7749
  /**
7750
- * 模板描述信息
7750
+ * <p>模板描述信息</p>
7751
7751
  */
7752
7752
  Description?: string;
7753
7753
  /**
7754
- * 此模板的资源ID
7754
+ * <p>此模板的资源ID</p>
7755
7755
  */
7756
7756
  DocumentResourceIds?: Array<string>;
7757
7757
  /**
7758
- * 生成模板的文件基础信息
7758
+ * <p>生成模板的文件基础信息</p>
7759
7759
  */
7760
7760
  FileInfos?: Array<FileInfo>;
7761
7761
  /**
7762
- * 此模板里边附件的资源ID
7762
+ * <p>此模板里边附件的资源ID</p>
7763
7763
  */
7764
7764
  AttachmentResourceIds?: Array<string>;
7765
7765
  /**
7766
- * 签署人参与签署的顺序,可以分为以下两种方式:
7767
-
7768
- <b>无序</b>:不限定签署人的签署顺序,签署人可以在任何时间签署。此种方式值为 :{-1}
7769
- <b>有序</b>:通过序列数字标识签署顺序,从0开始编码,数字越大签署顺序越靠后,签署人按照指定的顺序依次签署。此种方式值为: {0,1,2,3………}
7766
+ * <p>签署人参与签署的顺序,可以分为以下两种方式:</p><p><b>无序</b>:不限定签署人的签署顺序,签署人可以在任何时间签署。此种方式值为 :{-1}<br><b>有序</b>:通过序列数字标识签署顺序,从0开始编码,数字越大签署顺序越靠后,签署人按照指定的顺序依次签署。此种方式值为: {0,1,2,3………}</p>
7770
7767
  */
7771
7768
  SignOrder?: Array<number | bigint>;
7772
7769
  /**
7773
- * 此模板的状态可以分为以下几种:
7774
-
7775
- <b>-1</b>:不可用状态。
7776
- <b>0</b>:草稿态,即模板正在编辑或未发布状态。
7777
- <b>1</b>:正式态,只有正式态的模板才可以发起合同。
7770
+ * <p>此模板的状态可以分为以下几种:</p><p><b>-1</b>:不可用状态。<br><b>0</b>:草稿态,即模板正在编辑或未发布状态。<br><b>1</b>:正式态,只有正式态的模板才可以发起合同。</p>
7778
7771
  */
7779
7772
  Status?: number;
7780
7773
  /**
7781
- * 模板的创建者信息,用户的名字
7782
-
7783
- 注: `是创建者的名字,而非创建者的用户ID`
7774
+ * <p>模板的创建者信息,用户的名字</p><p>注: <code>是创建者的名字,而非创建者的用户ID</code></p>
7784
7775
  */
7785
7776
  Creator?: string;
7786
7777
  /**
7787
- * 模板创建的时间戳,格式为Unix标准时间戳(秒)
7778
+ * <p>模板创建的时间戳,格式为Unix标准时间戳(秒)</p>
7788
7779
  */
7789
7780
  CreatedOn?: number;
7790
7781
  /**
7791
- * 此模板创建方角色信息。
7792
-
7793
- [点击查看在模板中配置的创建方角色的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)
7794
-
7782
+ * <p>此模板创建方角色信息。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png">点击查看在模板中配置的创建方角色的样子</a></p>
7795
7783
  */
7796
7784
  Promoter?: Recipient;
7797
7785
  /**
7798
- * 模板类型可以分为以下两种:
7799
-
7800
- <b>1</b>:带有本企业自动签署的模板,即签署过程无需签署人手动操作,系统自动完成签署。
7801
- <b>3</b>:普通模板,即签署人需要手动进行签署操作。
7786
+ * <p>模板类型可以分为以下两种:</p><p><b>1</b>:带有本企业自动签署的模板,即签署过程无需签署人手动操作,系统自动完成签署。<br><b>3</b>:普通模板,即签署人需要手动进行签署操作。</p>
7802
7787
  */
7803
7788
  TemplateType?: number;
7804
7789
  /**
7805
- * 模板可用状态可以分为以下两种:
7806
-
7807
- <b>1</b>:(默认)启用状态,即模板可以正常使用。
7808
- <b>2</b>:停用状态,即模板暂时无法使用。
7809
-
7810
- 可到控制台启停模板
7790
+ * <p>模板可用状态可以分为以下两种:</p><p><b>1</b>:(默认)启用状态,即模板可以正常使用。<br><b>2</b>:停用状态,即模板暂时无法使用。</p><p>可到控制台启停模板</p>
7811
7791
  */
7812
7792
  Available?: number;
7813
7793
  /**
7814
- * 创建模板的企业ID,电子签的机构ID
7794
+ * <p>创建模板的企业ID,电子签的机构ID</p>
7815
7795
  */
7816
7796
  OrganizationId?: string;
7817
7797
  /**
7818
- * 模板创建人用户ID
7798
+ * <p>模板创建人用户ID</p>
7819
7799
  */
7820
7800
  CreatorId?: string;
7821
7801
  /**
7822
- * 模板的 H5 预览链接,有效期为 5 分钟。
7823
- 您可以通过浏览器直接打开此链接预览模板,或将其嵌入到 iframe 中进行预览。
7824
-
7825
- 注意:只有在请求接口时将 <b>WithPreviewUrl </b>参数设置为 true,才会生成预览链接。
7802
+ * <p>模板的 H5 预览链接,有效期为 5 分钟。<br>您可以通过浏览器直接打开此链接预览模板,或将其嵌入到 iframe 中进行预览。</p><p>注意:只有在请求接口时将 <b>WithPreviewUrl </b>参数设置为 true,才会生成预览链接。</p>
7826
7803
  */
7827
7804
  PreviewUrl?: string;
7828
7805
  /**
7829
- * 用户自定义合同类型。
7830
-
7831
- 返回配置模板的时候选择的合同类型。[点击查看配置的位置](https://qcloudimg.tencent-cloud.cn/raw/4a766f0540253bf2a05d50c58bd14990.png)
7832
-
7833
- 自定义合同类型配置的地方如链接图所示。[点击查看自定义合同类型管理的位置](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png)
7834
-
7806
+ * <p>用户自定义合同类型。</p><p>返回配置模板的时候选择的合同类型。<a href="https://qcloudimg.tencent-cloud.cn/raw/4a766f0540253bf2a05d50c58bd14990.png">点击查看配置的位置</a></p><p>自定义合同类型配置的地方如链接图所示。<a href="https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png">点击查看自定义合同类型管理的位置</a></p>
7835
7807
  */
7836
7808
  UserFlowType?: UserFlowType;
7837
7809
  /**
7838
- * 模板版本的编号,旨在标识其独特的版本信息,通常呈现为一串字符串,由日期和递增的数字组成
7810
+ * <p>模板版本的编号,旨在标识其独特的版本信息,通常呈现为一串字符串,由日期和递增的数字组成</p>
7839
7811
  */
7840
7812
  TemplateVersion?: string;
7841
7813
  /**
7842
- * 模板是否已发布可以分为以下两种状态:
7843
-
7844
- <b>true</b>:已发布状态,表示该模板已经发布并可以正常使用。
7845
- <b>false</b>:未发布状态,表示该模板还未发布,无法使用。
7814
+ * <p>模板是否已发布可以分为以下两种状态:</p><p><b>true</b>:已发布状态,表示该模板已经发布并可以正常使用。<br><b>false</b>:未发布状态,表示该模板还未发布,无法使用。</p>
7846
7815
  */
7847
7816
  Published?: boolean;
7848
7817
  /**
7849
- * <b>集体账号场景下</b>: 集团账号分享给子企业的模板的来源模板ID
7818
+ * <p><b>集体账号场景下</b>: 集团账号分享给子企业的模板的来源模板ID。</p>
7850
7819
  */
7851
7820
  ShareTemplateId?: string;
7852
7821
  /**
7853
- * 此模板配置的预填印章列表(包括自动签署指定的印章)
7822
+ * <p>此模板配置的预填印章列表(包括自动签署指定的印章)</p>
7854
7823
  */
7855
7824
  TemplateSeals?: Array<SealInfo>;
7856
7825
  /**
7857
- * 模板内部指定的印章列表
7826
+ * <p>模板内部指定的印章列表</p>
7858
7827
  注意:此字段可能返回 null,表示取不到有效值。
7859
7828
  * @deprecated
7860
7829
  */
@@ -11158,11 +11127,11 @@ export interface DescribeOrganizationSealsResponse {
11158
11127
  */
11159
11128
  export interface DescribeBillUsageDetailRequest {
11160
11129
  /**
11161
- * <p>查询开始时间字符串,格式为yyyyMMdd,时间跨度不能大于31天。<span style="color: red;">注意:从 2026年10月10日起,开始日期和结束日期必须在同一个自然月内,不支持跨月查询。</span></p><ul><li><p>正确示例:StartTime=20260901,EndTime=20260930。开始和结束日期都在 2026年9月,可以查询。</p></li><li><p>错误示例:StartTime=20260815,EndTime=20260915。开始日期在8月,结束日期在9月,属于跨月查询,不支持。</p></li></ul><p>参数格式:yyyyMMdd</p>
11130
+ * <p>查询开始时间字符串,格式为yyyyMMdd,时间跨度不能大于31天。<font color="red">注意:从 2026年10月10日起,开始日期和结束日期必须在同一个自然月内,不支持跨月查询。</font></p><ul><li><p>正确示例:StartTime=20260901,EndTime=20260930。开始和结束日期都在 2026年9月,可以查询。</p></li><li><p>错误示例:StartTime=20260815,EndTime=20260915。开始日期在8月,结束日期在9月,属于跨月查询,不支持。</p></li></ul><p>参数格式:yyyyMMdd</p>
11162
11131
  */
11163
11132
  StartTime: string;
11164
11133
  /**
11165
- * <p>查询结束时间字符串,格式为yyyyMMdd,时间跨度不能大于31天。<span style="color: red;">注意:从 2026年10月10日起,开始日期和结束日期必须在同一个自然月内,不支持跨月查询。</span></p><ul><li><p>正确示例:StartTime=20260901,EndTime=20260930。开始和结束日期都在 2026年9月,可以查询。</p></li><li><p>错误示例:StartTime=20260815,EndTime=20260915。开始日期在8月,结束日期在9月,属于跨月查询,不支持。</p></li></ul><p>参数格式:yyyyMMdd</p>
11134
+ * <p>查询结束时间字符串,格式为yyyyMMdd,时间跨度不能大于31天。<font color="red">注意:从 2026年10月10日起,开始日期和结束日期必须在同一个自然月内,不支持跨月查询。</font></p><ul><li><p>正确示例:StartTime=20260901,EndTime=20260930。开始和结束日期都在 2026年9月,可以查询。</p></li><li><p>错误示例:StartTime=20260815,EndTime=20260915。开始日期在8月,结束日期在9月,属于跨月查询,不支持。</p></li></ul><p>参数格式:yyyyMMdd</p>
11166
11135
  */
11167
11136
  EndTime: string;
11168
11137
  /**
@@ -11826,6 +11795,10 @@ export interface CreatePreparedPersonalEsignRequest {
11826
11795
  * <p>印章名称,长度1-50个字。</p>
11827
11796
  */
11828
11797
  SealName: string;
11798
+ /**
11799
+ * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
11800
+ */
11801
+ Agent?: Agent;
11829
11802
  /**
11830
11803
  * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
11831
11804
  */
@@ -11834,24 +11807,14 @@ export interface CreatePreparedPersonalEsignRequest {
11834
11807
  * <p>证件类型,支持以下类型</p><ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同 中国大陆居民身份证)</li></ul>
11835
11808
  */
11836
11809
  IdCardType?: string;
11837
- /**
11838
- * <p>该字段已不再使用</p>
11839
- * @deprecated
11840
- */
11841
- SealImage?: string;
11842
- /**
11843
- * <p>是否开启印章图片压缩处理,默认不开启,如需开启请设置为 true。当印章超过 2M 时建议开启,开启后图片的 hash 将发生变化。</p>
11844
- */
11845
- SealImageCompress?: boolean;
11846
11810
  /**
11847
11811
  * <p>手机号码;当需要开通自动签时,该参数必传</p>
11848
11812
  */
11849
11813
  Mobile?: string;
11850
11814
  /**
11851
- * <p>该字段已不再使用</p>
11852
- * @deprecated
11815
+ * <p>印章图片文件 id<br>取值:<br>填写的FileId通过UploadFiles接口上传文件获取。</p>
11853
11816
  */
11854
- EnableAutoSign?: boolean;
11817
+ FileId?: string;
11855
11818
  /**
11856
11819
  * <p>印章颜色(参数ProcessSeal=true时生效)<br>默认值:BLACK黑色<br>取值:<br>BLACK 黑色,<br>RED 红色,<br>BLUE 蓝色。</p>
11857
11820
  */
@@ -11861,21 +11824,29 @@ export interface CreatePreparedPersonalEsignRequest {
11861
11824
  */
11862
11825
  ProcessSeal?: boolean;
11863
11826
  /**
11864
- * <p>印章图片文件 id<br>取值:<br>填写的FileId通过UploadFiles接口上传文件获取。</p>
11827
+ * <p>自动签使用的场景值, 可以选择的场景值如下:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul><p>注: <code>不传默认为处方单场景,即E_PRESCRIPTION_AUTO_SIGN</code></p>
11865
11828
  */
11866
- FileId?: string;
11829
+ SceneKey?: string;
11867
11830
  /**
11868
- * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
11831
+ * <p>该字段已不再使用,设置不生效。</p>
11832
+ * @deprecated
11869
11833
  */
11870
- Agent?: Agent;
11834
+ LicenseType?: number;
11871
11835
  /**
11872
- * <p>设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次 1-不绑定,发起合同时将按标准合同套餐进行扣减</p>
11836
+ * <p>该字段已不再使用,请使用 FileId 参数代替。</p>
11837
+ * @deprecated
11873
11838
  */
11874
- LicenseType?: number;
11839
+ SealImage?: string;
11875
11840
  /**
11876
- * <p>自动签使用的场景值, 可以选择的场景值如下:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul><p>注: <code>不传默认为处方单场景,即E_PRESCRIPTION_AUTO_SIGN</code></p>
11841
+ * <p>该字段已不再使用,设置不生效。</p>
11842
+ * @deprecated
11877
11843
  */
11878
- SceneKey?: string;
11844
+ EnableAutoSign?: boolean;
11845
+ /**
11846
+ * <p>该字段已不再使用,设置不生效。</p>
11847
+ * @deprecated
11848
+ */
11849
+ SealImageCompress?: boolean;
11879
11850
  }
11880
11851
  /**
11881
11852
  * ImportContractReviewChecklist请求参数结构体
@@ -80,18 +80,42 @@ export declare class Client extends AbstractClient {
80
80
  */
81
81
  DescribeBatchOrganizationRegistrationTasks(req: DescribeBatchOrganizationRegistrationTasksRequest, cb?: (error: string, rep: DescribeBatchOrganizationRegistrationTasksResponse) => void): Promise<DescribeBatchOrganizationRegistrationTasksResponse>;
82
82
  /**
83
- * 此接口(CreateFileConvertTask)用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
84
- <font color="red">原功能接口: </font><a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换服务(ChannelCreateConvertTaskApi)</a><br />
85
- 前提条件:源文件已经通过 <a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>完成上传,并得到了源文件的资源Id。
86
- 适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同
87
- 适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
88
- 转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
89
- 注:
90
- 1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
91
- 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
83
+ * 创建文件转换任务
92
84
 
93
- 整体流程如下图
94
- ![image](https://qcloudimg.tencent-cloud.cn/raw/bb35c9cfa453d28eade16df36221f313.png)
85
+ ### 1.1 接口说明
86
+
87
+ 本接口用于创建文件转换任务,将以下类型的源文件转换为 PDF 文件:
88
+
89
+ `doc`、`docx`、`xls`、`xlsx`、`html`、`jpg`、`jpeg`、`png`、`bmp`、`txt`
90
+
91
+ 文件转换为异步耗时操作。任务创建成功后,可调用[查询文件转换任务状态](https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask)接口查询转换进度及结果。
92
+
93
+ ### 1.2 前提条件
94
+
95
+ 调用本接口前,请先通过[文件上传接口](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)上传源文件,并获取文件对应的资源 ID(`ResourceId`)。
96
+
97
+ ### 1.3 适用场景
98
+
99
+ - **Word 转 PDF**:已上传 Word 文件,需要先将其转换为 PDF,再用于发起合同。
100
+ - **图片转 PDF**:已上传 JPG、PNG 等图片文件,需要先将其转换为 PDF,再用于发起合同。
101
+ - **其他文件转 PDF**:将 Excel、HTML 或 TXT 文件转换为 PDF,以便预览或用于合同签署流程。
102
+
103
+ ### 1.4 使用流程
104
+
105
+ 1. 调用文件上传接口上传源文件,获取资源 ID。
106
+ 2. 调用 `CreateFileConvertTask`,使用资源 ID 创建转换任务。
107
+ 3. 保存接口返回的转换任务 ID。
108
+ 4. 调用 `DescribeFileConvertTask` 查询任务状态。
109
+ 5. 转换成功后,获取转换生成的 PDF 文件资源 ID。
110
+ 6. 使用转换后的 PDF 文件发起合同。
111
+
112
+ ![文件转换整体流程](https://qcloudimg.tencent-cloud.cn/raw/bb35c9cfa453d28eade16df36221f313.png)
113
+
114
+ ### 1.5 注意事项
115
+
116
+ 1. 支持转换的文件格式为:`doc`、`docx`、`xls`、`xlsx`、`html`、`jpg`、`jpeg`、`png`、`bmp`、`txt`。
117
+ 2. 文件转换需要一定时间,请勿在创建任务后立即使用转换结果,应通过任务状态查询接口确认转换成功。
118
+ 3. 建议在发起合同时开启文件预览,检查转换后的 PDF 是否符合预期,尤其需要关注页面排版、分页、字体及图片清晰度。
95
119
  */
96
120
  CreateFileConvertTask(req: CreateFileConvertTaskRequest, cb?: (error: string, rep: CreateFileConvertTaskResponse) => void): Promise<CreateFileConvertTaskResponse>;
97
121
  /**
@@ -112,16 +136,30 @@ export declare class Client extends AbstractClient {
112
136
  */
113
137
  ChannelDeleteRoleUsers(req: ChannelDeleteRoleUsersRequest, cb?: (error: string, rep: ChannelDeleteRoleUsersResponse) => void): Promise<ChannelDeleteRoleUsersResponse>;
114
138
  /**
115
- * 创建跳转小程序查看或签署的链接
139
+ * 本接口用于获取跳转至腾讯电子签小程序的签署链接,签署人点击链接后即可跳转到腾讯电子签小程序完成合同的查看、填写与签署等操作。
116
140
 
117
- **腾讯电子签小程序的AppID 原始Id如下:**
141
+ ### 1.1 适用场景
142
+ 当需要签署人在贵方自有的 APP、小程序、H5、公众号等应用中发起或完成签署时,可通过此接口获取跳转至腾讯电子签小程序的签署链接,并结合短信、页面按钮、二维码等方式触达签署人。
143
+ 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/partner/openwxminiprogram">跳转电子签小程序配置</a>
144
+
145
+ ### 1.2 注意事项
146
+ <ul><li>1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署</li>
147
+ <li>2. 签署链接的有效期为<font color="red">90天</font>,超过有效期链接不可用</li>
148
+ <li>4. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)</li>
149
+ <li>5. <font color="red">签署链接与签署人一一对应,仅限对应签署人本人打开</font>。例如给签署人A生成的链接只能A本人打开,其他人打开会提示无权限,不同签署人的链接不能混用</li></ul>
150
+
151
+ ### 1.3 腾讯电子签小程序AppID
152
+ 其中小程序的原始Id如下,或者查看小程序信息自助获取。
118
153
 
119
154
  | 小程序 | AppID | 原始ID |
120
155
  | ------------ | ------------ | ------------ |
121
156
  | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
122
157
  | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
123
158
 
124
- **主要使用场景EndPoint分类**
159
+ <font color="red">注:如果客户在线上小程序环境中打开的是腾讯电子签的测试版本小程序(腾讯电子签Demo),需要联系其前端将跳转配置中小程序的 AppID 从 `腾讯电子签Demo(wx371151823f6f3edf)` 更换为 `腾讯电子签(正式版)(wxa023b292fd19d41d)`。</font>
160
+
161
+ ### 1.4主要使用场景EndPoint分类
162
+
125
163
 
126
164
  |EndPoint| 场景| 说明和示例|
127
165
  | ---- | ---- | --- |
@@ -236,7 +274,7 @@ export declare class Client extends AbstractClient {
236
274
  ChannelCreateFlowReminds(req: ChannelCreateFlowRemindsRequest, cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void): Promise<ChannelCreateFlowRemindsResponse>;
237
275
  /**
238
276
  * 此接口(DescribeFileConvertTask)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
239
- <font color="red">原功能接口: </font><a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态(ChannelGetTaskResultApi)</a><br />
277
+
240
278
  前提条件:已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
241
279
 
242
280
  适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源ID。<br />
@@ -114,18 +114,42 @@ class Client extends abstract_client_1.AbstractClient {
114
114
  return this.request("DescribeBatchOrganizationRegistrationTasks", req, cb);
115
115
  }
116
116
  /**
117
- * 此接口(CreateFileConvertTask)用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
118
- <font color="red">原功能接口: </font><a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换服务(ChannelCreateConvertTaskApi)</a><br />
119
- 前提条件:源文件已经通过 <a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>完成上传,并得到了源文件的资源Id。
120
- 适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同
121
- 适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
122
- 转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
123
- 注:
124
- 1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
125
- 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
117
+ * 创建文件转换任务
126
118
 
127
- 整体流程如下图
128
- ![image](https://qcloudimg.tencent-cloud.cn/raw/bb35c9cfa453d28eade16df36221f313.png)
119
+ ### 1.1 接口说明
120
+
121
+ 本接口用于创建文件转换任务,将以下类型的源文件转换为 PDF 文件:
122
+
123
+ `doc`、`docx`、`xls`、`xlsx`、`html`、`jpg`、`jpeg`、`png`、`bmp`、`txt`
124
+
125
+ 文件转换为异步耗时操作。任务创建成功后,可调用[查询文件转换任务状态](https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask)接口查询转换进度及结果。
126
+
127
+ ### 1.2 前提条件
128
+
129
+ 调用本接口前,请先通过[文件上传接口](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)上传源文件,并获取文件对应的资源 ID(`ResourceId`)。
130
+
131
+ ### 1.3 适用场景
132
+
133
+ - **Word 转 PDF**:已上传 Word 文件,需要先将其转换为 PDF,再用于发起合同。
134
+ - **图片转 PDF**:已上传 JPG、PNG 等图片文件,需要先将其转换为 PDF,再用于发起合同。
135
+ - **其他文件转 PDF**:将 Excel、HTML 或 TXT 文件转换为 PDF,以便预览或用于合同签署流程。
136
+
137
+ ### 1.4 使用流程
138
+
139
+ 1. 调用文件上传接口上传源文件,获取资源 ID。
140
+ 2. 调用 `CreateFileConvertTask`,使用资源 ID 创建转换任务。
141
+ 3. 保存接口返回的转换任务 ID。
142
+ 4. 调用 `DescribeFileConvertTask` 查询任务状态。
143
+ 5. 转换成功后,获取转换生成的 PDF 文件资源 ID。
144
+ 6. 使用转换后的 PDF 文件发起合同。
145
+
146
+ ![文件转换整体流程](https://qcloudimg.tencent-cloud.cn/raw/bb35c9cfa453d28eade16df36221f313.png)
147
+
148
+ ### 1.5 注意事项
149
+
150
+ 1. 支持转换的文件格式为:`doc`、`docx`、`xls`、`xlsx`、`html`、`jpg`、`jpeg`、`png`、`bmp`、`txt`。
151
+ 2. 文件转换需要一定时间,请勿在创建任务后立即使用转换结果,应通过任务状态查询接口确认转换成功。
152
+ 3. 建议在发起合同时开启文件预览,检查转换后的 PDF 是否符合预期,尤其需要关注页面排版、分页、字体及图片清晰度。
129
153
  */
130
154
  async CreateFileConvertTask(req, cb) {
131
155
  return this.request("CreateFileConvertTask", req, cb);
@@ -152,16 +176,30 @@ class Client extends abstract_client_1.AbstractClient {
152
176
  return this.request("ChannelDeleteRoleUsers", req, cb);
153
177
  }
154
178
  /**
155
- * 创建跳转小程序查看或签署的链接
179
+ * 本接口用于获取跳转至腾讯电子签小程序的签署链接,签署人点击链接后即可跳转到腾讯电子签小程序完成合同的查看、填写与签署等操作。
156
180
 
157
- **腾讯电子签小程序的AppID 原始Id如下:**
181
+ ### 1.1 适用场景
182
+ 当需要签署人在贵方自有的 APP、小程序、H5、公众号等应用中发起或完成签署时,可通过此接口获取跳转至腾讯电子签小程序的签署链接,并结合短信、页面按钮、二维码等方式触达签署人。
183
+ 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/partner/openwxminiprogram">跳转电子签小程序配置</a>
184
+
185
+ ### 1.2 注意事项
186
+ <ul><li>1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署</li>
187
+ <li>2. 签署链接的有效期为<font color="red">90天</font>,超过有效期链接不可用</li>
188
+ <li>4. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)</li>
189
+ <li>5. <font color="red">签署链接与签署人一一对应,仅限对应签署人本人打开</font>。例如给签署人A生成的链接只能A本人打开,其他人打开会提示无权限,不同签署人的链接不能混用</li></ul>
190
+
191
+ ### 1.3 腾讯电子签小程序AppID
192
+ 其中小程序的原始Id如下,或者查看小程序信息自助获取。
158
193
 
159
194
  | 小程序 | AppID | 原始ID |
160
195
  | ------------ | ------------ | ------------ |
161
196
  | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
162
197
  | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
163
198
 
164
- **主要使用场景EndPoint分类**
199
+ <font color="red">注:如果客户在线上小程序环境中打开的是腾讯电子签的测试版本小程序(腾讯电子签Demo),需要联系其前端将跳转配置中小程序的 AppID 从 `腾讯电子签Demo(wx371151823f6f3edf)` 更换为 `腾讯电子签(正式版)(wxa023b292fd19d41d)`。</font>
200
+
201
+ ### 1.4主要使用场景EndPoint分类
202
+
165
203
 
166
204
  |EndPoint| 场景| 说明和示例|
167
205
  | ---- | ---- | --- |
@@ -288,7 +326,7 @@ class Client extends abstract_client_1.AbstractClient {
288
326
  }
289
327
  /**
290
328
  * 此接口(DescribeFileConvertTask)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
291
- <font color="red">原功能接口: </font><a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态(ChannelGetTaskResultApi)</a><br />
329
+
292
330
  前提条件:已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
293
331
 
294
332
  适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源ID。<br />