tccli 3.0.1216.1__py2.py3-none-any.whl → 3.0.1217.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (252) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/argparser.py +1 -1
  3. tccli/command.py +2 -2
  4. tccli/credentials.py +25 -0
  5. tccli/main.py +6 -2
  6. tccli/plugins/sso/__init__.py +61 -0
  7. tccli/plugins/sso/configs.py +4 -0
  8. tccli/plugins/sso/configure.py +45 -0
  9. tccli/plugins/sso/login.py +144 -0
  10. tccli/plugins/sso/logout.py +21 -0
  11. tccli/plugins/sso/terminal.py +161 -0
  12. tccli/plugins/sso/texts.py +40 -0
  13. tccli/services/__init__.py +6 -0
  14. tccli/services/acp/v20220105/api.json +7 -7
  15. tccli/services/acp/v20220105/examples.json +2 -2
  16. tccli/services/aiart/v20221229/api.json +29 -29
  17. tccli/services/aiart/v20221229/examples.json +8 -8
  18. tccli/services/apigateway/v20180808/api.json +18 -17
  19. tccli/services/apigateway/v20180808/examples.json +12 -12
  20. tccli/services/apm/v20210622/api.json +98 -4
  21. tccli/services/asr/v20190614/api.json +18 -17
  22. tccli/services/asr/v20190614/examples.json +13 -13
  23. tccli/services/autoscaling/v20180419/api.json +371 -309
  24. tccli/services/autoscaling/v20180419/examples.json +17 -17
  25. tccli/services/batch/v20170312/api.json +7 -7
  26. tccli/services/bda/v20200324/api.json +39 -31
  27. tccli/services/bda/v20200324/examples.json +9 -9
  28. tccli/services/bh/__init__.py +4 -0
  29. tccli/services/bh/bh_client.py +3428 -0
  30. tccli/services/bh/v20230418/api.json +8180 -0
  31. tccli/services/bh/v20230418/examples.json +519 -0
  32. tccli/services/bi/v20220105/api.json +48 -0
  33. tccli/services/billing/v20180709/api.json +26 -24
  34. tccli/services/bsca/v20210811/api.json +1 -1
  35. tccli/services/btoe/v20210514/api.json +4 -4
  36. tccli/services/btoe/v20210514/examples.json +2 -2
  37. tccli/services/ca/v20230228/api.json +60 -0
  38. tccli/services/cam/v20190116/api.json +11 -11
  39. tccli/services/cat/v20180409/api.json +9 -0
  40. tccli/services/cbs/v20170312/api.json +200 -188
  41. tccli/services/cbs/v20170312/examples.json +4 -4
  42. tccli/services/ccc/v20200210/api.json +390 -323
  43. tccli/services/ccc/v20200210/examples.json +15 -15
  44. tccli/services/cdb/cdb_client.py +13 -13
  45. tccli/services/cdb/v20170320/api.json +295 -270
  46. tccli/services/cdb/v20170320/examples.json +38 -38
  47. tccli/services/cdc/v20201214/api.json +283 -270
  48. tccli/services/cdc/v20201214/examples.json +26 -26
  49. tccli/services/cds/v20180420/api.json +82 -76
  50. tccli/services/cds/v20180420/examples.json +1 -1
  51. tccli/services/cdwch/v20200915/api.json +1 -1
  52. tccli/services/cdwdoris/v20211228/api.json +42 -2
  53. tccli/services/cdz/v20221123/api.json +41 -5
  54. tccli/services/cfg/v20210820/api.json +31 -0
  55. tccli/services/cfs/v20190719/api.json +89 -1
  56. tccli/services/cfs/v20190719/examples.json +1 -1
  57. tccli/services/cfw/cfw_client.py +0 -53
  58. tccli/services/cfw/v20190904/api.json +1849 -1999
  59. tccli/services/cfw/v20190904/examples.json +157 -159
  60. tccli/services/ckafka/v20190819/api.json +104 -75
  61. tccli/services/clb/v20180317/api.json +48 -26
  62. tccli/services/clb/v20180317/examples.json +1 -1
  63. tccli/services/cloudapp/v20220530/api.json +5 -1
  64. tccli/services/cloudaudit/v20190319/api.json +58 -44
  65. tccli/services/cloudaudit/v20190319/examples.json +6 -6
  66. tccli/services/cloudstudio/v20230508/api.json +38 -37
  67. tccli/services/cloudstudio/v20230508/examples.json +4 -4
  68. tccli/services/cls/cls_client.py +216 -4
  69. tccli/services/cls/v20201016/api.json +536 -47
  70. tccli/services/cls/v20201016/examples.json +34 -2
  71. tccli/services/csip/v20221121/api.json +2562 -2382
  72. tccli/services/csip/v20221121/examples.json +108 -108
  73. tccli/services/cvm/v20170312/api.json +149 -112
  74. tccli/services/cvm/v20170312/examples.json +2 -2
  75. tccli/services/cwp/cwp_client.py +4 -110
  76. tccli/services/cwp/v20180228/api.json +6338 -6146
  77. tccli/services/cwp/v20180228/examples.json +342 -370
  78. tccli/services/cynosdb/v20190107/api.json +93 -81
  79. tccli/services/cynosdb/v20190107/examples.json +70 -70
  80. tccli/services/dasb/v20191018/api.json +796 -651
  81. tccli/services/dasb/v20191018/examples.json +101 -101
  82. tccli/services/dcdb/dcdb_client.py +114 -61
  83. tccli/services/dcdb/v20180411/api.json +141 -7
  84. tccli/services/dcdb/v20180411/examples.json +32 -0
  85. tccli/services/dlc/v20210125/api.json +21 -11
  86. tccli/services/dnspod/dnspod_client.py +417 -46
  87. tccli/services/dnspod/v20210323/api.json +751 -30
  88. tccli/services/dnspod/v20210323/examples.json +62 -0
  89. tccli/services/dts/v20211206/api.json +4 -4
  90. tccli/services/ecm/v20190719/api.json +2 -2
  91. tccli/services/emr/v20190103/api.json +339 -114
  92. tccli/services/emr/v20190103/examples.json +64 -82
  93. tccli/services/es/v20180416/api.json +29 -0
  94. tccli/services/es/v20180416/examples.json +1 -1
  95. tccli/services/ess/v20201111/api.json +49 -31
  96. tccli/services/ess/v20201111/examples.json +20 -8
  97. tccli/services/essbasic/v20210526/api.json +54 -49
  98. tccli/services/essbasic/v20210526/examples.json +36 -18
  99. tccli/services/facefusion/v20181201/api.json +47 -45
  100. tccli/services/facefusion/v20181201/examples.json +2 -2
  101. tccli/services/facefusion/v20220927/api.json +54 -48
  102. tccli/services/facefusion/v20220927/examples.json +5 -5
  103. tccli/services/faceid/v20180301/api.json +497 -496
  104. tccli/services/faceid/v20180301/examples.json +219 -101
  105. tccli/services/fmu/v20191213/api.json +59 -67
  106. tccli/services/fmu/v20191213/examples.json +22 -22
  107. tccli/services/ft/v20200304/api.json +53 -57
  108. tccli/services/ft/v20200304/examples.json +14 -14
  109. tccli/services/gme/v20180711/api.json +21 -11
  110. tccli/services/gme/v20180711/examples.json +1 -1
  111. tccli/services/hai/v20230812/api.json +116 -9
  112. tccli/services/hai/v20230812/examples.json +4 -4
  113. tccli/services/hunyuan/hunyuan_client.py +436 -12
  114. tccli/services/hunyuan/v20230901/api.json +1482 -118
  115. tccli/services/hunyuan/v20230901/examples.json +82 -18
  116. tccli/services/iai/v20180301/api.json +23 -19
  117. tccli/services/iai/v20180301/examples.json +2 -2
  118. tccli/services/iai/v20200303/api.json +530 -511
  119. tccli/services/iai/v20200303/examples.json +116 -86
  120. tccli/services/ig/__init__.py +4 -0
  121. tccli/services/ig/ig_client.py +195 -0
  122. tccli/services/ig/v20210518/api.json +83 -0
  123. tccli/services/ig/v20210518/examples.json +13 -0
  124. tccli/services/ioa/ioa_client.py +53 -0
  125. tccli/services/ioa/v20220601/api.json +662 -413
  126. tccli/services/ioa/v20220601/examples.json +24 -10
  127. tccli/services/iotexplorer/v20190423/api.json +33 -13
  128. tccli/services/iotexplorer/v20190423/examples.json +3 -3
  129. tccli/services/iotvideo/iotvideo_client.py +106 -0
  130. tccli/services/iotvideo/v20191126/api.json +256 -24
  131. tccli/services/iotvideo/v20191126/examples.json +19 -3
  132. tccli/services/iotvideo/v20201215/api.json +1 -1
  133. tccli/services/iotvideo/v20201215/examples.json +1 -1
  134. tccli/services/iotvideo/v20211125/api.json +1 -1
  135. tccli/services/iotvideo/v20211125/examples.json +2 -2
  136. tccli/services/iss/iss_client.py +69 -122
  137. tccli/services/iss/v20230517/api.json +10 -54
  138. tccli/services/iss/v20230517/examples.json +0 -14
  139. tccli/services/kms/v20190118/api.json +301 -268
  140. tccli/services/kms/v20190118/examples.json +45 -51
  141. tccli/services/lcic/lcic_client.py +159 -0
  142. tccli/services/lcic/v20220817/api.json +273 -1
  143. tccli/services/lcic/v20220817/examples.json +24 -0
  144. tccli/services/lighthouse/v20200324/api.json +56 -0
  145. tccli/services/live/live_client.py +159 -0
  146. tccli/services/live/v20180801/api.json +244 -0
  147. tccli/services/live/v20180801/examples.json +24 -0
  148. tccli/services/lke/v20231130/api.json +17 -17
  149. tccli/services/lke/v20231130/examples.json +19 -25
  150. tccli/services/mariadb/v20170312/api.json +7 -7
  151. tccli/services/market/v20191010/api.json +3 -3
  152. tccli/services/market/v20191010/examples.json +2 -2
  153. tccli/services/mmps/v20200710/api.json +47 -47
  154. tccli/services/mmps/v20200710/examples.json +3 -3
  155. tccli/services/mongodb/v20190725/api.json +4 -4
  156. tccli/services/monitor/v20180724/api.json +46 -19
  157. tccli/services/mps/v20190612/api.json +282 -5
  158. tccli/services/mps/v20190612/examples.json +25 -1
  159. tccli/services/mqtt/v20240516/api.json +2 -2
  160. tccli/services/mrs/v20200910/api.json +72 -34
  161. tccli/services/mrs/v20200910/examples.json +2 -2
  162. tccli/services/ms/v20180408/api.json +535 -506
  163. tccli/services/ms/v20180408/examples.json +25 -25
  164. tccli/services/oceanus/v20190422/api.json +130 -0
  165. tccli/services/ocr/ocr_client.py +232 -20
  166. tccli/services/ocr/v20181119/api.json +2265 -760
  167. tccli/services/ocr/v20181119/examples.json +200 -180
  168. tccli/services/omics/v20221128/api.json +614 -553
  169. tccli/services/omics/v20221128/examples.json +9 -9
  170. tccli/services/organization/v20210331/api.json +13 -4
  171. tccli/services/organization/v20210331/examples.json +2 -2
  172. tccli/services/partners/v20180321/api.json +244 -234
  173. tccli/services/partners/v20180321/examples.json +19 -19
  174. tccli/services/privatedns/privatedns_client.py +428 -4
  175. tccli/services/privatedns/v20201028/api.json +815 -11
  176. tccli/services/privatedns/v20201028/examples.json +64 -0
  177. tccli/services/pts/v20210728/api.json +18 -0
  178. tccli/services/pts/v20210728/examples.json +1 -1
  179. tccli/services/rce/rce_client.py +53 -0
  180. tccli/services/rce/v20201103/api.json +146 -0
  181. tccli/services/rce/v20201103/examples.json +8 -0
  182. tccli/services/redis/v20180412/api.json +42 -42
  183. tccli/services/redis/v20180412/examples.json +19 -19
  184. tccli/services/rum/v20210622/api.json +9 -0
  185. tccli/services/scf/v20180416/api.json +15 -15
  186. tccli/services/scf/v20180416/examples.json +1 -1
  187. tccli/services/smop/v20201203/api.json +46 -42
  188. tccli/services/smop/v20201203/examples.json +2 -2
  189. tccli/services/soe/v20180724/api.json +10 -10
  190. tccli/services/sqlserver/v20180328/api.json +21 -8
  191. tccli/services/sqlserver/v20180328/examples.json +5 -5
  192. tccli/services/ssl/v20191205/api.json +97 -4
  193. tccli/services/ssm/v20190923/api.json +292 -231
  194. tccli/services/ssm/v20190923/examples.json +42 -42
  195. tccli/services/tat/v20201028/api.json +97 -97
  196. tccli/services/tat/v20201028/examples.json +20 -26
  197. tccli/services/tchd/v20230306/api.json +5 -5
  198. tccli/services/tchd/v20230306/examples.json +3 -3
  199. tccli/services/tcr/v20190924/api.json +1 -1
  200. tccli/services/tcr/v20190924/examples.json +1 -1
  201. tccli/services/tcss/v20201101/api.json +1973 -1426
  202. tccli/services/tcss/v20201101/examples.json +346 -364
  203. tccli/services/tdmq/v20200217/api.json +539 -401
  204. tccli/services/tdmq/v20200217/examples.json +104 -104
  205. tccli/services/tds/v20220801/api.json +4 -4
  206. tccli/services/tem/v20210701/api.json +287 -271
  207. tccli/services/tem/v20210701/examples.json +59 -59
  208. tccli/services/teo/v20220901/api.json +37 -9
  209. tccli/services/teo/v20220901/examples.json +13 -7
  210. tccli/services/thpc/v20230321/api.json +5 -5
  211. tccli/services/tke/tke_client.py +217 -58
  212. tccli/services/tke/v20180525/api.json +36 -27
  213. tccli/services/tke/v20180525/examples.json +1 -1
  214. tccli/services/tke/v20220501/api.json +176 -0
  215. tccli/services/tke/v20220501/examples.json +24 -0
  216. tccli/services/tmt/v20180321/api.json +38 -8
  217. tccli/services/trp/v20210515/api.json +86 -74
  218. tccli/services/trp/v20210515/examples.json +65 -65
  219. tccli/services/trro/v20220325/api.json +72 -71
  220. tccli/services/trro/v20220325/examples.json +8 -8
  221. tccli/services/trtc/trtc_client.py +8 -61
  222. tccli/services/trtc/v20190722/api.json +72 -30
  223. tccli/services/trtc/v20190722/examples.json +3 -11
  224. tccli/services/tse/tse_client.py +110 -4
  225. tccli/services/tse/v20201207/api.json +122 -7
  226. tccli/services/tse/v20201207/examples.json +25 -9
  227. tccli/services/vclm/v20240523/api.json +225 -82
  228. tccli/services/vclm/v20240523/examples.json +13 -19
  229. tccli/services/vod/v20180717/api.json +431 -4
  230. tccli/services/vod/v20180717/examples.json +25 -5
  231. tccli/services/vod/v20240718/api.json +11 -11
  232. tccli/services/vod/v20240718/examples.json +4 -4
  233. tccli/services/vod/vod_client.py +53 -0
  234. tccli/services/vpc/v20170312/api.json +1090 -862
  235. tccli/services/vpc/v20170312/examples.json +74 -66
  236. tccli/services/vpc/vpc_client.py +61 -8
  237. tccli/services/waf/v20180125/api.json +2540 -2177
  238. tccli/services/waf/v20180125/examples.json +216 -284
  239. tccli/services/waf/waf_client.py +172 -119
  240. tccli/services/wav/v20210129/api.json +48 -48
  241. tccli/services/wav/v20210129/examples.json +4 -4
  242. tccli/services/wedata/v20210820/api.json +909 -25
  243. tccli/services/wedata/v20210820/examples.json +28 -4
  244. tccli/services/wedata/wedata_client.py +159 -0
  245. tccli/services/weilingwith/v20230427/api.json +6 -6
  246. tccli/services/weilingwith/v20230427/examples.json +3 -3
  247. tccli/sso.py +229 -0
  248. {tccli-3.0.1216.1.dist-info → tccli-3.0.1217.1.dist-info}/METADATA +2 -2
  249. {tccli-3.0.1216.1.dist-info → tccli-3.0.1217.1.dist-info}/RECORD +252 -235
  250. {tccli-3.0.1216.1.dist-info → tccli-3.0.1217.1.dist-info}/WHEEL +0 -0
  251. {tccli-3.0.1216.1.dist-info → tccli-3.0.1217.1.dist-info}/entry_points.txt +0 -0
  252. {tccli-3.0.1216.1.dist-info → tccli-3.0.1217.1.dist-info}/license_files/LICENSE +0 -0
