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
@@ -1 +1 @@
1
- export const sdkVersion = "4.1.304";
1
+ export const sdkVersion = "4.1.305";
@@ -15,6 +15,9 @@ export class Client extends AbstractClient {
15
15
  async ModifyApmService(req, cb) {
16
16
  return this.request("ModifyApmService", req, cb);
17
17
  }
18
+ async DescribeRelatedServicesOnTrace(req, cb) {
19
+ return this.request("DescribeRelatedServicesOnTrace", req, cb);
20
+ }
18
21
  async DescribeGeneralOTSpanList(req, cb) {
19
22
  return this.request("DescribeGeneralOTSpanList", req, cb);
20
23
  }
@@ -6,9 +6,15 @@ export class Client extends AbstractClient {
6
6
  async CreateCloudModeration(req, cb) {
7
7
  return this.request("CreateCloudModeration", req, cb);
8
8
  }
9
+ async DescribeTRTCRealTimeQualityData(req, cb) {
10
+ return this.request("DescribeTRTCRealTimeQualityData", req, cb);
11
+ }
9
12
  async StopWebRecord(req, cb) {
10
13
  return this.request("StopWebRecord", req, cb);
11
14
  }
15
+ async UpdateVoicePrint(req, cb) {
16
+ return this.request("UpdateVoicePrint", req, cb);
17
+ }
12
18
  async UpdateAIConversation(req, cb) {
13
19
  return this.request("UpdateAIConversation", req, cb);
14
20
  }
@@ -24,8 +30,8 @@ export class Client extends AbstractClient {
24
30
  async DescribeWebRecord(req, cb) {
25
31
  return this.request("DescribeWebRecord", req, cb);
26
32
  }
27
- async StartPublishCdnStream(req, cb) {
28
- return this.request("StartPublishCdnStream", req, cb);
33
+ async DownloadRecognizeVocabV3(req, cb) {
34
+ return this.request("DownloadRecognizeVocabV3", req, cb);
29
35
  }
30
36
  async DescribeCallDetailInfo(req, cb) {
31
37
  return this.request("DescribeCallDetailInfo", req, cb);
@@ -42,11 +48,17 @@ export class Client extends AbstractClient {
42
48
  async StopMCUMixTranscodeByStrRoomId(req, cb) {
43
49
  return this.request("StopMCUMixTranscodeByStrRoomId", req, cb);
44
50
  }
51
+ async UpdateRecognizeVocabV3(req, cb) {
52
+ return this.request("UpdateRecognizeVocabV3", req, cb);
53
+ }
54
+ async SetVocabStateV3(req, cb) {
55
+ return this.request("SetVocabStateV3", req, cb);
56
+ }
45
57
  async DescribeTRTCRealTimeScaleData(req, cb) {
46
58
  return this.request("DescribeTRTCRealTimeScaleData", req, cb);
47
59
  }
48
- async DeleteVoicePrint(req, cb) {
49
- return this.request("DeleteVoicePrint", req, cb);
60
+ async DescribeAIConversation(req, cb) {
61
+ return this.request("DescribeAIConversation", req, cb);
50
62
  }
51
63
  async StartMCUMixTranscodeByStrRoomId(req, cb) {
52
64
  return this.request("StartMCUMixTranscodeByStrRoomId", req, cb);
@@ -63,6 +75,9 @@ export class Client extends AbstractClient {
63
75
  async RemoveUserByStrRoomId(req, cb) {
64
76
  return this.request("RemoveUserByStrRoomId", req, cb);
65
77
  }
78
+ async DeleteRecognizeVocabV3(req, cb) {
79
+ return this.request("DeleteRecognizeVocabV3", req, cb);
80
+ }
66
81
  async DeletePicture(req, cb) {
67
82
  return this.request("DeletePicture", req, cb);
68
83
  }
@@ -75,14 +90,14 @@ export class Client extends AbstractClient {
75
90
  async DescribeTRTCSegmentModerationUsage(req, cb) {
76
91
  return this.request("DescribeTRTCSegmentModerationUsage", req, cb);
77
92
  }
78
- async UpdateVoicePrint(req, cb) {
79
- return this.request("UpdateVoicePrint", req, cb);
93
+ async CreateRecognizeVocabV3(req, cb) {
94
+ return this.request("CreateRecognizeVocabV3", req, cb);
80
95
  }
81
96
  async RemoveUser(req, cb) {
82
97
  return this.request("RemoveUser", req, cb);
83
98
  }
84
- async StopMCUMixTranscode(req, cb) {
85
- return this.request("StopMCUMixTranscode", req, cb);
99
+ async StartPublishCdnStream(req, cb) {
100
+ return this.request("StartPublishCdnStream", req, cb);
86
101
  }
87
102
  async DescribeLiveStreamModeration(req, cb) {
88
103
  return this.request("DescribeLiveStreamModeration", req, cb);
@@ -195,8 +210,8 @@ export class Client extends AbstractClient {
195
210
  async UpdatePublishCdnStream(req, cb) {
196
211
  return this.request("UpdatePublishCdnStream", req, cb);
197
212
  }
198
- async DescribeTRTCRealTimeQualityData(req, cb) {
199
- return this.request("DescribeTRTCRealTimeQualityData", req, cb);
213
+ async DeleteVoicePrint(req, cb) {
214
+ return this.request("DeleteVoicePrint", req, cb);
200
215
  }
201
216
  async CreateCloudSliceTask(req, cb) {
202
217
  return this.request("CreateCloudSliceTask", req, cb);
@@ -213,8 +228,8 @@ export class Client extends AbstractClient {
213
228
  async DescribeCloudModeration(req, cb) {
214
229
  return this.request("DescribeCloudModeration", req, cb);
215
230
  }
216
- async DescribeAIConversation(req, cb) {
217
- return this.request("DescribeAIConversation", req, cb);
231
+ async GetRecognizeVocabListV3(req, cb) {
232
+ return this.request("GetRecognizeVocabListV3", req, cb);
218
233
  }
219
234
  async DescribeTRTCMarketQualityData(req, cb) {
220
235
  return this.request("DescribeTRTCMarketQualityData", req, cb);
@@ -237,4 +252,10 @@ export class Client extends AbstractClient {
237
252
  async TextToSpeechSSE(req, cb) {
238
253
  return this.request("TextToSpeechSSE", req, cb);
239
254
  }
255
+ async StopMCUMixTranscode(req, cb) {
256
+ return this.request("StopMCUMixTranscode", req, cb);
257
+ }
258
+ async GetRecognizeVocabV3(req, cb) {
259
+ return this.request("GetRecognizeVocabV3", req, cb);
260
+ }
240
261
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs",
3
- "version": "4.1.304",
3
+ "version": "4.1.305",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.1.304";
1
+ export declare const sdkVersion = "4.1.305";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sdkVersion = void 0;
4
- exports.sdkVersion = "4.1.304";
4
+ exports.sdkVersion = "4.1.305";
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { DescribeApmAssociationResponse, CreateApmInstanceRequest, DescribeApmVulnerabilityCountResponse, DescribeServiceOverviewResponse, DescribeApmSQLInjectionDetailResponse, DescribeApmSampleConfigRequest, DescribeApmAllVulCountResponse, DescribeApmSampleConfigResponse, DescribeServiceOverviewRequest, DescribeTopologyNewResponse, DescribeOPRAllVulCountResponse, ModifyApmApplicationConfigResponse, DescribeApmServiceMetricResponse, ModifyApmAssociationRequest, DescribeGeneralOTSpanListResponse, DescribeApmApplicationConfigResponse, DescribeApmAssociationRequest, CreateProfileTaskRequest, DescribeApmVulnerabilityDetailRequest, DeleteApmSampleConfigResponse, DescribeApmPrometheusRuleRequest, CreateApmPrometheusRuleResponse, TerminateApmInstanceResponse, DescribeApmAgentResponse, CreateApmSampleConfigRequest, DescribeTagValuesRequest, CreateApmSampleConfigResponse, ModifyApmAssociationResponse, DescribeGeneralSpanListRequest, DescribeApmAgentRequest, DescribeMetricRecordsRequest, DescribeGeneralMetricDataRequest, ModifyApmPrometheusRuleRequest, ModifyApmInstanceResponse, DescribeGeneralMetricDataResponse, ModifyApmInstanceRequest, DescribeApmInstancesResponse, DescribeApmPrometheusRuleResponse, ModifyApmSampleConfigResponse, DescribeApmApplicationConfigRequest, CreateProfileTaskResponse, DescribeApmVulnerabilityDetailResponse, ModifyApmPrometheusRuleResponse, DescribeMetricRecordsResponse, DescribeApmSQLInjectionDetailRequest, DescribeGeneralOTSpanListRequest, DescribeGeneralApmApplicationConfigResponse, CreateApmInstanceResponse, DescribeGeneralApmApplicationConfigRequest, DescribeTopologyNewRequest, DescribeApmInstancesRequest, DeleteApmSampleConfigRequest, DescribeApmVulnerabilityCountRequest, ModifyApmSampleConfigRequest, TerminateApmInstanceRequest, ModifyGeneralApmApplicationConfigRequest, DescribeApmServiceMetricRequest, CreateApmPrometheusRuleRequest, DescribeApmAllVulCountRequest, DescribeTagValuesResponse, DescribeGeneralSpanListResponse, ModifyApmServiceResponse, ModifyApmApplicationConfigRequest, ModifyGeneralApmApplicationConfigResponse, ModifyApmServiceRequest, DescribeOPRAllVulCountRequest } from "./apm_models";
3
+ import { DescribeApmAssociationResponse, CreateApmInstanceRequest, DescribeApmVulnerabilityCountResponse, DescribeServiceOverviewResponse, DescribeApmSQLInjectionDetailResponse, DescribeRelatedServicesOnTraceResponse, DescribeApmAllVulCountResponse, DescribeApmSampleConfigResponse, DescribeServiceOverviewRequest, DescribeTopologyNewResponse, DescribeOPRAllVulCountResponse, ModifyApmApplicationConfigResponse, DescribeApmServiceMetricResponse, ModifyApmAssociationRequest, DescribeGeneralOTSpanListResponse, DescribeApmApplicationConfigResponse, DescribeApmAssociationRequest, CreateProfileTaskRequest, DescribeApmVulnerabilityDetailRequest, DeleteApmSampleConfigResponse, DescribeApmPrometheusRuleRequest, CreateApmPrometheusRuleResponse, TerminateApmInstanceResponse, DescribeApmAgentResponse, CreateApmSampleConfigRequest, DescribeApmSampleConfigRequest, CreateApmSampleConfigResponse, ModifyApmAssociationResponse, DescribeGeneralSpanListRequest, DescribeApmAgentRequest, DescribeMetricRecordsRequest, DescribeGeneralMetricDataRequest, ModifyApmPrometheusRuleRequest, ModifyApmInstanceResponse, DescribeGeneralMetricDataResponse, ModifyApmInstanceRequest, DescribeApmInstancesResponse, DescribeApmPrometheusRuleResponse, ModifyApmSampleConfigResponse, DescribeApmApplicationConfigRequest, CreateProfileTaskResponse, DescribeApmVulnerabilityDetailResponse, ModifyApmPrometheusRuleResponse, DescribeMetricRecordsResponse, DescribeRelatedServicesOnTraceRequest, DescribeGeneralOTSpanListRequest, DescribeGeneralApmApplicationConfigResponse, CreateApmInstanceResponse, DescribeGeneralApmApplicationConfigRequest, DescribeTopologyNewRequest, DescribeApmInstancesRequest, DeleteApmSampleConfigRequest, DescribeApmVulnerabilityCountRequest, ModifyApmSampleConfigRequest, TerminateApmInstanceRequest, ModifyGeneralApmApplicationConfigRequest, DescribeApmServiceMetricRequest, CreateApmPrometheusRuleRequest, DescribeApmAllVulCountRequest, DescribeTagValuesResponse, DescribeGeneralSpanListResponse, DescribeApmSQLInjectionDetailRequest, ModifyApmServiceResponse, ModifyApmApplicationConfigRequest, ModifyGeneralApmApplicationConfigResponse, DescribeTagValuesRequest, ModifyApmServiceRequest, DescribeOPRAllVulCountRequest } from "./apm_models";
4
4
  /**
5
5
  * apm client
6
6
  * @class
@@ -23,6 +23,10 @@ export declare class Client extends AbstractClient {
23
23
  * 修改apm应用信息
24
24
  */
25
25
  ModifyApmService(req: ModifyApmServiceRequest, cb?: (error: string, rep: ModifyApmServiceResponse) => void): Promise<ModifyApmServiceResponse>;
26
+ /**
27
+ * 根据链路查询目标服务的上下游相关服务
28
+ */
29
+ DescribeRelatedServicesOnTrace(req: DescribeRelatedServicesOnTraceRequest, cb?: (error: string, rep: DescribeRelatedServicesOnTraceResponse) => void): Promise<DescribeRelatedServicesOnTraceResponse>;
26
30
  /**
27
31
  * 通用查询 OpenTelemetry 调用链列表
28
32
  */
@@ -51,6 +51,12 @@ class Client extends abstract_client_1.AbstractClient {
51
51
  async ModifyApmService(req, cb) {
52
52
  return this.request("ModifyApmService", req, cb);
53
53
  }
54
+ /**
55
+ * 根据链路查询目标服务的上下游相关服务
56
+ */
57
+ async DescribeRelatedServicesOnTrace(req, cb) {
58
+ return this.request("DescribeRelatedServicesOnTrace", req, cb);
59
+ }
54
60
  /**
55
61
  * 通用查询 OpenTelemetry 调用链列表
56
62
  */
@@ -179,17 +179,30 @@ export interface SelectorView {
179
179
  Component?: ComponentTopologyView;
180
180
  }
181
181
  /**
182
- * DescribeApmSampleConfig请求参数结构体
182
+ * DescribeRelatedServicesOnTrace返回参数结构体
183
183
  */
184
- export interface DescribeApmSampleConfigRequest {
184
+ export interface DescribeRelatedServicesOnTraceResponse {
185
185
  /**
186
- * 业务系统ID
186
+ * 查询的总链路数
187
187
  */
188
- InstanceId: string;
188
+ TotalTraces?: number;
189
189
  /**
190
- * 采样规则名
190
+ * 查询到的应用的数量
191
191
  */
192
- SampleName?: string;
192
+ TotalServices?: number;
193
+ /**
194
+ * 挑选的链路数量
195
+ */
196
+ SelectedTraces?: number;
197
+ /**
198
+ * 相关的服务/应用名列表
199
+ 注意:此字段可能返回 null,表示取不到有效值。
200
+ */
201
+ ServiceRelations?: Array<ServiceRelation>;
202
+ /**
203
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
204
+ */
205
+ RequestId?: string;
193
206
  }
194
207
  /**
195
208
  * DescribeApmAllVulCount返回参数结构体
@@ -874,37 +887,17 @@ export interface CreateApmSampleConfigRequest {
874
887
  OperationType?: number;
875
888
  }
876
889
  /**
877
- * DescribeTagValues请求参数结构体
890
+ * DescribeApmSampleConfig请求参数结构体
878
891
  */
879
- export interface DescribeTagValuesRequest {
892
+ export interface DescribeApmSampleConfigRequest {
880
893
  /**
881
- * 业务系统 ID
894
+ * 业务系统ID
882
895
  */
883
896
  InstanceId: string;
884
897
  /**
885
- * 维度名
886
- */
887
- TagKey: string;
888
- /**
889
- * 开始时间(单位为秒)
890
- */
891
- StartTime: number;
892
- /**
893
- * 结束时间(单位为秒)
894
- */
895
- EndTime: number;
896
- /**
897
- * 过滤条件
898
- */
899
- Filters?: Array<Filter>;
900
- /**
901
- * Or 过滤条件
902
- */
903
- OrFilters?: Array<Filter>;
904
- /**
905
- * 使用类型
898
+ * 采样规则名
906
899
  */
907
- Type?: string;
900
+ SampleName?: string;
908
901
  }
909
902
  /**
910
903
  * apm应用指标信息
@@ -1906,6 +1899,23 @@ export interface DescribeApmPrometheusRuleResponse {
1906
1899
  */
1907
1900
  RequestId?: string;
1908
1901
  }
1902
+ /**
1903
+ * 应用对应的链路上下游应用集合
1904
+ */
1905
+ export interface ServiceRelation {
1906
+ /**
1907
+ * 应用名
1908
+ */
1909
+ ServiceName?: string;
1910
+ /**
1911
+ * 上游应用集合
1912
+ */
1913
+ UpstreamServices?: Array<string>;
1914
+ /**
1915
+ * 下游应用集合
1916
+ */
1917
+ DownstreamServices?: Array<string>;
1918
+ }
1909
1919
  /**
1910
1920
  * ModifyApmSampleConfig返回参数结构体
1911
1921
  */
@@ -1998,45 +2008,29 @@ export interface ApmTag {
1998
2008
  Value: string;
1999
2009
  }
2000
2010
  /**
2001
- * DescribeApmSQLInjectionDetail请求参数结构体
2011
+ * DescribeRelatedServicesOnTrace请求参数结构体
2002
2012
  */
2003
- export interface DescribeApmSQLInjectionDetailRequest {
2013
+ export interface DescribeRelatedServicesOnTraceRequest {
2004
2014
  /**
2005
2015
  * 业务系统 ID
2006
2016
  */
2007
2017
  InstanceId: string;
2008
2018
  /**
2009
- * 限制
2010
- */
2011
- Limit?: number;
2012
- /**
2013
- * 偏移量
2014
- */
2015
- Offset?: number;
2016
- /**
2017
- * 秒级时间戳
2018
- */
2019
- StartTime?: number;
2020
- /**
2021
- * 秒级时间戳
2022
- */
2023
- EndTime?: number;
2024
- /**
2025
- * 排序
2019
+ * 查询开始时间
2026
2020
  */
2027
- OrderBy?: OrderBy;
2021
+ StartTime: number;
2028
2022
  /**
2029
- * 查询过滤条件
2023
+ * 查询结束时间
2030
2024
  */
2031
- Filters?: Array<Filter>;
2025
+ EndTime: number;
2032
2026
  /**
2033
- * 聚合维度
2027
+ * 应用名
2034
2028
  */
2035
- GroupBy?: Array<string>;
2029
+ ServiceName?: string;
2036
2030
  /**
2037
- * 指标列表
2031
+ * 是否为应用拓扑查询
2038
2032
  */
2039
- Metrics?: Array<QueryMetricItem>;
2033
+ IsServiceTopology?: boolean;
2040
2034
  }
2041
2035
  /**
2042
2036
  * 查询过滤参数
@@ -3246,6 +3240,47 @@ export interface Resource {
3246
3240
  */
3247
3241
  CVMMeta?: Array<CVMMeta>;
3248
3242
  }
3243
+ /**
3244
+ * DescribeApmSQLInjectionDetail请求参数结构体
3245
+ */
3246
+ export interface DescribeApmSQLInjectionDetailRequest {
3247
+ /**
3248
+ * 业务系统 ID
3249
+ */
3250
+ InstanceId: string;
3251
+ /**
3252
+ * 限制
3253
+ */
3254
+ Limit?: number;
3255
+ /**
3256
+ * 偏移量
3257
+ */
3258
+ Offset?: number;
3259
+ /**
3260
+ * 秒级时间戳
3261
+ */
3262
+ StartTime?: number;
3263
+ /**
3264
+ * 秒级时间戳
3265
+ */
3266
+ EndTime?: number;
3267
+ /**
3268
+ * 排序
3269
+ */
3270
+ OrderBy?: OrderBy;
3271
+ /**
3272
+ * 查询过滤条件
3273
+ */
3274
+ Filters?: Array<Filter>;
3275
+ /**
3276
+ * 聚合维度
3277
+ */
3278
+ GroupBy?: Array<string>;
3279
+ /**
3280
+ * 指标列表
3281
+ */
3282
+ Metrics?: Array<QueryMetricItem>;
3283
+ }
3249
3284
  /**
3250
3285
  * 视图方案勾选情况
3251
3286
  */
@@ -3539,6 +3574,39 @@ export interface ModifyGeneralApmApplicationConfigResponse {
3539
3574
  */
3540
3575
  RequestId?: string;
3541
3576
  }
3577
+ /**
3578
+ * DescribeTagValues请求参数结构体
3579
+ */
3580
+ export interface DescribeTagValuesRequest {
3581
+ /**
3582
+ * 业务系统 ID
3583
+ */
3584
+ InstanceId: string;
3585
+ /**
3586
+ * 维度名
3587
+ */
3588
+ TagKey: string;
3589
+ /**
3590
+ * 开始时间(单位为秒)
3591
+ */
3592
+ StartTime: number;
3593
+ /**
3594
+ * 结束时间(单位为秒)
3595
+ */
3596
+ EndTime: number;
3597
+ /**
3598
+ * 过滤条件
3599
+ */
3600
+ Filters?: Array<Filter>;
3601
+ /**
3602
+ * Or 过滤条件
3603
+ */
3604
+ OrFilters?: Array<Filter>;
3605
+ /**
3606
+ * 使用类型
3607
+ */
3608
+ Type?: string;
3609
+ }
3542
3610
  /**
3543
3611
  * CVM元数据
3544
3612
  */
@@ -1423,7 +1423,7 @@ export interface SetUserQuotaRequest {
1423
1423
  */
1424
1424
  CapacityHardLimit?: number;
1425
1425
  /**
1426
- * <p>文件硬限制,单位个。设置范围1000-100000000</p>
1426
+ * <p>文件硬限制</p><p>取值范围:[1000, 1000000000]</p><p>单位:个</p><p>默认值:无默认值</p>
1427
1427
  */
1428
1428
  FileHardLimit?: number;
1429
1429
  /**
@@ -21,16 +21,16 @@ export declare class Client extends AbstractClient {
21
21
  DescribeContractReviewTaskListWebUrl(req: DescribeContractReviewTaskListWebUrlRequest, cb?: (error: string, rep: DescribeContractReviewTaskListWebUrlResponse) => void): Promise<DescribeContractReviewTaskListWebUrlResponse>;
22
22
  /**
23
23
  * 此接口用于启动流程。它是模板发起合同的最后一步。
24
- 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于开始整个合同流程, 推进流程进入到签署环节。
25
-
26
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
27
24
 
28
- 注:
29
- 1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度)
25
+ ## 1.1 接口调用流程
26
+ 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于开始整个合同流程, 推进流程进入到签署环节。
30
27
 
31
- 2.<font color="red">静默(自动)签署不支持非本企业合同签署方存在填写</font>功能
28
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
32
29
 
33
- 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>,尤其是当模板中存在动态表格等复杂填写控件时,因为合成过程可能会耗费秒级别的时间。
30
+ ### 1.2 注意事项
31
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同,且<font color="red">有撤销合同额度</font>的情形下,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
32
+ - 只要存在填写控件,填充时会触发 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) 接口发起签署**,以确保文档已合成完毕。,尤其是当模板中存在动态表格等复杂填写控件时,因为合成过程可能会耗费秒级别的时间。
33
+ - 调用 [CreateDocument](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument) 成功后,请<font color="red">在 5 分钟内调用本接口(StartFlow)启动合同</font> ,不要长时间暂存仅调用了 CreateDocument 而未发起的合同;否则会导致该合同长时间后无法再启动,且合同额度不再返还。
34
34
  */
35
35
  StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
36
36
  /**
@@ -170,48 +170,42 @@ export declare class Client extends AbstractClient {
170
170
  */
171
171
  CreateFlowSignReview(req: CreateFlowSignReviewRequest, cb?: (error: string, rep: CreateFlowSignReviewResponse) => void): Promise<CreateFlowSignReviewResponse>;
172
172
  /**
173
- * 创建签署流程电子文档<br />
174
-
175
- ### 调用流程
176
- 该接口需要给对应的流程指定一个模板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>接口使用。具体逻辑可以参考下图:
173
+ * 本接口用于基于**模板**创建合同的电子文档,并填充模板中由发起方补充的信息(归属发起方填写控件)。
177
174
 
178
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
175
+ ### 1.1 调用流程
179
176
 
177
+ 本接口需指定一个模板 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>接口配合使用,完整调用顺序如下:
178
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
180
179
 
181
- ### 填充模板中定义的填写控件
182
- 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充。
180
+ ### 1.2 发起方填写控件
183
181
 
184
- **<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>**
182
+ 模板中配置的<font color="red">发起人填充控件</font>,可通过本接口的 **FormFields 数组**字段填充。
185
183
 
186
184
  ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
187
185
 
188
- 填充的传参示例如下
189
-
190
- ```
191
- request.FormFields = [{
192
- "ComponentName": "项目的名字",
193
- "ComponentValue": "休闲山庄"
194
- }, {
195
- "ComponentName": "项目的地址",
196
- "ComponentValue": "凤凰山北侧",
197
- }, {
198
- "ComponentName": "范围",
199
- "ComponentValue": "凤凰山至107国道",
200
- }, {
201
- "ComponentName": "面积",
202
- "ComponentValue": "100亩",
203
- }, {
204
- "ComponentName": "基本情况",
205
- "ComponentValue": "完好",
206
- }, , {
207
- "ComponentName": "用途",
208
- "ComponentValue": "经营农家乐",
209
- }
210
- ]
186
+ 填充的传参示例如下(以 ComponentName 匹配模板中的控件名):
187
+
188
+ ```json
189
+ [
190
+ { "ComponentName": "项目的名字", "ComponentValue": "休闲山庄" },
191
+ { "ComponentName": "项目的地址", "ComponentValue": "凤凰山北侧" },
192
+ { "ComponentName": "范围", "ComponentValue": "凤凰山至107国道" },
193
+ { "ComponentName": "面积", "ComponentValue": "100亩" },
194
+ { "ComponentName": "基本情况", "ComponentValue": "完好" },
195
+ { "ComponentName": "用途", "ComponentValue": "经营农家乐" }
196
+ ]
211
197
  ```
212
- 合成后合同样子示例
198
+
199
+ 合成后的合同样例:
213
200
 
214
201
  ![image](https://qcloudimg.tencent-cloud.cn/raw/140a2fb771ac66a185d0a000d37485f6.png)
202
+
203
+ ### 1.3 注意事项
204
+
205
+ - 本接口<font color="red">只能填充分配给发起方的填写控件</font>,不能填充分配给签署方的签署控件。
206
+ - <font color="red">若使用预览方式(`NeedPreview=true`),预览确认无误后,需用同样的参数再次调用本接口</font>(`NeedPreview=false`),并使用新调用返回的 `FlowId` 去调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 发起签署。预览模式返回的 `FlowId` 为临时 ID,不能用于发起。
207
+ - 只要存在发起方的填写控件,填充时会触发 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>,以确保文档已合成完毕。
208
+ - 调用本接口(CreateDocument)成功后,请**在 5 分钟内调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 启动合同**,不要长时间暂存仅调用了 CreateDocument 而未发起的合同;否则会导致该合同长时间后无法再启动,且合同额度不再返还。
215
209
  */
216
210
  CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
217
211
  /**
@@ -661,40 +655,26 @@ export declare class Client extends AbstractClient {
661
655
  CreateFlowEvidenceReport(req: CreateFlowEvidenceReportRequest, cb?: (error: string, rep: CreateFlowEvidenceReportResponse) => void): Promise<CreateFlowEvidenceReportResponse>;
662
656
  /**
663
657
  * 通过模板创建签署流程<br/>
664
- 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
665
- <table>
666
- <thead>
667
- <tr>
668
- <th>签署人类别</th>
669
- <th>需要提前准备的信息</th>
670
- </tr>
671
- </thead>
672
- <tbody>
673
- <tr>
674
- <td>自己企业的员工签署(未认证加入或已认证加入)</td>
675
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
676
- </tr>
677
- <tr>
678
- <td>自己企业的员工签署(已认证加入)</td>
679
- <td>签署企业的名字、员工在电子签平台的ID(UserId)</td>
680
- </tr>
681
- <tr>
682
- <td>其他企业的员工签署</td>
683
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
684
- </tr>
685
- <tr>
686
- <td>个人(自然人)签署</td>
687
- <td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>
688
- </tr>
689
- </tbody>
690
- </table>
658
+ 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次使用这个配置好的模板,补充合同内容信息及签署信息生成电子合同。
659
+ ## 1.1 传参方式指引
691
660
 
661
+ | 签署方类型 | ApproverType | 需要提前准备的信息 | 对应 Approvers 关键字段 |
662
+ |------|------|------|------|
663
+ | 本企业员工(未认证加入) | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号(非必传) | OrganizationName + ApproverName + ApproverMobile |
664
+ | 本企业员工(已认证加入) | 0 | 签署企业名、员工在电子签平台的 ID(UserId) | OrganizationName + UserId |
665
+ | 他方企业员工 | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号(非必传) | OrganizationName + ApproverName + ApproverMobile |
666
+ | 个人(自然人) | 1 | 个人真实姓名、个人触达手机号、身份证号(非必传) | ApproverName + ApproverMobile |
692
667
 
693
- 注:配合<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>接口使用。整体的逻辑如下图
668
+ ## 1.2 接口调用流程
669
+ 此接口需<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> 。整体的逻辑如下图
694
670
 
695
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
671
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
696
672
 
697
- 注:**静默(自动)签署不支持合同签署方存在填写**功能
673
+ ## 1.3 注意事项
674
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同,且<font color="red">有撤销合同额度</font>的情形下,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
675
+ - 支持的证件类型可以参考[支持的证件类型](https://qian.tencent.com/developers/company/id_card_support)。
676
+ - 合同发起方需要【组织管理】->【角色管理】中拥有<font color="red">接口发起合同</font>的权限
677
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/c8553d1823ca1323e82c11f01c86e8cd.png)
698
678
  <br>
699
679
 
700
680
  <font color="red">相关视频指引</font> <br>
@@ -865,7 +845,7 @@ export declare class Client extends AbstractClient {
865
845
  该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFileConvertTask)接口转换成pdf资源)<br/>
866
846
 
867
847
  ## 整体流程图
868
- ![image](https://qcloudimg.tencent-cloud.cn/raw/9577ac334c083ecfe0014a187d64b485.svg)
848
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/9bf547fe0bc738f9a97b4b619dea0633.svg)
869
849
 
870
850
  注:
871
851
  - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同,且<font color="red">有撤销合同额度</font>的情形下,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。