tencentcloud-sdk-nodejs-essbasic 4.0.723 → 4.0.725

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.
@@ -7,6 +7,97 @@ export interface SyncProxyOrganizationResponse {
7
7
  */
8
8
  RequestId?: string;
9
9
  }
10
+ /**
11
+ * 用户计费使用情况详情
12
+ */
13
+ export interface BillUsageDetail {
14
+ /**
15
+ * 合同流程ID,为32位字符串。
16
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
17
+ 注意:此字段可能返回 null,表示取不到有效值。
18
+ */
19
+ FlowId?: string;
20
+ /**
21
+ * 合同经办人名称
22
+ 如果有多个经办人用分号隔开。
23
+ 注意:此字段可能返回 null,表示取不到有效值。
24
+ */
25
+ OperatorName?: string;
26
+ /**
27
+ * 发起方组织机构名称
28
+ 注意:此字段可能返回 null,表示取不到有效值。
29
+ */
30
+ CreateOrganizationName?: string;
31
+ /**
32
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
33
+ 该名称还将用于合同签署完成后的下载文件名。
34
+ 注意:此字段可能返回 null,表示取不到有效值。
35
+ */
36
+ FlowName?: string;
37
+ /**
38
+ * 当前合同状态,如下是状态码对应的状态。
39
+ 0-还没有发起
40
+ 1-等待签署
41
+ 2-部分签署
42
+ 3-拒签
43
+ 4-已签署
44
+ 5-已过期
45
+ 6-已撤销
46
+ 7-还没有预发起
47
+ 8-等待填写
48
+ 9-部分填写
49
+ 10-拒填
50
+ 11-已解除
51
+ 注意:此字段可能返回 null,表示取不到有效值。
52
+ */
53
+ Status?: number;
54
+ /**
55
+ * 套餐类型
56
+ 对应关系如下
57
+ CloudEnterprise-企业版合同
58
+ SingleSignature-单方签章
59
+ CloudProve-签署报告
60
+ CloudOnlineSign-腾讯会议在线签约
61
+ ChannelWeCard-微工卡
62
+ SignFlow-合同套餐
63
+ SignFace-签署意愿(人脸识别)
64
+ SignPassword-签署意愿(密码)
65
+ SignSMS-签署意愿(短信)
66
+ PersonalEssAuth-签署人实名(腾讯电子签认证)
67
+ PersonalThirdAuth-签署人实名(信任第三方认证)
68
+ OrgEssAuth-签署企业实名
69
+ FlowNotify-短信通知
70
+ AuthService-企业工商信息查询
71
+ 注意:此字段可能返回 null,表示取不到有效值。
72
+ */
73
+ QuotaType?: string;
74
+ /**
75
+ * 合同使用量
76
+ 注意:此字段可能返回 null,表示取不到有效值。
77
+ */
78
+ UseCount?: number;
79
+ /**
80
+ * 消耗的时间戳,格式为Unix标准时间戳(秒)。
81
+ 注意:此字段可能返回 null,表示取不到有效值。
82
+ */
83
+ CostTime?: number;
84
+ /**
85
+ * 消耗的套餐名称
86
+ 注意:此字段可能返回 null,表示取不到有效值。
87
+ */
88
+ QuotaName?: string;
89
+ /**
90
+ * 消耗类型
91
+ 1.扣费 2.撤销返还
92
+ 注意:此字段可能返回 null,表示取不到有效值。
93
+ */
94
+ CostType?: number;
95
+ /**
96
+ * 备注
97
+ 注意:此字段可能返回 null,表示取不到有效值。
98
+ */
99
+ Remark?: string;
100
+ }
10
101
  /**
11
102
  * ChannelCreateConvertTaskApi返回参数结构体
12
103
  */
