tencentcloud-sdk-nodejs-ess 4.0.722 → 4.0.724

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.
@@ -11,6 +11,69 @@ export interface DescribePersonCertificateResponse {
11
11
  */
12
12
  RequestId?: string;
13
13
  }
14
+ /**
15
+ * 用户计费使用情况详情
16
+ */
17
+ export interface BillUsageDetail {
18
+ /**
19
+ * 合同流程ID,为32位字符串。
20
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
21
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
22
+ 注意:此字段可能返回 null,表示取不到有效值。
23
+ */
24
+ FlowId?: string;
25
+ /**
26
+ * 经办人名称
27
+ 注意:此字段可能返回 null,表示取不到有效值。
28
+ */
29
+ OperatorName?: string;
30
+ /**
31
+ * 发起方组织机构名称
32
+ 注意:此字段可能返回 null,表示取不到有效值。
33
+ */
34
+ CreateOrganizationName?: string;
35
+ /**
36
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
37
+ 该名称还将用于合同签署完成后的下载文件名。
38
+ 注意:此字段可能返回 null,表示取不到有效值。
39
+ */
40
+ FlowName?: string;
41
+ /**
42
+ * 0 还没有发起 1等待签署 2部分签署 3拒签 4已签署 5已过期 6已撤销 7还没有预发起 8等待填写 9部分填写 10拒填 11已解除
43
+ 注意:此字段可能返回 null,表示取不到有效值。
44
+ */
45
+ Status?: number;
46
+ /**
47
+ * 套餐类型
48
+ 注意:此字段可能返回 null,表示取不到有效值。
49
+ */
50
+ QuotaType?: string;
51
+ /**
52
+ * 合同使用量
53
+ 注意:此字段可能返回 null,表示取不到有效值。
54
+ */
55
+ UseCount?: number;
56
+ /**
57
+ * 消耗的时间戳
58
+ 注意:此字段可能返回 null,表示取不到有效值。
59
+ */
60
+ CostTime?: number;
61
+ /**
62
+ * 套餐名称
63
+ 注意:此字段可能返回 null,表示取不到有效值。
64
+ */
65
+ QuotaName?: string;
66
+ /**
67
+ * 消耗类型 1.扣费 2.撤销返还
68
+ 注意:此字段可能返回 null,表示取不到有效值。
69
+ */
70
+ CostType?: number;
71
+ /**
72
+ * 备注
73
+ 注意:此字段可能返回 null,表示取不到有效值。
74
+ */
75
+ Remark?: string;
76
+ }
14
77
  /**
15
78
  * CreateSeal请求参数结构体
16
79
  */
