tencentcloud-sdk-nodejs 4.0.674 → 4.0.676

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 (78) hide show
  1. package/CHANGELOG.md +461 -0
  2. package/SERVICE_CHANGELOG.md +554 -73
  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/billing/v20180709/billing_client.ts +197 -160
  7. package/src/services/billing/v20180709/billing_models.ts +1761 -1649
  8. package/src/services/cdwch/v20200915/cdwch_models.ts +20 -0
  9. package/src/services/ckafka/v20190819/ckafka_models.ts +4 -0
  10. package/src/services/cvm/v20170312/cvm_client.ts +2 -2
  11. package/src/services/cvm/v20170312/cvm_models.ts +6 -1
  12. package/src/services/cwp/v20180228/cwp_models.ts +21 -15
  13. package/src/services/dcdb/v20180411/dcdb_models.ts +5 -1
  14. package/src/services/es/v20180416/es_models.ts +100 -86
  15. package/src/services/ess/v20201111/ess_client.ts +75 -28
  16. package/src/services/ess/v20201111/ess_models.ts +533 -296
  17. package/src/services/essbasic/v20210526/essbasic_client.ts +5 -0
  18. package/src/services/essbasic/v20210526/essbasic_models.ts +14 -5
  19. package/src/services/faceid/v20180301/faceid_models.ts +7 -6
  20. package/src/services/iotvideo/v20201215/iotvideo_models.ts +9 -5
  21. package/src/services/iotvideo/v20211125/iotvideo_models.ts +19 -7
  22. package/src/services/iss/v20230517/iss_models.ts +4 -4
  23. package/src/services/lcic/v20220817/lcic_models.ts +14 -4
  24. package/src/services/mariadb/v20170312/mariadb_models.ts +5 -1
  25. package/src/services/memcached/v20190318/memcached_models.ts +1 -1
  26. package/src/services/mna/v20210119/mna_models.ts +1 -1
  27. package/src/services/ms/v20180408/ms_client.ts +3 -3
  28. package/src/services/nlp/v20190408/nlp_client.ts +1 -1
  29. package/src/services/ocr/v20181119/ocr_models.ts +2 -0
  30. package/src/services/redis/v20180412/redis_models.ts +1 -1
  31. package/src/services/ssl/v20191205/ssl_models.ts +30 -8
  32. package/src/services/tem/v20210701/tem_models.ts +8 -8
  33. package/src/services/teo/v20220901/teo_client.ts +1 -1
  34. package/src/services/teo/v20220901/teo_models.ts +1 -1
  35. package/src/services/tse/v20201207/tse_models.ts +2 -2
  36. package/src/services/wedata/v20210820/wedata_models.ts +90 -90
  37. package/tencentcloud/common/sdk_version.d.ts +1 -1
  38. package/tencentcloud/common/sdk_version.js +1 -1
  39. package/tencentcloud/services/billing/v20180709/billing_client.d.ts +47 -35
  40. package/tencentcloud/services/billing/v20180709/billing_client.js +69 -51
  41. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +1687 -1582
  42. package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +20 -0
  43. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +4 -0
  44. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +2 -2
  45. package/tencentcloud/services/cvm/v20170312/cvm_client.js +2 -2
  46. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +6 -1
  47. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +21 -15
  48. package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +5 -1
  49. package/tencentcloud/services/es/v20180416/es_models.d.ts +100 -86
  50. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +41 -12
  51. package/tencentcloud/services/ess/v20201111/ess_client.js +46 -13
  52. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +520 -289
  53. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +5 -0
  54. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +5 -0
  55. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +14 -5
  56. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +7 -6
  57. package/tencentcloud/services/iotvideo/v20201215/iotvideo_models.d.ts +9 -5
  58. package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +19 -7
  59. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +4 -4
  60. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +14 -4
  61. package/tencentcloud/services/mariadb/v20170312/mariadb_models.d.ts +5 -1
  62. package/tencentcloud/services/memcached/v20190318/memcached_models.d.ts +1 -1
  63. package/tencentcloud/services/mna/v20210119/mna_models.d.ts +1 -1
  64. package/tencentcloud/services/ms/v20180408/ms_client.d.ts +3 -3
  65. package/tencentcloud/services/ms/v20180408/ms_client.js +3 -3
  66. package/tencentcloud/services/nlp/v20190408/nlp_client.d.ts +1 -1
  67. package/tencentcloud/services/nlp/v20190408/nlp_client.js +1 -1
  68. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +2 -0
  69. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +1 -1
  70. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +30 -8
  71. package/tencentcloud/services/tem/v20210701/tem_models.d.ts +8 -8
  72. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +1 -1
  73. package/tencentcloud/services/teo/v20220901/teo_client.js +1 -1
  74. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +1 -1
  75. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +2 -2
  76. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +90 -90
  77. package/test/billing.v20180709.test.js +64 -34
  78. package/test/ess.v20201111.test.js +24 -4
@@ -304,13 +304,22 @@ export interface CreateFlowApproversResponse {
304
304
  }
305
305
 
306
306
  /**
307
- * DescribeIntegrationMainOrganizationUser请求参数结构体
307
+ * DescribeFileUrls返回参数结构体
308
308
  */
