tencentcloud-sdk-nodejs-essbasic 4.0.712 → 4.0.714

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.
@@ -138,14 +138,20 @@ class Client extends TencentCloudCommon.AbstractClient {
138
138
  return this.request("ChannelCreateFlowByFiles", req, cb);
139
139
  }
140
140
  /**
141
- * 通过图片为子客企业代创建印章,图片最大5MB
142
- */
141
+ * 1. 可以**通过图片**为子客企业代创建印章,图片最大5MB
142
+
143
+ 2. 可以**系统创建**子客企业代创建印章, 系统创建的印章样子下图(样式可以调整)
144
+
145
+ ![image](https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage.png)
146
+ */
143
147
  async CreateSealByImage(req, cb) {
144
148
  return this.request("CreateSealByImage", req, cb);
145
149
  }
146
150
  /**
147
- * 此接口(ChannelCancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
148
- */
151
+ * 此接口(CancelMultiFlowSignQRCode)用于废除一码多扫流程签署二维码。
152
+ 该接口所需的二维码ID,源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)生成的。
153
+ 如果该二维码尚处于有效期内,可通过本接口将其设置为失效状态。
154
+ */
149
155
  async ChannelCancelMultiFlowSignQRCode(req, cb) {
150
156
  return this.request("ChannelCancelMultiFlowSignQRCode", req, cb);
151
157
  }
