tencentcloud-sdk-nodejs-ess 4.0.691 → 4.0.693

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.
@@ -41,10 +41,12 @@ export interface CreateSealRequest {
41
41
  GenerateSource?: string
42
42
  /**
43
43
  * 电子印章类型:
44
- OFFICIAL-公章;
45
- CONTRACT-合同专用章;
46
- FINANCE-合财务专用章;
47
- PERSONNEL-人事专用章.
44
+ <ul>
45
+ <li>OFFICIAL-公章;</li>
46
+ <li>CONTRACT-合同专用章;</li>
47
+ <li>FINANCE-合财务专用章;</li>
48
+ <li>PERSONNEL-人事专用章.</li>
49
+ </ul>
48
50
  */
49
51
  SealType?: string
50
52
  /**
@@ -90,18 +92,22 @@ PERSONNEL-人事专用章.
90
92
  */
91
93
  FileToken?: string
92
94
  /**
93
- * 印章样式:
95
+ * 印章样式,取值如下:
94
96
 
95
- cycle:圆形印章;
96
- ellipse:椭圆印章;
97
- 注:默认圆形印章
97
+ <ul>
98
+ <li>cycle:圆形印章;</li>
99
+ <li>ellipse:椭圆印章;</li>
100
+ <li>注:默认圆形印章</li>
101
+ </ul>
98
102
  */
99
103
  SealStyle?: string
100
104
  /**
101
105
  * 印章尺寸取值描述:
102
- 42_42 圆形企业公章直径42mm;
103
- 40_40 圆形企业印章直径40mm;
104
- 45_30 椭圆形印章45mm x 30mm;
106
+ <ul>
107
+ <li>42_42 圆形企业公章直径42mm;</li>
108
+ <li>40_40 圆形企业印章直径40mm;</li>
109
+ <li>45_30 椭圆形印章45mm x 30mm;</li>
110
+ </ul>
105
111
  */
106
112
  SealSize?: string
107
113
  }