309
- export interface DescribeIntegrationMainOrganizationUserRequest {
309
+ export interface DescribeFileUrlsResponse {
310
310
  /**
311
- * 操作人信息,userId必填
311
+ * 文件URL信息;
312
+ 链接不是永久链接,有效期5分钟后链接失效。
312
313
  */
313
- Operator: UserInfo
314
+ FileUrls?: Array<FileUrl>
315
+ /**
316
+ * URL数量
317
+ */
318
+ TotalCount?: number
319
+ /**
320
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
321
+ */
322
+ RequestId?: string
314
323
  }
315
324
 
316
325
  /**
@@ -342,154 +351,34 @@ export interface CreateMultiFlowSignQRCodeResponse {
342
351
  }
343
352
 
344
353
  /**
345
- * 创建流程的签署方信息
354
+ * 签署链接信息
346
355
  */
347
- export interface FlowCreateApprover {
356
+ export interface FlowApproverUrlInfo {
348
357
  /**
349
- * 参与者类型:
350
- 0:企业
351
- 1:个人
352
- 3:企业自动签署
353
- 注:类型为3(企业自动签署)时,会自动完成该签署方的签署。
354
- 自动签署仅进行盖章操作,不能是手写签名。
355
- 本方企业自动签署的签署人会默认是当前的发起人
356
- 他方企业自动签署的签署人是自动签模板的他方企业授权人
357
- 7: 个人自动签署,适用于个人自动签场景。
358
- 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
358
+ * 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
359
+ 注意:此字段可能返回 null,表示取不到有效值。
359
360
  */
360
- ApproverType: number
361
+ SignUrl?: string
361
362
  /**
362
- * 签署人企业名称
363
- <br/>当approverType=1 或 approverType=3时,必须指定
364
-
365
-
363
+ * 签署人类型 1-个人
364
+ 注意:此字段可能返回 null,表示取不到有效值。
366
365
  */
367
- OrganizationName?: string
366
+ ApproverType?: number
368
367
  /**
369
- * 签署方经办人姓名
370
- <br/>在未指定签署人电子签UserId情况下,为必填参数
368
+ * 签署人姓名
369
+ 注意:此字段可能返回 null,表示取不到有效值。
371
370
  */
372
371
  ApproverName?: string
373
372
  /**
374
- * 签署方经办人手机号码
375
- <br/>在未指定签署人电子签UserId情况下,为必填参数
376
-
373
+ * 签署人手机号
374
+ 注意:此字段可能返回 null,表示取不到有效值。
377
375
  */
378
376
  ApproverMobile?: string
379
377
  /**
380
- * 签署人的证件类型
381
- ID_CARD 身份证
382
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
383
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
384
- OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
385
- */
386
- ApproverIdCardType?: string
387
- /**
388
- * 签署人证件号(长度不超过18位)
389
- */
390
- ApproverIdCardNumber?: string
391
- /**
392
- * 签署方经办人在模板中的参与方ID
393
- <br/>模板发起合同时,该参数为必填项
394
- <br/>文件发起合同是,该参数无序传值
395
-
396
- */
397
- RecipientId?: string
398
- /**
399
- * 签署意愿确认渠道,WEIXINAPP:人脸识别
400
- */
401
- VerifyChannel?: Array<string>
402
- /**
403
- * 是否发送短信
404
- <br/>sms--短信通知
405
- <br/>none--不通知
406
- <br/>默认为sms
407
- <br/>发起方=签署方时不发送短信
408
- */
409
- NotifyType?: string
410
- /**
411
- * 合同强制需要阅读全文,无需传此参数
412
- */
413
- IsFullText?: boolean
414
- /**
415
- * 合同的强制预览时间:3~300s,未指定则按合同页数计算
416
- */
417
- PreReadTime?: number
418
- /**
419
- * 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
420
-
421
- 若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息
422
- */
423
- UserId?: string
424
- /**
425
- * 当前只支持true,默认为true
426
- */
427
- Required?: boolean
428
- /**
429
- * 签署人用户来源,此参数仅针对企微用户开放
430
-
431
- 企微侧用户请传入:WEWORKAPP
432
- */
433
- ApproverSource?: string
434
- /**
435
- * 企业签署方或签标识,客户自定义,64位长度
436
- <br>用于发起含有或签签署人的合同。或签参与人必须有此字段。
437
- <br/>合同内不同或签参与人CustomApproverTag需要保证唯一。
438
- <br/>如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
439
- */
440
- CustomApproverTag?: string
441
- /**
442
- * 快速注册相关信息,目前暂未开放!
443
- */
444
- RegisterInfo?: RegisterInfo
445
- /**
446
- * 签署人个性化能力值
447
- */
448
- ApproverOption?: ApproverOption
449
- /**
450
- * 签署完前端跳转的url,暂未使用
451
- * @deprecated
452
- */
453
- JumpUrl?: string
454
- /**
455
- * 签署ID
456
- - 发起流程时系统自动补充
457
- - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
458
- */
459
- SignId?: string
460
- /**
461
- * 当前签署方进行签署操作是否需要企业内部审批
462
- <br>true 则为需要
463
- <br/>false,无序企业内部审批(默认)
464
- <br/>为个人签署方时则由发起方企业审核。
465
- */
466
- ApproverNeedSignReview?: boolean
467
- /**
468
- * 签署人签署控件, 此参数仅针对文件发起(CreateFlowByFiles)生效
469
- <br/>文件发起时,可通过该参数为签署人指定签署控件类型以及位置
470
- */
471
- SignComponents?: Array<Component>
472
- /**
473
- * 签署人填写控件 此参数仅针对文件发起(CreateFlowByFiles)生效
474
- <br/>文件发起时,可通过该参数为签署人指定填写控件类型以及位置
475
- */
476
- Components?: Array<Component>
477
- /**
478
- * 签署方控件类型为 SIGN_SIGNATURE时,可以指定签署方签名方式
479
- HANDWRITE – 手写签名
480
- OCR_ESIGN -- AI智能识别手写签名
481
- ESIGN -- 个人印章类型
482
- SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
483
- */
484
- ComponentLimitType?: Array<string>
485
- /**
486
- * 合同查看方式<br/>默认1 -实名查看 <br/>2-短信验证码查看(企业签署方暂不支持该方式)
487
- */
488
- ApproverVerifyTypes?: Array<number | bigint>
489
- /**
490
- * 合同签署方式(默认1,2) <br/>1-人脸认证 <br/>2-签署密码 <br/>3-运营商三要素
378
+ * 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
379
+ 注意:此字段可能返回 null,表示取不到有效值。
491
380
  */
492
- ApproverSignTypes?: Array<number | bigint>
381
+ LongUrl?: string
493
382
  }
494
383
 
495
384
  /**
@@ -717,7 +606,8 @@ export interface DescribeIntegrationRolesRequest {
717
606
  * 查询的关键字段:
718
607
  Key:"RoleType",Values:["1"]查询系统角色,Values:["2"]查询自定义角色
719
608
  Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
720
- Key:"IsGroupRole",Values:["0"],查询非集团角色,Values:["1"]表示查询集团角色
609
+ Key:"IsGroupRole",Values:["0"]:查询非集团角色,Values:["1"]表示查询集团角色
610
+ Key:"IsReturnPermissionGroup",Values:["0"]:表示接口不返回角色对应的权限树字段,Values:["1"]表示接口返回角色对应的权限树字段
721
611
  */
722
612
  Filters?: Array<Filter>
723
613
  /**
@@ -806,34 +696,42 @@ export interface StaffRole {
806
696
  }
807
697
 
808
698
  /**
809
- * 签署链接信息
699
+ * CreateIntegrationRole请求参数结构体
810
700
  */
811
- export interface FlowApproverUrlInfo {
701
+ export interface CreateIntegrationRoleRequest {
812
702
  /**
813
- * 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
814
- 注意:此字段可能返回 null,表示取不到有效值。
703
+ * 角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。
815
704
  */
816
- SignUrl?: string
705
+ Name: string
817
706
  /**
818
- * 签署人类型 1-个人
819
- 注意:此字段可能返回 null,表示取不到有效值。
707
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId。
708
+ 支持填入集团子公司经办人 userId 代发合同。
709
+
710
+ 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
820
711
  */
821
- ApproverType?: number
712
+ Operator: UserInfo
822
713
  /**
823
- * 签署人姓名
824
- 注意:此字段可能返回 null,表示取不到有效值。
714
+ * 角色描述,最大长度为50个字符
825
715
  */
826
- ApproverName?: string
716
+ Description?: string
827
717
  /**
828
- * 签署人手机号
829
- 注意:此字段可能返回 null,表示取不到有效值。
718
+ * 角色类型,0:saas角色,1:集团角色
719
+ 默认0,saas角色
830
720
  */
831
- ApproverMobile?: string
721
+ IsGroupRole?: number
832
722
  /**
833
- * 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
834
- 注意:此字段可能返回 null,表示取不到有效值。
723
+ * 权限树
835
724
  */
836
- LongUrl?: string
725
+ PermissionGroups?: Array<PermissionGroup>
726
+ /**
727
+ * 集团角色的话,需要传递集团子企业列表,如果是全选,则传1
728
+ */
729
+ SubOrganizationIds?: string
730
+ /**
731
+ * 代理企业和员工的信息。
732
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
733
+ */
734
+ Agent?: Agent
837
735
  }
838
736
 
839
737
  /**
@@ -867,8 +765,7 @@ export interface CreateConvertTaskApiRequest {
867
765
  */
868
766
  Operator?: UserInfo
869
767
  /**
870
- * 应用号信息
871
- * @deprecated
768
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
872
769
  */
873
770
  Agent?: Agent
874
771
  /**
@@ -1316,6 +1213,20 @@ export interface DescribeIntegrationEmployeesRequest {
1316
1213
  Offset?: number
1317
1214
  }
1318
1215
 
1216
+ /**
1217
+ * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
1218
+ */
1219
+ export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1220
+ /**
1221
+ * 解绑是否成功,1表示成功,0表示失败
1222
+ */
1223
+ Status?: number
1224
+ /**
1225
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1226
+ */
1227
+ RequestId?: string
1228
+ }
1229
+
1319
1230
  /**
1320
1231
  * CreateIntegrationUserRoles返回参数结构体
1321
1232
  */
@@ -1566,17 +1477,13 @@ export interface DescribeThirdPartyAuthCodeRequest {
1566
1477
  }
1567
1478
 
1568
1479
  /**
1569
- * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
1480
+ * DescribeIntegrationMainOrganizationUser请求参数结构体
1570
1481
  */
1571
- export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1572
- /**
1573
- * 解绑是否成功,1表示成功,0表示失败
1574
- */
1575
- Status?: number
1482
+ export interface DescribeIntegrationMainOrganizationUserRequest {
1576
1483
  /**
1577
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1484
+ * 操作人信息,userId必填
1578
1485
  */
1579
- RequestId?: string
1486
+ Operator: UserInfo
1580
1487
  }
1581
1488
 
1582
1489
  /**
@@ -1654,6 +1561,67 @@ export interface DescribeIntegrationDepartmentsRequest {
1654
1561
  DeptOpenId?: string
1655
1562
  }
1656
1563
 
1564
+ /**
1565
+ * 权限树节点权限
1566
+ */
1567
+ export interface Permission {
1568
+ /**
1569
+ * 权限名称
1570
+ 注意:此字段可能返回 null,表示取不到有效值。
1571
+ */
1572
+ Name?: string
1573
+ /**
1574
+ * 权限key
1575
+ 注意:此字段可能返回 null,表示取不到有效值。
1576
+ */
1577
+ Key?: string
1578
+ /**
1579
+ * 权限类型 1前端,2后端
1580
+ 注意:此字段可能返回 null,表示取不到有效值。
1581
+ */
1582
+ Type?: number
1583
+ /**
1584
+ * 是否隐藏
1585
+ 注意:此字段可能返回 null,表示取不到有效值。
1586
+ */
1587
+ Hide?: number
1588
+ /**
1589
+ * 数据权限标签 1:表示根节点,2:表示叶子结点
1590
+ 注意:此字段可能返回 null,表示取不到有效值。
1591
+ */
1592
+ DataLabel?: number
1593
+ /**
1594
+ * 数据权限独有,1:关联其他模块鉴权,2:表示关联自己模块鉴权
1595
+ 注意:此字段可能返回 null,表示取不到有效值。
1596
+ */
1597
+ DataType?: number
1598
+ /**
1599
+ * 数据权限独有,表示数据范围,1:全公司,2:部门及下级部门,3:自己
1600
+ 注意:此字段可能返回 null,表示取不到有效值。
1601
+ */
1602
+ DataRange?: number
1603
+ /**
1604
+ * 关联权限, 表示这个功能权限要受哪个数据权限管控
1605
+ 注意:此字段可能返回 null,表示取不到有效值。
1606
+ */
1607
+ DataTo?: string
1608
+ /**
1609
+ * 父级权限key
1610
+ 注意:此字段可能返回 null,表示取不到有效值。
1611
+ */
1612
+ ParentKey?: string
1613
+ /**
1614
+ * 是否选中
1615
+ 注意:此字段可能返回 null,表示取不到有效值。
1616
+ */
1617
+ IsChecked?: boolean
1618
+ /**
1619
+ * 子权限集合
1620
+ 注意:此字段可能返回 null,表示取不到有效值。
1621
+ */
1622
+ Children?: Array<Permission>
1623
+ }
1624
+
1657
1625
  /**
1658
1626
  * CreateIntegrationDepartment返回参数结构体
1659
1627
  */
@@ -1891,6 +1859,26 @@ export interface CreatePersonAuthCertificateImageResponse {
1891
1859
  * 个人用户证明证书的下载链接
1892
1860
  */
1893
1861
  AuthCertUrl?: string
1862
+ /**
1863
+ * 证书图片上的证书编号,20位数字
1864
+ 注意:此字段可能返回 null,表示取不到有效值。
1865
+ */
1866
+ ImageCertId?: string
1867
+ /**
1868
+ * 图片证明对应的CA证书序列号
1869
+ 注意:此字段可能返回 null,表示取不到有效值。
1870
+ */
1871
+ SerialNumber?: string
1872
+ /**
1873
+ * CA证书颁发时间戳
1874
+ 注意:此字段可能返回 null,表示取不到有效值。
1875
+ */
1876
+ ValidFrom?: number
1877
+ /**
1878
+ * CA证书有效截止时间戳
1879
+ 注意:此字段可能返回 null,表示取不到有效值。
1880
+ */
1881
+ ValidTo?: number
1894
1882
  /**
1895
1883
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1896
1884
  */
@@ -2323,6 +2311,25 @@ export interface CreateFlowSignUrlResponse {
2323
2311
  RequestId?: string
2324
2312
  }
2325
2313
 
2314
+ /**
2315
+ * 发起流程快速注册相关信息
2316
+ */
2317
+ export interface RegisterInfo {
2318
+ /**
2319
+ * 法人姓名
2320
+ */
2321
+ LegalName: string
2322
+ /**
2323
+ * 社会统一信用代码
2324
+ * @deprecated
2325
+ */
2326
+ Uscc?: string
2327
+ /**
2328
+ * 社会统一信用代码
2329
+ */
2330
+ UnifiedSocialCreditCode?: string
2331
+ }
2332
+
2326
2333
  /**
2327
2334
  * DescribeFileUrls请求参数结构体
2328
2335
  */
@@ -2375,8 +2382,8 @@ export interface DescribeFileUrlsRequest {
2375
2382
  */
2376
2383
  Scene?: string
2377
2384
  /**
2378
- * 应用相关信息
2379
- * @deprecated
2385
+ * 代理企业和员工的信息。
2386
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2380
2387
  */
2381
2388
  Agent?: Agent
2382
2389
  }
@@ -2554,101 +2561,270 @@ FormFiled输入示例:
2554
2561
  | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
2555
2562
  | cells.N.content | String | 单元格内容,字数不超过100 |
2556
2563
 
2557
- 表格参数headers说明
2558
- widthPercent Integer 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35
2559
- content String 表头单元格内容,字数不超过100
2560
- */
2561
- export interface FormField {
2564
+ 表格参数headers说明
2565
+ widthPercent Integer 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35
2566
+ content String 表头单元格内容,字数不超过100
2567
+ */
2568
+ export interface FormField {
2569
+ /**
2570
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
2571
+ TEXT - 文本内容
2572
+ MULTI_LINE_TEXT - 文本内容
2573
+ CHECK_BOX - true/false
2574
+ FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
2575
+ SELECTOR - 选项值
2576
+ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
2577
+ */
2578
+ ComponentValue: string
2579
+ /**
2580
+ * 控件id,和ComponentName选择一项传入即可
2581
+ */
2582
+ ComponentId?: string
2583
+ /**
2584
+ * 控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可
2585
+ */
2586
+ ComponentName?: string
2587
+ }
2588
+
2589
+ /**
2590
+ * CreateChannelSubOrganizationModifyQrCode请求参数结构体
2591
+ */
2592
+ export interface CreateChannelSubOrganizationModifyQrCodeRequest {
2593
+ /**
2594
+ * 操作人信息,userId必填
2595
+ */
2596
+ Operator: UserInfo
2597
+ /**
2598
+ * 应用编号
2599
+ */
2600
+ ApplicationId: string
2601
+ }
2602
+
2603
+ /**
2604
+ * 用户信息
2605
+ */
2606
+ export interface UserInfo {
2607
+ /**
2608
+ * 用户在平台的编号
2609
+ */
2610
+ UserId?: string
2611
+ /**
2612
+ * 用户的来源渠道,一般不用传,特定场景根据接口说明传值
2613
+ * @deprecated
2614
+ */
2615
+ Channel?: string
2616
+ /**
2617
+ * 用户在渠道的编号,一般不用传,特定场景根据接口说明传值
2618
+ * @deprecated
2619
+ */
2620
+ OpenId?: string
2621
+ /**
2622
+ * 用户真实IP,内部字段,暂未开放
2623
+ * @deprecated
2624
+ */
2625
+ ClientIp?: string
2626
+ /**
2627
+ * 用户代理IP,内部字段,暂未开放
2628
+ * @deprecated
2629
+ */
2630
+ ProxyIp?: string
2631
+ }
2632
+
2633
+ /**
2634
+ * CreateFlowApprovers请求参数结构体
2635
+ */
2636
+ export interface CreateFlowApproversRequest {
2637
+ /**
2638
+ * 调用方用户信息,userId 必填
2639
+ */
2640
+ Operator: UserInfo
2641
+ /**
2642
+ * 签署流程编号
2643
+ */
2644
+ FlowId: string
2645
+ /**
2646
+ * 补充签署人信息
2647
+ */
2648
+ Approvers: Array<FillApproverInfo>
2649
+ /**
2650
+ * 企微消息中的发起人
2651
+ */
2652
+ Initiator?: string
2653
+ /**
2654
+ * 代理相关应用信息,如集团主企业代子企业操作
2655
+
2656
+
2657
+ */
2658
+ Agent?: Agent
2659
+ }
2660
+
2661
+ /**
2662
+ * ModifyIntegrationRole返回参数结构体
2663
+ */
2664
+ export interface ModifyIntegrationRoleResponse {
2665
+ /**
2666
+ * 角色id
2667
+ */
2668
+ RoleId?: string
2669
+ /**
2670
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2671
+ */
2672
+ RequestId?: string
2673
+ }
2674
+
2675
+ /**
2676
+ * 创建流程的签署方信息
2677
+ */
2678
+ export interface FlowCreateApprover {
2679
+ /**
2680
+ * 参与者类型:
2681
+ 0:企业
2682
+ 1:个人
2683
+ 3:企业自动签署
2684
+ 注:类型为3(企业自动签署)时,会自动完成该签署方的签署。
2685
+ 自动签署仅进行盖章操作,不能是手写签名。
2686
+ 本方企业自动签署的签署人会默认是当前的发起人
2687
+ 他方企业自动签署的签署人是自动签模板的他方企业授权人
2688
+ 7: 个人自动签署,适用于个人自动签场景。
2689
+ 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
2690
+ */
2691
+ ApproverType: number
2692
+ /**
2693
+ * 签署人企业名称
2694
+ 当approverType=0 或 approverType=3时,必须指定
2695
+
2696
+
2697
+ */
2698
+ OrganizationName?: string
2562
2699
  /**
2563
- * 控件填充vaule,ComponentType和传入值类型对应关系:
2564
- TEXT - 文本内容
2565
- MULTI_LINE_TEXT - 文本内容
2566
- CHECK_BOX - true/false
2567
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
2568
- SELECTOR - 选项值
2569
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
2700
+ * 签署方经办人姓名
2701
+ <br/>在未指定签署人电子签UserId情况下,为必填参数
2570
2702
  */
2571
- ComponentValue: string
2703
+ ApproverName?: string
2572
2704
  /**
2573
- * 控件id,和ComponentName选择一项传入即可
2705
+ * 签署方经办人手机号码
2706
+ <br/>在未指定签署人电子签UserId情况下,为必填参数
2707
+
2574
2708
  */
2575
- ComponentId?: string
2709
+ ApproverMobile?: string
2576
2710
  /**
2577
- * 控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可
2711
+ * 签署人的证件类型
2712
+ ID_CARD 身份证
2713
+ HONGKONG_AND_MACAO 港澳居民来往内地通行证
2714
+ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
2715
+ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
2578
2716
  */
2579
- ComponentName?: string
2580
- }
2717
+ ApproverIdCardType?: string
2718
+ /**
2719
+ * 签署人证件号(长度不超过18位)
2720
+ */
2721
+ ApproverIdCardNumber?: string
2722
+ /**
2723
+ * 签署方经办人在模板中的参与方ID
2724
+ <br/>模板发起合同时,该参数为必填项
2725
+ <br/>文件发起合同是,该参数无序传值
2581
2726
 
2582
- /**
2583
- * CreateChannelSubOrganizationModifyQrCode请求参数结构体
2584
- */
2585
- export interface CreateChannelSubOrganizationModifyQrCodeRequest {
2727
+ */
2728
+ RecipientId?: string
2586
2729
  /**
2587
- * 操作人信息,userId必填
2730
+ * 签署意愿确认渠道,WEIXINAPP:人脸识别
2588
2731
  */
2589
- Operator: UserInfo
2732
+ VerifyChannel?: Array<string>
2590
2733
  /**
2591
- * 应用编号
2734
+ * 是否发送短信
2735
+ <br/>sms--短信通知
2736
+ <br/>none--不通知
2737
+ <br/>默认为sms
2738
+ <br/>发起方=签署方时不发送短信
2592
2739
  */
2593
- ApplicationId: string
2594
- }
2595
-
2596
- /**
2597
- * 用户信息
2598
- */
2599
- export interface UserInfo {
2740
+ NotifyType?: string
2600
2741
  /**
2601
- * 用户在平台的编号
2742
+ * 合同强制需要阅读全文,无需传此参数
2743
+ */
2744
+ IsFullText?: boolean
2745
+ /**
2746
+ * 合同的强制预览时间:3~300s,未指定则按合同页数计算
2747
+ */
2748
+ PreReadTime?: number
2749
+ /**
2750
+ * 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
2751
+
2752
+ 若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息
2602
2753
  */
2603
2754
  UserId?: string
2604
2755
  /**
2605
- * 用户的来源渠道,一般不用传,特定场景根据接口说明传值
2606
- * @deprecated
2756
+ * 当前只支持true,默认为true
2607
2757
  */
2608
- Channel?: string
2758
+ Required?: boolean
2609
2759
  /**
2610
- * 用户在渠道的编号,一般不用传,特定场景根据接口说明传值
2611
- * @deprecated
2760
+ * 签署人用户来源,此参数仅针对企微用户开放
2761
+
2762
+ 企微侧用户请传入:WEWORKAPP
2612
2763
  */
2613
- OpenId?: string
2764
+ ApproverSource?: string
2614
2765
  /**
2615
- * 用户真实IP,内部字段,暂未开放
2616
- * @deprecated
2766
+ * 企业签署方或签标识,客户自定义,64位长度
2767
+ <br>用于发起含有或签签署人的合同。或签参与人必须有此字段。
2768
+ <br/>合同内不同或签参与人CustomApproverTag需要保证唯一。
2769
+ <br/>如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
2617
2770
  */
2618
- ClientIp?: string
2771
+ CustomApproverTag?: string
2619
2772
  /**
2620
- * 用户代理IP,内部字段,暂未开放
2773
+ * 快速注册相关信息,目前暂未开放!
2774
+ */
2775
+ RegisterInfo?: RegisterInfo
2776
+ /**
2777
+ * 签署人个性化能力值
2778
+ */
2779
+ ApproverOption?: ApproverOption
2780
+ /**
2781
+ * 签署完前端跳转的url,暂未使用
2621
2782
  * @deprecated
2622
2783
  */
2623
- ProxyIp?: string
2624
- }
2625
-
2626
- /**
2627
- * CreateFlowApprovers请求参数结构体
2628
- */
2629
- export interface CreateFlowApproversRequest {
2784
+ JumpUrl?: string
2630
2785
  /**
2631
- * 调用方用户信息,userId 必填
2786
+ * 签署ID
2787
+ - 发起流程时系统自动补充
2788
+ - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
2632
2789
  */
2633
- Operator: UserInfo
2790
+ SignId?: string
2634
2791
  /**
2635
- * 签署流程编号
2792
+ * 当前签署方进行签署操作是否需要企业内部审批
2793
+ <br>true 则为需要
2794
+ <br/>false,无序企业内部审批(默认)
2795
+ <br/>为个人签署方时则由发起方企业审核。
2636
2796
  */
2637
- FlowId: string
2797
+ ApproverNeedSignReview?: boolean
2638
2798
  /**
2639
- * 补充签署人信息
2799
+ * 签署人签署控件, 此参数仅针对文件发起(CreateFlowByFiles)生效
2800
+ <br/>文件发起时,可通过该参数为签署人指定签署控件类型以及位置
2640
2801
  */
2641
- Approvers: Array<FillApproverInfo>
2802
+ SignComponents?: Array<Component>
2642
2803
  /**
2643
- * 企微消息中的发起人
2804
+ * 签署人填写控件 此参数仅针对文件发起(CreateFlowByFiles)生效
2805
+ <br/>文件发起时,可通过该参数为签署人指定填写控件类型以及位置
2644
2806
  */
2645
- Initiator?: string
2807
+ Components?: Array<Component>
2646
2808
  /**
2647
- * 代理相关应用信息,如集团主企业代子企业操作
2809
+ * 签署方控件类型为 SIGN_SIGNATURE时,可以指定签署方签名方式
2810
+ HANDWRITE – 手写签名
2811
+ OCR_ESIGN -- AI智能识别手写签名
2812
+ ESIGN -- 个人印章类型
2813
+ SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
2814
+ */
2815
+ ComponentLimitType?: Array<string>
2816
+ /**
2817
+ * 合同查看方式<br/>默认1 -实名查看 <br/>2-短信验证码查看(企业签署方暂不支持该方式)
2648
2818
 
2819
+ > 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
2820
+ */
2821
+ ApproverVerifyTypes?: Array<number | bigint>
2822
+ /**
2823
+ * 合同签署方式(默认1,2) <br/>1-人脸认证 <br/>2-签署密码 <br/>3-运营商三要素
2649
2824
 
2825
+ > 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
2650
2826
  */
2651
- Agent?: Agent
2827
+ ApproverSignTypes?: Array<number | bigint>
2652
2828
  }
2653
2829
 
2654
2830
  /**
@@ -2784,18 +2960,13 @@ export interface CreateFlowEvidenceReportResponse {
2784
2960
  }
2785
2961
 
2786
2962
  /**
2787
- * DescribeFileUrls返回参数结构体
2963
+ * CreateIntegrationRole返回参数结构体
2788
2964
  */
2789
- export interface DescribeFileUrlsResponse {
2790
- /**
2791
- * 文件URL信息;
2792
- 链接不是永久链接,有效期5分钟后链接失效。
2793
- */
2794
- FileUrls?: Array<FileUrl>
2965
+ export interface CreateIntegrationRoleResponse {
2795
2966
  /**
2796
- * URL数量
2967
+ * 角色id
2797
2968
  */
2798
- TotalCount?: number
2969
+ RoleId?: string
2799
2970
  /**
2800
2971
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2801
2972
  */
@@ -3173,8 +3344,7 @@ export interface GetTaskResultApiRequest {
3173
3344
  */
3174
3345
  Operator?: UserInfo
3175
3346
  /**
3176
- * 应用号信息
3177
- * @deprecated
3347
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3178
3348
  */
3179
3349
  Agent?: Agent
3180
3350
  /**
@@ -3208,22 +3378,41 @@ MobileCheck:手机号验证
3208
3378
  }
3209
3379
 
3210
3380
  /**
3211
- * 发起流程快速注册相关信息
3381
+ * ModifyIntegrationRole请求参数结构体
3212
3382
  */
3213
- export interface RegisterInfo {
3383
+ export interface ModifyIntegrationRoleRequest {
3214
3384
  /**
3215
- * 法人姓名
3385
+ * 角色Id,可通过接口 DescribeIntegrationRoles 查询获取
3216
3386
  */
3217
- LegalName: string
3387
+ RoleId: string
3218
3388
  /**
3219
- * 社会统一信用代码
3220
- * @deprecated
3389
+ * 角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。
3221
3390
  */
3222
- Uscc?: string
3391
+ Name: string
3223
3392
  /**
3224
- * 社会统一信用代码
3393
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId。
3394
+ 支持填入集团子公司经办人 userId 代发合同。
3395
+
3396
+ 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3225
3397
  */
3226
- UnifiedSocialCreditCode?: string
3398
+ Operator: UserInfo
3399
+ /**
3400
+ * 角色描述,最大长度为50个字符
3401
+ */
3402
+ Description?: string
3403
+ /**
3404
+ * 权限树
3405
+ */
3406
+ PermissionGroups?: Array<PermissionGroup>
3407
+ /**
3408
+ * 集团角色的话,需要传递集团子企业列表,如果是全选,则传1
3409
+ */
3410
+ SubOrganizationIds?: Array<string>
3411
+ /**
3412
+ * 代理企业和员工的信息。
3413
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3414
+ */
3415
+ Agent?: Agent
3227
3416
  }
3228
3417
 
3229
3418
  /**
@@ -3579,6 +3768,10 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
3579
3768
  * 身份证件号码
3580
3769
  */
3581
3770
  IdCardNumber: string
3771
+ /**
3772
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3773
+ */
3774
+ Agent?: Agent
3582
3775
  }
3583
3776
 
3584
3777
  /**
@@ -3750,7 +3943,7 @@ export interface FailedCreateRoleData {
3750
3943
  }
3751
3944
 
3752
3945
  /**
3753
- * 参与者信息
3946
+ * 参与者信息。
3754
3947
  */
3755
3948
  export interface ApproverInfo {
3756
3949
  /**
@@ -3769,10 +3962,8 @@ export interface ApproverInfo {
3769
3962
  */
3770
3963
  ApproverName: string
3771
3964
  /**
3772
- * 本企业的签署方经办人的员工UserId
3773
- 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3774
-
3775
- 注: `若传该字段,则签署方经办人的其他信息(如签署方经办人的姓名、证件号码、手机号码等)将被忽略。`
3965
+ * 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
3966
+ 请确认手机号所有方为此合同签署方。
3776
3967
  */
3777
3968
  ApproverMobile: string
3778
3969
  /**
@@ -4234,6 +4425,11 @@ export interface IntegrateRole {
4234
4425
  注意:此字段可能返回 null,表示取不到有效值。
4235
4426
  */
4236
4427
  SubOrgIdList?: Array<string>
4428
+ /**
4429
+ * 权限树
4430
+ 注意:此字段可能返回 null,表示取不到有效值。
4431
+ */
4432
+ PermissionGroups?: Array<PermissionGroup>
4237
4433
  }
4238
4434
 
4239
4435
  /**
@@ -4444,7 +4640,7 @@ export interface CreatePrepareFlowRequest {
4444
4640
  */
4445
4641
  Operator: UserInfo
4446
4642
  /**
4447
- * 资源Id,通过多文件上传(UploadFiles)接口获得
4643
+ * 资源id,与ResourceType对应
4448
4644
  */
4449
4645
  ResourceId: string
4450
4646
  /**
@@ -4465,25 +4661,32 @@ false:顺序签
4465
4661
  Deadline?: number
4466
4662
  /**
4467
4663
  * 用户自定义合同类型Id
4468
- 该id为电子签企业内的合同类型id
4664
+
4665
+ 该id为电子签企业内的合同类型id, 可以在自定义合同类型处获取
4469
4666
  */
4470
4667
  UserFlowTypeId?: string
4668
+ /**
4669
+ * 合同类型名称
4670
+ 该字段用于客户自定义合同类型
4671
+ 建议使用时指定合同类型,便于之后合同分类以及查看
4672
+ 如果合同类型与自定义的合同类型描述一致,会自动归类到自定义的合同类型处,如果不一致,则会创建一个新的自定义合同类型
4673
+ */
4674
+ FlowType?: string
4471
4675
  /**
4472
4676
  * 签署流程参与者信息,最大限制50方
4473
4677
  */
4474
4678
  Approvers?: Array<FlowCreateApprover>
4475
4679
  /**
4476
4680
  * 打开智能添加填写区
4477
- (默认开启,打开:"OPEN"
4681
+ 默认开启,打开:"OPEN"
4478
4682
  关闭:"CLOSE"
4479
4683
  */
4480
4684
  IntelligentStatus?: string
4481
4685
  /**
4482
4686
  * 资源类型,
4483
- 1:文件,
4484
- 2:模板
4485
- 不传默认为1:文件
4486
- 目前仅支持文件
4687
+ 1:模板
4688
+ 2:文件,
4689
+ 不传默认为2:文件
4487
4690
  */
4488
4691
  ResourceType?: number
4489
4692
  /**
@@ -4519,12 +4722,6 @@ false:不开启发起方发起合同审核
4519
4722
  * 合同id,用于通过已web页面发起的合同id快速生成一个web发起合同链接
4520
4723
  */
4521
4724
  FlowId?: string
4522
- /**
4523
- * 合同类型名称
4524
- 该字段用于客户自定义合同类型
4525
- 建议使用时指定合同类型,便于之后合同分类以及查看
4526
- */
4527
- FlowType?: string
4528
4725
  /**
4529
4726
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4530
4727
  */
@@ -4638,6 +4835,46 @@ LEGAL_PERSON_SEAL:法定代表人章
4638
4835
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4639
4836
  */
4640
4837
  Agent?: Agent
4838
+ /**
4839
+ * 查询的印章状态列表。
4840
+ 取值为空,只查询启用状态的印章;
4841
+ 取值ALL,查询所有状态的印章;
4842
+ 取值CHECKING,查询待审核的印章;
4843
+ 取值SUCCESS,查询启用状态的印章;
4844
+ 取值FAIL,查询印章审核拒绝的印章;
4845
+ 取值DISABLE,查询已停用的印章;
4846
+ 取值STOPPED,查询已终止的印章;
4847
+ 取值VOID,查询已作废的印章;
4848
+ 取值INVALID,查询以失效的印章;
4849
+
4850
+ */
4851
+ SealStatuses?: Array<string>
4852
+ }
4853
+
4854
+ /**
4855
+ * 权限树中的权限组
4856
+ */
4857
+ export interface PermissionGroup {
4858
+ /**
4859
+ * 权限组名称
4860
+ 注意:此字段可能返回 null,表示取不到有效值。
4861
+ */
4862
+ GroupName?: string
4863
+ /**
4864
+ * 权限组key
4865
+ 注意:此字段可能返回 null,表示取不到有效值。
4866
+ */
4867
+ GroupKey?: string
4868
+ /**
4869
+ * 是否隐藏分组,0否1是
4870
+ 注意:此字段可能返回 null,表示取不到有效值。
4871
+ */
4872
+ Hide?: number
4873
+ /**
4874
+ * 权限集合
4875
+ 注意:此字段可能返回 null,表示取不到有效值。
4876
+ */
4877
+ Permissions?: Array<Permission>
4641
4878
  }
4642
4879
 
4643
4880
  /**
@@ -5123,7 +5360,7 @@ export interface VerifyPdfResponse {
5123
5360
  */
5124
5361
  VerifyResult?: number
5125
5362
  /**
5126
- * 验签结果详情,内部状态1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域;5-文件签名格式错误
5363
+ * 验签结果详情,每个签名域对应的验签结果。状态值:1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域;5-文件签名格式错误
5127
5364
  */
5128
5365
  PdfVerifyResults?: Array<PdfVerifyResult>
5129
5366
  /**
@@ -5417,13 +5654,15 @@ export interface CreateMultiFlowSignQRCodeRequest {
5417
5654
  */
5418
5655
  UserData?: string
5419
5656
  /**
5420
- * 回调地址,最大长度1000字符串
5421
- <br/>回调时机:用户通过签署二维码发起签署流程时,企业额度不足导致失败
5657
+ * 已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
5658
+ <br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
5659
+ <br/> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
5660
+
5661
+ * @deprecated
5422
5662
  */
5423
5663
  CallbackUrl?: string
5424
5664
  /**
5425
- * 应用信息
5426
- * @deprecated
5665
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5427
5666
  */
5428
5667
  Agent?: Agent
5429
5668
  /**
@@ -5580,62 +5819,60 @@ export interface FileUrl {
5580
5819
  }
5581
5820
 
5582
5821
  /**
5583
- * 流程信息摘要
5822
+ * 合同流程的基础信息
5584
5823
  */
5585
5824
  export interface FlowBrief {
5586
5825
  /**
5587
- * 流程的编号ID
5826
+ * 合同流程ID,为32位字符串。
5588
5827
  */
5589
5828
  FlowId?: string
5590
5829
  /**
5591
- * 流程的名称
5830
+ * 合同流程的名称。
5592
5831
  */
5593
5832
  FlowName?: string
5594
5833
  /**
5595
- * 流程的描述信息
5834
+ * 合同流程描述信息。
5596
5835
  注意:此字段可能返回 null,表示取不到有效值。
5597
5836
  */
5598
5837
  FlowDescription?: string
5599
5838
  /**
5600
- * 流程的类型
5839
+ * 合同流程的类别分类(如销售合同/入职合同等)。
5601
5840
  */
5602
5841
  FlowType?: string
5603
5842
  /**
5604
- * 流程状态
5605
- - 0 还没有发起
5606
- - 1 待签署
5607
- - 2 部分签署
5608
- - 3 已拒签
5609
- - 4 已签署
5610
- - 5 已过期
5611
- - 6 已撤销
5612
- - 7 还没有预发起
5613
- - 8 等待填写
5614
- - 9 部分填写
5615
- - 10 拒填
5616
- - 21 已解除
5843
+ * 合同流程当前的签署状态, 会存在下列的状态值
5844
+ <ul><li> **0** : 未开启流程(合同中不存在填写环节)</li>
5845
+ <li> **1** : 待签署</li>
5846
+ <li> **2** : 部分签署</li>
5847
+ <li> **3** : 已拒签</li>
5848
+ <li> **4** : 已签署</li>
5849
+ <li> **5** : 已过期</li>
5850
+ <li> **6** : 已撤销</li>
5851
+ <li> **7** : 未开启流程(合同中存在填写环节)</li>
5852
+ <li> **8** : 等待填写</li>
5853
+ <li> **9** : 部分填写</li>
5854
+ <li> **10** : 已拒填</li>
5855
+ <li> **21** : 已解除</li></ul>
5617
5856
  注意:此字段可能返回 null,表示取不到有效值。
5618
5857
  */
5619
5858
  FlowStatus?: number
5620
5859
  /**
5621
- * 流程创建的时间戳,单位秒
5860
+ * 合同流程创建时间,格式为Unix标准时间戳(秒)。
5622
5861
  注意:此字段可能返回 null,表示取不到有效值。
5623
5862
  */
5624
5863
  CreatedOn?: number
5625
5864
  /**
5626
- * 当合同被拒签或者取消后(当FlowStatus=3或者FlowStatus=6的时候)
5627
- 此字段展示拒签或者取消的原因描述
5628
-
5865
+ * 当合同流程状态为已拒签(即 FlowStatus=3)或已撤销(即 FlowStatus=6)时,此字段 FlowMessage 为拒签或撤销原因。
5629
5866
  注意:此字段可能返回 null,表示取不到有效值。
5630
5867
  */
5631
5868
  FlowMessage?: string
5632
5869
  /**
5633
- * 合同发起人userId
5870
+ * 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
5634
5871
  注意:此字段可能返回 null,表示取不到有效值。
5635
5872
  */
5636
5873
  Creator?: string
5637
5874
  /**
5638
- * 合同过期时间,时间戳,单位秒
5875
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒)。
5639
5876
  注意:此字段可能返回 null,表示取不到有效值。
5640
5877
  */
5641
5878
  Deadline?: number