tencentcloud-sdk-nodejs 4.0.680 → 4.0.682

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 (119) hide show
  1. package/CHANGELOG.md +413 -0
  2. package/SERVICE_CHANGELOG.md +600 -181
  3. package/package.json +1 -1
  4. package/products.md +41 -41
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/asr/v20190614/asr_client.ts +11 -10
  7. package/src/services/asr/v20190614/asr_models.ts +48 -17
  8. package/src/services/batch/v20170312/batch_models.ts +22 -22
  9. package/src/services/ccc/v20200210/ccc_models.ts +3 -3
  10. package/src/services/cdwch/v20200915/cdwch_client.ts +5 -3
  11. package/src/services/cdwch/v20200915/cdwch_models.ts +79 -20
  12. package/src/services/cfw/v20190904/cfw_client.ts +29 -3
  13. package/src/services/cfw/v20190904/cfw_models.ts +150 -47
  14. package/src/services/ckafka/v20190819/ckafka_models.ts +4 -4
  15. package/src/services/clb/v20180317/clb_models.ts +103 -73
  16. package/src/services/cls/v20201016/cls_models.ts +31 -21
  17. package/src/services/cvm/v20170312/cvm_client.ts +1 -0
  18. package/src/services/cvm/v20170312/cvm_models.ts +23 -27
  19. package/src/services/cynosdb/v20190107/cynosdb_models.ts +10 -7
  20. package/src/services/dbbrain/v20210527/dbbrain_client.ts +41 -11
  21. package/src/services/dbbrain/v20210527/dbbrain_models.ts +391 -96
  22. package/src/services/dnspod/v20210323/dnspod_models.ts +38 -34
  23. package/src/services/ecm/v20190719/ecm_models.ts +7 -2
  24. package/src/services/ess/v20201111/ess_client.ts +26 -14
  25. package/src/services/ess/v20201111/ess_models.ts +139 -108
  26. package/src/services/essbasic/v20210526/essbasic_client.ts +7 -0
  27. package/src/services/essbasic/v20210526/essbasic_models.ts +34 -27
  28. package/src/services/faceid/v20180301/faceid_models.ts +14 -9
  29. package/src/services/lcic/v20220817/lcic_models.ts +26 -0
  30. package/src/services/live/v20180801/live_client.ts +13 -0
  31. package/src/services/live/v20180801/live_models.ts +47 -0
  32. package/src/services/monitor/v20180724/monitor_client.ts +15 -2
  33. package/src/services/monitor/v20180724/monitor_models.ts +107 -49
  34. package/src/services/mps/v20190612/mps_client.ts +6 -1
  35. package/src/services/mps/v20190612/mps_models.ts +153 -38
  36. package/src/services/oceanus/v20190422/oceanus_models.ts +7 -1
  37. package/src/services/ses/v20201002/ses_models.ts +1 -1
  38. package/src/services/sqlserver/v20180328/sqlserver_client.ts +2 -3
  39. package/src/services/sqlserver/v20180328/sqlserver_models.ts +3 -3
  40. package/src/services/ssl/v20191205/ssl_client.ts +64 -6
  41. package/src/services/ssl/v20191205/ssl_models.ts +564 -0
  42. package/src/services/tdmq/v20200217/tdmq_client.ts +29 -3
  43. package/src/services/tdmq/v20200217/tdmq_models.ts +251 -29
  44. package/src/services/teo/v20220901/teo_client.ts +12 -0
  45. package/src/services/teo/v20220901/teo_models.ts +34 -0
  46. package/src/services/tione/v20211111/tione_models.ts +48 -5
  47. package/src/services/trtc/v20190722/trtc_models.ts +5 -2
  48. package/src/services/tse/v20201207/tse_models.ts +5 -0
  49. package/src/services/tsf/v20180326/tsf_client.ts +1 -1
  50. package/src/services/tsf/v20180326/tsf_models.ts +5 -4
  51. package/src/services/vod/v20180717/vod_models.ts +1 -1
  52. package/tencentcloud/common/sdk_version.d.ts +1 -1
  53. package/tencentcloud/common/sdk_version.js +1 -1
  54. package/tencentcloud/services/asr/v20190614/asr_client.d.ts +11 -10
  55. package/tencentcloud/services/asr/v20190614/asr_client.js +11 -10
  56. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +48 -17
  57. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +22 -22
  58. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +3 -3
  59. package/tencentcloud/services/cdwch/v20200915/cdwch_client.d.ts +2 -2
  60. package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +77 -20
  61. package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +10 -1
  62. package/tencentcloud/services/cfw/v20190904/cfw_client.js +13 -0
  63. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +145 -47
  64. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +4 -4
  65. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +103 -73
  66. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +31 -21
  67. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +1 -0
  68. package/tencentcloud/services/cvm/v20170312/cvm_client.js +1 -0
  69. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +23 -27
  70. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +10 -7
  71. package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.d.ts +11 -3
  72. package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.js +15 -3
  73. package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +381 -96
  74. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +38 -34
  75. package/tencentcloud/services/ecm/v20190719/ecm_models.d.ts +7 -2
  76. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +25 -13
  77. package/tencentcloud/services/ess/v20201111/ess_client.js +25 -13
  78. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +139 -108
  79. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +7 -0
  80. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +7 -0
  81. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +34 -27
  82. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +14 -9
  83. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +26 -0
  84. package/tencentcloud/services/live/v20180801/live_client.d.ts +5 -1
  85. package/tencentcloud/services/live/v20180801/live_client.js +6 -0
  86. package/tencentcloud/services/live/v20180801/live_models.d.ts +44 -0
  87. package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +5 -1
  88. package/tencentcloud/services/monitor/v20180724/monitor_client.js +6 -0
  89. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +104 -49
  90. package/tencentcloud/services/mps/v20190612/mps_client.d.ts +1 -1
  91. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +148 -38
  92. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +7 -1
  93. package/tencentcloud/services/ses/v20201002/ses_models.d.ts +1 -1
  94. package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.d.ts +0 -1
  95. package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.js +0 -1
  96. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +3 -3
  97. package/tencentcloud/services/ssl/v20191205/ssl_client.d.ts +15 -3
  98. package/tencentcloud/services/ssl/v20191205/ssl_client.js +21 -3
  99. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +536 -0
  100. package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +9 -1
  101. package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +12 -0
  102. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +245 -29
  103. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +5 -1
  104. package/tencentcloud/services/teo/v20220901/teo_client.js +6 -0
  105. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +32 -0
  106. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +48 -5
  107. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +5 -2
  108. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +5 -0
  109. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +1 -1
  110. package/tencentcloud/services/tsf/v20180326/tsf_client.js +1 -1
  111. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +5 -4
  112. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +1 -1
  113. package/test/cfw.v20190904.test.js +20 -0
  114. package/test/dbbrain.v20210527.test.js +22 -2
  115. package/test/live.v20180801.test.js +10 -0
  116. package/test/monitor.v20180724.test.js +10 -0
  117. package/test/ssl.v20191205.test.js +32 -2
  118. package/test/tdmq.v20200217.test.js +20 -0
  119. package/test/teo.v20220901.test.js +10 -0