@@ -36,7 +36,7 @@
36
36
  "status": "online"
37
37
  },
38
38
  "ChannelCreateBatchQuickSignUrl": {
39
- "document": "该接口用于发起合同后,生成个人用户的批量待办链接, 暂时不支持企业端签署。\n**注意:**\n1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。\n2. 该接口可生成C端签署人的批量签署/查看链接,**签署控件仅支持手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件** 。\n3. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。\n4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。\n跳转到小程序的实现,参考微信官方文档(分为<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>。\n6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href=\"https://cloud.tencent.com/document/product/1007/61076\">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。",
39
+ "document": "该接口用于发起合同后,生成个人/企业用户的批量待办链接。\n**注意:**\n1. 该接口可生成签署人的批量、合同组签署/查看链接 。\n2. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。\n4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。\n跳转到小程序的实现,参考微信官方文档(分为<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>。\n6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href=\"https://cloud.tencent.com/document/product/1007/61076\">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。",
40
40
  "input": "ChannelCreateBatchQuickSignUrlRequest",
41
41
  "name": "获取H5批量签署或查看链接",
42
42
  "output": "ChannelCreateBatchQuickSignUrlResponse",
@@ -85,14 +85,14 @@
85
85
  "status": "online"
86
86
  },
87
87
  "ChannelCreateFlowGroupByFiles": {
88
- "document": "接口(ChannelCreateFlowGroupByFiles)用于使用 PDF 文件创建合同组签署流程。\n\n合同组是将多个合同签署流程组织在一起,多个合同同时创建,每个签署方得到一个签署链接,`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`,只能作为一个整体签署。\n\n适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。\n\n\n\n**注**: \n<ul>\n<li>此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。</li>\n<li>合同组暂不支持抄送功能</li>\n<li>此接口需要依赖<a href=\"https://qian.tencent.com/developers/partnerApis/files/UploadFiles\" target=\"_blank\">文件上传接口</a>生成pdf资源编号(FileIds)进行使用。</li>\n</ul>\n\n**可以作为发起方和签署方的角色列表**\n<table>\n<thead>\n<tr>\n<th>场景编号</th>\n<th>可作为发起方类型</th>\n<th>可作为签署方的类型</th>\n</tr>\n</thead>\n\n<tbody>\n<tr>\n<td>场景一</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业A员工</td>\n</tr>\n\n<tr>\n<td>场景二</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业B(不指定经办人)</td>\n</tr>\n\n<tr>\n<td>场景三</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业B员工</td>\n</tr>\n\n<tr>\n<td>场景四</td>\n<td>第三方子企业A员工</td>\n<td>个人/自然人</td>\n</tr>\n\n<tr>\n<td>场景五</td>\n<td>第三方子企业A员工</td>\n<td>SaaS平台企业员工</td>\n</tr>\n</tbody>\n</table>\n\n**注**: \n`1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`\n\n`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`\n\n`3. 合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度),合同组中每个合同会扣减一个合同额度`\n\n`4. 静默(自动)签署不支持合同签署方存在填写功能`",
88
+ "document": "接口(ChannelCreateFlowGroupByFiles)用于使用 PDF 文件创建合同组签署流程。\n\n- 该接口允许通过选择多个模板一次性创建多个合同,这些合同被组织在一个合同组中。\n- 每个签署方将收到一个签署链接,通过这个链接可以访问并签署合同组中的所有合同。\n- 合同组中的合同必须作为一个整体进行签署,不能将合同组拆分成单独的合同进行逐一签署。\n\n<img src=\"https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png\" width=\"400\" />\n\n\n### 2. 适用场景\n\n该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。\n\n### 3. 发起方要求和签署方实名要求\n- **发起方要求**:作为合同发起方的第三方子企业A的员工必须进行实名认证。\n- **签署方要求**:签署方可以是多种身份(如第三方子企业的员工、个人、SaaS平台企业员工),其中企业和员工可以不进行实名认证。\n\n**可以作为发起方和签署方的角色列表**\n\n<table>\n<thead>\n<tr>\n<th>场景编号</th>\n<th>可作为发起方类型</th>\n<th>可作为签署方的类型</th>\n</tr>\n</thead>\n\n<tbody>\n<tr>\n<td>场景一</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业A员工</td>\n</tr>\n\n<tr>\n<td>场景二</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业B员工</td>\n</tr>\n\n<tr>\n<td>场景三</td>\n<td>第三方子企业A员工</td>\n<td>个人/自然人</td>\n</tr>\n\n<tr>\n<td>场景四</td>\n<td>第三方子企业A员工</td>\n<td>SaaS平台企业员工</td>\n</tr>\n</tbody>\n</table>\n\n### 4. 签署方参数差异\n- 根据签署方的不同类型(第三方子企业的员工、个人、SaaS平台企业员工),传递的参数也不同。具体参数的结构和要求可以参考开发者中心提供的 `FlowApproverInfo` 结构体说明。\n\n### 5. 合同额度的扣减与返还\n- **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。\n- **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。\n- **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。\n\n### 6. 静默(自动)签署的限制\n- 在使用静默(自动)签署功能时,合同签署方不能有填写控件。<font color=\"red\">此接口静默签(企业自动签)能力为白名单功能</font>,使用前请联系对接的客户经理沟通。\n\n### 7.合同组暂不支持抄送功能",
89
89
  "input": "ChannelCreateFlowGroupByFilesRequest",
90
90
  "name": "通过多文件创建合同组签署流程",
91
91
  "output": "ChannelCreateFlowGroupByFilesResponse",
92
92
  "status": "online"
93
93
  },
