tccli 3.0.1090.1__py2.py3-none-any.whl → 3.0.1092.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 (182) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/examples/ccc/v20200210/UploadIvrAudio.md +16 -1
  3. tccli/examples/cdb/v20170320/CheckMigrateCluster.md +18 -0
  4. tccli/examples/cdb/v20170320/DescribeClusterInfo.md +59 -0
  5. tccli/examples/csip/v20221121/DescribeAssetViewVulRiskList.md +5 -302
  6. tccli/examples/domain/v20180808/BidPreDomains.md +21 -0
  7. tccli/examples/domain/v20180808/DescribeReservedBidInfo.md +43 -0
  8. tccli/examples/domain/v20180808/DescribeReservedPreDomainInfo.md +31 -0
  9. tccli/examples/es/v20180416/UpdateInstance.md +27 -27
  10. tccli/examples/es/v20180416/UpdatePlugins.md +6 -6
  11. tccli/examples/ess/v20201111/CreateBatchOrganizationRegistrationTasks.md +146 -0
  12. tccli/examples/ess/v20201111/CreateOrganizationAuthUrl.md +18 -0
  13. tccli/examples/ess/v20201111/CreateOrganizationBatchSignUrl.md +28 -0
  14. tccli/examples/gs/v20191118/StartPublishStreamToCSS.md +20 -0
  15. tccli/examples/hunyuan/v20230901/ChatPro.md +69 -31
  16. tccli/examples/hunyuan/v20230901/ChatStd.md +40 -1
  17. tccli/examples/lke/v20231130/CheckAttributeLabelExist.md +24 -0
  18. tccli/examples/lke/v20231130/CheckAttributeLabelRefer.md +23 -0
  19. tccli/examples/lke/v20231130/CreateApp.md +24 -0
  20. tccli/examples/lke/v20231130/CreateAttributeLabel.md +24 -0
  21. tccli/examples/lke/v20231130/CreateCorp.md +24 -0
  22. tccli/examples/lke/v20231130/CreateQA.md +24 -0
  23. tccli/examples/lke/v20231130/CreateQACate.md +26 -0
  24. tccli/examples/lke/v20231130/CreateRejectedQuestion.md +22 -0
  25. tccli/examples/lke/v20231130/CreateRelease.md +21 -0
  26. tccli/examples/lke/v20231130/DeleteApp.md +21 -0
  27. tccli/examples/lke/v20231130/DeleteAttributeLabel.md +21 -0
  28. tccli/examples/lke/v20231130/DeleteDoc.md +21 -0
  29. tccli/examples/lke/v20231130/DeleteQA.md +21 -0
  30. tccli/examples/lke/v20231130/DeleteQACate.md +21 -0
  31. tccli/examples/lke/v20231130/DeleteRejectedQuestion.md +21 -0
  32. tccli/examples/lke/v20231130/DescribeApp.md +29 -0
  33. tccli/examples/lke/v20231130/DescribeAttributeLabel.md +28 -0
  34. tccli/examples/lke/v20231130/DescribeCorp.md +21 -0
  35. tccli/examples/lke/v20231130/DescribeDoc.md +44 -0
  36. tccli/examples/lke/v20231130/DescribeQA.md +42 -0
  37. tccli/examples/lke/v20231130/DescribeRefer.md +35 -0
  38. tccli/examples/lke/v20231130/DescribeRelease.md +25 -0
  39. tccli/examples/lke/v20231130/DescribeReleaseInfo.md +24 -0
  40. tccli/examples/lke/v20231130/DescribeRobotBizIDByAppKey.md +21 -0
  41. tccli/examples/lke/v20231130/DescribeStorageCredential.md +32 -0
  42. tccli/examples/lke/v20231130/DescribeUnsatisfiedReplyContext.md +121 -0
  43. tccli/examples/lke/v20231130/ExportAttributeLabel.md +21 -0
  44. tccli/examples/lke/v20231130/ExportQAList.md +21 -0
  45. tccli/examples/lke/v20231130/ExportUnsatisfiedReply.md +21 -0
  46. tccli/examples/lke/v20231130/GenerateQA.md +21 -0
  47. tccli/examples/lke/v20231130/GetAppKnowledgeCount.md +22 -0
  48. tccli/examples/lke/v20231130/GetAppSecret.md +24 -0
  49. tccli/examples/lke/v20231130/GetDocPreview.md +26 -0
  50. tccli/examples/lke/v20231130/GetEmbedding.md +29 -0
  51. tccli/examples/lke/v20231130/GetMsgRecord.md +51 -0
  52. tccli/examples/lke/v20231130/GetTaskStatus.md +0 -0
  53. tccli/examples/lke/v20231130/GetWsToken.md +44 -0
  54. tccli/examples/lke/v20231130/GroupQA.md +44 -0
  55. tccli/examples/lke/v20231130/IgnoreUnsatisfiedReply.md +21 -0
  56. tccli/examples/lke/v20231130/IsTransferIntent.md +22 -0
  57. tccli/examples/lke/v20231130/ListApp.md +36 -0
  58. tccli/examples/lke/v20231130/ListAppCategory.md +25 -0
  59. tccli/examples/lke/v20231130/ListAttributeLabel.md +33 -0
  60. tccli/examples/lke/v20231130/ListDoc.md +52 -0
  61. tccli/examples/lke/v20231130/ListModel.md +31 -0
  62. tccli/examples/lke/v20231130/ListQA.md +66 -0
  63. tccli/examples/lke/v20231130/ListQACate.md +41 -0
  64. tccli/examples/lke/v20231130/ListRejectedQuestion.md +52 -0
  65. tccli/examples/lke/v20231130/ListRejectedQuestionPreview.md +37 -0
  66. tccli/examples/lke/v20231130/ListRelease.md +36 -0
  67. tccli/examples/lke/v20231130/ListReleaseConfigPreview.md +129 -0
  68. tccli/examples/lke/v20231130/ListReleaseDocPreview.md +38 -0
  69. tccli/examples/lke/v20231130/ListReleaseQAPreview.md +107 -0
  70. tccli/examples/lke/v20231130/ListSelectDoc.md +27 -0
  71. tccli/examples/lke/v20231130/ListUnsatisfiedReply.md +24 -0
  72. tccli/examples/lke/v20231130/ModifyApp.md +25 -0
  73. tccli/examples/lke/v20231130/ModifyAttributeLabel.md +23 -0
  74. tccli/examples/lke/v20231130/ModifyDoc.md +25 -0
  75. tccli/examples/lke/v20231130/ModifyDocAttrRange.md +25 -0
  76. tccli/examples/lke/v20231130/ModifyQA.md +24 -0
  77. tccli/examples/lke/v20231130/ModifyQAAttrRange.md +25 -0
  78. tccli/examples/lke/v20231130/ModifyQACate.md +22 -0
  79. tccli/examples/lke/v20231130/ModifyRejectedQuestion.md +22 -0
  80. tccli/examples/lke/v20231130/ParseDoc.md +25 -0
  81. tccli/examples/lke/v20231130/QueryParseDocResult.md +24 -0
  82. tccli/examples/lke/v20231130/QueryRewrite.md +25 -0
  83. tccli/examples/lke/v20231130/RateMsgRecord.md +22 -0
  84. tccli/examples/lke/v20231130/ResetSession.md +20 -0
  85. tccli/examples/lke/v20231130/RetryDocAudit.md +21 -0
  86. tccli/examples/lke/v20231130/RetryDocParse.md +21 -0
  87. tccli/examples/lke/v20231130/RetryRelease.md +21 -0
  88. tccli/examples/lke/v20231130/SaveDoc.md +34 -0
  89. tccli/examples/lke/v20231130/StopDocParse.md +21 -0
  90. tccli/examples/lke/v20231130/UploadAttributeLabel.md +27 -0
  91. tccli/examples/lke/v20231130/VerifyQA.md +27 -0
  92. tccli/examples/mna/v20210119/GetFlowPackages.md +3 -1
  93. tccli/examples/mna/v20210119/GetFlowStatistic.md +42 -0
  94. tccli/examples/ocr/v20181119/GeneralBasicOCR.md +0 -1
  95. tccli/examples/organization/v20210331/AddOrganizationNode.md +1 -1
  96. tccli/examples/organization/v20210331/BindOrganizationMemberAuthAccount.md +3 -3
  97. tccli/examples/organization/v20210331/CancelOrganizationMemberAuthAccount.md +3 -3
  98. tccli/examples/organization/v20210331/CheckAccountDelete.md +5 -5
  99. tccli/examples/organization/v20210331/CreateOrganizationMember.md +2 -2
  100. tccli/examples/organization/v20210331/CreateOrganizationMemberAuthIdentity.md +1 -1
  101. tccli/examples/organization/v20210331/CreateOrganizationMemberPolicy.md +5 -5
  102. tccli/examples/organization/v20210331/CreateOrganizationMembersPolicy.md +2 -2
  103. tccli/examples/organization/v20210331/DeleteOrganizationMembers.md +1 -1
  104. tccli/examples/organization/v20210331/DeleteOrganizationNodes.md +1 -1
  105. tccli/examples/organization/v20210331/DeleteShareUnitResources.md +1 -1
  106. tccli/examples/organization/v20210331/DescribeOrganizationMemberAuthAccounts.md +2 -2
  107. tccli/examples/organization/v20210331/DescribeOrganizationMemberPolicies.md +1 -1
  108. tccli/examples/organization/v20210331/MoveOrganizationNodeMembers.md +2 -2
  109. tccli/examples/organization/v20210331/QuitOrganization.md +1 -1
  110. tccli/examples/organization/v20210331/UpdateOrganizationMember.md +2 -2
  111. tccli/examples/organization/v20210331/UpdateOrganizationMemberEmailBind.md +3 -3
  112. tccli/examples/organization/v20210331/UpdateOrganizationNode.md +3 -2
  113. tccli/examples/sqlserver/v20180328/DescribeDBInstancesAttribute.md +7 -1
  114. tccli/examples/sqlserver/v20180328/DescribeRestoreTimeRange.md +23 -0
  115. tccli/examples/ssl/v20191205/DeployCertificateInstance.md +26 -1
  116. tccli/examples/tione/v20211111/CreateBatchTask.md +1 -0
  117. tccli/services/__init__.py +3 -0
  118. tccli/services/aiart/v20221229/api.json +7 -7
  119. tccli/services/antiddos/v20200309/api.json +10 -0
  120. tccli/services/asr/v20190614/api.json +6 -6
  121. tccli/services/captcha/v20190722/api.json +75 -31
  122. tccli/services/ccc/v20200210/api.json +10 -0
  123. tccli/services/ccc/v20200210/examples.json +1 -1
  124. tccli/services/cdb/cdb_client.py +106 -0
  125. tccli/services/cdb/v20170320/api.json +255 -0
  126. tccli/services/cdb/v20170320/examples.json +16 -0
  127. tccli/services/cdn/v20180606/api.json +4 -4
  128. tccli/services/cfg/v20210820/api.json +30 -33
  129. tccli/services/ckafka/v20190819/api.json +29 -24
  130. tccli/services/csip/v20221121/api.json +17 -11
  131. tccli/services/csip/v20221121/examples.json +1 -1
  132. tccli/services/domain/domain_client.py +114 -8
  133. tccli/services/domain/v20180808/api.json +174 -1
  134. tccli/services/domain/v20180808/examples.json +22 -0
  135. tccli/services/dts/v20211206/api.json +22 -2
  136. tccli/services/es/v20180416/api.json +12 -12
  137. tccli/services/es/v20180416/examples.json +21 -21
  138. tccli/services/ess/ess_client.py +149 -43
  139. tccli/services/ess/v20201111/api.json +215 -5
  140. tccli/services/ess/v20201111/examples.json +34 -0
  141. tccli/services/essbasic/v20210526/api.json +15 -15
  142. tccli/services/faceid/v20180301/api.json +14 -5
  143. tccli/services/gs/gs_client.py +53 -0
  144. tccli/services/gs/v20191118/api.json +43 -0
  145. tccli/services/gs/v20191118/examples.json +8 -0
  146. tccli/services/hunyuan/v20230901/api.json +67 -21
  147. tccli/services/hunyuan/v20230901/examples.json +17 -5
  148. tccli/services/iai/v20180301/api.json +19 -19
  149. tccli/services/iss/v20230517/api.json +38 -0
  150. tccli/services/live/v20180801/api.json +12 -12
  151. tccli/services/lke/__init__.py +4 -0
  152. tccli/services/lke/lke_client.py +4117 -0
  153. tccli/services/lke/v20231130/api.json +9010 -0
  154. tccli/services/lke/v20231130/examples.json +617 -0
  155. tccli/services/mna/v20210119/api.json +249 -29
  156. tccli/services/mna/v20210119/examples.json +7 -1
  157. tccli/services/monitor/monitor_client.py +0 -53
  158. tccli/services/monitor/v20180724/api.json +30 -62
  159. tccli/services/monitor/v20180724/examples.json +0 -8
  160. tccli/services/ocr/v20181119/api.json +5 -0
  161. tccli/services/ocr/v20181119/examples.json +1 -1
  162. tccli/services/organization/v20210331/api.json +128 -119
  163. tccli/services/organization/v20210331/examples.json +24 -24
  164. tccli/services/redis/v20180412/api.json +1 -1
  165. tccli/services/scf/v20180416/api.json +18 -9
  166. tccli/services/sms/v20210111/api.json +1 -1
  167. tccli/services/soe/v20180724/api.json +13 -13
  168. tccli/services/sqlserver/sqlserver_client.py +110 -57
  169. tccli/services/sqlserver/v20180328/api.json +109 -0
  170. tccli/services/sqlserver/v20180328/examples.json +9 -1
  171. tccli/services/ssl/v20191205/examples.json +7 -1
  172. tccli/services/tione/v20211111/api.json +61 -4
  173. tccli/services/tione/v20211111/examples.json +1 -1
  174. tccli/services/trtc/v20190722/api.json +79 -10
  175. tccli/services/wedata/v20210820/api.json +295 -1437
  176. tccli/services/wedata/v20210820/examples.json +0 -88
  177. tccli/services/wedata/wedata_client.py +33 -616
  178. {tccli-3.0.1090.1.dist-info → tccli-3.0.1092.1.dist-info}/METADATA +2 -2
  179. {tccli-3.0.1090.1.dist-info → tccli-3.0.1092.1.dist-info}/RECORD +182 -95
  180. {tccli-3.0.1090.1.dist-info → tccli-3.0.1092.1.dist-info}/WHEEL +0 -0
  181. {tccli-3.0.1090.1.dist-info → tccli-3.0.1092.1.dist-info}/entry_points.txt +0 -0
  182. {tccli-3.0.1090.1.dist-info → tccli-3.0.1092.1.dist-info}/license_files/LICENSE +0 -0