@@ -187,24 +193,26 @@ export interface CreatePreparedPersonalEsignRequest {
187
193
  */
188
194
  UserName: string
189
195
  /**
190
- * 身份证件号码
196
+ * 证件号码,应符合以下规则
197
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
198
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
199
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
191
200
  */
192
201
  IdCardNumber: string
193
202
  /**
194
- * 印章名称
203
+ * 印章名称,长度1-50个字。
195
204
  */
196
205
  SealName: string
197
206
  /**
198
- * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
207
+ * 执行本接口操作的员工信息。
208
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
199
209
  */
200
210
  Operator?: UserInfo
201
211
  /**
202
- * 身份证件类型:
203
- ID_CARD 身份证
204
- PASSPORT 护照
205
- HONGKONG_AND_MACAO 中国香港
206
- FOREIGN_ID_CARD 境外身份
207
- HONGKONG_MACAO_AND_TAIWAN 中国台湾
212
+ * 证件类型,支持以下类型
213
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
214
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
215
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
208
216
  */
209
217
  IdCardType?: string
210
218
  /**
@@ -236,10 +244,12 @@ BLUE 蓝色。
236
244
  */
237
245
  SealColor?: string
238
246
  /**
239
- * 是否处理印章
240
- 默认不做印章处理。
241
- 取值:false:不做任何处理;
242
- true:做透明化处理和颜色增强。
247
+ * 是否处理印章,默认不做印章处理。
248
+ 取值如下:
249
+ <ul>
250
+ <li>false:不做任何处理;</li>
251
+ <li>true:做透明化处理和颜色增强。</li>
252
+ </ul>
243
253
  */
244
254
  ProcessSeal?: boolean
245
255
  /**
@@ -249,7 +259,8 @@ true:做透明化处理和颜色增强。
249
259
  */
250
260
  FileId?: string
251
261
  /**
252
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
262
+ * 代理企业和员工的信息。
263
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
253
264
  */
254
265
  Agent?: Agent
255
266
  /**
@@ -477,62 +488,62 @@ export interface CreateIntegrationEmployeesRequest {
477
488
  export interface CreateFlowOption {
478
489
  /**
479
490
  * 是否允许修改发起合同时确认弹窗的合同信息(合同名称、合同类型、签署截止时间),若不允许编辑,则表单字段将被禁止输入。
480
- <br/>true:允许编辑(默认),<br/>false:不允许编辑<br/>默认:false:不允许编辑
491
+ <br/>true:允许编辑<br/>false:不允许编辑(默认值)<br/>
481
492
  */
482
493
  CanEditFlow?: boolean
483
494
  /**
484
495
  * 是否允许编辑模板控件
485
496
  <br/>true:允许编辑模板控件信息
486
- <br/>false:不允许编辑模板控件信息
487
- <br/>默认false:不允许编辑模板控件信息
497
+ <br/>false:不允许编辑模板控件信息(默认值)
498
+ <br/>
488
499
  */
489
500
  CanEditFormField?: boolean
490
501
  /**
491
502
  * 发起页面隐藏合同名称展示
492
503
  <br/>true:发起页面隐藏合同名称展示
493
- <br/>false:发起页面不隐藏合同名称展示
494
- <br/>默认false:发起页面不隐藏合同名称展示
504
+ <br/>false:发起页面不隐藏合同名称展示(默认值)
505
+ <br/>
495
506
  */
496
507
  HideShowFlowName?: boolean
497
508
  /**
498
509
  * 发起页面隐藏合同类型展示
499
510
  <br/>true:发起页面隐藏合同类型展示
500
- <br/>false:发起页面不隐藏合同类型展示
501
- <br/>默认false:发起页面不隐藏合同类型展示
511
+ <br/>false:发起页面不隐藏合同类型展示(默认值)
512
+ <br/>
502
513
 
503
514
  */
504
515
  HideShowFlowType?: boolean
505
516
  /**
506
517
  * 发起页面隐藏合同截止日期展示
507
518
  <br/>true:发起页面隐藏合同截止日期展示
508
- <br/>false:发起页面不隐藏合同截止日期展示
509
- <br/>默认false:发起页面不隐藏合同截止日期展示
519
+ <br/>false:发起页面不隐藏合同截止日期展示(默认值)
520
+ <br/>
510
521
  */
511
522
  HideShowDeadline?: boolean
512
523
  /**
513
524
  * 发起页面允许跳过添加签署人环节
514
525
  <br/>true:发起页面允许跳过添加签署人环节
515
- <br/>false:发起页面不允许跳过添加签署人环节
516
- <br/>默认false:发起页面不允许跳过添加签署人环节
526
+ <br/>false:发起页面不允许跳过添加签署人环节(默认值)
527
+ <br/>
517
528
 
518
529
  */
519
530
  CanSkipAddApprover?: boolean
520
531
  /**
521
532
  * 文件发起页面跳过文件上传步骤
522
533
  <br/>true:文件发起页面跳过文件上传步骤
523
- <br/>false:文件发起页面不跳过文件上传步骤
524
- <br/>默认false:文件发起页面不跳过文件上传步骤
534
+ <br/>false:文件发起页面不跳过文件上传步骤(默认值)
535
+ <br/>
525
536
  */
526
537
  SkipUploadFile?: boolean
527
538
  /**
528
539
  * 禁止编辑填写控件
529
540
  <br/>true:禁止编辑填写控件
530
- <br/>false:允许编辑填写控件
531
- <br/>默认false:允许编辑填写控件
541
+ <br/>false:允许编辑填写控件(默认值)
542
+ <br/>
532
543
  */
533
544
  ForbidEditFillComponent?: boolean
534
545
  /**
535
- * 定制化发起合同弹窗的描述信息,描述信息最长500
546
+ * 定制化发起合同弹窗的描述信息,描述信息最长500字符
536
547
 
537
548
  */
538
549
  CustomCreateFlowDescription?: string
@@ -1037,7 +1048,7 @@ export interface CreateFlowGroupByFilesRequest {
1037
1048
  */
1038
1049
  export interface DescribeFlowComponentsResponse {
1039
1050
  /**
1040
- * 流程关联的填写控件信息,按照参与方进行分类返回。
1051
+ * 合同流程关联的填写控件信息,按照参与方进行分类返回。
1041
1052
  注意:此字段可能返回 null,表示取不到有效值。
1042
1053
  */
1043
1054
  RecipientComponentInfos?: Array<RecipientComponentInfo>
@@ -1247,7 +1258,8 @@ export interface CreateDocumentResponse {
1247
1258
  /**
1248
1259
  * 合同预览链接URL。
1249
1260
 
1250
- 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
1261
+ 注: `1.如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL`
1262
+ `2.当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容`
1251
1263
  注意:此字段可能返回 null,表示取不到有效值。
1252
1264
  */
1253
1265
  PreviewFileUrl?: string
@@ -1785,40 +1797,44 @@ export interface CreateIntegrationDepartmentResponse {
1785
1797
  */
1786
1798
  export interface DescribeFlowTemplatesRequest {
1787
1799
  /**
1788
- * 调用方员工/经办人信息
1789
- UserId 必填,在企业控制台组织架构中可以查到员工的UserId
1790
- 注:请保证员工有相关的角色权限
1800
+ * 执行本接口操作的员工信息。
1801
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1791
1802
  */
1792
1803
  Operator: UserInfo
1793
1804
  /**
1794
- * 代理相关应用信息
1795
- 如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1805
+ * 代理企业和员工的信息。
1806
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1796
1807
  */
1797
1808
  Agent?: Agent
1798
1809
  /**
1799
- * 查询内容类型
1800
- 0-模板列表及详情(默认)
1801
- 1-仅模板列表
1810
+ * 查询内容控制
1811
+
1812
+ <ul><li>**0**:模板列表及详情(默认)</li>
1813
+ <li>**1**:仅模板列表</li></ul>
1802
1814
  */
1803
1815
  ContentType?: number
1804
1816
  /**
1805
1817
  * 搜索条件,本字段用于指定模板Id进行查询。
1806
- Key:template-id
1807
- Values:需要查询的模板Id列表
1818
+ Key:template-id Values:需要查询的模板Id列表
1808
1819
  */
1809
1820
  Filters?: Array<Filter>
1810
1821
  /**
1811
- * 查询结果分页返回,此处指定第几页,如果不传默从第一页返回。页码从0开始,即首页为0。
1822
+ * 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
1823
+
1824
+ 注:`1.offset从0开始,即第一页为0。`
1825
+ `2.默认从第一页返回。`
1812
1826
  */
1813
1827
  Offset?: number
1814
1828
  /**
1815
- * 指定每页多少条数据,如果不传默认为20,单页最大200。
1829
+ * 指定每页返回的数据条数,和Offset参数配合使用。
1830
+
1831
+ 注:`1.默认值为20,单页做大值为200。`
1816
1832
  */
1817
1833
  Limit?: number
1818
1834
  /**
1819
- * 用于查询指定应用号下单模板列表。
1820
- ApplicationId不为空,查询指定应用下的模板列表
1821
- ApplicationId为空,查询所有应用下的模板列表
1835
+ * 指定查询的应用号,指定后查询该应用号下的模板列表。
1836
+
1837
+ 注:`1.ApplicationId为空时,查询所有应用下的模板列表。`
1822
1838
  */
1823
1839
  ApplicationId?: string
1824
1840
  /**
@@ -2192,7 +2208,8 @@ export interface SignQrCode {
2192
2208
  */
2193
2209
  export interface CreateSealPolicyResponse {
2194
2210
  /**
2195
- * 最终授权成功的。其他的跳过的是已经授权了的
2211
+ * 最终授权成功的用户ID,在腾讯电子签平台的唯一身份标识,为32位字符串。
2212
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
2196
2213
  */
2197
2214
  UserIds?: Array<string>
2198
2215
  /**
@@ -2546,20 +2563,29 @@ export interface RegisterInfo {
2546
2563
  */
2547
2564
  export interface DescribeFileUrlsRequest {
2548
2565
  /**
2549
- * 调用方用户信息,UserId 必填
2566
+ * 执行本接口操作的员工信息。
2567
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2550
2568
  */
2551
2569
  Operator: UserInfo
2552
2570
  /**
2553
2571
  * 文件对应的业务类型,目前支持:
2554
- - 流程 "FLOW",如需下载合同文件请选择此项
2555
- - 模板 "TEMPLATE"
2556
- - 文档 "DOCUMENT"
2557
- - 印章 “SEAL”
2572
+ <ul>
2573
+ <li>FLOW 如需下载合同文件请选择此项</li>
2574
+ <li>TEMPLATE 如需下载模板文件请选择此项</li>
2575
+ <li>DOCUMENT 如需下载文档文件请选择此项</li>
2576
+ <li>SEAL 如需下载印章图片请选择此项</li>
2577
+ </ul>
2558
2578
  */
2559
2579
  BusinessType: string
2560
2580
  /**
2561
- * 业务编号的数组,如流程编号、模板编号、文档编号、印章编号。如需下载合同文件请传入FlowId
2562
- 最大支持20个资源
2581
+ * 业务编号的数组,取值如下:
2582
+ <ul>
2583
+ <li>流程编号</li>
2584
+ <li>模板编号</li>
2585
+ <li>文档编号</li>
2586
+ <li>印章编号</li>
2587
+ <li>如需下载合同文件请传入FlowId,最大支持20个资源</li>
2588
+ </ul>
2563
2589
  */
2564
2590
  BusinessIds: Array<string>
2565
2591
  /**
@@ -2567,15 +2593,20 @@ export interface DescribeFileUrlsRequest {
2567
2593
  */
2568
2594
  FileName?: string
2569
2595
  /**
2570
- * 文件类型,"JPG", "PDF","ZIP"等
2596
+ * 要下载的文件类型,取值如下:
2597
+ <ul>
2598
+ <li>JPG</li>
2599
+ <li>PDF</li>
2600
+ <li>ZIP</li>
2601
+ </ul>
2571
2602
  */
2572
2603
  FileType?: string
2573
2604
  /**
2574
- * 指定资源起始偏移量,默认0
2605
+ * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。
2575
2606
  */
2576
2607
  Offset?: number
2577
2608
  /**
2578
- * 指定资源数量,查询全部资源则传入-1
2609
+ * 指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。
2579
2610
  */
2580
2611
  Limit?: number
2581
2612
  /**
@@ -3161,13 +3192,15 @@ export interface RecipientComponentInfo {
3161
3192
  RecipientId?: string
3162
3193
  /**
3163
3194
  * 参与方填写状态
3164
- 0-未填写
3165
- 1-已填写
3195
+ <ul><li>0-未填写</li>
3196
+ <li>1-已填写</li></ul>
3166
3197
  注意:此字段可能返回 null,表示取不到有效值。
3167
3198
  */
3168
3199
  RecipientFillStatus?: string
3169
3200
  /**
3170
3201
  * 是否为发起方
3202
+ <ul><li>true-发起方</li>
3203
+ <li>false-参与方</li></ul>
3171
3204
  注意:此字段可能返回 null,表示取不到有效值。
3172
3205
  */
3173
3206
  IsPromoter?: boolean
@@ -3227,15 +3260,19 @@ export interface CreateIntegrationRoleResponse {
3227
3260
  */
3228
3261
  export interface DescribeFlowComponentsRequest {
3229
3262
  /**
3230
- * 操作者信息
3263
+ * 执行本接口操作的员工信息。
3264
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3231
3265
  */
3232
3266
  Operator: UserInfo
3233
3267
  /**
3234
- * 流程(合同)的编号
3268
+ * 合同流程ID,为32位字符串。
3269
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
3270
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
3235
3271
  */
3236
3272
  FlowId: string
3237
3273
  /**
3238
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3274
+ * 代理企业和员工的信息。
3275
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3239
3276
  */
3240
3277
  Agent?: Agent
3241
3278
  }
@@ -3396,6 +3433,7 @@ export interface CreateDocumentRequest {
3396
3433
  * 是否为预览模式,取值如下:
3397
3434
  <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
3398
3435
  <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
3436
+ 注: `当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容`
3399
3437
  */
3400
3438
  NeedPreview?: boolean
3401
3439
  /**
@@ -3442,7 +3480,8 @@ true - 可以,false - 不可以。
3442
3480
  */
3443
3481
  export interface CreatePreparedPersonalEsignResponse {
3444
3482
  /**
3445
- * 导入生成的印章ID
3483
+ * 导入生成的印章ID,为32位字符串。
3484
+ 建议开发者保存此印章ID,开头实名认证后,通过此 ID查询导入的印章。
3446
3485
  */
3447
3486
  SealId?: string
3448
3487
  /**
@@ -3964,58 +4003,46 @@ export interface CreateIntegrationUserRolesRequest {
3964
4003
  */
3965
4004
  export interface FlowDetailInfo {
3966
4005
  /**
3967
- * 合同(流程)的ID
4006
+ * 合同流程ID,为32位字符串。
3968
4007
  */
3969
4008
  FlowId?: string
3970
4009
  /**
3971
- * 合同(流程)的名字
4010
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
3972
4011
  */
3973
4012
  FlowName?: string
3974
4013
  /**
3975
- * 合同(流程)的类型
4014
+ * 合同流程的类别分类(如销售合同/入职合同等)。
3976
4015
  注意:此字段可能返回 null,表示取不到有效值。
3977
4016
  */
3978
4017
  FlowType?: string
3979
4018
  /**
3980
- * 流程状态
3981
- - 0 还没有发起
3982
- - 1 待签署
3983
- - 2 部分签署
3984
- - 3 已拒签
3985
- - 4 已签署
3986
- - 5 已过期
3987
- - 6 已撤销
3988
- - 7 还没有预发起
3989
- - 8 等待填写
3990
- - 9 部分填写
3991
- - 10 拒填
3992
- - 21 已解除
4019
+ * 合同流程当前的签署状态, 会存在下列的状态值 <ul><li> **0** : 未开启流程(合同中不存在填写环节)</li> <li> **1** : 待签署</li> <li> **2** : 部分签署</li> <li> **3** : 已拒签</li> <li> **4** : 已签署</li> <li> **5** : 已过期</li> <li> **6** : 已撤销</li> <li> **7** : 未开启流程(合同中存在填写环节)</li> <li> **8** : 等待填写</li> <li> **9** : 部分填写</li> <li> **10** : 已拒填</li> <li> **21** : 已解除</li></ul>
3993
4020
  */
3994
4021
  FlowStatus?: number
3995
4022
  /**
3996
- * 合同(流程)的信息
4023
+ * 当合同流程状态为已拒签(即 FlowStatus=3)或已撤销(即 FlowStatus=6)时,此字段 FlowMessage 为拒签或撤销原因。
3997
4024
  注意:此字段可能返回 null,表示取不到有效值。
3998
4025
  */
3999
4026
  FlowMessage?: string
4000
4027
  /**
4001
- * 流程的描述
4028
+ * 合同流程描述信息。
4002
4029
  注意:此字段可能返回 null,表示取不到有效值。
4003
4030
  */
4004
4031
  FlowDescription?: string
4005
4032
  /**
4006
- * 合同(流程)的创建时间戳,单位秒
4033
+ * 合同流程的创建时间戳,格式为Unix标准时间戳(秒)。
4007
4034
  */
4008
4035
  CreatedOn?: number
4009
4036
  /**
4010
- * 合同(流程)的签署方数组
4037
+ * 合同流程的签署方数组
4011
4038
  */
4012
4039
  FlowApproverInfos?: Array<FlowApproverDetail>
4013
4040
  /**
4014
- * 合同(流程)的关注方信息列表
4041
+ * 合同流程的关注方信息数组
4015
4042
  */
4016
4043
  CcInfos?: Array<FlowApproverDetail>
4017
4044
  /**
4018
- * 合同发起人UserId
4045
+ * 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
4019
4046
  注意:此字段可能返回 null,表示取不到有效值。
4020
4047
  */
4021
4048
  Creator?: string
@@ -4219,13 +4246,20 @@ WECHAT-微信通知
4219
4246
  */
4220
4247
  export interface VerifyPdfRequest {
4221
4248
  /**
4222
- * 流程ID
4249
+ * 合同流程ID,为32位字符串。
4250
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
4223
4251
  */
4224
4252
  FlowId: string
4225
4253
  /**
4226
- * 调用方用户信息,userId 必填
4254
+ * 执行本接口操作的员工信息。
4255
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
4227
4256
  */
4228
4257
  Operator?: UserInfo
4258
+ /**
4259
+ * 代理企业和员工的信息。
4260
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4261
+ */
4262
+ Agent?: Agent
4229
4263
  }
4230
4264
 
4231
4265
  /**
@@ -4640,7 +4674,7 @@ export interface CreateWebThemeConfigRequest {
4640
4674
  */
4641
4675
  ThemeType: string
4642
4676
  /**
4643
- * 主题配置
4677
+ * 电子签logo是否展示,主体颜色等配置项
4644
4678
  */
4645
4679
  WebThemeConfig: WebThemeConfig
4646
4680
  /**
@@ -4655,7 +4689,8 @@ export interface CreateWebThemeConfigRequest {
4655
4689
  */
4656
4690
  export interface DeleteSealPoliciesRequest {
4657
4691
  /**
4658
- * 调用方用户信息,userId 必填
4692
+ * 执行本接口操作的员工信息。
4693
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4659
4694
  */
4660
4695
  Operator: UserInfo
4661
4696
  /**
@@ -4663,15 +4698,20 @@ export interface DeleteSealPoliciesRequest {
4663
4698
  */
4664
4699
  PolicyIds?: Array<string>
4665
4700
  /**
4666
- * 印章ID。这个参数跟上面的PolicyIds其中一个必填,另外一个可选填
4701
+ * 电子印章ID,为32位字符串。
4702
+ 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
4703
+ 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
4704
+ 注:印章ID。这个参数跟上面的PolicyIds其中一个必填,另外一个可选填。
4667
4705
  */
4668
4706
  SealId?: string
4669
4707
  /**
4670
- * 待授权的员工ID
4708
+ * 待授权的员工ID,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
4709
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
4671
4710
  */
4672
4711
  UserIds?: Array<string>
4673
4712
  /**
4674
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4713
+ * 代理企业和员工的信息。
4714
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4675
4715
  */
4676
4716
  Agent?: Agent
4677
4717
  }
@@ -4759,7 +4799,7 @@ export interface IntegrateRole {
4759
4799
  */
4760
4800
  export interface CreatePrepareFlowResponse {
4761
4801
  /**
4762
- * 快速发起预览链接,有效期5分钟
4802
+ * 发起流程的web页面链接,有效期5分钟
4763
4803
  */
4764
4804
  Url?: string
4765
4805
  /**
@@ -4932,7 +4972,9 @@ export interface StartFlowRequest {
4932
4972
  */
4933
4973
  export interface CreateSealResponse {
4934
4974
  /**
4935
- * 电子印章编号
4975
+ * 电子印章ID,为32位字符串。
4976
+ 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
4977
+ 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
4936
4978
  */
4937
4979
  SealId?: string
4938
4980
  /**
@@ -4946,62 +4988,67 @@ export interface CreateSealResponse {
4946
4988
  */
4947
4989
  export interface CreatePrepareFlowRequest {
4948
4990
  /**
4949
- * 调用方用户信息,userId 必填
4991
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId
4992
+ 支持填入集团子公司经办人 userId 代发合同。
4993
+
4994
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4950
4995
  */
4951
4996
  Operator: UserInfo
4952
4997
  /**
4953
- * 资源id,与ResourceType对应
4998
+ * 资源id,与ResourceType相对应,取值范围:
4999
+ <ul>
5000
+ <li>文件Id(通过UploadFiles获取文件资源Id)</li>
5001
+ <li>模板Id</li>
5002
+ </ul>
4954
5003
  */
4955
5004
  ResourceId: string
4956
5005
  /**
4957
- * 合同名称
5006
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
5007
+
4958
5008
  */
4959
5009
  FlowName: string
4960
5010
  /**
4961
- * 是否顺序签署
4962
- true:无序签
4963
- false:顺序签
5011
+ * 合同流程的签署顺序类型:
5012
+ <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
5013
+ <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
4964
5014
  */
4965
5015
  Unordered?: boolean
4966
5016
  /**
4967
- * 签署流程的签署截止时间。
4968
- 值为unix时间戳,精确到秒
4969
- 不传默认为当前时间一年后
5017
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
5018
+
4970
5019
  */
4971
5020
  Deadline?: number
4972
5021
  /**
4973
5022
  * 用户自定义合同类型Id
4974
5023
 
4975
- 该id为电子签企业内的合同类型id, 可以在自定义合同类型处获取
5024
+ 该id为电子签企业内的合同类型id, 可以在控制台-合同-自定义合同类型处获取
5025
+ 注: `该参数如果和FlowType同时传,以该参数优先生效`
4976
5026
  */
4977
5027
  UserFlowTypeId?: string
4978
5028
  /**
4979
- * 合同类型名称
4980
- 该字段用于客户自定义合同类型
4981
- 建议使用时指定合同类型,便于之后合同分类以及查看
4982
- 如果合同类型与自定义的合同类型描述一致,会自动归类到自定义的合同类型处,如果不一致,则会创建一个新的自定义合同类型
5029
+ * 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
4983
5030
  */
4984
5031
  FlowType?: string
4985
5032
  /**
4986
- * 签署流程参与者信息,最大限制50
5033
+ * 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
5034
+
5035
+ 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
4987
5036
  */
4988
5037
  Approvers?: Array<FlowCreateApprover>
4989
5038
  /**
4990
- * 打开智能添加填写区
4991
- 默认开启,打开:"OPEN"
4992
- 关闭:"CLOSE"
5039
+ * 开启或者关闭智能添加填写区:
5040
+ <ul><li> **OPEN**:开启(默认值)</li>
5041
+ <li> **CLOSE**:关闭</li></ul>
4993
5042
  */
4994
5043
  IntelligentStatus?: string
4995
5044
  /**
4996
- * 资源类型,
4997
- 1:模板
4998
- 2:文件,
4999
- 不传默认为2:文件
5045
+ * 资源类型,取值有:
5046
+ <ul><li> **1**:模板</li>
5047
+ <li> **2**:文件(默认值)</li></ul>
5000
5048
  */
5001
5049
  ResourceType?: number
5002
5050
  /**
5003
- * 发起方填写控件
5004
- 该类型控件由发起方完成填写
5051
+ * 该字段已废弃,请使用InitiatorComponents
5005
5052
  */
5006
5053
  Components?: Component
5007
5054
  /**
@@ -5011,31 +5058,44 @@ false:顺序签
5011
5058
  */
5012
5059
  FlowOption?: CreateFlowOption
5013
5060
  /**
5014
- * 是否开启发起方签署审核
5015
- true:开启发起方签署审核
5016
- false:不开启发起方签署审核
5017
- 默认false:不开启发起方签署审核
5061
+ * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
5062
+ <ul><li> **false**:(默认)不需要审批,直接签署。</li>
5063
+ <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
5064
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
5065
+ <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
5066
+ <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
5067
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
5018
5068
  */
5019
5069
  NeedSignReview?: boolean
5020
5070
  /**
5021
- * 开启发起方发起合同审核
5022
- true:开启发起方发起合同审核
5023
- false:不开启发起方发起合同审核
5024
- 默认false:不开启发起方发起合同审核
5071
+ * 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
5072
+
5073
+ 若设置为true,发起审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
5074
+
5075
+
5025
5076
  */
5026
5077
  NeedCreateReview?: boolean
5027
5078
  /**
5028
- * 用户自定义参数
5079
+ * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
5080
+
5081
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
5029
5082
  */
5030
5083
  UserData?: string
5031
5084
  /**
5032
- * 合同id,用于通过已web页面发起的合同id快速生成一个web发起合同链接
5085
+ * 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
5086
+ 注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`
5033
5087
  */
5034
5088
  FlowId?: string
5035
5089
  /**
5036
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5090
+ * 代理企业和员工的信息。
5091
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5037
5092
  */
5038
5093
  Agent?: Agent
5094
+ /**
5095
+ * 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
5096
+
5097
+ */
5098
+ InitiatorComponents?: Array<Component>
5039
5099
  }
5040
5100
 
5041
5101
  /**
@@ -5078,7 +5138,8 @@ export interface CreateEmbedWebUrlResponse {
5078
5138
  */
5079
5139
  export interface CreateSealPolicyRequest {
5080
5140
  /**
5081
- * 调用方用户信息,userId 必填
5141
+ * 执行本接口操作的员工信息。
5142
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5082
5143
  */
5083
5144
  Operator: UserInfo
5084
5145
  /**
@@ -5086,7 +5147,9 @@ export interface CreateSealPolicyRequest {
5086
5147
  */
5087
5148
  Users: Array<UserInfo>
5088
5149
  /**
5089
- * 印章ID
5150
+ * 电子印章ID,为32位字符串。
5151
+ 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
5152
+ 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
5090
5153
  */
5091
5154
  SealId: string
5092
5155
  /**
@@ -5102,7 +5165,8 @@ export interface CreateSealPolicyRequest {
5102
5165
  */
5103
5166
  Policy?: string
5104
5167
  /**
5105
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5168
+ * 代理企业和员工的信息。
5169
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5106
5170
  */
5107
5171
  Agent?: Agent
5108
5172
  }
@@ -5112,19 +5176,24 @@ export interface CreateSealPolicyRequest {
5112
5176
  */
5113
5177
  export interface DescribeOrganizationSealsRequest {
5114
5178
  /**
5115
- * 调用方用户信息,userId 必填
5179
+ * 执行本接口操作的员工信息。
5180
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5116
5181
  */
5117
5182
  Operator: UserInfo
5118
5183
  /**
5119
- * 返回最大数量,最大为100
5184
+ * 指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 200。
5120
5185
  */
5121
5186
  Limit: number
5122
5187
  /**
5123
- * 偏移量,默认为0,最大为20000
5188
+ * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 20000
5124
5189
  */
5125
5190
  Offset?: number
5126
5191
  /**
5127
- * 查询信息类型,为0时不返回授权用户,为1时返回
5192
+ * 查询信息类型,取值如下:
5193
+ <ul>
5194
+ <li>0不返回授权用户</li>
5195
+ <li>1返回授权用户信息</li>
5196
+ </ul>
5128
5197
  */
5129
5198
  InfoType?: number
5130
5199
  /**
@@ -5135,28 +5204,32 @@ export interface DescribeOrganizationSealsRequest {
5135
5204
  * 印章类型列表(都是组织机构印章)。
5136
5205
  为空时查询所有类型的印章。
5137
5206
  目前支持以下类型:
5138
- OFFICIAL:企业公章;
5139
- CONTRACT:合同专用章;
5140
- ORGANIZATION_SEAL:企业印章(图片上传创建);
5141
- LEGAL_PERSON_SEAL:法定代表人章
5207
+ <ul>
5208
+ <li>OFFICIAL:企业公章;</li>
5209
+ <li>CONTRACT:合同专用章;</li>
5210
+ <li>ORGANIZATION_SEAL:企业印章(图片上传创建);</li>
5211
+ <li>LEGAL_PERSON_SEAL:法定代表人章</li>
5212
+ </ul>
5142
5213
  */
5143
5214
  SealTypes?: Array<string>
5144
5215
  /**
5145
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5216
+ * 代理企业和员工的信息。
5217
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5146
5218
  */
5147
5219
  Agent?: Agent
5148
5220
  /**
5149
5221
  * 查询的印章状态列表。
5150
- 取值为空,只查询启用状态的印章;
5151
- 取值ALL,查询所有状态的印章;
5152
- 取值CHECKING,查询待审核的印章;
5153
- 取值SUCCESS,查询启用状态的印章;
5154
- 取值FAIL,查询印章审核拒绝的印章;
5155
- 取值DISABLE,查询已停用的印章;
5156
- 取值STOPPED,查询已终止的印章;
5157
- 取值VOID,查询已作废的印章;
5158
- 取值INVALID,查询已失效的印章;
5159
-
5222
+ <ul>
5223
+ <li>空,只查询启用状态的印章;</li>
5224
+ <li>ALL,查询所有状态的印章;</li>
5225
+ <li>CHECKING,查询待审核的印章;</li>
5226
+ <li>SUCCESS,查询启用状态的印章;</li>
5227
+ <li>FAIL,查询印章审核拒绝的印章;</li>
5228
+ <li>DISABLE,查询已停用的印章;</li>
5229
+ <li>STOPPED,查询已终止的印章;</li>
5230
+ <li>VOID,查询已作废的印章;</li>
5231
+ <li>INVALID,查询已失效的印章;</li>
5232
+ </ul>
5160
5233
  */
5161
5234
  SealStatuses?: Array<string>
5162
5235
  }
@@ -5773,15 +5846,26 @@ export interface SignUrl {
5773
5846
  */
5774
5847
  export interface VerifyPdfResponse {
5775
5848
  /**
5776
- * 验签结果,1-文件未被篡改,全部签名在腾讯电子签完成; 2-文件未被篡改,部分签名在腾讯电子签完成;3-文件被篡改;4-异常:文件内没有签名域;5-异常:文件签名格式错误
5849
+ * 验签结果代码,代码的含义如下:
5850
+
5851
+ <ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>
5852
+ <li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>
5853
+ <li>**3**:文件被篡改。</li>
5854
+ <li>**4**:异常:文件内没有签名域。</li>
5855
+ <li>**5**:异常:文件签名格式错误。</li></ul>
5777
5856
  */
5778
5857
  VerifyResult?: number
5779
5858
  /**
5780
- * 验签结果详情,每个签名域对应的验签结果。状态值:1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域;5-文件签名格式错误
5859
+ * 验签结果详情,每个签名域对应的验签结果。状态值如下
5860
+ <ul><li> **1** :验签成功,在电子签签署</li>
5861
+ <li> **2** :验签成功,在其他平台签署</li>
5862
+ <li> **3** :验签失败</li>
5863
+ <li> **4** :pdf文件没有签名域</li>
5864
+ <li> **5** :文件签名格式错误</li></ul>
5781
5865
  */
5782
5866
  PdfVerifyResults?: Array<PdfVerifyResult>
5783
5867
  /**
5784
- * 验签序列号
5868
+ * 验签序列号, 为11为数组组成的字符串
5785
5869
  */
5786
5870
  VerifySerialNo?: string
5787
5871
  /**
@@ -5869,11 +5953,11 @@ export interface Caller {
5869
5953
  */
5870
5954
  export interface DescribeFlowTemplatesResponse {
5871
5955
  /**
5872
- * 模板详情列表
5956
+ * 模板详情列表数据
5873
5957
  */
5874
5958
  Templates?: Array<TemplateInfo>
5875
5959
  /**
5876
- * 查询到的总数
5960
+ * 查询到的模板总数
5877
5961
  */
5878
5962
  TotalCount?: number
5879
5963
  /**
@@ -6102,7 +6186,7 @@ export interface CreateMultiFlowSignQRCodeRequest {
6102
6186
  */
6103
6187
  export interface DescribeFlowInfoRequest {
6104
6188
  /**
6105
- * 调用方用户信息,userId 必填
6189
+ * 执行本接口操作的员工信息。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
6106
6190
  */
6107
6191
  Operator?: UserInfo
6108
6192
  /**
@@ -6112,7 +6196,7 @@ export interface DescribeFlowInfoRequest {
6112
6196
  */
6113
6197
  FlowIds?: Array<string>
6114
6198
  /**
6115
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
6199
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6116
6200
  */
6117
6201
  Agent?: Agent
6118
6202
  /**
@@ -6132,7 +6216,7 @@ export interface DescribeFlowInfoResponse {
6132
6216
  */
6133
6217
  FlowDetailInfos?: Array<FlowDetailInfo>
6134
6218
  /**
6135
- * 合同组ID
6219
+ * 合同组ID,为32位字符串
6136
6220
  */
6137
6221
  FlowGroupId?: string
6138
6222
  /**