94
94
  "ChannelCreateFlowGroupByTemplates": {
95
- "document": "接口(ChannelCreateFlowGroupByTemplates)用于通过多模板创建合同组签署流程。\n\n合同组是将多个合同签署流程组织在一起,多个合同同时创建,每个签署方得到一个签署链接,`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`,只能作为一个整体签署。\n\n适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。\n\n**注**: \n<ul>\n<li>此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。</li>\n<li>合同组暂不支持抄送功能</li>\n</ul>\n\n**可以作为发起方和签署方的角色列表**\n<table>\n<thead>\n<tr>\n<th>场景编号</th>\n<th>可作为发起方类型</th>\n<th>可作为签署方的类型</th>\n</tr>\n</thead>\n\n<tbody>\n<tr>\n<td>场景一</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业A员工</td>\n</tr>\n\n<tr>\n<td>场景二</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业B(不指定经办人)</td>\n</tr>\n\n<tr>\n<td>场景三</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业B员工</td>\n</tr>\n\n<tr>\n<td>场景四</td>\n<td>第三方子企业A员工</td>\n<td>个人/自然人</td>\n</tr>\n\n<tr>\n<td>场景五</td>\n<td>第三方子企业A员工</td>\n<td>SaaS平台企业员工</td>\n</tr>\n</tbody>\n</table>\n\n**注**: \n`1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`\n\n`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`\n\n`3. 合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度),合同组中每个合同会扣减一个合同额度`\n\n`4. 静默(自动)签署不支持合同签署方存在填写功能`",
95
+ "document": "接口(ChannelCreateFlowGroupByTemplates)用于通过多模板创建合同组签署流程。\n\n- 该接口允许通过选择多个模板一次性创建多个合同,这些合同被组织在一个合同组中。\n- 每个签署方将收到一个签署链接,通过这个链接可以访问并签署合同组中的所有合同。\n- 合同组中的合同必须作为一个整体进行签署,不能将合同组拆分成单独的合同进行逐一签署。\n\n<img src=\"https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png\" width=\"400\" />\n\n### 2. 适用场景\n\n该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。\n\n### 3. 发起方要求和签署方实名要求\n- **发起方要求**:作为合同发起方的第三方子企业A的员工必须进行实名认证。\n- **签署方要求**:签署方可以是多种身份(如第三方子企业的员工、个人、SaaS平台企业员工),其中企业和员工可以不进行实名认证。\n\n**可以作为发起方和签署方的角色列表**\n\n<table>\n<thead>\n<tr>\n<th>场景编号</th>\n<th>可作为发起方类型</th>\n<th>可作为签署方的类型</th>\n</tr>\n</thead>\n\n<tbody>\n<tr>\n<td>场景一</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业A员工</td>\n</tr>\n<tr>\n<td>场景二</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业B员工</td>\n</tr>\n\n<tr>\n<td>场景三</td>\n<td>第三方子企业A员工</td>\n<td>个人/自然人</td>\n</tr>\n\n<tr>\n<td>场景四</td>\n<td>第三方子企业A员工</td>\n<td>SaaS平台企业员工</td>\n</tr>\n</tbody>\n</table>\n\n### 4. 签署方参数差异\n- 根据签署方的不同类型(第三方子企业的员工、个人、SaaS平台企业员工),传递的参数也不同。具体参数的结构和要求可以参考开发者中心提供的 `FlowApproverInfo` 结构体说明。\n\n### 5. 合同额度的扣减与返还\n- **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。\n- **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。\n- **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。\n\n### 6. 静默(自动)签署的限制\n- 在使用静默(自动)签署功能时,合同签署方不能有填写控件。<font color=\"red\">此接口静默签(企业自动签)能力为白名单功能</font>,使用前请联系对接的客户经理沟通。\n\n### 7.合同组暂不支持抄送功能",
96
96
  "input": "ChannelCreateFlowGroupByTemplatesRequest",
97
97
  "name": "通过多模板创建合同组签署流程",
98
98
  "output": "ChannelCreateFlowGroupByTemplatesResponse",
@@ -204,7 +204,7 @@
204
204
  "status": "online"
205
205
  },