@@ -559,98 +559,98 @@ export interface DomainInfo {
559
559
  /**
560
560
  * 域名ID
561
561
  */
562
- DomainId: number;
562
+ DomainId?: number;
563
563
  /**
564
564
  * 域名状态
565
565
  */
566
- Status: string;
566
+ Status?: string;
567
567
  /**
568
568
  * 域名套餐等级
569
569
  */
570
- Grade: string;
570
+ Grade?: string;
571
571
  /**
572
572
  * 域名分组ID
573
573
  */
574
- GroupId: number;
574
+ GroupId?: number;
575
575
  /**
576
576
  * 是否星标域名
577
577
  */
578
- IsMark: string;
578
+ IsMark?: string;
579
579
  /**
580
580
  * TTL(DNS记录缓存时间)
581
581
  */
582
- TTL: number;
582
+ TTL?: number;
583
583
  /**
584
584
  * cname加速启用状态
585
585
  */
586
- CnameSpeedup: string;
586
+ CnameSpeedup?: string;
587
587
  /**
588
588
  * 域名备注
589
589
  注意:此字段可能返回 null,表示取不到有效值。
590
590
  */
591
- Remark: string;
591
+ Remark?: string;
592
592
  /**
593
593
  * 域名Punycode
594
594
  */
595
- Punycode: string;
595
+ Punycode?: string;
596
596
  /**
597
597
  * 域名DNS状态
598
598
  */
599
- DnsStatus: string;
599
+ DnsStatus?: string;
600
600
  /**
601
601
  * 域名的NS列表
602
602
  */
603
- DnspodNsList: Array<string>;
603
+ DnspodNsList?: Array<string>;
604
604
  /**
605
605
  * 域名
606
606
  */
607
- Domain: string;
607
+ Domain?: string;
608
608
  /**
609
609
  * 域名等级代号
610
610
  */
611
- GradeLevel: number;
611
+ GradeLevel?: number;
612
612
  /**
613
613
  * 域名所属的用户ID
614
614
  */
615
- UserId: number;
615
+ UserId?: number;
616
616
  /**
617
617
  * 是否为付费域名
618
618
  */
619
- IsVip: string;
619
+ IsVip?: string;
620
620
  /**
621
621
  * 域名所有者的账号
622
622
  */
623
- Owner: string;
623
+ Owner?: string;
624
624
  /**
625
625
  * 域名等级的描述
626
626
  */
627
- GradeTitle: string;
627
+ GradeTitle?: string;
628
628
  /**
629
629
  * 域名创建时间
630
630
  */
631
- CreatedOn: string;
631
+ CreatedOn?: string;
632
632
  /**
633
633
  * 最后操作时间
634
634
  */
635
- UpdatedOn: string;
635
+ UpdatedOn?: string;
636
636
  /**
637
637
  * 腾讯云账户Uin
638
638
  */
639
- Uin: string;
639
+ Uin?: string;
640
640
  /**
641
641
  * 域名实际使用的NS列表
642
642
  注意:此字段可能返回 null,表示取不到有效值。
643
643
  */
644
- ActualNsList: Array<string>;
644
+ ActualNsList?: Array<string>;
645
645
  /**
646
646
  * 域名的记录数量
647
647
  */
648
- RecordCount: number;
648
+ RecordCount?: number;
649
649
  /**
650
650
  * 域名所有者的账户昵称
651
651
  注意:此字段可能返回 null,表示取不到有效值。
652
652
  */
653
- OwnerNick: string;
653
+ OwnerNick?: string;
654
654
  /**
655
655
  * 是否在付费套餐宽限期
656
656
  注意:此字段可能返回 null,表示取不到有效值。
@@ -691,6 +691,10 @@ export interface DomainInfo {
691
691
  注意:此字段可能返回 null,表示取不到有效值。
692
692
  */
693
693
  TagList?: Array<TagItem>;
694
+ /**
695
+ * 是否启用搜索引擎推送
696
+ */
697
+ SearchEnginePush?: string;
694
698
  }