@@ -35,6 +35,13 @@
35
35
  "output": "CreateBatchCancelFlowUrlResponse",
36
36
  "status": "online"
37
37
  },
38
+ "CreateBatchOrganizationRegistrationTasks": {
39
+ "document": "本接口(CreateBatchOrganizationRegistrationTasks)用于批量创建企业认证链接\n该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.\n\n批量创建链接有以下限制:\n\n1. 单次最多创建10个企业。\n2. 一天同一家企业最多创建8000家企业。\n3. 同一批创建的企业不能重复 其中包括 企业名称,企业统一信用代码\n4. 跳转到小程序的实现,参考微信官方文档(分为全屏、半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置\n\n注:\n\n1. **此接口需要购买单独的实名套餐包方可调用,如有需求请联系对接人员评估**\n \n2. 如果生成的链接是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>\n \n\n**腾讯电子签小程序的AppID 和 原始Id如下:**\n\n| 小程序 | AppID | 原始ID |\n| --- | --- | --- |\n| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |\n| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |",
40
+ "input": "CreateBatchOrganizationRegistrationTasksRequest",
41
+ "name": "创建企业批量认证链接",
42
+ "output": "CreateBatchOrganizationRegistrationTasksResponse",
43
+ "status": "online"
44
+ },
38
45
  "CreateBatchQuickSignUrl": {
39
46
  "document": "该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。\n**注意:**\n1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。\n2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件** 。\n3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。\n4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。\n5. 该接口返回的签署链接适用于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
47
  "input": "CreateBatchQuickSignUrlRequest",
@@ -182,8 +189,15 @@
182
189
  "output": "CreateMultiFlowSignQRCodeResponse",
183
190
  "status": "online"
184
191
  },