206
206
  "ChannelDeleteRole": {
207
- "document": "此接口(ChannelDeleteRole)用来删除企业自定义角色。\n\n注意:系统角色不可删除。",
207
+ "document": "此接口(ChannelDeleteRole)用来删除企业自定义角色。\n\n注:**系统角色不可删除。**",
208
208
  "input": "ChannelDeleteRoleRequest",
209
209
  "name": "删除角色",
210
210
  "output": "ChannelDeleteRoleResponse",
@@ -246,7 +246,7 @@
246
246
  "status": "online"
247
247
  },
248
248
  "ChannelDescribeFlowComponents": {
249
- "document": "用于获取合同中填写控件填写状态和填写的内容。 \n\n**注意**: `附件控件不会出现在结果列表中`\n\n\n**授权**: \n此接口需要授权, 有两种开通权限的途径\n\n**第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图\n授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)\n\n**第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>\n![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)",
249
+ "document": "您可以通过合同流程ID查询相关的<font color=\"red\"><b>填写控件</b></font>信息及其内容。这包括控件的归属方、控件的填写状态(是否已填写)以及具体的填写内容。\n\n无论是<font color=\"red\"><b>发起方还是签署方</b></font>填写的控件,均包含在查询结果中。\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/08f6ea50d3ae88b51c280c2b17c2a126.png)\n### 2. 那些控件会出现在结果里边? \n**A.不返回的控件类型:**\n- 动态表格\n- 附件控件\n- 水印控件\n\n**B.返回的控件类型:**\n- 单行文本\n- 多行文本\n- 勾选框控件\n- 数字控件\n- 日期控件\n- 图片控件(图片下载地址)\n- 邮箱控件\n- 地址控件\n- 学历控件\n- 性别控件\n- 省市区控件\n\n### 3.怎么授权? \n\n此接口需要授权, 有两种开通权限的途径\n\n**第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图\n授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)\n\n**第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>\n![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)",
250
250
  "input": "ChannelDescribeFlowComponentsRequest",
251
251
  "name": "获取合同填写控件内容",
252
252
  "output": "ChannelDescribeFlowComponentsResponse",
@@ -407,14 +407,14 @@
407
407
  "status": "online"
408
408
  },
