tencentcloud-sdk-nodejs 4.0.651 → 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.
Files changed (84) hide show
  1. package/CHANGELOG.md +467 -0
  2. package/SERVICE_CHANGELOG.md +459 -176
  3. package/package.json +1 -1
  4. package/products.md +29 -29
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/bma/v20221115/bma_models.ts +7 -2
  7. package/src/services/cam/v20190116/cam_models.ts +12 -12
  8. package/src/services/ccc/v20200210/ccc_models.ts +10 -0
  9. package/src/services/cdb/v20170320/cdb_models.ts +27 -27
  10. package/src/services/cdn/v20180606/cdn_models.ts +0 -1
  11. package/src/services/ckafka/v20190819/ckafka_models.ts +2 -2
  12. package/src/services/clb/v20180317/clb_models.ts +4 -6
  13. package/src/services/cls/v20201016/cls_client.ts +17 -2
  14. package/src/services/cls/v20201016/cls_models.ts +212 -40
  15. package/src/services/cwp/v20180228/cwp_models.ts +37 -32
  16. package/src/services/dnspod/v20210323/dnspod_models.ts +4 -0
  17. package/src/services/dts/v20211206/dts_models.ts +1 -1
  18. package/src/services/ess/v20201111/ess_client.ts +21 -8
  19. package/src/services/ess/v20201111/ess_models.ts +88 -38
  20. package/src/services/essbasic/v20210526/essbasic_client.ts +7 -1
  21. package/src/services/essbasic/v20210526/essbasic_models.ts +49 -33
  22. package/src/services/gaap/v20180529/gaap_models.ts +2 -2
  23. package/src/services/lcic/v20220817/lcic_models.ts +22 -0
  24. package/src/services/nlp/v20190408/nlp_models.ts +1 -1
  25. package/src/services/ocr/v20181119/ocr_client.ts +3 -35
  26. package/src/services/ocr/v20181119/ocr_models.ts +40 -209
  27. package/src/services/tcss/v20201101/tcss_client.ts +2 -0
  28. package/src/services/tcss/v20201101/tcss_models.ts +105 -25
  29. package/src/services/teo/v20220901/teo_models.ts +16 -16
  30. package/src/services/tione/v20211111/tione_client.ts +182 -22
  31. package/src/services/tione/v20211111/tione_models.ts +1203 -277
  32. package/src/services/trtc/v20190722/trtc_models.ts +9 -1
  33. package/src/services/tsf/v20180326/tsf_models.ts +11 -11
  34. package/src/services/tts/v20190823/tts_models.ts +2 -2
  35. package/src/services/vpc/v20170312/vpc_client.ts +15 -1
  36. package/src/services/vpc/v20170312/vpc_models.ts +133 -6
  37. package/src/services/waf/v20180125/waf_client.ts +33 -7
  38. package/src/services/waf/v20180125/waf_models.ts +137 -16
  39. package/tencentcloud/common/sdk_version.d.ts +1 -1
  40. package/tencentcloud/common/sdk_version.js +1 -1
  41. package/tencentcloud/services/bma/v20221115/bma_models.d.ts +7 -2
  42. package/tencentcloud/services/cam/v20190116/cam_models.d.ts +12 -12
  43. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +10 -0
  44. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +27 -27
  45. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +0 -1
  46. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +2 -2
  47. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +4 -6
  48. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +5 -1
  49. package/tencentcloud/services/cls/v20201016/cls_client.js +6 -0
  50. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +207 -40
  51. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +37 -32
  52. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +4 -0
  53. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +1 -1
  54. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +21 -8
  55. package/tencentcloud/services/ess/v20201111/ess_client.js +21 -8
  56. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +88 -38
  57. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +7 -1
  58. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +7 -1
  59. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +49 -33
  60. package/tencentcloud/services/gaap/v20180529/gaap_models.d.ts +2 -2
  61. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +22 -0
  62. package/tencentcloud/services/nlp/v20190408/nlp_models.d.ts +1 -1
  63. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +2 -16
  64. package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -19
  65. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +40 -203
  66. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +103 -25
  67. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +16 -16
  68. package/tencentcloud/services/tione/v20211111/tione_client.d.ts +57 -5
  69. package/tencentcloud/services/tione/v20211111/tione_client.js +84 -6
  70. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +1135 -239
  71. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +9 -1
  72. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +11 -11
  73. package/tencentcloud/services/tts/v20190823/tts_models.d.ts +2 -2
  74. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +5 -1
  75. package/tencentcloud/services/vpc/v20170312/vpc_client.js +6 -0
  76. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +129 -6
  77. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +11 -3
  78. package/tencentcloud/services/waf/v20180125/waf_client.js +15 -3
  79. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +131 -16
  80. package/test/cls.v20201016.test.js +10 -0
  81. package/test/ocr.v20181119.test.js +0 -20
  82. package/test/tione.v20211111.test.js +134 -4
  83. package/test/vpc.v20170312.test.js +10 -0
  84. package/test/waf.v20180125.test.js +22 -2
