tencentcloud-sdk-nodejs 4.0.945 → 4.0.947

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 (83) hide show
  1. package/CHANGELOG.md +386 -0
  2. package/SERVICE_CHANGELOG.md +418 -224
  3. package/package.json +1 -1
  4. package/products.md +28 -27
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/aiart/v20221229/aiart_client.ts +34 -21
  7. package/src/services/aiart/v20221229/aiart_models.ts +6 -6
  8. package/src/services/ca/index.ts +5 -0
  9. package/src/services/ca/v20230228/ca_client.ts +68 -0
  10. package/src/services/ca/v20230228/ca_models.ts +142 -0
  11. package/src/services/ca/v20230228/index.ts +6 -0
  12. package/src/services/ccc/v20200210/ccc_models.ts +4 -0
  13. package/src/services/cdn/v20180606/cdn_models.ts +16 -0
  14. package/src/services/cvm/v20170312/cvm_models.ts +4 -0
  15. package/src/services/cwp/v20180228/cwp_client.ts +4 -2
  16. package/src/services/cynosdb/v20190107/cynosdb_client.ts +6 -6
  17. package/src/services/cynosdb/v20190107/cynosdb_models.ts +1 -1
  18. package/src/services/dasb/v20191018/dasb_models.ts +16 -3
  19. package/src/services/dts/v20211206/dts_models.ts +16 -16
  20. package/src/services/emr/v20190103/emr_models.ts +4 -0
  21. package/src/services/ess/v20201111/ess_client.ts +19 -12
  22. package/src/services/ess/v20201111/ess_models.ts +32 -22
  23. package/src/services/essbasic/v20210526/essbasic_client.ts +11 -9
  24. package/src/services/essbasic/v20210526/essbasic_models.ts +11 -4
  25. package/src/services/index.ts +1 -0
  26. package/src/services/lcic/v20220817/lcic_models.ts +1 -1
  27. package/src/services/lighthouse/v20200324/lighthouse_models.ts +2 -2
  28. package/src/services/ocr/v20181119/ocr_models.ts +11 -0
  29. package/src/services/omics/v20221128/omics_client.ts +1 -0
  30. package/src/services/omics/v20221128/omics_models.ts +98 -11
  31. package/src/services/ses/v20201002/ses_models.ts +25 -0
  32. package/src/services/ssl/v20191205/ssl_client.ts +1 -0
  33. package/src/services/ssl/v20191205/ssl_models.ts +26 -0
  34. package/src/services/tcb/v20180608/tcb_models.ts +10 -1
  35. package/src/services/tts/v20190823/tts_client.ts +4 -1
  36. package/src/services/vpc/v20170312/vpc_client.ts +338 -70
  37. package/src/services/vpc/v20170312/vpc_models.ts +986 -296
  38. package/tencentcloud/common/sdk_version.d.ts +1 -1
  39. package/tencentcloud/common/sdk_version.js +1 -1
  40. package/tencentcloud/services/aiart/v20221229/aiart_client.d.ts +34 -21
  41. package/tencentcloud/services/aiart/v20221229/aiart_client.js +34 -21
  42. package/tencentcloud/services/aiart/v20221229/aiart_models.d.ts +6 -6
  43. package/tencentcloud/services/ca/index.d.ts +6 -0
  44. package/tencentcloud/services/ca/index.js +7 -0
  45. package/tencentcloud/services/ca/v20230228/ca_client.d.ts +22 -0
  46. package/tencentcloud/services/ca/v20230228/ca_client.js +49 -0
  47. package/tencentcloud/services/ca/v20230228/ca_models.d.ts +119 -0
  48. package/tencentcloud/services/ca/v20230228/ca_models.js +18 -0
  49. package/tencentcloud/services/ca/v20230228/index.d.ts +6 -0
  50. package/tencentcloud/services/ca/v20230228/index.js +9 -0
  51. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +4 -0
  52. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +16 -0
  53. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +4 -0
  54. package/tencentcloud/services/cwp/v20180228/cwp_client.d.ts +3 -1
  55. package/tencentcloud/services/cwp/v20180228/cwp_client.js +3 -1
  56. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +6 -6
  57. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +6 -6
  58. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +1 -1
  59. package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +16 -3
  60. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +16 -16
  61. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +4 -0
  62. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +18 -11
  63. package/tencentcloud/services/ess/v20201111/ess_client.js +18 -11
  64. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +32 -22
  65. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +11 -9
  66. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +11 -9
  67. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +11 -4
  68. package/tencentcloud/services/index.d.ts +1 -0
  69. package/tencentcloud/services/index.js +2 -0
  70. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +1 -1
  71. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +2 -2
  72. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +11 -0
  73. package/tencentcloud/services/omics/v20221128/omics_models.d.ts +97 -11
  74. package/tencentcloud/services/ses/v20201002/ses_models.d.ts +25 -0
  75. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +25 -0
  76. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +10 -1
  77. package/tencentcloud/services/tts/v20190823/tts_client.d.ts +4 -1
  78. package/tencentcloud/services/tts/v20190823/tts_client.js +4 -1
  79. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +107 -19
  80. package/tencentcloud/services/vpc/v20170312/vpc_client.js +157 -25
  81. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +920 -278
  82. package/test/ca.v20230228.test.js +51 -0
  83. package/test/vpc.v20170312.test.js +234 -14