695
699
  /**
696
700
  * CreateDomainBatch请求参数结构体
@@ -3832,52 +3836,52 @@ export interface WhoisInfo {
3832
3836
  * 联系信息
3833
3837
  注意:此字段可能返回 null,表示取不到有效值。
3834
3838
  */
3835
- Contacts: WhoisContact;
3839
+ Contacts?: WhoisContact;
3836
3840
  /**
3837
3841
  * 域名注册时间
3838
3842
  注意:此字段可能返回 null,表示取不到有效值。
3839
3843
  */
3840
- CreationDate: string;
3844
+ CreationDate?: string;
3841
3845
  /**
3842
3846
  * 域名到期时间
3843
3847
  注意:此字段可能返回 null,表示取不到有效值。
3844
3848
  */
3845
- ExpirationDate: string;
3849
+ ExpirationDate?: string;
3846
3850
  /**
3847
3851
  * 是否是在腾讯云注册的域名
3848
3852
  注意:此字段可能返回 null,表示取不到有效值。
3849
3853
  */
3850
- IsQcloud: boolean;
3854
+ IsQcloud?: boolean;
3851
3855
  /**
3852
- * 是否当前操作帐号注册的域名
3856
+ * 是否当前操作账号注册的域名
3853
3857
  注意:此字段可能返回 null,表示取不到有效值。
3854
3858
  */