409
409
  "CreatePartnerAutoSignAuthUrl": {
410
- "document": "创建他方自动签授权链接,通过该链接可进入小程序进行合作方企业的自动签授权,若当前企业未开通企业自动签,通过该链接会先引导开通本企业自动签。\n该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权\n\n\n\n注: \n1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)\n2. 已经在授权中或者授权成功的企业,无法重复授权",
410
+ "document": "创建一个用于他方自动签授权的链接(可选择他方授权或我方授权)。通过这个链接,合作方企业可以直接进入小程序,进行自动签授权操作。\n\n如果授权企业尚未开通企业自动签功能,该链接还将引导他们首先开通本企业的自动签服务\n\n\n注: \n1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)\n2. 已经在授权中或者授权成功的企业,无法重复授权\n3. 授权企业和被授权企业必须都是已认证企业\n4. <font color='red'>需要授权企业或被授权企业的超管或者法人打开链接</font>走开通逻辑。\n\n**该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权**\n![image](https://qcloudimg.tencent-cloud.cn/raw/091823fd4f02af7dda416fa10ca65f2d.png)",
411
411
  "input": "CreatePartnerAutoSignAuthUrlRequest",
412
- "name": "创建他方企业自动签授权链接(他方授权 ,我方授权)",
412
+ "name": "创建企业自动签授权链接",
413
413
  "output": "CreatePartnerAutoSignAuthUrlResponse",
414
414
  "status": "online"
415
415
  },
416
416
  "CreatePersonAuthCertificateImage": {
417
- "document": "获取个人用户认证证书图片下载URL\n\n个人用户认证证书图片样式如下图\n\n![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)\n\n注: \n<ul>\n<li>只能获取个人用户证明图片, 企业员工的暂不支持</li>\n<li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 </li>\n</ul>",
417
+ "document": "获取个人用户认证证书图片下载URL\n\n个人用户认证证书图片样式如下图\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/d568bc0f101bef582f7af2cb5ab7a715.png)\n\n注: \n<ul>\n<li>只能获取个人用户证明图片, 企业员工的暂不支持</li>\n<li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 </li>\n</ul>",
418
418
  "input": "CreatePersonAuthCertificateImageRequest",
419
419
  "name": "获取个人用户认证证书图片",
420
420
  "output": "CreatePersonAuthCertificateImageResponse",
@@ -498,7 +498,7 @@
498
498
  "status": "online"
499
499
  },
500
500
  "DescribeResourceUrlsByFlows": {
501
- "document": "获取合同流程PDF的下载链接,可以下载签署中、签署完的此子企业创建的合同。\n\n\n\n\n### 1. 确保合同的PDF已经合成后,再调用本接口。\n 用户创建合同或者提交签署动作后,后台需要1~3秒的时间就进行合同PDF合成或者签名,为了确保您下载的是签署完成的完整合同文件,我们建议采取下面两种方式的一种来<font color=\"red\"><b>确保PDF已经合成完成,然后在调用本接口</b></font>。\n\n**第一种**:请确保您的系统配置了[接收合同完成通知的回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign)功能。一旦所有参与方签署完毕,我们的系统将自动向您提供的回调地址发送完成通知。\n**第二种**:通过调用我们的[获取合同信息](https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo)接口来主动检查合同的签署状态。请仅在确认合同状态为“全部签署完成”后,进行文件的下载操作。\n\n### 2. 有两种开通下载权限的途径。\n\n**第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图。\n授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)\n\n**第二种**: 渠道方企业在**企业应用管理**的配置界面打开需要配置的应用,点击**应用扩展服务**开通此功能,需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>\n注: \n1. `请注意如果第三方应用的子客主动关闭了渠道端下载渠道子客合同功能开关,那么渠道方开通了此功能也无法下载子客的合同文件`\n![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)",
501
+ "document": "获取合同流程PDF的下载链接,可以下载签署中、签署完的此子企业创建的合同。\n\n\n\n\n### 2. 确保合同的PDF已经合成后,再调用本接口。\n 用户创建合同或者提交签署动作后,后台需要1~3秒的时间就进行合同PDF合成或者签名,为了确保您下载的是签署完成的完整合同文件,我们建议采取下面两种方式的一种来<font color=\"red\"><b>确保PDF已经合成完成,然后在调用本接口</b></font>。\n\n**第一种**:请确保您的系统配置了[接收合同完成通知的回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign)功能。一旦所有参与方签署完毕,我们的系统将自动向您提供的回调地址发送完成通知。\n\n**第二种**:通过调用我们的[获取合同信息](https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo)接口来主动检查合同的签署状态。请仅在确认合同状态为“全部签署完成”后,进行文件的下载操作。\n\n### 3. 链接具有有效期限\n<font color=\"red\"><b>生成的链接是有时间限制的,过期后将无法访问</b></font>。您可以在接口返回的信息中查看具体的过期时间。为避免错误,请确保在链接过期之前进行下载操作。\n\n### 4. 有两种开通下载权限的途径。\n\n**第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图。\n授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)\n\n**第二种**: 渠道方企业在**企业应用管理**的配置界面打开需要配置的应用,点击**应用扩展服务**开通此功能,需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>\n注: \n1. `请注意如果第三方应用的子客主动关闭了渠道端下载渠道子客合同功能开关,那么渠道方开通了此功能也无法下载子客的合同文件`\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)",
502
502
  "input": "DescribeResourceUrlsByFlowsRequest",
503
503
  "name": "获取合同PDF下载链接",
504
504
  "output": "DescribeResourceUrlsByFlowsResponse",
@@ -512,7 +512,7 @@
512
512
  "status": "online"
513
513
  },
514
514
  "DescribeUsage": {
515
- "document": "此接口(DescribeUsage)用于获取此应用下子客企业的合同消耗数量。\n\n注: 此接口**每日限频50次**,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。",
515
+ "document": "此接口(DescribeUsage)用于获取此应用下子客企业的合同消耗数量。\n\n<font color=\"red\">此接口即将下线, 请使用新接口</font> [查询渠道计费消耗情况](https://qian.tencent.com/developers/partnerApis/fee/ChannelDescribeBillUsageDetail)\n\n注: 此接口**每日限频50次**,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。",
516
516
  "input": "DescribeUsageRequest",
517
517
  "name": "合同消耗数量查询",
518
518
  "output": "DescribeUsageResponse",
@@ -526,7 +526,7 @@
526
526
  "status": "online"
527
527
  },
528
528
  "ModifyExtendedService": {
529
- "document": "管理企业扩展服务\n\n- **直接开通的情形:** 若在操作过程中接口没有返回跳转链接,这表明无需进行任何跳转操作。此时,相应的企业拓展服务将会直接被开通或关闭。\n\n- **需要法人或者超管签署开通协议的情形:** 当需要开通以下企业拓展服务时, 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成服务的开通操作。\n - **AUTO_SIGN(企业自动签)**\n - **DOWNLOAD_FLOW(授权渠道下载合同)**\n - **OVERSEA_SIGN(企业与港澳台居民签署合同)**\n\n注意: `在调用此接口以管理企业扩展服务时,操作者( Agent.ProxyOperator.OpenId)必须是企业的超级管理员(超管)或法人`\n\n\n对应的扩展服务能力可以在控制台的【扩展服务】中找到\n![image](https://qcloudimg.tencent-cloud.cn/raw/99eebd37883ec55ed1f1df3a57aee60a.png)",
529
+ "document": "管理企业扩展服务\n\n- **直接开通的情形:** 若在操作过程中接口没有返回跳转链接,这表明无需进行任何跳转操作。此时,相应的企业拓展服务将会直接被开通或关闭。\n\n- **需要法人或者超管签署开通协议的情形:** 当需要开通以下企业拓展服务时, 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成服务的开通操作。\n - **AUTO_SIGN(企业自动签)**\n - **DOWNLOAD_FLOW(授权渠道下载合同)**\n\n注意: `在调用此接口以管理企业扩展服务时,操作者( Agent.ProxyOperator.OpenId)必须是企业的超级管理员(超管)或法人`\n\n\n对应的扩展服务能力可以在控制台的【扩展服务】中找到\n![image](https://qcloudimg.tencent-cloud.cn/raw/99eebd37883ec55ed1f1df3a57aee60a.png)",
530
530
  "input": "ModifyExtendedServiceRequest",
531
531
  "name": "管理企业扩展服务",
532
532
  "output": "ModifyExtendedServiceResponse",
@@ -1068,7 +1068,7 @@
1068
1068
  },
