tencentcloud-sdk-nodejs-essbasic 4.0.711 → 4.0.713

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.
@@ -25,7 +25,7 @@ export interface ChannelCreateConvertTaskApiResponse {
25
25
  */
26
26
  export interface ChannelCreateFlowRemindsResponse {
27
27
  /**
28
- * 合同催办详情信息
28
+ * 合同催办结果的详细信息列表。
29
29
  */
30
30
  RemindFlowRecords?: Array<RemindFlowRecords>;
31
31
  /**
@@ -39,7 +39,7 @@ export interface ChannelCreateFlowRemindsResponse {
39
39
  在通过文件发起合同时,对应的component有三种定位方式
40
40
  1. 绝对定位方式
41
41
  2. 表单域(FIELD)定位方式
42
- 3. 关键字(KEYWORD)定位方式
42
+ 3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找
43
43
  可以参考官网说明
44
44
  https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
45
45
  */
@@ -103,7 +103,7 @@ export interface Component {
103
103
  * 控件生成的方式:
104
104
  NORMAL - 普通控件
105
105
  FIELD - 表单域
106
- KEYWORD - 关键字
106
+ KEYWORD - 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)
107
107
  */
108
108
  GenerateMode?: string;
109
109
  /**
@@ -397,11 +397,15 @@ export interface CommonApproverOption {
397
397
  */
398
398
  export interface ChannelCreateFlowGroupByTemplatesResponse {
399
399
  /**
400
- * 合同组ID
400
+ * 合同组ID,为32位字符串。
401
+ 建议开发者妥善保存此合同组ID,以便于顺利进行后续操作。
401
402
  */
402
403
  FlowGroupId?: string;
403
404
  /**
404
- * 子合同ID列表
405
+ * 合同组中每个合同流程ID,每个ID均为32位字符串。
406
+
407
+ 注:
408
+ `此数组的顺序和入参中的FlowInfos顺序回不一致`
405
409
  */
406
410
  FlowIds?: Array<string>;
407
411
  /**
@@ -456,13 +460,15 @@ export interface ChannelCreateFlowSignReviewRequest {
456
460
  */
457
461
  export interface AuthFailMessage {
458
462
  /**
459
- * 第三方应用平台的子客企业OpenId
463
+ * 第三方平台子客企业的唯一标识,长度不能超过64,只能由字母和数字组成。开发者可自定义此字段的值,并需要保存此 ID 以便进行后续操作。
464
+
465
+ 一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。例如,可以使用企业名称的哈希值,或者社会统一信用代码的哈希值,或者随机哈希值。
460
466
  */
461
- ProxyOrganizationOpenId: string;
467
+ ProxyOrganizationOpenId?: string;
462
468
  /**
463
469
  * 错误信息
464
470
  */
465
- Message: string;
471
+ Message?: string;
466
472
  }
467
473
  /**
468
474
  * DescribeFlowDetailInfo请求参数结构体
@@ -569,21 +575,21 @@ export interface CreateChannelOrganizationInfoChangeUrlResponse {
569
575
  RequestId?: string;
570
576
  }
571
577
  /**
572
- * 催办接口返回详细信息
578
+ * 催办接口返回的详细信息。
573
579
  */
574
580
  export interface RemindFlowRecords {
575
581
  /**
576
- * 是否能够催办,true-是,false-否
582
+ * 合同流程是否可以催办: true - 可以,false - 不可以。 若无法催办,将返回RemindMessage以解释原因。
577
583
  */
578
- CanRemind: boolean;
584
+ CanRemind?: boolean;
579
585
  /**
580
- * 合同id
586
+ * 合同流程ID,为32位字符串。
581
587
  */
582
- FlowId: string;
588
+ FlowId?: string;
583
589
  /**
584
- * 催办详情信息
590
+ * 在合同流程无法催办的情况下,系统将返回RemindMessage以阐述原因。
585
591
  */
586
- RemindMessage: string;
592
+ RemindMessage?: string;
587
593
  }
588
594
  /**
589
595
  * ChannelCreateFlowSignUrl返回参数结构体
@@ -667,27 +673,33 @@ export interface OperateChannelTemplateResponse {
667
673
  */
668
674
  AppId?: string;
669
675
  /**
670
- * 第三方应用平台模板库模板唯一标识
676
+ * 合同模板ID,为32位字符串。此处为第三方应用平台模板库模板ID,非子客模板ID。
671
677
  注意:此字段可能返回 null,表示取不到有效值。
672
678
  */
673
679
  TemplateId?: string;
674
680
  /**
675
681
  * 描述模板可见性更改的结果,和参数中Available无关。
676
- 全部成功-"all-success",
677
- 部分成功-"part-success",
678
- 全部失败-"fail",失败的会在FailMessageList中展示。
682
+ <ul>
683
+ <li>全部成功-"all-success"</li>
684
+ <li>部分成功-"part-success"</li>
685
+ <li>全部失败-"fail",失败的会在FailMessageList中展示</li>
686
+ </ul>
679
687
  注意:此字段可能返回 null,表示取不到有效值。
680
688
  */
681
689
  OperateResult?: string;
682
690
  /**
683
691
  * 模板可见性,
684
- 全部可见-"all",
685
- 部分可见-"part"
692
+ <ul>
693
+ <li>全部可见-"all"</li>
694
+ <li>部分可见-"part"</li>
695
+ </ul>
686
696
  注意:此字段可能返回 null,表示取不到有效值。
687
697
  */
688
698
  AuthTag?: string;
689
699
  /**
690
- * 合作企业方第三方机构唯一标识数据
700
+ * 第三方平台子客企业的唯一标识,长度不能超过64,只能由字母和数字组成。开发者可自定义此字段的值,并需要保存此 ID 以便进行后续操作。
701
+
702
+ 一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。例如,可以使用企业名称的哈希值,或者社会统一信用代码的哈希值,或者随机哈希值。
691
703
  注意:此字段可能返回 null,表示取不到有效值。
692
704
  */
693
705
  ProxyOrganizationOpenIds?: Array<string>;
@@ -1092,11 +1104,18 @@ export interface ChannelCreatePrepareFlowRequest {
1092
1104
  */
1093
1105
  export interface ChannelCreateFlowRemindsRequest {
1094
1106
  /**
1095
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
1107
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1108
+
1109
+ 此接口下面信息必填。
1110
+ <ul>
1111
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
1112
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
1113
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
1114
+ </ul>
1096
1115
  */
1097
1116
  Agent: Agent;
1098
1117
  /**
1099
- * 签署流程Id数组,最多100个,超过100不处理
1118
+ * 需执行催办的签署流程ID数组,最多包含100个。
1100
1119
  */
1101
1120
  FlowIds: Array<string>;
1102
1121
  }
@@ -1487,26 +1506,37 @@ export interface DescribeResourceUrlsByFlowsResponse {
1487
1506
  */
1488
1507
  export interface ChannelCreateFlowGroupByFilesRequest {
1489
1508
  /**
1490
- * 每个子合同的发起所需的信息,数量限制2-50
1509
+ * 合同组中每个合同签署流程的信息,合同组中最少包含2个合同,不能超过50个合同。
1491
1510
  */
1492
1511
  FlowFileInfos: Array<FlowFileInfo>;
1493
1512
  /**
1494
- * 合同组名称,长度不超过200个字符
1513
+ * 合同组的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
1495
1514
  */
1496
1515
  FlowGroupName: string;
1497
1516
  /**
1498
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
1517
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1518
+
1519
+ 此接口下面信息必填。
1520
+ <ul>
1521
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
1522
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
1523
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
1524
+ </ul>
1525
+
1526
+ 子客企业和子客企业中的员工比较走完创建和实名过程
1499
1527
  */
1500
1528
  Agent?: Agent;
1501
1529
  /**
1502
- * 签署人校验方式
1503
- VerifyCheck: 人脸识别(默认)
1504
- MobileCheck:手机号验证
1505
- 参数说明:若选择后者,未实名的个人签署方查看合同时,无需进行人脸识别实名认证(但签署合同时仍然需要人脸实名),该能力仅适用于个人签署方。
1530
+ * 合同组中签署人校验和认证的方式:
1531
+ <ul><li>**VerifyCheck**:人脸识别(默认)</li>
1532
+ <li>**MobileCheck**:手机号验证</li></ul>
1533
+ 注意:
1534
+ `1. MobileCheck 方式,未实名的个人/自然人签署方无需进行人脸识别实名认证即可查看合同(但签署合同时仍然需要人脸实名),企业签署方需经过人脸认证。`
1535
+ `2. 合同组的校验和认证的方式会优先使用,会覆盖合同组中单个合同和合同签署方认证方式的限制配置。`
1506
1536
  */
1507
1537
  ApproverVerifyType?: string;
1508
1538
  /**
1509
- * 合同组的配置项信息包括:在合同组签署过程中,是否需要对每个子合同进行独立的意愿确认。
1539
+ * 合同组的签署配置项信息,例如在合同组签署过程中,是否需要对每个子合同进行独立的意愿确认。
1510
1540
  */
1511
1541
  FlowGroupOptions?: FlowGroupOptions;
1512
1542
  /**
@@ -2628,11 +2658,18 @@ export interface ChannelCreateUserAutoSignEnableUrlRequest {
2628
2658
  */
2629
2659
  export interface ChannelCancelMultiFlowSignQRCodeRequest {
2630
2660
  /**
2631
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
2661
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2662
+
2663
+ 此接口下面信息必填。
2664
+ <ul>
2665
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
2666
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
2667
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
2668
+ </ul>
2632
2669
  */
2633
2670
  Agent: Agent;
2634
2671
  /**
2635
- * 二维码id
2672
+ * 二维码ID,为32位字符串。
2636
2673
  */
2637
2674
  QrCodeId: string;
2638
2675
  /**
@@ -2646,17 +2683,15 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
2646
2683
  */
2647
2684
  export interface FlowGroupOptions {
2648
2685
  /**
2649
- * 发起方企业经办人(即签署人为发起方企业员工)是否需要对子合同进行独立的意愿确认:
2650
- fasle:发起方企业经办人签署时对所有子合同进行统一的意愿确认
2651
- true:发起方企业经办人签署时需要对子合同进行独立的意愿确认
2652
- 默认为fasle。
2686
+ * 发起方企业经办人(即签署人为发起方企业员工)是否需要对子合同进行独立的意愿确认
2687
+ <ul><li>**false**(默认):发起方企业经办人签署时对所有子合同进行统一的意愿确认。</li>
2688
+ <li>**true**:发起方企业经办人签署时需要对子合同进行独立的意愿确认。</li></ul>
2653
2689
  */
2654
2690
  SelfOrganizationApproverSignEach?: boolean;
2655
2691
  /**
2656
- * 非发起方企业经办人(即:签署人为个人或者不为发起方企业的员工)是否需要对子合同进行独立的意愿确认:
2657
- fasle:非发起方企业经办人签署时对所有子合同进行统一的意愿确认
2658
- true:非发起方企业经办人签署时需要对子合同进行独立的意愿确认
2659
- 默认为false。
2692
+ * 非发起方企业经办人(即:签署人为个人或者不为发起方企业的员工)是否需要对子合同进行独立的意愿确认
2693
+ <ul><li>**false**(默认):非发起方企业经办人签署时对所有子合同进行统一的意愿确认。</li>
2694
+ <li>**true**:非发起方企业经办人签署时需要对子合同进行独立的意愿确认。</li></ul>
2660
2695
  */
2661
2696
  OtherApproverSignEach?: boolean;
2662
2697
  }
@@ -3454,37 +3489,45 @@ export interface CreateSignUrlsRequest {
3454
3489
  */
3455
3490
  export interface ChannelCreateMultiFlowSignQRCodeRequest {
3456
3491
  /**
3457
- * 应用相关信息。
3458
- 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
3492
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3493
+
3494
+ 此接口下面信息必填。
3495
+ <ul>
3496
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
3497
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
3498
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
3499
+ </ul>
3459
3500
  */
3460
3501
  Agent: Agent;
3461
3502
  /**
3462
- * 模版ID
3503
+ * 合同模板ID,为32位字符串。
3504
+ 建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
3463
3505
  */
3464
3506
  TemplateId: string;
3465
3507
  /**
3466
- * 签署流程名称,最大长度200个字符。
3508
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。
3467
3509
  */
3468
3510
  FlowName: string;
3469
3511
  /**
3470
- * 最大可发起签署流程份数
3471
- <br/>默认5份
3472
- <br/>备注:发起签署流程数量超过此上限后,二维码自动失效。
3512
+ * 通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。 一旦发起流程数超越该限制,该二维码将自动失效。
3473
3513
  */
3474
3514
  MaxFlowNum?: number;
3475
3515
  /**
3476
- * 签署流程有效天数 默认7 最高设置不超过30
3516
+ * 合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。
3477
3517
  */
3478
3518
  FlowEffectiveDay?: number;
3479
3519
  /**
3480
- * 二维码有效天数 默认7 最高设置不超过90天
3520
+ * 二维码的有效期限,默认为7天,最高设定不得超过90天。 一旦超过二维码的有效期限,该二维码将自动失效。
3481
3521
  */
3482
3522
  QrEffectiveDay?: number;
3483
3523
  /**
3484
- * 指定的签署二维码签署人
3485
- <br/>指定后,只允许知道的人操作和签署
3524
+ * 指定签署人信息。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。
3486
3525
  */
3487
3526
  Restrictions?: Array<ApproverRestriction>;
3527
+ /**
3528
+ * 指定签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。
3529
+ */
3530
+ ApproverComponentLimitTypes?: Array<ApproverComponentLimitType>;
3488
3531
  /**
3489
3532
  * 已废弃,回调配置统一使用企业应用管理-应用集成-第三方应用中的配置
3490
3533
  <br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/partner/callback_types_contracts_sign
@@ -3502,27 +3545,23 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
3502
3545
  * @deprecated
3503
3546
  */
3504
3547
  Operator?: UserInfo;
3505
- /**
3506
- * 指定签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。
3507
- */
3508
- ApproverComponentLimitTypes?: Array<ApproverComponentLimitType>;
3509
3548
  }
3510
3549
  /**
3511
- * 一码多扫签署二维码对象
3550
+ * 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
3512
3551
  */
3513
3552
  export interface SignQrCode {
3514
3553
  /**
3515
- * 二维码id
3554
+ * 二维码ID,为32位字符串。
3516
3555
  */
3517
- QrCodeId: string;
3556
+ QrCodeId?: string;
3518
3557
  /**
3519
- * 二维码url
3558
+ * 二维码URL,可通过转换二维码的工具或代码组件将此URL转化为二维码,以便用户扫描进行流程签署。
3520
3559
  */
3521
- QrCodeUrl: string;
3560
+ QrCodeUrl?: string;
3522
3561
  /**
3523
- * 二维码过期时间
3562
+ * 二维码的有截止时间,格式为Unix标准时间戳(秒)。 一旦超过二维码的有效期限,该二维码将自动失效。
3524
3563
  */
3525
- ExpiredTime: number;
3564
+ ExpiredTime?: number;
3526
3565
  }
3527
3566
  /**
3528
3567
  * 创建签署流程签署人入参。
@@ -3544,21 +3583,21 @@ export interface SignQrCode {
3544
3583
  <td>场景一</td>
3545
3584
  <td>第三方子企业A员工</td>
3546
3585
  <td>第三方子企业A员工</td>
3547
- <td>OpenId、OrgNameOrgOpenId必传 ,ApproverType设置为ORGANIZATION</td>
3586
+ <td>OpenId、OrganizationNameOrganizationOpenId必传 ,ApproverType设置为ORGANIZATION</td>
3548
3587
  </tr>
3549
3588
 
3550
3589
  <tr>
3551
3590
  <td>场景二</td>
3552
3591
  <td>第三方子企业A员工</td>
3553
3592
  <td>第三方子企业B(不指定经办人)</td>
3554
- <td>OrgNameOrgOpenId必传 ,ApproverType设置为ORGANIZATION</td>
3593
+ <td>OrganizationNameOrganizationOpenId必传 ,ApproverType设置为ORGANIZATION</td>
3555
3594
  </tr>
3556
3595
 
3557
3596
  <tr>
3558
3597
  <td>场景三</td>
3559
3598
  <td>第三方子企业A员工</td>
3560
3599
  <td>第三方子企业B员工</td>
3561
- <td>OpenId、OrgNameOrgOpenId必传, ApproverType设置为ORGANIZATION</td>
3600
+ <td>OpenId、OrganizationOpenIdOrganizationName必传, ApproverType设置为ORGANIZATION</td>
3562
3601
  </tr>
3563
3602
 
3564
3603
  <tr>
@@ -3572,7 +3611,7 @@ export interface SignQrCode {
3572
3611
  <td>场景五</td>
3573
3612
  <td>第三方子企业A员工</td>
3574
3613
  <td>SaaS平台企业员工</td>
3575
- <td>Name、Mobile、OrgName必传,且NotChannelOrganization=True。 ApproverType设置为ORGANIZATION</td>
3614
+ <td>Name、Mobile、OrganizationName必传,且NotChannelOrganization=True。 ApproverType设置为ORGANIZATION</td>
3576
3615
  </tr>
3577
3616
  </tbody>
3578
3617
  </table>
@@ -4474,12 +4513,16 @@ export interface ChannelDescribeFlowComponentsResponse {
4474
4513
  */
4475
4514
  export interface ChannelCreateFlowGroupByFilesResponse {
4476
4515
  /**
4477
- * 合同组ID
4516
+ * 合同组ID,为32位字符串。
4517
+ 建议开发者妥善保存此合同组ID,以便于顺利进行后续操作。
4478
4518
  注意:此字段可能返回 null,表示取不到有效值。
4479
4519
  */
4480
4520
  FlowGroupId?: string;
4481
4521
  /**
4482
- * 子合同ID列表
4522
+ * 合同组中每个合同流程ID,每个ID均为32位字符串。
4523
+
4524
+ 注:
4525
+ `此数组的顺序和入参中的FlowGroupInfos顺序回不一致`
4483
4526
  注意:此字段可能返回 null,表示取不到有效值。
4484
4527
  */
4485
4528
  FlowIds?: Array<string>;
@@ -4493,11 +4536,11 @@ export interface ChannelCreateFlowGroupByFilesResponse {
4493
4536
  */
4494
4537
  export interface ChannelCreateMultiFlowSignQRCodeResponse {
4495
4538
  /**
4496
- * 签署二维码对象
4539
+ * 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
4497
4540
  */
4498
4541
  QrCode?: SignQrCode;
4499
4542
  /**
4500
- * 签署链接对象
4543
+ * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
4501
4544
  */
4502
4545
  SignUrls?: SignUrl;
4503
4546
  /**
@@ -4933,34 +4976,43 @@ export interface ChannelUpdateSealStatusRequest {
4933
4976
  */
4934
4977
  export interface ChannelCreateFlowGroupByTemplatesRequest {
4935
4978
  /**
4936
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
4979
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4980
+
4981
+ 此接口下面信息必填。
4982
+ <ul>
4983
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
4984
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
4985
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
4986
+ </ul>
4987
+
4988
+ 子客企业和子客企业中的员工比较走完创建和实名过程
4937
4989
  */
4938
4990
  Agent: Agent;
4939
4991
  /**
4940
- * 每个子合同的发起所需的信息,数量限制2-50(合同组暂不支持抄送功能)
4992
+ * 合同组中每个合同签署流程的信息,合同组中最少包含2个合同,不能超过50个合同。
4941
4993
  */
4942
4994
  FlowInfos: Array<FlowInfo>;
4943
4995
  /**
4944
- * 合同组名称,长度不超过200个字符
4996
+ * 合同组的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
4945
4997
  */
4946
4998
  FlowGroupName: string;
4947
4999
  }
4948
5000
  /**
4949
- * 一码多扫签署二维码签署信息
5001
+ * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。 通过链接,用户可直接访问电子签名小程序并签署合同。
4950
5002
  */
4951
5003
  export interface SignUrl {
4952
5004
  /**
4953
- * 小程序签署链接
5005
+ * 跳转至电子签名小程序签署的链接地址。 适用于客户端APP及小程序直接唤起电子签名小程序。
4954
5006
  */
4955
- AppSignUrl: string;
5007
+ AppSignUrl?: string;
4956
5008
  /**
4957
- * 签署链接有效时间
5009
+ * 签署链接有效时间,格式类似"2022-08-05 15:55:01"
4958
5010
  */
4959
- EffectiveTime: string;
5011
+ EffectiveTime?: string;
4960
5012
  /**
4961
- * 移动端签署链接
5013
+ * 跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
4962
5014
  */
4963
- HttpSignUrl: string;
5015
+ HttpSignUrl?: string;
4964
5016
  }
4965
5017
  /**
4966
5018
  * ChannelCancelFlow请求参数结构体
@@ -5317,38 +5369,51 @@ export interface ChannelCreateBatchCancelFlowUrlResponse {
5317
5369
  */
5318
5370
  export interface OperateChannelTemplateRequest {
5319
5371
  /**
5320
- * 应用相关信息。
5321
- 此接口Agent.AppId必填。
5372
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5373
+
5374
+ 此接口下面信息必填。
5375
+ <ul>
5376
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
5377
+ </ul>
5322
5378
  */
5323
5379
  Agent: Agent;
5324
5380
  /**
5325
5381
  * 操作类型,
5326
- 查询:"SELECT",
5327
- 删除:"DELETE"
5328
- 更新:"UPDATE"
5382
+ <ul>
5383
+ <li>查询:"SELECT"</li>
5384
+ <li>删除:"DELETE"</li>
5385
+ <li>更新:"UPDATE"</li>
5386
+ </ul>
5329
5387
  */
5330
5388
  OperateType: string;
5331
5389
  /**
5332
- * 第三方应用平台模板库模板唯一标识
5390
+ * 合同模板ID,为32位字符串。此处为第三方应用平台模板库模板ID,非子客模板ID。
5333
5391
  */
5334
5392
  TemplateId: string;
5335
5393
  /**
5336
- * 合作企业方第三方机构唯一标识数据.
5337
- 支持多个, 用","进行分隔
5394
+ * 第三方平台子客企业的唯一标识,长度不能超过64,只能由字母和数字组成。开发者可自定义此字段的值,并需要保存此 ID 以便进行后续操作。
5395
+
5396
+ 一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。例如,可以使用企业名称的哈希值,或者社会统一信用代码的哈希值,或者随机哈希值。
5338
5397
  */
5339
5398
  ProxyOrganizationOpenIds?: string;
5340
5399
  /**
5341
5400
  * 模板可见性,
5342
- 全部可见-"all",
5343
- 部分可见-"part"
5401
+ <ul>
5402
+ <li>全部可见-"all"</li>
5403
+ <li>部分可见-"part"</li>
5404
+ </ul>
5344
5405
  */
5345
5406
  AuthTag?: string;
5346
5407
  /**
5347
5408
  * 当OperateType=UPDATE时,可以通过设置此字段对模板启停用状态进行操作。
5348
- 若此字段值为0,则不会修改模板Available,
5349
- 1为启用模板,
5350
- 2为停用模板。
5351
- 启用后模板可以正常领取。停用后,推送方式为【自动推送】的模板则无法被子客使用,推送方式为【手动领取】的模板则无法出现被模板库被子客领用。如果Available更新失败,会直接返回错误。
5409
+ <ul>
5410
+ <li>若此字段值为0,则不会修改模板Available</li>
5411
+ <li>1为启用模板</li>
5412
+ <li>2为停用模板</li>
5413
+ </ul>
5414
+ 启用后模板可以正常领取。
5415
+ 停用后,推送方式为【自动推送】的模板则无法被子客使用,推送方式为【手动领取】的模板则无法出现被模板库被子客领用。
5416
+ 如果Available更新失败,会直接返回错误。
5352
5417
  */
5353
5418
  Available?: number;
5354
5419
  /**
@@ -5524,7 +5589,7 @@ export interface CreateSealByImageRequest {
5524
5589
  */
5525
5590
  Operator?: UserInfo;
5526
5591
  /**
5527
- * 本接口支持上传图片印章及系统直接生成印章; 如果要使用系统生成印章,此值传:SealGenerateSourceSystem; 如果要使用图片上传请传字段 SealImage
5592
+ * 本接口支持上传图片印章及系统直接生成印章; 如果要使用系统生成印章,此值传:SealGenerateSourceSystem; 如果要使用图片上传,此字段置空并且传字段 SealImage
5528
5593
  */
5529
5594
  GenerateSource?: string;
5530
5595
  /**