@@ -9112,7 +9112,7 @@ export interface ModifyVipVportResponse {
9112
9112
  */
9113
9113
  export interface ModifyDBInstanceSecurityGroupsRequest {
9114
9114
  /**
9115
- * 实例组ID
9115
+ * 网络组id(cynosdbmysql-grp-前缀开头)或集群id
9116
9116
  */
9117
9117
  InstanceId: string;
9118
9118
  /**
@@ -823,15 +823,15 @@ export interface CmdTemplate {
823
823
  /**
824
824
  * 高危命令模板ID
825
825
  */
826
- Id: number;
826
+ Id?: number;
827
827
  /**
828
828
  * 高危命令模板名称
829
829
  */
830
- Name: string;
830
+ Name?: string;
831
831
  /**
832
832
  * 命令列表,命令之间用换行符("\n")分隔
833
833
  */
834
- CmdList: string;
834
+ CmdList?: string;
835
835
  }
836
836
  /**
837
837
  * 命令执行检索结果
@@ -1338,6 +1338,10 @@ export interface CreateAclRequest {
1338
1338
  * 是否允许使用访问串,默认允许
1339
1339
  */
1340
1340
  AllowAccessCredential?: boolean;
1341
+ /**
1342
+ * 是否允许记录键盘
1343
+ */
1344
+ AllowKeyboardLogger?: boolean;
1341
1345
  }
1342
1346
  /**
1343
1347
  * DescribeLoginEvent返回参数结构体
@@ -1679,6 +1683,10 @@ export interface ModifyAclRequest {
1679
1683
  * 是否允许使用访问串
1680
1684
  */
1681
1685
  AllowAccessCredential?: boolean;
1686
+ /**
1687
+ * 是否允许键盘记录
1688
+ */
1689
+ AllowKeyboardLogger?: boolean;
1682
1690
  }
1683
1691
  /**
1684
1692
  * SearchAuditLog请求参数结构体
@@ -3577,6 +3585,11 @@ export interface Acl {
3577
3585
  注意:此字段可能返回 null,表示取不到有效值。
3578
3586
  */
3579
3587
  WhiteCmds?: Array<string>;
3588
+ /**
3589
+ * 是否允许记录键盘
3590
+ 注意:此字段可能返回 null,表示取不到有效值。
3591
+ */
3592
+ AllowKeyboardLogger?: boolean;
3580
3593
  }
3581
3594
  /**
3582
3595
  * 资产标签
@@ -1750,7 +1750,7 @@ export interface MigrateOption {
1750
1750
  */
1751
1751
  DatabaseTable: DatabaseTableObject;
1752
1752
  /**
1753
- * 迁移类型,full(全量迁移),structure(结构迁移),fullAndIncrement(全量加增量迁移), 默认为fullAndIncrement
1753
+ * 迁移类型,full(全量迁移),structure(结构迁移),fullAndIncrement(全量加增量迁移), 默认为fullAndIncrement;注意redis,keewidb产品只支持fullAndIncrement类型。
1754
1754
  注意:此字段可能返回 null,表示取不到有效值。
1755
1755
  */