1069
1069
  {
1070
1070
  "disabled": false,
1071
- "document": "合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。\n",
1071
+ "document": "合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。\n\n注\n1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。\n2. 请确保抄送人列表中的成员不与任何签署人重复。",
1072
1072
  "example": "无",
1073
1073
  "member": "CcInfo",
1074
1074
  "name": "CcInfos",
@@ -1136,43 +1136,39 @@
1136
1136
  "members": [
1137
1137
  {
1138
1138
  "disabled": false,
1139
- "document": "被抄送人手机号,大陆11位手机号",
1140
- "example": "xxx",
1139
+ "document": "被抄送方手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。",
1140
+ "example": "13200000000",
1141
1141
  "member": "string",
1142
1142
  "name": "Mobile",
1143
1143
  "required": false,
1144
- "type": "string",
1145
- "value_allowed_null": false
1144
+ "type": "string"
1146
1145
  },
1147
1146
  {
1148
1147
  "disabled": false,
1149
- "document": "被抄送人姓名",
1150
- "example": "",
1148
+ "document": "被抄送方姓名。\n抄送方的姓名将用于身份认证,请确保填写的姓名为抄送方的真实姓名,而非昵称等代名。",
1149
+ "example": "典子谦",
1151
1150
  "member": "string",
1152
1151
  "name": "Name",
1153
1152
  "required": false,
1154
- "type": "string",
1155
- "value_allowed_null": true
1153
+ "type": "string"
1156
1154
  },
1157
1155
  {
1158
1156
  "disabled": false,
1159
- "document": "被抄送人类型\n0--个人. 1--员工",
1160
- "example": "",
1157
+ "document": "被抄送方类型, 可设置以下类型:\n<ul><li> **0** :个人抄送方</li>\n<li> **1** :企业员工抄送方</li></ul>",
1158
+ "example": "1",
1161
1159
  "member": "int64",
1162
1160
  "name": "CcType",
1163
1161
  "required": false,
1164
- "type": "int",
1165
- "value_allowed_null": true
1162
+ "type": "int"
1166
1163
  },
1167
1164
  {
1168
1165
  "disabled": false,
1169
- "document": "被抄送人权限\n0--可查看\n1--可查看也可下载",
1170
- "example": "",
1166
+ "document": "被抄送方权限, 可设置如下权限:\n<ul><li> **0** :可查看合同内容</li>\n<li> **1** :可查看合同内容也可下载原文</li></ul>",
1167
+ "example": "1",
1171
1168
  "member": "int64",
1172
1169
  "name": "CcPermission",
1173
1170
  "required": false,
1174
- "type": "int",
1175
- "value_allowed_null": true
1171
+ "type": "int"
1176
1172
  }
1177
1173
  ],
1178
1174
  "usage": "in"
@@ -1628,7 +1624,7 @@
1628
1624
  "members": [
1629
1625
  {
1630
1626
  "disabled": false,
1631
- "document": "批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。\n注:\n`1. ApproverType目前只支持个人类型的签署人。`\n`2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`\n`3. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`",
1627
+ "document": "批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。\n<ul>\n<li>若为个人参与方:ApproverType:\"PERSON\"</li>\n<li>若为企业参与方:ApproverType:\"ORGANIZATION\"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,还需要传 OpenId、OrganizationOpenId。</li>\n</ul>\n\n注:\n`1. 暂不支持签署人拖动签署控件功能,以及签批控件。`\n`2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`",
1632
1628
  "example": "无",
1633
1629
  "member": "FlowApproverInfo",
1634
1630
  "name": "FlowApproverInfo",
@@ -1673,7 +1669,7 @@
1673
1669
  },
1674
1670
  {
1675
1671
  "disabled": false,
1676
- "document": "指定批量签署合同的签名类型,可传递以下值:\n<ul><li>**0**:手写签名(默认)</li>\n<li>**1**:OCR楷体</li>\n<li>**2**:姓名印章</li>\n<li>**3**:图片印章</li>\n<li>**4**:系统签名</li></ul>\n注:\n<ul><li>默认情况下,签名类型为手写签名</li>\n<li>您可以传递多种值,表示可用多种签名类型。</li>\n<li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li></ul>",
1672
+ "document": "指定批量签署合同的签名类型,可传递以下值:\n<ul><li>**0**:手写签名(默认)</li>\n<li>**1**:OCR楷体</li>\n<li>**2**:姓名印章</li>\n<li>**3**:图片印章</li>\n<li>**4**:系统签名</li></ul>\n注:\n<ul><li>默认情况下,签名类型为手写签名</li>\n<li>您可以传递多种值,表示可用多种签名类型。</li>\n<li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li>\n<li>若签署方为企业员工,此参数无效,签名方式将以合同中为准。</li>\n</ul>",
1677
1673
  "example": "[0, 1, 2, 3, 4]",
1678
1674
  "member": "int64",
1679
1675
  "name": "SignatureTypes",
@@ -1700,7 +1696,7 @@
1700
1696
  },
1701
1697
  {
1702
1698
  "disabled": false,
1703
- "document": "批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。\t",
1699
+ "document": "批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。\t\n\n注: `若签署方为企业员工,暂不支持通过H5端进行动态签署人的补充`",
1704
1700
  "example": "无",
1705
1701
  "member": "FlowBatchUrlInfo",
1706
1702
  "name": "FlowBatchUrlInfo",
@@ -1718,7 +1714,7 @@
1718
1714
  },
1719
1715
  {
1720
1716
  "disabled": false,
1721
- "document": "是否开启缓存签署人信息",
1717
+ "document": "缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。\n\n注: `若参与方为企业员工时,暂不支持对参与方信息进行缓存`",
1722
1718
  "example": "无",
1723
1719
  "member": "bool",
1724
1720
  "name": "CacheApproverInfo",
@@ -2247,7 +2243,7 @@
2247
2243
  },
2248
2244
  {
2249
2245
  "disabled": false,
2250
- "document": "合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的<a href=\"https://qian.tencent.com/developers/partnerApis/dataTypes/#flowapproverinfo\" target=\"_blank\">FlowApproverInfo结构体</a>。\n\n如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。",
2246
+ "document": "合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。\n\n如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。",
2251
2247
  "example": "无",
2252
2248
  "member": "FlowApproverInfo",
2253
2249
  "name": "FlowApprovers",
@@ -2355,7 +2351,7 @@
2355
2351
  },
2356
2352
  {
2357
2353
  "disabled": false,
2358
- "document": "合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。",
2354
+ "document": "合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。\n\n<b>注</b>\n1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。\n2. 请确保抄送人列表中的成员不与任何签署人重复。",
2359
2355
  "example": "无",
2360
2356
  "member": "CcInfo",
2361
2357
  "name": "CcInfos",
@@ -2939,6 +2935,15 @@
2939
2935
  "name": "ForbidPersonalMultipleSign",
2940
2936
  "required": false,
2941
2937
  "type": "bool"
2938
+ },
2939
+ {
2940
+ "disabled": false,
2941
+ "document": "合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。",
2942
+ "example": "true",
2943
+ "member": "bool",
2944
+ "name": "FlowNameAppendScannerInfo",
2945
+ "required": false,
2946
+ "type": "bool"
2942
2947
  }
2943
2948
  ],
2944
2949
  "type": "object"
@@ -3411,7 +3416,7 @@
3411
3416
  },