3855
- IsQcloudOwner: boolean;
3859
+ IsQcloudOwner?: boolean;
3856
3860
  /**
3857
3861
  * 域名配置的NS
3858
3862
  注意:此字段可能返回 null,表示取不到有效值。
3859
3863
  */
3860
- NameServers: Array<string>;
3864
+ NameServers?: Array<string>;
3861
3865
  /**
3862
3866
  * Whois原始信息
3863
3867
  注意:此字段可能返回 null,表示取不到有效值。
3864
3868
  */
3865
- Raw: Array<string>;
3869
+ Raw?: Array<string>;
3866
3870
  /**
3867
3871
  * 域名注册商
3868
3872
  注意:此字段可能返回 null,表示取不到有效值。
3869
3873
  */
3870
- Registrar: Array<string>;
3874
+ Registrar?: Array<string>;
3871
3875
  /**
3872
3876
  * 状态
3873
3877
  注意:此字段可能返回 null,表示取不到有效值。
3874
3878
  */
3875
- Status: Array<string>;
3879
+ Status?: Array<string>;
3876
3880
  /**
3877
3881
  * 更新日期
3878
3882
  注意:此字段可能返回 null,表示取不到有效值。
3879
3883
  */
3880
- UpdatedDate: string;
3884
+ UpdatedDate?: string;
3881
3885
  }
3882
3886
  /**
3883
3887
  * DownloadSnapshot返回参数结构体
@@ -3957,6 +3957,10 @@ export interface CreateSubnetRequest {
3957
3957
  * 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}]
3958
3958
  */
3959
3959
  Tags?: Array<Tag>;
3960
+ /**
3961
+ * IPv6 CIDR
3962
+ */
3963
+ IPv6CidrBlock?: string;
3960
3964
  }
3961
3965
  /**
3962
3966
  * HAVIP对象。
@@ -6294,7 +6298,7 @@ export interface ZoneInstanceCountISP {
6294
6298
  CTCC:中国电信
6295
6299
  CUCC:中国联通
6296
6300
  CMCC:中国移动
6297
- 多个运营商用英文分号连接";",例如:"CMCC;CUCC;CTCC"。多运营商需要开通白名单,请直接联系腾讯云客服。
6301
+ CMCC;CUCC;CTCC:三网;三网需要开通白名单,请直接联系腾讯云客服。
6298
6302
  */
6299
6303
  ISP: string;
6300
6304
  /**
@@ -6314,7 +6318,8 @@ export interface ZoneInstanceCountISP {
6314
6318
  */
6315
6319
  Ipv6AddressCount?: number;
6316
6320
  /**
6317
- * 指定创建三网ipv6地址,使用的subnet数组,单独ipv4和单网ipv6子网依然使用SubnetId字段
6321
+ * 指定创建三网ipv6地址,使用的subnet数组,只创建ipv4不创建ipv6和单网ipv6子网依然使用SubnetId字段;
6322
+ 该数组必须且仅支持传入三个不同的子网,并且这三个子网各自分配了电信、联通、移动三个运营商的其中一个IPV6 CIDR网段
6318
6323
  */
