tencentcloud-sdk-nodejs-ess 4.0.652 → 4.0.653

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.
package/products.md CHANGED
@@ -41,9 +41,9 @@
41
41
  | cat | [云拨测](https://cloud.tencent.com/document/product/280) | 2023-05-18 01:07:39 |
42
42
  | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2023-07-24 01:12:51 |
43
43
  | ccc | [云呼叫中心](https://cloud.tencent.com/document/product/679) | 2023-07-28 01:10:59 |
44
- | cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2023-07-26 01:07:06 |
44
+ | cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2023-07-31 01:10:35 |
45
45
  | cdc | [本地专用集群](https://cloud.tencent.com/document/product/1346) | 2023-07-28 01:11:59 |
46
- | cdn | [内容分发网络 CDN](https://cloud.tencent.com/document/product/228) | 2023-07-21 01:11:26 |
46
+ | cdn | [内容分发网络 CDN](https://cloud.tencent.com/document/product/228) | 2023-07-31 01:11:31 |
47
47
  | cds | [T-Sec-数据安全审计(DSA)](https://cloud.tencent.com/document/product/856) | 2023-05-18 01:10:41 |
48
48
  | cdwch | [云数据仓库 ClickHouse](https://cloud.tencent.com/document/product/1299) | 2023-07-20 01:14:55 |
49
49
  | cfg | [混沌演练平台](https://cloud.tencent.com/document/product/1500) | 2023-07-25 10:44:01 |
@@ -54,16 +54,16 @@
54
54
  | cii | [智能保险助手](https://cloud.tencent.com/document/product/1368) | 2023-05-18 01:12:07 |
55
55
  | cim | [](https://cloud.tencent.com/document/product) | 2019-05-16 17:21:18 |
56
56
  | cis | [](https://cloud.tencent.com/document/product) | 2018-06-07 15:01:42 |
57
- | ckafka | [消息队列 CKafka](https://cloud.tencent.com/document/product/597) | 2023-07-25 10:45:07 |
58
- | clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2023-07-25 10:45:46 |
57
+ | ckafka | [消息队列 CKafka](https://cloud.tencent.com/document/product/597) | 2023-07-31 01:13:15 |
58
+ | clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2023-07-31 01:13:45 |
59
59
  | cloudaudit | [云审计](https://cloud.tencent.com/document/product/629) | 2023-05-18 01:13:28 |
60
60
  | cloudhsm | [云加密机](https://cloud.tencent.com/document/product/639) | 2023-05-18 01:13:36 |
61
61
  | cloudstudio | [Cloud Studio(云端 IDE)](https://cloud.tencent.com/document/product/1039) | 2023-07-24 01:17:40 |
62
- | cls | [日志服务](https://cloud.tencent.com/document/product/614) | 2023-07-28 01:15:40 |
62
+ | cls | [日志服务](https://cloud.tencent.com/document/product/614) | 2023-07-31 01:14:37 |
63
63
  | cme | [多媒体创作引擎](https://cloud.tencent.com/document/product/1156) | 2023-07-26 01:11:19 |
64
64
  | cmq | [消息队列 CMQ](https://cloud.tencent.com/document/product/406) | 2023-05-18 01:14:51 |
65
65
  | cms | [内容安全](https://cloud.tencent.com/document/product/669) | 2023-07-11 01:11:56 |
66
- | cpdp | [企业收付平台](https://cloud.tencent.com/document/product/1122) | 2023-07-10 01:16:33 |
66
+ | cpdp | [企业收付平台](https://cloud.tencent.com/document/product/1122) | 2023-07-31 01:15:43 |
67
67
  | cr | [金融联络机器人](https://cloud.tencent.com/document/product/656) | 2021-02-24 08:03:24 |
68
68
  | csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2023-07-18 01:21:16 |
69
69
  | csxg | [5G入云服务](https://cloud.tencent.com/document/product/1687) | 2023-05-19 11:26:14 |
@@ -93,8 +93,8 @@
93
93
  | eis | [数据连接器](https://cloud.tencent.com/document/product/1270) | 2023-05-18 01:25:58 |
94
94
  | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2023-07-25 10:56:12 |
95
95
  | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2023-07-12 01:24:00 |
96
- | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-07-28 01:25:58 |
97
- | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-07-26 16:20:45 |
96
+ | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-07-31 01:23:57 |
97
+ | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-07-28 17:50:48 |
98
98
  | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2023-07-27 01:13:31 |
99
99
  | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2023-07-25 10:59:09 |
100
100
  | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2023-07-14 14:55:45 |
@@ -125,7 +125,7 @@
125
125
  | ivld | [媒体智能标签](https://cloud.tencent.com/document/product/1509) | 2023-05-18 01:35:21 |
126
126
  | keewidb | [云数据库 KeeWiDB](https://cloud.tencent.com/document/product/1520) | 2023-07-19 01:29:34 |
127
127
  | kms | [密钥管理系统](https://cloud.tencent.com/document/product/573) | 2023-05-18 01:35:58 |
128
- | lcic | [低代码互动课堂](https://cloud.tencent.com/document/product/1639) | 2023-07-28 01:32:25 |
128
+ | lcic | [低代码互动课堂](https://cloud.tencent.com/document/product/1639) | 2023-07-31 01:30:04 |
129
129
  | lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2023-07-25 11:04:43 |
130
130
  | live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2023-07-28 01:33:15 |
131
131
  | lowcode | [云开发低码](https://cloud.tencent.com/document/product/1301) | 2022-04-04 06:56:51 |
@@ -144,10 +144,10 @@
144
144
  | ms | [移动应用安全](https://cloud.tencent.com/document/product/283) | 2023-07-27 01:16:41 |
145
145
  | msp | [迁移服务平台](https://cloud.tencent.com/document/product/659) | 2023-05-18 01:42:21 |
146
146
  | mvj | [营销价值判断](https://cloud.tencent.com/document/product) | 2020-03-19 08:11:44 |
147
- | nlp | [NLP 服务](https://cloud.tencent.com/document/product/271) | 2023-07-18 01:40:17 |
147
+ | nlp | [NLP 服务](https://cloud.tencent.com/document/product/271) | 2023-07-31 01:34:03 |
148
148
  | npp | [号码保护](https://cloud.tencent.com/document/product) | 2020-04-22 08:00:22 |
149
149
  | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2023-07-17 01:29:44 |
150
- | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2023-07-28 01:40:37 |
150
+ | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2023-07-31 01:34:27 |
151
151
  | omics | [腾讯健康组学平台](https://cloud.tencent.com/document/product/1643) | 2023-07-20 01:37:20 |
152
152
  | organization | [集团账号管理](https://cloud.tencent.com/document/product/850) | 2023-07-27 01:17:15 |
153
153
  | partners | [渠道合作伙伴](https://cloud.tencent.com/document/product/563) | 2023-07-20 18:40:49 |
@@ -197,7 +197,7 @@
197
197
  | tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2023-07-26 01:38:18 |
198
198
  | tds | [设备安全](https://cloud.tencent.com/document/product/1628) | 2023-05-18 01:55:50 |
199
199
  | tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2023-05-22 02:01:01 |
200
- | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2023-07-24 01:50:27 |
200
+ | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2023-07-31 01:43:23 |
201
201
  | thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2023-07-07 01:53:45 |
202
202
  | tia | [智能钛机器学习](https://cloud.tencent.com/document/product/851) | 2021-10-21 11:12:52 |
203
203
  | tic | [资源编排 TIC](https://cloud.tencent.com/document/product/1213) | 2023-05-18 01:58:19 |
@@ -205,7 +205,7 @@
205
205
  | tics | [威胁情报云查服务](https://cloud.tencent.com/document/product/1013) | 2023-05-18 01:58:24 |
206
206
  | tiems | [腾讯云 TI 平台 TI-EMS ](https://cloud.tencent.com/document/product/1120) | 2022-07-19 06:19:39 |
207
207
  | tiia | [图像分析](https://cloud.tencent.com/document/product/865) | 2023-07-10 01:48:50 |
208
- | tione | [TI-ONE 训练平台](https://cloud.tencent.com/document/product/851) | 2023-07-20 01:46:59 |
208
+ | tione | [TI-ONE 训练平台](https://cloud.tencent.com/document/product/851) | 2023-07-28 15:36:37 |
209
209
  | tiw | [互动白板](https://cloud.tencent.com/document/product/1137) | 2023-07-24 01:52:09 |
210
210
  | tke | [容器服务](https://cloud.tencent.com/document/product/457) | 2023-07-21 01:45:01 |
211
211
  | tkgdq | [腾讯知识图谱数据查询](https://cloud.tencent.com/document/product) | 2020-03-10 00:51:44 |
@@ -226,7 +226,7 @@
226
226
  | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2023-07-26 01:43:57 |
227
227
  | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-07-28 01:57:59 |
228
228
  | vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2023-07-18 01:58:58 |
229
- | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-07-28 01:59:57 |
229
+ | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-07-31 01:50:43 |
230
230
  | wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2023-07-18 01:59:28 |
231
231
  | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2023-07-25 11:28:02 |
232
232
  | wss | [SSL证书管理服务](https://cloud.tencent.com/document/product) | 2020-04-01 08:53:44 |
@@ -259,6 +259,7 @@ callbackinfo包含: 回调地址和签名key
259
259
  当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
260
260
 
261
261
  > **适用场景**
262
+ >
262
263
  > 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
263
264
  > 一个模板通常会包含以下结构信息
264
265
  >- 模板基本信息
@@ -622,8 +623,8 @@ callbackinfo包含: 回调地址和签名key
622
623
  }
623
624
 
624
625
  /**
625
- * 通过发起转换任务接口(CreateConvertTaskApi)返回的任务Id查询转换任务状态,通过本接口确认转换任务是否完成。<br/>
626
- 大文件转换所需的时间可能会比较长。
626
+ * 查询转换任务的状态。转换任务Id通过发起转换任务接口(CreateConvertTaskApi)获取。
627
+ 注意:大文件转换所需的时间可能会比较长。
627
628
  */
628
629
  async GetTaskResultApi(
629
630
  req: GetTaskResultApiRequest,
@@ -679,9 +680,9 @@ callbackinfo包含: 回调地址和签名key
679
680
  }
680
681
 
681
682
  /**
682
- * 查询流程摘要
683
+ * 查询流程基础信息
683
684
  适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
684
- 日调用量限制:10W
685
+ 每个企业限制日调用量限制:10W, 当当日超过此限制后再调用接口返回错误
685
686
  */
686
687
  async DescribeFlowBriefs(
687
688
  req: DescribeFlowBriefsRequest,
@@ -562,7 +562,7 @@ ENTERPRISESERVER-企业静默签
562
562
  */
563
563
  ApproverSignComponentType?: string
564
564
  /**
565
- * 签署方自定义控件别名,最大长度20个字符
565
+ * 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方, 依次类推. 如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字符
566
566
  */
567
567
  ApproverSignRole?: string
568
568
  }
@@ -934,14 +934,16 @@ export interface DescribeFlowComponentsResponse {
934
934
  */
935
935
  export interface DescribeFlowEvidenceReportResponse {
936
936
  /**
937
- * 报告 URL
937
+ * 出证报告PDF的下载 URL
938
938
  注意:此字段可能返回 null,表示取不到有效值。
939
939
  */
940
940
  ReportUrl?: string
941
941
  /**
942
- * 执行中:EvidenceStatusExecuting
943
- 成功:EvidenceStatusSuccess
944
- 失败:EvidenceStatusFailed
942
+ * 出证任务执行的状态, 分布表示下面的含义
943
+
944
+ EvidenceStatusExecuting 出证任务在执行中
945
+ EvidenceStatusSuccess 出证任务执行成功
946
+ EvidenceStatusFailed 出征任务执行失败
945
947
  */
946
948
  Status?: string
947
949
  /**
@@ -1280,7 +1282,10 @@ APP:第三方APP或小程序跳转电子签小程序的path。
1280
1282
  */
1281
1283
  PathType?: number
1282
1284
  /**
1283
- * 是否自动回跳 true:是, false:否。该参数只针对"APP" 类型的签署链接有效
1285
+ * 是否自动回跳
1286
+ true:是,
1287
+ false:否。
1288
+ 该参数只针对"APP" 类型的签署链接有效
1284
1289
  */
1285
1290
  AutoJumpBack?: boolean
1286
1291
  /**
@@ -1317,23 +1322,40 @@ export interface AutoSignConfig {
1317
1322
  */
1318
1323
  UserInfo: UserThreeFactor
1319
1324
  /**
1320
- * 接受自动签开启的回调地址。需要保证post返回200
1325
+ * 接受回调URL地址。支持http://或者https://协议
1326
+
1327
+ Post数据到此地址后后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
1321
1328
  */
1322
1329
  CallbackUrl: string
1323
1330
  /**
1324
- * 是否回调证书信息,默认false-不需要
1331
+ * 是否回调证书信息
1332
+ false-不需要 (默认值)
1333
+ true-需要
1325
1334
  */
1326
1335
  CertInfoCallback?: boolean
1327
1336
  /**
1328
- * 是否支持用户自定义签名印章,默认false-不需要
1337
+ * 是否支持用户自定义签名印章
1338
+ false-不需要(默认)
1339
+ true-需要
1329
1340
  */
1330
1341
  UserDefineSeal?: boolean
1331
1342
  /**
1332
- * 是否需要回调的时候返回印章(签名) 图片的 base64,默认false-不需要
1343
+ * 是否需要回调的时候返回印章(签名) 图片的 base64
1344
+
1345
+ false-不需要(默认)
1346
+ true-需要(
1333
1347
  */
1334
1348
  SealImgCallback?: boolean
1335
1349
  /**
1336
- * 开通时候的验证方式,取值:WEIXINAPP(微信人脸识别),INSIGHT(慧眼人脸认别),TELECOM(运营商三要素验证)。如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
1350
+ * 开通时候的验证方式, 分布为
1351
+
1352
+ WEIXINAPP : 微信人脸识别
1353
+ INSIGHT : 慧眼人脸认别
1354
+ TELECOM : 运营商三要素验证
1355
+
1356
+ 如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。
1357
+
1358
+ 如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
1337
1359
  */
1338
1360
  VerifyChannels?: Array<string>
1339
1361
  }
@@ -1558,15 +1580,18 @@ export interface OrganizationInfo {
1558
1580
  */
1559
1581
  export interface DescribeUserAutoSignStatusResponse {
1560
1582
  /**
1561
- * 是否已开通自动签
1583
+ * 查询用户是否已开通自动签
1562
1584
  */
1563
1585
  IsOpen?: boolean
1564
1586
  /**
1565
1587
  * 自动签许可生效时间。当且仅当已开通自动签时有值。
1588
+
1589
+ 值为unix时间戳,单位为秒。
1566
1590
  */
1567
1591
  LicenseFrom?: number
1568
1592
  /**
1569
1593
  * 自动签许可到期时间。当且仅当已开通自动签时有值。
1594
+ 值为unix时间戳,单位为秒。
1570
1595
  */
1571
1596
  LicenseTo?: number
1572
1597
  /**
@@ -1746,10 +1771,13 @@ export interface CreateBatchCancelFlowUrlResponse {
1746
1771
  BatchCancelFlowUrl?: string
1747
1772
  /**
1748
1773
  * 签署流程撤回失败信息
1774
+ 数组里边的错误原因与传进来的FlowIds一一对应,如果是空字符串则标识没有出错
1749
1775
  */
1750
1776
  FailMessages?: Array<string>
1751
1777
  /**
1752
1778
  * 签署连接过期时间字符串:年月日-时分秒
1779
+
1780
+ 例如:2023-07-28 17:25:59
1753
1781
  */
1754
1782
  UrlExpireOn?: string
1755
1783
  /**
@@ -1934,7 +1962,7 @@ CreateReview:发起审核
1934
1962
  默认:SignReview;SignReview:签署审核
1935
1963
 
1936
1964
  该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
1937
- 若发起个人审核,则指定该字段为:SignReview(注意,给个人审核时,需联系客户经理开白使用)
1965
+ 若发起个人审核,则指定该字段为:SignReview
1938
1966
  */
1939
1967
  OperateType?: string
1940
1968
  }
@@ -1996,7 +2024,7 @@ export interface CreateUserAutoSignEnableUrlResponse {
1996
2024
  */
1997
2025
  Path?: string
1998
2026
  /**
1999
- * base64格式跳转二维码
2027
+ * base64格式跳转二维码,可以通过微信扫描后跳转到业务界面
2000
2028
  */
2001
2029
  QrCode?: string
2002
2030
  /**
@@ -2840,7 +2868,7 @@ export interface FailedUpdateStaffData {
2840
2868
  */
2841
2869
  export interface GetTaskResultApiRequest {
2842
2870
  /**
2843
- * 任务Id,通过CreateConvertTaskApi得到
2871
+ * 任务Id,通过接口CreateConvertTaskApi或CreateMergeFileTask得到的返回任务id
2844
2872
  */
2845
2873
  TaskId: string
2846
2874
  /**
@@ -3519,15 +3547,20 @@ E_PRESCRIPTION_AUTO_SIGN 电子处方
3519
3547
  */
3520
3548
  AutoSignConfig: AutoSignConfig
3521
3549
  /**
3522
- * 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
3550
+ * 链接类型,
3551
+ 空-默认小程序端链接
3552
+ H5SIGN-h5端链接
3523
3553
  */
3524
3554
  UrlType?: string
3525
3555
  /**
3526
- * 通知类型,默认不填为不通知开通方,填写 SMS 为短信通知。
3556
+ * 通知类型
3557
+
3558
+ 默认不设置为不通知开通方,
3559
+ SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
3527
3560
  */
3528
3561
  NotifyType?: string
3529
3562
  /**
3530
- * 若上方填写为 SMS,则此处为手机号
3563
+ * 如果通知类型NotifyType选择为SMS,则此处为手机号, 其他通知类型不需要设置此项
3531
3564
  */
3532
3565
  NotifyAddress?: string
3533
3566
  /**
@@ -3804,7 +3837,7 @@ ProcessTimeout - 转换文件超时
3804
3837
  */
3805
3838
  TaskMessage?: string
3806
3839
  /**
3807
- * 资源Id,也是FileId,用于文件发起使用
3840
+ * 资源Id,也是FileId,用于文件发起时使用
3808
3841
  */
3809
3842
  ResourceId?: string
3810
3843
  /**
@@ -4773,7 +4806,8 @@ export interface CreateBatchCancelFlowUrlRequest {
4773
4806
  */
4774
4807
  Operator: UserInfo
4775
4808
  /**
4776
- * 需要执行撤回的签署流程id数组,最多100
4809
+ * 需要执行撤回的流程(合同)的编号列表,最多100个.
4810
+ 列表中的流程(合同)编号不要重复.
4777
4811
  */
4778
4812
  FlowIds: Array<string>
4779
4813
  /**
@@ -4848,6 +4882,8 @@ export interface DescribeFlowInfoRequest {
4848
4882
  Operator?: UserInfo
4849
4883
  /**
4850
4884
  * 需要查询的流程ID列表,限制最大100个
4885
+
4886
+ 如果查询合同组的信息,不要传此参数
4851
4887
  */
4852
4888
  FlowIds?: Array<string>
4853
4889
  /**
@@ -4855,7 +4891,9 @@ export interface DescribeFlowInfoRequest {
4855
4891
  */
4856
4892
  Agent?: Agent
4857
4893
  /**
4858
- * 合同组ID
4894
+ * 合同组ID, 如果传此参数会忽略FlowIds入参
4895
+ 所以如传此参数不要传FlowIds参数
4896
+
4859
4897
  */
4860
4898
  FlowGroupId?: string
4861
4899
  }
@@ -4920,7 +4958,7 @@ E_PRESCRIPTION_AUTO_SIGN 电子处方
4920
4958
  */
4921
4959
  SceneKey: string
4922
4960
  /**
4923
- * 查询开启状态的用户信息
4961
+ * 要查询开启状态的用户信息
4924
4962
  */
4925
4963
  UserInfo: UserThreeFactor
4926
4964
  /**
@@ -4987,20 +5025,20 @@ export interface FlowBrief {
4987
5025
  /**
4988
5026
  * 流程的编号ID
4989
5027
  */
4990
- FlowId: string
5028
+ FlowId?: string
4991
5029
  /**
4992
5030
  * 流程的名称
4993
5031
  */
4994
- FlowName: string
5032
+ FlowName?: string
4995
5033
  /**
4996
5034
  * 流程的描述信息
4997
5035
  注意:此字段可能返回 null,表示取不到有效值。
4998
5036
  */
4999
- FlowDescription: string
5037
+ FlowDescription?: string
5000
5038
  /**
5001
5039
  * 流程的类型
5002
5040
  */
5003
- FlowType: string
5041
+ FlowType?: string
5004
5042
  /**
5005
5043
  * 流程状态
5006
5044
  - 0 还没有发起
@@ -5017,17 +5055,19 @@ export interface FlowBrief {
5017
5055
  - 21 已解除
5018
5056
  注意:此字段可能返回 null,表示取不到有效值。
5019
5057
  */
5020
- FlowStatus: number
5058
+ FlowStatus?: number
5021
5059
  /**
5022
5060
  * 流程创建的时间戳,单位秒
5023
5061
  注意:此字段可能返回 null,表示取不到有效值。
5024
5062
  */
5025
- CreatedOn: number
5063
+ CreatedOn?: number
5026
5064
  /**
5027
- * 拒签或者取消的原因描述
5065
+ * 当合同被拒签或者取消后(当FlowStatus=3或者FlowStatus=6的时候)
5066
+ 此字段展示拒签或者取消的原因描述
5067
+
5028
5068
  注意:此字段可能返回 null,表示取不到有效值。
5029
5069
  */
5030
- FlowMessage: string
5070
+ FlowMessage?: string
5031
5071
  /**
5032
5072
  * 合同发起人userId
5033
5073
  注意:此字段可能返回 null,表示取不到有效值。
@@ -35,6 +35,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
35
35
  当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
36
36
 
37
37
  > **适用场景**
38
+ >
38
39
  > 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
39
40
  > 一个模板通常会包含以下结构信息
40
41
  >- 模板基本信息
@@ -206,8 +207,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
206
207
  */
207
208
  CreateIntegrationDepartment(req: CreateIntegrationDepartmentRequest, cb?: (error: string, rep: CreateIntegrationDepartmentResponse) => void): Promise<CreateIntegrationDepartmentResponse>;
208
209
  /**
209
- * 通过发起转换任务接口(CreateConvertTaskApi)返回的任务Id查询转换任务状态,通过本接口确认转换任务是否完成。<br/>
210
- 大文件转换所需的时间可能会比较长。
210
+ * 查询转换任务的状态。转换任务Id通过发起转换任务接口(CreateConvertTaskApi)获取。
211
+ 注意:大文件转换所需的时间可能会比较长。
211
212
  */
212
213
  GetTaskResultApi(req: GetTaskResultApiRequest, cb?: (error: string, rep: GetTaskResultApiResponse) => void): Promise<GetTaskResultApiResponse>;
213
214
  /**
@@ -233,9 +234,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
233
234
  */
234
235
  CreateConvertTaskApi(req: CreateConvertTaskApiRequest, cb?: (error: string, rep: CreateConvertTaskApiResponse) => void): Promise<CreateConvertTaskApiResponse>;
235
236
  /**
236
- * 查询流程摘要
237
+ * 查询流程基础信息
237
238
  适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
238
- 日调用量限制:10W
239
+ 每个企业限制日调用量限制:10W, 当当日超过此限制后再调用接口返回错误
239
240
  */
240
241
  DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
241
242
  /**
@@ -64,6 +64,7 @@ class Client extends TencentCloudCommon.AbstractClient {
64
64
  当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
65
65
 
66
66
  > **适用场景**
67
+ >
67
68
  > 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
68
69
  > 一个模板通常会包含以下结构信息
69
70
  >- 模板基本信息
@@ -299,8 +300,8 @@ class Client extends TencentCloudCommon.AbstractClient {
299
300
  return this.request("CreateIntegrationDepartment", req, cb);
300
301
  }
301
302
  /**
302
- * 通过发起转换任务接口(CreateConvertTaskApi)返回的任务Id查询转换任务状态,通过本接口确认转换任务是否完成。<br/>
303
- 大文件转换所需的时间可能会比较长。
303
+ * 查询转换任务的状态。转换任务Id通过发起转换任务接口(CreateConvertTaskApi)获取。
304
+ 注意:大文件转换所需的时间可能会比较长。
304
305
  */
305
306
  async GetTaskResultApi(req, cb) {
306
307
  return this.request("GetTaskResultApi", req, cb);
@@ -336,9 +337,9 @@ class Client extends TencentCloudCommon.AbstractClient {
336
337
  return this.request("CreateConvertTaskApi", req, cb);
337
338
  }
338
339
  /**
339
- * 查询流程摘要
340
+ * 查询流程基础信息
340
341
  适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
341
- 日调用量限制:10W
342
+ 每个企业限制日调用量限制:10W, 当当日超过此限制后再调用接口返回错误
342
343
  */
343
344
  async DescribeFlowBriefs(req, cb) {
344
345
  return this.request("DescribeFlowBriefs", req, cb);