tencentcloud-sdk-nodejs 4.1.304 → 4.1.305

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/apm/v20210622/apm_client.js +3 -0
  3. package/es/services/trtc/v20190722/trtc_client.js +33 -12
  4. package/package.json +1 -1
  5. package/tencentcloud/common/sdk_version.d.ts +1 -1
  6. package/tencentcloud/common/sdk_version.js +1 -1
  7. package/tencentcloud/services/apm/v20210622/apm_client.d.ts +5 -1
  8. package/tencentcloud/services/apm/v20210622/apm_client.js +6 -0
  9. package/tencentcloud/services/apm/v20210622/apm_models.d.ts +125 -57
  10. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +1 -1
  11. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +50 -70
  12. package/tencentcloud/services/ess/v20201111/ess_client.js +50 -70
  13. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +18 -19
  14. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +18 -19
  15. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +6 -2
  16. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +33 -25
  17. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +4 -0
  18. package/tencentcloud/services/sms/v20210111/sms_models.d.ts +6 -9
  19. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +5 -0
  20. package/tencentcloud/services/thpc/v20220401/thpc_models.d.ts +4 -0
  21. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +67 -25
  22. package/tencentcloud/services/trtc/v20190722/trtc_client.js +86 -30
  23. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +282 -186
  24. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +12 -6
  25. package/tencentcloud/services/vod/v20180717/vod_client.js +12 -6
  26. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +1 -0
  27. package/tencentcloud/services/vpc/v20170312/vpc_client.js +1 -0
@@ -45,16 +45,16 @@ class Client extends abstract_client_1.AbstractClient {
45
45
  }
46
46
  /**
47
47
  * 此接口用于启动流程。它是模板发起合同的最后一步。
48
- 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于开始整个合同流程, 推进流程进入到签署环节。
49
-
50
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
51
48
 
52
- 注:
53
- 1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度)
49
+ ## 1.1 接口调用流程
50
+ 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于开始整个合同流程, 推进流程进入到签署环节。
54
51
 
55
- 2.<font color="red">静默(自动)签署不支持非本企业合同签署方存在填写</font>功能
52
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
56
53
 
57
- 3.<font color="red">在发起签署流程之前,建议等待 [PDF合成完成的回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)</font>,尤其是当模板中存在动态表格等复杂填写控件时,因为合成过程可能会耗费秒级别的时间。
54
+ ### 1.2 注意事项
55
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同,且<font color="red">有撤销合同额度</font>的情形下,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
56
+ - 只要存在填写控件,填充时会触发 PDF 合成工作,文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)。**一定要等待该回调(或等待数秒)后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口发起签署**,以确保文档已合成完毕。,尤其是当模板中存在动态表格等复杂填写控件时,因为合成过程可能会耗费秒级别的时间。
57
+ - 调用 [CreateDocument](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument) 成功后,请<font color="red">在 5 分钟内调用本接口(StartFlow)启动合同</font> ,不要长时间暂存仅调用了 CreateDocument 而未发起的合同;否则会导致该合同长时间后无法再启动,且合同额度不再返还。
58
58
  */