@@ -156,6 +162,7 @@ class Client extends TencentCloudCommon.AbstractClient {
156
162
  3. 使用手机号验证签署方身份
157
163
  4. 骑缝章
158
164
  5. 拓宽签署方年龄限制
165
+ 6. 下载企业合同/文件
159
166
 
160
167
  注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
161
168
  */
@@ -502,10 +509,12 @@ class Client extends TencentCloudCommon.AbstractClient {
502
509
  return this.request("ChannelCreateWebThemeConfig", req, cb);
503
510
  }
504
511
  /**
505
- * 指定需要批量催办的签署流程Id,批量催办合同,最多100个;接口失败后返回错误信息
506
- 注意:
507
- 该接口不可直接调用,请联系客户经理申请使用
508
- 仅能催办当前状态为“待签署”的签署人,且只能催办一次
512
+ * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
513
+
514
+ 1. 合同中当前状态为“待签署”的签署人是催办的对象
515
+ 2. 每个合同只能催办一次
516
+
517
+ 注意:该接口无法直接调用,请联系客户经理申请使用。
509
518
  */
510
519
  async ChannelCreateFlowReminds(req, cb) {
511
520
  return this.request("ChannelCreateFlowReminds", req, cb);
@@ -623,8 +632,66 @@ class Client extends TencentCloudCommon.AbstractClient {
623
632
  return this.request("SyncProxyOrganization", req, cb);
624
633
  }
625
634
  /**
626
- * 接口(ChannelCreateFlowGroupByTemplates)用于通过多模板创建合同组签署流程。
627
- */
635
+ * 接口(ChannelCreateFlowGroupByTemplates)用于通过多模板创建合同组签署流程。
636
+
637
+ 合同组是将多个合同签署流程组织在一起,多个合同同时创建,每个签署方得到一个签署链接,`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`,只能作为一个整体签署。
638
+
639
+ 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
640
+
641
+ **注**:
642
+ <ul>
643
+ <li>此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。</li>
644
+ <li>合同组暂不支持抄送功能</li>
645
+ </ul>
646
+
647
+ **可以作为发起方和签署方的角色列表**
648
+ <table>
649
+ <thead>
650
+ <tr>
651
+ <th>场景编号</th>
652
+ <th>可作为发起方类型</th>
653
+ <th>可作为签署方的类型</th>
654
+ </tr>
655
+ </thead>
656
+
657
+ <tbody>
658
+ <tr>
659
+ <td>场景一</td>
660
+ <td>第三方子企业A员工</td>
661
+ <td>第三方子企业A员工</td>
662
+ </tr>
663
+
664
+ <tr>
665
+ <td>场景二</td>
666
+ <td>第三方子企业A员工</td>
667
+ <td>第三方子企业B(不指定经办人)</td>
668
+ </tr>
669
+
670
+ <tr>
671
+ <td>场景三</td>
672
+ <td>第三方子企业A员工</td>
673
+ <td>第三方子企业B员工</td>
674
+ </tr>
675
+
676
+ <tr>
677
+ <td>场景四</td>
678
+ <td>第三方子企业A员工</td>
679
+ <td>个人/自然人</td>
680
+ </tr>
681
+
682
+ <tr>
683
+ <td>场景五</td>
684
+ <td>第三方子企业A员工</td>
685
+ <td>SaaS平台企业员工</td>
686
+ </tr>
687
+ </tbody>
688
+ </table>
689
+
690
+ **注**:
691
+ `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
692
+
693
+ `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
694
+ */
628
695
  async ChannelCreateFlowGroupByTemplates(req, cb) {
629
696
  return this.request("ChannelCreateFlowGroupByTemplates", req, cb);
630
697
  }
@@ -709,8 +776,69 @@ class Client extends TencentCloudCommon.AbstractClient {
709
776
  return this.request("ChannelCreatePreparedPersonalEsign", req, cb);
710
777
  }
711
778
  /**
712
- * 接口(ChannelCreateFlowGroupByFiles)用于通过多文件创建合同组签署流程。
713
- */
779
+ * 接口(ChannelCreateFlowGroupByFiles)用于使用 PDF 文件创建合同组签署流程。
780
+
781
+ 合同组是将多个合同签署流程组织在一起,多个合同同时创建,每个签署方得到一个签署链接,`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`,只能作为一个整体签署。
782
+
783
+ 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
784
+
785
+
786
+
787
+ **注**:
788
+ <ul>
789
+ <li>此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。</li>
790
+ <li>合同组暂不支持抄送功能</li>
791
+ <li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号(FileIds)进行使用。</li>
792
+ </ul>
793
+
794
+ **可以作为发起方和签署方的角色列表**
795
+ <table>
796
+ <thead>
797
+ <tr>
798
+ <th>场景编号</th>
799
+ <th>可作为发起方类型</th>
800
+ <th>可作为签署方的类型</th>
801
+ </tr>
802
+ </thead>
803
+
804
+ <tbody>
805
+ <tr>
806
+ <td>场景一</td>
807
+ <td>第三方子企业A员工</td>
808
+ <td>第三方子企业A员工</td>
809
+ </tr>
810
+
811
+ <tr>
812
+ <td>场景二</td>
813
+ <td>第三方子企业A员工</td>
814
+ <td>第三方子企业B(不指定经办人)</td>
815
+ </tr>
816
+
817
+ <tr>
818
+ <td>场景三</td>
819
+ <td>第三方子企业A员工</td>
820
+ <td>第三方子企业B员工</td>
821
+ </tr>
822
+
823
+ <tr>
824
+ <td>场景四</td>
825
+ <td>第三方子企业A员工</td>
826
+ <td>个人/自然人</td>
827
+ </tr>
828
+
829
+ <tr>
830
+ <td>场景五</td>
831
+ <td>第三方子企业A员工</td>
832
+ <td>SaaS平台企业员工</td>
833
+ </tr>
834
+ </tbody>
835
+ </table>
836
+
837
+ **注**:
838
+ `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
839
+
840
+ `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
841
+ */
714
842
  async ChannelCreateFlowGroupByFiles(req, cb) {
715
843
  return this.request("ChannelCreateFlowGroupByFiles", req, cb);
716
844
  }
@@ -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
  /**
@@ -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
  /**
@@ -504,19 +508,24 @@ export interface ChannelCancelUserAutoSignEnableUrlResponse {
504
508
  */
505
509
  export interface ModifyExtendedServiceRequest {
506
510
  /**
507
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
511
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
508
512
 
509
- 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
513
+ 此接口下面信息必填。
514
+ <ul>
515
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
516
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
517
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
518
+ </ul>
510
519
  */
511
520
  Agent: Agent;
512
521
  /**
513
522
  * 扩展服务类型
514
523
  <ul>
515
- <li>AUTO_SIGN 企业自动签(自动签署)</li>
524
+ <li>AUTO_SIGN 企业自动签(自动签署)</li>
516
525
  <li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>
517
526
  <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
518
- <li> PAGING_SEAL 骑缝章</li>
519
- <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
527
+ <li> PAGING_SEAL 骑缝章</li>
528
+ <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
520
529
  <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
521
530
  </ul>
522
531
  */
@@ -529,8 +538,10 @@ export interface ModifyExtendedServiceRequest {
529
538
  Operate: string;
530
539
  /**
531
540
  * 链接跳转类型,支持以下类型
532
- <ul><li>WEIXINAPP : 短链直接跳转到电子签小程序 (默认值)</li>
533
- <li>APP : 第三方APP或小程序跳转电子签小程序</li></ul>
541
+ <ul>
542
+ <li>WEIXINAPP : 短链直接跳转到电子签小程序 (默认值)</li>
543
+ <li>APP : 第三方APP或小程序跳转电子签小程序</li>
544
+ </ul>
534
545
  */
535
546
  Endpoint?: string;
536
547
  }
@@ -571,21 +582,21 @@ export interface CreateChannelOrganizationInfoChangeUrlResponse {
571
582
  RequestId?: string;
572
583
  }
573
584
  /**
574
- * 催办接口返回详细信息
585
+ * 催办接口返回的详细信息。
575
586
  */
576
587
  export interface RemindFlowRecords {
577
588
  /**
578
- * 是否能够催办,true-是,false-否
589
+ * 合同流程是否可以催办: true - 可以,false - 不可以。 若无法催办,将返回RemindMessage以解释原因。
579
590
  */
580
- CanRemind: boolean;
591
+ CanRemind?: boolean;
581
592
  /**
582
- * 合同id
593
+ * 合同流程ID,为32位字符串。
583
594
  */
584
- FlowId: string;
595
+ FlowId?: string;
585
596
  /**
586
- * 催办详情信息
597
+ * 在合同流程无法催办的情况下,系统将返回RemindMessage以阐述原因。
587
598
  */
588
- RemindMessage: string;
599
+ RemindMessage?: string;
589
600
  }
590
601
  /**
591
602
  * ChannelCreateFlowSignUrl返回参数结构体
@@ -1100,11 +1111,18 @@ export interface ChannelCreatePrepareFlowRequest {
1100
1111
  */
1101
1112
  export interface ChannelCreateFlowRemindsRequest {
1102
1113
  /**
1103
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
1114
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1115
+
1116
+ 此接口下面信息必填。
1117
+ <ul>
1118
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
1119
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
1120
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
1121
+ </ul>
1104
1122
  */
1105
1123
  Agent: Agent;
1106
1124
  /**
1107
- * 签署流程Id数组,最多100个,超过100不处理
1125
+ * 需执行催办的签署流程ID数组,最多包含100个。
1108
1126
  */
1109
1127
  FlowIds: Array<string>;
1110
1128
  }
@@ -1495,26 +1513,36 @@ export interface DescribeResourceUrlsByFlowsResponse {
1495
1513
  */
1496
1514
  export interface ChannelCreateFlowGroupByFilesRequest {
1497
1515
  /**
1498
- * 每个子合同的发起所需的信息,数量限制2-50
1516
+ * 合同组中每个合同签署流程的信息,合同组中最少包含2个合同,不能超过50个合同。
1499
1517
  */
1500
1518
  FlowFileInfos: Array<FlowFileInfo>;
1501
1519
  /**
1502
- * 合同组名称,长度不超过200个字符
1520
+ * 合同组的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
1503
1521
  */
1504
1522
  FlowGroupName: string;
1505
1523
  /**
1506
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
1524
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1525
+
1526
+ 此接口下面信息必填。
1527
+ <ul>
1528
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
1529
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
1530
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
1531
+ </ul>
1532
+ 子客企业和子客企业中的员工比较走完创建和实名过程
1507
1533
  */
1508
1534
  Agent?: Agent;
1509
1535
  /**
1510
- * 签署人校验方式
1511
- VerifyCheck: 人脸识别(默认)
1512
- MobileCheck:手机号验证
1513
- 参数说明:若选择后者,未实名的个人签署方查看合同时,无需进行人脸识别实名认证(但签署合同时仍然需要人脸实名),该能力仅适用于个人签署方。
1536
+ * 合同组中签署人校验和认证的方式:
1537
+ <ul><li>**VerifyCheck**:人脸识别(默认)</li>
1538
+ <li>**MobileCheck**:手机号验证</li></ul>
1539
+ 注意:
1540
+ `1. MobileCheck 方式,未实名的个人/自然人签署方无需进行人脸识别实名认证即可查看合同(但签署合同时仍然需要人脸实名),企业签署方需经过人脸认证。`
1541
+ `2. 合同组的校验和认证的方式会优先使用,会覆盖合同组中单个合同和合同签署方认证方式的限制配置。`
1514
1542
  */
1515
1543
  ApproverVerifyType?: string;
1516
1544
  /**
1517
- * 合同组的配置项信息包括:在合同组签署过程中,是否需要对每个子合同进行独立的意愿确认。
1545
+ * 合同组的签署配置项信息,例如在合同组签署过程中,是否需要对每个子合同进行独立的意愿确认。
1518
1546
  */
1519
1547
  FlowGroupOptions?: FlowGroupOptions;
1520
1548
  /**
@@ -2636,11 +2664,18 @@ export interface ChannelCreateUserAutoSignEnableUrlRequest {
2636
2664
  */
2637
2665
  export interface ChannelCancelMultiFlowSignQRCodeRequest {
2638
2666
  /**
2639
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
2667
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2668
+
2669
+ 此接口下面信息必填。
2670
+ <ul>
2671
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
2672
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
2673
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
2674
+ </ul>
2640
2675
  */
2641
2676
  Agent: Agent;
2642
2677
  /**
2643
- * 二维码id
2678
+ * 二维码ID,为32位字符串。
2644
2679
  */
2645
2680
  QrCodeId: string;
2646
2681
  /**
@@ -2654,17 +2689,15 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
2654
2689
  */
2655
2690
  export interface FlowGroupOptions {
2656
2691
  /**
2657
- * 发起方企业经办人(即签署人为发起方企业员工)是否需要对子合同进行独立的意愿确认:
2658
- fasle:发起方企业经办人签署时对所有子合同进行统一的意愿确认
2659
- true:发起方企业经办人签署时需要对子合同进行独立的意愿确认
2660
- 默认为fasle。
2692
+ * 发起方企业经办人(即签署人为发起方企业员工)是否需要对子合同进行独立的意愿确认
2693
+ <ul><li>**false**(默认):发起方企业经办人签署时对所有子合同进行统一的意愿确认。</li>
2694
+ <li>**true**:发起方企业经办人签署时需要对子合同进行独立的意愿确认。</li></ul>
2661
2695
  */
2662
2696
  SelfOrganizationApproverSignEach?: boolean;
2663
2697
  /**
2664
- * 非发起方企业经办人(即:签署人为个人或者不为发起方企业的员工)是否需要对子合同进行独立的意愿确认:
2665
- fasle:非发起方企业经办人签署时对所有子合同进行统一的意愿确认
2666
- true:非发起方企业经办人签署时需要对子合同进行独立的意愿确认
2667
- 默认为false。
2698
+ * 非发起方企业经办人(即:签署人为个人或者不为发起方企业的员工)是否需要对子合同进行独立的意愿确认
2699
+ <ul><li>**false**(默认):非发起方企业经办人签署时对所有子合同进行统一的意愿确认。</li>
2700
+ <li>**true**:非发起方企业经办人签署时需要对子合同进行独立的意愿确认。</li></ul>
2668
2701
  */
2669
2702
  OtherApproverSignEach?: boolean;
2670
2703
  }
@@ -3556,21 +3589,21 @@ export interface SignQrCode {
3556
3589
  <td>场景一</td>
3557
3590
  <td>第三方子企业A员工</td>
3558
3591
  <td>第三方子企业A员工</td>
3559
- <td>OpenId、OrgNameOrgOpenId必传 ,ApproverType设置为ORGANIZATION</td>
3592
+ <td>OpenId、OrganizationNameOrganizationOpenId必传 ,ApproverType设置为ORGANIZATION</td>
3560
3593
  </tr>
3561
3594
 
3562
3595
  <tr>
3563
3596
  <td>场景二</td>
3564
3597
  <td>第三方子企业A员工</td>
3565
3598
  <td>第三方子企业B(不指定经办人)</td>
3566
- <td>OrgNameOrgOpenId必传 ,ApproverType设置为ORGANIZATION</td>
3599
+ <td>OrganizationNameOrganizationOpenId必传 ,ApproverType设置为ORGANIZATION</td>
3567
3600
  </tr>
3568
3601
 
3569
3602
  <tr>
3570
3603
  <td>场景三</td>
3571
3604
  <td>第三方子企业A员工</td>
3572
3605
  <td>第三方子企业B员工</td>
3573
- <td>OpenId、OrgNameOrgOpenId必传, ApproverType设置为ORGANIZATION</td>
3606
+ <td>OpenId、OrganizationOpenIdOrganizationName必传, ApproverType设置为ORGANIZATION</td>
3574
3607
  </tr>
3575
3608
 
3576
3609
  <tr>
@@ -3584,7 +3617,7 @@ export interface SignQrCode {
3584
3617
  <td>场景五</td>
3585
3618
  <td>第三方子企业A员工</td>
3586
3619
  <td>SaaS平台企业员工</td>
3587
- <td>Name、Mobile、OrgName必传,且NotChannelOrganization=True。 ApproverType设置为ORGANIZATION</td>
3620
+ <td>Name、Mobile、OrganizationName必传,且NotChannelOrganization=True。 ApproverType设置为ORGANIZATION</td>
3588
3621
  </tr>
3589
3622
  </tbody>
3590
3623
  </table>
@@ -4380,11 +4413,12 @@ export interface CreateSealByImageResponse {
4380
4413
  /**
4381
4414
  * 电子印章ID,为32位字符串。
4382
4415
  建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
4383
- 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
4384
4416
  */
4385
4417
  SealId?: string;
4386
4418
  /**
4387
4419
  * 电子印章预览链接地址,地址默认失效时间为24小时。
4420
+
4421
+ 注:`图片上传生成的电子印章无预览链接地址`
4388
4422
  注意:此字段可能返回 null,表示取不到有效值。
4389
4423
  */
4390
4424
  ImageUrl?: string;
@@ -4486,12 +4520,16 @@ export interface ChannelDescribeFlowComponentsResponse {
4486
4520
  */
4487
4521
  export interface ChannelCreateFlowGroupByFilesResponse {
4488
4522
  /**
4489
- * 合同组ID
4523
+ * 合同组ID,为32位字符串。
4524
+ 建议开发者妥善保存此合同组ID,以便于顺利进行后续操作。
4490
4525
  注意:此字段可能返回 null,表示取不到有效值。
4491
4526
  */
4492
4527
  FlowGroupId?: string;
4493
4528
  /**
4494
- * 子合同ID列表
4529
+ * 合同组中每个合同流程ID,每个ID均为32位字符串。
4530
+
4531
+ 注:
4532
+ `此数组的顺序和入参中的FlowGroupInfos顺序回不一致`
4495
4533
  注意:此字段可能返回 null,表示取不到有效值。
4496
4534
  */
4497
4535
  FlowIds?: Array<string>;
@@ -4945,15 +4983,23 @@ export interface ChannelUpdateSealStatusRequest {
4945
4983
  */
4946
4984
  export interface ChannelCreateFlowGroupByTemplatesRequest {
4947
4985
  /**
4948
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
4986
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4987
+
4988
+ 此接口下面信息必填。
4989
+ <ul>
4990
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
4991
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
4992
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
4993
+ </ul>
4994
+ 子客企业和子客企业中的员工比较走完创建和实名过程
4949
4995
  */
4950
4996
  Agent: Agent;
4951
4997
  /**
4952
- * 每个子合同的发起所需的信息,数量限制2-50(合同组暂不支持抄送功能)
4998
+ * 合同组中每个合同签署流程的信息,合同组中最少包含2个合同,不能超过50个合同。
4953
4999
  */
4954
5000
  FlowInfos: Array<FlowInfo>;
4955
5001
  /**
4956
- * 合同组名称,长度不超过200个字符
5002
+ * 合同组的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
4957
5003
  */
4958
5004
  FlowGroupName: string;
4959
5005
  }
@@ -5531,16 +5577,28 @@ export interface DescribeChannelFlowEvidenceReportResponse {
5531
5577
  */
5532
5578
  export interface CreateSealByImageRequest {
5533
5579
  /**
5534
- * 代理企业和员工的信息。
5535
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5580
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5581
+
5582
+ 此接口下面信息必填。
5583
+ <ul>
5584
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
5585
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
5586
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
5587
+ </ul>
5588
+ 第三方平台子客企业和员工必须已经经过实名认证
5536
5589
  */
5537
5590
  Agent: Agent;
5538
5591
  /**
5539
- * 印章名称,最大长度不超过50字符
5592
+ * 电子印章名字,1-50个中文字符
5593
+ 注:`同一企业下电子印章名字不能相同`
5540
5594
  */
5541
5595
  SealName: string;
5542
5596
  /**
5543
- * 印章图片base64,大小不超过10M(原始图片不超过7.6M)
5597
+ * 电子印章图片base64编码,大小不超过10M(原始图片不超过5M),只支持PNG或JPG图片格式
5598
+
5599
+ 注: `通过图片创建的电子印章,需电子签平台人工审核`
5600
+
5601
+
5544
5602
  */
5545
5603
  SealImage?: string;
5546
5604
  /**
@@ -5549,37 +5607,42 @@ export interface CreateSealByImageRequest {
5549
5607
  */
5550
5608
  Operator?: UserInfo;
5551
5609
  /**
5552
- * 本接口支持上传图片印章及系统直接生成印章; 如果要使用系统生成印章,此值传:SealGenerateSourceSystem; 如果要使用图片上传请传字段 SealImage
5610
+ * 电子印章生成方式
5611
+ <ul>
5612
+ <li><strong>空值</strong>:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片</li>
5613
+ <li><strong>SealGenerateSourceSystem</strong>: 系统生成印章, 无需上传SealImage图片</li>
5614
+ </ul>
5553
5615
  */
5554
5616
  GenerateSource?: string;
5555
5617
  /**
5556
- * 电子印章类型:
5557
- <ul><li>OFFICIAL-公章</li>
5558
- <li>CONTRACT-合同专用章;</li>
5559
- <li>FINANCE-合财务专用章;</li>
5560
- <li>PERSONNEL-人事专用章
5561
- </li>
5562
- <li>默认:OFFICIAL</li>
5618
+ * 电子印章类型 , 可选类型如下:
5619
+ <ul><li>**OFFICIAL**: (默认)公章</li>
5620
+ <li>**CONTRACT**: 合同专用章;</li>
5621
+ <li>**FINANCE**: 合财务专用章;</li>
5622
+ <li>**PERSONNEL**: 人事专用章</li>
5563
5623
  </ul>
5624
+ 注: `同企业下只能有一个公章, 重复创建会报错`
5564
5625
  */
5565
5626
  SealType?: string;
5566
5627
  /**
5567
- * 企业印章横向文字,最多可填15个汉字(若超过印章最大宽度,优先压缩字间距,其次缩小字号
5628
+ * 企业印章横向文字,最多可填15个汉字 (若超过印章最大宽度,优先压缩字间距,其次缩小字号)
5629
+ 横向文字的位置如下图中的"印章横向文字在这里"
5630
+
5631
+ ![image](https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage2.png)
5632
+
5568
5633
  */
5569
5634
  SealHorizontalText?: string;
5570
5635
  /**
5571
- * 印章样式:
5572
-
5573
- <ul><li>cycle:圆形印章</li>
5574
- <li>ellipse:椭圆印章</li>
5575
- <li> 注:默认圆形印章</li></ul>
5636
+ * 印章样式, 可以选择的样式如下:
5637
+ <ul><li>**cycle**:(默认)圆形印章</li>
5638
+ <li>**ellipse**:椭圆印章</li>
5576
5639
  */
5577
5640
  SealStyle?: string;
5578
5641
  /**
5579
- * 印章尺寸取值描述:<ul><li> 42_42 圆形企业公章直径42mm</li>
5580
- <li> 40_40 圆形企业印章直径40mm</li>
5581
- <li> 45_30 椭圆形印章45mm x 30mm</li>
5582
- </ul>
5642
+ * 印章尺寸取值描述, 可以选择的尺寸如下:
5643
+ <ul><li> **42_42**: 圆形企业公章直径42mm, 当SealStyle是圆形的时候才有效</li>
5644
+ <li> **40_40**: 圆形企业印章直径40mm, 当SealStyle是圆形的时候才有效</li>
5645
+ <li> **45_30**: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效</li></ul>
5583
5646
  */
5584
5647
  SealSize?: string;
5585
5648
  }