192
+ "CreateOrganizationAuthUrl": {
193
+ "document": "本接口(CreateOrganizationAuthUrl)用于生成创建企业认证链接。\n用于业务方系统自己生成认证链接进行跳转.而不用电子签自带的生成链接\n\n注: **此接口需要购买单独的实名套餐包方可调用,如有需求请联系对接人员评估**",
194
+ "input": "CreateOrganizationAuthUrlRequest",
195
+ "name": "创建企业认证链接",
196
+ "output": "CreateOrganizationAuthUrlResponse",
197
+ "status": "online"
198
+ },
185
199
  "CreateOrganizationBatchSignUrl": {
186
- "document": "使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。<br/>\n附注:\n- 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方。\n- 如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。\n- 仅支持待签署状态的合同生成签署链接。",
200
+ "document": "使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。<br/>\n附注:\n- 员工必须需作为批量签署合同的签署方,or或签合同的候选人之一。\n- 对于本方企业:如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。\n- 若要生成他发企业签署链接:应传RecipientIds,且制定的合同必须是接口调用方发起的。\n- 支持待签署、待填写状态的合同生成签署链接。",
187
201
  "input": "CreateOrganizationBatchSignUrlRequest",
188
202
  "name": "获取企业签署合同web页面",
189
203
  "output": "CreateOrganizationBatchSignUrlResponse",
@@ -693,7 +707,7 @@
693
707
  },
694
708
  {
695
709
  "disabled": false,
696
- "document": "通知签署方经办人的方式, 有以下途径:\n<ul><li> **sms** : (默认)短信</li>\n<li> **none** : 不通知</li></ul>\n```\n注意:\n如果使用的是通过文件发起合同(CreateFlowByFiles),NotifyType必须 是 sms 才会发送短信\n```",
710
+ "document": "通知签署方经办人的方式, 有以下途径:\n<ul><li> **sms** : (默认)短信</li>\n<li> **none** : 不通知</li></ul>\n\n注意:\n`如果使用的是通过文件发起合同(CreateFlowByFiles),NotifyType必须 是 sms 才会发送短信`",
697
711
  "example": "sms",
698
712
  "member": "string",
699
713
  "name": "NotifyType",
@@ -1127,7 +1141,7 @@
1127
1141
  },
1128
1142
  {
1129
1143
  "disabled": false,
1130
- "document": "开通成功后前端页面跳转的url,此字段的用法场景请联系客户经理确认。\n\n注:`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`\n\n跳转场景:\n<ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li>\n<li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL,只需满足 qianapp:// 开头的URL即可。`APP实现方,需要拦截Webview地址跳转,发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考:<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>,<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>\n\n成功结果返回:\n若贵方需要在跳转回时通过链接query参数提示开通成功,JumpUrl中的query应携带如下参数:`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功,比如 qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess",
1144
+ "document": "开通成功后前端页面跳转的url,此字段的用法场景请联系客户经理确认。\n\n注:`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`\n\n跳转场景:\n<ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li>\n<li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL,只需满足 qianapp:// 开头的URL即可。`APP实现方,需要拦截Webview地址跳转,发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考:<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>,<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>\n\n成功结果返回:\n若贵方需要在跳转回时通过链接query参数提示开通成功,JumpUrl中的query应携带如下参数:`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功,例如: qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess",
1131
1145
  "example": "无",
1132
1146
  "member": "string",
1133
1147
  "name": "JumpUrl",
@@ -1730,7 +1744,7 @@
1730
1744
  },
1731
1745
  {
1732
1746
  "disabled": false,
1733
- "document": "控件唯一ID。\n\n**在绝对定位方式方式下**,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。\n\n**在关键字定位方式下**,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。\n\n例:\n\n- 如传入的关键字<font color=\"red\">\"^甲方签署^\"</font >,则会在PDF文件中有且仅有\"甲方签署\"关键字的地方(<font color=\"red\">前后不能有其他字符</font >)进行对应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署</font >\",则PDF文件中每个出现关键字的位置(<font color=\"red\">前后可以有其他字符</font >)都会执行相应操作。\n- 如传入的关键字为<font color=\"red\">\"^甲方签署</font >\",则PDF文件中每个出现关键字的位置(<font color=\"red\">前面不能有其他字符</font >)都会执行相应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署^</font >\",则PDF文件中每个出现关键字的位置(<font color=\"red\">后面不能有其他字符</font >)都会执行相应操作。\n\n\n注:`控件ID可以在一个PDF中不可重复`\n\n<a href=\"https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png\" target=\"_blank\">点击查看ComponentId在模板编辑页面的位置</a>\n",
1747
+ "document": "控件唯一ID。\n\n**在绝对定位方式方式下**,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。\n\n**在关键字定位方式下**,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。\n\n例:\n\n- 如传入的关键字<font color=\"red\">\"^甲方签署^\"</font >,则会在PDF文件中有且仅有\"甲方签署\"关键字的地方(<font color=\"red\">前后不能有其他字符</font >)进行对应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署</font >\",则PDF文件中每个出现关键字的位置(<font color=\"red\">前后可以有其他字符</font >)都会执行相应操作。\n\n\n注:`控件ID可以在一个PDF中不可重复`\n\n<a href=\"https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png\" target=\"_blank\">点击查看ComponentId在模板编辑页面的位置</a>\n",
1734
1748
  "example": "无",
1735
1749
  "member": "string",
1736
1750
  "name": "ComponentId",
@@ -2038,6 +2052,80 @@
2038
2052
  ],
