tencentcloud-sdk-nodejs-ess 4.0.685 → 4.0.687

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.
@@ -374,7 +374,10 @@ export interface ReviewerInfo {
374
374
  */
375
375
  export interface DescribeThirdPartyAuthCodeResponse {
376
376
  /**
377
- * 用户是否实名,VERIFIED 为实名,UNVERIFIED 未实名
377
+ * AuthCode 中对应个人用户是否实名
378
+ <ul>
379
+ <li> **VERIFIED** : 此个人已实名</li>
380
+ <li> **UNVERIFIED**: 此个人未实名</li></ul>
378
381
  */
379
382
  VerifyStatus?: string;
380
383
  /**
@@ -548,7 +551,10 @@ export interface ReleasedApprover {
548
551
  */
549
552
  ApproverSignComponentType?: string;
550
553
  /**
551
- * 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议默认会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方,以此类推。如果您需要改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字。
554
+ * 参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。
555
+
556
+ 如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。
557
+
552
558
  */
553
559
  ApproverSignRole?: string;
554
560
  }
@@ -1175,7 +1181,9 @@ export interface DescribeIntegrationEmployeesRequest {
1175
1181
  */
1176
1182
  Agent?: Agent;
1177
1183
  /**
1178
- * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
1184
+ * 查询过滤实名用户,Key为Status,Values为["IsVerified"],查询过滤未实名用户,Key为Status,Values为["NotVerified"]
1185
+ 查询某个部门的用户,Key为DepartmentId,Values为["DepartmentId"]
1186
+ 根据用户Id查询员工时,Key为UserId,Values为["UserId"]
1179
1187
  根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
1180
1188
  */
1181
1189
  Filters?: Array<Filter>;
@@ -1462,15 +1470,17 @@ export interface AutoSignConfig {
1462
1470
  */
1463
1471
  export interface DescribeThirdPartyAuthCodeRequest {
1464
1472
  /**
1465
- * 电子签小程序跳转客户小程序时携带的授权查看码
1473
+ * 腾讯电子签小程序跳转客户企业小程序时携带的授权查看码,AuthCode由腾讯电子签小程序生成。
1466
1474
  */
1467
1475
  AuthCode: string;
1468
1476
  /**
1469
- * 操作人信息
1477
+ * 执行本接口操作的员工信息。
1478
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1470
1479
  */
1471
1480
  Operator?: UserInfo;
1472
1481
  /**
1473
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1482
+ * 代理企业和员工的信息。
1483
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1474
1484
  */
1475
1485
  Agent?: Agent;
1476
1486
  }
@@ -1615,6 +1625,34 @@ export interface Permission {
1615
1625
  */
1616
1626
  Children?: Array<Permission>;
1617
1627
  }
1628
+ /**
1629
+ * 签署控件的类型和范围限制条件,用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
1630
+ */
1631
+ export interface ComponentLimit {
1632
+ /**
1633
+ * 控件类型,支持以下类型
1634
+ <ul><li>SIGN_SEAL : 印章控件</li>
1635
+ <li>SIGN_PAGING_SEAL : 骑缝章控件</li>
1636
+ <li>SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件</li>
1637
+ <li>SIGN_SIGNATURE : 用户签名控件</li></ul>
1638
+ */
1639
+ ComponentType: string;
1640
+ /**
1641
+ * 签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围
1642
+
1643
+ 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)
1644
+
1645
+ 2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)
1646
+
1647
+ <ul><li>HANDWRITE : 手写签名</li>
1648
+ <li>OCR_ESIGN : OCR印章(智慧手写签名)</li>
1649
+ <li>ESIGN : 个人印章</li>
1650
+ <li>SYSTEM_ESIGN : 系统印章</li></ul>
1651
+
1652
+ 3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。
1653
+ */
1654
+ ComponentValue?: Array<string>;
1655
+ }
1618
1656
  /**
1619
1657
  * CreateIntegrationDepartment返回参数结构体
1620
1658
  */
@@ -1845,26 +1883,33 @@ export interface OccupiedSeal {
1845
1883
  */
1846
1884
  export interface CreatePersonAuthCertificateImageResponse {
1847
1885
  /**
1848
- * 个人用户证明证书的下载链接
1886
+ * 个人用户认证证书图片下载URL,`有效期为5分钟`,超过有效期后将无法再下载。
1849
1887
  */
1850
1888
  AuthCertUrl?: string;
1851
1889
  /**
1852
- * 证书图片上的证书编号,20位数字
1890
+ * 个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。
1891
+ 该编号会合成到个人用户证书证明图片。
1892
+
1893
+ 注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`
1853
1894
  注意:此字段可能返回 null,表示取不到有效值。
1854
1895
  */
1855
1896
  ImageCertId?: string;
1856
1897
  /**
1857
- * 图片证明对应的CA证书序列号
1898
+ * CA供应商下发给用户的证书编号,在证书到期后自动续期后此证书编号会发生变动,且不会合成到个人用户证书证明图片中。
1899
+
1900
+ 注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下。`
1858
1901
  注意:此字段可能返回 null,表示取不到有效值。
1859
1902
  */
1860
1903
  SerialNumber?: string;
1861
1904
  /**
1862
- * CA证书颁发时间戳
1905
+ * CA证书颁发时间,格式为Unix标准时间戳(秒)
1906
+ 该时间格式化后会合成到个人用户证书证明图片
1863
1907
  注意:此字段可能返回 null,表示取不到有效值。
1864
1908
  */
1865
1909
  ValidFrom?: number;
1866
1910
  /**
1867
- * CA证书有效截止时间戳
1911
+ * CA证书有效截止时间,格式为Unix标准时间戳(秒)
1912
+ 该时间格式化后会合成到个人用户证书证明图片
1868
1913
  注意:此字段可能返回 null,表示取不到有效值。
1869
1914
  */
1870
1915
  ValidTo?: number;
@@ -2576,19 +2621,6 @@ export interface FormField {
2576
2621
  */
2577
2622
  ComponentName?: string;
2578
2623
  }
2579
- /**
2580
- * CreateChannelSubOrganizationModifyQrCode请求参数结构体
2581
- */
2582
- export interface CreateChannelSubOrganizationModifyQrCodeRequest {
2583
- /**
2584
- * 操作人信息,userId必填
2585
- */
2586
- Operator: UserInfo;
2587
- /**
2588
- * 应用编号
2589
- */
2590
- ApplicationId: string;
2591
- }
2592
2624
  /**
2593
2625
  * 用户信息
2594
2626
  */
@@ -3179,65 +3211,23 @@ export interface CreateDocumentRequest {
3179
3211
  ClientToken?: string;
3180
3212
  }
3181
3213
  /**
3182
- * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
3214
+ * 催办接口返回的详细信息。
3183
3215
  */
3184
- export interface FlowDetailInfo {
3185
- /**
3186
- * 合同(流程)的ID
3187
- */
3188
- FlowId?: string;
3189
- /**
3190
- * 合同(流程)的名字
3191
- */
3192
- FlowName?: string;
3193
- /**
3194
- * 合同(流程)的类型
3195
- 注意:此字段可能返回 null,表示取不到有效值。
3196
- */
3197
- FlowType?: string;
3198
- /**
3199
- * 流程状态
3200
- - 0 还没有发起
3201
- - 1 待签署
3202
- - 2 部分签署
3203
- - 3 已拒签
3204
- - 4 已签署
3205
- - 5 已过期
3206
- - 6 已撤销
3207
- - 7 还没有预发起
3208
- - 8 等待填写
3209
- - 9 部分填写
3210
- - 10 拒填
3211
- - 21 已解除
3212
- */
3213
- FlowStatus?: number;
3214
- /**
3215
- * 合同(流程)的信息
3216
- 注意:此字段可能返回 null,表示取不到有效值。
3217
- */
3218
- FlowMessage?: string;
3219
- /**
3220
- * 流程的描述
3221
- 注意:此字段可能返回 null,表示取不到有效值。
3222
- */
3223
- FlowDescription?: string;
3224
- /**
3225
- * 合同(流程)的创建时间戳,单位秒
3226
- */
3227
- CreatedOn?: number;
3216
+ export interface RemindFlowRecords {
3228
3217
  /**
3229
- * 合同(流程)的签署方数组
3218
+ * 合同流程是否可以催办:
3219
+ true - 可以,false - 不可以。
3220
+ 若无法催办,将返回RemindMessage以解释原因。
3230
3221
  */
3231
- FlowApproverInfos?: Array<FlowApproverDetail>;
3222
+ CanRemind?: boolean;
3232
3223
  /**
3233
- * 合同(流程)的关注方信息列表
3224
+ * 合同流程ID,为32位字符串。
3234
3225
  */
3235
- CcInfos?: Array<FlowApproverDetail>;
3226
+ FlowId?: string;
3236
3227
  /**
3237
- * 合同发起人UserId
3238
- 注意:此字段可能返回 null,表示取不到有效值。
3228
+ * 在合同流程无法催办的情况下,系统将返回RemindMessage以阐述原因。
3239
3229
  */
3240
- Creator?: string;
3230
+ RemindMessage?: string;
3241
3231
  }
3242
3232
  /**
3243
3233
  * CreatePreparedPersonalEsign返回参数结构体
@@ -3274,7 +3264,8 @@ export interface DescribeOrganizationSealsResponse {
3274
3264
  */
3275
3265
  export interface CreateEmbedWebUrlRequest {
3276
3266
  /**
3277
- * 操作者信息
3267
+ * 执行本接口操作的员工信息。
3268
+ <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3278
3269
  */
3279
3270
  Operator: UserInfo;
3280
3271
  /**
@@ -3299,7 +3290,8 @@ export interface CreateEmbedWebUrlRequest {
3299
3290
  */
3300
3291
  BusinessId?: string;
3301
3292
  /**
3302
- * 代理相关应用信息,如集团主企业代子企业操作
3293
+ * 代理企业和员工的信息。
3294
+ <br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3303
3295
  */
3304
3296
  Agent?: Agent;
3305
3297
  /**
@@ -3307,7 +3299,7 @@ export interface CreateEmbedWebUrlRequest {
3307
3299
  */
3308
3300
  Reviewer?: ReviewerInfo;
3309
3301
  /**
3310
- * 个性化参数
3302
+ * 个性化参数,用于控制页面展示内容
3311
3303
  */
3312
3304
  Option?: EmbedUrlOption;
3313
3305
  }
@@ -3687,7 +3679,7 @@ export interface CreateReleaseFlowRequest {
3687
3679
  */
3688
3680
  NeedRelievedFlowId: string;
3689
3681
  /**
3690
- * 解除协议内容。
3682
+ * 解除协议内容, 包括解除理由等信息。
3691
3683
  */
3692
3684
  ReliveInfo: RelieveInfo;
3693
3685
  /**
@@ -3695,12 +3687,12 @@ export interface CreateReleaseFlowRequest {
3695
3687
  */
3696
3688
  Agent?: Agent;
3697
3689
  /**
3698
- * 解除协议的签署人列表(如不指定该参数,默认使用原流程的签署人列表)。 <br/>
3699
- 如需更换原合同中的签署人,可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
3700
- 解除协议的签署人数量不能多于原流程的签署人数量。<br/>
3690
+ * 替换解除协议的签署人, 如不指定替换签署人, 则使用原流程的签署人。 <br/>
3691
+ 如需更换原合同中的企业端签署人,可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
3701
3692
 
3702
- `注意:只能更换同企业的签署人。`<br/>
3703
- `注意:不支持更换个人类型的签署人。`<br/>
3693
+ 注意:
3694
+ `只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人。`
3695
+ `可以不指定替换签署人, 使用原流程的签署人 `
3704
3696
  */
3705
3697
  ReleasedApprovers?: Array<ReleasedApprover>;
3706
3698
  /**
@@ -3739,21 +3731,65 @@ export interface CreateIntegrationUserRolesRequest {
3739
3731
  Agent?: Agent;
3740
3732
  }
3741
3733
  /**
3742
- * CreateChannelSubOrganizationModifyQrCode返回参数结构体
3734
+ * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
3743
3735
  */
3744
- export interface CreateChannelSubOrganizationModifyQrCodeResponse {
3736
+ export interface FlowDetailInfo {
3745
3737
  /**
3746
- * 二维码下载链接
3738
+ * 合同(流程)的ID
3747
3739
  */
3748
- QrCodeUrl?: string;
3740
+ FlowId?: string;
3749
3741
  /**
3750
- * 二维码失效时间 UNIX 时间戳 精确到秒
3742
+ * 合同(流程)的名字
3751
3743
  */
3752
- ExpiredTime?: number;
3744
+ FlowName?: string;
3753
3745
  /**
3754
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3746
+ * 合同(流程)的类型
3747
+ 注意:此字段可能返回 null,表示取不到有效值。
3755
3748
  */
3756
- RequestId?: string;
3749
+ FlowType?: string;
3750
+ /**
3751
+ * 流程状态
3752
+ - 0 还没有发起
3753
+ - 1 待签署
3754
+ - 2 部分签署
3755
+ - 3 已拒签
3756
+ - 4 已签署
3757
+ - 5 已过期
3758
+ - 6 已撤销
3759
+ - 7 还没有预发起
3760
+ - 8 等待填写
3761
+ - 9 部分填写
3762
+ - 10 拒填
3763
+ - 21 已解除
3764
+ */
3765
+ FlowStatus?: number;
3766
+ /**
3767
+ * 合同(流程)的信息
3768
+ 注意:此字段可能返回 null,表示取不到有效值。
3769
+ */
3770
+ FlowMessage?: string;
3771
+ /**
3772
+ * 流程的描述
3773
+ 注意:此字段可能返回 null,表示取不到有效值。
3774
+ */
3775
+ FlowDescription?: string;
3776
+ /**
3777
+ * 合同(流程)的创建时间戳,单位秒
3778
+ */
3779
+ CreatedOn?: number;
3780
+ /**
3781
+ * 合同(流程)的签署方数组
3782
+ */
3783
+ FlowApproverInfos?: Array<FlowApproverDetail>;
3784
+ /**
3785
+ * 合同(流程)的关注方信息列表
3786
+ */
3787
+ CcInfos?: Array<FlowApproverDetail>;
3788
+ /**
3789
+ * 合同发起人UserId
3790
+ 注意:此字段可能返回 null,表示取不到有效值。
3791
+ */
3792
+ Creator?: string;
3757
3793
  }
3758
3794
  /**
3759
3795
  * 更新员工信息成功返回的数据信息
@@ -3777,7 +3813,8 @@ export interface SuccessUpdateStaffData {
3777
3813
  */
3778
3814
  export interface CreatePersonAuthCertificateImageRequest {
3779
3815
  /**
3780
- * 操作人信息
3816
+ * 执行本接口操作的员工信息。
3817
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3781
3818
  */
3782
3819
  Operator: UserInfo;
3783
3820
  /**
@@ -3785,20 +3822,24 @@ export interface CreatePersonAuthCertificateImageRequest {
3785
3822
  */
3786
3823
  UserName: string;
3787
3824
  /**
3788
- * 身份证件类型取值:
3789
- ID_CARD 身居民身份证
3790
- PASSPORT 护照
3791
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
3792
- FOREIGN_ID_CARD 外国人永久居留身份证
3793
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
3825
+ * 证件类型,支持以下类型
3826
+ <ul><li> ID_CARD : 居民身份证 (默认值)</li>
3827
+ <li> PASSPORT : 护照</li>
3828
+ <li> FOREIGN_ID_CARD : 外国人永久居留身份证</li>
3829
+ <li> HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
3830
+ <li> HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
3794
3831
  */
3795
3832
  IdCardType: string;
3796
3833
  /**
3797
- * 身份证件号码
3834
+ * 证件号码,应符合以下规则
3835
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
3836
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
3837
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
3798
3838
  */
3799
3839
  IdCardNumber: string;
3800
3840
  /**
3801
- * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3841
+ * 代理企业和员工的信息。
3842
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3802
3843
  */
3803
3844
  Agent?: Agent;
3804
3845
  }
@@ -4102,6 +4143,12 @@ export interface ApproverInfo {
4102
4143
  注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
4103
4144
  */
4104
4145
  ApproverNeedSignReview?: boolean;
4146
+ /**
4147
+ * [用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID)或签名方式。
4148
+
4149
+ 注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
4150
+ */
4151
+ AddSignComponentsLimits?: Array<ComponentLimit>;
4105
4152
  }
4106
4153
  /**
4107
4154
  * CreateFlowSignReview返回参数结构体
@@ -4226,11 +4273,11 @@ export interface CreateUserAutoSignEnableUrlRequest {
4226
4273
  */
4227
4274
  export interface CreateOrganizationBatchSignUrlResponse {
4228
4275
  /**
4229
- * 批量签署入口链接
4276
+ * 批量签署入口链接,用户可使用这个链接跳转到控制台页面对合同进行签署操作。
4230
4277
  */
4231
4278
  SignUrl?: string;
4232
4279
  /**
4233
- * 链接过期时间戳
4280
+ * 链接过期截止时间,格式为Unix标准时间戳(秒),默认为7天后截止。
4234
4281
  */
4235
4282
  ExpiredTime?: number;
4236
4283
  /**
@@ -4252,25 +4299,6 @@ export interface DescribeIntegrationMainOrganizationUserResponse {
4252
4299
  */
4253
4300
  RequestId?: string;
4254
4301
  }
4255
- /**
4256
- * 催办接口返回的详细信息。
4257
- */
4258
- export interface RemindFlowRecords {
4259
- /**
4260
- * 合同流程是否可以催办:
4261
- true - 可以,false - 不可以。
4262
- 若无法催办,将返回RemindMessage以解释原因。
4263
- */
4264
- CanRemind?: boolean;
4265
- /**
4266
- * 合同流程ID,为32位字符串。
4267
- */
4268
- FlowId?: string;
4269
- /**
4270
- * 在合同流程无法催办的情况下,系统将返回RemindMessage以阐述原因。
4271
- */
4272
- RemindMessage?: string;
4273
- }
4274
4302
  /**
4275
4303
  * CancelUserAutoSignEnableUrl请求参数结构体
4276
4304
  */
@@ -4393,27 +4421,37 @@ export interface DeleteSealPoliciesRequest {
4393
4421
  */
4394
4422
  export interface CreateOrganizationBatchSignUrlRequest {
4395
4423
  /**
4396
- * 调用方用户信息,UserId 必填,支持填入集团子公司经办人UserId
4424
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId
4425
+ 支持填入集团子公司经办人 userId 代发合同。
4426
+
4427
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4397
4428
  */
4398
4429
  Operator: UserInfo;
4399
4430
  /**
4400
- * 指定需要进行批量签署的流程id,数量1-100,填写后用户将通过链接对这些合同进行批量签署。
4431
+ * 请指定需执行批量签署的流程ID,数量范围为1-100。</br>
4432
+ 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。</br>
4433
+ 用户将利用链接对这些合同实施批量操作。
4401
4434
  */
4402
4435
  FlowIds: Array<string>;
4403
4436
  /**
4404
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填。
4437
+ * 代理企业和员工的信息。
4438
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4405
4439
  */
4406
4440
  Agent?: Agent;
4407
4441
  /**
4408
- * 员工的UserId,该UserId对应的员工必须已经加入企业并实名,Name和Mobile为空时该字段不能为空。(优先使用UserId对应的员工)
4442
+ * 员工在腾讯电子签平台的独特身份标识,为32位字符串。</br>
4443
+ 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的UserId(在页面中显示为用户ID)。</br>
4444
+ UserId必须是传入合同(FlowId)中的签署人。
4445
+ - 1. 若UserId为空,Name和Mobile 必须提供。
4446
+ - 2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。
4409
4447
  */
4410
4448
  UserId?: string;
4411
4449
  /**
4412
- * 员工姓名,该字段需要与Mobile组合使用,UserId为空时该字段不能为空。(UserId为空时,使用Name和Mbile对应的员工)
4450
+ * 员工姓名,必须与手机号码一起使用。</br> 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
4413
4451
  */
4414
4452
  Name?: string;
4415
4453
  /**
4416
- * 员工手机号码,该字段需要与Name组合使用,UserId为空时该字段不能为空。(UserId为空时,使用Name和Mbile对应的员工)
4454
+ * 员工手机号,必须与姓名一起使用。</br> 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
4417
4455
  */
4418
4456
  Mobile?: string;
4419
4457
  }
@@ -4549,10 +4587,11 @@ export interface DeleteIntegrationDepartmentRequest {
4549
4587
  */
4550
4588
  export interface WebThemeConfig {
4551
4589
  /**
4552
- * 是否页面底部显示电子签logo
4553
- <br/>true:允许在页面底部隐藏电子签logo
4554
- <br/>false:不允许允许在页面底部隐藏电子签logo
4555
- <br/>默认false,不隐藏logo
4590
+ * 是否显示页面底部电子签logo,取值如下:
4591
+ <ul>
4592
+ <li> **true**:页面底部显示电子签logo</li>
4593
+ <li> **false**:页面底部不显示电子签logo(默认)</li>
4594
+ </ul>
4556
4595
  */
4557
4596
  DisplaySignBrandLogo?: boolean;
4558
4597
  /**
@@ -4771,7 +4810,7 @@ export interface ApproverOption {
4771
4810
  export interface CreateEmbedWebUrlResponse {
4772
4811
  /**
4773
4812
  * 嵌入的web链接,有效期:5分钟
4774
- EmbedType=PREVIEW_CC_FLOW,该url为h5链接
4813
+ <br/>EmbedType=PREVIEW_CC_FLOW,该url为h5链接
4775
4814
  */
4776
4815
  WebUrl?: string;
4777
4816
  /**
@@ -5308,15 +5347,20 @@ export interface UpdateIntegrationEmployeesRequest {
5308
5347
  */
5309
5348
  export interface DescribeFlowBriefsRequest {
5310
5349
  /**
5311
- * 调用方用户信息,userId 必填
5350
+ * 执行本接口操作的员工信息。
5351
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5312
5352
  */
5313
5353
  Operator: UserInfo;
5314
5354
  /**
5315
- * 需要查询的流程ID列表,限制最大100
5355
+ * 查询的合同流程ID列表最多支持100个流程ID。
5356
+ 如果某个合同流程ID不存在,系统会跳过此ID的查询,继续查询剩余存在的合同流程。
5357
+
5358
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
5316
5359
  */
5317
5360
  FlowIds: Array<string>;
5318
5361
  /**
5319
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5362
+ * 代理企业和员工的信息。
5363
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5320
5364
  */
5321
5365
  Agent?: Agent;
5322
5366
  }
@@ -5406,7 +5450,8 @@ export interface DeleteStaffsResult {
5406
5450
  */
5407
5451
  export interface DescribeFlowBriefsResponse {
5408
5452
  /**
5409
- * 流程列表
5453
+ * 合同流程基础信息列表,包含流程的名称、状态、创建日期等基本信息。
5454
+ 注:`与入参 FlowIds 的顺序可能存在不一致的情况。`
5410
5455
  */
5411
5456
  FlowBriefs?: Array<FlowBrief>;
5412
5457
  /**
@@ -5554,27 +5599,24 @@ export interface ExtendAuthInfo {
5554
5599
  */
5555
5600
  export interface RelieveInfo {
5556
5601
  /**
5557
- * 解除理由,最大支持200个字
5602
+ * 解除理由,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
5558
5603
  */
5559
5604
  Reason: string;
5560
5605
  /**
5561
- * 解除后仍然有效的条款,保留条款,最大支持200个字
5606
+ * 解除后仍然有效的条款,保留条款,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
5562
5607
 
5563
5608
  */
5564
5609
  RemainInForceItem?: string;
5565
5610
  /**
5566
- * 原合同事项处理-费用结算,最大支持200个字
5567
-
5611
+ * 原合同事项处理-费用结算,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
5568
5612
  */
5569
5613
  OriginalExpenseSettlement?: string;
5570
5614
  /**
5571
- * 原合同事项处理-其他事项,最大支持200个字
5572
-
5615
+ * 原合同事项处理-其他事项,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
5573
5616
  */
5574
5617
  OriginalOtherSettlement?: string;
5575
5618
  /**
5576
- * 其他约定,最大支持200个字
5577
-
5619
+ * 其他约定,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
5578
5620
  */
5579
5621
  OtherDeals?: string;
5580
5622
  }
@@ -5602,17 +5644,18 @@ export interface EmbedUrlOption {
5602
5644
  */
5603
5645
  export interface CreateBatchCancelFlowUrlRequest {
5604
5646
  /**
5605
- * 调用方用户信息,userId 必填
5647
+ * 执行本接口操作的员工信息。
5648
+ <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
5606
5649
  */
5607
5650
  Operator: UserInfo;
5608
5651
  /**
5609
5652
  * 需要执行撤回的流程(合同)的编号列表,最多100个.
5610
- 列表中的流程(合同)编号不要重复.
5653
+ <br>列表中的流程(合同)编号不要重复.
5611
5654
  */
5612
5655
  FlowIds: Array<string>;
5613
5656
  /**
5614
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5615
-
5657
+ * 代理企业和员工的信息。
5658
+ <br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5616
5659
  */
5617
5660
  Agent?: Agent;
5618
5661
  }