tencentcloud-sdk-nodejs 4.0.682 → 4.0.684

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 (120) hide show
  1. package/CHANGELOG.md +337 -0
  2. package/SERVICE_CHANGELOG.md +369 -166
  3. package/package.json +1 -1
  4. package/products.md +17 -17
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ams/index.ts +2 -2
  7. package/src/services/bma/index.ts +2 -2
  8. package/src/services/btoe/index.ts +2 -2
  9. package/src/services/cbs/v20170312/cbs_client.ts +2 -2
  10. package/src/services/ccc/v20200210/ccc_client.ts +2 -1
  11. package/src/services/ccc/v20200210/ccc_models.ts +21 -2
  12. package/src/services/cdwch/v20200915/cdwch_client.ts +27 -15
  13. package/src/services/cdwch/v20200915/cdwch_models.ts +70 -46
  14. package/src/services/cfw/v20190904/cfw_client.ts +711 -456
  15. package/src/services/cfw/v20190904/cfw_models.ts +1815 -305
  16. package/src/services/cii/index.ts +2 -2
  17. package/src/services/cloudstudio/index.ts +2 -2
  18. package/src/services/dts/index.ts +2 -2
  19. package/src/services/eb/v20210416/eb_client.ts +110 -59
  20. package/src/services/eb/v20210416/eb_models.ts +917 -780
  21. package/src/services/ess/v20201111/ess_client.ts +64 -30
  22. package/src/services/ess/v20201111/ess_models.ts +381 -214
  23. package/src/services/essbasic/index.ts +2 -2
  24. package/src/services/facefusion/v20181201/facefusion_client.ts +4 -2
  25. package/src/services/iai/index.ts +2 -2
  26. package/src/services/iai/v20180301/iai_models.ts +21 -25
  27. package/src/services/iai/v20200303/iai_models.ts +23 -27
  28. package/src/services/ims/index.ts +2 -2
  29. package/src/services/iotcloud/index.ts +2 -2
  30. package/src/services/iotvideo/index.ts +4 -4
  31. package/src/services/mgobe/index.ts +2 -2
  32. package/src/services/mrs/v20200910/mrs_models.ts +48 -25
  33. package/src/services/tem/index.ts +2 -2
  34. package/src/services/thpc/index.ts +4 -4
  35. package/src/services/thpc/v20230321/thpc_models.ts +17 -0
  36. package/src/services/tione/index.ts +2 -2
  37. package/src/services/tms/index.ts +2 -2
  38. package/src/services/trocket/v20230308/trocket_client.ts +68 -17
  39. package/src/services/trocket/v20230308/trocket_models.ts +371 -35
  40. package/src/services/trtc/v20190722/trtc_models.ts +1 -1
  41. package/src/services/tsw/index.ts +2 -2
  42. package/src/services/vm/index.ts +2 -2
  43. package/src/services/waf/v20180125/waf_client.ts +37 -38
  44. package/src/services/waf/v20180125/waf_models.ts +73 -73
  45. package/src/services/yunsou/index.ts +2 -2
  46. package/tencentcloud/common/sdk_version.d.ts +1 -1
  47. package/tencentcloud/common/sdk_version.js +1 -1
  48. package/tencentcloud/services/ams/index.d.ts +4 -4
  49. package/tencentcloud/services/ams/index.js +2 -2
  50. package/tencentcloud/services/bma/index.d.ts +4 -4
  51. package/tencentcloud/services/bma/index.js +2 -2
  52. package/tencentcloud/services/btoe/index.d.ts +4 -4
  53. package/tencentcloud/services/btoe/index.js +2 -2
  54. package/tencentcloud/services/cbs/v20170312/cbs_client.d.ts +2 -2
  55. package/tencentcloud/services/cbs/v20170312/cbs_client.js +2 -2
  56. package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +1 -1
  57. package/tencentcloud/services/ccc/v20200210/ccc_client.js +1 -1
  58. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +20 -2
  59. package/tencentcloud/services/cdwch/v20200915/cdwch_client.d.ts +9 -5
  60. package/tencentcloud/services/cdwch/v20200915/cdwch_client.js +12 -6
  61. package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +68 -46
  62. package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +227 -147
  63. package/tencentcloud/services/cfw/v20190904/cfw_client.js +336 -216
  64. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +1815 -360
  65. package/tencentcloud/services/cii/index.d.ts +4 -4
  66. package/tencentcloud/services/cii/index.js +2 -2
  67. package/tencentcloud/services/cloudstudio/index.d.ts +4 -4
  68. package/tencentcloud/services/cloudstudio/index.js +2 -2
  69. package/tencentcloud/services/dts/index.d.ts +4 -4
  70. package/tencentcloud/services/dts/index.js +2 -2
  71. package/tencentcloud/services/eb/v20210416/eb_client.d.ts +17 -1
  72. package/tencentcloud/services/eb/v20210416/eb_client.js +24 -0
  73. package/tencentcloud/services/eb/v20210416/eb_models.d.ts +896 -770
  74. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +56 -22
  75. package/tencentcloud/services/ess/v20201111/ess_client.js +56 -22
  76. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +381 -214
  77. package/tencentcloud/services/essbasic/index.d.ts +4 -4
  78. package/tencentcloud/services/essbasic/index.js +2 -2
  79. package/tencentcloud/services/facefusion/v20181201/facefusion_client.d.ts +3 -1
  80. package/tencentcloud/services/facefusion/v20181201/facefusion_client.js +3 -1
  81. package/tencentcloud/services/iai/index.d.ts +4 -4
  82. package/tencentcloud/services/iai/index.js +2 -2
  83. package/tencentcloud/services/iai/v20180301/iai_models.d.ts +21 -25
  84. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +23 -27
  85. package/tencentcloud/services/ims/index.d.ts +4 -4
  86. package/tencentcloud/services/ims/index.js +2 -2
  87. package/tencentcloud/services/iotcloud/index.d.ts +4 -4
  88. package/tencentcloud/services/iotcloud/index.js +2 -2
  89. package/tencentcloud/services/iotvideo/index.d.ts +6 -6
  90. package/tencentcloud/services/iotvideo/index.js +4 -4
  91. package/tencentcloud/services/mgobe/index.d.ts +4 -4
  92. package/tencentcloud/services/mgobe/index.js +2 -2
  93. package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +48 -25
  94. package/tencentcloud/services/tem/index.d.ts +4 -4
  95. package/tencentcloud/services/tem/index.js +2 -2
  96. package/tencentcloud/services/thpc/index.d.ts +6 -6
  97. package/tencentcloud/services/thpc/index.js +4 -4
  98. package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +17 -0
  99. package/tencentcloud/services/tione/index.d.ts +4 -4
  100. package/tencentcloud/services/tione/index.js +2 -2
  101. package/tencentcloud/services/tms/index.d.ts +4 -4
  102. package/tencentcloud/services/tms/index.js +2 -2
  103. package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +24 -8
  104. package/tencentcloud/services/trocket/v20230308/trocket_client.js +33 -9
  105. package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +359 -34
  106. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +1 -1
  107. package/tencentcloud/services/tsw/index.d.ts +4 -4
  108. package/tencentcloud/services/tsw/index.js +2 -2
  109. package/tencentcloud/services/vm/index.d.ts +4 -4
  110. package/tencentcloud/services/vm/index.js +2 -2
  111. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +13 -13
  112. package/tencentcloud/services/waf/v20180125/waf_client.js +18 -18
  113. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +69 -68
  114. package/tencentcloud/services/yunsou/index.d.ts +4 -4
  115. package/tencentcloud/services/yunsou/index.js +2 -2
  116. package/test/cdwch.v20200915.test.js +14 -4
  117. package/test/cfw.v20190904.test.js +340 -140
  118. package/test/eb.v20210416.test.js +40 -0
  119. package/test/trocket.v20230308.test.js +42 -2
  120. package/test/waf.v20180125.test.js +24 -24