2039
2053
  "type": "object"
2040
2054
  },
2055
+ "CreateBatchOrganizationRegistrationTasksRequest": {
2056
+ "document": "CreateBatchOrganizationRegistrationTasks请求参数结构体",
2057
+ "members": [
2058
+ {
2059
+ "disabled": false,
2060
+ "document": "执行本接口操作的员工信息。\n注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
2061
+ "example": "无",
2062
+ "member": "UserInfo",
2063
+ "name": "Operator",
2064
+ "required": true,
2065
+ "type": "object"
2066
+ },
2067
+ {
2068
+ "disabled": false,
2069
+ "document": "组织机构注册信息。\n一次最多支持10条认证流",
2070
+ "example": "无",
2071
+ "member": "RegistrationOrganizationInfo",
2072
+ "name": "RegistrationOrganizations",
2073
+ "required": true,
2074
+ "type": "list"
2075
+ },
2076
+ {
2077
+ "disabled": false,
2078
+ "document": "代理企业和员工的信息。\n在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
2079
+ "example": "无",
2080
+ "member": "Agent",
2081
+ "name": "Agent",
2082
+ "required": false,
2083
+ "type": "object"
2084
+ },
2085
+ {
2086
+ "disabled": false,
2087
+ "document": "要生成链接的类型, 可以选择的值如下: \n\n<ul>\n<li>(默认)PC: 生成PC端的链接</li>\n<li>SHORT_URL: H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>\n<li>APP:生成小程序跳转链接</li>\n<li>H5:生成H5跳转长链接</li>\n<li>SHORT_H5:生成H5跳转短链</li>\n</ul>",
2088
+ "example": "PC",
2089
+ "member": "string",
2090
+ "name": "Endpoint",
2091
+ "required": false,
2092
+ "type": "string"
2093
+ }
2094
+ ],
2095
+ "type": "object"
2096
+ },
2097
+ "CreateBatchOrganizationRegistrationTasksResponse": {
2098
+ "document": "CreateBatchOrganizationRegistrationTasks返回参数结构体",
2099
+ "members": [
2100
+ {
2101
+ "disabled": false,
2102
+ "document": "生成注册链接的任务Id,\n根据这个id, 调用DescribeBatchOrganizationRegistrationUrls 获取生成的链接,进入认证流程",
2103
+ "example": "无",
2104
+ "member": "string",
2105
+ "name": "TaskId",
2106
+ "output_required": false,
2107
+ "type": "string",
2108
+ "value_allowed_null": false
2109
+ },
2110
+ {
2111
+ "disabled": false,
2112
+ "document": "批量生成企业认证链接的详细错误信息,\n顺序与输入参数保持一致。\n若企业认证均成功生成,则不返回错误信息;\n若存在任何错误,则返回具体的错误描述。",
2113
+ "example": "无",
2114
+ "member": "string",
2115
+ "name": "ErrorMessages",
2116
+ "output_required": false,
2117
+ "type": "list",
2118
+ "value_allowed_null": false
2119
+ },
2120
+ {
2121
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2122
+ "member": "string",
2123
+ "name": "RequestId",
2124
+ "type": "string"
2125
+ }
2126
+ ],
2127
+ "type": "object"
2128
+ },
2041
2129
  "CreateBatchQuickSignUrlRequest": {
2042
2130
  "document": "CreateBatchQuickSignUrl请求参数结构体",
2043
2131
  "members": [
@@ -4325,6 +4413,23 @@
4325
4413
  ],
4326
4414
  "type": "object"
4327
4415
  },
4416
+ "CreateOrganizationAuthUrlRequest": {
4417
+ "document": "CreateOrganizationAuthUrl请求参数结构体",
4418
+ "members": [],
4419
+ "type": "object"
4420
+ },
4421
+ "CreateOrganizationAuthUrlResponse": {
4422
+ "document": "CreateOrganizationAuthUrl返回参数结构体",
4423
+ "members": [
4424
+ {
4425
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
4426
+ "member": "string",
4427
+ "name": "RequestId",
4428
+ "type": "string"
4429
+ }
4430
+ ],
4431
+ "type": "object"
4432
+ },
4328
4433
  "CreateOrganizationBatchSignUrlRequest": {
4329
4434
  "document": "CreateOrganizationBatchSignUrl请求参数结构体",
4330
4435
  "members": [
@@ -4381,6 +4486,15 @@
4381
4486
  "name": "Mobile",
4382
4487
  "required": false,
4383
4488
  "type": "string"
4489
+ },
4490
+ {
4491
+ "disabled": false,
4492
+ "document": "为签署方经办人在签署合同中的参与方ID,必须与参数FlowIds数组一一对应。\n您可以通过查询合同接口(DescribeFlowInfo)查询此参数。\n若传了此参数,则可以不传 UserId, Name, Mobile等参数",
4493
+ "example": "无",
4494
+ "member": "string",
4495
+ "name": "RecipientIds",
4496
+ "required": false,
4497
+ "type": "list"
4384
4498
  }
4385
4499
  ],
4386
4500
  "type": "object"
@@ -8895,7 +9009,7 @@
8895
9009
  },
8896
9010
  {
8897
9011
  "disabled": false,
8898
- "document": "签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。\n\n<b>模板发起合同时,该参数为必填项,可以通过[查询模版信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。</b>\n<b>文件发起合同时,该参数无需传值。</b>\n\n如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。",
9012
+ "document": "签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。\n\n<b>模板发起合同时,该参数为必填项,可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。</b>\n<b>文件发起合同时,该参数无需传值。</b>\n\n如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。",
8899
9013
  "example": "无",
8900
9014
  "member": "string",
8901
9015
  "name": "RecipientId",
@@ -11221,6 +11335,102 @@
11221
11335
  ],
11222
11336
  "usage": "in"
11223
11337
  },