6319
6324
  Ipv6SubnetIds?: Array<string>;
6320
6325
  }
@@ -13,15 +13,16 @@ export declare class Client extends AbstractClient {
13
13
  */
14
14
  DescribeFlowInfo(req: DescribeFlowInfoRequest, cb?: (error: string, rep: DescribeFlowInfoResponse) => void): Promise<DescribeFlowInfoResponse>;
15
15
  /**
16
- * 新增/删除应用callbackinfo
17
- callbackinfo包含: 回调地址和签名key
18
- 操作:新增/删除
16
+ * 新增/删除企业应用集成中的回调配置。
17
+ 新增回调配置只会增加不存在的CallbackUrl;删除操作将针对找到的相同CallbackUrl的配置进行删除。
18
+ 请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
19
+ 更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)
19
20
  */
20
21
  ModifyApplicationCallbackInfo(req: ModifyApplicationCallbackInfoRequest, cb?: (error: string, rep: ModifyApplicationCallbackInfoResponse) => void): Promise<ModifyApplicationCallbackInfoResponse>;
21
22
  /**
22
- * 此接口用于发起流程
23
- 适用场景:见创建签署流程接口。
24
- 注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
23
+ * 此接口用于启动流程。它是模板发起合同的最后一步。
24
+ 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于激活包含完整合同信息(模板及内容信息)的流程。
25
+ 流程激活后,将生成一份待签署的电子合同。
25
26
  */
26
27
  StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
27
28
  /**
@@ -144,7 +145,8 @@ callbackinfo包含: 回调地址和签名key
144
145
  CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
145
146
  /**
146
147
  * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
147
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
148
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
149
+ 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
148
150
 
149
151
  **本接口适用于发起方没有填写控件的 B2C或者单C模板**
150
152
 
@@ -185,7 +187,12 @@ callbackinfo包含: 回调地址和签名key
185
187
  */
186
188
  CreateFlowGroupByTemplates(req: CreateFlowGroupByTemplatesRequest, cb?: (error: string, rep: CreateFlowGroupByTemplatesResponse) => void): Promise<CreateFlowGroupByTemplatesResponse>;
187
189
  /**
188
- * 查询企业扩展服务授权信息,目前支持查询:企业静默签,企业与港澳台居民签署合同,使用手机号验证签署方身份,骑缝章,批量签署能力是否已经开通
190
+ * 查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
191
+ 1. 企业静默签
192
+ 2. 企业与港澳台居民签署合同
193
+ 3. 使用手机号验证签署方身份
194
+ 4. 骑缝章
195
+ 5. 批量签署能力
189
196
  */
190
197
  DescribeExtendedServiceAuthInfos(req: DescribeExtendedServiceAuthInfosRequest, cb?: (error: string, rep: DescribeExtendedServiceAuthInfosResponse) => void): Promise<DescribeExtendedServiceAuthInfosResponse>;
191
198
  /**
@@ -335,17 +342,22 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
335
342
  */
336
343
  DeleteIntegrationEmployees(req: DeleteIntegrationEmployeesRequest, cb?: (error: string, rep: DeleteIntegrationEmployeesResponse) => void): Promise<DeleteIntegrationEmployeesResponse>;
337
344
  /**
338
- * 获取小程序签署链接
345
+ * 获取跳转至腾讯电子签小程序的签署链接
339
346
 
340
347
  适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
341
348
 
342
- 注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
343
-
349
+ 跳转到小程序的实现,参考微信官方文档(分为<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>
344
350
 
345
- 跳转到小程序的实现,参考官方文档(分为<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>两种方式)
351
+ 注:
352
+ `1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署`
353
+ `2. 签署链接的有效期为90天,超过有效期链接不可用`
346
354
 
355
+ 其中小程序的原始Id如下,或者查看小程序信息自助获取。
347
356
 
348
- 如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
357
+ | 小程序 | AppID | 原始ID |
358
+ | ------------ | ------------ | ------------ |
359
+ | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
360
+ | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
349
361
  */
350
362
  CreateSchemeUrl(req: CreateSchemeUrlRequest, cb?: (error: string, rep: CreateSchemeUrlResponse) => void): Promise<CreateSchemeUrlResponse>;
351
363
  /**
@@ -35,17 +35,18 @@ class Client extends abstract_client_1.AbstractClient {
35
35
  return this.request("DescribeFlowInfo", req, cb);
36
36
  }
37
37
  /**
38
- * 新增/删除应用callbackinfo
39
- callbackinfo包含: 回调地址和签名key
40
- 操作:新增/删除
38
+ * 新增/删除企业应用集成中的回调配置。
39
+ 新增回调配置只会增加不存在的CallbackUrl;删除操作将针对找到的相同CallbackUrl的配置进行删除。
40
+ 请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
41
+ 更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)
41
42
  */
42
43
  async ModifyApplicationCallbackInfo(req, cb) {
43
44
  return this.request("ModifyApplicationCallbackInfo", req, cb);
44
45
  }
45
46
  /**
46
- * 此接口用于发起流程
47
- 适用场景:见创建签署流程接口。
48
- 注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
47
+ * 此接口用于启动流程。它是模板发起合同的最后一步。
48
+ 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于激活包含完整合同信息(模板及内容信息)的流程。
49
+ 流程激活后,将生成一份待签署的电子合同。
49
50
  */
50
51
  async StartFlow(req, cb) {
51
52
  return this.request("StartFlow", req, cb);
@@ -210,7 +211,8 @@ callbackinfo包含: 回调地址和签名key
210
211
  }
211
212
  /**
212
213
  * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
213
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
214
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
215
+ 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
214
216
 
215
217
  **本接口适用于发起方没有填写控件的 B2C或者单C模板**
216
218
 
@@ -263,7 +265,12 @@ callbackinfo包含: 回调地址和签名key
263
265
  return this.request("CreateFlowGroupByTemplates", req, cb);
264
266
  }
265
267
  /**
266
- * 查询企业扩展服务授权信息,目前支持查询:企业静默签,企业与港澳台居民签署合同,使用手机号验证签署方身份,骑缝章,批量签署能力是否已经开通
268
+ * 查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
269
+ 1. 企业静默签
270
+ 2. 企业与港澳台居民签署合同
271
+ 3. 使用手机号验证签署方身份
272
+ 4. 骑缝章
273
+ 5. 批量签署能力
267
274
  */
268
275
  async DescribeExtendedServiceAuthInfos(req, cb) {
269
276
  return this.request("DescribeExtendedServiceAuthInfos", req, cb);
@@ -465,17 +472,22 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
465
472
  return this.request("DeleteIntegrationEmployees", req, cb);
466
473
  }
467
474
  /**
468
- * 获取小程序签署链接
475
+ * 获取跳转至腾讯电子签小程序的签署链接
469
476
 
470
477
  适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
471
478
 
472
- 注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
473
-
479
+ 跳转到小程序的实现,参考微信官方文档(分为<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>
474
480
 
475
- 跳转到小程序的实现,参考官方文档(分为<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>两种方式)
481
+ 注:
482
+ `1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署`
483
+ `2. 签署链接的有效期为90天,超过有效期链接不可用`
476
484
 
485
+ 其中小程序的原始Id如下,或者查看小程序信息自助获取。
477
486
 
478
- 如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
487
+ | 小程序 | AppID | 原始ID |
488
+ | ------------ | ------------ | ------------ |
489
+ | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
490
+ | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
479
491
  */
480
492
  async CreateSchemeUrl(req, cb) {
481
493
  return this.request("CreateSchemeUrl", req, cb);