@@ -923,7 +1014,7 @@ export interface ReleasedApprover {
923
1014
  ApproverNumber: number;
924
1015
  /**
925
1016
  * 指定签署人类型,目前支持
926
- <ul><li> **ORGANIZATION**:企业(默认值)</li>
1017
+ <ul><li> **ORGANIZATION**:企业(默认值)</li>
927
1018
  <li> **ENTERPRISESERVER**:企业静默签</li></ul>
928
1019
  */
929
1020
  ApproverType: string;
@@ -933,15 +1024,15 @@ export interface ReleasedApprover {
933
1024
  Name?: string;
934
1025
  /**
935
1026
  * 签署方经办人的证件类型,支持以下类型
936
- <ul><li>ID_CARD : 居民身份证 (默认值)</li>
1027
+ <ul><li>ID_CARD : 居民身份证(默认值)</li>
937
1028
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
938
1029
  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
939
1030
  */
940
1031
  IdCardType?: string;
941
1032
  /**
942
1033
  * 证件号码,应符合以下规则
943
- <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
944
- <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
1034
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
1035
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
945
1036
  <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
946
1037
  */
947
1038
  IdCardNumber?: string;
@@ -1055,12 +1146,19 @@ export interface ChannelCreateUserRolesResponse {
1055
1146
  */
1056
1147
  export interface SyncProxyOrganizationRequest {
1057
1148
  /**
1058
- * 应用信息
1059
- 此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
1149
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1150
+
1151
+ 此接口下面信息必填。
1152
+ <ul>
1153
+ <li>渠道应用标识: Agent.AppId</li>
1154
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1155
+ </ul>
1156
+
1060
1157
  */
1061
1158
  Agent: Agent;
1062
1159
  /**
1063
- * 第三方平台子客企业名称,最大长度64个字符
1160
+ * 第三方平台子客企业名称,请确认该名称与企业营业执照中注册的名称一致。
1161
+ 注: `如果名称中包含英文括号(),请使用中文括号()代替。`
1064
1162
  */
1065
1163
  ProxyOrganizationName: string;
1066
1164
  /**
@@ -1072,7 +1170,7 @@ export interface SyncProxyOrganizationRequest {
1072
1170
  */
1073
1171
  UniformSocialCreditCode?: string;
1074
1172
  /**
1075
- * 第三方平台子客企业法人/负责人姓名
1173
+ * 第三方平台子客企业法定代表人的名字
1076
1174
  */
1077
1175
  ProxyLegalName?: string;
1078
1176
  /**
@@ -1081,13 +1179,22 @@ export interface SyncProxyOrganizationRequest {
1081
1179
  */
1082
1180
  Operator?: UserInfo;
1083
1181
  /**
1084
- * 第三方平台子客企业法人/负责人证件类型,默认居民身份证(ID_CARD)类型,暂不支持其他类型
1182
+ * 第三方平台子客企业法定代表人的证件类型,支持以下类型
1183
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li></ul>
1184
+ 注: `现在仅支持ID_CARD居民身份证类型`
1085
1185
  */
1086
1186
  ProxyLegalIdCardType?: string;
1087
1187
  /**
1088
- * 第三方平台子客企业法人/负责人证件号
1188
+ * 第三方平台子客企业法定代表人的证件号码, 应符合以下规则
1189
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li></ul>
1089
1190
  */
1090
1191
  ProxyLegalIdCardNumber?: string;
1192
+ /**
1193
+ * 第三方平台子客企业详细住所,最大长度500个字符
1194
+
1195
+ 注:`需要符合省市区详情的格式例如: XX省XX市XX区街道具体地址`
1196
+ */
1197
+ ProxyAddress?: string;
1091
1198
  }
1092
1199
  /**
1093
1200
  * ChannelCreatePrepareFlow请求参数结构体
@@ -1146,14 +1253,15 @@ export interface ChannelCreateFlowRemindsRequest {
1146
1253
 
1147
1254
  此接口下面信息必填。
1148
1255
  <ul>
1149
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
1150
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
1151
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
1256
+ <li>渠道应用标识: Agent.AppId</li>
1257
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1258
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1152
1259
  </ul>
1260
+ 第三方平台子客企业和员工必须已经经过实名认证
1153
1261
  */
1154
1262
  Agent: Agent;
1155
1263
  /**
1156
- * 需执行催办的签署流程ID数组,最多包含100个。
1264
+ * 需执行催办的合同流程ID数组,最多支持100个。
1157
1265
  */
1158
1266
  FlowIds: Array<string>;
1159
1267
  }
@@ -1462,11 +1570,16 @@ export interface UploadFilesResponse {
1462
1570
  RequestId?: string;
1463
1571
  }
1464
1572
  /**
1465
- * 应用相关信息
1573
+ * 应用相关信息, 整体应用的层级图如下
1574
+
1575
+ 注:
1576
+ 1. `不同的业务系统可以采用不同的应用,不同应用下的数据是隔离的, 应用A中的某个企业已经实名, 在应用B中此企业还需要重新认证`
1466
1577
  */
1467
1578
  export interface Agent {
1468
1579
  /**
1469
- * 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
1580
+ * 应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下:
1581
+
1582
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)
1470
1583
  */
1471
1584
  AppId: string;
1472
1585
  /**
@@ -1478,7 +1591,7 @@ export interface Agent {
1478
1591
  */
1479
1592
  ProxyOperator?: UserInfo;
1480
1593
  /**
1481
- * 非必需参数,在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
1594
+ * **不用填写**,在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
1482
1595
  */
1483
1596
  ProxyAppId?: string;
1484
1597
  /**
@@ -1492,7 +1605,9 @@ export interface Agent {
1492
1605
  */
1493
1606
  export interface ChannelCreatePreparedPersonalEsignResponse {
1494
1607
  /**
1495
- * 导入的印章 ID
1608
+ * 电子印章ID,为32位字符串。
1609
+ 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
1610
+ 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
1496
1611
  */
1497
1612
  SealId?: string;
1498
1613
  /**
@@ -1505,20 +1620,20 @@ export interface ChannelCreatePreparedPersonalEsignResponse {
1505
1620
  */
1506
1621
  export interface FlowApproverDetail {
1507
1622
  /**
1508
- * 模板配置时候的签署人id,与控件绑定
1623
+ * 模板配置时候的签署人角色ID(用PDF文件发起也可以指定,如果不指定则自动生成此角色ID), 所有的填写控件和签署控件都归属不同的角色
1509
1624
  */
1510
1625
  ReceiptId?: string;
1511
1626
  /**
1512
- * 平台企业的第三方id
1627
+ * 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
1513
1628
  注意:此字段可能返回 null,表示取不到有效值。
1514
1629
  */
1515
1630
  ProxyOrganizationOpenId?: string;
1516
1631
  /**
1517
- * 平台企业操作人的第三方id
1632
+ * 第三方平台子客企业员工的唯一标识
1518
1633
  */
1519
1634
  ProxyOperatorOpenId?: string;
1520
1635
  /**
1521
- * 平台企业名称
1636
+ * 第三方平台子客企业名称,与企业营业执照中注册的名称一致。
1522
1637
  */
1523
1638
  ProxyOrganizationName?: string;
1524
1639
  /**
@@ -1526,34 +1641,34 @@ export interface FlowApproverDetail {
1526
1641
  */
1527
1642
  Mobile?: string;
1528
1643
  /**
1529
- * 签署人签署顺序
1644
+ * 签署顺序,如果是有序签署,签署顺序从小到大
1530
1645
  */
1531
1646
  SignOrder?: number;
1532
1647
  /**
1533
- * 签署人姓名
1648
+ * 签署方经办人的姓名。
1649
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
1534
1650
  注意:此字段可能返回 null,表示取不到有效值。
1535
1651
  */
1536
1652
  ApproveName?: string;
1537
1653
  /**
1538
1654
  * 当前签署人的状态, 状态如下
1539
- <br/>PENDING 待签署
1540
- <br/>FILLPENDING 待填写
1541
- <br/>FILLACCEPT 填写完成
1542
- <br/>FILLREJECT 拒绝填写
1543
- <br/>WAITPICKUP 待领取
1544
- <br/>ACCEPT 已签署
1545
- <br/>REJECT 拒签
1546
- <br/>DEADLINE 过期没人处理
1547
- <br/>CANCEL 流程已撤回
1548
- <br/>FORWARD 已经转他人处理
1549
- <br/>STOP 流程已终止
1550
- <br/>RELIEVED 解除协议(已解除)
1551
-
1655
+ <ul><li> **PENDING** :待签署</li>
1656
+ <li> **FILLPENDING** :待填写</li>
1657
+ <li> **FILLACCEPT** :填写完成</li>
1658
+ <li> **FILLREJECT** :拒绝填写</li>
1659
+ <li> **WAITPICKUP** :待领取</li>
1660
+ <li> **ACCEPT** :已签署</li>
1661
+ <li> **REJECT** :拒签</li>
1662
+ <li> **DEADLINE** :过期没人处理</li>
1663
+ <li> **CANCEL** :流程已撤回</li>
1664
+ <li> **FORWARD** :已经转他人处理</li>
1665
+ <li> **STOP** :流程已终止</li>
1666
+ <li> **RELIEVED** :解除协议(已解除)</li></ul>
1552
1667
  注意:此字段可能返回 null,表示取不到有效值。
1553
1668
  */
1554
1669
  ApproveStatus?: string;
1555
1670
  /**
1556
- * 签署人自定义信息
1671
+ * 签署人拒签等情况的时候填写的原因
1557
1672
  注意:此字段可能返回 null,表示取不到有效值。
1558
1673
  */
1559
1674
  ApproveMessage?: string;
@@ -1563,13 +1678,13 @@ export interface FlowApproverDetail {
1563
1678
  ApproveTime?: number;
1564
1679
  /**
1565
1680
  * 参与者类型
1566
- <br/>ORGANIZATION:企业签署人
1567
- <br/>PERSON:个人签署人
1681
+ <ul><li> **ORGANIZATION** :企业签署人</li>
1682
+ <li> **PERSON** :个人签署人</li></ul>
1568
1683
  注意:此字段可能返回 null,表示取不到有效值。
1569
1684
  */
1570
1685
  ApproveType?: string;
1571
1686
  /**
1572
- * 自定义签署人角色
1687
+ * 自定义签署人的角色名, 如: 收款人、开具人、见证人等
1573
1688
  注意:此字段可能返回 null,表示取不到有效值。
1574
1689
  */
1575
1690
  ApproverRoleName?: string;
@@ -2199,6 +2314,101 @@ export interface Permission {
2199
2314
  */
2200
2315
  Children?: Array<Permission>;
2201
2316
  }
2317
+ /**
2318
+ * DescribeTemplates请求参数结构体
2319
+ */
2320
+ export interface DescribeTemplatesRequest {
2321
+ /**
2322
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2323
+
2324
+ 此接口下面信息必填。
2325
+ <ul>
2326
+ <li>渠道应用标识: Agent.AppId</li>
2327
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2328
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2329
+ </ul>
2330
+ 第三方平台子客企业和员工必须已经经过实名认证
2331
+ */
2332
+ Agent: Agent;
2333
+ /**
2334
+ * 合同模板ID,为32位字符串。
2335
+
2336
+ 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
2337
+ */
2338
+ TemplateId?: string;
2339
+ /**
2340
+ * 查询模版的内容
2341
+
2342
+ <ul><li>**0**:(默认)模板列表及详情</li>
2343
+ <li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
2344
+ */
2345
+ ContentType?: number;
2346
+ /**
2347
+ * 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
2348
+
2349
+ 注意:
2350
+ 1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
2351
+ 2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
2352
+ 4. `若传递此参数,分页参数(Limit,Offset)无效`
2353
+
2354
+ */
2355
+ TemplateIds?: Array<string>;
2356
+ /**
2357
+ * 指定每页返回的数据条数,和Offset参数配合使用。
2358
+
2359
+ 注:`1.默认值为20,单页做大值为200。`
2360
+ */
2361
+ Limit?: number;
2362
+ /**
2363
+ * 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
2364
+
2365
+ 注:`1.offset从0开始,即第一页为0。`
2366
+ `2.默认从第一页返回。`
2367
+ */
2368
+ Offset?: number;
2369
+ /**
2370
+ * 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
2371
+ */
2372
+ TemplateName?: string;
2373
+ /**
2374
+ * 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
2375
+ */
2376
+ ChannelTemplateId?: string;
2377
+ /**
2378
+ * 返回控件的范围, 是只返回发起方自己的还是所有参与方的
2379
+
2380
+ <ul><li>**false**:(默认)只返回发起方控件</li>
2381
+ <li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
2382
+ */
2383
+ QueryAllComponents?: boolean;
2384
+ /**
2385
+ * 是否获取模板预览链接。
2386
+
2387
+ <ul><li>**false**:不获取(默认)</li>
2388
+ <li>**true**:获取</li></ul>
2389
+
2390
+ 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
2391
+
2392
+ 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
2393
+ */
2394
+ WithPreviewUrl?: boolean;
2395
+ /**
2396
+ * 是否获取模板的PDF文件链接。
2397
+
2398
+ <ul><li>**false**:不获取(默认)</li>
2399
+ <li>**true**:获取</li></ul>
2400
+
2401
+ 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
2402
+
2403
+ 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
2404
+ */
2405
+ WithPdfUrl?: boolean;
2406
+ /**
2407
+ * 操作者的信息
2408
+ * @deprecated
2409
+ */
2410
+ Operator?: UserInfo;
2411
+ }
2202
2412
  /**
2203
2413
  * 企业员工信息
2204
2414
  */
@@ -2673,8 +2883,8 @@ export interface PdfVerifyResult {
2673
2883
  * 申请证书的主体的名字
2674
2884
 
2675
2885
  如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
2676
- **企业**: ESS@企业名称@编码
2677
- **个人**: ESS@个人姓名@证件号@808854
2886
+ **企业**: ESS@企业名称@平台生成的数字编码
2887
+ **个人**: ESS@个人姓名@证件号@平台生成的数字编码
2678
2888
 
2679
2889
  如果在其他平台签署的, 主体的名字参考其他平台的说明
2680
2890
  */
@@ -3347,11 +3557,18 @@ export interface FlowInfo {
3347
3557
  AutoSignScene?: string;
3348
3558
  }
3349
3559
  /**
3350
- * 接口调用者信息
3560
+ * 接口调用的员工信息
3351
3561
  */
3352
3562
  export interface UserInfo {
3353
3563
  /**
3354
- * 第三方应用平台自定义,对应第三方平台子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串
3564
+ * 第三方应用平台自定义,对应第三方平台子客企业员工的唯一标识。
3565
+
3566
+
3567
+ 注意:
3568
+ 1. OpenId在子客企业对应一个真实员工,**本应用唯一, 不可重复使用**,最大64位字符串
3569
+ 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId
3570
+ 3. **员工加入企业后**, 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图
3571
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/bb67fb66c926759df3a0af5838fdafd5.png)
3355
3572
  */
3356
3573
  OpenId?: string;
3357
3574
  /**
@@ -3555,14 +3772,16 @@ export interface ChannelDescribeEmployeesRequest {
3555
3772
  /**
3556
3773
  * 查询的关键字段,支持Key-Values查询。可选键值如下:
3557
3774
  <ul>
3558
- <li>Key:**"Status"**,根据实名状态查询员工,Values可选:
3559
- <ul><li>**["IsVerified"]**:查询已实名的员工</li><li>**["QuiteJob"]**:查询离职员工</li></ul></li>
3560
- <li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
3775
+ <li>Key:**"Status"**,Values: **["IsVerified"]**, 查询已实名的员工</li>
3776
+ <li>Key:**"Status"**,Values: **["QuiteJob"]**, 查询离职员工</li>
3777
+ <li>Key:**"StaffOpenId"**,Values: **["OpenId1","OpenId2",...]**, 根据第三方系统用户OpenId查询员工</li>
3561
3778
  </ul>
3779
+ 注: `同名字的Key的过滤条件会冲突, 只能填写一个`
3562
3780
  */
3563
3781
  Filters?: Array<Filter>;
3564
3782
  /**
3565
- * 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大20000。
3783
+ * 指定分页返回第几页的数据,如果不传默认返回第一页。
3784
+ 页码从 0 开始,即首页为 0,最大20000。
3566
3785
  */
3567
3786
  Offset?: number;
3568
3787
  /**
@@ -3640,6 +3859,23 @@ export interface ChannelCreateFlowApproversResponse {
3640
3859
  */
3641
3860
  RequestId?: string;
3642
3861
  }
3862
+ /**
3863
+ * DescribeBillUsageDetail返回参数结构体
3864
+ */
3865
+ export interface DescribeBillUsageDetailResponse {
3866
+ /**
3867
+ * 返回查询记录总数
3868
+ */
3869
+ Total?: number;
3870
+ /**
3871
+ * 消耗记录详情
3872
+ */
3873
+ Details?: Array<BillUsageDetail>;
3874
+ /**
3875
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3876
+ */
3877
+ RequestId?: string;
3878
+ }
3643
3879
  /**
3644
3880
  * CreateSignUrls请求参数结构体
3645
3881
  */
@@ -4143,7 +4379,7 @@ export interface FillError {
4143
4379
  */
4144
4380
  export interface ChannelCreatePreparedPersonalEsignRequest {
4145
4381
  /**
4146
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
4382
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4147
4383
  */
4148
4384
  Agent: Agent;
4149
4385
  /**
@@ -4151,23 +4387,36 @@ export interface ChannelCreatePreparedPersonalEsignRequest {
4151
4387
  */
4152
4388
  UserName: string;
4153
4389
  /**
4154
- * 身份证件号码
4390
+ * 证件号码, 应符合以下规则
4391
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
4392
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
4393
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
4155
4394
  */
4156
4395
  IdCardNumber: string;
4157
4396
  /**
4158
- * 印章名称
4397
+ * 电子印章名字,1-50个中文字符
4398
+ 注:`同一企业下电子印章名字不能相同`
4159
4399
  */
4160
4400
  SealName: string;
4161
4401
  /**
4162
- * 印章图片的base64,最大不超过 8M
4402
+ * 电子印章图片base64编码,大小不超过10M(原始图片不超过5M),只支持PNG或JPG图片格式。
4403
+
4404
+
4163
4405
  */
4164
4406
  SealImage: string;
4165
4407
  /**
4166
- * 操作者信息
4408
+ * 执行本接口操作的员工信息。
4409
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4167
4410
  */
4168
4411
  Operator?: UserInfo;
4169
4412
  /**
4170
- * 身份证件类型
4413
+ * 证件类型,支持以下类型
4414
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
4415
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
4416
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
4417
+ <li>OTHER_CARD_TYPE : 其他</li></ul>
4418
+
4419
+ 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
4171
4420
  */
4172
4421
  IdCardType?: string;
4173
4422
  /**
@@ -4786,13 +5035,13 @@ export interface ChannelCreateReleaseFlowRequest {
4786
5035
  */
4787
5036
  ReliveInfo: RelieveInfo;
4788
5037
  /**
4789
- * 替换解除协议的签署人, 如不指定替换签署人, 则使用原流程的签署人。 <br/>
4790
- 如需更换原合同中的企业端签署人,可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
5038
+ * 指定解除协议的签署人,如不指定,则默认使用原流程的签署人。 <br/>
5039
+ 如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号,默认从0开始,顺序递增)<br/>
4791
5040
 
4792
5041
  注意:
4793
5042
  <ul>
4794
- <li>只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人</li>
4795
- <li>可以不指定替换签署人, 使用原流程的签署人</li>
5043
+ <li>只能更换自己企业的签署人,不支持更换个人类型或者其他企业的签署人</li>
5044
+ <li>可以不指定替换签署人,使用原流程的签署人</li>
4796
5045
  </ul>
4797
5046
  */
4798
5047
  ReleasedApprovers?: Array<ReleasedApprover>;
@@ -5423,99 +5672,48 @@ export interface ChannelCancelFlowRequest {
5423
5672
  Operator?: UserInfo;
5424
5673
  }
5425
5674
  /**
5426
- * DescribeTemplates请求参数结构体
5675
+ * DescribeBillUsageDetail请求参数结构体
5427
5676
  */
5428
- export interface DescribeTemplatesRequest {
5677
+ export interface DescribeBillUsageDetailRequest {
5429
5678
  /**
5430
5679
  * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5431
-
5432
- 此接口下面信息必填。
5433
- <ul>
5434
- <li>渠道应用标识: Agent.AppId</li>
5435
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5436
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
5437
- </ul>
5438
- 第三方平台子客企业和员工必须已经经过实名认证
5439
5680
  */
5440
5681
  Agent: Agent;
5441
5682
  /**
5442
- * 合同模板ID,为32位字符串。
5443
-
5444
- 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
5445
- */
5446
- TemplateId?: string;
5447
- /**
5448
- * 查询模版的内容
5449
-
5450
- <ul><li>**0**:(默认)模板列表及详情</li>
5451
- <li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
5683
+ * 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
5452
5684
  */
5453
- ContentType?: number;
5685
+ StartTime: string;
5454
5686
  /**
5455
- * 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
5456
-
5457
- 注意:
5458
- 1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
5459
- 2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
5460
- 4. `若传递此参数,分页参数(Limit,Offset)无效`
5461
-
5687
+ * 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
5462
5688
  */
5463
- TemplateIds?: Array<string>;
5689
+ EndTime: string;
5464
5690
  /**
5465
- * 指定每页返回的数据条数,和Offset参数配合使用。
5466
-
5467
- 注:`1.默认值为20,单页做大值为200。`
5691
+ * 查询的套餐类型 (选填 )不传则查询所有套餐;
5692
+ 对应关系如下
5693
+ CloudEnterprise-企业版合同
5694
+ SingleSignature-单方签章
5695
+ CloudProve-签署报告
5696
+ CloudOnlineSign-腾讯会议在线签约
5697
+ ChannelWeCard-微工卡
5698
+ SignFlow-合同套餐
5699
+ SignFace-签署意愿(人脸识别)
5700
+ SignPassword-签署意愿(密码)
5701
+ SignSMS-签署意愿(短信)
5702
+ PersonalEssAuth-签署人实名(腾讯电子签认证)
5703
+ PersonalThirdAuth-签署人实名(信任第三方认证)
5704
+ OrgEssAuth-签署企业实名
5705
+ FlowNotify-短信通知
5706
+ AuthService-企业工商信息查询
5468
5707
  */
5469
- Limit?: number;
5708
+ QuotaType?: string;
5470
5709
  /**
5471
- * 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
5472
-
5473
- 注:`1.offset从0开始,即第一页为0。`
5474
- `2.默认从第一页返回。`
5710
+ * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
5475
5711
  */
5476
5712
  Offset?: number;
5477
5713
  /**
5478
- * 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
5479
- */
5480
- TemplateName?: string;
5481
- /**
5482
- * 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
5483
- */
5484
- ChannelTemplateId?: string;
5485
- /**
5486
- * 返回控件的范围, 是只返回发起方自己的还是所有参与方的
5487
-
5488
- <ul><li>**false**:(默认)只返回发起方控件</li>
5489
- <li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
5490
- */
5491
- QueryAllComponents?: boolean;
5492
- /**
5493
- * 是否获取模板预览链接。
5494
-
5495
- <ul><li>**false**:不获取(默认)</li>
5496
- <li>**true**:获取</li></ul>
5497
-
5498
- 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
5499
-
5500
- 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
5501
- */
5502
- WithPreviewUrl?: boolean;
5503
- /**
5504
- * 是否获取模板的PDF文件链接。
5505
-
5506
- <ul><li>**false**:不获取(默认)</li>
5507
- <li>**true**:获取</li></ul>
5508
-
5509
- 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
5510
-
5511
- 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
5512
- */
5513
- WithPdfUrl?: boolean;
5514
- /**
5515
- * 操作者的信息
5516
- * @deprecated
5714
+ * 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
5517
5715
  */
5518
- Operator?: UserInfo;
5716
+ Limit?: number;
5519
5717
  }
5520
5718
  /**
5521
5719
  * 解除协议文档中内容信息,包括但不限于:解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。
@@ -5547,15 +5745,29 @@ export interface RelieveInfo {
5547
5745
  */
5548
5746
  export interface ChannelCreateSealPolicyRequest {
5549
5747
  /**
5550
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
5748
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5749
+
5750
+ 此接口下面信息必填。
5751
+
5752
+ 渠道应用标识: Agent.AppId
5753
+ 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
5754
+ 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
5755
+ 第三方平台子客企业和员工必须已经经过实名认证。
5551
5756
  */
5552
5757
  Agent: Agent;
5553
5758
  /**
5554
- * 指定印章ID
5759
+ * 电子印章ID,为32位字符串。
5760
+ 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
5761
+ 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
5555
5762
  */
5556
5763
  SealId: string;
5557
5764
  /**
5558
- * 指定待授权的用户ID数组,电子签的用户ID
5765
+ *
5766
+ 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
5767
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
5768
+ 员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。
5769
+ 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
5770
+ 指定待授权的用户ID数组,电子签的用户ID
5559
5771
  可以填写OpenId,系统会通过组织+渠道+OpenId查询得到UserId进行授权。
5560
5772
  */
5561
5773
  UserIds: Array<string>;