11338
+ "RegistrationOrganizationInfo": {
11339
+ "document": "企业认证信息参数, 需要保证这些参数跟营业执照中的信息一致。",
11340
+ "members": [
11341
+ {
11342
+ "disabled": false,
11343
+ "document": "组织机构名称。\n请确认该名称与企业营业执照中注册的名称一致。\n如果名称中包含英文括号(),请使用中文括号()代替。",
11344
+ "example": "无",
11345
+ "member": "string",
11346
+ "name": "OrganizationName",
11347
+ "required": true,
11348
+ "type": "string"
11349
+ },
11350
+ {
11351
+ "disabled": false,
11352
+ "document": "组织机构企业统一社会信用代码。\n请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。",
11353
+ "example": "无",
11354
+ "member": "string",
11355
+ "name": "UniformSocialCreditCode",
11356
+ "required": true,
11357
+ "type": "string"
11358
+ },
11359
+ {
11360
+ "disabled": false,
11361
+ "document": "组织机构法人的姓名。\n请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。",
11362
+ "example": "无",
11363
+ "member": "string",
11364
+ "name": "LegalName",
11365
+ "required": true,
11366
+ "type": "string"
11367
+ },
11368
+ {
11369
+ "disabled": false,
11370
+ "document": "组织机构企业注册地址。\n请确认该企业注册地址与企业营业执照中注册的地址一致。",
11371
+ "example": "深圳市南山区高新区科技中一路腾讯大厦35层",
11372
+ "member": "string",
11373
+ "name": "Address",
11374
+ "required": true,
11375
+ "type": "string"
11376
+ },
11377
+ {
11378
+ "disabled": false,
11379
+ "document": "组织机构超管姓名。\n在注册流程中,必须是超管本人进行操作。\n如果法人做为超管管理组织机构,超管姓名就是法人姓名",
11380
+ "example": "无",
11381
+ "member": "string",
11382
+ "name": "AdminName",
11383
+ "required": false,
11384
+ "type": "string"
11385
+ },
11386
+ {
11387
+ "disabled": false,
11388
+ "document": "组织机构超管姓名。\n在注册流程中,这个手机号必须跟操作人在电子签注册的个人手机号一致。",
11389
+ "example": "无",
11390
+ "member": "string",
11391
+ "name": "AdminMobile",
11392
+ "required": false,
11393
+ "type": "string"
11394
+ },
11395
+ {
11396
+ "disabled": false,
11397
+ "document": "可选的此企业允许的授权方式, 可以设置的方式有:\n1:上传授权书\n2:法人授权超管\n5:授权书+对公打款\n\n\n注:\n`1. 当前仅支持一种认证方式`\n`2. 如果当前的企业类型是政府/事业单位, 则只支持上传授权书+对公打款`\n`3. 如果当前操作人是法人,则是法人认证`",
11398
+ "example": "无",
11399
+ "member": "uint64",
11400
+ "name": "AuthorizationTypes",
11401
+ "required": false,
11402
+ "type": "list"
11403
+ },
11404
+ {
11405
+ "disabled": false,
11406
+ "document": "认证人身份证号",
11407
+ "example": "无",
11408
+ "member": "string",
11409
+ "name": "AdminIdCardNumber",
11410
+ "required": false,
11411
+ "type": "string"
11412
+ },
11413
+ {
11414
+ "disabled": false,
11415
+ "document": "认证人证件类型 \n支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n",
11416
+ "example": "无",
11417
+ "member": "string",
11418
+ "name": "AdminIdCardType",
11419
+ "required": false,
11420
+ "type": "string"
11421
+ },
11422
+ {
11423
+ "disabled": false,
11424
+ "document": "营业执照正面照(PNG或JPG) base64格式, 大小不超过5M",
11425
+ "example": "无",
11426
+ "member": "string",
11427
+ "name": "BusinessLicense",
11428
+ "required": false,
11429
+ "type": "string"
11430
+ }
11431
+ ],
11432
+ "usage": "in"
11433
+ },
11224
11434
  "ReleasedApprover": {
11225
11435
  "document": "解除协议的签署人,如不指定,默认使用原流程中的签署人。<br/>\n`注意:不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该C端签署人。`<br/>\n`注意:目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。`<br/>\n`注意:当指定C端签署人的签署方自定义控件别名不空时,除RelievedApproverReceiptId参数外,可以只参数ApproverSignRole。`<br/>",
11226
11436
  "members": [
@@ -88,6 +88,26 @@
88
88
  "title": "获取批量撤销签署流程链接部分成功"
89
89
  }
90
90
  ],