59
59
  async StartFlow(req, cb) {
60
60
  return this.request("StartFlow", req, cb);
@@ -220,48 +220,42 @@ class Client extends abstract_client_1.AbstractClient {
220
220
  return this.request("CreateFlowSignReview", req, cb);
221
221
  }
222
222
  /**
223
- * 创建签署流程电子文档<br />
224
-
225
- ### 调用流程
226
- 该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
223
+ * 本接口用于基于**模板**创建合同的电子文档,并填充模板中由发起方补充的信息(归属发起方填写控件)。
227
224
 
228
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
225
+ ### 1.1 调用流程
229
226
 
227
+ 本接口需指定一个模板 ID,并填充该模板中需补充的信息。它需要与<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口配合使用,完整调用顺序如下:
228
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
230
229
 
231
- ### 填充模板中定义的填写控件
232
- 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充。
230
+ ### 1.2 发起方填写控件
233
231
 
234
- **<font color="red">填充填写控件需要进行Pdf合成工作,文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83),建议在收到此回调后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口。</font>**
232
+ 模板中配置的<font color="red">发起人填充控件</font>,可通过本接口的 **FormFields 数组**字段填充。
235
233
 
236
234
  ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
237
235
 
238
- 填充的传参示例如下
239
-
240
- ```
241
- request.FormFields = [{
242
- "ComponentName": "项目的名字",
243
- "ComponentValue": "休闲山庄"
244
- }, {
245
- "ComponentName": "项目的地址",
246
- "ComponentValue": "凤凰山北侧",
247
- }, {
248
- "ComponentName": "范围",
249
- "ComponentValue": "凤凰山至107国道",
250
- }, {
251
- "ComponentName": "面积",
252
- "ComponentValue": "100亩",
253
- }, {
254
- "ComponentName": "基本情况",
255
- "ComponentValue": "完好",
256
- }, , {
257
- "ComponentName": "用途",
258
- "ComponentValue": "经营农家乐",
259
- }
260
- ]
236
+ 填充的传参示例如下(以 ComponentName 匹配模板中的控件名):
237
+
238
+ ```json
239
+ [
240
+ { "ComponentName": "项目的名字", "ComponentValue": "休闲山庄" },
241
+ { "ComponentName": "项目的地址", "ComponentValue": "凤凰山北侧" },
242
+ { "ComponentName": "范围", "ComponentValue": "凤凰山至107国道" },
243
+ { "ComponentName": "面积", "ComponentValue": "100亩" },
244
+ { "ComponentName": "基本情况", "ComponentValue": "完好" },
245
+ { "ComponentName": "用途", "ComponentValue": "经营农家乐" }
246
+ ]
261
247
  ```
262
- 合成后合同样子示例
248
+
249
+ 合成后的合同样例:
263
250
 
264
251
  ![image](https://qcloudimg.tencent-cloud.cn/raw/140a2fb771ac66a185d0a000d37485f6.png)
252
+
253
+ ### 1.3 注意事项
254
+
255
+ - 本接口<font color="red">只能填充分配给发起方的填写控件</font>,不能填充分配给签署方的签署控件。
256
+ - <font color="red">若使用预览方式(`NeedPreview=true`),预览确认无误后,需用同样的参数再次调用本接口</font>(`NeedPreview=false`),并使用新调用返回的 `FlowId` 去调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 发起签署。预览模式返回的 `FlowId` 为临时 ID,不能用于发起。
257
+ - 只要存在发起方的填写控件,填充时会触发 PDF 合成工作,文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)。<font color="red">一定要等待该回调(或等待数秒)后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口发起签署</font>,以确保文档已合成完毕。
258
+ - 调用本接口(CreateDocument)成功后,请**在 5 分钟内调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 启动合同**,不要长时间暂存仅调用了 CreateDocument 而未发起的合同;否则会导致该合同长时间后无法再启动,且合同额度不再返还。
265
259
  */
266
260
  async CreateDocument(req, cb) {
267
261
  return this.request("CreateDocument", req, cb);
@@ -799,40 +793,26 @@ class Client extends abstract_client_1.AbstractClient {
799
793
  }
800
794
  /**
801
795
  * 通过模板创建签署流程<br/>
802
- 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
803
- <table>
804
- <thead>
805
- <tr>
806
- <th>签署人类别</th>
807
- <th>需要提前准备的信息</th>
808
- </tr>
809
- </thead>
810
- <tbody>
811
- <tr>
812
- <td>自己企业的员工签署(未认证加入或已认证加入)</td>
813
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
814
- </tr>
815
- <tr>
816
- <td>自己企业的员工签署(已认证加入)</td>
817
- <td>签署企业的名字、员工在电子签平台的ID(UserId)</td>
818
- </tr>
819
- <tr>
820
- <td>其他企业的员工签署</td>
821
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
822
- </tr>
823
- <tr>
824
- <td>个人(自然人)签署</td>
825
- <td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>
826
- </tr>
827
- </tbody>
828
- </table>
796
+ 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次使用这个配置好的模板,补充合同内容信息及签署信息生成电子合同。
797
+ ## 1.1 传参方式指引
829
798
 
799
+ | 签署方类型 | ApproverType | 需要提前准备的信息 | 对应 Approvers 关键字段 |
800
+ |------|------|------|------|
801
+ | 本企业员工(未认证加入) | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号(非必传) | OrganizationName + ApproverName + ApproverMobile |
802
+ | 本企业员工(已认证加入) | 0 | 签署企业名、员工在电子签平台的 ID(UserId) | OrganizationName + UserId |
803
+ | 他方企业员工 | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号(非必传) | OrganizationName + ApproverName + ApproverMobile |
804
+ | 个人(自然人) | 1 | 个人真实姓名、个人触达手机号、身份证号(非必传) | ApproverName + ApproverMobile |
830
805
 
831
- 注:配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
806
+ ## 1.2 接口调用流程
807
+ 此接口需<font color="red">配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用</font> 。整体的逻辑如下图
832
808
 
833
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
809
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
834
810
 
835
- 注:**静默(自动)签署不支持合同签署方存在填写**功能
811
+ ## 1.3 注意事项
812
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同,且<font color="red">有撤销合同额度</font>的情形下,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
813
+ - 支持的证件类型可以参考[支持的证件类型](https://qian.tencent.com/developers/company/id_card_support)。
814
+ - 合同发起方需要【组织管理】->【角色管理】中拥有<font color="red">接口发起合同</font>的权限
815
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/c8553d1823ca1323e82c11f01c86e8cd.png)
836
816
  <br>
837
817
 
838
818
  <font color="red">相关视频指引</font> <br>
@@ -1029,7 +1009,7 @@ class Client extends abstract_client_1.AbstractClient {
1029
1009
  该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFileConvertTask)接口转换成pdf资源)<br/>
1030
1010
 
1031
1011
  ## 整体流程图
1032
- ![image](https://qcloudimg.tencent-cloud.cn/raw/9577ac334c083ecfe0014a187d64b485.svg)
1012
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/9bf547fe0bc738f9a97b4b619dea0633.svg)
1033
1013
 
1034
1014
  注:
1035
1015
  - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同,且<font color="red">有撤销合同额度</font>的情形下,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
@@ -328,34 +328,33 @@ export declare class Client extends AbstractClient {
328
328
  */
329
329
  ChannelCreatePreparedPersonalEsign(req: ChannelCreatePreparedPersonalEsignRequest, cb?: (error: string, rep: ChannelCreatePreparedPersonalEsignResponse) => void): Promise<ChannelCreatePreparedPersonalEsignResponse>;
330
330
  /**
331
- * 接口(ChannelCreateFlowByFiles)用PDF文件创建签署流程。
331
+ * 本接口(ChannelCreateFlowByFiles)用于通过**已上传的 PDF 资源编号**创建待签署的合同流程。
332
332
 
333
- 适用场景:适用非制式的合同文件签署,开发者有每个签署流程的PDF,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
333
+ **适用场景**:适用于非制式的合同文件签署。当开发者已拥有每个签署流程完整的 PDF 文件时,可通过本接口传入完整的 PDF 文件及流程信息,生成待签署的合同流程。
334
334
 
335
- **注**:
336
- <ul>
337
- <li>此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。</li>
338
- <li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号(FileIds)进行使用。整体的逻辑如下图</li>
339
- </ul>
335
+ ### 1.1 调用依赖
340
336
 
341
- ![image](https://qcloudimg.tencent-cloud.cn/raw/bf86248a2c163228c4e894cf5926af69/ChannelCreateFlowByFiles.png)
342
-
343
- **可以作为发起方和签署方的角色列表**
344
- <table> <thead> <tr> <th>场景编号</th> <th>发起方</th> <th>签署方</th> <th>补充</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>子企业A的员工</td> <td>子企业A的员工</td> <td>子企业是通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">CreateConsoleLoginUrl</a>生成子客登录链接注册的企业</td> </tr> <tr> <td>场景二</td> <td>子企业A的员工</td> <td>子企业B(不指定经办人走领取逻辑)</td> <td>领取的逻辑可以参考文档<a href="https://qian.tencent.com/developers/partner/dynamic_signer" target="_blank">动态签署方</a> </td> </tr> <tr> <td>场景三</td> <td>子企业A的员工</td> <td>子企业B的员工</td> <td>-</td> </tr> <tr> <td>场景四</td> <td>子企业A的员工</td> <td>个人</td> <td>就是自然人,不是企业员工</td> </tr> <tr> <td>场景五</td> <td>子企业A的员工</td> <td>SaaS平台企业员工</td> <td>SaaS平台企业是通过<a href="https://qian.tencent.cn/console/company-register" target="_blank">https://qian.tencent.cn/console/company-register</a>链接注册的企业</td> </tr> </tbody> </table>
337
+ 本接口需依赖[文件上传接口](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)生成 PDF 资源编号(FileId)后使用,整体逻辑如下图:
345
338
 
339
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/985b4bf10a40d65fe7b016bb2f82c3df.svg)
346
340
 
347
- **注**:
348
- `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
341
+ ### 1.2 发起方和签署方
342
+ <table> <thead> <tr> <th>场景编号</th> <th>发起方</th> <th>签署方</th> <th>补充</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>子企业A的员工</td> <td>子企业A的员工</td> <td>子企业是通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">CreateConsoleLoginUrl</a>生成子客登录链接注册的企业</td> </tr> <tr> <td>场景二</td> <td>子企业A的员工</td> <td>子企业B(不指定经办人走领取逻辑)</td> <td>领取的逻辑可以参考文档<a href="https://qian.tencent.com/developers/partner/dynamic_signer" target="_blank">动态签署方</a> </td> </tr> <tr> <td>场景三</td> <td>子企业A的员工</td> <td>子企业B的员工</td> <td>-</td> </tr> <tr> <td>场景四</td> <td>子企业A的员工</td> <td>个人</td> <td>就是自然人,不是企业员工</td> </tr> <tr> <td>场景五</td> <td>子企业A的员工</td> <td>SaaS平台企业员工</td> <td>SaaS平台企业是通过<a href="https://qian.tencent.cn/console/company-register" target="_blank">https://qian.tencent.cn/console/company-register</a>链接注册的企业</td> </tr> </tbody> </table>
349
343
 
350
- `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
351
344
 
352
- `3. 合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度)`
345
+ <font color="red">发起方(第三方子企业 A 的企业与员工)必须完成实名</font>;作为**签署方**的第三方子企业 A 员工 / 个人自然人 / SaaS 平台企业员工 / 第三方子企业 B 员工等,其企业和个人可以未实名。
353
346
 
354
- `4. 静默(自动)签署不支持合同签署方存在填写功能`
347
+ ### 1.3 注意事项
348
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同,且<font color="red">有撤销合同额度</font>的情形下,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/partner/contract_cancel_quota)。
349
+ - <font color="red">支持的证件类型</font>可以参考[支持的证件类型](https://qian.tencent.com/developers/partner/id_card_support)。
350
+ - <font color="red">不同类型的签署方传参不同</font>,各类型签署方的信息传递方式详见 [【签署方入参指引】](https://qian.tencent.com/developers/partner/flow_approver)。
351
+ - 如果合同正式发起前如需<font color="red">预览</font>效果,可参考 [【使用文件发起的预览】](https://qian.tencent.com/developers/partner/preview_guide#%E4%B8%80%E4%BD%BF%E7%94%A8%E6%96%87%E4%BB%B6%E5%8F%91%E8%B5%B7%E7%9A%84%E9%A2%84%E8%A7%88)
352
+ - 关于填写方与签署方的<font color="red">填写、签署先后顺序</font>设置,详见 [【填写与签署顺序说明】](https://qian.tencent.com/developers/partner/fill_sign_order)。
353
+ - 关于<font color="red">本企业自动签署与其他企业自动签署</font>的配置与使用,详见 [【自动签署】](https://qian.tencent.com/developers/partner/autosign_guide)。
355
354
 
356
- <font color="red">相关视频指引</font> <br>
357
- 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a><br>
358
- 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-ChannelCreateFlowByFiles.mp4" target="_blank">【用PDF文件创建签署流程】编写示例</a><br>
355
+ ### 1.4 视频教程
356
+ 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a>
357
+ 2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-ChannelCreateFlowByFiles.mp4" target="_blank">【用PDF文件创建签署流程】编写示例</a>
359
358
  */
360
359
  ChannelCreateFlowByFiles(req: ChannelCreateFlowByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowByFilesResponse) => void): Promise<ChannelCreateFlowByFilesResponse>;
361
360
  /**
@@ -392,34 +392,33 @@ class Client extends abstract_client_1.AbstractClient {
392
392
  return this.request("ChannelCreatePreparedPersonalEsign", req, cb);
393
393
  }
394
394
  /**
395
- * 接口(ChannelCreateFlowByFiles)用PDF文件创建签署流程。
395
+ * 本接口(ChannelCreateFlowByFiles)用于通过**已上传的 PDF 资源编号**创建待签署的合同流程。
396
396
 
397
- 适用场景:适用非制式的合同文件签署,开发者有每个签署流程的PDF,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
397
+ **适用场景**:适用于非制式的合同文件签署。当开发者已拥有每个签署流程完整的 PDF 文件时,可通过本接口传入完整的 PDF 文件及流程信息,生成待签署的合同流程。
398
398
 
399
- **注**:
400
- <ul>
401
- <li>此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。</li>
402
- <li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号(FileIds)进行使用。整体的逻辑如下图</li>
403
- </ul>
399
+ ### 1.1 调用依赖
404
400
 
405
- ![image](https://qcloudimg.tencent-cloud.cn/raw/bf86248a2c163228c4e894cf5926af69/ChannelCreateFlowByFiles.png)
406
-
407
- **可以作为发起方和签署方的角色列表**
408
- <table> <thead> <tr> <th>场景编号</th> <th>发起方</th> <th>签署方</th> <th>补充</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>子企业A的员工</td> <td>子企业A的员工</td> <td>子企业是通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">CreateConsoleLoginUrl</a>生成子客登录链接注册的企业</td> </tr> <tr> <td>场景二</td> <td>子企业A的员工</td> <td>子企业B(不指定经办人走领取逻辑)</td> <td>领取的逻辑可以参考文档<a href="https://qian.tencent.com/developers/partner/dynamic_signer" target="_blank">动态签署方</a> </td> </tr> <tr> <td>场景三</td> <td>子企业A的员工</td> <td>子企业B的员工</td> <td>-</td> </tr> <tr> <td>场景四</td> <td>子企业A的员工</td> <td>个人</td> <td>就是自然人,不是企业员工</td> </tr> <tr> <td>场景五</td> <td>子企业A的员工</td> <td>SaaS平台企业员工</td> <td>SaaS平台企业是通过<a href="https://qian.tencent.cn/console/company-register" target="_blank">https://qian.tencent.cn/console/company-register</a>链接注册的企业</td> </tr> </tbody> </table>
401
+ 本接口需依赖[文件上传接口](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)生成 PDF 资源编号(FileId)后使用,整体逻辑如下图:
409
402
 
403
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/985b4bf10a40d65fe7b016bb2f82c3df.svg)
410
404
 
411
- **注**:
412
- `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
405
+ ### 1.2 发起方和签署方
406
+ <table> <thead> <tr> <th>场景编号</th> <th>发起方</th> <th>签署方</th> <th>补充</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>子企业A的员工</td> <td>子企业A的员工</td> <td>子企业是通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">CreateConsoleLoginUrl</a>生成子客登录链接注册的企业</td> </tr> <tr> <td>场景二</td> <td>子企业A的员工</td> <td>子企业B(不指定经办人走领取逻辑)</td> <td>领取的逻辑可以参考文档<a href="https://qian.tencent.com/developers/partner/dynamic_signer" target="_blank">动态签署方</a> </td> </tr> <tr> <td>场景三</td> <td>子企业A的员工</td> <td>子企业B的员工</td> <td>-</td> </tr> <tr> <td>场景四</td> <td>子企业A的员工</td> <td>个人</td> <td>就是自然人,不是企业员工</td> </tr> <tr> <td>场景五</td> <td>子企业A的员工</td> <td>SaaS平台企业员工</td> <td>SaaS平台企业是通过<a href="https://qian.tencent.cn/console/company-register" target="_blank">https://qian.tencent.cn/console/company-register</a>链接注册的企业</td> </tr> </tbody> </table>
413
407
 
414
- `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
415
408
 
416
- `3. 合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度)`
409
+ <font color="red">发起方(第三方子企业 A 的企业与员工)必须完成实名</font>;作为**签署方**的第三方子企业 A 员工 / 个人自然人 / SaaS 平台企业员工 / 第三方子企业 B 员工等,其企业和个人可以未实名。
417
410
 
418
- `4. 静默(自动)签署不支持合同签署方存在填写功能`
411
+ ### 1.3 注意事项
412
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同,且<font color="red">有撤销合同额度</font>的情形下,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/partner/contract_cancel_quota)。
413
+ - <font color="red">支持的证件类型</font>可以参考[支持的证件类型](https://qian.tencent.com/developers/partner/id_card_support)。
414
+ - <font color="red">不同类型的签署方传参不同</font>,各类型签署方的信息传递方式详见 [【签署方入参指引】](https://qian.tencent.com/developers/partner/flow_approver)。
415
+ - 如果合同正式发起前如需<font color="red">预览</font>效果,可参考 [【使用文件发起的预览】](https://qian.tencent.com/developers/partner/preview_guide#%E4%B8%80%E4%BD%BF%E7%94%A8%E6%96%87%E4%BB%B6%E5%8F%91%E8%B5%B7%E7%9A%84%E9%A2%84%E8%A7%88)
416
+ - 关于填写方与签署方的<font color="red">填写、签署先后顺序</font>设置,详见 [【填写与签署顺序说明】](https://qian.tencent.com/developers/partner/fill_sign_order)。
417
+ - 关于<font color="red">本企业自动签署与其他企业自动签署</font>的配置与使用,详见 [【自动签署】](https://qian.tencent.com/developers/partner/autosign_guide)。
419
418
 
420
- <font color="red">相关视频指引</font> <br>
421
- 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a><br>
422
- 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-ChannelCreateFlowByFiles.mp4" target="_blank">【用PDF文件创建签署流程】编写示例</a><br>
419
+ ### 1.4 视频教程
420
+ 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a>
421
+ 2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-ChannelCreateFlowByFiles.mp4" target="_blank">【用PDF文件创建签署流程】编写示例</a>
423
422
  */
424
423
  async ChannelCreateFlowByFiles(req, cb) {
425
424
  return this.request("ChannelCreateFlowByFiles", req, cb);
@@ -16671,7 +16671,7 @@ export interface AiReviewProhibitedAsrTaskInput {
16671
16671
  */
16672
16672
  export interface DescribeMediaMetaDataResponse {
16673
16673
  /**
16674
- * 媒体元信息。
16674
+ * <p>媒体元信息。</p>
16675
16675
  */
16676
16676
  MetaData?: MediaMetaData;
16677
16677
  /**
@@ -26683,9 +26683,13 @@ export interface LowLightEnhanceConfig {
26683
26683
  */
26684
26684
  export interface DescribeMediaMetaDataRequest {
26685
26685
  /**
26686
- * 需要获取元信息的文件输入信息。
26686
+ * <p>需要获取元信息的文件输入信息。</p>
26687
26687
  */
26688
26688
  InputInfo: MediaInputInfo;
26689
+ /**
26690
+ * <p>指定为slow时,增加接口超时时间</p><p>枚举值:</p><ul><li>slow: 增加接口超时时间</li></ul>
26691
+ */
26692
+ Mode?: string;
26689
26693
  }
26690
26694
  /**
26691
26695
  * DescribeImageTasks请求参数结构体
@@ -2070,6 +2070,10 @@ export interface VatElectronicItemInfo {
2070
2070
  * <p>通行日期止</p>
2071
2071
  */
2072
2072
  DateEnd?: string;
2073
+ /**
2074
+ * <p>车架号</p>
2075
+ */
2076
+ VinNo?: string;
2073
2077
  }
2074
2078
  /**
2075
2079
  * 单词坐标信息
@@ -7042,105 +7046,109 @@ export interface ArithmeticOCRRequest {
7042
7046
  */
7043
7047
  export interface NonTaxIncomeBill {
7044
7048
  /**
7045
- * 发票名称
7049
+ * <p>发票名称</p>
7046
7050
  */
7047
7051
  Title?: string;
7048
7052
  /**
7049
- * 发票号码
7053
+ * <p>发票号码</p>
7050
7054
  */
7051
7055
  Number?: string;
7052
7056
  /**
7053
- * 发票代码
7057
+ * <p>发票代码</p>
7054
7058
  */
7055
7059
  Code?: string;
7056
7060
  /**
7057
- * 校验码
7061
+ * <p>校验码</p>
7058
7062
  */
7059
7063
  CheckCode?: string;
7060
7064
  /**
7061
- * 开票日期
7065
+ * <p>开票日期</p>
7062
7066
  */
7063
7067
  Date?: string;
7064
7068
  /**
7065
- * 价税合计(小写)
7069
+ * <p>价税合计(小写)</p>
7066
7070
  */
7067
7071
  Total?: string;
7068
7072
  /**
7069
- * 价税合计(大写)
7073
+ * <p>价税合计(大写)</p>
7070
7074
  */
7071
7075
  TotalCn?: string;
7072
7076
  /**
7073
- * 交款人名称
7077
+ * <p>交款人名称</p>
7074
7078
  */
7075
7079
  Buyer?: string;
7076
7080
  /**
7077
- * 交款人纳税人识别号
7081
+ * <p>交款人纳税人识别号</p>
7078
7082
  */
7079
7083
  BuyerTaxID?: string;
7080
7084
  /**
7081
- * 收款人名称
7085
+ * <p>收款人名称</p>
7082
7086
  */
7083
7087
  Seller?: string;
7084
7088
  /**
7085
- * 收款单位名称
7089
+ * <p>收款单位名称</p>
7086
7090
  */
7087
7091
  SellerCompany?: string;
7088
7092
  /**
7089
- * 备注
7093
+ * <p>备注</p>
7090
7094
  */
7091
7095
  Remark?: string;
7092
7096
  /**
7093
- * 币种
7097
+ * <p>币种</p>
7094
7098
  */
7095
7099
  CurrencyCode?: string;
7096
7100
  /**
7097
- * 复核人
7101
+ * <p>复核人</p>
7098
7102
  */
7099
7103
  Reviewer?: string;
7100
7104
  /**
7101
- * 是否存在二维码(1:有,0:无)
7105
+ * <p>是否存在二维码(1:有,0:无)</p>
7102
7106
  */
7103
7107
  QRCodeMark?: number;
7104
7108
  /**
7105
- * 其他信息
7109
+ * <p>其他信息</p>
7106
7110
  */
7107
7111
  OtherInfo?: string;
7108
7112
  /**
7109
- * 缴款码
7113
+ * <p>缴款码</p>
7110
7114
  */
7111
7115
  PaymentCode?: string;
7112
7116
  /**
7113
- * 执收单位编码
7117
+ * <p>执收单位编码</p>
7114
7118
  */
7115
7119
  ReceiveUnitCode?: string;
7116
7120
  /**
7117
- * 执收单位名称
7121
+ * <p>执收单位名称</p>
7118
7122
  */
7119
7123
  Receiver?: string;
7120
7124
  /**
7121
- * 经办人
7125
+ * <p>经办人</p>
7122
7126
  */
7123
7127
  Operator?: string;
7124
7128
  /**
7125
- * 付款人账号
7129
+ * <p>付款人账号</p>
7126
7130
  */
7127
7131
  PayerAccount?: string;
7128
7132
  /**
7129
- * 付款人开户银行
7133
+ * <p>付款人开户银行</p>
7130
7134
  */
7131
7135
  PayerBank?: string;
7132
7136
  /**
7133
- * 收款人账号
7137
+ * <p>收款人账号</p>
7134
7138
  */
7135
7139
  ReceiverAccount?: string;
7136
7140
  /**
7137
- * 收款人开户银行
7141
+ * <p>收款人开户银行</p>
7138
7142
  */
7139
7143
  ReceiverBank?: string;
7140
7144
  /**
7141
- * 条目
7145
+ * <p>条目</p>
7142
7146
  */
7143
7147
  NonTaxItems?: Array<NonTaxItem>;
7148
+ /**
7149
+ * <p>票据名称</p>
7150
+ */
7151
+ BillName?: string;
7144
7152
  }
7145
7153
  /**
7146
7154
  * VerifyOfdVatInvoiceOCR请求参数结构体
@@ -2540,6 +2540,10 @@ export interface ModifyDBInstanceParametersRequest {
2540
2540
  * CreateAuditLogFile返回参数结构体
2541
2541
  */
2542
2542
  export interface CreateAuditLogFileResponse {
2543
+ /**
2544
+ * <p>文件名称</p>
2545
+ */
2546
+ FileName?: string;
2543
2547
  /**
2544
2548
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2545
2549
  */
@@ -526,7 +526,7 @@ export interface SendSmsResponse {
526
526
  */
527
527
  export interface SendStatusStatisticsResponse {
528
528
  /**
529
- * 发送数据统计响应包体。
529
+ * <p>发送数据统计响应包体。</p>
530
530
  */
531
531
  SendStatusStatistics?: SendStatusStatistics;
532
532
  /**
@@ -917,26 +917,23 @@ export interface PhoneNumberInfo {
917
917
  */
918
918
  export interface SendStatusStatisticsRequest {
919
919
  /**
920
- * 起始时间,格式为yyyymmddhh,精确到小时,例如2024050113,表示2024年5月1号13时。
920
+ * <p>起始时间,格式为yyyymmddhh,精确到小时,例如2024050113,表示2024年5月1号13时。注:统计范围包含当前小时。</p><p>参数格式:yyyymmddhh</p>
921
921
  */
922
922
  BeginTime: string;
923
923
  /**
924
- * 结束时间,格式为yyyymmddhh,精确到小时,例如2024050118,表示2024年5月1号18时。
925
- 注:EndTime 必须大于等于 BeginTime。
924
+ * <p>结束时间,格式为yyyymmddhh,精确到小时,例如2024050118,表示2024年5月1号18时。注:EndTime 必须大于等于 BeginTime,统计范围包含当前小时。</p><p>参数格式:yyyymmddhh</p>
926
925
  */
927
926
  EndTime: string;
928
927
  /**
929
- * 短信 SdkAppId 在 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 添加应用后生成的实际 SdkAppId,示例如1400006666
928
+ * <p>短信 SdkAppId 在 <a href="https://console.cloud.tencent.com/smsv2/app-manage">短信控制台</a> 添加应用后生成的实际 SdkAppId,示例如1400006666。</p>
930
929
  */
931
930
  SmsSdkAppId: string;
932
931
  /**
933
- * 最大上限。
934
- 注:目前固定设置为0。
932
+ * <p>最大上限。<br>注:目前固定设置为0。</p>
935
933
  */
936
934
  Limit: number;
937
935
  /**
938
- * 偏移量。
939
- 注:目前固定设置为0。
936
+ * <p>偏移量。<br>注:目前固定设置为0。</p>
940
937
  */
941
938
  Offset: number;
942
939
  }
@@ -2466,6 +2466,11 @@ export interface ExecutePGSqlResponse {
2466
2466
  注意:此字段可能返回 null,表示取不到有效值。
2467
2467
  */
2468
2468
  Columns?: Array<string>;
2469
+ /**
2470
+ * <p>字段类型名</p>
2471
+ 注意:此字段可能返回 null,表示取不到有效值。
2472
+ */
2473
+ ColumnTypes?: Array<string>;
2469
2474
  /**
2470
2475
  * <p>数据行。每一行数据都是一个JSON串,将JSON进行反序列化将得到了每列的值。值可能是 null 或者 字符串,如果是 null 说明该列的值为 &lt;null&gt;,如果是字符串则为该列的值的字符串表示形式。</p>
2471
2476
  注意:此字段可能返回 null,表示取不到有效值。
@@ -820,6 +820,10 @@ export interface DescribeClusterActivitiesRequest {
820
820
  * <p>返回数量,默认为20,最大值为100。关于<code>Limit</code>的更进一步介绍请参考 API <a href="https://cloud.tencent.com/document/api/213/15688">简介</a>中的相关小节。</p>
821
821
  */
822
822
  Limit?: number;
823
+ /**
824
+ * <li><strong>queue-name</strong></li> <p style="padding-left: 30px;">按照【<strong>队列名称</strong>】进行过滤。队列名称形如:compute。</p><p style="padding-left: 30px;">类型:String</p><p style="padding-left: 30px;">必选:否</p><p style="padding-left: 30px;">每次请求的<code>Filters</code>的上限为10,<code>Filter.Values</code>的上限为5。</p>
825
+ */
826
+ Filters?: Array<Filter>;
823
827
  }
824
828
  /**
825
829
  * DeleteQueue请求参数结构体