@@ -42,7 +105,7 @@ export interface CreateSealRequest {
42
105
  * 电子印章类型 , 可选类型如下:
43
106
  <ul><li>**OFFICIAL**: (默认)公章</li>
44
107
  <li>**CONTRACT**: 合同专用章;</li>
45
- <li>**FINANCE**: 合财务专用章;</li>
108
+ <li>**FINANCE**: 财务专用章;</li>
46
109
  <li>**PERSONNEL**: 人事专用章</li>
47
110
  </ul>
48
111
  注: `同企业下只能有一个公章, 重复创建会报错`
@@ -332,12 +395,10 @@ export interface CreateExtendedServiceAuthInfosRequest {
332
395
  */
333
396
  UserIds: Array<string>;
334
397
  /**
335
- * 要查询的扩展服务类型。
336
- 默认为空,即查询当前支持的所有扩展服务信息。
337
- 若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
398
+ * 取值
338
399
  <ul><li>OPEN_SERVER_SIGN:企业自动签</li>
400
+ <li>BATCH_SIGN:批量签署</li>
339
401
  </ul>
340
-
341
402
  */
342
403
  ExtendServiceType?: string;
343
404
  /**
@@ -373,36 +434,38 @@ export interface CreateMultiFlowSignQRCodeResponse {
373
434
  RequestId?: string;
374
435
  }
375
436
  /**
376
- * 签署链接信息
437
+ * 签署链接信息。
377
438
  */
378
439
  export interface FlowApproverUrlInfo {
379
440
  /**
380
- * 签署链接(短链形式呈现)。请注意保密,不要将其外泄给无关用户。
381
- 注: `注意该链接有效期为30分钟`
441
+ * 签署短链接。</br>
442
+ 注意:
443
+ - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
444
+ - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
382
445
  注意:此字段可能返回 null,表示取不到有效值。
383
446
  */
384
447
  SignUrl?: string;
385
448
  /**
386
- * 签署参与人类型
387
- <ul><li> **1** :个人参与方</li></ul>
388
-
389
- 注: `现在仅支持个人参与方`
449
+ * 签署人类型。
450
+ - **1**: 个人
390
451
  注意:此字段可能返回 null,表示取不到有效值。
391
452
  */
392
453
  ApproverType?: number;
393
454
  /**
394
- * 签署人姓名
455
+ * 签署人姓名。
395
456
  注意:此字段可能返回 null,表示取不到有效值。
396
457
  */
397
458
  ApproverName?: string;
398
459
  /**
399
- * 签署人手机号
460
+ * 签署人手机号。
400
461
  注意:此字段可能返回 null,表示取不到有效值。
401
462
  */
402
463
  ApproverMobile?: string;
403
464
  /**
404
- * 签署链接(长链形式呈现)。请注意保密,不要将其外泄给无关用户。
405
- 注: `注意该链接有效期为30分钟`
465
+ * 签署长链接。</br>
466
+ 注意:
467
+ - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
468
+ - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
406
469
  注意:此字段可能返回 null,表示取不到有效值。
407
470
  */
408
471
  LongUrl?: string;
@@ -1419,6 +1482,7 @@ export interface DescribeIntegrationEmployeesRequest {
1419
1482
  <li>Key:**"UserId"**,根据用户ID查询员工,Values为指定的用户ID:**["UserId"]**</li>
1420
1483
  <li>Key:**"UserWeWorkOpenId"**,根据用户企微账号ID查询员工,Values为指定用户的企微账号ID:**["UserWeWorkOpenId"]**</li>
1421
1484
  <li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
1485
+ <li>Key:**"RoleId"**,根据电子签角色ID查询员工,Values为指定的角色ID,满足其中任意一个角色即可:**["RoleId1","RoleId2",...]**</li>
1422
1486
  </ul>
1423
1487
  */
1424
1488
  Filters?: Array<Filter>;
@@ -1852,6 +1916,20 @@ export interface Permission {
1852
1916
  */
1853
1917
  Children?: Array<Permission>;
1854
1918
  }
1919
+ /**
1920
+ * DescribeFlowBriefs返回参数结构体
1921
+ */
1922
+ export interface DescribeFlowBriefsResponse {
1923
+ /**
1924
+ * 合同流程基础信息列表,包含流程的名称、状态、创建日期等基本信息。
1925
+ 注:`与入参 FlowIds 的顺序可能存在不一致的情况。`
1926
+ */
1927
+ FlowBriefs?: Array<FlowBrief>;
1928
+ /**
1929
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1930
+ */
1931
+ RequestId?: string;
1932
+ }
1855
1933
  /**
1856
1934
  * 企业员工信息。
1857
1935
  */
@@ -2294,47 +2372,57 @@ export interface PdfVerifyResult {
2294
2372
  */
2295
2373
  VerifyResult?: number;
2296
2374
  /**
2297
- * 签署平台,如果文件是在腾讯电子签平台签署,则返回腾讯电子签,如果文件不在腾讯电子签平台签署,则返回其他平台。
2375
+ * 签署平台
2376
+ 如果文件是在腾讯电子签平台签署,则为**腾讯电子签**,
2377
+ 如果文件不在腾讯电子签平台签署,则为**其他平台**。
2298
2378
  */
2299
2379
  SignPlatform?: string;
2300
2380
  /**
2301
- * 签署人名称
2381
+ * 申请证书的主体的名字
2382
+
2383
+ 如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
2384
+ **企业**: ESS@企业名称@编码
2385
+ **个人**: ESS@个人姓名@证件号@808854
2386
+
2387
+ 如果在其他平台签署的, 主体的名字参考其他平台的说明
2302
2388
  */
2303
2389
  SignerName?: string;
2304
2390
  /**
2305
- * 签署时间戳,单位秒
2391
+ * 签署时间的Unix时间戳,单位毫秒
2306
2392
  */
2307
2393
  SignTime?: number;
2308
2394
  /**
2309
- * 签名算法
2395
+ * 证书签名算法, 如SHA1withRSA等算法
2310
2396
  */
2311
2397
  SignAlgorithm?: string;
2312
2398
  /**
2313
- * 签名证书序列号
2399
+ * CA供应商下发给用户的证书编号
2400
+
2401
+ 注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下`。
2314
2402
  */
2315
2403
  CertSn?: string;
2316
2404
  /**
2317
- * 证书起始时间戳,单位毫秒
2405
+ * 证书起始时间的Unix时间戳,单位毫秒
2318
2406
  */
2319
2407
  CertNotBefore?: number;
2320
2408
  /**
2321
- * 证书过期时间戳,单位毫秒
2409
+ * 证书过期时间的时间戳,单位毫秒
2322
2410
  */
2323
2411
  CertNotAfter?: number;
2324
2412
  /**
2325
- * 签名域横坐标,单位pt
2413
+ * 签名域横坐标,单位px
2326
2414
  */
2327
2415
  ComponentPosX?: number;
2328
2416
  /**
2329
- * 签名域纵坐标,单位pt
2417
+ * 签名域纵坐标,单位px
2330
2418
  */
2331
2419
  ComponentPosY?: number;
2332
2420
  /**
2333
- * 签名域宽度,单位pt
2421
+ * 签名域宽度,单位px
2334
2422
  */
2335
2423
  ComponentWidth?: number;
2336
2424
  /**
2337
- * 签名域高度,单位pt
2425
+ * 签名域高度,单位px
2338
2426
  */
2339
2427
  ComponentHeight?: number;
2340
2428
  /**
@@ -2598,47 +2686,151 @@ export interface CreateSchemeUrlResponse {
2598
2686
  RequestId?: string;
2599
2687
  }
2600
2688
  /**
2601
- * CreateUserAutoSignEnableUrl返回参数结构体
2689
+ * CreateFlowByFiles请求参数结构体
2602
2690
  */
2603
- export interface CreateUserAutoSignEnableUrlResponse {
2691
+ export interface CreateFlowByFilesRequest {
2604
2692
  /**
2605
- * 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
2693
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId。
2694
+ 支持填入集团子公司经办人 userId 代发合同。
2695
+
2696
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2606
2697
  */
2607
- Url?: string;
2698
+ Operator: UserInfo;
2608
2699
  /**
2609
- * 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
2700
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
2610
2701
 
2611
- 注: `如果获取的是H5链接, 则不会返回此值`
2702
+ 该名称还将用于合同签署完成后的下载文件名。
2612
2703
  */
2613
- AppId?: string;
2704
+ FlowName: string;
2614
2705
  /**
2615
- * 腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
2706
+ * 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
2616
2707
 
2617
- 注: `如果获取的是H5链接, 则不会返回此值`
2708
+ 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
2618
2709
  */
2619
- AppOriginalId?: string;
2710
+ Approvers: Array<ApproverInfo>;
2620
2711
  /**
2621
- * 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
2712
+ * 本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
2622
2713
 
2623
- 注: `如果获取的是H5链接, 则不会返回此值`
2714
+ 注: `目前,此接口仅支持单个文件发起。`
2624
2715
  */
2625
- Path?: string;
2716
+ FileIds: Array<string>;
2626
2717
  /**
2627
- * base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
2718
+ * 合同流程描述信息(可自定义此描述),最大长度1000个字符。
2719
+ */
2720
+ FlowDescription?: string;
2721
+ /**
2722
+ * 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
2723
+ */
2724
+ FlowType?: string;
2725
+ /**
2726
+ * 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
2727
+ <ul><li> 单行文本控件 </li>
2728
+ <li> 多行文本控件 </li>
2729
+ <li> 勾选框控件 </li>
2730
+ <li> 数字控件 </li>
2731
+ <li> 图片控件 </li>
2732
+ <li> 动态表格等填写控件</li></ul>
2733
+ */
2734
+ Components?: Array<Component>;
2735
+ /**
2736
+ * 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
2628
2737
 
2629
- 注: `如果获取的是H5链接, 则不会返回此二维码图片`
2630
2738
  */
2631
- QrCode?: string;
2739
+ CcInfos?: Array<CcInfo>;
2632
2740
  /**
2633
- * 返回的链接类型
2634
- <ul><li> 空: 默认小程序端链接</li>
2635
- <li> **H5SIGN** : h5端链接</li></ul>
2741
+ * 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
2742
+ <ul><li> **0**:合同发起时通知(默认值)</li>
2743
+ <li> **1**:签署完成后通知</li></ul>
2636
2744
  */
2637
- UrlType?: string;
2745
+ CcNotifyType?: number;
2638
2746
  /**
2639
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2747
+ * 是否为预览模式,取值如下:
2748
+ <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
2749
+ <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
2640
2750
  */
2641
- RequestId?: string;
2751
+ NeedPreview?: boolean;
2752
+ /**
2753
+ * 预览模式下产生的预览链接类型
2754
+ <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
2755
+ <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
2756
+ 注: `此参数在NeedPreview 为true时有效`
2757
+
2758
+ */
2759
+ PreviewType?: number;
2760
+ /**
2761
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
2762
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
2763
+ */
2764
+ Deadline?: number;
2765
+ /**
2766
+ * 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
2767
+
2768
+ 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
2769
+ */
2770
+ RemindedOn?: number;
2771
+ /**
2772
+ * 合同流程的签署顺序类型:
2773
+ <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
2774
+ <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
2775
+ */
2776
+ Unordered?: boolean;
2777
+ /**
2778
+ * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
2779
+ <ul><li>{合同名称} </li>
2780
+ <li>{发起方企业} </li>
2781
+ <li>{发起方姓名} </li>
2782
+ <li>{签署方N企业}</li>
2783
+ <li>{签署方N姓名}</li></ul>
2784
+ 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
2785
+
2786
+ 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
2787
+
2788
+ 合同名称:租房合同
2789
+ 发起方:腾讯公司(张三)
2790
+ 签署方:李四
2791
+
2792
+
2793
+ */
2794
+ CustomShowMap?: string;
2795
+ /**
2796
+ * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
2797
+ <ul><li> **false**:(默认)不需要审批,直接签署。</li>
2798
+ <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
2799
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
2800
+ <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
2801
+ <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
2802
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
2803
+ */
2804
+ NeedSignReview?: boolean;
2805
+ /**
2806
+ * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
2807
+
2808
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
2809
+ */
2810
+ UserData?: string;
2811
+ /**
2812
+ * 指定个人签署方查看合同的校验方式
2813
+ <ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
2814
+ <li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>
2815
+ */
2816
+ ApproverVerifyType?: string;
2817
+ /**
2818
+ * 签署方签署控件(印章/签名等)的生成方式:
2819
+ <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
2820
+ <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
2821
+ */
2822
+ SignBeanTag?: number;
2823
+ /**
2824
+ * 代理企业和员工的信息。
2825
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2826
+ */
2827
+ Agent?: Agent;
2828
+ /**
2829
+ * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
2830
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
2831
+ 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
2832
+ */
2833
+ AutoSignScene?: string;
2642
2834
  }
2643
2835
  /**
2644
2836
  * 此结构体(FlowGroupInfo)描述的是合同组(流程组)的单个合同(流程)信息
@@ -3945,153 +4137,6 @@ export interface DeleteIntegrationRoleUsersRequest {
3945
4137
  */
3946
4138
  Agent?: Agent;
3947
4139
  }
3948
- /**
3949
- * CreateFlowByFiles请求参数结构体
3950
- */
3951
- export interface CreateFlowByFilesRequest {
3952
- /**
3953
- * 执行本接口操作的员工信息。使用此接口时,必须填写userId。
3954
- 支持填入集团子公司经办人 userId 代发合同。
3955
-
3956
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3957
- */
3958
- Operator: UserInfo;
3959
- /**
3960
- * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
3961
-
3962
- 该名称还将用于合同签署完成后的下载文件名。
3963
- */
3964
- FlowName: string;
3965
- /**
3966
- * 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
3967
-
3968
- 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
3969
- */
3970
- Approvers: Array<ApproverInfo>;
3971
- /**
3972
- * 本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
3973
-
3974
- 注: `目前,此接口仅支持单个文件发起。`
3975
- */
3976
- FileIds: Array<string>;
3977
- /**
3978
- * 合同流程描述信息(可自定义此描述),最大长度1000个字符。
3979
- */
3980
- FlowDescription?: string;
3981
- /**
3982
- * 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
3983
- */
3984
- FlowType?: string;
3985
- /**
3986
- * 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
3987
- <ul><li> 单行文本控件 </li>
3988
- <li> 多行文本控件 </li>
3989
- <li> 勾选框控件 </li>
3990
- <li> 数字控件 </li>
3991
- <li> 图片控件 </li>
3992
- <li> 动态表格等填写控件</li></ul>
3993
- */
3994
- Components?: Array<Component>;
3995
- /**
3996
- * 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
3997
-
3998
- */
3999
- CcInfos?: Array<CcInfo>;
4000
- /**
4001
- * 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
4002
- <ul><li> **0**:合同发起时通知(默认值)</li>
4003
- <li> **1**:签署完成后通知</li></ul>
4004
- */
4005
- CcNotifyType?: number;
4006
- /**
4007
- * 是否为预览模式,取值如下:
4008
- <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
4009
- <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
4010
- */
4011
- NeedPreview?: boolean;
4012
- /**
4013
- * 预览模式下产生的预览链接类型
4014
- <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
4015
- <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
4016
- 注: `此参数在NeedPreview 为true时有效`
4017
-
4018
- */
4019
- PreviewType?: number;
4020
- /**
4021
- * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
4022
- 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
4023
- */
4024
- Deadline?: number;
4025
- /**
4026
- * 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
4027
-
4028
- 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
4029
- */
4030
- RemindedOn?: number;
4031
- /**
4032
- * 合同流程的签署顺序类型:
4033
- <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
4034
- <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
4035
- */
4036
- Unordered?: boolean;
4037
- /**
4038
- * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
4039
- <ul><li>{合同名称} </li>
4040
- <li>{发起方企业} </li>
4041
- <li>{发起方姓名} </li>
4042
- <li>{签署方N企业}</li>
4043
- <li>{签署方N姓名}</li></ul>
4044
- 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
4045
-
4046
- 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
4047
-
4048
- 合同名称:租房合同
4049
- 发起方:腾讯公司(张三)
4050
- 签署方:李四
4051
-
4052
-
4053
- */
4054
- CustomShowMap?: string;
4055
- /**
4056
- * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
4057
- <ul><li> **false**:(默认)不需要审批,直接签署。</li>
4058
- <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
4059
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
4060
- <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
4061
- <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
4062
- 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
4063
- */
4064
- NeedSignReview?: boolean;
4065
- /**
4066
- * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
4067
-
4068
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
4069
- */
4070
- UserData?: string;
4071
- /**
4072
- * 指定个人签署方查看合同的校验方式
4073
- <ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
4074
- <li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>
4075
- */
4076
- ApproverVerifyType?: string;
4077
- /**
4078
- * 签署方签署控件(印章/签名等)的生成方式:
4079
- <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
4080
- <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
4081
- */
4082
- SignBeanTag?: number;
4083
- /**
4084
- * 代理企业和员工的信息。
4085
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4086
- */
4087
- Agent?: Agent;
4088
- /**
4089
- * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
4090
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
4091
- 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
4092
- */
4093
- AutoSignScene?: string;
4094
- }
4095
4140
  /**
4096
4141
  * CreateFlowSignUrl请求参数结构体
4097
4142
  */
@@ -6020,6 +6065,66 @@ export interface CreateFlowGroupByTemplatesRequest {
6020
6065
  */
6021
6066
  FlowGroupOptions?: FlowGroupOptions;
6022
6067
  }
6068
+ /**
6069
+ * DescribeBillUsageDetail返回参数结构体
6070
+ */
6071
+ export interface DescribeBillUsageDetailResponse {
6072
+ /**
6073
+ * 总数
6074
+ */
6075
+ Total?: number;
6076
+ /**
6077
+ * 消耗详情
6078
+ */
6079
+ Details?: Array<BillUsageDetail>;
6080
+ /**
6081
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6082
+ */
6083
+ RequestId?: string;
6084
+ }
6085
+ /**
6086
+ * CreateUserAutoSignEnableUrl返回参数结构体
6087
+ */
6088
+ export interface CreateUserAutoSignEnableUrlResponse {
6089
+ /**
6090
+ * 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
6091
+ */
6092
+ Url?: string;
6093
+ /**
6094
+ * 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
6095
+
6096
+ 注: `如果获取的是H5链接, 则不会返回此值`
6097
+ */
6098
+ AppId?: string;
6099
+ /**
6100
+ * 腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
6101
+
6102
+ 注: `如果获取的是H5链接, 则不会返回此值`
6103
+ */
6104
+ AppOriginalId?: string;
6105
+ /**
6106
+ * 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
6107
+
6108
+ 注: `如果获取的是H5链接, 则不会返回此值`
6109
+ */
6110
+ Path?: string;
6111
+ /**
6112
+ * base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
6113
+
6114
+ 注: `如果获取的是H5链接, 则不会返回此二维码图片`
6115
+ */
6116
+ QrCode?: string;
6117
+ /**
6118
+ * 返回的链接类型
6119
+ <ul><li> 空: 默认小程序端链接</li>
6120
+ <li> **H5SIGN** : h5端链接</li></ul>
6121
+ */
6122
+ UrlType?: string;
6123
+ /**
6124
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6125
+ */
6126
+ RequestId?: string;
6127
+ }
6023
6128
  /**
6024
6129
  * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。
6025
6130
  通过链接,用户可直接访问电子签名小程序并签署合同。
@@ -6092,18 +6197,49 @@ export interface DeleteStaffsResult {
6092
6197
  FailedEmployeeData: Array<FailedDeleteStaffData>;
6093
6198
  }
6094
6199
  /**
6095
- * DescribeFlowBriefs返回参数结构体
6200
+ * DescribeBillUsageDetail请求参数结构体
6096
6201
  */
6097
- export interface DescribeFlowBriefsResponse {
6202
+ export interface DescribeBillUsageDetailRequest {
6098
6203
  /**
6099
- * 合同流程基础信息列表,包含流程的名称、状态、创建日期等基本信息。
6100
- 注:`与入参 FlowIds 的顺序可能存在不一致的情况。`
6204
+ * 查询开始时间,时间跨度不能大于31天
6101
6205
  */
6102
- FlowBriefs?: Array<FlowBrief>;
6206
+ StartTime: string;
6103
6207
  /**
6104
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6208
+ * 查询结束时间,时间跨度不能大于31天
6105
6209
  */
6106
- RequestId?: string;
6210
+ EndTime: string;
6211
+ /**
6212
+ * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
6213
+ */
6214
+ Offset: number;
6215
+ /**
6216
+ * 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
6217
+ */
6218
+ Limit?: number;
6219
+ /**
6220
+ * 查询的套餐类型 (选填 )不传则查询所有套餐;
6221
+ 对应关系如下
6222
+ CloudEnterprise-企业版合同
6223
+ SingleSignature-单方签章
6224
+ CloudProve-签署报告
6225
+ CloudOnlineSign-腾讯会议在线签约
6226
+ ChannelWeCard-微工卡
6227
+ SignFlow-合同套餐
6228
+ SignFace-签署意愿(人脸识别)
6229
+ SignPassword-签署意愿(密码)
6230
+ SignSMS-签署意愿(短信)
6231
+ PersonalEssAuth-签署人实名(腾讯电子签认证)
6232
+ PersonalThirdAuth-签署人实名(信任第三方认证)
6233
+ OrgEssAuth-签署企业实名
6234
+ FlowNotify-短信通知
6235
+ AuthService-企业工商信息查询
6236
+ */
6237
+ QuotaType?: string;
6238
+ /**
6239
+ * 非必填,查询某个渠道企业的消耗情况。
6240
+ 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6241
+ */
6242
+ Agent?: Agent;
6107
6243
  }
6108
6244
  /**
6109
6245
  * 企业超管信息
@@ -6422,12 +6558,10 @@ export interface DeleteExtendedServiceAuthInfosRequest {
6422
6558
  */
6423
6559
  UserIds: Array<string>;
6424
6560
  /**
6425
- * 要查询的扩展服务类型。
6426
- 默认为空,即查询当前支持的所有扩展服务信息。
6427
- 若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
6561
+ * 取值如下所示:
6428
6562
  <ul><li>OPEN_SERVER_SIGN:企业自动签</li>
6563
+ <li>BATCH_SIGN:批量签署</li>
6429
6564
  </ul>
6430
-
6431
6565
  */
6432
6566
  ExtendServiceType?: string;
6433
6567
  /**