91
+ "CreateBatchOrganizationRegistrationTasks": [
92
+ {
93
+ "document": "",
94
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateBatchOrganizationRegistrationTasks\n<公共请求参数>\n\n{\n \"Operator\": {\n \"OpenId\": \"us-768d38720c10405f994539097f030a27\",\n \"UserId\": \"19561039c99fe825a934a132520fde6a\",\n \"Channel\": \"YUFU\",\n \"ClientIp\": \"8.8.8.8\"\n },\n \"RegistrationOrganizations\": [\n {\n \"OrganizationName\": \"测试认证企业一\",\n \"UniformSocialCreditCode\": \"9XXXXXXXXXXXXXXXX1\",\n \"LegalName\": \"鹅鹅子\",\n \"Address\": \"深圳市南山区1000号腾讯大厦\",\n \"AdminName\": \"鹅鹅子\",\n \"AdminMobile\": \"187XXXXXXX0\",\n \"AuthorizationTypes\": [\n 2\n ]\n },\n {\n \"OrganizationName\": \"测试认证企业二\",\n \"UniformSocialCreditCode\": \"9XXXXXXXXXXXXXXXX2\",\n \"LegalName\": \"鹅鹅子\",\n \"Address\": \"深圳市南山区1000号腾讯大厦\",\n \"AdminName\": \"鹅鹅子\",\n \"AdminMobile\": \"187XXXXXXX0\",\n \"AuthorizationTypes\": [\n 1\n ]\n },\n {\n \"OrganizationName\": \"测试认证企业三\",\n \"UniformSocialCreditCode\": \"9XXXXXXXXXXXXXXXX3\",\n \"LegalName\": \"鹅鹅子\",\n \"Address\": \"深圳市南山区1000号腾讯大厦\",\n \"AdminName\": \"鹅鹅子\",\n \"AdminMobile\": \"187XXXXXXX0\",\n \"AuthorizationTypes\": [\n 2\n ]\n }\n ]\n}",
95
+ "output": "{\n \"Response\": {\n \"TaskId\": \"abc\",\n \"ErrorMessages\": [\n \"\"\n ],\n \"RequestId\": \"f38013e59d00\"\n }\n}",
96
+ "title": "批量注册三家企业,成功创建任务"
97
+ },
98
+ {
99
+ "document": "测试认证企业三的地址没有按照省市区的格式传递",
100
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateBatchOrganizationRegistrationTasks\n<公共请求参数>\n\n{\n \"Operator\": {\n \"OpenId\": \"us-768d38720c10405f994539097f030a27\",\n \"UserId\": \"19561039c99fe825a934a132520fde6a\",\n \"Channel\": \"YUFU\",\n \"ClientIp\": \"8.8.8.8\"\n },\n \"RegistrationOrganizations\": [\n {\n \"OrganizationName\": \"测试认证企业一\",\n \"UniformSocialCreditCode\": \"9XXXXXXXXXXXXXXXX1\",\n \"LegalName\": \"鹅鹅子\",\n \"Address\": \"深圳市南山区1000号腾讯大厦\",\n \"AdminName\": \"鹅鹅子\",\n \"AdminMobile\": \"187XXXXXXX0\",\n \"AuthorizationTypes\": [\n 2\n ]\n },\n {\n \"OrganizationName\": \"测试认证企业二\",\n \"UniformSocialCreditCode\": \"9XXXXXXXXXXXXXXXX2\",\n \"LegalName\": \"鹅鹅子\",\n \"Address\": \"深圳市南山区1000号腾讯大厦\",\n \"AdminName\": \"鹅鹅子\",\n \"AdminMobile\": \"187XXXXXXX0\",\n \"AuthorizationTypes\": [\n 1\n ]\n },\n {\n \"OrganizationName\": \"测试认证企业三\",\n \"UniformSocialCreditCode\": \"9XXXXXXXXXXXXXXXX3\",\n \"LegalName\": \"鹅鹅子\",\n \"Address\": \"测试地址\",\n \"AdminName\": \"鹅鹅子\",\n \"AdminMobile\": \"187XXXXXXX0\",\n \"AuthorizationTypes\": [\n 2\n ]\n }\n ]\n}",
101
+ "output": "{\n \"Response\": {\n \"ErrorMessages\": [\n \"\",\n \"第【2】条注册信息参数错误,地址参数不正确,请确认后再试\",\n \"\"\n ],\n \"RequestId\": \"5cea4b4778bf\",\n \"TaskId\": \"\"\n }\n}",
102
+ "title": "批量注册三家企业,地址不符合格式,返回错误"
103
+ },
104
+ {
105
+ "document": "第一家企业和第三家企业名字重复, 无法注册",
106
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateBatchOrganizationRegistrationTasks\n<公共请求参数>\n\n{\n \"Operator\": {\n \"OpenId\": \"us-768d38720c10405f994539097f030a27\",\n \"UserId\": \"19561039c99fe825a934a132520fde6a\",\n \"Channel\": \"YUFU\",\n \"ClientIp\": \"8.8.8.8\"\n },\n \"RegistrationOrganizations\": [\n {\n \"OrganizationName\": \"测试认证企业一\",\n \"UniformSocialCreditCode\": \"9XXXXXXXXXXXXXXXX1\",\n \"LegalName\": \"鹅鹅子\",\n \"Address\": \"深圳市南山区1000号腾讯大厦\",\n \"AdminName\": \"鹅鹅子\",\n \"AdminMobile\": \"187XXXXXXX0\",\n \"AuthorizationTypes\": [\n 2\n ]\n },\n {\n \"OrganizationName\": \"测试认证企业二\",\n \"UniformSocialCreditCode\": \"9XXXXXXXXXXXXXXXX2\",\n \"LegalName\": \"鹅鹅子\",\n \"Address\": \"深圳市南山区1000号腾讯大厦\",\n \"AdminName\": \"鹅鹅子\",\n \"AdminMobile\": \"187XXXXXXX0\",\n \"AuthorizationTypes\": [\n 1\n ]\n },\n {\n \"OrganizationName\": \"测试认证企业一\",\n \"UniformSocialCreditCode\": \"9XXXXXXXXXXXXXXXX3\",\n \"LegalName\": \"鹅鹅子\",\n \"Address\": \"深圳市南山区1000号腾讯大厦\",\n \"AdminName\": \"鹅鹅子\",\n \"AdminMobile\": \"187XXXXXXX0\",\n \"AuthorizationTypes\": [\n 2\n ]\n }\n ]\n}",
107
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue\",\n \"Message\": \"企业名称[测试认证企业一]重复\"\n },\n \"RequestId\": \"4f7b42be805f\"\n }\n}",
108
+ "title": "批量注册三家企业,企业名称重复,无法创建,返回错误提示"
109
+ }
110
+ ],
91
111
  "CreateBatchQuickSignUrl": [
92
112
  {
93
113
  "document": "1. 为个人用户生成合同组H5批量签署链接\n2. 使用默认的签名类型\n3. 使用默认的签署方式\n4. 默认跳转到合同列表页",
@@ -694,6 +714,14 @@
694
714
  "title": "创建有数量或时间限制的合同流程签署二维码"
695
715
  }
696
716
  ],
717
+ "CreateOrganizationAuthUrl": [
718
+ {
719
+ "document": "创建企业认证链接",
720
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateOrganizationAuthUrl\n<公共请求参数>\n\n{}",
721
+ "output": "{\n \"Response\": {\n \"RequestId\": \"s168499xxxxx2608083\"\n }\n}",
722
+ "title": "创建企业认证链接"
723
+ }
724
+ ],
697
725
  "CreateOrganizationBatchSignUrl": [
698
726
  {
699
727
  "document": "根据员工UserId获取批量签署链接",
@@ -718,6 +746,12 @@
718
746
  "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateOrganizationBatchSignUrl\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UXXXzjEwg0vjoimj\"\n },\n \"Agent\": {\n \"ProxyOrganizationId\": \"\"\n },\n \"FlowIds\": [\n \"yDRIxxxxxxxxxxxxxxxxxxxxxxxxxx0s\",\n \"yDwFmUUckpstqfvzUxxx3jo1f3cqjkGm\",\n \"yDwFmUUckpst10i3UxxxSat8PWOt2iQF\"\n ],\n \"UserId\": \"yDRCLUUgygq2xun5UXXXzjEwg0vjoimj\",\n \"Name\": \"张三\",\n \"Mobile\": \"18888888888\"\n}",
719
747
  "output": "{\n \"Response\": {\n \"ExpiredTime\": 1706100107,\n \"RequestId\": \"s1705495307288609862\",\n \"SignUrl\": \"https://embed.test.qian.tencent.cn/contract-sign?embed=1&expiredOn=1706100107&code=yDCNBUUckpvlibz6UEMbkWeSzl6YurH0&shortKey=yDCNBUzgvS93aBhXs3ae&channel=TENCENTCLOUD\"\n }\n}",
720
748
  "title": "UserId和 姓名手机都传递,生成的链接基于UserId生成"
749
+ },
750
+ {
751
+ "document": "",
752
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateOrganizationBatchSignUrl\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UXXXzjEwg0vjoimj\"\n },\n \"Agent\": {\n \"ProxyOrganizationId\": \"\"\n },\n \"UserId\": \"\",\n \"Name\": \"\",\n \"Mobile\": \"\",\n \"FlowIds\": [\n \"yDC5yUUntf6vnnUxxBTyJ8Ps0WGqAuHL\",\n \"yDC5yUUntf6fccUEgcyeHwPz4wjnDSI4\"\n ],\n \"RecipientIds\": [\n \"yDC5yUUntf6vn0UxxBTyJvfv3Xlckcye\",\n \"yDC5yUUntf6mdgUEgcyeHCpCDmDjbsQJ\"\n ]\n}",
753
+ "output": "{\n \"Response\": {\n \"ExpiredTime\": 1706100107,\n \"RequestId\": \"s1705495307288609862\",\n \"SignUrl\": \"https://embed.test.qian.tencent.cn/contract-sign?embed=1&expiredOn=1706100107&code=yDCNBUUckpvlibz6UEMbkWeSzl6YurH0&shortKey=yDCNBUzgvS93aBhXs3ae&channel=TENCENTCLOUD\"\n }\n}",
754
+ "title": "基于RecipientIds 生成他方签署链接"
721
755
  }
722
756
  ],
723
757
  "CreateOrganizationInfoChangeUrl": [
@@ -909,7 +909,7 @@
909
909
  },
910
910
  {
911
911
  "disabled": false,
912
- "document": "开通成功后前端页面跳转的url,此字段的用法场景请联系客户经理确认。\n\n注:`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`\n\n跳转场景:\n<ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li>\n<li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL,只需满足 qianapp:// 开头的URL即可。`APP实现方,需要拦截Webview地址跳转,发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考:<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>,<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>\n\n成功结果返回:\n若贵方需要在跳转回时通过链接query参数提示开通成功,JumpUrl中的query应携带如下参数:`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功,比如 qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess",
912
+ "document": "开通成功后前端页面跳转的url,此字段的用法场景请联系客户经理确认。\n\n注:`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`\n\n跳转场景:\n<ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li>\n<li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL,只需满足 qianapp:// 开头的URL即可。`APP实现方,需要拦截Webview地址跳转,发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考:<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>,<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>\n\n成功结果返回:\n若贵方需要在跳转回时通过链接query参数提示开通成功,JumpUrl中的query应携带如下参数:`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功,例如:qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess",
913
913
  "example": "无",
914
914
  "member": "string",
915
915
  "name": "JumpUrl",
@@ -4056,7 +4056,7 @@
4056
4056
  },
4057
4057
  {
4058
4058
  "disabled": false,
4059
- "document": "查询的套餐类型 (选填 )不传则查询所有套餐;\n目前支持:\n<ul>\n<li>**CloudEnterprise**: 企业版合同</li>\n<li>**SingleSignature**: 单方签章</li>\n<li>**CloudProve**: 签署报告</li>\n<li>**CloudOnlineSign**: 腾讯会议在线签约</li>\n<li>**ChannelWeCard**: 微工卡</li>\n<li>**SignFlow**: 合同套餐</li>\n<li>**SignFace**: 签署意愿(人脸识别)</li>\n<li>**SignPassword**: 签署意愿(密码)</li>\n<li>**SignSMS**: 签署意愿(短信)</li>\n<li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>\n<li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>\n<li>**OrgEssAuth**: 签署企业实名</li>\n<li>**FlowNotify**: 短信通知</li>\n<li>**AuthService**: 企业工商信息查询</li>\n<li>**NoAuthSign**: 形式签</li>\n</ul>",
4059
+ "document": "查询的套餐类型 (选填 )不传则查询所有套餐;\n目前支持:\n<ul>\n<li>**CloudEnterprise**: 企业版合同</li>\n<li>**SingleSignature**: 单方签章</li>\n<li>**CloudProve**: 签署报告</li>\n<li>**CloudOnlineSign**: 腾讯会议在线签约</li>\n<li>**ChannelWeCard**: 微工卡</li>\n<li>**SignFlow**: 合同套餐</li>\n<li>**SignFace**: 签署意愿(人脸识别)</li>\n<li>**SignPassword**: 签署意愿(密码)</li>\n<li>**SignSMS**: 签署意愿(短信)</li>\n<li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>\n<li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>\n<li>**OrgEssAuth**: 签署企业实名</li>\n<li>**FlowNotify**: 短信通知</li>\n<li>**AuthService**: 企业工商信息查询</li>\n</ul>",
4060
4060
  "example": "CloudEnterprise",
4061
4061
  "member": "string",
4062
4062
  "name": "QuotaType",
@@ -5443,7 +5443,7 @@
5443
5443
  "members": [
5444
5444
  {
5445
5445
  "disabled": false,
5446
- "document": "控件唯一ID。\n\n**在绝对定位方式方式下**,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。\n\n**在关键字定位方式下**,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。\n\n例:\n\n- 如传入的关键字<font color=\"red\">\"^甲方签署^\"</font >,则会在PDF文件中有且仅有\"甲方签署\"关键字的地方(<font color=\"red\">前后不能有其他字符</font >)进行对应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署</font >\",则PDF文件中每个出现关键字的位置(<font color=\"red\">前后可以有其他字符</font >)都会执行相应操作。\n- 如传入的关键字为<font color=\"red\">\"^甲方签署</font >\",则PDF文件中每个出现关键字的位置(<font color=\"red\">前面不能有其他字符</font >)都会执行相应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署^</font >\",则PDF文件中每个出现关键字的位置(<font color=\"red\">后面不能有其他字符</font >)都会执行相应操作。\n\n\n注:`控件ID可以在一个PDF中不可重复`\n<a href=\"https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png\" target=\"_blank\">点击查看ComponentId在模板页面的位置</a>\n",
5446
+ "document": "控件唯一ID。\n\n**在绝对定位方式方式下**,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。\n\n**在关键字定位方式下**,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。\n\n例:\n\n- 如传入的关键字<font color=\"red\">\"^甲方签署^\"</font >,则会在PDF文件中有且仅有\"甲方签署\"关键字的地方(<font color=\"red\">前后不能有其他字符</font >)进行对应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署</font >\",则PDF文件中每个出现关键字的位置(<font color=\"red\">前后可以有其他字符</font >)都会执行相应操作。\n\n\n注:`控件ID可以在一个PDF中不可重复`\n<a href=\"https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png\" target=\"_blank\">点击查看ComponentId在模板页面的位置</a>\n",
5447
5447
  "example": "ComponentId",
5448
5448
  "member": "string",
5449
5449
  "name": "ComponentId",
@@ -9518,7 +9518,7 @@
9518
9518
  "example": "无",
9519
9519
  "member": "string",
9520
9520
  "name": "SealId",
9521
- "required": true,
9521
+ "output_required": true,
9522
9522
  "type": "string",
9523
9523
  "value_allowed_null": false
9524
9524
  },
@@ -9528,7 +9528,7 @@
9528
9528
  "example": "无",
9529
9529
  "member": "string",
9530
9530
  "name": "SealName",
9531
- "required": true,
9531
+ "output_required": true,
9532
9532
  "type": "string",
9533
9533
  "value_allowed_null": false
9534
9534
  },
@@ -9538,7 +9538,7 @@
9538
9538
  "example": "无",
9539
9539
  "member": "int64",
9540
9540
  "name": "CreateOn",
9541
- "required": true,
9541
+ "output_required": true,
9542
9542
  "type": "int",
9543
9543
  "value_allowed_null": false
9544
9544
  },
@@ -9548,7 +9548,7 @@
9548
9548
  "example": "无",
9549
9549
  "member": "string",
9550
9550
  "name": "Creator",
9551
- "required": true,
9551
+ "output_required": true,
9552
9552
  "type": "string",
9553
9553
  "value_allowed_null": false
9554
9554
  },
@@ -9558,7 +9558,7 @@
9558
9558
  "example": "无",
9559
9559
  "member": "string",
9560
9560
  "name": "SealPolicyId",
9561
- "required": true,
9561
+ "output_required": true,
9562
9562
  "type": "string",
9563
9563
  "value_allowed_null": false
9564
9564
  },
@@ -9568,7 +9568,7 @@
9568
9568
  "example": "无",
9569
9569
  "member": "string",
9570
9570
  "name": "SealStatus",
9571
- "required": true,
9571
+ "output_required": true,
9572
9572
  "type": "string",
9573
9573
  "value_allowed_null": false
9574
9574
  },