1756
1756
  MigrateType?: string;
@@ -1760,7 +1760,7 @@ export interface MigrateOption {
1760
1760
  */
1761
1761
  Consistency?: ConsistencyOption;
1762
1762
  /**
1763
- * 是否迁移账号,yes(迁移账号),no(不迁移账号)
1763
+ * 是否迁移账号,true(迁移账号),false(不迁移账号)
1764
1764
  注意:此字段可能返回 null,表示取不到有效值。
1765
1765
  */
1766
1766
  IsMigrateAccount?: boolean;
@@ -1776,7 +1776,7 @@ export interface MigrateOption {
1776
1776
  IsDstReadOnly?: boolean;
1777
1777
  /**
1778
1778
  * 其他附加信息,对于特定库可设置额外参数,Redis可定义如下的参数:
1779
- ["DstWriteMode":normal, 目标库写入模式,可取值clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(跟正常流程一样,不做额外动作) "IsDstReadOnly":true, 是否在迁移时设置目标库只读,true(设置只读)、false(不设置只读) "ClientOutputBufferHardLimit":512, 从机缓冲区的硬性容量限制(MB) "ClientOutputBufferSoftLimit":512, 从机缓冲区的软性容量限制(MB) "ClientOutputBufferPersistTime":60, 从机缓冲区的软性限制持续时间(秒) "ReplBacklogSize":512, 环形缓冲区容量限制(MB) "ReplTimeout":120, 复制超时时间(秒)]
1779
+ ["DstWriteMode":normal, 目标库写入模式,可取值clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(跟正常流程一样,不做额外动作) "IsDstReadOnly":true, 是否在迁移时设置目标库只读,true(设置只读)、false(不设置只读) "ClientOutputBufferHardLimit":512, 从机缓冲区的硬性容量限制(MB) "ClientOutputBufferSoftLimit":512, 从机缓冲区的软性容量限制(MB) "ClientOutputBufferPersistTime":60, 从机缓冲区的软性限制持续时间(秒) "ReplBacklogSize":512, 环形缓冲区容量限制(MB) "ReplTimeout":120, 复制超时时间(秒) "IsExpireKey":"true",过期key自动淘汰]
1780
1780
  注意:此字段可能返回 null,表示取不到有效值。
1781
1781
  */
1782
1782
  ExtraAttr?: Array<KeyValuePairOption>;
@@ -2335,17 +2335,17 @@ export interface DBInfo {
2335
2335
  */
2336
2336
  AccountMode?: string;
2337
2337
  /**
2338
- * 临时密钥Id,可通过 获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195
2338
+ * 临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。
2339
2339
  注意:此字段可能返回 null,表示取不到有效值。
2340
2340
  */
2341
2341
  TmpSecretId?: string;
2342
2342
  /**
2343
- * 临时密钥Key,可通过 获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195
2343
+ * 临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。
2344
2344
  注意:此字段可能返回 null,表示取不到有效值。
2345
2345
  */
2346
2346
  TmpSecretKey?: string;
2347
2347
  /**
2348
- * 临时Token,可通过 获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195
2348
+ * 临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。
2349
2349
  注意:此字段可能返回 null,表示取不到有效值。
2350
2350
  */
2351
2351
  TmpToken?: string;
@@ -2607,11 +2607,11 @@ export interface ConfigureSyncJobRequest {
2607
2607
  */
2608
2608
  SrcConnectType?: string;
2609
2609
  /**
2610
- * 源端信息,单节点数据库使用,且SrcNodeType传single
2610
+ * 源端信息,单机版类型数据库配置使用,且SrcNodeType传single。例如mysql、percona、mariadb等。
2611
2611
  */
2612
2612
  SrcInfo?: Endpoint;
2613
2613
  /**
2614
- * 源端信息,多节点数据库使用,且SrcNodeType传cluster
2614
+ * 源端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等。
2615
2615
  */
2616
2616
  SrcInfos?: SyncDBEndpointInfos;
2617
2617
  /**
@@ -2619,11 +2619,11 @@ export interface ConfigureSyncJobRequest {
2619
2619
  */
2620
2620
  SrcNodeType?: string;
2621
2621
  /**
2622
- * 目标端信息,单节点数据库使用
2622
+ * 目标端信息,单机版类型数据库配置使用,且SrcNodeType传single。例如mysql、percona、mariadb等。
2623
2623
  */
2624
2624
  DstInfo?: Endpoint;
2625
2625
  /**
2626
- * 目标端信息,多节点数据库使用,且DstNodeType传cluster
2626
+ * 目标端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等。
2627
2627
  */
2628
2628
  DstInfos?: SyncDBEndpointInfos;
2629
2629
  /**
@@ -2750,15 +2750,15 @@ export interface DescribeMigrateDBInstancesRequest {
2750
2750
  */
2751
2751
  AccountMode?: string;
2752
2752
  /**
2753
- * 临时密钥Id,若为跨账号资源此项必填
2753
+ * 临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。
2754
2754
  */
2755
2755
  TmpSecretId?: string;
2756
2756
  /**
2757
- * 临时密钥Key,若为跨账号资源此项必填
2757
+ * 临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。
2758
2758
  */
2759
2759
  TmpSecretKey?: string;
2760
2760
  /**
2761
- * 临时密钥Token,若为跨账号资源此项必填
2761
+ * 临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。
2762
2762
  */
2763
2763
  TmpToken?: string;
2764
2764
  }
@@ -4511,17 +4511,17 @@ export interface Endpoint {
4511
4511
  */
4512
4512
  RoleExternalId?: string;
4513
4513
  /**
4514
- * 临时密钥Id,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,如果为跨账号实例此项必填
4514
+ * 临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。
4515
4515
  注意:此字段可能返回 null,表示取不到有效值。
4516
4516
  */
4517
4517
  TmpSecretId?: string;
4518
4518
  /**
4519
- * 临时密钥Key,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,,如果为跨账号实例此项必填
4519
+ * 临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。
4520
4520
  注意:此字段可能返回 null,表示取不到有效值。
4521
4521
  */
4522
4522
  TmpSecretKey?: string;
4523
4523
  /**
4524
- * 临时Token,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,,如果为跨账号实例此项必填
4524
+ * 临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。
4525
4525
  注意:此字段可能返回 null,表示取不到有效值。
4526
4526
  */
4527
4527
  TmpToken?: string;
@@ -3673,6 +3673,10 @@ export interface DescribeInsightListRequest {
3673
3673
  * 分页查询时的页号,从1开始
3674
3674
  */
3675
3675
  Page: number;
3676
+ /**
3677
+ * 查询类型,支持HIVE,SPARK,MAPREDUCE,TRINO等类型,默认查询全部
3678
+ */
3679
+ Type?: string;
3676
3680
  }
3677
3681
  /**
3678
3682
  * DescribeYarnScheduleHistory请求参数结构体
@@ -11,7 +11,7 @@ export declare class Client extends AbstractClient {
11
11
  * 此接口用于启动流程。它是模板发起合同的最后一步。
12
12
  在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于开始整个合同流程, 推进流程进入到签署环节。
13
13
 
14
- ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
14
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
15
15
 
16
16
  注:
17
17
  1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度)
@@ -140,7 +140,7 @@ export declare class Client extends AbstractClient {
140
140
  ### 调用流程
141
141
  该接口需要给对应的流程指定一个模板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>接口使用。具体逻辑可以参考下图:
142
142
 
143
- ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
143
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
144
144
 
145
145
 
146
146
  ### 填充模板中定义的填写控件
@@ -455,7 +455,7 @@ export declare class Client extends AbstractClient {
455
455
 
456
456
  注:配合<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>接口使用。整体的逻辑如下图
457
457
 
458
- ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
458
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
459
459
 
460
460
  注:**静默(自动)签署不支持合同签署方存在填写**功能
461
461
  <br>
@@ -478,6 +478,8 @@ export declare class Client extends AbstractClient {
478
478
  <li>在解除协议签署完毕后,原合同及解除协议均变为已解除状态。</li>
479
479
  <li>非原合同企业参与人发起解除协议时,需要有<code>解除合同的权限</code>。</li>
480
480
  </ul>
481
+
482
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/3427941ecb091bf0c55009bad192dd1c.png)
481
483
  */
482
484
  CreateReleaseFlow(req: CreateReleaseFlowRequest, cb?: (error: string, rep: CreateReleaseFlowResponse) => void): Promise<CreateReleaseFlowResponse>;
483
485
  /**
@@ -537,8 +539,7 @@ export declare class Client extends AbstractClient {
537
539
  */
538
540
  CancelMultiFlowSignQRCode(req: CancelMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void): Promise<CancelMultiFlowSignQRCodeResponse>;
539
541
  /**
540
- * 查询流程基础信息
541
- 适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
542
+ * 查询流程基础信息,主要用于<font color="red">查询合同的状态</font>信息。可以配合回调通知使用。
542
543
 
543
544
  注: `每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误`
544
545
  */
@@ -857,7 +858,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
857
858
  */
858
859
  CreateIntegrationSubOrganizationActiveRecord(req: CreateIntegrationSubOrganizationActiveRecordRequest, cb?: (error: string, rep: CreateIntegrationSubOrganizationActiveRecordResponse) => void): Promise<CreateIntegrationSubOrganizationActiveRecordResponse>;
859
860
  /**
860
- * 可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容,包括填写控件的归属方、填写控件是否已经填写以及填写的内容等信息。
861
+ * 可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容,包括填写控件的归属方、填写控件是否已经填写以及填写的具体内容。
862
+
863
+
864
+ 如下图模板所示,发起后对方填写后,可以获取红框中用户填写的信息。
865
+
866
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/08f6ea50d3ae88b51c280c2b17c2a126.png)
861
867
  */
862
868
  DescribeFlowComponents(req: DescribeFlowComponentsRequest, cb?: (error: string, rep: DescribeFlowComponentsResponse) => void): Promise<DescribeFlowComponentsResponse>;
863
869
  /**
@@ -913,10 +919,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
913
919
  * 该接口用于发起合同后,生成个人用户的批量待办链接, 暂时不支持企业端签署。
914
920
  **注意:**
915
921
  1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
916
- 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件**
917
- 3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。
918
- 4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
919
- 5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
922
+ 2. 该接口可生成C端签署人的批量签署/查看链接,**签署控件仅支持手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**
923
+ 3. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
924
+ 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
920
925
  跳转到小程序的实现,参考微信官方文档(分为<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>。
921
926
  6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
922
927
  */
@@ -942,7 +947,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
942
947
 
943
948
  3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
944
949
 
945
- 4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员
950
+ 4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
946
951
  */
947
952
  CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
948
953
  /**
@@ -969,6 +974,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
969
974
  ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
970
975
 
971
976
  3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
977
+
978
+ 4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
972
979
  */
973
980
  CreateBatchCancelFlowUrl(req: CreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: CreateBatchCancelFlowUrlResponse) => void): Promise<CreateBatchCancelFlowUrlResponse>;
974
981
  /**
@@ -31,7 +31,7 @@ class Client extends abstract_client_1.AbstractClient {
31
31
  * 此接口用于启动流程。它是模板发起合同的最后一步。
32
32
  在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于开始整个合同流程, 推进流程进入到签署环节。
33
33
 
34
- ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
34
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
35
35
 
36
36
  注:
37
37
  1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度)
@@ -178,7 +178,7 @@ class Client extends abstract_client_1.AbstractClient {
178
178
  ### 调用流程
179
179
  该接口需要给对应的流程指定一个模板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>接口使用。具体逻辑可以参考下图:
180
180
 
181
- ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
181
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
182
182
 
183
183
 
184
184
  ### 填充模板中定义的填写控件
@@ -541,7 +541,7 @@ class Client extends abstract_client_1.AbstractClient {
541
541
 
542
542
  注:配合<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>接口使用。整体的逻辑如下图
543
543
 
544
- ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
544
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
545
545
 
546
546
  注:**静默(自动)签署不支持合同签署方存在填写**功能
547
547
  <br>
@@ -566,6 +566,8 @@ class Client extends abstract_client_1.AbstractClient {
566
566
  <li>在解除协议签署完毕后,原合同及解除协议均变为已解除状态。</li>
567
567
  <li>非原合同企业参与人发起解除协议时,需要有<code>解除合同的权限</code>。</li>
568
568
  </ul>
569
+
570
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/3427941ecb091bf0c55009bad192dd1c.png)
569
571
  */
570
572
  async CreateReleaseFlow(req, cb) {
571
573
  return this.request("CreateReleaseFlow", req, cb);
@@ -637,8 +639,7 @@ class Client extends abstract_client_1.AbstractClient {
637
639
  return this.request("CancelMultiFlowSignQRCode", req, cb);
638
640
  }
639
641
  /**
640
- * 查询流程基础信息
641
- 适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
642
+ * 查询流程基础信息,主要用于<font color="red">查询合同的状态</font>信息。可以配合回调通知使用。
642
643
 
643
644
  注: `每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误`
644
645
  */
@@ -1011,7 +1012,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1011
1012
  return this.request("CreateIntegrationSubOrganizationActiveRecord", req, cb);
1012
1013
  }
1013
1014
  /**
1014
- * 可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容,包括填写控件的归属方、填写控件是否已经填写以及填写的内容等信息。
1015
+ * 可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容,包括填写控件的归属方、填写控件是否已经填写以及填写的具体内容。
1016
+
1017
+
1018
+ 如下图模板所示,发起后对方填写后,可以获取红框中用户填写的信息。
1019
+
1020
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/08f6ea50d3ae88b51c280c2b17c2a126.png)
1015
1021
  */
1016
1022
  async DescribeFlowComponents(req, cb) {
1017
1023
  return this.request("DescribeFlowComponents", req, cb);
@@ -1073,10 +1079,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1073
1079
  * 该接口用于发起合同后,生成个人用户的批量待办链接, 暂时不支持企业端签署。
1074
1080
  **注意:**
1075
1081
  1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
1076
- 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件**
1077
- 3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。
1078
- 4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
1079
- 5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
1082
+ 2. 该接口可生成C端签署人的批量签署/查看链接,**签署控件仅支持手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**
1083
+ 3. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
1084
+ 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
1080
1085
  跳转到小程序的实现,参考微信官方文档(分为<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>。
1081
1086
  6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
1082
1087
  */
@@ -1106,7 +1111,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1106
1111
 
1107
1112
  3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
1108
1113
 
1109
- 4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员
1114
+ 4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
1110
1115
  */
1111
1116
  async CancelFlow(req, cb) {
1112
1117
  return this.request("CancelFlow", req, cb);
@@ -1137,6 +1142,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1137
1142
  ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
1138
1143
 
1139
1144
  3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
1145
+
1146
+ 4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
1140
1147
  */
1141
1148
  async CreateBatchCancelFlowUrl(req, cb) {
1142
1149
  return this.request("CreateBatchCancelFlowUrl", req, cb);
@@ -4930,11 +4930,14 @@ export interface FlowCreateApprover {
4930
4930
  */
4931
4931
  Deadline?: number;
4932
4932
  /**
4933
- * 视频核身意图配置,可指定问答模式或者点头模式的语音文本。
4933
+ * <b>只有在生成H5签署链接的情形下</b>( 如调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口),该配置才会生效。
4934
4934
 
4935
- 注:
4936
- `1.视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
4937
- `2.使用视频认证必须指定签署认证方式为人脸(即ApproverSignTypes)。`
4935
+ 您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。
4936
+
4937
+ 注意:
4938
+ 1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。
4939
+ 2. 使用视频认证时,<b>生成H5签署链接必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。
4940
+ 3. 签署完成后,可以通过<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
4938
4941
  */
4939
4942
  Intention?: Intention;
4940
4943
  }
@@ -5790,9 +5793,10 @@ export interface DeleteIntegrationRoleUsersRequest {
5790
5793
  */
5791
5794
  export interface CreateFlowSignUrlRequest {
5792
5795
  /**
5793
- * 合同流程ID,为32位字符串。
5794
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
5795
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
5796
+ * 合同流程ID32位字符串。
5797
+
5798
+ 您可以登录腾讯电子签控制台,在 "合同" -> "合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
5799
+
5796
5800
  */
5797
5801
  FlowId: string;
5798
5802
  /**
@@ -5806,11 +5810,13 @@ export interface CreateFlowSignUrlRequest {
5806
5810
  */
5807
5811
  Agent?: Agent;
5808
5812
  /**
5809
- * 流程签署人列表,其中结构体的ApproverNameApproverMobile和ApproverType必传,企业签署人则需传OrganizationName,其他可不传。
5813
+ * 流程签署人列表中,结构体的ApproverNameApproverMobile和ApproverType为必传字段。如果是企业签署人,还需传递OrganizationName
5814
+
5815
+ 注:
5816
+ 1. 签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>,其他类型的签署控件暂时不支持。
5817
+ 2. 生成发起方预览链接时,该字段(FlowApproverInfos)可以传空或者不传。
5818
+
5810
5819
 
5811
- 注:
5812
- `1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`
5813
- `2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
5814
5820
  */
5815
5821
  FlowApproverInfos?: Array<FlowCreateApprover>;
5816
5822
  /**
@@ -5824,12 +5830,14 @@ export interface CreateFlowSignUrlRequest {
5824
5830
  */
5825
5831
  JumpUrl?: string;
5826
5832
  /**
5827
- * 链接类型,支持指定以下类型
5828
- <ul><li>0 : 签署链接 (默认值)</li>
5829
- <li>1 : 预览链接</li></ul>
5830
- 注:
5831
- `1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`
5832
- `2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`
5833
+ * 链接类型支持以下指定类型:
5834
+
5835
+ <ul><li><b>0</b>: 签署链接(默认值),进入后可以填写或签署合同。</li><li><b>1 </b>: 预览链接,进入后可以预览合同当前的样子。</li></ul>
5836
+
5837
+ 注:
5838
+
5839
+ 1. 当指定链接类型为1时,链接为预览链接,打开链接后无法进行签署操作,仅支持预览和查看当前合同状态。
5840
+ 2. 如需生成发起方预览链接,则签署方信息应传空,即FlowApproverInfos传空或者不传。
5833
5841
  */
5834
5842
  UrlType?: number;
5835
5843
  }
@@ -6270,12 +6278,15 @@ export interface ApproverInfo {
6270
6278
  */
6271
6279
  SignComponents?: Array<Component>;
6272
6280
  /**
6273
- * 签署方经办人的证件类型,支持以下类型
6281
+ * 签署方经办人的证件类型,支持以下类型,样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a>
6274
6282
  <ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
6275
6283
  <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
6276
6284
  <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
6277
6285
  <li>OTHER_CARD_TYPE 其他证件</li></ul>
6278
6286
 
6287
+
6288
+
6289
+
6279
6290
  注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
6280
6291
  */
6281
6292
  ApproverIdCardType?: string;
@@ -6296,7 +6307,7 @@ export interface ApproverInfo {
6296
6307
  */
6297
6308
  NotifyType?: string;
6298
6309
  /**
6299
- * 收据场景设置签署人角色类型, 可以设置如下****类型****:
6310
+ * 收据场景设置签署人角色类型, 可以设置如下<b>类型</b>:
6300
6311
  <ul><li> **1** :收款人</li>
6301
6312
  <li> **2** :开具人</li>
6302
6313
  <li> **3** :见证人</li></ul>
@@ -8109,11 +8120,10 @@ export interface DescribeFlowBriefsRequest {
8109
8120
  Operator: UserInfo;
8110
8121
  /**
8111
8122
  * 查询的合同流程ID列表最多支持100个流程ID。
8112
- 如果某个合同流程ID不存在,系统会跳过此ID的查询,继续查询剩余存在的合同流程。
8113
8123
 
8114
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
8124
+ 如果某个合同流程ID不存在,系统会跳过此ID的查询,继续查询剩余存在的合同流程。
8115
8125
 
8116
- [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
8126
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
8117
8127
  */
8118
8128
  FlowIds: Array<string>;
8119
8129
  /**
@@ -243,6 +243,7 @@ export declare class Client extends AbstractClient {
243
243
  - 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
244
244
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
245
245
  - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
246
+ - 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
246
247
  */
247
248
  ChannelCancelFlow(req: ChannelCancelFlowRequest, cb?: (error: string, rep: ChannelCancelFlowResponse) => void): Promise<ChannelCancelFlowResponse>;
248
249
  /**
@@ -266,15 +267,14 @@ export declare class Client extends AbstractClient {
266
267
  */
267
268
  ChannelCreateSealPolicy(req: ChannelCreateSealPolicyRequest, cb?: (error: string, rep: ChannelCreateSealPolicyResponse) => void): Promise<ChannelCreateSealPolicyResponse>;
268
269
  /**
269
- * 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。
270
- **注意**:
271
- 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=PERSON)。
272
- 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件**
273
- 3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。
274
- 4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
275
- 5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
270
+ * 该接口用于发起合同后,生成个人用户的批量待办链接, 暂时不支持企业端签署。
271
+ **注意:**
272
+ 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
273
+ 2. 该接口可生成C端签署人的批量签署/查看链接,**签署控件仅支持手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**
274
+ 3. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
275
+ 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
276
276
  跳转到小程序的实现,参考微信官方文档(分为<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>。
277
- 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
277
+ 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
278
278
  */
279
279
  ChannelCreateBatchQuickSignUrl(req: ChannelCreateBatchQuickSignUrlRequest, cb?: (error: string, rep: ChannelCreateBatchQuickSignUrlResponse) => void): Promise<ChannelCreateBatchQuickSignUrlResponse>;
280
280
  /**
@@ -508,7 +508,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
508
508
  2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。
509
509
 
510
510
  系统的渠道企业, 应用, 子客企业, 子客员工的组织形式
511
- ![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)
511
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/77677faeea26c9d7f37474597c81fe01.png)
512
512
 
513
513
 
514
514
  <font color="red">相关视频指引</font> <br>
@@ -573,6 +573,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
573
573
  注:
574
574
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
575
575
  - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
576
+ - 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
576
577
  */
577
578
  ChannelCreateBatchCancelFlowUrl(req: ChannelCreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: ChannelCreateBatchCancelFlowUrlResponse) => void): Promise<ChannelCreateBatchCancelFlowUrlResponse>;
578
579
  /**
@@ -732,6 +733,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
732
733
  - 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
733
734
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
734
735
  - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
736
+ - 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
735
737
  */
736
738
  ChannelBatchCancelFlows(req: ChannelBatchCancelFlowsRequest, cb?: (error: string, rep: ChannelBatchCancelFlowsResponse) => void): Promise<ChannelBatchCancelFlowsResponse>;
737
739
  /**
@@ -297,6 +297,7 @@ class Client extends abstract_client_1.AbstractClient {
297
297
  - 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
298
298
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
299
299
  - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
300
+ - 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
300
301
  */
301
302
  async ChannelCancelFlow(req, cb) {
302
303
  return this.request("ChannelCancelFlow", req, cb);
@@ -328,15 +329,14 @@ class Client extends abstract_client_1.AbstractClient {
328
329
  return this.request("ChannelCreateSealPolicy", req, cb);
329
330
  }
330
331
  /**
331
- * 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。
332
- **注意**:
333
- 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=PERSON)。
334
- 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件**
335
- 3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。
336
- 4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
337
- 5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
332
+ * 该接口用于发起合同后,生成个人用户的批量待办链接, 暂时不支持企业端签署。
333
+ **注意:**
334
+ 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
335
+ 2. 该接口可生成C端签署人的批量签署/查看链接,**签署控件仅支持手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**
336
+ 3. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
337
+ 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
338
338
  跳转到小程序的实现,参考微信官方文档(分为<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>。
339
- 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
339
+ 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
340
340
  */
341
341
  async ChannelCreateBatchQuickSignUrl(req, cb) {
342
342
  return this.request("ChannelCreateBatchQuickSignUrl", req, cb);
@@ -590,7 +590,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
590
590
  2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。
591
591
 
592
592
  系统的渠道企业, 应用, 子客企业, 子客员工的组织形式
593
- ![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)
593
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/77677faeea26c9d7f37474597c81fe01.png)
594
594
 
595
595
 
596
596
  <font color="red">相关视频指引</font> <br>
@@ -661,6 +661,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
661
661
  注:
662
662
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
663
663
  - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
664
+ - 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
664
665
  */
665
666
  async ChannelCreateBatchCancelFlowUrl(req, cb) {
666
667
  return this.request("ChannelCreateBatchCancelFlowUrl", req, cb);
@@ -850,6 +851,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
850
851
  - 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
851
852
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
852
853
  - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
854
+ - 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
853
855
  */
854
856
  async ChannelBatchCancelFlows(req, cb) {
855
857
  return this.request("ChannelBatchCancelFlows", req, cb);