@@ -59,8 +59,19 @@ callbackinfo包含: 回调地址和签名key
59
59
  return this.request("CancelFlow", req, cb);
60
60
  }
61
61
  /**
62
- * 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。<br/>
63
- 该接口常用来配合“创建电子文档”接口作为前置的接口使用。<br/>
62
+ * 本接口用于查询本企业模板列表。
63
+
64
+ 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
65
+
66
+ > **适用场景**
67
+ >
68
+ > 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
69
+ > 一个模板通常会包含以下结构信息
70
+ >- 模板基本信息
71
+ >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
72
+ >- 填写控件 Components
73
+ >- 签署控件 SignComponents
74
+ >- 生成模板的文件基础信息 FileInfos
64
75
  */
65
76
  async DescribeFlowTemplates(req, cb) {
66
77
  return this.request("DescribeFlowTemplates", req, cb);
@@ -289,8 +300,8 @@ callbackinfo包含: 回调地址和签名key
289
300
  return this.request("CreateIntegrationDepartment", req, cb);
290
301
  }
291
302
  /**
292
- * 通过发起转换任务接口(CreateConvertTaskApi)返回的任务Id查询转换任务状态,通过本接口确认转换任务是否完成。<br/>
293
- 大文件转换所需的时间可能会比较长。
303
+ * 查询转换任务的状态。转换任务Id通过发起转换任务接口(CreateConvertTaskApi)获取。
304
+ 注意:大文件转换所需的时间可能会比较长。
294
305
  */
295
306
  async GetTaskResultApi(req, cb) {
296
307
  return this.request("GetTaskResultApi", req, cb);
@@ -308,8 +319,10 @@ callbackinfo包含: 回调地址和签名key
308
319
  return this.request("DescribeIntegrationEmployees", req, cb);
309
320
  }
310
321
  /**
311
- * 创建个人H5签署链接,请联系客户经理申请使用 <br/>
312
- 该接口用于发起合同后,生成C端签署人的签署链接 <br/>
322
+ * 创建个人H5签署链接,请联系客户经理申请开通使用, 否则调用会返回失败 <br/>
323
+
324
+ 该接口用于发起合同后,生成个人签署人的签署链接, 暂时不支持企业端签署 <br/>
325
+
313
326
  注意:该接口目前签署人类型仅支持个人签署方(PERSON) <br/>
314
327
  注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
315
328
  注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
@@ -324,9 +337,9 @@ callbackinfo包含: 回调地址和签名key
324
337
  return this.request("CreateConvertTaskApi", req, cb);
325
338
  }
326
339
  /**
327
- * 查询流程摘要
340
+ * 查询流程基础信息
328
341
  适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
329
- 日调用量限制:10W
342
+ 每个企业限制日调用量限制:10W, 当当日超过此限制后再调用接口返回错误
330
343
  */