@@ -9578,7 +9578,7 @@
9578
9578
  "example": "无",
9579
9579
  "member": "string",
9580
9580
  "name": "FailReason",
9581
- "required": true,
9581
+ "output_required": true,
9582
9582
  "type": "string",
9583
9583
  "value_allowed_null": true
9584
9584
  },
@@ -9588,17 +9588,17 @@
9588
9588
  "example": "无",
9589
9589
  "member": "string",
9590
9590
  "name": "Url",
9591
- "required": true,
9591
+ "output_required": true,
9592
9592
  "type": "string",
9593
9593
  "value_allowed_null": false
9594
9594
  },
9595
9595
  {
9596
9596
  "disabled": false,
9597
- "document": "印章类型,OFFICIAL-企业公章,CONTRACT-合同专用章,LEGAL_PERSON_SEAL-法人章",
9597
+ "document": "电子印章类型 , 可选类型如下: \n<ul><li>**OFFICIAL**: (默认)公章</li>\n<li>**CONTRACT**: 合同专用章;</li>\n<li>**FINANCE**: 财务专用章;</li>\n<li>**PERSONNEL**: 人事专用章</li>\n<li>**INVOICE**: 发票专用章</li>\n</ul>",
9598
9598
  "example": "无",
9599
9599
  "member": "string",
9600
9600
  "name": "SealType",
9601
- "required": true,
9601
+ "output_required": true,
9602
9602
  "type": "string",
9603
9603
  "value_allowed_null": false
9604
9604
  },