3412
3417
  {
3413
3418
  "disabled": false,
3414
- "document": "指定解除协议的签署人,如不指定,则默认使用原流程的签署人。 <br/>\n如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href=\"https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/\">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号,默认从0开始,顺序递增)<br/>\n\n注意:\n<ul>\n<li>只能更换自己企业的签署人,不支持更换个人类型或者其他企业的签署人</li>\n<li>可以不指定替换签署人,使用原流程的签署人</li>\n</ul>",
3419
+ "document": "替换解除协议的签署人, 如不指定新的签署人,将继续使用原流程的签署人作为本解除协议的参与方。 <br/>\n如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href=\"https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/\">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号,默认从0开始,顺序递增)<br/>\n\n注:\n1. 支持更换企业的签署人,不支持更换个人类型的签署人。\n2. 己方企业支持自动签署,他方企业不支持自动签署。\n3. <b>仅将需要替换的签署人添加至此列表</b>,无需替换的签署人无需添加进来。",
3415
3420
  "example": "无",
3416
3421
  "member": "ReleasedApprover",
3417
3422
  "name": "ReleasedApprovers",
@@ -5735,7 +5740,7 @@
5735
5740
  },
5736
5741
  {
5737
5742
  "disabled": false,
5738
- "document": "**如果是Component填写控件类型,则可选的字段为**:\n\n<ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>\n<li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>\n<li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>\n<li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>\n\n**如果是SignComponent签署控件类型,\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li></ul>\n \n注:` 表单域的控件不能作为印章和签名控件`",
5743
+ "document": "**如果是Component填写控件类型,则可选的字段为**:\n\n<ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>\n<li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>\n<li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>\n<li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>\n\n**如果是SignComponent签署控件类型,\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li></ul>\n \n注:` 表单域的控件不能作为印章和签名控件`",
5739
5744
  "example": "SIGN_SEAL",
5740
5745
  "member": "string",
5741
5746
  "name": "ComponentType",
@@ -5856,7 +5861,7 @@
5856
5861
  },
5857
5862
  {
5858
5863
  "disabled": false,
5859
- "document": "**在所有的定位方式下**,控件的扩展参数,为<font color=\"red\">JSON格式</font>,不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围12 :72</li>\n<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围12 :72</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>,支持以下参数:\n<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>:`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li></ul>\n<b>参考样例</b>:`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\",如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n<b>参数样例</b>: ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能,当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>,可以通过以下参数设置签署图片的旋转角度:\n<ul><li> <b>Rotate</b>:旋转角度,支持范围:-360:360,为正整数时,为顺时针旋转;为负整数时,为逆时针旋转。</li>\n<li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>\n<b>参数样例</b>:`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`",
5864
+ "document": "**在所有的定位方式下**,控件的扩展参数,为<font color=\"red\">JSON格式</font>,不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围12 :72</li>\n<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>: 范围12 :72</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>,支持以下参数:\n<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>:`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li></ul>\n<b>参考样例</b>:`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\",如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n<b>参数样例</b>: ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能,当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>,可以通过以下参数设置签署图片的旋转角度:\n<ul><li> <b>Rotate</b>:旋转角度,支持范围:-360:360,为正整数时,为顺时针旋转;为负整数时,为逆时针旋转。</li>\n<li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>\n<b>参数样例</b>:`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:\n<ul><li> <b>Opacity</b>:印章透明度,支持范围:0-1,0.7表示70%的透明度,1表示无透明度</li></ul>\n<b>参数样例</b>:`{\"Opacity\":0.7}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`",
5860
5865
  "example": "ComponentExtra",
5861
5866
  "member": "string",
5862
5867
  "name": "ComponentExtra",
@@ -7123,7 +7128,7 @@
7123
7128
  },
7124
7129
  {
7125
7130
  "disabled": false,
7126
- "document": "被授企业id,和AuthorizedOrganizationName二选一,不能同时为空\n注:`被授权企业必须和当前企业在同一应用号下`",
7131
+ "document": "被授企业id/授权方企业id(即OrganizationId),如果是企业之间授权和AuthorizedOrganizationName二选一传入。\n\n注:`被授权企业必须和当前企业在同一应用号下`",
7127
7132
  "example": "无",
7128
7133
  "member": "string",
7129
7134
  "name": "AuthorizedOrganizationId",
@@ -7132,7 +7137,7 @@
7132
7137
  },
7133
7138
  {
7134
7139
  "disabled": false,
7135
- "document": "被授权企业名,和AuthorizedOrganizationId二选一,不能同时为空\n注:`被授权企业必须和当前企业在同一应用号下`",
7140
+ "document": "被授企业名称/授权方企业的名字,如果是企业之间授权和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。\n\n注: \n1. 如果名称中包含英文括号(),请使用中文括号()代替。\n2. 被授权企业必须和当前企业在同一应用号下",
7136
7141
  "example": "无",
7137
7142
  "member": "string",
7138
7143
  "name": "AuthorizedOrganizationName",
@@ -7141,7 +7146,7 @@
7141
7146
  },
7142
7147
  {
7143
7148
  "disabled": false,
7144
- "document": "是否给平台应用授权:\n- true: 是(无需设置AuthorizedOrganizationIdAuthorizedOrganizationName)\n- false: 否(默认)\n 注:该参数需要开通“基于子客授权第三方应用可文件发起子客自动签署”,请联系运营经理开通\n",
7149
+ "document": "是否给平台应用授权\n\n<ul>\n<li><strong>true</strong>: 表示是,授权平台应用。在此情况下,无需设置<code>AuthorizedOrganizationId</code>和<code>AuthorizedOrganizationName</code>。</li>\n<li><strong>false</strong>: (默认)表示否,不是授权平台应用。</li>\n</ul>\n\n 注:授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客自动签署】白名单,请联系运营经理开通。",
7145
7150
  "example": "无",
7146
7151
  "member": "bool",
7147
7152
  "name": "PlatformAppAuthorization",
@@ -7150,7 +7155,7 @@
7150
7155
  },