331
344
  async DescribeFlowBriefs(req, cb) {
332
345
  return this.request("DescribeFlowBriefs", req, cb);
@@ -524,7 +524,7 @@ export interface ReleasedApprover {
524
524
  */
525
525
  ApproverSignComponentType?: string;
526
526
  /**
527
- * 签署方自定义控件别名,最大长度20个字符
527
+ * 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方, 依次类推. 如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字符
528
528
  */
529
529
  ApproverSignRole?: string;
530
530
  }
@@ -880,14 +880,16 @@ export interface DescribeFlowComponentsResponse {
880
880
  */
881
881
  export interface DescribeFlowEvidenceReportResponse {
882
882
  /**
883
- * 报告 URL
883
+ * 出证报告PDF的下载 URL
884
884
  注意:此字段可能返回 null,表示取不到有效值。
885
885
  */
886
886
  ReportUrl?: string;
887
887
  /**
888
- * 执行中:EvidenceStatusExecuting
889
- 成功:EvidenceStatusSuccess
890
- 失败:EvidenceStatusFailed
888
+ * 出证任务执行的状态, 分布表示下面的含义
889
+
890
+ EvidenceStatusExecuting 出证任务在执行中
891
+ EvidenceStatusSuccess 出证任务执行成功
892
+ EvidenceStatusFailed 出征任务执行失败
891
893
  */
892
894
  Status?: string;
893
895
  /**
@@ -1218,7 +1220,10 @@ export interface CreateSchemeUrlRequest {
1218
1220
  */
1219
1221
  PathType?: number;
1220
1222
  /**
1221
- * 是否自动回跳 true:是, false:否。该参数只针对"APP" 类型的签署链接有效
1223
+ * 是否自动回跳
1224
+ true:是,
1225
+ false:否。
1226
+ 该参数只针对"APP" 类型的签署链接有效
1222
1227
  */
1223
1228
  AutoJumpBack?: boolean;
1224
1229
  /**
@@ -1253,23 +1258,40 @@ export interface AutoSignConfig {
1253
1258
  */
1254
1259
  UserInfo: UserThreeFactor;
1255
1260
  /**
1256
- * 接受自动签开启的回调地址。需要保证post返回200
1261
+ * 接受回调URL地址。支持http://或者https://协议
1262
+
1263
+ Post数据到此地址后后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
1257
1264
  */
1258
1265
  CallbackUrl: string;
1259
1266
  /**
1260
- * 是否回调证书信息,默认false-不需要
1267
+ * 是否回调证书信息
1268
+ false-不需要 (默认值)
1269
+ true-需要
1261
1270
  */
1262
1271
  CertInfoCallback?: boolean;
1263
1272
  /**
1264
- * 是否支持用户自定义签名印章,默认false-不需要
1273
+ * 是否支持用户自定义签名印章
1274
+ false-不需要(默认)
1275
+ true-需要
1265
1276
  */
1266
1277
  UserDefineSeal?: boolean;
1267
1278
  /**
1268
- * 是否需要回调的时候返回印章(签名) 图片的 base64,默认false-不需要
1279
+ * 是否需要回调的时候返回印章(签名) 图片的 base64
1280
+
1281
+ false-不需要(默认)
1282
+ true-需要(
1269
1283
  */
1270
1284
  SealImgCallback?: boolean;
1271
1285
  /**
1272
- * 开通时候的验证方式,取值:WEIXINAPP(微信人脸识别),INSIGHT(慧眼人脸认别),TELECOM(运营商三要素验证)。如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
1286
+ * 开通时候的验证方式, 分布为
1287
+
1288
+ WEIXINAPP : 微信人脸识别
1289
+ INSIGHT : 慧眼人脸认别
1290
+ TELECOM : 运营商三要素验证
1291
+
1292
+ 如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。
1293
+
1294
+ 如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
1273
1295
  */
1274
1296
  VerifyChannels?: Array<string>;
1275
1297
  }
@@ -1386,31 +1408,39 @@ export interface CreateIntegrationDepartmentResponse {
1386
1408
  */
1387
1409
  export interface DescribeFlowTemplatesRequest {
1388
1410
  /**
1389
- * 调用方用户信息,userId 必填
1411
+ * 调用方员工/经办人信息
1412
+ UserId 必填,在企业控制台组织架构中可以查到员工的UserId
1413
+ 注:请保证对应
1390
1414
  */
1391
1415
  Operator: UserInfo;
1392
1416
  /**
1393
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1417
+ * 代理相关应用信息
1418
+ 如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1394
1419
  */
1395
1420
  Agent?: Agent;
1396
1421
  /**
1397
- * 查询内容:0-模板列表及详情(默认),1-仅模板列表
1422
+ * 查询内容类型
1423
+ 0-模板列表及详情(默认)
1424
+ 1-仅模板列表
1398
1425
  */
1399
1426
  ContentType?: number;
1400
1427
  /**
1401
- * 搜索条件,具体参考Filter结构体。本接口取值:template-id:按照【 **模板唯一标识** 】进行过滤
1428
+ * 搜索条件,本字段用于指定模板Id进行查询。
1429
+ Key:template-id
1430
+ Values:需要查询的模板Id列表
1402
1431
  */
1403
1432
  Filters?: Array<Filter>;
1404
1433
  /**
1405
- * 查询偏移位置,默认0
1434
+ * 查询结果分页返回,此处指定第几页,如果不传默从第一页返回。页码从0开始,即首页为0。
1406
1435
  */
1407
1436
  Offset?: number;
1408
1437
  /**
1409
- * 查询个数,默认20,最大200
1438
+ * 指定每页多少条数据,如果不传默认为20,单页最大200
1410
1439
  */
1411
1440
  Limit?: number;
1412
1441
  /**
1413
- * ApplicationId不为空,查询指定应用下的模板列表
1442
+ * 用于查询指定应用号下单模板列表。
1443
+ ApplicationId不为空,查询指定应用下的模板列表
1414
1444
  ApplicationId为空,查询所有应用下的模板列表
1415
1445
  */
1416
1446
  ApplicationId?: string;
@@ -1475,15 +1505,18 @@ export interface OrganizationInfo {
1475
1505
  */
1476
1506
  export interface DescribeUserAutoSignStatusResponse {
1477
1507
  /**
1478
- * 是否已开通自动签
1508
+ * 查询用户是否已开通自动签
1479
1509
  */
1480
1510
  IsOpen?: boolean;
1481
1511
  /**
1482
1512
  * 自动签许可生效时间。当且仅当已开通自动签时有值。
1513
+
1514
+ 值为unix时间戳,单位为秒。
1483
1515
  */
1484
1516
  LicenseFrom?: number;
1485
1517
  /**
1486
1518
  * 自动签许可到期时间。当且仅当已开通自动签时有值。
1519
+ 值为unix时间戳,单位为秒。
1487
1520
  */
1488
1521
  LicenseTo?: number;
1489
1522
  /**
@@ -1658,10 +1691,13 @@ export interface CreateBatchCancelFlowUrlResponse {
1658
1691
  BatchCancelFlowUrl?: string;
1659
1692
  /**
1660
1693
  * 签署流程撤回失败信息
1694
+ 数组里边的错误原因与传进来的FlowIds一一对应,如果是空字符串则标识没有出错
1661
1695
  */
1662
1696
  FailMessages?: Array<string>;
1663
1697
  /**
1664
1698
  * 签署连接过期时间字符串:年月日-时分秒
1699
+
1700
+ 例如:2023-07-28 17:25:59
1665
1701
  */
1666
1702
  UrlExpireOn?: string;
1667
1703
  /**
@@ -1838,7 +1874,7 @@ export interface CreateFlowSignReviewRequest {
1838
1874
  默认:SignReview;SignReview:签署审核
1839
1875
 
1840
1876
  该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
1841
- 若发起个人审核,则指定该字段为:SignReview(注意,给个人审核时,需联系客户经理开白使用)
1877
+ 若发起个人审核,则指定该字段为:SignReview
1842
1878
  */
1843
1879
  OperateType?: string;
1844
1880
  }
@@ -1897,7 +1933,7 @@ export interface CreateUserAutoSignEnableUrlResponse {
1897
1933
  */
1898
1934
  Path?: string;
1899
1935
  /**
1900
- * base64格式跳转二维码
1936
+ * base64格式跳转二维码,可以通过微信扫描后跳转到业务界面
1901
1937
  */
1902
1938
  QrCode?: string;
1903
1939
  /**
@@ -2718,7 +2754,7 @@ export interface FailedUpdateStaffData {
2718
2754
  */
2719
2755
  export interface GetTaskResultApiRequest {
2720
2756
  /**
2721
- * 任务Id,通过CreateConvertTaskApi得到
2757
+ * 任务Id,通过接口CreateConvertTaskApi或CreateMergeFileTask得到的返回任务id
2722
2758
  */
2723
2759
  TaskId: string;
2724
2760
  /**
@@ -2941,7 +2977,9 @@ export interface CreateFlowSignUrlRequest {
2941
2977
  */
2942
2978
  FlowId: string;
2943
2979
  /**
2944
- * 流程签署人,其中ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
2980
+ * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。
2981
+
2982
+ 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
2945
2983
  */
2946
2984
  FlowApproverInfos: Array<FlowCreateApprover>;
2947
2985
  /**
@@ -3372,15 +3410,20 @@ export interface CreateUserAutoSignEnableUrlRequest {
3372
3410
  */
3373
3411
  AutoSignConfig: AutoSignConfig;
3374
3412
  /**
3375
- * 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
3413
+ * 链接类型,
3414
+ 空-默认小程序端链接
3415
+ H5SIGN-h5端链接
3376
3416
  */
3377
3417
  UrlType?: string;
3378
3418
  /**
3379
- * 通知类型,默认不填为不通知开通方,填写 SMS 为短信通知。
3419
+ * 通知类型
3420
+
3421
+ 默认不设置为不通知开通方,
3422
+ SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
3380
3423
  */
3381
3424
  NotifyType?: string;
3382
3425
  /**
3383
- * 若上方填写为 SMS,则此处为手机号
3426
+ * 如果通知类型NotifyType选择为SMS,则此处为手机号, 其他通知类型不需要设置此项
3384
3427
  */
3385
3428
  NotifyAddress?: string;
3386
3429
  /**
@@ -3645,7 +3688,7 @@ export interface GetTaskResultApiResponse {
3645
3688
  */
3646
3689
  TaskMessage?: string;
3647
3690
  /**
3648
- * 资源Id,也是FileId,用于文件发起使用
3691
+ * 资源Id,也是FileId,用于文件发起时使用
3649
3692
  */
3650
3693
  ResourceId?: string;
3651
3694
  /**
@@ -4581,7 +4624,8 @@ export interface CreateBatchCancelFlowUrlRequest {
4581
4624
  */
4582
4625
  Operator: UserInfo;
4583
4626
  /**
4584
- * 需要执行撤回的签署流程id数组,最多100
4627
+ * 需要执行撤回的流程(合同)的编号列表,最多100个.
4628
+ 列表中的流程(合同)编号不要重复.
4585
4629
  */
4586
4630
  FlowIds: Array<string>;
4587
4631
  /**
@@ -4654,6 +4698,8 @@ export interface DescribeFlowInfoRequest {
4654
4698
  Operator?: UserInfo;
4655
4699
  /**
4656
4700
  * 需要查询的流程ID列表,限制最大100个
4701
+
4702
+ 如果查询合同组的信息,不要传此参数
4657
4703
  */
4658
4704
  FlowIds?: Array<string>;
4659
4705
  /**
@@ -4661,7 +4707,9 @@ export interface DescribeFlowInfoRequest {
4661
4707
  */
4662
4708
  Agent?: Agent;
4663
4709
  /**
4664
- * 合同组ID
4710
+ * 合同组ID, 如果传此参数会忽略FlowIds入参
4711
+ 所以如传此参数不要传FlowIds参数
4712
+
4665
4713
  */
4666
4714
  FlowGroupId?: string;
4667
4715
  }
@@ -4722,7 +4770,7 @@ export interface DescribeUserAutoSignStatusRequest {
4722
4770
  */
4723
4771
  SceneKey: string;
4724
4772
  /**
4725
- * 查询开启状态的用户信息
4773
+ * 要查询开启状态的用户信息
4726
4774
  */
4727
4775
  UserInfo: UserThreeFactor;
4728
4776
  /**
@@ -4786,20 +4834,20 @@ export interface FlowBrief {
4786
4834
  /**
4787
4835
  * 流程的编号ID
4788
4836
  */
4789
- FlowId: string;
4837
+ FlowId?: string;
4790
4838
  /**
4791
4839
  * 流程的名称
4792
4840
  */
4793
- FlowName: string;
4841
+ FlowName?: string;
4794
4842
  /**
4795
4843
  * 流程的描述信息
4796
4844
  注意:此字段可能返回 null,表示取不到有效值。
4797
4845
  */
4798
- FlowDescription: string;
4846
+ FlowDescription?: string;
4799
4847
  /**
4800
4848
  * 流程的类型
4801
4849
  */
4802
- FlowType: string;
4850
+ FlowType?: string;
4803
4851
  /**
4804
4852
  * 流程状态
4805
4853
  - 0 还没有发起
@@ -4816,17 +4864,19 @@ export interface FlowBrief {
4816
4864
  - 21 已解除
4817
4865
  注意:此字段可能返回 null,表示取不到有效值。
4818
4866
  */
4819
- FlowStatus: number;
4867
+ FlowStatus?: number;
4820
4868
  /**
4821
4869
  * 流程创建的时间戳,单位秒
4822
4870
  注意:此字段可能返回 null,表示取不到有效值。
4823
4871
  */
4824
- CreatedOn: number;
4872
+ CreatedOn?: number;
4825
4873
  /**
4826
- * 拒签或者取消的原因描述
4874
+ * 当合同被拒签或者取消后(当FlowStatus=3或者FlowStatus=6的时候)
4875
+ 此字段展示拒签或者取消的原因描述
4876
+
4827
4877
  注意:此字段可能返回 null,表示取不到有效值。
4828
4878
  */
4829
- FlowMessage: string;
4879
+ FlowMessage?: string;
4830
4880
  /**
4831
4881
  * 合同发起人userId
4832
4882
  注意:此字段可能返回 null,表示取不到有效值。
@@ -138,7 +138,10 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
138
138
  * 指定需要批量撤销的签署流程Id,获取批量撤销链接 - 不建议使用此接口,可使用ChannelBatchCancelFlows
139
139
  客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
140
140
  接口调用成功返回批量撤销合同的链接,通过链接跳转到电子签小程序完成批量撤销;
141
- 可以撤回:未全部签署完成;不可以撤回(终态):已全部签署完成、已拒签、已过期、已撤回。
141
+
142
+ 可以撤回:未全部签署完成
143
+ 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
144
+
142
145
  注意:
143
146
  能撤回合同的只能是合同的发起人或者发起企业的超管、法人
144
147
  */
@@ -189,6 +192,9 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
189
192
  * 指定需要批量撤销的签署流程Id,批量撤销合同
190
193
  客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
191
194
 
195
+ 可以撤回:未全部签署完成
196
+ 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
197
+
192
198
  **满足撤销条件的合同会发起异步撤销流程,不满足撤销条件的合同返回失败原因。**
193
199
 
194
200
  **合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**
@@ -198,7 +198,10 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
198
198
  * 指定需要批量撤销的签署流程Id,获取批量撤销链接 - 不建议使用此接口,可使用ChannelBatchCancelFlows
199
199
  客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
200
200
  接口调用成功返回批量撤销合同的链接,通过链接跳转到电子签小程序完成批量撤销;
201
- 可以撤回:未全部签署完成;不可以撤回(终态):已全部签署完成、已拒签、已过期、已撤回。
201
+
202
+ 可以撤回:未全部签署完成
203
+ 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
204
+
202
205
  注意:
203
206
  能撤回合同的只能是合同的发起人或者发起企业的超管、法人
204
207
  */
@@ -269,6 +272,9 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
269
272
  * 指定需要批量撤销的签署流程Id,批量撤销合同
270
273
  客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
271
274
 
275
+ 可以撤回:未全部签署完成
276
+ 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
277
+
272
278
  **满足撤销条件的合同会发起异步撤销流程,不满足撤销条件的合同返回失败原因。**
273
279
 
274
280
  **合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**
@@ -416,7 +416,7 @@ export interface ChannelCreateFlowSignReviewRequest {
416
416
  注:接口通过该字段区分操作类型
417
417
  该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
418
418
  若想使用发起审核,请指定该字段为:CreateReview
419
- 若发起个人审核,则指定该字段为:SignReview(注意,给个人审核时,需联系客户经理开白使用)
419
+ 若发起个人审核,则指定该字段为:SignReview
420
420
  */
421
421
  OperateType?: string;
422
422
  }
@@ -443,7 +443,7 @@ export interface DescribeFlowDetailInfoRequest {
443
443
  Agent: Agent;
444
444
  /**
445
445
  * 合同(流程)编号数组,最多支持100个。
446
- (备注:该参数和合同组编号必须二选一)
446
+ (备注:该参数和合同组编号必须二选一, 如果填写FlowGroupId则忽略此FlowIds的入参)
447
447
  */
448
448
  FlowIds?: Array<string>;
449
449
  /**
@@ -691,6 +691,7 @@ export interface BaseFlowInfo {
691
691
  FlowName: string;
692
692
  /**
693
693
  * 合同流程类型
694
+ <br/>客户自定义,用于合同分类展示
694
695
  */
695
696
  FlowType: string;
696
697
  /**
@@ -703,6 +704,7 @@ export interface BaseFlowInfo {
703
704
  Deadline: number;
704
705
  /**
705
706
  * 是否顺序签署(true:无序签,false:顺序签)
707
+ <br/>默认false,有序签署合同
706
708
  */
707
709
  Unordered?: boolean;
708
710
  /**
@@ -714,7 +716,10 @@ export interface BaseFlowInfo {
714
716
  */
715
717
  FormFields?: Array<FormField>;
716
718
  /**
717
- * 本企业(发起方企业)是否需要签署审批,true:开启本企业签署审批。使用ChannelCreateFlowSignReview接口提交审批结果,才能继续完成签署
719
+ * 本企业(发起方企业)是否需要签署审批
720
+ <br/>true:开启发起方签署审批
721
+ <br/>false:不开启发起方签署审批
722
+ <br/>开启后,使用ChannelCreateFlowSignReview接口提交审批结果,才能继续完成签署
718
723
  */
719
724
  NeedSignReview?: boolean;
720
725
  /**
@@ -726,7 +731,10 @@ export interface BaseFlowInfo {
726
731
  */
727
732
  CcInfos?: Array<CcInfo>;
728
733
  /**
729
- * 是否需要发起前审核,当指定NeedCreateReview=true,则发起后,需要使用接口:ChannelCreateFlowSignReview,来完成发起前审核,审核通过后,可以继续查看,签署合同
734
+ * 是否需要开启发起方发起前审核
735
+ <br/>true:开启发起方发起前审核
736
+ <br/>false:不开启发起方发起前审核
737
+ <br/>当指定NeedCreateReview=true,则提交审核后,需要使用接口:ChannelCreateFlowSignReview,来完成发起前审核,审核通过后,可以继续查看,签署合同
730
738
  */
731
739
  NeedCreateReview?: boolean;
732
740
  }
@@ -908,10 +916,6 @@ export interface ChannelCreatePrepareFlowRequest {
908
916
  * 合同流程基础信息
909
917
  */
910
918
  FlowInfo: BaseFlowInfo;
911
- /**
912
- * 合同签署人信息
913
- */
914
- FlowApproverList: Array<CommonFlowApprover>;
915
919
  /**
916
920
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
917
921
  */
@@ -920,6 +924,10 @@ export interface ChannelCreatePrepareFlowRequest {
920
924
  * 合同流程配置信息,用于配置发起合同时定制化
921
925
  */
922
926
  FlowOption?: CreateFlowOption;
927
+ /**
928
+ * 合同签署人信息
929
+ */
930
+ FlowApproverList?: Array<CommonFlowApprover>;
923
931
  /**
924
932
  * 通过flowid快速获得之前成功通过页面发起的合同生成链接
925
933
  */
@@ -3498,10 +3506,11 @@ export interface ChannelBatchCancelFlowsRequest {
3498
3506
  CancelMessage?: string;
3499
3507
  /**
3500
3508
  * 撤销理由自定义格式;选项:
3501
- 0 默认格式
3502
- 1 只保留身份信息:展示为【发起方】
3503
- 2 保留身份信息+企业名称:展示为【发起方xxx公司】
3504
- 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
3509
+
3510
+ - 0 默认格式
3511
+ - 1 只保留身份信息:展示为【发起方】
3512
+ - 2 保留身份信息+企业名称:展示为【发起方xxx公司】
3513
+ - 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
3505
3514
  */
3506
3515
  CancelMessageFormat?: number;
3507
3516
  /**
@@ -3893,14 +3902,17 @@ export interface OperateChannelTemplateRequest {
3893
3902
  */
3894
3903
  export interface CreateChannelFlowEvidenceReportResponse {
3895
3904
  /**
3896
- * 出证报告 ID,用于查询出证报告接口DescribeChannelFlowEvidenceReport时用到
3905
+ * 出证报告 ID,可用户DescribeChannelFlowEvidenceReport接口查询出证PDF的下载地址
3906
+
3897
3907
  注意:此字段可能返回 null,表示取不到有效值。
3898
3908
  */
3899
3909
  ReportId?: string;
3900
3910
  /**
3901
- * 执行中:EvidenceStatusExecuting
3902
- 成功:EvidenceStatusSuccess
3903
- 失败:EvidenceStatusFailed
3911
+ * 出征任务的执行状态,状态列表如下
3912
+
3913
+ - EvidenceStatusExecuting : 出征任务正在执行中
3914
+ - EvidenceStatusSuccess : 出征任务执行成功
3915
+ - EvidenceStatusFailed : 出征任务执行失败
3904
3916
  */
3905
3917
  Status?: string;
3906
3918
  /**
@@ -3973,14 +3985,16 @@ export interface ChannelCreateReleaseFlowResponse {
3973
3985
  */
3974
3986
  export interface DescribeChannelFlowEvidenceReportResponse {
3975
3987
  /**
3976
- * 出证报告 URL
3988
+ * 出证报告下载 URL
3977
3989
  注意:此字段可能返回 null,表示取不到有效值。
3978
3990
  */
3979
3991
  ReportUrl?: string;
3980
3992
  /**
3981
- * 执行中:EvidenceStatusExecuting
3982
- 成功:EvidenceStatusSuccess
3983
- 失败:EvidenceStatusFailed
3993
+ * 出征任务的执行状态,状态列表如下
3994
+
3995
+ - EvidenceStatusExecuting : 出征任务正在执行中
3996
+ - EvidenceStatusSuccess : 出征任务执行成功
3997
+ - EvidenceStatusFailed : 出征任务执行失败
3984
3998
  */
3985
3999
  Status?: string;
3986
4000
  /**
@@ -4073,23 +4087,25 @@ export interface ChannelCreateEmbedWebUrlRequest {
4073
4087
  */
4074
4088
  Agent: Agent;
4075
4089
  /**
4076
- * WEB嵌入资源类型。
4077
- CREATE_SEAL: 创建印章
4078
- CREATE_TEMPLATE:创建模板
4079
- MODIFY_TEMPLATE:修改模板
4080
- PREVIEW_TEMPLATE:预览模板
4081
- PREVIEW_FLOW:预览合同文档
4082
- PREVIEW_FLOW_DETAIL:预览合同详情
4083
- PREVIEW_SEAL_LIST:预览印章列表
4084
- PREVIEW_SEAL_DETAIL:预览印章详情
4085
- EXTEND_SERVICE:扩展服务
4090
+ * 要生成WEB嵌入界面的类型, 可以选择的值如下:
4091
+
4092
+ - CREATE_SEAL: 生成创建印章的嵌入页面
4093
+ - CREATE_TEMPLATE:生成创建模板的嵌入页面
4094
+ - MODIFY_TEMPLATE:生成修改模板的嵌入页面
4095
+ - PREVIEW_TEMPLATE:生成预览模板的嵌入页面
4096
+ - PREVIEW_FLOW:生成预览合同文档的嵌入页面
4097
+ - PREVIEW_FLOW_DETAIL:生成预览合同详情的嵌入页面
4098
+ - PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面
4099
+ - PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面
4100
+ - EXTEND_SERVICE:生成扩展服务的嵌入页面
4086
4101
  */
4087
4102
  EmbedType: string;
4088
4103
  /**
4089
4104
  * WEB嵌入的业务资源ID
4090
- EmbedType取值MODIFY_TEMPLATE,PREVIEW_TEMPLATE时必填,取值为模板id
4091
- PREVIEW_FLOWPREVIEW_FLOW_DETAIL时必填,取值为合同id
4092
- PREVIEW_SEAL_DETAIL,必填,取值为印章id
4105
+
4106
+ - 当EmbedType取值MODIFY_TEMPLATEPREVIEW_TEMPLATE时需要填写模板id作为BusinessId
4107
+ - 当EmbedType取值PREVIEW_FLOW,PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId
4108
+ - 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId
4093
4109
  */
4094
4110
  BusinessId?: string;
4095
4111
  /**
@@ -1754,11 +1754,11 @@ export interface DescribeAccessRegionsByDestRegionResponse {
1754
1754
  /**
1755
1755
  * 可用加速区域数量
1756
1756
  */
1757
- TotalCount: number;
1757
+ TotalCount?: number;
1758
1758
  /**
1759
1759
  * 可用加速区域信息列表
1760
1760
  */
1761
- AccessRegionSet: Array<AccessRegionDetial>;
1761
+ AccessRegionSet?: Array<AccessRegionDetial>;
1762
1762
  /**
1763
1763
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1764
1764
  */
@@ -650,6 +650,16 @@ export interface RoomItem {
650
650
  注意:此字段可能返回 null,表示取不到有效值。
651
651
  */
652
652
  VideoOrientation?: number;
653
+ /**
654
+ * 开启课后评分。 0:不开启(默认) 1:开启
655
+ 注意:此字段可能返回 null,表示取不到有效值。
656
+ */
657
+ IsGradingRequiredPostClass?: number;
658
+ /**
659
+ * 房间类型。0:小班课(默认值);1:大班课;2:1V1(后续扩展)
660
+ 注意:此字段可能返回 null,表示取不到有效值。
661
+ */
662
+ RoomType?: number;
653
663
  }
654
664
  /**
655
665
  * SetWatermark请求参数结构体
@@ -1260,6 +1270,14 @@ export interface GetRoomEventRequest {
1260
1270
  MemberJoin:成员加入
1261
1271
  MemberQuit:成员退出
1262
1272
  RecordFinish:录制结束
1273
+ CameraOn: 摄像头打开
1274
+ CameraOff: 摄像头关闭
1275
+ MicOn: 麦克风打开
1276
+ MicOff: 麦克风关闭
1277
+ ScreenOn: 屏幕共享打开
1278
+ ScreenOff: 屏幕共享关闭
1279
+ VisibleOn: 页面可见
1280
+ VisibleOff: 页面不可见
1263
1281
  */
1264
1282
  Keyword?: string;
1265
1283
  }
@@ -1739,6 +1757,10 @@ export interface DescribeRoomResponse {
1739
1757
  * 低代码互动课堂的SdkAppId。
1740
1758
  */
1741
1759
  SdkAppId?: number;
1760
+ /**
1761
+ * 观看类型。互动观看 (默认)
1762
+ */
1763
+ AudienceType?: number;
1742
1764
  /**
1743
1765
  * 分辨率。可以有如下取值:
1744
1766
  1 标清
@@ -1108,7 +1108,7 @@ export interface ComposeCoupletRequest {
1108
1108
  */
1109
1109
  export interface EvaluateSentenceSimilarityRequest {
1110
1110
  /**
1111
- * 待分析的句子对数组。句子对应不超过1对,仅支持中文文本,原句子与目标句子均应不超过64字符。
1111
+ * 待分析的句子对数组。句子对应不超过1对,仅支持中文文本,原句子与目标句子均应不超过500字符。
1112
1112
  */
1113
1113
  SentencePairList: Array<SentencePair>;
1114
1114
  }