@@ -9608,7 +9608,7 @@
9608
9608
  "example": "无",
9609
9609
  "member": "bool",
9610
9610
  "name": "IsAllTime",
9611
- "required": true,
9611
+ "output_required": true,
9612
9612
  "type": "bool",
9613
9613
  "value_allowed_null": false
9614
9614
  },
@@ -9618,7 +9618,7 @@
9618
9618
  "example": "无",
9619
9619
  "member": "AuthorizedUser",
9620
9620
  "name": "AuthorizedUsers",
9621
- "required": true,
9621
+ "output_required": true,
9622
9622
  "type": "list",
9623
9623
  "value_allowed_null": false
9624
9624
  }
@@ -50,7 +50,7 @@
50
50
  "status": "online"
51
51
  },
52
52
  "CheckPhoneAndName": {
53
- "document": "手机号二要素核验接口用于校验手机号和姓名的真实性和一致性,支持的手机号段详情请查阅<a href=\"https://cloud.tencent.com/document/product/1007/46063\">运营商类</a>文档。\n",
53
+ "document": "手机号二要素核验接口用于校验手机号和姓名的真实性和一致性,支持的手机号段详情请查阅<a href=\"https://cloud.tencent.com/document/product/1007/46063\">运营商类</a>文档。",
54
54
  "input": "CheckPhoneAndNameRequest",
55
55
  "name": "手机号二要素核验",
56
56
  "output": "CheckPhoneAndNameResponse",
@@ -169,7 +169,7 @@
169
169
  "status": "online"
170
170
  },
171
171
  "ImageRecognition": {
172
- "document": "传入照片和身份信息,判断该照片与权威库的证件照是否属于同一个人。",
172
+ "document": "传入照片和身份信息,判断该照片与权威库的证件照是否属于同一个人(该接口已停止接入,新客户请使用<a href=\"https://cloud.tencent.com/document/product/1007/102203\">照片人脸核身(V2.0)</a>接口)。",
173
173
  "input": "ImageRecognitionRequest",
174
174
  "name": "照片人脸核身",
175
175
  "output": "ImageRecognitionResponse",
@@ -1043,11 +1043,11 @@
1043
1043
  "members": [
1044
1044
  {
1045
1045
  "disabled": false,
1046
- "document": "认证结果码,收费情况如下。\n收费结果码:\n0: 验证结果一致\n1: 验证结果不一致\n不收费结果码:\n-1:查无记录\n-2:引擎未知错误\n-3:引擎服务异常",
1046
+ "document": "认证结果码,收费情况如下。\n收费结果码:\n0: 验证结果一致\n1: 验证结果不一致\n不收费结果码:\n-1:查无记录\n-2:引擎未知错误\n-3:引擎服务异常\n-4:姓名校验不通过\n-5:手机号码不合法",
1047
1047
  "example": "0",
1048
1048
  "member": "string",
1049
1049
  "name": "Result",
1050
- "required": true,
1050
+ "output_required": true,
1051
1051
  "type": "string",
1052
1052
  "value_allowed_null": false
1053
1053
  },
@@ -1057,7 +1057,7 @@
1057
1057
  "example": "验证结果一致",
1058
1058
  "member": "string",
1059
1059
  "name": "Description",
1060
- "required": true,
1060
+ "output_required": true,
1061
1061
  "type": "string",
1062
1062
  "value_allowed_null": false
1063
1063
  },
@@ -5009,6 +5009,15 @@
5009
5009
  "name": "IntentionType",
5010
5010
  "required": false,
5011
5011
  "type": "int"
5012
+ },
5013
+ {
5014
+ "disabled": false,
5015
+ "document": "用户语音回答过程中是否开启张嘴识别检测,默认不开启,仅在意愿核身问答模式中使用。",
5016
+ "example": "false",
5017
+ "member": "bool",
5018
+ "name": "MouthOpenRecognition",
5019
+ "required": false,
5020
+ "type": "bool"
5012
5021
  }
5013
5022
  ],
5014
5023
  "usage": "in"
@@ -225,6 +225,58 @@ def doSaveGameArchive(args, parsed_globals):
225
225
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
226
226
 
227
227
 
228
+ def doStartPublishStreamToCSS(args, parsed_globals):
229
+ g_param = parse_global_arg(parsed_globals)
230
+
231
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
232
+ cred = credential.CVMRoleCredential()
233
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
234
+ cred = credential.STSAssumeRoleCredential(
235
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
236
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
237
+ )
238
+ elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
239
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
240
+ else:
241
+ cred = credential.Credential(
242
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
243
+ )
244
+ http_profile = HttpProfile(
245
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
246
+ reqMethod="POST",
247
+ endpoint=g_param[OptionsDefine.Endpoint],
248
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
249
+ )
250
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
251
+ if g_param[OptionsDefine.Language]:
252
+ profile.language = g_param[OptionsDefine.Language]
253
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
254
+ client = mod.GsClient(cred, g_param[OptionsDefine.Region], profile)
255
+ client._sdkVersion += ("_CLI_" + __version__)
256
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
257
+ model = models.StartPublishStreamToCSSRequest()
258
+ model.from_json_string(json.dumps(args))
259
+ start_time = time.time()
260
+ while True:
261
+ rsp = client.StartPublishStreamToCSS(model)
262
+ result = rsp.to_json_string()
263
+ try:
264
+ json_obj = json.loads(result)
265
+ except TypeError as e:
266
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
267
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
268
+ break
269
+ cur_time = time.time()
270
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
271
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
272
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
273
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
274
+ else:
275
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
276
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
277
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
278
+
279
+
228
280
  def doCreateSession(args, parsed_globals):
229
281
  g_param = parse_global_arg(parsed_globals)
230
282
 
@@ -448,6 +500,7 @@ ACTION_MAP = {
448
500
  "TrylockWorker": doTrylockWorker,
449
501
  "StopGame": doStopGame,
450
502
  "SaveGameArchive": doSaveGameArchive,
503
+ "StartPublishStreamToCSS": doStartPublishStreamToCSS,
451
504
  "CreateSession": doCreateSession,
452
505
  "StartPublishStream": doStartPublishStream,
453
506
  "StopPublishStream": doStopPublishStream,