7151
7156
  {
7152
7157
  "disabled": false,
7153
- "document": "指定印章类型,指定后只能选择该类型的印章进行授权\n支持以下印章类型:\n- OFFICIAL : 企业公章\n- CONTRACT : 合同专用章\n- FINANCE : 财务专用章\n- PERSONNEL : 人事专用章",
7158
+ "document": "在设置印章授权时,可以指定特定的印章类型,以确保在授权过程中只使用相应类型的印章。支持的印章类型包括:\n\n<ul>\n<li><strong>OFFICIAL</strong>:企业公章,用于代表企业对外的正式文件和重要事务的认证。</li>\n<li><strong>CONTRACT</strong>:合同专用章,专门用于签署各类合同。</li>\n<li><strong>FINANCE</strong>:财务专用章,用于企业的财务相关文件,如发票、收据等财务凭证的认证。</li>\n<li><strong>PERSONNEL</strong>:人事专用章,用于人事管理相关文件,如劳动合同、人事任命等。</li>\n</ul>",
7154
7159
  "example": "无",
7155
7160
  "member": "string",
7156
7161
  "name": "SealTypes",
@@ -7159,7 +7164,7 @@
7159
7164
  },
7160
7165
  {
7161
7166
  "disabled": false,
7162
- "document": "他方授权给我方:- false:我方授权他方,AuthorizedOrganizationName代表【被授权方】企业名称- true:他方授权我方,AuthorizedOrganizationName代表【授权方】企业名称",
7167
+ "document": "在处理授权关系时,授权的方向\n<ul>\n<li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li>\n<li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li>\n</ul>",
7163
7168
  "example": "无",
7164
7169
  "member": "bool",
7165
7170
  "name": "AuthToMe",
@@ -7287,7 +7292,7 @@
7287
7292
  },
7288
7293
  {
7289
7294
  "disabled": false,
7290
- "document": "CA供应商下发给用户的证书编号,在证书到期后自动续期后此证书编号会发生变动,且不会合成到个人用户证书证明图片中。注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下。`\n注意:此字段可能返回 null,表示取不到有效值。",
7295
+ "document": "在数字证书申请过程中,系统会自动生成一个独一无二的序列号。请注意,当证书到期并自动续期时,该序列号将会发生变化。值得注意的是,此序列号不会被合成至个人用户证书的证明图片中。\n注意:此字段可能返回 null,表示取不到有效值。",
7291
7296
  "example": "2206EB**4597742",
7292
7297
  "member": "string",
7293
7298
  "name": "SerialNumber",
@@ -7547,7 +7552,7 @@
7547
7552
  },
7548
7553
  {
7549
7554
  "disabled": false,
7550
- "document": "第三方平台子客企业的企业的标识, 即OrganizationOpenId\n注: `GenerateType为\"CHANNEL\"时必填`",
7555
+ "document": "第三方平台子客企业的企业的标识, 即OrganizationOpenId注: `1.GenerateType为\"CHANNEL\"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`",
7551
7556
  "example": "org_dianziqian",
7552
7557
  "member": "string",
7553
7558
  "name": "OrganizationOpenId",
@@ -9907,7 +9912,7 @@
9907
9912
  },
9908
9913
  {
9909
9914
  "disabled": false,
9910
- "document": "合同流程的参与方列表,最多可支持50个参与方\n\n注: \n<font color=\"red\" > <b> 在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。\n例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font>\n\n[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)\n",
9915
+ "document": "合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)\n\n注: \n<font color=\"red\" > <b> 在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。\n例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font>\n\n[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)\n",
9911
9916
  "example": "签署人信息",
9912
9917
  "member": "FlowApproverInfo",
9913
9918
  "name": "FlowApprovers",
@@ -9970,7 +9975,7 @@
9970
9975
  },
9971
9976
  {
9972
9977
  "disabled": false,
9973
- "document": "合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。",
9978
+ "document": "合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。\n\n<b>注</b>\n1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。\n2. 请确保抄送人列表中的成员不与任何签署人重复。",
9974
9979
  "example": " ",
9975
9980
  "member": "CcInfo",
9976
9981
  "name": "CcInfos",
@@ -10379,7 +10384,7 @@
10379
10384
  },
10380
10385
  {
10381
10386
  "disabled": false,
10382
- "document": " 扩展服务类型\n<ul>\n<li>AUTO_SIGN 企业自动签(自动签署)</li>\n<li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>\n<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>\n<li> PAGING_SEAL 骑缝章</li>\n<li> DOWNLOAD_FLOW 授权渠道下载合同 </li>\n<li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>\n<li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>\n</ul>",
10387
+ "document": " 扩展服务类型\n<ul>\n<li>AUTO_SIGN 企业自动签(自动签署)</li>\n<li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>\n<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>\n<li> DOWNLOAD_FLOW 授权渠道下载合同 </li>\n<li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>\n<li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>\n</ul>",
10383
10388
  "example": "AUTO_SIGN",
10384
10389
  "member": "string",
10385
10390
  "name": "ServiceType",
@@ -10412,7 +10417,7 @@
10412
10417
  "members": [
10413
10418
  {
10414
10419
  "disabled": false,
10415
- "document": "操作跳转链接\n<ul><li><strong>链接有效期:</strong> 跳转链接的有效期为24小时。</li>\n<li><strong>没有返回链接的情形:</strong> 如果在操作时没有返回跳转链接,说明此次操作无需进行跳转,服务将会直接被开通或关闭。</li>\n<li><strong>返回链接的情形:</strong> 当操作类型为<b>OPEN(开通服务)</b>,并且扩展服务类型为<b>AUTO_SIGN( 企业自动签署)</b>、<b>DOWNLOAD_FLOW(授权渠道下载合同)</b>或<b>OVERSEA_SIGN(企业与港澳台居民签署合同)</b>时,系统将返回一个操作链接。收到操作链接后,贵方需主动联系超级管理员(超管)或法人。<font color=\"red\"><b>由超管或法人点击链接</b></font>,以完成服务的开通操作。</li>\n</ul>\n\n",
10420
+ "document": "操作跳转链接\n<ul><li><strong>链接有效期:</strong> 跳转链接的有效期为24小时。</li>\n<li><strong>没有返回链接的情形:</strong> 如果在操作时没有返回跳转链接,说明此次操作无需进行跳转,服务将会直接被开通或关闭。</li>\n<li><strong>返回链接的情形:</strong> 当操作类型为<b>OPEN(开通服务)</b>,并且扩展服务类型为<b>AUTO_SIGN( 企业自动签署)</b>、<b>DOWNLOAD_FLOW(授权渠道下载合同)</b>时,系统将返回一个操作链接。收到操作链接后,贵方需主动联系超级管理员(超管)或法人。<font color=\"red\"><b>由超管或法人点击链接</b></font>,以完成服务的开通操作。</li>\n</ul>\n\n",
10416
10421
  "example": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=OPEN_SERVER_SIGN&request_token=xxxxx&organizationId=xxxxx&channelType=xxxxx&expired_time=1673428532&login=1&verify=1",
10417
10422
  "member": "string",
10418
10423
  "name": "OperateUrl",
@@ -10937,7 +10942,7 @@
10937
10942
  },
10938
10943
  {
10939
10944
  "disabled": false,
10940
- "document": "CA供应商下发给用户的证书编号\n\n注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下`。",
10945
+ "document": "在数字证书申请过程中,系统会自动生成一个独一无二的序列号。",
10941
10946
  "example": "6c8e2911fadf70ea",
10942
10947
  "member": "string",
10943
10948
  "name": "CertSn",