@@ -243,8 +243,9 @@ export class Client extends AbstractClient {
243
243
 
244
244
  /**
245
245
  * 此接口用于启动流程。它是模板发起合同的最后一步。
246
- 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于激活包含完整合同信息(模板及内容信息)的流程。
247
- 流程激活后,将生成一份待签署的电子合同。
246
+ 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于开始整个合同流程, 推进流程进入到签署环节。
247
+
248
+ <svg id="SvgjsSvg1077" width="304" height="505" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1078"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1096" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1097" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1108" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1109" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1120" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1121" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1140" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1141" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="304" height="505" fill="transparent"></rect><rect id="SvgjsRect1080" width="304" height="505" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1081" width="304" height="505" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1082" transform="translate(58,121)"><path id="SvgjsPath1083" d="M 0 0L 221 0L 221 262L 0 262Z" stroke-dasharray="3,4" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1084"><text id="SvgjsText1085" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="201px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="120.375" transform="rotate(0)"></text></g></g><g id="SvgjsG1086" transform="translate(88,140.00000000000006)"><path id="SvgjsPath1087" d="M 0 0L 161 0L 161 48L 0 48Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1088"><text id="SvgjsText1089" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="141px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="4.875" transform="rotate(0)"><tspan id="SvgjsTspan1090" dy="16" x="80.5"><tspan id="SvgjsTspan1091" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlow</tspan></tspan><tspan id="SvgjsTspan1092" dy="16" x="80.5"><tspan id="SvgjsTspan1093" style="text-decoration:;">创建签署流程</tspan></tspan></text></g></g><g id="SvgjsG1094"><path id="SvgjsPath1095" d="M168.5 188.50000000000006L168.5 200.83333333333337L168.5 200.83333333333337L168.5 211.86666666666667" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1096)"></path></g><g id="SvgjsG1098" transform="translate(104.25,213.66666666666669)"><path id="SvgjsPath1099" d="M 0 0L 128.5 0L 128.5 55L 0 55Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1100"><text id="SvgjsText1101" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="109px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1102" dy="16" x="64.5"><tspan id="SvgjsTspan1103" style="text-decoration:;fill: rgb(28, 30, 33);">CreateDocument</tspan></tspan><tspan id="SvgjsTspan1104" dy="16" x="64.5"><tspan id="SvgjsTspan1105" style="text-decoration:;">创建电子文档</tspan></tspan></text></g></g><g id="SvgjsG1106"><path id="SvgjsPath1107" d="M168.5 269.16666666666674L168.5 281.5L168.5 281.5L168.5 292.5333333333334" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1108)"></path></g><g id="SvgjsG1110" transform="translate(96.75,294.33333333333337)"><path id="SvgjsPath1111" d="M 0 0L 143.5 0L 143.5 65L 0 65Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1112"><text id="SvgjsText1113" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="124px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="13.375" transform="rotate(0)"><tspan id="SvgjsTspan1114" dy="16" x="72"><tspan id="SvgjsTspan1115" style="text-decoration:;fill: rgb(28, 30, 33);">StartFlow</tspan></tspan><tspan id="SvgjsTspan1116" dy="16" x="72"><tspan id="SvgjsTspan1117" style="text-decoration:;">发起签署流程</tspan></tspan></text></g></g><g id="SvgjsG1118"><path id="SvgjsPath1119" d="M168.5 359.83333333333337L168.5 392.16666666666674L168.5 392.16666666666674L168.5 423.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1120)"></path></g><g id="SvgjsG1122" transform="translate(106.25,425)"><path id="SvgjsPath1123" d="M 0 0L 124.5 0L 124.5 55L 0 55Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1124"><text id="SvgjsText1125" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="105px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1126" dy="16" x="62.5"><tspan id="SvgjsTspan1127" style="text-decoration:;">开始签署</tspan></tspan><tspan id="SvgjsTspan1128" dy="16" x="62.5"><tspan id="SvgjsTspan1129" style="text-decoration:;">(小程序/H5等)</tspan></tspan></text></g></g><g id="SvgjsG1130" transform="translate(120.5,25)"><path id="SvgjsPath1131" d="M 0 0L 96 0L 96 54L 0 54Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1132"><text id="SvgjsText1133" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="76px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="7.875" transform="rotate(0)"><tspan id="SvgjsTspan1134" dy="16" x="48"><tspan id="SvgjsTspan1135" style="text-decoration:;">控制台创建</tspan></tspan><tspan id="SvgjsTspan1136" dy="16" x="48"><tspan id="SvgjsTspan1137" style="text-decoration:;">模板</tspan></tspan></text></g></g><g id="SvgjsG1138"><path id="SvgjsPath1139" d="M168.5 79.5L168.5 109.5L168.5 109.5L168.5 138.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1140)"></path></g><g id="SvgjsG1142" transform="translate(25,114)"><path id="SvgjsPath1143" d="M 0 0L 100 0L 100 40L 0 40Z" stroke="none" fill="none"></path><g id="SvgjsG1144"><text id="SvgjsText1145" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="100px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="9.375" transform="rotate(0)"><tspan id="SvgjsTspan1146" dy="16" x="50"><tspan id="SvgjsTspan1147" style="text-decoration:;">API</tspan></tspan></text></g></g></svg>
248
249
  */
249
250
  async StartFlow(
250
251
  req: StartFlowRequest,
@@ -254,9 +255,9 @@ export class Client extends AbstractClient {
254
255
  }
255
256
 
256
257
  /**
257
- * 用于撤销签署流程
258
- 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
259
- 注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
258
+ * 用于撤销签署流程<br/>
259
+ 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
260
+ `注意:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。`
260
261
  */
261
262
  async CancelFlow(
262
263
  req: CancelFlowRequest,
@@ -309,8 +310,10 @@ export class Client extends AbstractClient {
309
310
  }
310
311
 
311
312
  /**
312
- * 企业方可以通过此接口获取个人用户开启自动签的跳转链接(处方单场景专用,使用此接口请与客户经理确认)
313
- */
313
+ * 获取个人用户自动签的开通链接。
314
+
315
+ 注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
316
+ */
314
317
  async CreateUserAutoSignEnableUrl(
315
318
  req: CreateUserAutoSignEnableUrlRequest,
316
319
  cb?: (error: string, rep: CreateUserAutoSignEnableUrlResponse) => void
@@ -435,8 +438,14 @@ export class Client extends AbstractClient {
435
438
  }
436
439
 
437
440
  /**
438
- * 企业方可以通过此接口关闭个人的自动签功能(处方单场景专用,使用此接口请与客户经理确认)
439
- */
441
+ * 通过此接口可以关闭个人用户自动签功能。
442
+ 无需对应的用户刷脸等方式同意即可关闭。
443
+
444
+ 注意:
445
+
446
+ <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
447
+ <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
448
+ */
440
449
  async DisableUserAutoSign(
441
450
  req: DisableUserAutoSignRequest,
442
451
  cb?: (error: string, rep: DisableUserAutoSignResponse) => void
@@ -482,7 +491,9 @@ export class Client extends AbstractClient {
482
491
  /**
483
492
  * 创建签署流程电子文档
484
493
  适用场景:见创建签署流程接口。
485
- 注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
494
+ 注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用, 具体逻辑可以参考下图:
495
+
496
+ <svg id="SvgjsSvg1077" width="304" height="505" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1078"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1096" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1097" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1108" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1109" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1120" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1121" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1140" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1141" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="304" height="505" fill="transparent"></rect><rect id="SvgjsRect1080" width="304" height="505" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1081" width="304" height="505" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1082" transform="translate(58,121)"><path id="SvgjsPath1083" d="M 0 0L 221 0L 221 262L 0 262Z" stroke-dasharray="3,4" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1084"><text id="SvgjsText1085" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="201px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="120.375" transform="rotate(0)"></text></g></g><g id="SvgjsG1086" transform="translate(88,140.00000000000006)"><path id="SvgjsPath1087" d="M 0 0L 161 0L 161 48L 0 48Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1088"><text id="SvgjsText1089" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="141px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="4.875" transform="rotate(0)"><tspan id="SvgjsTspan1090" dy="16" x="80.5"><tspan id="SvgjsTspan1091" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlow</tspan></tspan><tspan id="SvgjsTspan1092" dy="16" x="80.5"><tspan id="SvgjsTspan1093" style="text-decoration:;">创建签署流程</tspan></tspan></text></g></g><g id="SvgjsG1094"><path id="SvgjsPath1095" d="M168.5 188.50000000000006L168.5 200.83333333333337L168.5 200.83333333333337L168.5 211.86666666666667" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1096)"></path></g><g id="SvgjsG1098" transform="translate(104.25,213.66666666666669)"><path id="SvgjsPath1099" d="M 0 0L 128.5 0L 128.5 55L 0 55Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1100"><text id="SvgjsText1101" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="109px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1102" dy="16" x="64.5"><tspan id="SvgjsTspan1103" style="text-decoration:;fill: rgb(28, 30, 33);">CreateDocument</tspan></tspan><tspan id="SvgjsTspan1104" dy="16" x="64.5"><tspan id="SvgjsTspan1105" style="text-decoration:;">创建电子文档</tspan></tspan></text></g></g><g id="SvgjsG1106"><path id="SvgjsPath1107" d="M168.5 269.16666666666674L168.5 281.5L168.5 281.5L168.5 292.5333333333334" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1108)"></path></g><g id="SvgjsG1110" transform="translate(96.75,294.33333333333337)"><path id="SvgjsPath1111" d="M 0 0L 143.5 0L 143.5 65L 0 65Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1112"><text id="SvgjsText1113" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="124px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="13.375" transform="rotate(0)"><tspan id="SvgjsTspan1114" dy="16" x="72"><tspan id="SvgjsTspan1115" style="text-decoration:;fill: rgb(28, 30, 33);">StartFlow</tspan></tspan><tspan id="SvgjsTspan1116" dy="16" x="72"><tspan id="SvgjsTspan1117" style="text-decoration:;">发起签署流程</tspan></tspan></text></g></g><g id="SvgjsG1118"><path id="SvgjsPath1119" d="M168.5 359.83333333333337L168.5 392.16666666666674L168.5 392.16666666666674L168.5 423.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1120)"></path></g><g id="SvgjsG1122" transform="translate(106.25,425)"><path id="SvgjsPath1123" d="M 0 0L 124.5 0L 124.5 55L 0 55Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1124"><text id="SvgjsText1125" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="105px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1126" dy="16" x="62.5"><tspan id="SvgjsTspan1127" style="text-decoration:;">开始签署</tspan></tspan><tspan id="SvgjsTspan1128" dy="16" x="62.5"><tspan id="SvgjsTspan1129" style="text-decoration:;">(小程序/H5等)</tspan></tspan></text></g></g><g id="SvgjsG1130" transform="translate(120.5,25)"><path id="SvgjsPath1131" d="M 0 0L 96 0L 96 54L 0 54Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1132"><text id="SvgjsText1133" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="76px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="7.875" transform="rotate(0)"><tspan id="SvgjsTspan1134" dy="16" x="48"><tspan id="SvgjsTspan1135" style="text-decoration:;">控制台创建</tspan></tspan><tspan id="SvgjsTspan1136" dy="16" x="48"><tspan id="SvgjsTspan1137" style="text-decoration:;">模板</tspan></tspan></text></g></g><g id="SvgjsG1138"><path id="SvgjsPath1139" d="M168.5 79.5L168.5 109.5L168.5 109.5L168.5 138.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1140)"></path></g><g id="SvgjsG1142" transform="translate(25,114)"><path id="SvgjsPath1143" d="M 0 0L 100 0L 100 40L 0 40Z" stroke="none" fill="none"></path><g id="SvgjsG1144"><text id="SvgjsText1145" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="100px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="9.375" transform="rotate(0)"><tspan id="SvgjsTspan1146" dy="16" x="50"><tspan id="SvgjsTspan1147" style="text-decoration:;">API</tspan></tspan></text></g></g></svg>
486
497
  */
487
498
  async CreateDocument(
488
499
  req: CreateDocumentRequest,
@@ -528,9 +539,11 @@ export class Client extends AbstractClient {
528
539
 
529
540
  /**
530
541
  * 通过模板创建签署流程<br/>
531
- 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。<br/>
532
- 注:该接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。<br/>
533
- 配合“创建电子文档”接口和“发起流程”接口使用。<br/>
542
+ 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
543
+
544
+ 注:配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
545
+
546
+ <svg id="SvgjsSvg1077" width="304" height="505" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1078"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1096" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1097" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1108" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1109" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1120" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1121" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1140" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1141" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="304" height="505" fill="transparent"></rect><rect id="SvgjsRect1080" width="304" height="505" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1081" width="304" height="505" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1082" transform="translate(58,121)"><path id="SvgjsPath1083" d="M 0 0L 221 0L 221 262L 0 262Z" stroke-dasharray="3,4" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1084"><text id="SvgjsText1085" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="201px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="120.375" transform="rotate(0)"></text></g></g><g id="SvgjsG1086" transform="translate(88,140.00000000000006)"><path id="SvgjsPath1087" d="M 0 0L 161 0L 161 48L 0 48Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1088"><text id="SvgjsText1089" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="141px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="4.875" transform="rotate(0)"><tspan id="SvgjsTspan1090" dy="16" x="80.5"><tspan id="SvgjsTspan1091" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlow</tspan></tspan><tspan id="SvgjsTspan1092" dy="16" x="80.5"><tspan id="SvgjsTspan1093" style="text-decoration:;">创建签署流程</tspan></tspan></text></g></g><g id="SvgjsG1094"><path id="SvgjsPath1095" d="M168.5 188.50000000000006L168.5 200.83333333333337L168.5 200.83333333333337L168.5 211.86666666666667" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1096)"></path></g><g id="SvgjsG1098" transform="translate(104.25,213.66666666666669)"><path id="SvgjsPath1099" d="M 0 0L 128.5 0L 128.5 55L 0 55Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1100"><text id="SvgjsText1101" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="109px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1102" dy="16" x="64.5"><tspan id="SvgjsTspan1103" style="text-decoration:;fill: rgb(28, 30, 33);">CreateDocument</tspan></tspan><tspan id="SvgjsTspan1104" dy="16" x="64.5"><tspan id="SvgjsTspan1105" style="text-decoration:;">创建电子文档</tspan></tspan></text></g></g><g id="SvgjsG1106"><path id="SvgjsPath1107" d="M168.5 269.16666666666674L168.5 281.5L168.5 281.5L168.5 292.5333333333334" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1108)"></path></g><g id="SvgjsG1110" transform="translate(96.75,294.33333333333337)"><path id="SvgjsPath1111" d="M 0 0L 143.5 0L 143.5 65L 0 65Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1112"><text id="SvgjsText1113" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="124px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="13.375" transform="rotate(0)"><tspan id="SvgjsTspan1114" dy="16" x="72"><tspan id="SvgjsTspan1115" style="text-decoration:;fill: rgb(28, 30, 33);">StartFlow</tspan></tspan><tspan id="SvgjsTspan1116" dy="16" x="72"><tspan id="SvgjsTspan1117" style="text-decoration:;">发起签署流程</tspan></tspan></text></g></g><g id="SvgjsG1118"><path id="SvgjsPath1119" d="M168.5 359.83333333333337L168.5 392.16666666666674L168.5 392.16666666666674L168.5 423.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1120)"></path></g><g id="SvgjsG1122" transform="translate(106.25,425)"><path id="SvgjsPath1123" d="M 0 0L 124.5 0L 124.5 55L 0 55Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1124"><text id="SvgjsText1125" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="105px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1126" dy="16" x="62.5"><tspan id="SvgjsTspan1127" style="text-decoration:;">开始签署</tspan></tspan><tspan id="SvgjsTspan1128" dy="16" x="62.5"><tspan id="SvgjsTspan1129" style="text-decoration:;">(小程序/H5等)</tspan></tspan></text></g></g><g id="SvgjsG1130" transform="translate(120.5,25)"><path id="SvgjsPath1131" d="M 0 0L 96 0L 96 54L 0 54Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1132"><text id="SvgjsText1133" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="76px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="7.875" transform="rotate(0)"><tspan id="SvgjsTspan1134" dy="16" x="48"><tspan id="SvgjsTspan1135" style="text-decoration:;">控制台创建</tspan></tspan><tspan id="SvgjsTspan1136" dy="16" x="48"><tspan id="SvgjsTspan1137" style="text-decoration:;">模板</tspan></tspan></text></g></g><g id="SvgjsG1138"><path id="SvgjsPath1139" d="M168.5 79.5L168.5 109.5L168.5 109.5L168.5 138.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1140)"></path></g><g id="SvgjsG1142" transform="translate(25,114)"><path id="SvgjsPath1143" d="M 0 0L 100 0L 100 40L 0 40Z" stroke="none" fill="none"></path><g id="SvgjsG1144"><text id="SvgjsText1145" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="100px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="9.375" transform="rotate(0)"><tspan id="SvgjsTspan1146" dy="16" x="50"><tspan id="SvgjsTspan1147" style="text-decoration:;">API</tspan></tspan></text></g></g></svg>
534
547
  */
535
548
  async CreateFlow(
536
549
  req: CreateFlowRequest,
@@ -540,8 +553,15 @@ export class Client extends AbstractClient {
540
553
  }
541
554
 
542
555
  /**
543
- * 发起解除协议,主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
544
- */
556
+ * 发起解除协议,主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
557
+
558
+ `注意:原合同必须签署完成后,才能发起解除协议。` <br/>
559
+ `注意:只有原合同企业类型的参与人才能发起解除协议,个人不能发起解除协议。`<br/>
560
+ `注意:原合同个人类型参与人必须是解除协议的参与人,不能更换其他第三方个人参与解除协议。`<br/>
561
+ `注意:如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的企业员工代为处理。`<br/>
562
+ `注意:发起解除协议同发起其他企业合同一样,也会参与合同扣费,扣费标准同其他类型合同。`<br/>
563
+ `注意:在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均会转变为已解除状态。`<br/>
564
+ */
545
565
  async CreateReleaseFlow(
546
566
  req: CreateReleaseFlowRequest,
547
567
  cb?: (error: string, rep: CreateReleaseFlowResponse) => void
@@ -550,8 +570,10 @@ export class Client extends AbstractClient {
550
570
  }
551
571
 
552
572
  /**
553
- * 企业方可以通过此接口查询个人用户自动签开启状态。(处方单场景专用,使用此接口请与客户经理确认)
554
- */
573
+ * 通过此接口获取个人用户自动签的开通状态。
574
+
575
+ 注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
576
+ */
555
577
  async DescribeUserAutoSignStatus(
556
578
  req: DescribeUserAutoSignStatusRequest,
557
579
  cb?: (error: string, rep: DescribeUserAutoSignStatusResponse) => void
@@ -618,7 +640,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
618
640
  }
619
641
 
620
642
  /**
621
- * 查询出证报告,返回报告 URL。出证报告编号通过CreateFlowEvidenceReport接口获取。
643
+ * 查询签署报告,返回报告 URL。需调用创建并返回出证报告接口(CreateFlowEvidenceReport)获取报告编号后调用当前接口获取报告链接。
622
644
  */
623
645
  async DescribeFlowEvidenceReport(
624
646
  req: DescribeFlowEvidenceReportRequest,
@@ -682,8 +704,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
682
704
  }
683
705
 
684
706
  /**
685
- * 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
686
- */
707
+ * 此接口(CancelMultiFlowSignQRCode)用于废除一码多扫流程签署二维码。
708
+ 该接口所需的二维码ID,源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
709
+ 如果该二维码尚处于有效期内,可通过本接口将其设置为失效状态。
710
+ */
687
711
  async CancelMultiFlowSignQRCode(
688
712
  req: CancelMultiFlowSignQRCodeRequest,
689
713
  cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void
@@ -702,13 +726,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
702
726
  }
703
727
 
704
728
  /**
705
- * 创建个人H5签署链接,请联系客户经理申请开通使用, 否则调用会返回失败 <br/>
706
-
707
- 该接口用于发起合同后,生成个人签署人的签署链接, 暂时不支持企业端签署 <br/>
729
+ * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
708
730
 
709
- 注意:该接口目前签署人类型仅支持个人签署方(PERSON) <br/>
710
- 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
711
- 注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
731
+ 注:
732
+ `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)`
733
+ `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 `
734
+ `3. 该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。跳转到小程序的实现,参考微信官方文档(分为<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/company/openwxminiprogram">跳转电子签小程序配置</a>
712
735
  */
713
736
  async CreateFlowSignUrl(
714
737
  req: CreateFlowSignUrlRequest,
@@ -728,8 +751,15 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
728
751
  }
729
752
 
730
753
  /**
731
- * 上传了word、excel、图片文件后,通过该接口发起文件转换任务,将word、excel、图片文件转换为pdf文件。
732
- */
754
+ * 此接口(CreateConvertTaskApi)用来将word、excel、图片、txt类型文件转换为PDF文件。<br />
755
+ 前提条件:源文件已经通过 <a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">文件上传接口</a>完成上传,并得到了源文件的资源Id。<br />
756
+ 适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同
757
+ 适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
758
+ 转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
759
+ 注:
760
+ 1. `支持的文件类型有doc\docx\xls\xlsx\jpg\jpeg\png\bmp\txt`
761
+ 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
762
+ */
733
763
  async CreateConvertTaskApi(
734
764
  req: CreateConvertTaskApiRequest,
735
765
  cb?: (error: string, rep: CreateConvertTaskApiResponse) => void
@@ -907,8 +937,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
907
937
  }
908
938
 
909
939
  /**
910
- * 此接口(CancelUserAutoSignEnableUrl)用来撤销发送给个人用户的自动签开通链接,撤销后对应的个人用户开通链接失效。若个人用户已经完成开通,将无法撤销。(处方单场景专用,使用此接口请与客户经理确认)
911
- */
940
+ * 用来撤销<a href="https://qian.tencent.com/developers/companyApis/users/CreateUserAutoSignEnableUrl" target="_blank">获取个人用户自动签的开通状态</a>生成的开通链接,撤销生成的链接失效。
941
+
942
+ 注:
943
+ <ul><li>若个人用户已经用生成的完成自动签署的开通,撤销链接无效不会对开通结果产生影响(此情况接口会报错)。</li>
944
+ <li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li></ul>
945
+ */
912
946
  async CancelUserAutoSignEnableUrl(
913
947
  req: CancelUserAutoSignEnableUrlRequest,
914
948
  cb?: (error: string, rep: CancelUserAutoSignEnableUrlResponse) => void